1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992,93,94,95,96,97,98,2000,2001 Free Software Foundation, Inc.
5 ;; Author: FSF (see below for full credits)
6 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
9 ;; $Id: vc.el,v 1.326 2002/02/21 21:00:35 spiegel Exp $
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
30 ;; VC was initially designed and implemented by Eric S. Raymond
31 ;; <esr@snark.thyrsus.com>. Over the years, many people have
32 ;; contributed substantial amounts of work to VC. These include:
33 ;; Per Cederqvist <ceder@lysator.liu.se>
34 ;; Paul Eggert <eggert@twinsun.com>
35 ;; Sebastian Kremer <sk@thp.uni-koeln.de>
36 ;; Martin Lorentzson <martinl@gnu.org>
37 ;; Dave Love <fx@gnu.org>
38 ;; Stefan Monnier <monnier@cs.yale.edu>
39 ;; J.D. Smith <jdsmith@alum.mit.edu>
40 ;; Andre Spiegel <spiegel@gnu.org>
41 ;; Richard Stallman <rms@gnu.org>
42 ;; Thien-Thi Nguyen <ttn@gnu.org>
46 ;; This mode is fully documented in the Emacs user's manual.
48 ;; Supported version-control systems presently include SCCS, RCS, and CVS.
50 ;; Some features will not work with old RCS versions. Where
51 ;; appropriate, VC finds out which version you have, and allows or
52 ;; disallows those features (stealing locks, for example, works only
53 ;; from 5.6.2 onwards).
54 ;; Even initial checkins will fail if your RCS version is so old that ci
55 ;; doesn't understand -t-; this has been known to happen to people running
58 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
60 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
61 ;; to be installed somewhere on Emacs's path for executables.
63 ;; If your site uses the ChangeLog convention supported by Emacs, the
64 ;; function vc-comment-to-change-log should prove a useful checkin hook.
66 ;; The vc code maintains some internal state in order to reduce expensive
67 ;; version-control operations to a minimum. Some names are only computed
68 ;; once. If you perform version control operations with RCS/SCCS/CVS while
69 ;; vc's back is turned, or move/rename master files while vc is running,
70 ;; vc may get seriously confused. Don't do these things!
72 ;; Developer's notes on some concurrency issues are included at the end of
75 ;; ADDING SUPPORT FOR OTHER BACKENDS
77 ;; VC can use arbitrary version control systems as a backend. To add
78 ;; support for a new backend named SYS, write a library vc-sys.el that
79 ;; contains functions of the form `vc-sys-...' (note that SYS is in lower
80 ;; case for the function and library names). VC will use that library if
81 ;; you put the symbol SYS somewhere into the list of
82 ;; `vc-handled-backends'. Then, for example, if `vc-sys-registered'
83 ;; returns non-nil for a file, all SYS-specific versions of VC commands
84 ;; will be available for that file.
86 ;; VC keeps some per-file information in the form of properties (see
87 ;; vc-file-set/getprop in vc-hooks.el). The backend-specific functions
88 ;; do not generally need to be aware of these properties. For example,
89 ;; `vc-sys-workfile-version' should compute the workfile version and
90 ;; return it; it should not look it up in the property, and it needn't
91 ;; store it there either. However, if a backend-specific function does
92 ;; store a value in a property, that value takes precedence over any
93 ;; value that the generic code might want to set (check for uses of
94 ;; the macro `with-vc-properties' in vc.el).
96 ;; In the list of functions below, each identifier needs to be prepended
97 ;; with `vc-sys-'. Some of the functions are mandatory (marked with a
98 ;; `*'), others are optional (`-').
100 ;; STATE-QUERYING FUNCTIONS
102 ;; * registered (file)
104 ;; Return non-nil if FILE is registered in this backend.
108 ;; Return the current version control state of FILE. For a list of
109 ;; possible values, see `vc-state'. This function should do a full and
110 ;; reliable state computation; it is usually called immediately after
111 ;; C-x v v. If you want to use a faster heuristic when visiting a
112 ;; file, put that into `state-heuristic' below.
114 ;; - state-heuristic (file)
116 ;; If provided, this function is used to estimate the version control
117 ;; state of FILE at visiting time. It should be considerably faster
118 ;; than the implementation of `state'. For a list of possible values,
119 ;; see the doc string of `vc-state'.
123 ;; If provided, this function is used to find the version control state
124 ;; of all files in DIR in a fast way. The function should not return
125 ;; anything, but rather store the files' states into the corresponding
126 ;; `vc-state' properties.
128 ;; * workfile-version (file)
130 ;; Return the current workfile version of FILE.
132 ;; - latest-on-branch-p (file)
134 ;; Return non-nil if the current workfile version of FILE is the latest
135 ;; on its branch. The default implementation always returns t, which
136 ;; means that working with non-current versions is not supported by
139 ;; * checkout-model (file)
141 ;; Indicate whether FILE needs to be "checked out" before it can be
142 ;; edited. See `vc-checkout-model' for a list of possible values.
144 ;; - workfile-unchanged-p (file)
146 ;; Return non-nil if FILE is unchanged from its current workfile
147 ;; version. This function should do a brief comparison of FILE's
148 ;; contents with those of the master version. If the backend does not
149 ;; have such a brief-comparison feature, the default implementation of
150 ;; this function can be used, which delegates to a full
153 ;; - mode-line-string (file)
155 ;; If provided, this function should return the VC-specific mode line
156 ;; string for FILE. The default implementation deals well with all
157 ;; states that `vc-state' can return.
159 ;; - dired-state-info (file)
161 ;; Translate the `vc-state' property of FILE into a string that can be
162 ;; used in a vc-dired buffer. The default implementation deals well
163 ;; with all states that `vc-state' can return.
165 ;; STATE-CHANGING FUNCTIONS
167 ;; * register (file &optional rev comment)
169 ;; Register FILE in this backend. Optionally, an initial revision REV
170 ;; and an initial description of the file, COMMENT, may be specified.
171 ;; The implementation should pass the value of vc-register-switches
172 ;; to the backend command.
174 ;; - init-version (file)
176 ;; The initial version to use when registering FILE if one is not
177 ;; specified by the user. If not provided, the variable
178 ;; vc-default-init-version is used instead.
180 ;; - responsible-p (file)
182 ;; Return non-nil if this backend considers itself "responsible" for
183 ;; FILE, which can also be a directory. This function is used to find
184 ;; out what backend to use for registration of new files and for things
185 ;; like change log generation. The default implementation always
188 ;; - could-register (file)
190 ;; Return non-nil if FILE could be registered under this backend. The
191 ;; default implementation always returns t.
193 ;; - receive-file (file rev)
195 ;; Let this backend "receive" a file that is already registered under
196 ;; another backend. The default implementation simply calls `register'
197 ;; for FILE, but it can be overridden to do something more specific,
198 ;; e.g. keep revision numbers consistent or choose editing modes for
199 ;; FILE that resemble those of the other backend.
201 ;; - unregister (file)
203 ;; Unregister FILE from this backend. This is only needed if this
204 ;; backend may be used as a "more local" backend for temporary editing.
206 ;; * checkin (file rev comment)
208 ;; Commit changes in FILE to this backend. If REV is non-nil, that
209 ;; should become the new revision number. COMMENT is used as a
210 ;; check-in comment. The implementation should pass the value of
211 ;; vc-checkin-switches to the backend command.
213 ;; * checkout (file &optional editable rev destfile)
215 ;; Check out revision REV of FILE into the working area. If EDITABLE
216 ;; is non-nil, FILE should be writable by the user and if locking is
217 ;; used for FILE, a lock should also be set. If REV is non-nil, that
218 ;; is the revision to check out (default is current workfile version);
219 ;; if REV is the empty string, that means to check out the head of the
220 ;; trunk. If optional arg DESTFILE is given, it is an alternate
221 ;; filename to write the contents to. The implementation should
222 ;; pass the value of vc-checkout-switches to the backend command.
224 ;; * revert (file &optional contents-done)
226 ;; Revert FILE back to the current workfile version. If optional
227 ;; arg CONTENTS-DONE is non-nil, then the contents of FILE have
228 ;; already been reverted from a version backup, and this function
229 ;; only needs to update the status of FILE within the backend.
231 ;; - cancel-version (file editable)
233 ;; Cancel the current workfile version of FILE, i.e. remove it from the
234 ;; master. EDITABLE non-nil means that FILE should be writable
235 ;; afterwards, and if locking is used for FILE, then a lock should also
236 ;; be set. If this function is not provided, trying to cancel a
237 ;; version is caught as an error.
239 ;; - merge (file rev1 rev2)
241 ;; Merge the changes between REV1 and REV2 into the current working file.
243 ;; - merge-news (file)
245 ;; Merge recent changes from the current branch into FILE.
247 ;; - steal-lock (file &optional version)
249 ;; Steal any lock on the current workfile version of FILE, or on
250 ;; VERSION if that is provided. This function is only needed if
251 ;; locking is used for files under this backend, and if files can
252 ;; indeed be locked by other users.
256 ;; * print-log (file)
258 ;; Insert the revision log of FILE into the *vc* buffer.
260 ;; - show-log-entry (version)
262 ;; If provided, search the log entry for VERSION in the current buffer,
263 ;; and make sure it is displayed in the buffer's window. The default
264 ;; implementation of this function works for RCS-style logs.
268 ;; Remove all non-comment information from the output of print-log. The
269 ;; default implementation of this function works for RCS-style logs.
271 ;; - logentry-check ()
273 ;; If defined, this function is run to find out whether the user
274 ;; entered a valid log entry for check-in. The log entry is in the
275 ;; current buffer, and if it is not a valid one, the function should
278 ;; - comment-history (file)
280 ;; Return a string containing all log entries that were made for FILE.
281 ;; This is used for transferring a file from one backend to another,
282 ;; retaining comment information. The default implementation of this
283 ;; function does this by calling print-log and then wash-log, and
284 ;; returning the resulting buffer contents as a string.
286 ;; - update-changelog (files)
288 ;; Using recent log entries, create ChangeLog entries for FILES, or for
289 ;; all files at or below the default-directory if FILES is nil. The
290 ;; default implementation runs rcs2log, which handles RCS- and
293 ;; * diff (file &optional rev1 rev2)
295 ;; Insert the diff for FILE into the *vc-diff* buffer. If REV1 and
296 ;; REV2 are non-nil, report differences from REV1 to REV2. If REV1
297 ;; is nil, use the current workfile version (as found in the
298 ;; repository) as the older version; if REV2 is nil, use the current
299 ;; workfile contents as the newer version. This function should
300 ;; pass the value of (vc-diff-switches-list BACKEND) to the backend
301 ;; command. It should return a status of either 0 (no differences
302 ;; found), or 1 (either non-empty diff or the diff is run
305 ;; - diff-tree (dir &optional rev1 rev2)
307 ;; Insert the diff for all files at and below DIR into the *vc-diff*
308 ;; buffer. The meaning of REV1 and REV2 is the same as for
309 ;; vc-BACKEND-diff. The default implementation does an explicit tree
310 ;; walk, calling vc-BACKEND-diff for each individual file.
312 ;; - annotate-command (file buf rev)
314 ;; If this function is provided, it should produce an annotated version
315 ;; of FILE in BUF, relative to version REV. This is currently only
316 ;; implemented for CVS, using the `cvs annotate' command.
318 ;; - annotate-time ()
320 ;; Only required if `annotate-command' is defined for the backend.
321 ;; Return the time of the next line of annotation at or after point,
322 ;; as a floating point fractional number of days. The helper
323 ;; function `vc-annotate-convert-time' may be useful for converting
324 ;; multi-part times as returned by `current-time' and `encode-time'
325 ;; to this format. Return nil if no more lines of annotation appear
326 ;; in the buffer. You can safely assume that point is placed at the
327 ;; beginning of each line, starting at `point-min'. The buffer that
328 ;; point is placed in is the Annotate output, as defined by the
331 ;; - annotate-current-time ()
333 ;; Only required if `annotate-command' is defined for the backend,
334 ;; AND you'd like the current time considered to be anything besides
335 ;; (vs-annotate-convert-time (current-time)) -- i.e. the current
336 ;; time with hours, minutes, and seconds included. Probably safe to
337 ;; ignore. Return the current-time, in units of fractional days.
341 ;; - create-snapshot (dir name branchp)
343 ;; Take a snapshot of the current state of files under DIR and name it
344 ;; NAME. This should make sure that files are up-to-date before
345 ;; proceeding with the action. DIR can also be a file and if BRANCHP
346 ;; is specified, NAME should be created as a branch and DIR should be
347 ;; checked out under this new branch. The default implementation does
348 ;; not support branches but does a sanity check, a tree traversal and
349 ;; for each file calls `assign-name'.
351 ;; - assign-name (file name)
353 ;; Give name NAME to the current version of FILE, assuming it is
354 ;; up-to-date. Only used by the default version of `create-snapshot'.
356 ;; - retrieve-snapshot (dir name update)
358 ;; Retrieve a named snapshot of all registered files at or below DIR.
359 ;; If UPDATE is non-nil, then update buffers of any files in the
360 ;; snapshot that are currently visited. The default implementation
361 ;; does a sanity check whether there aren't any uncommitted changes at
362 ;; or below DIR, and then performs a tree walk, using the `checkout'
363 ;; function to retrieve the corresponding versions.
367 ;; - make-version-backups-p (file)
369 ;; Return non-nil if unmodified repository versions of FILE should be
370 ;; backed up locally. If this is done, VC can perform `diff' and
371 ;; `revert' operations itself, without calling the backend system. The
372 ;; default implementation always returns nil.
374 ;; - previous-version (file rev)
376 ;; Return the version number that precedes REV for FILE.
378 ;; - check-headers ()
380 ;; Return non-nil if the current buffer contains any version headers.
382 ;; - clear-headers ()
384 ;; In the current buffer, reset all version headers to their unexpanded
385 ;; form. This function should be provided if the state-querying code
386 ;; for this backend uses the version headers to determine the state of
387 ;; a file. This function will then be called whenever VC changes the
388 ;; version control state in such a way that the headers would give
389 ;; wrong information.
391 ;; - rename-file (old new)
393 ;; Rename file OLD to NEW, both in the working area and in the
394 ;; repository. If this function is not provided, the command
395 ;; `vc-rename-file' will signal an error.
404 (require 'dired
) ; for dired-map-over-marks macro
405 (require 'dired-aux
)) ; for dired-kill-{line,tree}
407 (if (not (assoc 'vc-parent-buffer minor-mode-alist
))
408 (setq minor-mode-alist
409 (cons '(vc-parent-buffer vc-parent-buffer-name
)
412 ;; General customization
415 "Version-control system in Emacs."
418 (defcustom vc-suppress-confirm nil
419 "*If non-nil, treat user as expert; suppress yes-no prompts on some things."
423 (defcustom vc-delete-logbuf-window t
424 "*If non-nil, delete the *VC-log* buffer and window after each logical action.
425 If nil, bury that buffer instead.
426 This is most useful if you have multiple windows on a frame and would like to
427 preserve the setting."
431 (defcustom vc-initial-comment nil
432 "*If non-nil, prompt for initial comment when a file is registered."
436 (defcustom vc-default-init-version
"1.1"
437 "*A string used as the default version number when a new file is registered.
438 This can be overridden by giving a prefix argument to \\[vc-register]. This
439 can also be overridden by a particular VC backend."
444 (defcustom vc-command-messages nil
445 "*If non-nil, display run messages from back-end commands."
449 (defcustom vc-checkin-switches nil
450 "*A string or list of strings specifying extra switches for checkin.
451 These are passed to the checkin program by \\[vc-checkin]."
452 :type
'(choice (const :tag
"None" nil
)
453 (string :tag
"Argument String")
454 (repeat :tag
"Argument List"
459 (defcustom vc-checkout-switches nil
460 "*A string or list of strings specifying extra switches for checkout.
461 These are passed to the checkout program by \\[vc-checkout]."
462 :type
'(choice (const :tag
"None" nil
)
463 (string :tag
"Argument String")
464 (repeat :tag
"Argument List"
469 (defcustom vc-register-switches nil
470 "*A string or list of strings; extra switches for registering a file.
471 These are passed to the checkin program by \\[vc-register]."
472 :type
'(choice (const :tag
"None" nil
)
473 (string :tag
"Argument String")
474 (repeat :tag
"Argument List"
479 (defcustom vc-dired-listing-switches
"-al"
480 "*Switches passed to `ls' for vc-dired. MUST contain the `l' option."
485 (defcustom vc-dired-recurse t
486 "*If non-nil, show directory trees recursively in VC Dired."
491 (defcustom vc-dired-terse-display t
492 "*If non-nil, show only locked files in VC Dired."
497 (defcustom vc-directory-exclusion-list
'("SCCS" "RCS" "CVS")
498 "*List of directory names to be ignored when walking directory trees."
499 :type
'(repeat string
)
502 (defconst vc-maximum-comment-ring-size
32
503 "Maximum number of saved comments in the comment ring.")
505 (defcustom vc-diff-switches nil
506 "*A string or list of strings specifying switches for diff under VC.
507 When running diff under a given BACKEND, VC concatenates the values of
508 `diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to
509 get the switches for that command. Thus, `vc-diff-switches' should
510 contain switches that are specific to version control, but not
511 specific to any particular backend."
512 :type
'(choice (const :tag
"None" nil
)
513 (string :tag
"Argument String")
514 (repeat :tag
"Argument List"
521 (defcustom vc-checkout-hook nil
522 "*Normal hook (list of functions) run after checking out a file.
528 (defcustom vc-annotate-display-mode nil
529 "Which mode to color the output of \\[vc-annotate] with by default."
530 :type
'(choice (const :tag
"Default" nil
)
531 (const :tag
"Scale to Oldest" scale
)
532 (const :tag
"Scale Oldest->Newest" fullscale
)
533 (number :tag
"Specify Fractional Number of Days"
538 (defcustom vc-checkin-hook nil
539 "*Normal hook (list of functions) run after a checkin is done.
542 :options
'(vc-comment-to-change-log)
546 (defcustom vc-before-checkin-hook nil
547 "*Normal hook (list of functions) run before a file is checked in.
552 (defcustom vc-logentry-check-hook nil
553 "*Normal hook run by `vc-backend-logentry-check'.
554 Use this to impose your own rules on the entry in addition to any the
555 version control backend imposes itself."
559 ;; Annotate customization
560 (defcustom vc-annotate-color-map
578 "*Association list of age versus color, for \\[vc-annotate].
579 Ages are given in units of fractional days. Default is eighteen steps
580 using a twenty day increment."
584 (defcustom vc-annotate-very-old-color
"#0046FF"
585 "*Color for lines older than the current color range in \\[vc-annotate]]."
589 (defcustom vc-annotate-background
"black"
590 "*Background color for \\[vc-annotate].
591 Default color is used if nil."
595 (defcustom vc-annotate-menu-elements
'(2 0.5 0.1 0.01)
596 "*Menu elements for the mode-specific menu of VC-Annotate mode.
597 List of factors, used to expand/compress the time scale. See `vc-annotate'."
598 :type
'(repeat number
)
601 ;; vc-annotate functionality (CVS only).
602 (defvar vc-annotate-mode nil
603 "Variable indicating if VC-Annotate mode is active.")
605 (defvar vc-annotate-mode-map
606 (let ((m (make-sparse-keymap)))
607 (define-key m
[menu-bar
] (make-sparse-keymap "VC-Annotate"))
609 "Local keymap used for VC-Annotate mode.")
611 (defvar vc-annotate-mode-menu nil
612 "Local keymap used for VC-Annotate mode's menu bar menu.")
614 ;; Header-insertion hair
616 (defcustom vc-static-header-alist
618 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
619 "*Associate static header string templates with file types.
620 A \%s in the template is replaced with the first string associated with
621 the file's version control type in `vc-header-alist'."
622 :type
'(repeat (cons :format
"%v"
623 (regexp :tag
"File Type")
624 (string :tag
"Header String")))
627 (defcustom vc-comment-alist
628 '((nroff-mode ".\\\"" ""))
629 "*Special comment delimiters for generating VC headers.
630 Add an entry in this list if you need to override the normal `comment-start'
631 and `comment-end' variables. This will only be necessary if the mode language
632 is sensitive to blank lines."
633 :type
'(repeat (list :format
"%v"
635 (string :tag
"Comment Start")
636 (string :tag
"Comment End")))
639 (defcustom vc-checkout-carefully
(= (user-uid) 0)
640 "*This variable is obsolete
641 The corresponding checks are always done now.
642 From the old doc string:
644 Non-nil means be extra-careful in checkout.
645 Verify that the file really is not locked
646 and that its contents match what the master file says."
653 ;; Initialization code, to be done just once at load-time
654 (defvar vc-log-mode-map
655 (let ((map (make-sparse-keymap)))
656 (define-key map
"\M-n" 'vc-next-comment
)
657 (define-key map
"\M-p" 'vc-previous-comment
)
658 (define-key map
"\M-r" 'vc-comment-search-reverse
)
659 (define-key map
"\M-s" 'vc-comment-search-forward
)
660 (define-key map
"\C-c\C-c" 'vc-finish-logentry
)
662 ;; Compatibility with old name. Should we bother ?
663 (defvar vc-log-entry-mode vc-log-mode-map
)
666 ;; Variables the user doesn't need to know about.
667 (defvar vc-log-operation nil
)
668 (defvar vc-log-after-operation-hook nil
)
669 (defvar vc-annotate-buffers nil
670 "Alist of current \"Annotate\" buffers and their corresponding backends.
671 The keys are \(BUFFER . BACKEND\). See also `vc-annotate-get-backend'.")
672 ;; In a log entry buffer, this is a local variable
673 ;; that points to the buffer for which it was made
674 ;; (either a file, or a VC dired buffer).
675 (defvar vc-parent-buffer nil
)
676 (put 'vc-parent-buffer
'permanent-local t
)
677 (defvar vc-parent-buffer-name nil
)
678 (put 'vc-parent-buffer-name
'permanent-local t
)
681 (defvar vc-log-version
)
683 (defvar vc-dired-mode nil
)
684 (make-variable-buffer-local 'vc-dired-mode
)
686 (defvar vc-comment-ring
(make-ring vc-maximum-comment-ring-size
))
687 (defvar vc-comment-ring-index nil
)
688 (defvar vc-last-comment-match
"")
690 ;; functions that operate on RCS revision numbers. This code should
691 ;; also be moved into the backends. It stays for now, however, since
692 ;; it is used in code below.
693 (defun vc-trunk-p (rev)
694 "Return t if REV is a revision on the trunk."
695 (not (eq nil
(string-match "\\`[0-9]+\\.[0-9]+\\'" rev
))))
697 (defun vc-branch-p (rev)
698 "Return t if REV is a branch revision."
699 (not (eq nil
(string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev
))))
701 (defun vc-branch-part (rev)
702 "Return the branch part of a revision number REV."
703 (let ((index (string-match "\\.[0-9]+\\'" rev
)))
705 (substring rev
0 index
))))
707 (defun vc-minor-part (rev)
708 "Return the minor version number of a revision number REV."
709 (string-match "[0-9]+\\'" rev
)
710 (substring rev
(match-beginning 0) (match-end 0)))
712 (defun vc-default-previous-version (backend file rev
)
713 "Guess the version number immediately preceding REV for FILE.
714 This default implementation works for <major>.<minor>-style version numbers
715 as used by RCS and CVS."
716 (let ((branch (vc-branch-part rev
))
717 (minor-num (string-to-number (vc-minor-part rev
))))
720 ;; version does probably not start a branch or release
721 (concat branch
"." (number-to-string (1- minor-num
)))
723 ;; we are at the beginning of the trunk --
724 ;; don't know anything to return here
726 ;; we are at the beginning of a branch --
727 ;; return version of starting point
728 (vc-branch-part branch
))))))
730 ;; File property caching
732 (defun vc-clear-context ()
733 "Clear all cached file properties and the comment ring."
735 (fillarray vc-file-prop-obarray
0)
736 ;; Note: there is potential for minor lossage here if there is an open
737 ;; log buffer with a nonzero local value of vc-comment-ring-index.
738 (setq vc-comment-ring
(make-ring vc-maximum-comment-ring-size
)))
740 (defmacro with-vc-properties
(file form settings
)
741 "Execute FORM, then maybe set per-file properties for FILE.
742 SETTINGS is an association list of property/value pairs. After
743 executing FORM, set those properties from SETTINGS that have not yet
744 been updated to their corresponding values."
745 `(let ((vc-touched-properties (list t
)))
747 (mapcar (lambda (setting)
748 (let ((property (car setting
)))
749 (unless (memq property vc-touched-properties
)
750 (put (intern ,file vc-file-prop-obarray
)
751 property
(cdr setting
)))))
754 ;; Random helper functions
756 (defsubst vc-editable-p
(file)
757 "Return non-nil if FILE can be edited."
758 (or (eq (vc-checkout-model file
) 'implicit
)
759 (memq (vc-state file
) '(edited needs-merge
))))
761 ;; Two macros for elisp programming
763 (defmacro with-vc-file
(file comment
&rest body
)
764 "Check out a writable copy of FILE if necessary, then execute BODY.
765 Check in FILE with COMMENT (a string) after BODY has been executed.
766 FILE is passed through `expand-file-name'; BODY executed within
767 `save-excursion'. If FILE is not under version control, or locked by
768 somebody else, signal error."
769 (let ((filevar (make-symbol "file")))
770 `(let ((,filevar
(expand-file-name ,file
)))
771 (or (vc-backend ,filevar
)
772 (error (format "File not under version control: `%s'" file
)))
773 (unless (vc-editable-p ,filevar
)
774 (let ((state (vc-state ,filevar
)))
776 (error (format "`%s' is locking `%s'" state
,filevar
))
777 (vc-checkout ,filevar t
))))
780 (vc-checkin ,filevar nil
,comment
))))
782 (put 'with-vc-file
'lisp-indent-function
2)
785 (defmacro edit-vc-file
(file comment
&rest body
)
786 "Edit FILE under version control, executing body.
787 Checkin with COMMENT after executing BODY.
788 This macro uses `with-vc-file', passing args to it.
789 However, before executing BODY, find FILE, and after BODY, save buffer."
790 (let ((filevar (make-symbol "file")))
791 `(let ((,filevar
(expand-file-name ,file
)))
794 (set-buffer (find-file-noselect ,filevar
))
798 (put 'edit-vc-file
'lisp-indent-function
2)
800 (defun vc-ensure-vc-buffer ()
801 "Make sure that the current buffer visits a version-controlled file."
803 (set-buffer (find-file-noselect (dired-get-filename)))
804 (while vc-parent-buffer
805 (pop-to-buffer vc-parent-buffer
))
806 (if (not (buffer-file-name))
807 (error "Buffer %s is not associated with a file" (buffer-name))
808 (if (not (vc-backend (buffer-file-name)))
809 (error "File %s is not under version control" (buffer-file-name))))))
811 (defvar vc-binary-assoc nil
)
812 (defvar vc-binary-suffixes
813 (if (memq system-type
'(ms-dos windows-nt
))
814 '(".exe" ".com" ".bat" ".cmd" ".btm" "")
817 (defun vc-process-filter (p s
)
818 "An alternative output filter for async process P.
819 The only difference with the default filter is to insert S after markers."
820 (with-current-buffer (process-buffer p
)
822 (let ((inhibit-read-only t
))
823 (goto-char (process-mark p
))
825 (set-marker (process-mark p
) (point))))))
827 (defun vc-setup-buffer (&optional buf
)
828 "Prepare BUF for executing a VC command and make it current.
829 BUF defaults to \"*vc*\", can be a string and will be created if necessary."
830 (unless buf
(setq buf
"*vc*"))
831 (let ((camefrom (current-buffer))
832 (olddir default-directory
))
833 (set-buffer (get-buffer-create buf
))
834 (kill-all-local-variables)
835 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
836 (set (make-local-variable 'vc-parent-buffer-name
)
837 (concat " from " (buffer-name camefrom
)))
838 (setq default-directory olddir
)
839 (let ((inhibit-read-only t
))
842 (defun vc-exec-after (code)
843 "Eval CODE when the current buffer's process is done.
844 If the current buffer has no process, just evaluate CODE.
845 Else, add CODE to the process' sentinel."
846 (let ((proc (get-buffer-process (current-buffer))))
848 ;; If there's no background process, just execute the code.
849 ((null proc
) (eval code
))
850 ;; If the background process has exited, reap it and try again
851 ((eq (process-status proc
) 'exit
)
852 (delete-process proc
)
853 (vc-exec-after code
))
854 ;; If a process is running, add CODE to the sentinel
855 ((eq (process-status proc
) 'run
)
856 (let ((sentinel (process-sentinel proc
)))
857 (set-process-sentinel proc
859 (with-current-buffer ',(current-buffer)
860 (goto-char (process-mark p
))
861 ,@(append (cdr (cdr (cdr ;strip off `with-current-buffer buf
863 (car (cdr (cdr ;strip off `lambda (p s)'
865 (list `(vc-exec-after ',code
))))))))
866 (t (error "Unexpected process state"))))
869 (defvar vc-post-command-functions nil
870 "Hook run at the end of `vc-do-command'.
871 Each function is called inside the buffer in which the command was run
872 and is passed 3 arguments: the COMMAND, the FILE and the FLAGS.")
875 (defun vc-do-command (buffer okstatus command file
&rest flags
)
876 "Execute a VC command, notifying user and checking for errors.
877 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil or the
878 current buffer if BUFFER is t. If the destination buffer is not
879 already current, set it up properly and erase it. The command is
880 considered successful if its exit status does not exceed OKSTATUS (if
881 OKSTATUS is nil, that means to ignore errors, if it is 'async, that
882 means not to wait for termination of the subprocess). FILE is the
883 name of the working file (may also be nil, to execute commands that
884 don't expect a file name). If an optional list of FLAGS is present,
885 that is inserted into the command line before the filename."
886 (and file
(setq file
(expand-file-name file
)))
887 (if vc-command-messages
888 (message "Running %s on %s..." command file
))
890 (unless (or (eq buffer t
)
891 (and (stringp buffer
)
892 (string= (buffer-name) buffer
))
893 (eq buffer
(current-buffer)))
894 (vc-setup-buffer buffer
))
896 (inhibit-read-only t
)
898 (setq squeezed
(delq nil
(copy-sequence flags
)))
900 ;; FIXME: file-relative-name can return a bogus result because
901 ;; it doesn't look at the actual file-system to see if symlinks
903 (setq squeezed
(append squeezed
(list (file-relative-name file
)))))
904 (let ((exec-path (append vc-path exec-path
))
905 ;; Add vc-path to PATH for the execution of this command.
907 (cons (concat "PATH=" (getenv "PATH")
909 (mapconcat 'identity vc-path path-separator
))
910 process-environment
))
911 (w32-quote-process-args t
))
912 (if (eq okstatus
'async
)
913 (let ((proc (apply 'start-process command
(current-buffer) command
915 (unless (active-minibuffer-window)
916 (message "Running %s in the background..." command
))
917 ;;(set-process-sentinel proc (lambda (p msg) (delete-process p)))
918 (set-process-filter proc
'vc-process-filter
)
920 `(unless (active-minibuffer-window)
921 (message "Running %s in the background... done" ',command
))))
922 (setq status
(apply 'call-process command nil t nil squeezed
))
923 (when (or (not (integerp status
)) (and okstatus
(< okstatus status
)))
924 (pop-to-buffer (current-buffer))
925 (goto-char (point-min))
926 (shrink-window-if-larger-than-buffer)
927 (error "Running %s...FAILED (%s)" command
928 (if (integerp status
) (format "status %d" status
) status
))))
929 (if vc-command-messages
930 (message "Running %s...OK" command
)))
932 `(run-hook-with-args 'vc-post-command-functions
',command
',file
',flags
))
935 (defun vc-position-context (posn)
936 "Save a bit of the text around POSN in the current buffer.
937 Used to help us find the corresponding position again later
938 if markers are destroyed or corrupted."
939 ;; A lot of this was shamelessly lifted from Sebastian Kremer's
943 (buffer-substring posn
944 (min (point-max) (+ posn
100)))))
946 (defun vc-find-position-by-context (context)
947 "Return the position of CONTEXT in the current buffer.
948 If CONTEXT cannot be found, return nil."
949 (let ((context-string (nth 2 context
)))
950 (if (equal "" context-string
)
953 (let ((diff (- (nth 1 context
) (buffer-size))))
954 (if (< diff
0) (setq diff
(- diff
)))
955 (goto-char (nth 0 context
))
956 (if (or (search-forward context-string nil t
)
957 ;; Can't use search-backward since the match may continue
959 (progn (goto-char (- (point) diff
(length context-string
)))
960 ;; goto-char doesn't signal an error at
961 ;; beginning of buffer like backward-char would
962 (search-forward context-string nil t
)))
963 ;; to beginning of OSTRING
964 (- (point) (length context-string
))))))))
966 (defun vc-context-matches-p (posn context
)
967 "Return t if POSN matches CONTEXT, nil otherwise."
968 (let* ((context-string (nth 2 context
))
969 (len (length context-string
))
971 (if (> end
(1+ (buffer-size)))
973 (string= context-string
(buffer-substring posn end
)))))
975 (defun vc-buffer-context ()
976 "Return a list (POINT-CONTEXT MARK-CONTEXT REPARSE).
977 Used by `vc-restore-buffer-context' to later restore the context."
978 (let ((point-context (vc-position-context (point)))
979 ;; Use mark-marker to avoid confusion in transient-mark-mode.
980 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
981 (vc-position-context (mark-marker))))
982 ;; Make the right thing happen in transient-mark-mode.
984 ;; We may want to reparse the compilation buffer after revert
985 (reparse (and (boundp 'compilation-error-list
) ;compile loaded
986 (let ((curbuf (current-buffer)))
987 ;; Construct a list; each elt is nil or a buffer
988 ;; iff that buffer is a compilation output buffer
989 ;; that contains markers into the current buffer.
991 (mapcar (lambda (buffer)
994 compilation-old-error-list
995 compilation-error-list
))
996 (buffer-error-marked-p nil
))
997 (while (and (consp errors
)
998 (not buffer-error-marked-p
))
999 (and (markerp (cdr (car errors
)))
1002 (cdr (car errors
))))
1003 (setq buffer-error-marked-p t
))
1004 (setq errors
(cdr errors
)))
1005 (if buffer-error-marked-p buffer
)))
1007 (list point-context mark-context reparse
)))
1009 (defun vc-restore-buffer-context (context)
1010 "Restore point/mark, and reparse any affected compilation buffers.
1011 CONTEXT is that which `vc-buffer-context' returns."
1012 (let ((point-context (nth 0 context
))
1013 (mark-context (nth 1 context
))
1014 (reparse (nth 2 context
)))
1015 ;; Reparse affected compilation buffers.
1018 (with-current-buffer (car reparse
)
1019 (let ((compilation-last-buffer (current-buffer)) ;select buffer
1020 ;; Record the position in the compilation buffer of
1021 ;; the last error next-error went to.
1022 (error-pos (marker-position
1023 (car (car-safe compilation-error-list
)))))
1024 ;; Reparse the error messages as far as they were parsed before.
1025 (compile-reinitialize-errors '(4) compilation-parsing-end
)
1026 ;; Move the pointer up to find the error we were at before
1027 ;; reparsing. Now next-error should properly go to the next one.
1028 (while (and compilation-error-list
1029 (/= error-pos
(car (car compilation-error-list
))))
1030 (setq compilation-error-list
(cdr compilation-error-list
))))))
1031 (setq reparse
(cdr reparse
)))
1033 ;; if necessary, restore point and mark
1034 (if (not (vc-context-matches-p (point) point-context
))
1035 (let ((new-point (vc-find-position-by-context point-context
)))
1036 (if new-point
(goto-char new-point
))))
1039 (not (vc-context-matches-p (mark) mark-context
))
1040 (let ((new-mark (vc-find-position-by-context mark-context
)))
1041 (if new-mark
(set-mark new-mark
))))))
1043 (defun vc-revert-buffer1 (&optional arg no-confirm
)
1044 "Revert buffer, keeping point and mark where user expects them.
1045 Try to be clever in the face of changes due to expanded version control
1046 key words. This is important for typeahead to work as expected.
1047 ARG and NO-CONFIRM are passed on to `revert-buffer'."
1050 (let ((context (vc-buffer-context)))
1051 ;; Use save-excursion here, because it may be able to restore point
1052 ;; and mark properly even in cases where vc-restore-buffer-context
1053 ;; would fail. However, save-excursion might also get it wrong --
1054 ;; in this case, vc-restore-buffer-context gives it a second try.
1056 ;; t means don't call normal-mode;
1057 ;; that's to preserve various minor modes.
1058 (revert-buffer arg no-confirm t
))
1059 (vc-restore-buffer-context context
)))
1062 (defun vc-buffer-sync (&optional not-urgent
)
1063 "Make sure the current buffer and its working file are in sync.
1064 NOT-URGENT means it is ok to continue if the user says not to save."
1065 (if (buffer-modified-p)
1066 (if (or vc-suppress-confirm
1067 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
1070 (error "Aborted")))))
1072 (defun vc-workfile-unchanged-p (file)
1073 "Return non-nil if FILE has not changed since the last checkout."
1074 (let ((checkout-time (vc-file-getprop file
'vc-checkout-time
))
1075 (lastmod (nth 5 (file-attributes file
))))
1077 (equal checkout-time lastmod
)
1078 (let ((unchanged (vc-call workfile-unchanged-p file
)))
1079 (vc-file-setprop file
'vc-checkout-time
(if unchanged lastmod
0))
1082 (defun vc-default-workfile-unchanged-p (backend file
)
1083 "Check if FILE is unchanged by diffing against the master version.
1084 Return non-nil if FILE is unchanged."
1085 (zerop (vc-call diff file
(vc-workfile-version file
))))
1087 (defun vc-default-latest-on-branch-p (backend file
)
1088 "Return non-nil if FILE is the latest on its branch.
1089 This default implementation always returns non-nil, which means that
1090 editing non-current versions is not supported by default."
1093 (defun vc-recompute-state (file)
1094 "Force a recomputation of the version control state of FILE.
1095 The state is computed using the exact, and possibly expensive
1096 function `vc-BACKEND-state', not the heuristic."
1097 (vc-file-setprop file
'vc-state
(vc-call state file
)))
1099 (defun vc-next-action-on-file (file verbose
&optional comment
)
1100 "Do The Right Thing for a given FILE under version control.
1101 If COMMENT is specified, it will be used as an admin or checkin comment.
1102 If VERBOSE is non-nil, query the user rather than using default parameters."
1103 (let ((visited (get-file-buffer file
))
1106 ;; Check relation of buffer and file, and make sure
1107 ;; user knows what he's doing. First, finding the file
1108 ;; will check whether the file on disk is newer.
1110 (find-file-other-window file
)
1111 (set-buffer (find-file-noselect file
)))
1112 (if (not (verify-visited-file-modtime (current-buffer)))
1113 (if (yes-or-no-p "Replace file on disk with buffer contents? ")
1114 (write-file (buffer-file-name))
1116 ;; Now, check if we have unsaved changes.
1118 (if (buffer-modified-p)
1119 (or (y-or-n-p "Operate on disk file, keeping modified buffer? ")
1120 (error "Aborted")))))
1122 ;; Do the right thing
1123 (if (not (vc-registered file
))
1124 (vc-register verbose comment
)
1125 (vc-recompute-state file
)
1126 (if visited
(vc-mode-line file
))
1127 (setq state
(vc-state file
))
1130 ((or (eq state
'up-to-date
)
1131 (and verbose
(eq state
'needs-patch
)))
1134 ;; go to a different version
1136 (read-string "Branch, version, or backend to move to: "))
1137 (let ((vsym (intern-soft (upcase version
))))
1138 (if (member vsym vc-handled-backends
)
1139 (vc-transfer-file file vsym
)
1140 (vc-checkout file
(eq (vc-checkout-model file
) 'implicit
)
1142 ((not (eq (vc-checkout-model file
) 'implicit
))
1143 ;; check the file out
1144 (vc-checkout file t
))
1147 (message "%s is up-to-date" file
))))
1149 ;; Abnormal: edited but read-only
1150 ((and visited
(eq state
'edited
)
1151 buffer-read-only
(not (file-writable-p file
)))
1152 ;; Make the file+buffer read-write. If the user really wanted to
1153 ;; commit, he'll get a chance to do that next time around, anyway.
1154 (message "File is edited but read-only; making it writable")
1155 (set-file-modes buffer-file-name
1156 (logior (file-modes buffer-file-name
) 128))
1157 (toggle-read-only -
1))
1162 ;; For files with locking, if the file does not contain
1163 ;; any changes, just let go of the lock, i.e. revert.
1164 ((and (not (eq (vc-checkout-model file
) 'implicit
))
1165 (vc-workfile-unchanged-p file
)
1166 ;; If buffer is modified, that means the user just
1167 ;; said no to saving it; in that case, don't revert,
1168 ;; because the user might intend to save after
1169 ;; finishing the log entry.
1170 (not (and visited
(buffer-modified-p))))
1171 ;; DO NOT revert the file without asking the user!
1172 (if (not visited
) (find-file-other-window file
))
1173 (if (yes-or-no-p "Revert to master version? ")
1174 (vc-revert-buffer)))
1177 (vc-checkin file nil comment
)
1178 (setq version
(read-string "New version or backend: "))
1179 (let ((vsym (intern (upcase version
))))
1180 (if (member vsym vc-handled-backends
)
1181 (vc-transfer-file file vsym
)
1182 (vc-checkin file version comment
)))))))
1184 ;; locked by somebody else
1187 (error "Sorry, you can't steal the lock on %s this way"
1188 (file-name-nondirectory file
)))
1190 (if verbose
(read-string "Version to steal: ")
1191 (vc-workfile-version file
))
1195 ((eq state
'needs-patch
)
1196 (if (yes-or-no-p (format
1197 "%s is not up-to-date. Get latest version? "
1198 (file-name-nondirectory file
)))
1199 (vc-checkout file
(eq (vc-checkout-model file
) 'implicit
) "")
1200 (if (and (not (eq (vc-checkout-model file
) 'implicit
))
1201 (yes-or-no-p "Lock this version? "))
1202 (vc-checkout file t
)
1203 (error "Aborted"))))
1206 ((eq state
'needs-merge
)
1207 (if (yes-or-no-p (format
1208 "%s is not up-to-date. Merge in changes now? "
1209 (file-name-nondirectory file
)))
1210 (vc-maybe-resolve-conflicts file
(vc-call merge-news file
))
1214 ((eq state
'unlocked-changes
)
1215 (if (not visited
) (find-file-other-window file
))
1216 (if (save-window-excursion
1217 (vc-version-diff file
(vc-workfile-version file
) nil
)
1218 (goto-char (point-min))
1219 (let ((inhibit-read-only t
))
1221 (format "Changes to %s since last lock:\n\n" file
)))
1223 (yes-or-no-p (concat "File has unlocked changes. "
1224 "Claim lock retaining changes? ")))
1225 (progn (vc-call steal-lock file
)
1226 ;; Must clear any headers here because they wouldn't
1227 ;; show that the file is locked now.
1228 (vc-clear-headers file
)
1229 (vc-mode-line file
))
1230 (if (not (yes-or-no-p
1231 "Revert to checked-in version, instead? "))
1232 (error "Checkout aborted")
1233 (vc-revert-buffer1 t t
)
1234 (vc-checkout file t
))))))))
1236 (defvar vc-dired-window-configuration
)
1238 (defun vc-next-action-dired (file rev comment
)
1239 "Call `vc-next-action-on-file' on all the marked files.
1240 Ignores FILE and REV, but passes on COMMENT."
1241 (let ((dired-buffer (current-buffer))
1242 (dired-dir default-directory
))
1243 (dired-map-over-marks
1244 (let ((file (dired-get-filename)))
1245 (message "Processing %s..." file
)
1246 (vc-next-action-on-file file nil comment
)
1247 (set-buffer dired-buffer
)
1248 (set-window-configuration vc-dired-window-configuration
)
1249 (message "Processing %s...done" file
))
1251 (dired-move-to-filename))
1253 ;; Here's the major entry point.
1256 (defun vc-next-action (verbose)
1257 "Do the next logical version control operation on the current file.
1259 If you call this from within a VC dired buffer with no files marked,
1260 it will operate on the file in the current line.
1262 If you call this from within a VC dired buffer, and one or more
1263 files are marked, it will accept a log message and then operate on
1264 each one. The log message will be used as a comment for any register
1265 or checkin operations, but ignored when doing checkouts. Attempted
1266 lock steals will raise an error.
1268 A prefix argument lets you specify the version number to use.
1270 For RCS and SCCS files:
1271 If the file is not already registered, this registers it for version
1273 If the file is registered and not locked by anyone, this checks out
1274 a writable and locked file ready for editing.
1275 If the file is checked out and locked by the calling user, this
1276 first checks to see if the file has changed since checkout. If not,
1277 it performs a revert.
1278 If the file has been changed, this pops up a buffer for entry
1279 of a log message; when the message has been entered, it checks in the
1280 resulting changes along with the log message as change commentary. If
1281 the variable `vc-keep-workfiles' is non-nil (which is its default), a
1282 read-only copy of the changed file is left in place afterwards.
1283 If the file is registered and locked by someone else, you are given
1284 the option to steal the lock.
1287 If the file is not already registered, this registers it for version
1288 control. This does a \"cvs add\", but no \"cvs commit\".
1289 If the file is added but not committed, it is committed.
1290 If your working file is changed, but the repository file is
1291 unchanged, this pops up a buffer for entry of a log message; when the
1292 message has been entered, it checks in the resulting changes along
1293 with the logmessage as change commentary. A writable file is retained.
1294 If the repository file is changed, you are asked if you want to
1295 merge in the changes into your working copy."
1300 (let ((files (dired-get-marked-files)))
1301 (set (make-local-variable 'vc-dired-window-configuration
)
1302 (current-window-configuration))
1306 (if (not (vc-up-to-date-p f
)) "@" ""))
1308 (vc-next-action-dired nil nil
"dummy")
1309 (vc-start-entry nil nil nil nil
1310 "Enter a change comment for the marked files."
1311 'vc-next-action-dired
))
1313 (while vc-parent-buffer
1314 (pop-to-buffer vc-parent-buffer
))
1315 (if buffer-file-name
1316 (vc-next-action-on-file buffer-file-name verbose
)
1317 (error "Buffer %s is not associated with a file" (buffer-name)))))
1319 ;; These functions help the vc-next-action entry point
1322 (defun vc-register (&optional set-version comment
)
1323 "Register the current file into a version control system.
1324 With prefix argument SET-VERSION, allow user to specify initial version
1325 level. If COMMENT is present, use that as an initial comment.
1327 The version control system to use is found by cycling through the list
1328 `vc-handled-backends'. The first backend in that list which declares
1329 itself responsible for the file (usually because other files in that
1330 directory are already registered under that backend) will be used to
1331 register the file. If no backend declares itself responsible, the
1332 first backend that could register the file is used."
1334 (unless buffer-file-name
(error "No visited file"))
1335 (when (vc-backend buffer-file-name
)
1336 (if (vc-registered buffer-file-name
)
1337 (error "This file is already registered")
1338 (unless (y-or-n-p "Previous master file has vanished. Make a new one? ")
1339 (error "Aborted"))))
1340 ;; Watch out for new buffers of size 0: the corresponding file
1341 ;; does not exist yet, even though buffer-modified-p is nil.
1342 (if (and (not (buffer-modified-p))
1343 (zerop (buffer-size))
1344 (not (file-exists-p buffer-file-name
)))
1345 (set-buffer-modified-p t
))
1348 (vc-start-entry buffer-file-name
1350 (read-string (format "Initial version level for %s: "
1352 (let ((backend (vc-responsible-backend buffer-file-name
)))
1353 (if (vc-find-backend-function backend
'init-version
)
1354 (vc-call-backend backend
'init-version
)
1355 vc-default-init-version
)))
1356 (or comment
(not vc-initial-comment
))
1358 "Enter initial comment."
1359 (lambda (file rev comment
)
1360 (message "Registering %s... " file
)
1361 (let ((backend (vc-responsible-backend file t
)))
1362 (vc-file-clearprops file
)
1363 (vc-call-backend backend
'register file rev comment
)
1364 (vc-file-setprop file
'vc-backend backend
)
1365 (unless vc-make-backup-files
1366 (make-local-variable 'backup-inhibited
)
1367 (setq backup-inhibited t
)))
1368 (message "Registering %s... done" file
))))
1371 (defun vc-responsible-backend (file &optional register
)
1372 "Return the name of a backend system that is responsible for FILE.
1373 The optional argument REGISTER means that a backend suitable for
1374 registration should be found.
1376 If REGISTER is nil, then if FILE is already registered, return the
1377 backend of FILE. If FILE is not registered, or a directory, then the
1378 first backend in `vc-handled-backends' that declares itself
1379 responsible for FILE is returned. If no backend declares itself
1380 responsible, return the first backend.
1382 If REGISTER is non-nil, return the first responsible backend under
1383 which FILE is not yet registered. If there is no such backend, return
1384 the first backend under which FILE is not yet registered, but could
1386 (if (not vc-handled-backends
)
1387 (error "No handled backends"))
1388 (or (and (not (file-directory-p file
)) (not register
) (vc-backend file
))
1390 ;; First try: find a responsible backend. If this is for registration,
1391 ;; it must be a backend under which FILE is not yet registered.
1392 (dolist (backend vc-handled-backends
)
1393 (and (or (not register
)
1394 (not (vc-call-backend backend
'registered file
)))
1395 (vc-call-backend backend
'responsible-p file
)
1396 (throw 'found backend
)))
1397 ;; no responsible backend
1399 ;; if this is not for registration, the first backend must do
1400 (car vc-handled-backends
)
1401 ;; for registration, we need to find a new backend that
1402 ;; could register FILE
1403 (dolist (backend vc-handled-backends
)
1404 (and (not (vc-call-backend backend
'registered file
))
1405 (vc-call-backend backend
'could-register file
)
1406 (throw 'found backend
)))
1407 (error "No backend that could register")))))
1409 (defun vc-default-responsible-p (backend file
)
1410 "Indicate whether BACKEND is reponsible for FILE.
1411 The default is to return nil always."
1414 (defun vc-default-could-register (backend file
)
1415 "Return non-nil if BACKEND could be used to register FILE.
1416 The default implementation returns t for all files."
1419 (defun vc-resynch-window (file &optional keep noquery
)
1420 "If FILE is in the current buffer, either revert or unvisit it.
1421 The choice between revert (to see expanded keywords) and unvisit depends on
1422 `vc-keep-workfiles'. NOQUERY if non-nil inhibits confirmation for
1423 reverting. NOQUERY should be t *only* if it is known the only
1424 difference between the buffer and the file is due to version control
1425 rather than user editing!"
1426 (and (string= buffer-file-name file
)
1429 (vc-revert-buffer1 t noquery
)
1430 ;; TODO: Adjusting view mode might no longer be necessary
1431 ;; after RMS change to files.el of 1999-08-08. Investigate
1432 ;; this when we install the new VC.
1434 (if (file-writable-p file
)
1436 (let ((view-old-buffer-read-only nil
))
1438 (and (not view-mode
)
1439 (not (eq (get major-mode
'mode-class
) 'special
))
1440 (view-mode-enter))))
1441 (vc-mode-line buffer-file-name
))
1442 (kill-buffer (current-buffer)))))
1444 (defun vc-resynch-buffer (file &optional keep noquery
)
1445 "If FILE is currently visited, resynch its buffer."
1446 (if (string= buffer-file-name file
)
1447 (vc-resynch-window file keep noquery
)
1448 (let ((buffer (get-file-buffer file
)))
1450 (with-current-buffer buffer
1451 (vc-resynch-window file keep noquery
)))))
1452 (vc-dired-resynch-file file
))
1454 (defun vc-start-entry (file rev comment initial-contents msg action
&optional after-hook
)
1455 "Accept a comment for an operation on FILE revision REV.
1456 If COMMENT is nil, pop up a VC-log buffer, emit MSG, and set the
1457 action on close to ACTION. If COMMENT is a string and
1458 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial
1459 contents of the log entry buffer. If COMMENT is a string and
1460 INITIAL-CONTENTS is nil, do action immediately as if the user had
1461 entered COMMENT. If COMMENT is t, also do action immediately with an
1462 empty comment. Remember the file's buffer in `vc-parent-buffer'
1463 \(current one if no file). AFTER-HOOK specifies the local value
1464 for vc-log-operation-hook."
1465 (let ((parent (or (and file
(get-file-buffer file
)) (current-buffer))))
1466 (if vc-before-checkin-hook
1468 (with-current-buffer parent
1469 (run-hooks 'vc-before-checkin-hook
))
1470 (run-hooks 'vc-before-checkin-hook
)))
1471 (if (and comment
(not initial-contents
))
1472 (set-buffer (get-buffer-create "*VC-log*"))
1473 (pop-to-buffer (get-buffer-create "*VC-log*")))
1474 (set (make-local-variable 'vc-parent-buffer
) parent
)
1475 (set (make-local-variable 'vc-parent-buffer-name
)
1476 (concat " from " (buffer-name vc-parent-buffer
)))
1477 (if file
(vc-mode-line file
))
1479 (make-local-variable 'vc-log-after-operation-hook
)
1481 (setq vc-log-after-operation-hook after-hook
))
1482 (setq vc-log-operation action
)
1483 (setq vc-log-version rev
)
1486 (when (stringp comment
) (insert comment
)))
1487 (if (or (not comment
) initial-contents
)
1488 (message "%s Type C-c C-c when done" msg
)
1489 (vc-finish-logentry (eq comment t
)))))
1491 (defun vc-checkout (file &optional writable rev
)
1492 "Retrieve a copy of the revision REV of FILE.
1493 If WRITABLE is non-nil, make sure the retrieved file is writable.
1494 REV defaults to the latest revision.
1496 After check-out, runs the normal hook `vc-checkout-hook'."
1499 (vc-call make-version-backups-p file
)
1500 (vc-up-to-date-p file
)
1501 (vc-make-version-backup file
))
1505 (vc-call checkout file writable rev
)
1507 ;; Maybe the backend is not installed ;-(
1509 (let ((buf (get-file-buffer file
)))
1510 (when buf
(with-current-buffer buf
(toggle-read-only -
1)))))
1511 (signal (car err
) (cdr err
))))
1512 `((vc-state .
,(if (or (eq (vc-checkout-model file
) 'implicit
)
1514 (if (vc-call latest-on-branch-p file
)
1518 (vc-checkout-time .
,(nth 5 (file-attributes file
)))))
1519 (vc-resynch-buffer file t t
)
1520 (run-hooks 'vc-checkout-hook
))
1522 (defun vc-steal-lock (file rev owner
)
1523 "Steal the lock on FILE."
1524 (let (file-description)
1526 (setq file-description
(format "%s:%s" file rev
))
1527 (setq file-description file
))
1528 (if (not (yes-or-no-p (format "Steal the lock on %s from %s? "
1529 file-description owner
)))
1530 (error "Steal canceled"))
1531 (message "Stealing lock on %s..." file
)
1534 (vc-call steal-lock file rev
)
1535 `((vc-state . edited
)))
1536 (vc-resynch-buffer file t t
)
1537 (message "Stealing lock on %s...done" file
)
1538 ;; Write mail after actually stealing, because if the stealing
1539 ;; goes wrong, we don't want to send any mail.
1540 (compose-mail owner
(format "Stolen lock on %s" file-description
))
1541 (setq default-directory
(expand-file-name "~/"))
1542 (goto-char (point-max))
1544 (format "I stole the lock on %s, " file-description
)
1545 (current-time-string)
1547 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
1549 (defun vc-checkin (file &optional rev comment initial-contents
)
1551 The optional argument REV may be a string specifying the new version
1552 level (if nil increment the current level). COMMENT is a comment
1553 string; if omitted, a buffer is popped up to accept a comment. If
1554 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents
1555 of the log entry buffer.
1557 If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided
1558 that the version control system supports this mode of operation.
1560 Runs the normal hook `vc-checkin-hook'."
1562 file rev comment initial-contents
1563 "Enter a change comment."
1564 (lambda (file rev comment
)
1565 (message "Checking in %s..." file
)
1566 ;; "This log message intentionally left almost blank".
1567 ;; RCS 5.7 gripes about white-space-only comments too.
1568 (or (and comment
(string-match "[^\t\n ]" comment
))
1569 (setq comment
"*** empty log message ***"))
1572 ;; Change buffers to get local value of vc-checkin-switches.
1573 (with-current-buffer (or (get-file-buffer file
) (current-buffer))
1575 (vc-call checkin file rev comment
)
1576 (vc-delete-automatic-version-backups file
)))
1577 `((vc-state . up-to-date
)
1578 (vc-checkout-time .
,(nth 5 (file-attributes file
)))
1579 (vc-workfile-version . nil
)))
1580 (message "Checking in %s...done" file
))
1583 (defun vc-comment-to-change-log (&optional whoami file-name
)
1584 "Enter last VC comment into the change log for the current file.
1585 WHOAMI (interactive prefix) non-nil means prompt for user name
1586 and site. FILE-NAME is the name of the change log; if nil, use
1587 `change-log-default-name'.
1589 This may be useful as a `vc-checkin-hook' to update change logs
1591 (interactive (if current-prefix-arg
1592 (list current-prefix-arg
1593 (prompt-for-change-log-name))))
1594 ;; Make sure the defvar for add-log-current-defun-function has been executed
1595 ;; before binding it.
1597 (let (;; Extract the comment first so we get any error before doing anything.
1598 (comment (ring-ref vc-comment-ring
0))
1599 ;; Don't let add-change-log-entry insert a defun name.
1600 (add-log-current-defun-function 'ignore
)
1602 ;; Call add-log to do half the work.
1603 (add-change-log-entry whoami file-name t t
)
1604 ;; Insert the VC comment, leaving point before it.
1605 (setq end
(save-excursion (insert comment
) (point-marker)))
1606 (if (looking-at "\\s *\\s(")
1607 ;; It starts with an open-paren, as in "(foo): Frobbed."
1608 ;; So remove the ": " add-log inserted.
1610 ;; Canonicalize the white space between the file name and comment.
1612 ;; Indent rest of the text the same way add-log indented the first line.
1613 (let ((indentation (current-indentation)))
1615 (while (< (point) end
)
1617 (indent-to indentation
))
1618 (setq end
(point))))
1619 ;; Fill the inserted text, preserving open-parens at bol.
1620 (let ((paragraph-separate (concat paragraph-separate
"\\|\\s *\\s("))
1621 (paragraph-start (concat paragraph-start
"\\|\\s *\\s(")))
1623 (fill-region (point) end
))
1624 ;; Canonicalize the white space at the end of the entry so it is
1625 ;; separated from the next entry by a single blank line.
1626 (skip-syntax-forward " " end
)
1627 (delete-char (- (skip-syntax-backward " ")))
1628 (or (eobp) (looking-at "\n\n")
1631 (defun vc-finish-logentry (&optional nocomment
)
1632 "Complete the operation implied by the current log entry.
1633 Use the contents of the current buffer as a check-in or registration
1634 comment. If the optional arg NOCOMMENT is non-nil, then don't check
1635 the buffer contents as a comment, and don't add it to
1638 ;; Check and record the comment, if any.
1640 ;; Comment too long?
1641 (vc-call-backend (or (and vc-log-file
(vc-backend vc-log-file
))
1642 (vc-responsible-backend default-directory
))
1644 (run-hooks 'vc-logentry-check-hook
)
1645 ;; Record the comment in the comment ring
1646 (let ((comment (buffer-string)))
1647 (unless (and (ring-p vc-comment-ring
)
1648 (not (ring-empty-p vc-comment-ring
))
1649 (equal comment
(ring-ref vc-comment-ring
0)))
1650 (ring-insert vc-comment-ring comment
))))
1651 ;; Sync parent buffer in case the user modified it while editing the comment.
1652 ;; But not if it is a vc-dired buffer.
1653 (with-current-buffer vc-parent-buffer
1654 (or vc-dired-mode
(vc-buffer-sync)))
1655 (if (not vc-log-operation
) (error "No log operation is pending"))
1656 ;; save the parameters held in buffer-local variables
1657 (let ((log-operation vc-log-operation
)
1658 (log-file vc-log-file
)
1659 (log-version vc-log-version
)
1660 (log-entry (buffer-string))
1661 (after-hook vc-log-after-operation-hook
)
1662 (tmp-vc-parent-buffer vc-parent-buffer
))
1663 (pop-to-buffer vc-parent-buffer
)
1666 (funcall log-operation
1670 ;; Remove checkin window (after the checkin so that if that fails
1671 ;; we don't zap the *VC-log* buffer and the typing therein).
1672 (let ((logbuf (get-buffer "*VC-log*")))
1673 (cond ((and logbuf vc-delete-logbuf-window
)
1674 (delete-windows-on logbuf
(selected-frame))
1675 ;; Kill buffer and delete any other dedicated windows/frames.
1676 (kill-buffer logbuf
))
1677 (logbuf (pop-to-buffer "*VC-log*")
1679 (pop-to-buffer tmp-vc-parent-buffer
))))
1680 ;; Now make sure we see the expanded headers
1682 (vc-resynch-buffer log-file vc-keep-workfiles t
))
1684 (dired-move-to-filename))
1685 (run-hooks after-hook
'vc-finish-logentry-hook
)))
1687 ;; Code for access to the comment ring
1689 (defun vc-new-comment-index (stride len
)
1690 "Return the comment index STRIDE elements from the current one.
1691 LEN is the length of `vc-comment-ring'."
1693 (vc-comment-ring-index (+ vc-comment-ring-index stride
))
1694 ;; Initialize the index on the first use of this command
1695 ;; so that the first M-p gets index 0, and the first M-n gets
1697 ((> stride
0) (1- stride
))
1701 (defun vc-previous-comment (arg)
1702 "Cycle backwards through comment history.
1703 With a numeric prefix ARG, go back ARG comments."
1705 (let ((len (ring-length vc-comment-ring
)))
1707 (progn (message "Empty comment ring") (ding))
1709 (setq vc-comment-ring-index
(vc-new-comment-index arg len
))
1710 (message "Comment %d" (1+ vc-comment-ring-index
))
1711 (insert (ring-ref vc-comment-ring vc-comment-ring-index
)))))
1713 (defun vc-next-comment (arg)
1714 "Cycle forwards through comment history.
1715 With a numeric prefix ARG, go forward ARG comments."
1717 (vc-previous-comment (- arg
)))
1719 (defun vc-comment-search-reverse (str &optional stride
)
1720 "Search backwards through comment history for substring match of STR.
1721 If the optional argument STRIDE is present, that is a step-width to use
1722 when going through the comment ring."
1723 ;; Why substring rather than regexp ? -sm
1725 (list (read-string "Comment substring: " nil nil vc-last-comment-match
)))
1726 (unless stride
(setq stride
1))
1727 (if (string= str
"")
1728 (setq str vc-last-comment-match
)
1729 (setq vc-last-comment-match str
))
1730 (let* ((str (regexp-quote str
))
1731 (len (ring-length vc-comment-ring
))
1732 (n (vc-new-comment-index stride len
)))
1733 (while (progn (when (or (>= n len
) (< n
0)) (error "Not found"))
1734 (not (string-match str
(ring-ref vc-comment-ring n
))))
1735 (setq n
(+ n stride
)))
1736 (setq vc-comment-ring-index n
)
1737 (vc-previous-comment 0)))
1739 (defun vc-comment-search-forward (str)
1740 "Search forwards through comment history for a substring match of STR."
1742 (list (read-string "Comment substring: " nil nil vc-last-comment-match
)))
1743 (vc-comment-search-reverse str -
1))
1745 ;; Additional entry points for examining version histories
1748 (defun vc-diff (historic &optional not-urgent
)
1749 "Display diffs between file versions.
1750 Normally this compares the current file and buffer with the most
1751 recent checked in version of that file. This uses no arguments. With
1752 a prefix argument HISTORIC, it reads the file name to use and two
1753 version designators specifying which versions to compare. The
1754 optional argument NOT-URGENT non-nil means it is ok to say no to
1756 (interactive (list current-prefix-arg t
))
1758 (call-interactively 'vc-version-diff
)
1759 (vc-ensure-vc-buffer)
1760 (let ((file buffer-file-name
))
1761 (vc-buffer-sync not-urgent
)
1762 (if (vc-workfile-unchanged-p buffer-file-name
)
1763 (message "No changes to %s since latest version" file
)
1764 (vc-version-diff file nil nil
)))))
1766 (defun vc-version-diff (file rel1 rel2
)
1767 "List the differences between FILE's versions REL1 and REL2.
1768 If REL1 is empty or nil it means to use the current workfile version;
1769 REL2 empty or nil means the current file contents. FILE may also be
1770 a directory, in that case, generate diffs between the correponding
1771 versions of all registered files in or below it."
1773 (let ((file (expand-file-name
1774 (read-file-name (if buffer-file-name
1775 "File or dir to diff: (default visited file) "
1776 "File or dir to diff: ")
1777 default-directory buffer-file-name t
)))
1778 (rel1-default nil
) (rel2-default nil
))
1779 ;; compute default versions based on the file state
1781 ;; if it's a directory, don't supply any version default
1782 ((file-directory-p file
)
1784 ;; if the file is not up-to-date, use current version as older version
1785 ((not (vc-up-to-date-p file
))
1786 (setq rel1-default
(vc-workfile-version file
)))
1787 ;; if the file is not locked, use last and previous version as default
1789 (setq rel1-default
(vc-call previous-version file
1790 (vc-workfile-version file
)))
1791 (if (string= rel1-default
"") (setq rel1-default nil
))
1792 (setq rel2-default
(vc-workfile-version file
))))
1793 ;; construct argument list
1795 (read-string (if rel1-default
1796 (concat "Older version: (default "
1799 nil nil rel1-default
)
1800 (read-string (if rel2-default
1801 (concat "Newer version: (default "
1803 "Newer version (default: current source): ")
1804 nil nil rel2-default
))))
1805 (if (file-directory-p file
)
1806 ;; recursive directory diff
1808 (vc-setup-buffer "*vc-diff*")
1809 (if (string-equal rel1
"") (setq rel1 nil
))
1810 (if (string-equal rel2
"") (setq rel2 nil
))
1811 (let ((inhibit-read-only t
))
1812 (insert "Diffs between "
1813 (or rel1
"last version checked in")
1815 (or rel2
"current workfile(s)")
1817 (let ((dir (file-name-as-directory file
)))
1818 (vc-call-backend (vc-responsible-backend dir
)
1819 'diff-tree dir rel1 rel2
))
1820 (vc-exec-after `(let ((inhibit-read-only t
))
1821 (insert "\nEnd of diffs.\n"))))
1823 (vc-diff-internal file rel1 rel2
))
1824 (set-buffer "*vc-diff*")
1825 (if (and (zerop (buffer-size))
1826 (not (get-buffer-process (current-buffer))))
1830 (message "No changes to %s between %s and %s" file rel1 rel2
)
1831 (message "No changes to %s since %s" file rel1
))
1832 (message "No changes to %s since latest version" file
))
1834 (pop-to-buffer (current-buffer))
1835 ;; Gnus-5.8.5 sets up an autoload for diff-mode, even if it's
1836 ;; not available. Work around that.
1837 (if (require 'diff-mode nil t
) (diff-mode))
1838 (vc-exec-after '(let ((inhibit-read-only t
))
1839 (if (eq (buffer-size) 0)
1840 (insert "No differences found.\n"))
1841 (goto-char (point-min))
1842 (shrink-window-if-larger-than-buffer)))
1845 (defun vc-diff-internal (file rel1 rel2
)
1846 "Run diff to compare FILE's revisions REL1 and REL2.
1847 Output goes to the current buffer, which is assumed properly set up.
1848 The exit status of the diff command is returned.
1850 This function takes care to set up a proper coding system for diff output.
1851 If both revisions are available as local files, then it also does not
1852 actually call the backend, but performs a local diff."
1853 (if (or (not rel1
) (string-equal rel1
""))
1854 (setq rel1
(vc-workfile-version file
)))
1855 (if (string-equal rel2
"")
1857 (let ((file-rel1 (vc-version-backup-file file rel1
))
1858 (file-rel2 (if (not rel2
)
1860 (vc-version-backup-file file rel2
)))
1861 (coding-system-for-read (vc-coding-system-for-diff file
)))
1862 (if (and file-rel1 file-rel2
)
1863 (apply 'vc-do-command
"*vc-diff*" 1 "diff" nil
1864 (append (if (listp diff-switches
)
1866 (list diff-switches
))
1867 (if (listp vc-diff-switches
)
1869 (list vc-diff-switches
))
1870 (list (file-relative-name file-rel1
)
1871 (file-relative-name file-rel2
))))
1872 (vc-call diff file rel1 rel2
))))
1874 (defmacro vc-diff-switches-list
(backend)
1875 "Return the list of switches to use for executing diff under BACKEND."
1877 (if (listp diff-switches
) diff-switches
(list diff-switches
))
1878 (if (listp vc-diff-switches
) vc-diff-switches
(list vc-diff-switches
))
1879 (let* ((backend-switches-symbol
1880 (intern (concat "vc-" (downcase (symbol-name ,backend
))
1883 (if (boundp backend-switches-symbol
)
1884 (eval backend-switches-symbol
)
1886 (if (listp backend-switches
) backend-switches
(list backend-switches
)))))
1888 (defun vc-default-diff-tree (backend dir rel1 rel2
)
1889 "List differences for all registered files at and below DIR.
1890 The meaning of REL1 and REL2 is the same as for `vc-version-diff'."
1891 ;; This implementation does an explicit tree walk, and calls
1892 ;; vc-BACKEND-diff directly for each file. An optimization
1893 ;; would be to use `vc-diff-internal', so that diffs can be local,
1894 ;; and to call it only for files that are actually changed.
1895 ;; However, this is expensive for some backends, and so it is left
1896 ;; to backend-specific implementations.
1897 (setq default-directory dir
)
1902 `(let ((coding-system-for-read (vc-coding-system-for-diff ',f
)))
1903 (message "Looking at %s" ',f
)
1904 (vc-call-backend ',(vc-backend f
)
1905 'diff
',f
',rel1
',rel2
))))))
1907 (defun vc-coding-system-for-diff (file)
1908 "Return the coding system for reading diff output for FILE."
1909 (or coding-system-for-read
1910 ;; if we already have this file open,
1911 ;; use the buffer's coding system
1912 (let ((buf (find-buffer-visiting file
)))
1913 (if buf
(with-current-buffer buf
1914 buffer-file-coding-system
)))
1915 ;; otherwise, try to find one based on the file name
1916 (car (find-operation-coding-system 'insert-file-contents
1918 ;; and a final fallback
1922 (defun vc-version-other-window (rev)
1923 "Visit version REV of the current file in another window.
1924 If the current file is named `F', the version is named `F.~REV~'.
1925 If `F.~REV~' already exists, use it instead of checking it out again."
1926 (interactive "sVersion to visit (default is workfile version): ")
1927 (vc-ensure-vc-buffer)
1928 (let* ((file buffer-file-name
)
1929 (version (if (string-equal rev
"")
1930 (vc-workfile-version file
)
1932 (switch-to-buffer-other-window (vc-find-version file version
))))
1934 (defun vc-find-version (file version
)
1935 "Read VERSION of FILE into a buffer and return the buffer."
1936 (let ((automatic-backup (vc-version-backup-file-name file version
))
1937 (manual-backup (vc-version-backup-file-name file version
'manual
)))
1938 (unless (file-exists-p manual-backup
)
1939 (if (file-exists-p automatic-backup
)
1940 (rename-file automatic-backup manual-backup nil
)
1941 (vc-call checkout file nil version manual-backup
)))
1942 (find-file-noselect manual-backup
)))
1944 ;; Header-insertion code
1947 (defun vc-insert-headers ()
1948 "Insert headers into a file for use with a version control system.
1949 Headers desired are inserted at point, and are pulled from
1950 the variable `vc-BACKEND-header'."
1952 (vc-ensure-vc-buffer)
1956 (if (or (not (vc-check-headers))
1957 (y-or-n-p "Version headers already exist. Insert another set? "))
1959 (let* ((delims (cdr (assq major-mode vc-comment-alist
)))
1960 (comment-start-vc (or (car delims
) comment-start
"#"))
1961 (comment-end-vc (or (car (cdr delims
)) comment-end
""))
1962 (hdsym (vc-make-backend-sym (vc-backend (buffer-file-name))
1964 (hdstrings (and (boundp hdsym
) (symbol-value hdsym
))))
1966 (insert comment-start-vc
"\t" s
"\t"
1967 comment-end-vc
"\n"))
1969 (if vc-static-header-alist
1971 (if (string-match (car f
) buffer-file-name
)
1972 (insert (format (cdr f
) (car hdstrings
)))))
1973 vc-static-header-alist
))
1977 (defun vc-clear-headers (&optional file
)
1978 "Clear all version headers in the current buffer (or FILE).
1979 The headers are reset to their non-expanded form."
1980 (let* ((filename (or file buffer-file-name
))
1981 (visited (find-buffer-visiting filename
))
1982 (backend (vc-backend filename
)))
1983 (when (vc-find-backend-function backend
'clear-headers
)
1985 (let ((context (vc-buffer-context)))
1986 ;; save-excursion may be able to relocate point and mark
1987 ;; properly. If it fails, vc-restore-buffer-context
1988 ;; will give it a second try.
1990 (vc-call-backend backend
'clear-headers
))
1991 (vc-restore-buffer-context context
))
1992 (set-buffer (find-file-noselect filename
))
1993 (vc-call-backend backend
'clear-headers
)
1994 (kill-buffer filename
)))))
1998 "Merge changes between two versions into the current buffer's file.
1999 This asks for two versions to merge from in the minibuffer. If the
2000 first version is a branch number, then merge all changes from that
2001 branch. If the first version is empty, merge news, i.e. recent changes
2002 from the current branch.
2004 See Info node `Merging'."
2006 (vc-ensure-vc-buffer)
2008 (let* ((file buffer-file-name
)
2009 (backend (vc-backend file
))
2010 (state (vc-state file
))
2011 first-version second-version status
)
2014 (error "File is locked by %s" state
))
2015 ((not (vc-editable-p file
))
2017 "File must be checked out for merging. Check out now? ")
2018 (vc-checkout file t
)
2019 (error "Merge aborted"))))
2021 (read-string (concat "Branch or version to merge from "
2022 "(default: news on current branch): ")))
2023 (if (string= first-version
"")
2024 (if (not (vc-find-backend-function backend
'merge-news
))
2025 (error "Sorry, merging news is not implemented for %s" backend
)
2026 (setq status
(vc-call merge-news file
)))
2027 (if (not (vc-find-backend-function backend
'merge
))
2028 (error "Sorry, merging is not implemented for %s" backend
)
2029 (if (not (vc-branch-p first-version
))
2030 (setq second-version
2031 (read-string "Second version: "
2032 (concat (vc-branch-part first-version
) ".")))
2033 ;; We want to merge an entire branch. Set versions
2034 ;; accordingly, so that vc-BACKEND-merge understands us.
2035 (setq second-version first-version
)
2036 ;; first-version must be the starting point of the branch
2037 (setq first-version
(vc-branch-part first-version
)))
2038 (setq status
(vc-call merge file first-version second-version
))))
2039 (vc-maybe-resolve-conflicts file status
"WORKFILE" "MERGE SOURCE")))
2041 (defun vc-maybe-resolve-conflicts (file status
&optional name-A name-B
)
2042 (vc-resynch-buffer file t
(not (buffer-modified-p)))
2043 (if (zerop status
) (message "Merge successful")
2044 (if (fboundp 'smerge-mode
) (smerge-mode 1))
2045 (if (y-or-n-p "Conflicts detected. Resolve them now? ")
2046 (if (fboundp 'smerge-ediff
)
2048 (vc-resolve-conflicts name-A name-B
))
2049 (message "File contains conflict markers"))))
2051 (defvar vc-ediff-windows
)
2052 (defvar vc-ediff-result
)
2054 (defvar ediff-buffer-A
)
2055 (defvar ediff-buffer-B
)
2056 (defvar ediff-buffer-C
)
2057 (require 'ediff-util
))
2059 (defun vc-resolve-conflicts (&optional name-A name-B
)
2060 "Invoke ediff to resolve conflicts in the current buffer.
2061 The conflicts must be marked with rcsmerge conflict markers."
2063 (vc-ensure-vc-buffer)
2065 (file-name (file-name-nondirectory buffer-file-name
))
2066 (your-buffer (generate-new-buffer
2067 (concat "*" file-name
2068 " " (or name-A
"WORKFILE") "*")))
2069 (other-buffer (generate-new-buffer
2070 (concat "*" file-name
2071 " " (or name-B
"CHECKED-IN") "*")))
2072 (result-buffer (current-buffer)))
2074 (set-buffer your-buffer
)
2076 (insert-buffer result-buffer
)
2077 (goto-char (point-min))
2078 (while (re-search-forward (concat "^<<<<<<< "
2079 (regexp-quote file-name
) "\n") nil t
)
2082 (if (not (re-search-forward "^=======\n" nil t
))
2083 (error "Malformed conflict marker"))
2085 (let ((start (point)))
2086 (if (not (re-search-forward "^>>>>>>> [0-9.]+\n" nil t
))
2087 (error "Malformed conflict marker"))
2088 (delete-region start
(point))))
2091 (kill-buffer your-buffer
)
2092 (kill-buffer other-buffer
)
2093 (error "No conflict markers found")))
2094 (set-buffer other-buffer
)
2096 (insert-buffer result-buffer
)
2097 (goto-char (point-min))
2098 (while (re-search-forward (concat "^<<<<<<< "
2099 (regexp-quote file-name
) "\n") nil t
)
2100 (let ((start (match-beginning 0)))
2101 (if (not (re-search-forward "^=======\n" nil t
))
2102 (error "Malformed conflict marker"))
2103 (delete-region start
(point))
2104 (if (not (re-search-forward "^>>>>>>> [0-9.]+\n" nil t
))
2105 (error "Malformed conflict marker"))
2106 (replace-match "")))
2107 (let ((config (current-window-configuration))
2108 (ediff-default-variant 'default-B
))
2112 (set-buffer (ediff-merge-buffers your-buffer other-buffer
))
2114 ;; Ediff is now set up, and we are in the control buffer.
2115 ;; Do a few further adjustments and take precautions for exit.
2117 (make-local-variable 'vc-ediff-windows
)
2118 (setq vc-ediff-windows config
)
2119 (make-local-variable 'vc-ediff-result
)
2120 (setq vc-ediff-result result-buffer
)
2121 (make-local-variable 'ediff-quit-hook
)
2122 (setq ediff-quit-hook
2124 (let ((buffer-A ediff-buffer-A
)
2125 (buffer-B ediff-buffer-B
)
2126 (buffer-C ediff-buffer-C
)
2127 (result vc-ediff-result
)
2128 (windows vc-ediff-windows
))
2129 (ediff-cleanup-mess)
2132 (insert-buffer buffer-C
)
2133 (kill-buffer buffer-A
)
2134 (kill-buffer buffer-B
)
2135 (kill-buffer buffer-C
)
2136 (set-window-configuration windows
)
2137 (message "Conflict resolution finished; you may save the buffer"))))
2138 (message "Please resolve conflicts now; exit ediff when done")
2141 ;; The VC directory major mode. Coopt Dired for this.
2142 ;; All VC commands get mapped into logical equivalents.
2144 (defvar vc-dired-switches
)
2145 (defvar vc-dired-terse-mode
)
2147 (defvar vc-dired-mode-map
2148 (let ((map (make-sparse-keymap))
2149 (vmap (make-sparse-keymap)))
2150 (define-key map
"\C-xv" vmap
)
2151 (define-key map
"v" vmap
)
2152 (set-keymap-parent vmap vc-prefix-map
)
2153 (define-key vmap
"t" 'vc-dired-toggle-terse-mode
)
2156 (define-derived-mode vc-dired-mode dired-mode
"Dired under VC"
2157 "The major mode used in VC directory buffers.
2159 It works like Dired, but lists only files under version control, with
2160 the current VC state of each file being indicated in the place of the
2161 file's link count, owner, group and size. Subdirectories are also
2162 listed, and you may insert them into the buffer as desired, like in
2165 All Dired commands operate normally, with the exception of `v', which
2166 is redefined as the version control prefix, so that you can type
2167 `vl', `v=' etc. to invoke `vc-print-log', `vc-diff', and the like on
2168 the file named in the current Dired buffer line. `vv' invokes
2169 `vc-next-action' on this file, or on all files currently marked.
2170 There is a special command, `*l', to mark all files currently locked."
2171 ;; define-derived-mode does it for us in Emacs-21, but not in Emacs-20.
2172 ;; We do it here because dired might not be loaded yet
2173 ;; when vc-dired-mode-map is initialized.
2174 (set-keymap-parent vc-dired-mode-map dired-mode-map
)
2175 (add-hook 'dired-after-readin-hook
'vc-dired-hook nil t
)
2176 ;; The following is slightly modified from dired.el,
2177 ;; because file lines look a bit different in vc-dired-mode.
2178 (set (make-local-variable 'dired-move-to-filename-regexp
)
2180 ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
2181 ;; In some locales, month abbreviations are as short as 2 letters,
2182 ;; and they can be padded on the right with spaces.
2183 (month (concat l l
"+ *"))
2184 ;; Recognize any non-ASCII character.
2185 ;; The purpose is to match a Kanji character.
2187 ;; (k "[^\x00-\x7f\x80-\xff]")
2189 (yyyy "[0-9][0-9][0-9][0-9]")
2192 (HH:MM
"[ 0-2][0-9]:[0-5][0-9]")
2193 (western (concat "\\(" month s dd
"\\|" dd s month
"\\)"
2194 s
"\\(" HH
:MM
"\\|" s yyyy
"\\|" yyyy s
"\\)"))
2195 (japanese (concat mm k s dd k s
"\\(" s HH
:MM
"\\|" yyyy k
"\\)")))
2196 ;; the .* below ensures that we find the last match on a line
2197 (concat ".*" s
"\\(" western
"\\|" japanese
"\\)" s
)))
2198 (and (boundp 'vc-dired-switches
)
2200 (set (make-local-variable 'dired-actual-switches
)
2202 (set (make-local-variable 'vc-dired-terse-mode
) vc-dired-terse-display
)
2203 (setq vc-dired-mode t
))
2205 (defun vc-dired-toggle-terse-mode ()
2206 "Toggle terse display in VC Dired."
2208 (if (not vc-dired-mode
)
2210 (setq vc-dired-terse-mode
(not vc-dired-terse-mode
))
2211 (if vc-dired-terse-mode
2215 (defun vc-dired-mark-locked ()
2216 "Mark all files currently locked."
2218 (dired-mark-if (let ((f (dired-get-filename nil t
)))
2220 (not (file-directory-p f
))
2221 (not (vc-up-to-date-p f
))))
2224 (define-key vc-dired-mode-map
"*l" 'vc-dired-mark-locked
)
2226 (defun vc-default-dired-state-info (backend file
)
2227 (let ((state (vc-state file
)))
2229 ((stringp state
) (concat "(" state
")"))
2230 ((eq state
'edited
) (concat "(" (vc-user-login-name) ")"))
2231 ((eq state
'needs-merge
) "(merge)")
2232 ((eq state
'needs-patch
) "(patch)")
2233 ((eq state
'unlocked-changes
) "(stale)"))))
2235 (defun vc-dired-reformat-line (x)
2236 "Reformat a directory-listing line.
2237 Replace various columns with version control information.
2238 This code, like dired, assumes UNIX -l format."
2240 (let ((pos (point)) limit perm date-and-file
)
2242 (setq limit
(point))
2246 (re-search-forward ;; owner and group
2247 "^\\(..[drwxlts-]+ \\) *[0-9]+ [^ ]+ +[^ ]+ +[0-9]+\\( .*\\)"
2249 (re-search-forward ;; only owner displayed
2250 "^\\(..[drwxlts-]+ \\) *[0-9]+ [^ ]+ +[0-9]+\\( .*\\)"
2252 (re-search-forward ;; OS/2 -l format, no links, owner, group
2253 "^\\(..[drwxlts-]+ \\) *[0-9]+\\( .*\\)"
2255 (setq perm
(match-string 1)
2256 date-and-file
(match-string 2))
2257 (setq x
(substring (concat x
" ") 0 10))
2258 (replace-match (concat perm x date-and-file
)))))
2260 (defun vc-dired-hook ()
2261 "Reformat the listing according to version control.
2262 Called by dired after any portion of a vc-dired buffer has been read in."
2263 (message "Getting version information... ")
2264 (let (subdir filename
(buffer-read-only nil
) cvs-dir
)
2265 (goto-char (point-min))
2268 ;; subdir header line
2269 ((setq subdir
(dired-get-subdir))
2270 ;; if the backend supports it, get the state
2271 ;; of all files in this directory at once
2272 (let ((backend (vc-responsible-backend subdir
)))
2273 (if (vc-find-backend-function backend
'dir-state
)
2274 (vc-call-backend backend
'dir-state subdir
)))
2276 ;; erase (but don't remove) the "total" line
2277 (delete-region (point) (line-end-position))
2281 ((setq filename
(dired-get-filename nil t
))
2284 ((file-directory-p filename
)
2286 ((member (file-name-nondirectory filename
)
2287 vc-directory-exclusion-list
)
2288 (let ((pos (point)))
2289 (dired-kill-tree filename
)
2292 (vc-dired-terse-mode
2293 ;; Don't show directories in terse mode. Don't use
2294 ;; dired-kill-line to remove it, because in recursive listings,
2295 ;; that would remove the directory contents as well.
2296 (delete-region (line-beginning-position)
2297 (progn (forward-line 1) (point))))
2298 ((string-match "\\`\\.\\.?\\'" (file-name-nondirectory filename
))
2301 (vc-dired-reformat-line nil
)
2304 ((and (vc-backend filename
)
2305 (not (and vc-dired-terse-mode
2306 (vc-up-to-date-p filename
))))
2307 (vc-dired-reformat-line (vc-call dired-state-info filename
))
2310 (dired-kill-line))))
2312 (t (forward-line 1))))
2314 (message "Getting version information... done")
2317 (cond ((eq (count-lines (point-min) (point-max)) 1)
2318 (goto-char (point-min))
2319 (message "No files locked under %s" default-directory
)))))
2321 (defun vc-dired-purge ()
2322 "Remove empty subdirs."
2324 (goto-char (point-min))
2325 (while (setq subdir
(dired-get-subdir))
2327 (if (dired-get-filename nil t
)
2328 (if (not (dired-next-subdir 1 t
))
2329 (goto-char (point-max)))
2331 (if (not (string= (dired-current-directory) default-directory
))
2332 (dired-do-kill-lines t
"")
2333 ;; We cannot remove the top level directory.
2334 ;; Just make it look a little nicer.
2337 (if (not (dired-next-subdir 1 t
))
2338 (goto-char (point-max))))))
2339 (goto-char (point-min))))
2341 (defun vc-dired-buffers-for-dir (dir)
2342 "Return a list of all vc-dired buffers that currently display DIR."
2344 ;; Check whether dired is loaded.
2345 (when (fboundp 'dired-buffers-for-dir
)
2346 (mapcar (lambda (buffer)
2347 (with-current-buffer buffer
2349 (setq result
(append result
(list buffer
))))))
2350 (dired-buffers-for-dir dir
)))
2353 (defun vc-dired-resynch-file (file)
2354 "Update the entries for FILE in any VC Dired buffers that list it."
2355 (let ((buffers (vc-dired-buffers-for-dir (file-name-directory file
))))
2357 (mapcar (lambda (buffer)
2358 (with-current-buffer buffer
2359 (if (dired-goto-file file
)
2360 ;; bind vc-dired-terse-mode to nil so that
2361 ;; files won't vanish when they are checked in
2362 (let ((vc-dired-terse-mode nil
))
2363 (dired-do-redisplay 1)))))
2367 (defun vc-directory (dir read-switches
)
2368 "Create a buffer in VC Dired Mode for directory DIR.
2370 See Info node `VC Dired Mode'.
2372 With prefix arg READ-SWITCHES, specify a value to override
2373 `dired-listing-switches' when generating the listing."
2374 (interactive "DDired under VC (directory): \nP")
2375 (let ((vc-dired-switches (concat vc-dired-listing-switches
2376 (if vc-dired-recurse
"R" ""))))
2378 (setq vc-dired-switches
2379 (read-string "Dired listing switches: "
2380 vc-dired-switches
)))
2382 (require 'dired-aux
)
2384 (dired-internal-noselect (expand-file-name (file-name-as-directory dir
))
2389 ;; Named-configuration entry points
2391 (defun vc-snapshot-precondition (dir)
2392 "Scan the tree below DIR, looking for files not up-to-date.
2393 If any file is not up-to-date, return the name of the first such file.
2394 \(This means, neither snapshot creation nor retrieval is allowed.\)
2395 If one or more of the files are currently visited, return `visited'.
2396 Otherwise, return nil."
2398 (catch 'vc-locked-example
2402 (if (not (vc-up-to-date-p f
)) (throw 'vc-locked-example f
)
2403 (if (get-file-buffer f
) (setq status
'visited
)))))
2407 (defun vc-create-snapshot (dir name branchp
)
2408 "Descending recursively from DIR, make a snapshot called NAME.
2409 For each registered file, the version level of its latest version
2410 becomes part of the named configuration. If the prefix argument
2411 BRANCHP is given, the snapshot is made as a new branch and the files
2412 are checked out in that new branch."
2414 (list (read-file-name "Directory: " default-directory default-directory t
)
2415 (read-string "New snapshot name: ")
2416 current-prefix-arg
))
2417 (message "Making %s... " (if branchp
"branch" "snapshot"))
2418 (if (file-directory-p dir
) (setq dir
(file-name-as-directory dir
)))
2419 (vc-call-backend (vc-responsible-backend dir
)
2420 'create-snapshot dir name branchp
)
2421 (message "Making %s... done" (if branchp
"branch" "snapshot")))
2423 (defun vc-default-create-snapshot (backend dir name branchp
)
2425 (error "VC backend %s does not support module branches" backend
))
2426 (let ((result (vc-snapshot-precondition dir
)))
2427 (if (stringp result
)
2428 (error "File %s is not up-to-date" result
)
2432 (vc-call assign-name f name
))))))
2435 (defun vc-retrieve-snapshot (dir name
)
2436 "Descending recursively from DIR, retrieve the snapshot called NAME.
2437 If NAME is empty, it refers to the latest versions.
2438 If locking is used for the files in DIR, then there must not be any
2439 locked files at or below DIR (but if NAME is empty, locked files are
2440 allowed and simply skipped)."
2442 (list (read-file-name "Directory: " default-directory default-directory t
)
2443 (read-string "Snapshot name to retrieve (default latest versions): ")))
2444 (let ((update (yes-or-no-p "Update any affected buffers? "))
2445 (msg (if (or (not name
) (string= name
""))
2446 (format "Updating %s... " (abbreviate-file-name dir
))
2447 (format "Retrieving snapshot into %s... "
2448 (abbreviate-file-name dir
)))))
2450 (vc-call-backend (vc-responsible-backend dir
)
2451 'retrieve-snapshot dir name update
)
2452 (message (concat msg
"done"))))
2454 (defun vc-default-retrieve-snapshot (backend dir name update
)
2455 (if (string= name
"")
2462 (vc-call checkout f nil
"")
2463 (if update
(vc-resynch-buffer f t t
)))))))
2464 (let ((result (vc-snapshot-precondition dir
)))
2465 (if (stringp result
)
2466 (error "File %s is locked" result
)
2467 (setq update
(and (eq result
'visited
) update
))
2470 (lambda (f) (vc-error-occurred
2471 (vc-call checkout f nil name
)
2472 (if update
(vc-resynch-buffer f t t
)))))))))
2474 ;; Miscellaneous other entry points
2477 (defun vc-print-log ()
2478 "List the change log of the current buffer in a window."
2480 (vc-ensure-vc-buffer)
2481 (let ((file buffer-file-name
))
2482 (vc-call print-log file
)
2484 (pop-to-buffer (current-buffer))
2485 (if (fboundp 'log-view-mode
) (log-view-mode))
2487 `(let ((inhibit-read-only t
))
2488 (goto-char (point-max)) (forward-line -
1)
2489 (while (looking-at "=*\n")
2490 (delete-char (- (match-end 0) (match-beginning 0)))
2492 (goto-char (point-min))
2493 (if (looking-at "[\b\t\n\v\f\r ]+")
2494 (delete-char (- (match-end 0) (match-beginning 0))))
2495 (shrink-window-if-larger-than-buffer)
2496 ;; move point to the log entry for the current version
2497 (if (fboundp 'log-view-goto-rev
)
2498 (log-view-goto-rev ',(vc-workfile-version file
))
2499 (if (vc-find-backend-function ',(vc-backend file
) 'show-log-entry
)
2500 (vc-call-backend ',(vc-backend file
)
2502 ',(vc-workfile-version file
))))
2503 (set-buffer-modified-p nil
)))))
2505 (defun vc-default-comment-history (backend file
)
2506 "Return a string with all log entries stored in BACKEND for FILE."
2507 (if (vc-find-backend-function backend
'print-log
)
2509 (vc-call print-log file
)
2510 (vc-call wash-log file
)
2513 (defun vc-default-wash-log (backend file
)
2514 "Remove all non-comment information from log output.
2515 This default implementation works for RCS logs; backends should override
2516 it if their logs are not in RCS format."
2517 (let ((separator (concat "^-+\nrevision [0-9.]+\ndate: .*\n"
2518 "\\(branches: .*;\n\\)?"
2519 "\\(\\*\\*\\* empty log message \\*\\*\\*\n\\)?")))
2520 (goto-char (point-max)) (forward-line -
1)
2521 (while (looking-at "=*\n")
2522 (delete-char (- (match-end 0) (match-beginning 0)))
2524 (goto-char (point-min))
2525 (if (looking-at "[\b\t\n\v\f\r ]+")
2526 (delete-char (- (match-end 0) (match-beginning 0))))
2527 (goto-char (point-min))
2528 (re-search-forward separator nil t
)
2529 (delete-region (point-min) (point))
2530 (while (re-search-forward separator nil t
)
2531 (delete-region (match-beginning 0) (match-end 0)))))
2534 (defun vc-revert-buffer ()
2535 "Revert the current buffer's file to the version it was based on.
2536 This asks for confirmation if the buffer contents are not identical
2537 to that version. This function does not automatically pick up newer
2538 changes found in the master file; use \\[universal-argument] \\[vc-next-action] to do so."
2540 (vc-ensure-vc-buffer)
2541 (let ((file buffer-file-name
)
2542 ;; This operation should always ask for confirmation.
2543 (vc-suppress-confirm nil
)
2544 (obuf (current-buffer))
2546 (if (vc-up-to-date-p file
)
2547 (unless (yes-or-no-p "File seems up-to-date. Revert anyway? ")
2548 (error "Revert canceled")))
2549 (unless (vc-workfile-unchanged-p file
)
2550 ;; vc-diff selects the new window, which is not what we want:
2551 ;; if the new window is on another frame, that'd require the user
2552 ;; moving her mouse to answer the yes-or-no-p question.
2553 (let ((win (save-selected-window
2554 (setq status
(vc-diff nil t
)) (selected-window))))
2555 (vc-exec-after `(message nil
))
2558 (unless (yes-or-no-p "Discard changes? ")
2559 (error "Revert canceled"))
2561 (if (one-window-p t
)
2562 (if (window-dedicated-p (selected-window))
2563 (make-frame-invisible))
2564 (delete-window))))))
2567 (message "Reverting %s..." file
)
2568 (vc-revert-file file
)
2569 (message "Reverting %s...done" file
)))
2571 (defun vc-version-backup-file (file &optional rev
)
2572 "Return name of backup file for revision REV of FILE.
2573 If version backups should be used for FILE, and there exists
2574 such a backup for REV or the current workfile version of file,
2575 return its name; otherwise return nil."
2576 (when (vc-call make-version-backups-p file
)
2577 (let ((backup-file (vc-version-backup-file-name file rev
)))
2578 (if (file-exists-p backup-file
)
2580 ;; there is no automatic backup, but maybe the user made one manually
2581 (setq backup-file
(vc-version-backup-file-name file rev
'manual
))
2582 (if (file-exists-p backup-file
)
2585 (defun vc-revert-file (file)
2586 "Revert FILE back to the version it was based on."
2589 (let ((backup-file (vc-version-backup-file file
)))
2591 (copy-file backup-file file
'ok-if-already-exists
'keep-date
)
2592 (vc-delete-automatic-version-backups file
))
2593 (vc-call revert file backup-file
))
2594 `((vc-state . up-to-date
)
2595 (vc-checkout-time .
,(nth 5 (file-attributes file
)))))
2596 (vc-resynch-buffer file t t
))
2599 (defun vc-cancel-version (norevert)
2600 "Get rid of most recently checked in version of this file.
2601 A prefix argument NOREVERT means do not revert the buffer afterwards."
2603 (vc-ensure-vc-buffer)
2604 (let* ((file (buffer-file-name))
2605 (backend (vc-backend file
))
2606 (target (vc-workfile-version file
))
2607 (config (current-window-configuration)) done
)
2609 ((not (vc-find-backend-function backend
'cancel-version
))
2610 (error "Sorry, canceling versions is not supported under %s" backend
))
2611 ((not (vc-call latest-on-branch-p file
))
2612 (error "This is not the latest version; VC cannot cancel it"))
2613 ((not (vc-up-to-date-p file
))
2614 (error (substitute-command-keys "File is not up to date; use \\[vc-revert-buffer] to discard changes"))))
2615 (if (null (yes-or-no-p (format "Remove version %s from master? " target
)))
2617 (setq norevert
(or norevert
(not
2618 (yes-or-no-p "Revert buffer to most recent remaining version? "))))
2620 (message "Removing last change from %s..." file
)
2623 (vc-call cancel-version file norevert
)
2624 `((vc-state .
,(if norevert
'edited
'up-to-date
))
2625 (vc-checkout-time .
,(if norevert
2627 (nth 5 (file-attributes file
))))
2628 (vc-workfile-version . nil
)))
2629 (message "Removing last change from %s...done" file
)
2632 (norevert ;; clear version headers and mark the buffer modified
2633 (set-visited-file-name file
)
2634 (when (not vc-make-backup-files
)
2635 ;; inhibit backup for this buffer
2636 (make-local-variable 'backup-inhibited
)
2637 (setq backup-inhibited t
))
2638 (setq buffer-read-only nil
)
2641 (vc-dired-resynch-file file
))
2642 (t ;; revert buffer to file on disk
2643 (vc-resynch-buffer file t t
)))
2644 (message "Version %s has been removed from the master" target
))))
2647 (defun vc-switch-backend (file backend
)
2648 "Make BACKEND the current version control system for FILE.
2649 FILE must already be registered in BACKEND. The change is not
2650 permanent, only for the current session. This function only changes
2651 VC's perspective on FILE, it does not register or unregister it.
2652 By default, this command cycles through the registered backends.
2653 To get a prompt, use a prefix argument."
2657 (let ((backend (vc-backend buffer-file-name
))
2659 ;; Find the registered backends.
2660 (dolist (backend vc-handled-backends
)
2661 (when (vc-call-backend backend
'registered buffer-file-name
)
2662 (push backend backends
)))
2663 ;; Find the next backend.
2664 (let ((def (car (delq backend
(append (memq backend backends
) backends
))))
2665 (others (delete backend backends
)))
2667 ((null others
) (error "No other backend to switch to"))
2672 (format "Switch to backend [%s]: " def
)
2673 (mapcar (lambda (b) (list (downcase (symbol-name b
)))) backends
)
2674 nil t nil nil
(downcase (symbol-name def
))))))
2676 (unless (eq backend
(vc-backend file
))
2677 (vc-file-clearprops file
)
2678 (vc-file-setprop file
'vc-backend backend
)
2679 ;; Force recomputation of the state
2680 (unless (vc-call-backend backend
'registered file
)
2681 (vc-file-clearprops file
)
2682 (error "%s is not registered in %s" file backend
))
2683 (vc-mode-line file
)))
2686 (defun vc-transfer-file (file new-backend
)
2687 "Transfer FILE to another version control system NEW-BACKEND.
2688 If NEW-BACKEND has a higher precedence than FILE's current backend
2689 \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in
2690 NEW-BACKEND, using the version number from the current backend as the
2691 base level. If NEW-BACKEND has a lower precedence than the current
2692 backend, then commit all changes that were made under the current
2693 backend to NEW-BACKEND, and unregister FILE from the current backend.
2694 \(If FILE is not yet registered under NEW-BACKEND, register it.)"
2695 (let* ((old-backend (vc-backend file
))
2696 (edited (memq (vc-state file
) '(edited needs-merge
)))
2697 (registered (vc-call-backend new-backend
'registered file
))
2699 (and registered
; Never move if not registered in new-backend yet.
2700 ;; move if new-backend comes later in vc-handled-backends
2701 (or (memq new-backend
(memq old-backend vc-handled-backends
))
2702 (y-or-n-p "Final transfer? "))))
2704 (if (eq old-backend new-backend
)
2705 (error "%s is the current backend of %s" new-backend file
))
2707 (set-file-modes file
(logior (file-modes file
) 128))
2708 ;; `registered' might have switched under us.
2709 (vc-switch-backend file old-backend
)
2710 (let* ((rev (vc-workfile-version file
))
2711 (modified-file (and edited
(make-temp-name file
)))
2712 (unmodified-file (and modified-file
(vc-version-backup-file file
))))
2713 ;; Go back to the base unmodified file.
2717 (copy-file file modified-file
)
2718 ;; If we have a local copy of the unmodified file, handle that
2719 ;; here and not in vc-revert-file because we don't want to
2720 ;; delete that copy -- it is still useful for OLD-BACKEND.
2722 (copy-file unmodified-file file
'ok-if-already-exists
)
2723 (if (y-or-n-p "Get base version from master? ")
2724 (vc-revert-file file
))))
2725 (vc-call-backend new-backend
'receive-file file rev
))
2727 (vc-switch-backend file new-backend
)
2728 (unless (eq (vc-checkout-model file
) 'implicit
)
2729 (vc-checkout file t nil
))
2730 (rename-file modified-file file
'ok-if-already-exists
)
2731 (vc-file-setprop file
'vc-checkout-time nil
)))))
2733 (vc-switch-backend file old-backend
)
2734 (setq comment
(vc-call comment-history file
))
2735 (vc-call unregister file
))
2736 (vc-switch-backend file new-backend
)
2737 (when (or move edited
)
2738 (vc-file-setprop file
'vc-state
'edited
)
2740 (vc-checkin file nil comment
(stringp comment
)))))
2742 (defun vc-default-unregister (backend file
)
2743 "Default implementation of `vc-unregister', signals an error."
2744 (error "Unregistering files is not supported for %s" backend
))
2746 (defun vc-default-receive-file (backend file rev
)
2747 "Let BACKEND receive FILE from another version control system."
2748 (vc-call-backend backend
'register file rev
""))
2750 (defun vc-rename-master (oldmaster newfile templates
)
2751 "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES."
2752 (let* ((dir (file-name-directory (expand-file-name oldmaster
)))
2753 (newdir (or (file-name-directory newfile
) ""))
2754 (newbase (file-name-nondirectory newfile
))
2756 ;; List of potential master files for `newfile'
2758 (lambda (s) (vc-possible-master s newdir newbase
))
2760 (if (or (file-symlink-p oldmaster
)
2761 (file-symlink-p (file-name-directory oldmaster
)))
2762 (error "This is unsafe in the presence of symbolic links"))
2766 ;; If possible, keep the master file in the same directory.
2768 (if (and f
(string= (file-name-directory (expand-file-name f
))
2772 ;; If not, just use the first possible place.
2775 (or (not (setq dir
(file-name-directory f
)))
2776 (file-directory-p dir
))
2779 (error "New file lacks a version control directory")))))
2782 (defun vc-rename-file (old new
)
2783 "Rename file OLD to NEW, and rename its master file likewise."
2784 (interactive "fVC rename file: \nFRename to: ")
2785 (let ((oldbuf (get-file-buffer old
))
2786 (backend (vc-backend old
)))
2787 (unless (or (null backend
) (vc-find-backend-function backend
'rename-file
))
2788 (error "Renaming files under %s is not supported in VC" backend
))
2789 (if (and oldbuf
(buffer-modified-p oldbuf
))
2790 (error "Please save files before moving them"))
2791 (if (get-file-buffer new
)
2792 (error "Already editing new file name"))
2793 (if (file-exists-p new
)
2794 (error "New file already exists"))
2796 (if (and backend
(not (vc-up-to-date-p old
)))
2797 (error "Please check in files before moving them"))
2798 (vc-call-backend backend
'rename-file old new
))
2799 ;; Move the actual file (unless the backend did it already)
2800 (if (or (not backend
) (file-exists-p old
))
2801 (rename-file old new
))
2802 ;; ?? Renaming a file might change its contents due to keyword expansion.
2803 ;; We should really check out a new copy if the old copy was precisely equal
2804 ;; to some checked in version. However, testing for this is tricky....
2806 (with-current-buffer oldbuf
2807 (let ((buffer-read-only buffer-read-only
))
2808 (set-visited-file-name new
))
2811 (set-buffer-modified-p nil
)))))
2813 ;; Only defined in very recent Emacsen
2814 (defvar small-temporary-file-directory nil
)
2817 (defun vc-update-change-log (&rest args
)
2818 "Find change log file and add entries from recent version control logs.
2819 Normally, find log entries for all registered files in the default
2822 With prefix arg of \\[universal-argument], only find log entries for the current buffer's file.
2824 With any numeric prefix arg, find log entries for all currently visited
2825 files that are under version control. This puts all the entries in the
2826 log for the default directory, which may not be appropriate.
2828 From a program, any ARGS are assumed to be filenames for which
2829 log entries should be gathered."
2831 (cond ((consp current-prefix-arg
) ;C-u
2832 (list buffer-file-name
))
2833 (current-prefix-arg ;Numeric argument.
2835 (buffers (buffer-list))
2838 (setq file
(buffer-file-name (car buffers
)))
2839 (and file
(vc-backend file
)
2840 (setq files
(cons file files
)))
2841 (setq buffers
(cdr buffers
)))
2844 ;; Don't supply any filenames to backend; this means
2845 ;; it should find all relevant files relative to
2846 ;; the default-directory.
2848 (vc-call-backend (vc-responsible-backend default-directory
)
2849 'update-changelog args
))
2851 (defun vc-default-update-changelog (backend files
)
2852 "Default implementation of update-changelog.
2853 Uses `rcs2log' which only works for RCS and CVS."
2854 ;; FIXME: We (c|sh)ould add support for cvs2cl
2855 (let ((odefault default-directory
)
2856 (changelog (find-change-log))
2857 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
2859 (if (fboundp 'make-temp-file
) 'make-temp-file
'make-temp-name
)
2860 (expand-file-name "vc"
2861 (or small-temporary-file-directory
2862 temporary-file-directory
))))
2863 (full-name (or add-log-full-name
2866 (format "uid%d" (number-to-string (user-uid)))))
2867 (mailing-address (or add-log-mailing-address
2868 user-mail-address
)))
2869 (find-file-other-window changelog
)
2870 (barf-if-buffer-read-only)
2873 (goto-char (point-min))
2875 (message "Computing change log entries...")
2876 (message "Computing change log entries... %s"
2879 (setq default-directory odefault
)
2880 (if (eq 0 (apply 'call-process
2881 (expand-file-name "rcs2log"
2883 nil
(list t tempfile
) nil
2885 "-u" (concat (vc-user-login-name)
2887 "\t" mailing-address
)
2891 (if (file-name-absolute-p f
)
2893 (concat odefault f
))))
2897 (set-buffer (get-buffer-create "*vc*")))
2899 (insert-file tempfile
)
2901 (setq default-directory
(file-name-directory changelog
))
2902 (delete-file tempfile
)))))
2904 ;; Annotate functionality
2906 ;; Declare globally instead of additional parameter to
2907 ;; temp-buffer-show-function (not possible to pass more than one
2908 ;; parameter). The use of annotate-ratio is deprecated in favor of
2909 ;; annotate-mode, which replaces it with the more sensible "span-to
2910 ;; days", along with autoscaling support.
2911 (defvar vc-annotate-ratio nil
"Global variable.")
2912 (defvar vc-annotate-backend nil
"Global variable.")
2914 (defun vc-annotate-get-backend (buffer)
2915 "Return the backend matching \"Annotate\" buffer BUFFER.
2916 Return nil if no match made. Associations are made based on
2917 `vc-annotate-buffers'."
2918 (cdr (assoc buffer vc-annotate-buffers
)))
2920 (define-derived-mode vc-annotate-mode fundamental-mode
"Annotate"
2921 "Major mode for output buffers of the `vc-annotate' command.
2923 You can use the mode-specific menu to alter the time-span of the used
2924 colors. See variable `vc-annotate-menu-elements' for customizing the
2926 (vc-annotate-add-menu))
2928 (defun vc-annotate-display-default (&optional ratio
)
2929 "Display the output of \\[vc-annotate] using the default color range.
2930 The color range is given by `vc-annotate-color-map', scaled by RATIO
2931 if present. The current time is used as the offset."
2933 (message "Redisplaying annotation...")
2934 (vc-annotate-display
2935 (if ratio
(vc-annotate-time-span vc-annotate-color-map ratio
)))
2936 (message "Redisplaying annotation...done"))
2938 (defun vc-annotate-display-autoscale (&optional full
)
2939 "Highlight the output of \\[vc-annotate]] using an autoscaled color map.
2940 Autoscaling means that the map is scaled from the current time to the
2941 oldest annotation in the buffer, or, with argument FULL non-nil, to
2942 cover the range from the oldest annotation to the newest."
2945 (oldest 999999.
) ;Any CVS users at the founding of Rome?
2946 (current (vc-annotate-convert-time (current-time)))
2948 (message "Redisplaying annotation...")
2949 ;; Run through this file and find the oldest and newest dates annotated.
2951 (goto-char (point-min))
2952 (while (setq date
(vc-call-backend vc-annotate-backend
'annotate-time
))
2956 (setq oldest date
))))
2957 (vc-annotate-display
2958 (vc-annotate-time-span ;return the scaled colormap.
2959 vc-annotate-color-map
2960 (/ (- (if full newest current
) oldest
)
2961 (vc-annotate-car-last-cons vc-annotate-color-map
)))
2963 (message "Redisplaying annotation...done \(%s\)"
2965 (format "Spanned from %.1f to %.1f days old"
2968 (format "Spanned to %.1f days old" (- current oldest
))))))
2970 ;; Menu -- Using easymenu.el
2971 (defun vc-annotate-add-menu ()
2972 "Add the menu 'Annotate' to the menu bar in VC-Annotate mode."
2973 (let ((menu-elements vc-annotate-menu-elements
)
2976 ["Default" (unless (null vc-annotate-display-mode
)
2977 (setq vc-annotate-display-mode nil
)
2978 (vc-annotate-display-select))
2979 :style toggle
:selected
(null vc-annotate-display-mode
)]))
2980 (oldest-in-map (vc-annotate-car-last-cons vc-annotate-color-map
)))
2981 (while menu-elements
2982 (let* ((element (car menu-elements
))
2983 (days (* element oldest-in-map
)))
2984 (setq menu-elements
(cdr menu-elements
))
2987 `([,(format "Span %.1f days" days
)
2988 (unless (and (numberp vc-annotate-display-mode
)
2989 (= vc-annotate-display-mode
,days
))
2990 (vc-annotate-display-select nil
,days
))
2991 :style toggle
:selected
2992 (and (numberp vc-annotate-display-mode
)
2993 (= vc-annotate-display-mode
,days
)) ])))))
2999 (float (string-to-number
3000 (read-string "Span how many days? ")))))
3001 (vc-annotate-display-select nil days
)) t
])
3005 (unless (eq vc-annotate-display-mode
'scale
)
3006 (vc-annotate-display-select nil
'scale
))
3007 :style toggle
:selected
3008 (eq vc-annotate-display-mode
'scale
)])
3010 ["Span Oldest->Newest"
3011 (unless (eq vc-annotate-display-mode
'fullscale
)
3012 (vc-annotate-display-select nil
'fullscale
))
3013 :style toggle
:selected
3014 (eq vc-annotate-display-mode
'fullscale
)])))
3016 (if (or (featurep 'easymenu
) (load "easymenu" t
))
3017 (easy-menu-define vc-annotate-mode-menu vc-annotate-mode-map
3018 "VC Annotate Display Menu" menu-def
))))
3020 (defun vc-annotate-display-select (&optional buffer mode
)
3021 "Highlight the output of \\[vc-annotate].
3022 By default, the current buffer is highlighted, unless overridden by
3023 BUFFER. `vc-annotate-display-mode' specifies the highlighting mode to
3024 use; you may override this using the second optional arg MODE."
3026 (if mode
(setq vc-annotate-display-mode mode
))
3029 (display-buffer buffer
))
3030 (if (not vc-annotate-mode
) ; Turn on vc-annotate-mode if not done
3032 (cond ((null vc-annotate-display-mode
) (vc-annotate-display-default
3034 ((symbolp vc-annotate-display-mode
) ; One of the auto-scaling modes
3035 (cond ((eq vc-annotate-display-mode
'scale
)
3036 (vc-annotate-display-autoscale))
3037 ((eq vc-annotate-display-mode
'fullscale
)
3038 (vc-annotate-display-autoscale t
))
3039 (t (error "No such display mode: %s"
3040 vc-annotate-display-mode
))))
3041 ((numberp vc-annotate-display-mode
) ; A fixed number of days lookback
3042 (vc-annotate-display-default
3043 (/ vc-annotate-display-mode
(vc-annotate-car-last-cons
3044 vc-annotate-color-map
))))
3045 (t (error "Error in display mode select"))))
3047 ;;;; (defun vc-BACKEND-annotate-command (file buffer) ...)
3048 ;;;; Execute "annotate" on FILE by using `call-process' and insert
3049 ;;;; the contents in BUFFER.
3052 (defun vc-annotate (prefix)
3053 "Display the edit history of the current file using colours.
3055 This command creates a buffer that shows, for each line of the current
3056 file, when it was last edited and by whom. Additionally, colours are
3057 used to show the age of each line--blue means oldest, red means
3058 youngest, and intermediate colours indicate intermediate ages. By
3059 default, the time scale stretches back one year into the past;
3060 everything that is older than that is shown in blue.
3062 With a prefix argument, this command asks two questions in the
3063 minibuffer. First, you may enter a version number; then the buffer
3064 displays and annotates that version instead of the current version
3065 \(type RET in the minibuffer to leave that default unchanged). Then,
3066 you are prompted for the time span in days which the color range
3067 should cover. For example, a time span of 20 days means that changes
3068 over the past 20 days are shown in red to blue, according to their
3069 age, and everything that is older than that is shown in blue.
3071 Customization variables:
3073 `vc-annotate-menu-elements' customizes the menu elements of the
3074 mode-specific menu. `vc-annotate-color-map' and
3075 `vc-annotate-very-old-color' defines the mapping of time to
3076 colors. `vc-annotate-background' specifies the background color."
3078 (vc-ensure-vc-buffer)
3079 (let* ((temp-buffer-name (concat "*Annotate " (buffer-name) "*"))
3080 (temp-buffer-show-function 'vc-annotate-display-select
)
3081 (rev (vc-workfile-version (buffer-file-name)))
3082 (vc-annotate-version
3083 (if prefix
(read-string
3084 (format "Annotate from version: (default %s) " rev
)
3088 (setq vc-annotate-display-mode
3089 (float (string-to-number
3090 (read-string "Annotate span days: (default 20) "
3092 (setq vc-annotate-backend
(vc-backend (buffer-file-name)))
3093 (message "Annotating...")
3094 (if (not (vc-find-backend-function vc-annotate-backend
'annotate-command
))
3095 (error "Sorry, annotating is not implemented for %s"
3096 vc-annotate-backend
))
3097 (with-output-to-temp-buffer temp-buffer-name
3098 (vc-call-backend vc-annotate-backend
'annotate-command
3099 (file-name-nondirectory (buffer-file-name))
3100 (get-buffer temp-buffer-name
)
3101 vc-annotate-version
))
3102 ;; Don't use the temp-buffer-name until the buffer is created
3103 ;; (only after `with-output-to-temp-buffer'.)
3104 (setq vc-annotate-buffers
3105 (append vc-annotate-buffers
3106 (list (cons (get-buffer temp-buffer-name
) vc-annotate-backend
))))
3107 (message "Annotating... done")))
3109 (defun vc-annotate-car-last-cons (a-list)
3110 "Return car of last cons in association list A-LIST."
3111 (if (not (eq nil
(cdr a-list
)))
3112 (vc-annotate-car-last-cons (cdr a-list
))
3113 (car (car a-list
))))
3115 (defun vc-annotate-time-span (a-list span
&optional quantize
)
3116 "Apply factor SPAN to the time-span of association list A-LIST.
3117 Return the new alist.
3118 Optionally quantize to the factor of QUANTIZE."
3119 ;; Apply span to each car of every cons
3120 (if (not (eq nil a-list
))
3121 (append (list (cons (* (car (car a-list
)) span
)
3122 (cdr (car a-list
))))
3123 (vc-annotate-time-span (nthcdr (or quantize
; optional
3125 a-list
) span quantize
))))
3127 (defun vc-annotate-compcar (threshold a-list
)
3128 "Test successive cons cells of A-LIST against THRESHOLD.
3129 Return the first cons cell with a car that is not less than THRESHOLD,
3130 nil if no such cell exists."
3132 (tmp-cons (car a-list
)))
3133 (while (and tmp-cons
(< (car tmp-cons
) threshold
))
3134 (setq tmp-cons
(car (nthcdr i a-list
)))
3136 tmp-cons
)) ; Return the appropriate value
3138 (defun vc-annotate-convert-time (time)
3139 "Convert a time value to a floating-point number of days.
3140 The argument TIME is a list as returned by `current-time' or
3141 `encode-time', only the first two elements of that list are considered."
3142 (/ (+ (* (float (car time
)) (lsh 1 16)) (cadr time
)) 24 3600))
3144 (defun vc-annotate-difference (&optional offset
)
3145 "Return the time span in days to the next annotation.
3146 This calls the backend function annotate-time, and returns the
3147 difference in days between the time returned and the current time,
3148 or OFFSET if present."
3149 (let ((next-time (vc-call-backend vc-annotate-backend
'annotate-time
)))
3152 (vc-call-backend vc-annotate-backend
'annotate-current-time
))
3155 (defun vc-default-annotate-current-time (backend)
3156 "Return the current time, encoded as fractional days."
3157 (vc-annotate-convert-time (current-time)))
3159 (defun vc-annotate-display (&optional color-map offset
)
3160 "Highlight `vc-annotate' output in the current buffer.
3161 COLOR-MAP, if present, overrides `vc-annotate-color-map'. The
3162 annotations are relative to the current time, unless overridden by
3165 This function is obsolete, and has been replaced by
3166 `vc-annotate-select'."
3168 (goto-char (point-min)) ; Position at the top of the buffer.
3169 ;; Delete old overlays
3172 (if (overlay-get overlay
'vc-annotation
)
3173 (delete-overlay overlay
)))
3174 (overlays-in (point-min) (point-max)))
3175 (goto-char (point-min)) ; Position at the top of the buffer.
3177 (while (setq difference
(vc-annotate-difference offset
))
3179 ((color (or (vc-annotate-compcar
3180 difference
(or color-map vc-annotate-color-map
))
3181 (cons nil vc-annotate-very-old-color
)))
3182 ;; substring from index 1 to remove any leading `#' in the name
3183 (face-name (concat "vc-annotate-face-" (substring (cdr color
) 1)))
3184 ;; Make the face if not done.
3185 (face (or (intern-soft face-name
)
3186 (let ((tmp-face (make-face (intern face-name
))))
3187 (set-face-foreground tmp-face
(cdr color
))
3188 (if vc-annotate-background
3189 (set-face-background tmp-face
3190 vc-annotate-background
))
3191 tmp-face
))) ; Return the face
3195 (setq overlay
(make-overlay point
(point)))
3196 (overlay-put overlay
'face face
)
3197 (overlay-put overlay
'vc-annotation t
))))))
3199 ;; Collect back-end-dependent stuff here
3201 (defalias 'vc-default-logentry-check
'ignore
)
3203 (defun vc-check-headers ()
3204 "Check if the current file has any headers in it."
3206 (vc-call-backend (vc-backend buffer-file-name
) 'check-headers
))
3208 (defun vc-default-check-headers (backend)
3209 "Default implementation of check-headers; always returns nil."
3212 ;; Back-end-dependent stuff ends here.
3214 ;; Set up key bindings for use while editing log messages
3216 (define-derived-mode vc-log-mode text-mode
"VC-Log"
3217 "Major mode for editing VC log entries.
3218 These bindings are added to the global keymap when you enter this mode:
3219 \\[vc-next-action] perform next logical version-control operation on current file
3220 \\[vc-register] register current file
3221 \\[vc-toggle-read-only] like next-action, but won't register files
3222 \\[vc-insert-headers] insert version-control headers in current file
3223 \\[vc-print-log] display change history of current file
3224 \\[vc-revert-buffer] revert buffer to latest version
3225 \\[vc-cancel-version] undo latest checkin
3226 \\[vc-diff] show diffs between file versions
3227 \\[vc-version-other-window] visit old version in another window
3228 \\[vc-directory] show all files locked by any user in or below .
3229 \\[vc-annotate] colorful display of the cvs annotate command
3230 \\[vc-update-change-log] add change log entry from recent checkins
3232 While you are entering a change log message for a version, the following
3233 additional bindings will be in effect.
3235 \\[vc-finish-logentry] proceed with check in, ending log message entry
3237 Whenever you do a checkin, your log comment is added to a ring of
3238 saved comments. These can be recalled as follows:
3240 \\[vc-next-comment] replace region with next message in comment ring
3241 \\[vc-previous-comment] replace region with previous message in comment ring
3242 \\[vc-comment-search-reverse] search backward for regexp in the comment ring
3243 \\[vc-comment-search-forward] search backward for regexp in the comment ring
3245 Entry to the change-log submode calls the value of `text-mode-hook', then
3246 the value of `vc-log-mode-hook'.
3248 Global user options:
3249 `vc-initial-comment' If non-nil, require user to enter a change
3250 comment upon first checkin of the file.
3252 `vc-keep-workfiles' Non-nil value prevents workfiles from being
3253 deleted when changes are checked in
3255 `vc-suppress-confirm' Suppresses some confirmation prompts.
3257 vc-BACKEND-header Which keywords to insert when adding headers
3258 with \\[vc-insert-headers]. Defaults to
3259 '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under
3262 `vc-static-header-alist' By default, version headers inserted in C files
3263 get stuffed in a static string area so that
3264 ident(RCS/CVS) or what(SCCS) can see them in
3265 the compiled object code. You can override
3266 this by setting this variable to nil, or change
3267 the header template by changing it.
3269 `vc-command-messages' if non-nil, display run messages from the
3270 actual version-control utilities (this is
3271 intended primarily for people hacking vc
3273 (make-local-variable 'vc-comment-ring-index
))
3275 (defun vc-log-edit (file)
3276 "Set up `log-edit' for use with VC on FILE.
3277 If `log-edit' is not available, resort to `vc-log-mode'."
3278 (setq default-directory
3279 (if file
(file-name-directory file
)
3280 (with-current-buffer vc-parent-buffer default-directory
)))
3281 (if (fboundp 'log-edit
)
3282 (log-edit 'vc-finish-logentry nil
3283 (if file
`(lambda () ',(list (file-name-nondirectory file
)))
3284 ;; If FILE is nil, we were called from vc-dired.
3286 (with-current-buffer vc-parent-buffer
3287 (dired-get-marked-files t
)))))
3289 (set (make-local-variable 'vc-log-file
) file
)
3290 (make-local-variable 'vc-log-version
)
3291 (set-buffer-modified-p nil
)
3292 (setq buffer-file-name nil
))
3294 ;; These things should probably be generally available
3296 (defun vc-file-tree-walk (dirname func
&rest args
)
3297 "Walk recursively through DIRNAME.
3298 Invoke FUNC f ARGS on each VC-managed file f underneath it."
3299 (vc-file-tree-walk-internal (expand-file-name dirname
) func args
)
3300 (message "Traversing directory %s...done" dirname
))
3302 (defun vc-file-tree-walk-internal (file func args
)
3303 (if (not (file-directory-p file
))
3304 (if (vc-backend file
) (apply func file args
))
3305 (message "Traversing directory %s..." (abbreviate-file-name file
))
3306 (let ((dir (file-name-as-directory file
)))
3309 (string-equal f
".")
3310 (string-equal f
"..")
3311 (member f vc-directory-exclusion-list
)
3312 (let ((dirf (expand-file-name f dir
)))
3314 (file-symlink-p dirf
);; Avoid possible loops
3315 (vc-file-tree-walk-internal dirf func args
)))))
3316 (directory-files dir
)))))
3320 ;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
3322 ;; These may be useful to anyone who has to debug or extend the package.
3323 ;; (Note that this information corresponds to versions 5.x. Some of it
3324 ;; might have been invalidated by the additions to support branching
3325 ;; and RCS keyword lookup. AS, 1995/03/24)
3327 ;; A fundamental problem in VC is that there are time windows between
3328 ;; vc-next-action's computations of the file's version-control state and
3329 ;; the actions that change it. This is a window open to lossage in a
3330 ;; multi-user environment; someone else could nip in and change the state
3331 ;; of the master during it.
3333 ;; The performance problem is that rlog/prs calls are very expensive; we want
3334 ;; to avoid them as much as possible.
3338 ;; The performance problem, it turns out, simplifies in practice to the
3339 ;; problem of making vc-state fast. The two other functions that call
3340 ;; prs/rlog will not be so commonly used that the slowdown is a problem; one
3341 ;; makes snapshots, the other deletes the calling user's last change in the
3344 ;; The race condition implies that we have to either (a) lock the master
3345 ;; during the entire execution of vc-next-action, or (b) detect and
3346 ;; recover from errors resulting from dispatch on an out-of-date state.
3348 ;; Alternative (a) appears to be infeasible. The problem is that we can't
3349 ;; guarantee that the lock will ever be removed. Suppose a user starts a
3350 ;; checkin, the change message buffer pops up, and the user, having wandered
3351 ;; off to do something else, simply forgets about it?
3353 ;; Alternative (b), on the other hand, works well with a cheap way to speed up
3354 ;; vc-state. Usually, if a file is registered, we can read its locked/
3355 ;; unlocked state and its current owner from its permissions.
3357 ;; This shortcut will fail if someone has manually changed the workfile's
3358 ;; permissions; also if developers are munging the workfile in several
3359 ;; directories, with symlinks to a master (in this latter case, the
3360 ;; permissions shortcut will fail to detect a lock asserted from another
3363 ;; Note that these cases correspond exactly to the errors which could happen
3364 ;; because of a competing checkin/checkout race in between two instances of
3367 ;; For VC's purposes, a workfile/master pair may have the following states:
3369 ;; A. Unregistered. There is a workfile, there is no master.
3371 ;; B. Registered and not locked by anyone.
3373 ;; C. Locked by calling user and unchanged.
3375 ;; D. Locked by the calling user and changed.
3377 ;; E. Locked by someone other than the calling user.
3379 ;; This makes for 25 states and 20 error conditions. Here's the matrix:
3381 ;; VC's idea of state
3383 ;; V Actual state RCS action SCCS action Effect
3385 ;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
3386 ;; B 5 . 6 7 8 co -l get -e checkout
3387 ;; C 9 10 . 11 12 co -u unget; get revert
3388 ;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
3389 ;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
3391 ;; All commands take the master file name as a last argument (not shown).
3393 ;; In the discussion below, a "self-race" is a pathological situation in
3394 ;; which VC operations are being attempted simultaneously by two or more
3395 ;; Emacsen running under the same username.
3397 ;; The vc-next-action code has the following windows:
3400 ;; Between the check for existence of a master file and the call to
3401 ;; admin/checkin in vc-buffer-admin (apparent state A). This window may
3402 ;; never close if the initial-comment feature is on.
3405 ;; Between the call to vc-workfile-unchanged-p in and the immediately
3406 ;; following revert (apparent state C).
3409 ;; Between the call to vc-workfile-unchanged-p in and the following
3410 ;; checkin (apparent state D). This window may never close.
3413 ;; Between the unlock and the immediately following checkout during a
3414 ;; revert operation (apparent state C). Included in window Q.
3417 ;; Between vc-state and the following checkout (apparent state B).
3420 ;; Between vc-state and the following revert (apparent state C).
3421 ;; Includes windows Q and S.
3424 ;; Between vc-state and the following checkin (apparent state
3425 ;; D). This window may never be closed if the user fails to complete the
3426 ;; checkin message. Includes window R.
3429 ;; Between vc-state and the following steal-lock (apparent
3430 ;; state E). This window may never close if the user fails to complete
3431 ;; the steal-lock message. Includes window X.
3434 ;; Between the unlock and the immediately following re-lock during a
3435 ;; steal-lock operation (apparent state E). This window may never close
3436 ;; if the user fails to complete the steal-lock message.
3440 ;; Apparent state A ---
3442 ;; 1. File looked unregistered but is actually registered and not locked.
3444 ;; Potential cause: someone else's admin during window P, with
3445 ;; caller's admin happening before their checkout.
3447 ;; RCS: Prior to version 5.6.4, ci fails with message
3448 ;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
3449 ;; ci -i option and the message is "<file>,v: already exists".
3450 ;; SCCS: admin will fail with error (ad19).
3452 ;; We can let these errors be passed up to the user.
3454 ;; 2. File looked unregistered but is actually locked by caller, unchanged.
3456 ;; Potential cause: self-race during window P.
3458 ;; RCS: Prior to version 5.6.4, reverts the file to the last saved
3459 ;; version and unlocks it. From 5.6.4 onwards, VC uses the new
3460 ;; ci -i option, failing with message "<file>,v: already exists".
3461 ;; SCCS: will fail with error (ad19).
3463 ;; Either of these consequences is acceptable.
3465 ;; 3. File looked unregistered but is actually locked by caller, changed.
3467 ;; Potential cause: self-race during window P.
3469 ;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
3470 ;; a delta with a null change comment (the -t- switch will be
3471 ;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
3472 ;; failing with message "<file>,v: already exists".
3473 ;; SCCS: will fail with error (ad19).
3475 ;; 4. File looked unregistered but is locked by someone else.
3477 ;; Potential cause: someone else's admin during window P, with
3478 ;; caller's admin happening *after* their checkout.
3480 ;; RCS: Prior to version 5.6.4, ci fails with a
3481 ;; "no lock set by <user>" message. From 5.6.4 onwards,
3482 ;; VC uses the new ci -i option, failing with message
3483 ;; "<file>,v: already exists".
3484 ;; SCCS: will fail with error (ad19).
3486 ;; We can let these errors be passed up to the user.
3488 ;; Apparent state B ---
3490 ;; 5. File looked registered and not locked, but is actually unregistered.
3492 ;; Potential cause: master file got nuked during window P.
3494 ;; RCS: will fail with "RCS/<file>: No such file or directory"
3495 ;; SCCS: will fail with error ut4.
3497 ;; We can let these errors be passed up to the user.
3499 ;; 6. File looked registered and not locked, but is actually locked by the
3500 ;; calling user and unchanged.
3502 ;; Potential cause: self-race during window T.
3504 ;; RCS: in the same directory as the previous workfile, co -l will fail
3505 ;; with "co error: writable foo exists; checkout aborted". In any other
3506 ;; directory, checkout will succeed.
3507 ;; SCCS: will fail with ge17.
3509 ;; Either of these consequences is acceptable.
3511 ;; 7. File looked registered and not locked, but is actually locked by the
3512 ;; calling user and changed.
3516 ;; 8. File looked registered and not locked, but is actually locked by another
3519 ;; Potential cause: someone else checks it out during window T.
3521 ;; RCS: co error: revision 1.3 already locked by <user>
3522 ;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
3524 ;; We can let these errors be passed up to the user.
3526 ;; Apparent state C ---
3528 ;; 9. File looks locked by calling user and unchanged, but is unregistered.
3532 ;; 10. File looks locked by calling user and unchanged, but is actually not
3535 ;; Potential cause: a self-race in window U, or by the revert's
3536 ;; landing during window X of some other user's steal-lock or window S
3537 ;; of another user's revert.
3539 ;; RCS: succeeds, refreshing the file from the identical version in
3541 ;; SCCS: fails with error ut4 (p file nonexistent).
3543 ;; Either of these consequences is acceptable.
3545 ;; 11. File is locked by calling user. It looks unchanged, but is actually
3548 ;; Potential cause: the file would have to be touched by a self-race
3551 ;; The revert will succeed, removing whatever changes came with
3552 ;; the touch. It is theoretically possible that work could be lost.
3554 ;; 12. File looks like it's locked by the calling user and unchanged, but
3555 ;; it's actually locked by someone else.
3557 ;; Potential cause: a steal-lock in window V.
3559 ;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
3560 ;; SCCS: fails with error un2
3562 ;; We can pass these errors up to the user.
3564 ;; Apparent state D ---
3566 ;; 13. File looks like it's locked by the calling user and changed, but it's
3567 ;; actually unregistered.
3569 ;; Potential cause: master file got nuked during window P.
3571 ;; RCS: Prior to version 5.6.4, checks in the user's version as an
3572 ;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
3573 ;; option, failing with message "no such file or directory".
3574 ;; SCCS: will fail with error ut4.
3576 ;; This case is kind of nasty. Under RCS prior to version 5.6.4,
3577 ;; VC may fail to detect the loss of previous version information.
3579 ;; 14. File looks like it's locked by the calling user and changed, but it's
3580 ;; actually unlocked.
3582 ;; Potential cause: self-race in window V, or the checkin happening
3583 ;; during the window X of someone else's steal-lock or window S of
3584 ;; someone else's revert.
3586 ;; RCS: ci will fail with "no lock set by <user>".
3587 ;; SCCS: delta will fail with error ut4.
3589 ;; 15. File looks like it's locked by the calling user and changed, but it's
3590 ;; actually locked by the calling user and unchanged.
3592 ;; Potential cause: another self-race --- a whole checkin/checkout
3593 ;; sequence by the calling user would have to land in window R.
3595 ;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
3596 ;; RCS: reverts to the file state as of the second user's checkin, leaving
3597 ;; the file unlocked.
3599 ;; It is theoretically possible that work could be lost under RCS.
3601 ;; 16. File looks like it's locked by the calling user and changed, but it's
3602 ;; actually locked by a different user.
3604 ;; RCS: ci error: no lock set by <user>
3605 ;; SCCS: unget will fail with error un2
3607 ;; We can pass these errors up to the user.
3609 ;; Apparent state E ---
3611 ;; 17. File looks like it's locked by some other user, but it's actually
3616 ;; 18. File looks like it's locked by some other user, but it's actually
3619 ;; Potential cause: someone released a lock during window W.
3621 ;; RCS: The calling user will get the lock on the file.
3622 ;; SCCS: unget -n will fail with cm4.
3624 ;; Either of these consequences will be OK.
3626 ;; 19. File looks like it's locked by some other user, but it's actually
3627 ;; locked by the calling user and unchanged.
3629 ;; Potential cause: the other user relinquishing a lock followed by
3630 ;; a self-race, both in window W.
3632 ;; Under both RCS and SCCS, both unlock and lock will succeed, making
3633 ;; the sequence a no-op.
3635 ;; 20. File looks like it's locked by some other user, but it's actually
3636 ;; locked by the calling user and changed.
3642 ;; In order of decreasing severity:
3644 ;; Cases 11 and 15 are the only ones that potentially lose work.
3645 ;; They would require a self-race for this to happen.
3647 ;; Case 13 in RCS loses information about previous deltas, retaining
3648 ;; only the information in the current workfile. This can only happen
3649 ;; if the master file gets nuked in window P.
3651 ;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
3652 ;; no change comment in the master. This would require a self-race in
3653 ;; window P or R respectively.
3655 ;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
3657 ;; Unfortunately, it appears to me that no recovery is possible in these
3658 ;; cases. They don't yield error messages, so there's no way to tell that
3659 ;; a race condition has occurred.
3661 ;; All other cases don't change either the workfile or the master, and
3662 ;; trigger command errors which the user will see.
3664 ;; Thus, there is no explicit recovery code.