1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992,93,94,95,96,97,98,2000,01,2003,2004
4 ;; Free Software Foundation, Inc.
6 ;; Author: FSF (see below for full credits)
7 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
10 ;; $Id: vc.el,v 1.368 2004/03/15 03:55:24 monnier Exp $
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
31 ;; VC was initially designed and implemented by Eric S. Raymond
32 ;; <esr@snark.thyrsus.com>. Over the years, many people have
33 ;; contributed substantial amounts of work to VC. These include:
34 ;; Per Cederqvist <ceder@lysator.liu.se>
35 ;; Paul Eggert <eggert@twinsun.com>
36 ;; Sebastian Kremer <sk@thp.uni-koeln.de>
37 ;; Martin Lorentzson <martinl@gnu.org>
38 ;; Dave Love <fx@gnu.org>
39 ;; Stefan Monnier <monnier@cs.yale.edu>
40 ;; J.D. Smith <jdsmith@alum.mit.edu>
41 ;; Andre Spiegel <spiegel@gnu.org>
42 ;; Richard Stallman <rms@gnu.org>
43 ;; Thien-Thi Nguyen <ttn@gnu.org>
47 ;; This mode is fully documented in the Emacs user's manual.
49 ;; Supported version-control systems presently include SCCS, RCS, and CVS.
51 ;; Some features will not work with old RCS versions. Where
52 ;; appropriate, VC finds out which version you have, and allows or
53 ;; disallows those features (stealing locks, for example, works only
54 ;; from 5.6.2 onwards).
55 ;; Even initial checkins will fail if your RCS version is so old that ci
56 ;; doesn't understand -t-; this has been known to happen to people running
59 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
61 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
62 ;; to be installed somewhere on Emacs's path for executables.
64 ;; If your site uses the ChangeLog convention supported by Emacs, the
65 ;; function log-edit-comment-to-change-log could prove a useful checkin hook,
66 ;; although you might prefer to use C-c C-a (i.e. log-edit-insert-changelog)
67 ;; from the commit buffer instead or to set `log-edit-setup-invert'.
69 ;; The vc code maintains some internal state in order to reduce expensive
70 ;; version-control operations to a minimum. Some names are only computed
71 ;; once. If you perform version control operations with RCS/SCCS/CVS while
72 ;; vc's back is turned, or move/rename master files while vc is running,
73 ;; vc may get seriously confused. Don't do these things!
75 ;; Developer's notes on some concurrency issues are included at the end of
78 ;; ADDING SUPPORT FOR OTHER BACKENDS
80 ;; VC can use arbitrary version control systems as a backend. To add
81 ;; support for a new backend named SYS, write a library vc-sys.el that
82 ;; contains functions of the form `vc-sys-...' (note that SYS is in lower
83 ;; case for the function and library names). VC will use that library if
84 ;; you put the symbol SYS somewhere into the list of
85 ;; `vc-handled-backends'. Then, for example, if `vc-sys-registered'
86 ;; returns non-nil for a file, all SYS-specific versions of VC commands
87 ;; will be available for that file.
89 ;; VC keeps some per-file information in the form of properties (see
90 ;; vc-file-set/getprop in vc-hooks.el). The backend-specific functions
91 ;; do not generally need to be aware of these properties. For example,
92 ;; `vc-sys-workfile-version' should compute the workfile version and
93 ;; return it; it should not look it up in the property, and it needn't
94 ;; store it there either. However, if a backend-specific function does
95 ;; store a value in a property, that value takes precedence over any
96 ;; value that the generic code might want to set (check for uses of
97 ;; the macro `with-vc-properties' in vc.el).
99 ;; In the list of functions below, each identifier needs to be prepended
100 ;; with `vc-sys-'. Some of the functions are mandatory (marked with a
101 ;; `*'), others are optional (`-').
103 ;; STATE-QUERYING FUNCTIONS
105 ;; * registered (file)
107 ;; Return non-nil if FILE is registered in this backend.
111 ;; Return the current version control state of FILE. For a list of
112 ;; possible values, see `vc-state'. This function should do a full and
113 ;; reliable state computation; it is usually called immediately after
114 ;; C-x v v. If you want to use a faster heuristic when visiting a
115 ;; file, put that into `state-heuristic' below.
117 ;; - state-heuristic (file)
119 ;; If provided, this function is used to estimate the version control
120 ;; state of FILE at visiting time. It should be considerably faster
121 ;; than the implementation of `state'. For a list of possible values,
122 ;; see the doc string of `vc-state'.
126 ;; If provided, this function is used to find the version control state
127 ;; of all files in DIR in a fast way. The function should not return
128 ;; anything, but rather store the files' states into the corresponding
129 ;; `vc-state' properties.
131 ;; * workfile-version (file)
133 ;; Return the current workfile version of FILE.
135 ;; - latest-on-branch-p (file)
137 ;; Return non-nil if the current workfile version of FILE is the latest
138 ;; on its branch. The default implementation always returns t, which
139 ;; means that working with non-current versions is not supported by
142 ;; * checkout-model (file)
144 ;; Indicate whether FILE needs to be "checked out" before it can be
145 ;; edited. See `vc-checkout-model' for a list of possible values.
147 ;; - workfile-unchanged-p (file)
149 ;; Return non-nil if FILE is unchanged from its current workfile
150 ;; version. This function should do a brief comparison of FILE's
151 ;; contents with those of the master version. If the backend does not
152 ;; have such a brief-comparison feature, the default implementation of
153 ;; this function can be used, which delegates to a full
154 ;; vc-BACKEND-diff. (Note that vc-BACKEND-diff must not run
155 ;; asynchronously in this case.)
157 ;; - mode-line-string (file)
159 ;; If provided, this function should return the VC-specific mode line
160 ;; string for FILE. The default implementation deals well with all
161 ;; states that `vc-state' can return.
163 ;; - dired-state-info (file)
165 ;; Translate the `vc-state' property of FILE into a string that can be
166 ;; used in a vc-dired buffer. The default implementation deals well
167 ;; with all states that `vc-state' can return.
169 ;; STATE-CHANGING FUNCTIONS
171 ;; * register (file &optional rev comment)
173 ;; Register FILE in this backend. Optionally, an initial revision REV
174 ;; and an initial description of the file, COMMENT, may be specified.
175 ;; The implementation should pass the value of vc-register-switches
176 ;; to the backend command.
178 ;; - init-version (file)
180 ;; The initial version to use when registering FILE if one is not
181 ;; specified by the user. If not provided, the variable
182 ;; vc-default-init-version is used instead.
184 ;; - responsible-p (file)
186 ;; Return non-nil if this backend considers itself "responsible" for
187 ;; FILE, which can also be a directory. This function is used to find
188 ;; out what backend to use for registration of new files and for things
189 ;; like change log generation. The default implementation always
192 ;; - could-register (file)
194 ;; Return non-nil if FILE could be registered under this backend. The
195 ;; default implementation always returns t.
197 ;; - receive-file (file rev)
199 ;; Let this backend "receive" a file that is already registered under
200 ;; another backend. The default implementation simply calls `register'
201 ;; for FILE, but it can be overridden to do something more specific,
202 ;; e.g. keep revision numbers consistent or choose editing modes for
203 ;; FILE that resemble those of the other backend.
205 ;; - unregister (file)
207 ;; Unregister FILE from this backend. This is only needed if this
208 ;; backend may be used as a "more local" backend for temporary editing.
210 ;; * checkin (file rev comment)
212 ;; Commit changes in FILE to this backend. If REV is non-nil, that
213 ;; should become the new revision number. COMMENT is used as a
214 ;; check-in comment. The implementation should pass the value of
215 ;; vc-checkin-switches to the backend command.
217 ;; * find-version (file rev buffer)
219 ;; Fetch revision REV of file FILE and put it into BUFFER.
220 ;; If REV is the empty string, fetch the head of the trunk.
221 ;; The implementation should pass the value of vc-checkout-switches
222 ;; to the backend command.
224 ;; * checkout (file &optional editable rev)
226 ;; Check out revision REV of FILE into the working area. If EDITABLE
227 ;; is non-nil, FILE should be writable by the user and if locking is
228 ;; used for FILE, a lock should also be set. If REV is non-nil, that
229 ;; is the revision to check out (default is current workfile version).
230 ;; If REV is t, that means to check out the head of the current branch;
231 ;; if it is the empty string, check out the head of the trunk.
232 ;; The implementation should pass the value of vc-checkout-switches
233 ;; to the backend command.
235 ;; * revert (file &optional contents-done)
237 ;; Revert FILE back to the current workfile version. If optional
238 ;; arg CONTENTS-DONE is non-nil, then the contents of FILE have
239 ;; already been reverted from a version backup, and this function
240 ;; only needs to update the status of FILE within the backend.
242 ;; - cancel-version (file editable)
244 ;; Cancel the current workfile version of FILE, i.e. remove it from the
245 ;; master. EDITABLE non-nil means that FILE should be writable
246 ;; afterwards, and if locking is used for FILE, then a lock should also
247 ;; be set. If this function is not provided, trying to cancel a
248 ;; version is caught as an error.
250 ;; - merge (file rev1 rev2)
252 ;; Merge the changes between REV1 and REV2 into the current working file.
254 ;; - merge-news (file)
256 ;; Merge recent changes from the current branch into FILE.
258 ;; - steal-lock (file &optional version)
260 ;; Steal any lock on the current workfile version of FILE, or on
261 ;; VERSION if that is provided. This function is only needed if
262 ;; locking is used for files under this backend, and if files can
263 ;; indeed be locked by other users.
267 ;; * print-log (file &optional buffer)
269 ;; Insert the revision log of FILE into BUFFER, or the *vc* buffer
272 ;; - show-log-entry (version)
274 ;; If provided, search the log entry for VERSION in the current buffer,
275 ;; and make sure it is displayed in the buffer's window. The default
276 ;; implementation of this function works for RCS-style logs.
280 ;; Remove all non-comment information from the output of print-log. The
281 ;; default implementation of this function works for RCS-style logs.
283 ;; - logentry-check ()
285 ;; If defined, this function is run to find out whether the user
286 ;; entered a valid log entry for check-in. The log entry is in the
287 ;; current buffer, and if it is not a valid one, the function should
290 ;; - comment-history (file)
292 ;; Return a string containing all log entries that were made for FILE.
293 ;; This is used for transferring a file from one backend to another,
294 ;; retaining comment information. The default implementation of this
295 ;; function does this by calling print-log and then wash-log, and
296 ;; returning the resulting buffer contents as a string.
298 ;; - update-changelog (files)
300 ;; Using recent log entries, create ChangeLog entries for FILES, or for
301 ;; all files at or below the default-directory if FILES is nil. The
302 ;; default implementation runs rcs2log, which handles RCS- and
305 ;; * diff (file &optional rev1 rev2 buffer)
307 ;; Insert the diff for FILE into BUFFER, or the *vc-diff* buffer if
308 ;; BUFFER is nil. If REV1 and REV2 are non-nil, report differences
309 ;; from REV1 to REV2. If REV1 is nil, use the current workfile
310 ;; version (as found in the repository) as the older version; if
311 ;; REV2 is nil, use the current workfile contents as the newer
312 ;; version. This function should pass the value of (vc-switches
313 ;; BACKEND 'diff) to the backend command. It should return a status
314 ;; of either 0 (no differences found), or 1 (either non-empty diff
315 ;; or the diff is run asynchronously).
317 ;; - diff-tree (dir &optional rev1 rev2)
319 ;; Insert the diff for all files at and below DIR into the *vc-diff*
320 ;; buffer. The meaning of REV1 and REV2 is the same as for
321 ;; vc-BACKEND-diff. The default implementation does an explicit tree
322 ;; walk, calling vc-BACKEND-diff for each individual file.
324 ;; - annotate-command (file buf rev)
326 ;; If this function is provided, it should produce an annotated version
327 ;; of FILE in BUF, relative to version REV. This is currently only
328 ;; implemented for CVS, using the `cvs annotate' command.
330 ;; - annotate-time ()
332 ;; Only required if `annotate-command' is defined for the backend.
333 ;; Return the time of the next line of annotation at or after point,
334 ;; as a floating point fractional number of days. The helper
335 ;; function `vc-annotate-convert-time' may be useful for converting
336 ;; multi-part times as returned by `current-time' and `encode-time'
337 ;; to this format. Return nil if no more lines of annotation appear
338 ;; in the buffer. You can safely assume that point is placed at the
339 ;; beginning of each line, starting at `point-min'. The buffer that
340 ;; point is placed in is the Annotate output, as defined by the
343 ;; - annotate-current-time ()
345 ;; Only required if `annotate-command' is defined for the backend,
346 ;; AND you'd like the current time considered to be anything besides
347 ;; (vs-annotate-convert-time (current-time)) -- i.e. the current
348 ;; time with hours, minutes, and seconds included. Probably safe to
349 ;; ignore. Return the current-time, in units of fractional days.
351 ;; - annotate-extract-revision-at-line ()
353 ;; Only required if `annotate-command' is defined for the backend.
354 ;; Invoked from a buffer in vc-annotate-mode, return the revision
355 ;; corresponding to the current line, or nil if there is no revision
356 ;; corresponding to the current line.
360 ;; - create-snapshot (dir name branchp)
362 ;; Take a snapshot of the current state of files under DIR and name it
363 ;; NAME. This should make sure that files are up-to-date before
364 ;; proceeding with the action. DIR can also be a file and if BRANCHP
365 ;; is specified, NAME should be created as a branch and DIR should be
366 ;; checked out under this new branch. The default implementation does
367 ;; not support branches but does a sanity check, a tree traversal and
368 ;; for each file calls `assign-name'.
370 ;; - assign-name (file name)
372 ;; Give name NAME to the current version of FILE, assuming it is
373 ;; up-to-date. Only used by the default version of `create-snapshot'.
375 ;; - retrieve-snapshot (dir name update)
377 ;; Retrieve a named snapshot of all registered files at or below DIR.
378 ;; If UPDATE is non-nil, then update buffers of any files in the
379 ;; snapshot that are currently visited. The default implementation
380 ;; does a sanity check whether there aren't any uncommitted changes at
381 ;; or below DIR, and then performs a tree walk, using the `checkout'
382 ;; function to retrieve the corresponding versions.
386 ;; - make-version-backups-p (file)
388 ;; Return non-nil if unmodified repository versions of FILE should be
389 ;; backed up locally. If this is done, VC can perform `diff' and
390 ;; `revert' operations itself, without calling the backend system. The
391 ;; default implementation always returns nil.
393 ;; - repository-hostname (dirname)
395 ;; Return the hostname that the backend will have to contact
396 ;; in order to operate on a file in DIRNAME. If the return value
397 ;; is nil, it is means that the repository is local.
398 ;; This function is used in `vc-stay-local-p' which backends can use
399 ;; for their convenience.
401 ;; - previous-version (file rev)
403 ;; Return the version number that precedes REV for FILE, or nil if no such
406 ;; - next-version (file rev)
408 ;; Return the version number that follows REV for FILE, or nil if no such
411 ;; - check-headers ()
413 ;; Return non-nil if the current buffer contains any version headers.
415 ;; - clear-headers ()
417 ;; In the current buffer, reset all version headers to their unexpanded
418 ;; form. This function should be provided if the state-querying code
419 ;; for this backend uses the version headers to determine the state of
420 ;; a file. This function will then be called whenever VC changes the
421 ;; version control state in such a way that the headers would give
422 ;; wrong information.
424 ;; - delete-file (file)
426 ;; Delete FILE and mark it as deleted in the repository. If this
427 ;; function is not provided, the command `vc-delete-file' will
430 ;; - rename-file (old new)
432 ;; Rename file OLD to NEW, both in the working area and in the
433 ;; repository. If this function is not provided, the renaming
434 ;; will be done by (vc-delete-file old) and (vc-register new).
436 ;; - find-file-hook ()
438 ;; Operation called in current buffer when opening a new file. This can
439 ;; be used by the backend to setup some local variables it might need.
448 (require 'dired
) ; for dired-map-over-marks macro
449 (require 'dired-aux
)) ; for dired-kill-{line,tree}
451 (if (not (assoc 'vc-parent-buffer minor-mode-alist
))
452 (setq minor-mode-alist
453 (cons '(vc-parent-buffer vc-parent-buffer-name
)
456 ;; General customization
459 "Version-control system in Emacs."
462 (defcustom vc-suppress-confirm nil
463 "*If non-nil, treat user as expert; suppress yes-no prompts on some things."
467 (defcustom vc-delete-logbuf-window t
468 "*If non-nil, delete the *VC-log* buffer and window after each logical action.
469 If nil, bury that buffer instead.
470 This is most useful if you have multiple windows on a frame and would like to
471 preserve the setting."
475 (defcustom vc-initial-comment nil
476 "*If non-nil, prompt for initial comment when a file is registered."
480 (defcustom vc-default-init-version
"1.1"
481 "*A string used as the default version number when a new file is registered.
482 This can be overridden by giving a prefix argument to \\[vc-register]. This
483 can also be overridden by a particular VC backend."
488 (defcustom vc-command-messages nil
489 "*If non-nil, display run messages from back-end commands."
493 (defcustom vc-checkin-switches nil
494 "*A string or list of strings specifying extra switches for checkin.
495 These are passed to the checkin program by \\[vc-checkin]."
496 :type
'(choice (const :tag
"None" nil
)
497 (string :tag
"Argument String")
498 (repeat :tag
"Argument List"
503 (defcustom vc-checkout-switches nil
504 "*A string or list of strings specifying extra switches for checkout.
505 These are passed to the checkout program by \\[vc-checkout]."
506 :type
'(choice (const :tag
"None" nil
)
507 (string :tag
"Argument String")
508 (repeat :tag
"Argument List"
513 (defcustom vc-register-switches nil
514 "*A string or list of strings; extra switches for registering a file.
515 These are passed to the checkin program by \\[vc-register]."
516 :type
'(choice (const :tag
"None" nil
)
517 (string :tag
"Argument String")
518 (repeat :tag
"Argument List"
523 (defcustom vc-dired-listing-switches
"-al"
524 "*Switches passed to `ls' for vc-dired. MUST contain the `l' option."
529 (defcustom vc-dired-recurse t
530 "*If non-nil, show directory trees recursively in VC Dired."
535 (defcustom vc-dired-terse-display t
536 "*If non-nil, show only locked files in VC Dired."
541 (defcustom vc-directory-exclusion-list
'("SCCS" "RCS" "CVS" "MCVS" ".svn")
542 "*List of directory names to be ignored when walking directory trees."
543 :type
'(repeat string
)
546 (defcustom vc-diff-switches nil
547 "*A string or list of strings specifying switches for diff under VC.
548 When running diff under a given BACKEND, VC concatenates the values of
549 `diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to
550 get the switches for that command. Thus, `vc-diff-switches' should
551 contain switches that are specific to version control, but not
552 specific to any particular backend."
553 :type
'(choice (const :tag
"None" nil
)
554 (string :tag
"Argument String")
555 (repeat :tag
"Argument List"
562 (defcustom vc-checkout-hook nil
563 "*Normal hook (list of functions) run after checking out a file.
569 (defcustom vc-annotate-display-mode nil
570 "Which mode to color the output of \\[vc-annotate] with by default."
571 :type
'(choice (const :tag
"Default" nil
)
572 (const :tag
"Scale to Oldest" scale
)
573 (const :tag
"Scale Oldest->Newest" fullscale
)
574 (number :tag
"Specify Fractional Number of Days"
579 (defcustom vc-checkin-hook nil
580 "*Normal hook (list of functions) run after a checkin is done.
581 See also `log-edit-done-hook'."
583 :options
'(log-edit-comment-to-change-log)
587 (defcustom vc-before-checkin-hook nil
588 "*Normal hook (list of functions) run before a file is checked in.
593 (defcustom vc-logentry-check-hook nil
594 "*Normal hook run by `vc-backend-logentry-check'.
595 Use this to impose your own rules on the entry in addition to any the
596 version control backend imposes itself."
600 ;; Annotate customization
601 (defcustom vc-annotate-color-map
619 "*Association list of age versus color, for \\[vc-annotate].
620 Ages are given in units of fractional days. Default is eighteen steps
621 using a twenty day increment."
625 (defcustom vc-annotate-very-old-color
"#0046FF"
626 "*Color for lines older than the current color range in \\[vc-annotate]]."
630 (defcustom vc-annotate-background
"black"
631 "*Background color for \\[vc-annotate].
632 Default color is used if nil."
636 (defcustom vc-annotate-menu-elements
'(2 0.5 0.1 0.01)
637 "*Menu elements for the mode-specific menu of VC-Annotate mode.
638 List of factors, used to expand/compress the time scale. See `vc-annotate'."
639 :type
'(repeat number
)
642 ;; vc-annotate functionality (CVS only).
643 (defvar vc-annotate-mode nil
644 "Variable indicating if VC-Annotate mode is active.")
646 (defvar vc-annotate-mode-map
647 (let ((m (make-sparse-keymap)))
648 (define-key m
[menu-bar
] (make-sparse-keymap "VC-Annotate"))
650 "Local keymap used for VC-Annotate mode.")
652 (define-key vc-annotate-mode-map
"A" 'vc-annotate-revision-previous-to-line
)
653 (define-key vc-annotate-mode-map
"D" 'vc-annotate-show-diff-revision-at-line
)
654 (define-key vc-annotate-mode-map
"J" 'vc-annotate-revision-at-line
)
655 (define-key vc-annotate-mode-map
"L" 'vc-annotate-show-log-revision-at-line
)
656 (define-key vc-annotate-mode-map
"N" 'vc-annotate-next-version
)
657 (define-key vc-annotate-mode-map
"P" 'vc-annotate-prev-version
)
658 (define-key vc-annotate-mode-map
"W" 'vc-annotate-workfile-version
)
660 (defvar vc-annotate-mode-menu nil
661 "Local keymap used for VC-Annotate mode's menu bar menu.")
663 ;; Header-insertion hair
665 (defcustom vc-static-header-alist
667 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
668 "*Associate static header string templates with file types.
669 A \%s in the template is replaced with the first string associated with
670 the file's version control type in `vc-header-alist'."
671 :type
'(repeat (cons :format
"%v"
672 (regexp :tag
"File Type")
673 (string :tag
"Header String")))
676 (defcustom vc-comment-alist
677 '((nroff-mode ".\\\"" ""))
678 "*Special comment delimiters for generating VC headers.
679 Add an entry in this list if you need to override the normal `comment-start'
680 and `comment-end' variables. This will only be necessary if the mode language
681 is sensitive to blank lines."
682 :type
'(repeat (list :format
"%v"
684 (string :tag
"Comment Start")
685 (string :tag
"Comment End")))
688 (defcustom vc-checkout-carefully
(= (user-uid) 0)
689 "*Non-nil means be extra-careful in checkout.
690 Verify that the file really is not locked
691 and that its contents match what the master file says."
694 (make-obsolete-variable 'vc-checkout-carefully
695 "the corresponding checks are always done now."
699 ;; Variables the user doesn't need to know about.
700 (defvar vc-log-operation nil
)
701 (defvar vc-log-after-operation-hook nil
)
702 (defvar vc-annotate-buffers nil
703 "Alist of current \"Annotate\" buffers and their corresponding backends.
704 The keys are \(BUFFER . BACKEND\). See also `vc-annotate-get-backend'.")
705 ;; In a log entry buffer, this is a local variable
706 ;; that points to the buffer for which it was made
707 ;; (either a file, or a VC dired buffer).
708 (defvar vc-parent-buffer nil
)
709 (put 'vc-parent-buffer
'permanent-local t
)
710 (defvar vc-parent-buffer-name nil
)
711 (put 'vc-parent-buffer-name
'permanent-local t
)
714 (defvar vc-log-version
)
716 (defvar vc-dired-mode nil
)
717 (make-variable-buffer-local 'vc-dired-mode
)
719 ;; functions that operate on RCS revision numbers. This code should
720 ;; also be moved into the backends. It stays for now, however, since
721 ;; it is used in code below.
722 (defun vc-trunk-p (rev)
723 "Return t if REV is a revision on the trunk."
724 (not (eq nil
(string-match "\\`[0-9]+\\.[0-9]+\\'" rev
))))
726 (defun vc-branch-p (rev)
727 "Return t if REV is a branch revision."
728 (not (eq nil
(string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev
))))
731 (defun vc-branch-part (rev)
732 "Return the branch part of a revision number REV."
733 (let ((index (string-match "\\.[0-9]+\\'" rev
)))
735 (substring rev
0 index
))))
737 (defun vc-minor-part (rev)
738 "Return the minor version number of a revision number REV."
739 (string-match "[0-9]+\\'" rev
)
740 (substring rev
(match-beginning 0) (match-end 0)))
742 (defun vc-default-previous-version (backend file rev
)
743 "Return the version number immediately preceding REV for FILE,
744 or nil if there is no previous version. This default
745 implementation works for <major>.<minor>-style version numbers as
746 used by RCS and CVS."
747 (let ((branch (vc-branch-part rev
))
748 (minor-num (string-to-number (vc-minor-part rev
))))
751 ;; version does probably not start a branch or release
752 (concat branch
"." (number-to-string (1- minor-num
)))
754 ;; we are at the beginning of the trunk --
755 ;; don't know anything to return here
757 ;; we are at the beginning of a branch --
758 ;; return version of starting point
759 (vc-branch-part branch
))))))
761 (defun vc-default-next-version (backend file rev
)
762 "Return the version number immediately following REV for FILE,
763 or nil if there is no next version. This default implementation
764 works for <major>.<minor>-style version numbers as used by RCS
766 (when (not (string= rev
(vc-workfile-version file
)))
767 (let ((branch (vc-branch-part rev
))
768 (minor-num (string-to-number (vc-minor-part rev
))))
769 (concat branch
"." (number-to-string (1+ minor-num
))))))
771 ;; File property caching
773 (defun vc-clear-context ()
774 "Clear all cached file properties."
776 (fillarray vc-file-prop-obarray
0))
778 (defmacro with-vc-properties
(file form settings
)
779 "Execute FORM, then maybe set per-file properties for FILE.
780 SETTINGS is an association list of property/value pairs. After
781 executing FORM, set those properties from SETTINGS that have not yet
782 been updated to their corresponding values."
784 `(let ((vc-touched-properties (list t
)))
786 (mapcar (lambda (setting)
787 (let ((property (car setting
)))
788 (unless (memq property vc-touched-properties
)
789 (put (intern ,file vc-file-prop-obarray
)
790 property
(cdr setting
)))))
793 ;; Random helper functions
795 (defsubst vc-editable-p
(file)
796 "Return non-nil if FILE can be edited."
797 (or (eq (vc-checkout-model file
) 'implicit
)
798 (memq (vc-state file
) '(edited needs-merge
))))
800 ;; Two macros for elisp programming
802 (defmacro with-vc-file
(file comment
&rest body
)
803 "Check out a writable copy of FILE if necessary, then execute BODY.
804 Check in FILE with COMMENT (a string) after BODY has been executed.
805 FILE is passed through `expand-file-name'; BODY executed within
806 `save-excursion'. If FILE is not under version control, or locked by
807 somebody else, signal error."
808 (declare (debug t
) (indent 2))
809 (let ((filevar (make-symbol "file")))
810 `(let ((,filevar
(expand-file-name ,file
)))
811 (or (vc-backend ,filevar
)
812 (error "File not under version control: `%s'" file
))
813 (unless (vc-editable-p ,filevar
)
814 (let ((state (vc-state ,filevar
)))
816 (error "`%s' is locking `%s'" state
,filevar
)
817 (vc-checkout ,filevar t
))))
820 (vc-checkin ,filevar nil
,comment
))))
823 (defmacro edit-vc-file
(file comment
&rest body
)
824 "Edit FILE under version control, executing body.
825 Checkin with COMMENT after executing BODY.
826 This macro uses `with-vc-file', passing args to it.
827 However, before executing BODY, find FILE, and after BODY, save buffer."
828 (declare (debug t
) (indent 2))
829 (let ((filevar (make-symbol "file")))
830 `(let ((,filevar
(expand-file-name ,file
)))
833 (set-buffer (find-file-noselect ,filevar
))
837 (defun vc-ensure-vc-buffer ()
838 "Make sure that the current buffer visits a version-controlled file."
840 (set-buffer (find-file-noselect (dired-get-filename)))
841 (while vc-parent-buffer
842 (pop-to-buffer vc-parent-buffer
))
843 (if (not buffer-file-name
)
844 (error "Buffer %s is not associated with a file" (buffer-name))
845 (if (not (vc-backend buffer-file-name
))
846 (error "File %s is not under version control" buffer-file-name
)))))
848 (defun vc-process-filter (p s
)
849 "An alternative output filter for async process P.
850 The only difference with the default filter is to insert S after markers."
851 (with-current-buffer (process-buffer p
)
853 (let ((inhibit-read-only t
))
854 (goto-char (process-mark p
))
856 (set-marker (process-mark p
) (point))))))
858 (defun vc-setup-buffer (&optional buf
)
859 "Prepare BUF for executing a VC command and make it current.
860 BUF defaults to \"*vc*\", can be a string and will be created if necessary."
861 (unless buf
(setq buf
"*vc*"))
862 (let ((camefrom (current-buffer))
863 (olddir default-directory
))
864 (set-buffer (get-buffer-create buf
))
865 (kill-all-local-variables)
866 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
867 (set (make-local-variable 'vc-parent-buffer-name
)
868 (concat " from " (buffer-name camefrom
)))
869 (setq default-directory olddir
)
870 (let ((inhibit-read-only t
))
873 (defun vc-exec-after (code)
874 "Eval CODE when the current buffer's process is done.
875 If the current buffer has no process, just evaluate CODE.
876 Else, add CODE to the process' sentinel."
877 (let ((proc (get-buffer-process (current-buffer))))
879 ;; If there's no background process, just execute the code.
880 ((null proc
) (eval code
))
881 ;; If the background process has exited, reap it and try again
882 ((eq (process-status proc
) 'exit
)
883 (delete-process proc
)
884 (vc-exec-after code
))
885 ;; If a process is running, add CODE to the sentinel
886 ((eq (process-status proc
) 'run
)
887 (let ((sentinel (process-sentinel proc
)))
888 (set-process-sentinel proc
890 (with-current-buffer ',(current-buffer)
891 (goto-char (process-mark p
))
892 ,@(append (cdr (cdr (cdr ;strip off `with-current-buffer buf
894 (car (cdr (cdr ;strip off `lambda (p s)'
896 (list `(vc-exec-after ',code
))))))))
897 (t (error "Unexpected process state"))))
900 (defvar vc-post-command-functions nil
901 "Hook run at the end of `vc-do-command'.
902 Each function is called inside the buffer in which the command was run
903 and is passed 3 arguments: the COMMAND, the FILE and the FLAGS.")
905 (defvar w32-quote-process-args
)
907 (defun vc-do-command (buffer okstatus command file
&rest flags
)
908 "Execute a VC command, notifying user and checking for errors.
909 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil or the
910 current buffer if BUFFER is t. If the destination buffer is not
911 already current, set it up properly and erase it. The command is
912 considered successful if its exit status does not exceed OKSTATUS (if
913 OKSTATUS is nil, that means to ignore errors, if it is 'async, that
914 means not to wait for termination of the subprocess). FILE is the
915 name of the working file (may also be nil, to execute commands that
916 don't expect a file name). If an optional list of FLAGS is present,
917 that is inserted into the command line before the filename."
918 (and file
(setq file
(expand-file-name file
)))
919 (if vc-command-messages
920 (message "Running %s on %s..." command file
))
922 (unless (or (eq buffer t
)
923 (and (stringp buffer
)
924 (string= (buffer-name) buffer
))
925 (eq buffer
(current-buffer)))
926 (vc-setup-buffer buffer
))
927 (let ((squeezed (remq nil flags
))
928 (inhibit-read-only t
)
931 ;; FIXME: file-relative-name can return a bogus result because
932 ;; it doesn't look at the actual file-system to see if symlinks
934 (setq squeezed
(append squeezed
(list (file-relative-name file
)))))
935 (let ((exec-path (append vc-path exec-path
))
936 ;; Add vc-path to PATH for the execution of this command.
938 (cons (concat "PATH=" (getenv "PATH")
940 (mapconcat 'identity vc-path path-separator
))
941 process-environment
))
942 (w32-quote-process-args t
))
943 (if (eq okstatus
'async
)
944 (let ((proc (apply 'start-process command
(current-buffer) command
946 (unless (active-minibuffer-window)
947 (message "Running %s in the background..." command
))
948 ;;(set-process-sentinel proc (lambda (p msg) (delete-process p)))
949 (set-process-filter proc
'vc-process-filter
)
951 `(unless (active-minibuffer-window)
952 (message "Running %s in the background... done" ',command
))))
953 (setq status
(apply 'call-process command nil t nil squeezed
))
954 (when (or (not (integerp status
)) (and okstatus
(< okstatus status
)))
955 (pop-to-buffer (current-buffer))
956 (goto-char (point-min))
957 (shrink-window-if-larger-than-buffer)
958 (error "Running %s...FAILED (%s)" command
959 (if (integerp status
) (format "status %d" status
) status
))))
960 (if vc-command-messages
961 (message "Running %s...OK" command
)))
963 `(run-hook-with-args 'vc-post-command-functions
',command
',file
',flags
))
966 (defun vc-position-context (posn)
967 "Save a bit of the text around POSN in the current buffer.
968 Used to help us find the corresponding position again later
969 if markers are destroyed or corrupted."
970 ;; A lot of this was shamelessly lifted from Sebastian Kremer's
974 (buffer-substring posn
975 (min (point-max) (+ posn
100)))))
977 (defun vc-find-position-by-context (context)
978 "Return the position of CONTEXT in the current buffer.
979 If CONTEXT cannot be found, return nil."
980 (let ((context-string (nth 2 context
)))
981 (if (equal "" context-string
)
984 (let ((diff (- (nth 1 context
) (buffer-size))))
985 (if (< diff
0) (setq diff
(- diff
)))
986 (goto-char (nth 0 context
))
987 (if (or (search-forward context-string nil t
)
988 ;; Can't use search-backward since the match may continue
990 (progn (goto-char (- (point) diff
(length context-string
)))
991 ;; goto-char doesn't signal an error at
992 ;; beginning of buffer like backward-char would
993 (search-forward context-string nil t
)))
994 ;; to beginning of OSTRING
995 (- (point) (length context-string
))))))))
997 (defun vc-context-matches-p (posn context
)
998 "Return t if POSN matches CONTEXT, nil otherwise."
999 (let* ((context-string (nth 2 context
))
1000 (len (length context-string
))
1002 (if (> end
(1+ (buffer-size)))
1004 (string= context-string
(buffer-substring posn end
)))))
1006 (defun vc-buffer-context ()
1007 "Return a list (POINT-CONTEXT MARK-CONTEXT REPARSE).
1008 Used by `vc-restore-buffer-context' to later restore the context."
1009 (let ((point-context (vc-position-context (point)))
1010 ;; Use mark-marker to avoid confusion in transient-mark-mode.
1011 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
1012 (vc-position-context (mark-marker))))
1013 ;; Make the right thing happen in transient-mark-mode.
1015 ;; We may want to reparse the compilation buffer after revert
1016 (reparse (and (boundp 'compilation-error-list
) ;compile loaded
1017 ;; Construct a list; each elt is nil or a buffer
1018 ;; iff that buffer is a compilation output buffer
1019 ;; that contains markers into the current buffer.
1020 (save-current-buffer
1021 (mapcar (lambda (buffer)
1024 compilation-old-error-list
1025 compilation-error-list
))
1026 (buffer-error-marked-p nil
))
1027 (while (and (consp errors
)
1028 (not buffer-error-marked-p
))
1029 (and (markerp (cdr (car errors
)))
1032 (cdr (car errors
))))
1033 (setq buffer-error-marked-p t
))
1034 (setq errors
(cdr errors
)))
1035 (if buffer-error-marked-p buffer
)))
1037 (list point-context mark-context reparse
)))
1039 (defun vc-restore-buffer-context (context)
1040 "Restore point/mark, and reparse any affected compilation buffers.
1041 CONTEXT is that which `vc-buffer-context' returns."
1042 (let ((point-context (nth 0 context
))
1043 (mark-context (nth 1 context
))
1044 (reparse (nth 2 context
)))
1045 ;; Reparse affected compilation buffers.
1048 (with-current-buffer (car reparse
)
1049 (let ((compilation-last-buffer (current-buffer)) ;select buffer
1050 ;; Record the position in the compilation buffer of
1051 ;; the last error next-error went to.
1052 (error-pos (marker-position
1053 (car (car-safe compilation-error-list
)))))
1054 ;; Reparse the error messages as far as they were parsed before.
1055 (compile-reinitialize-errors '(4) compilation-parsing-end
)
1056 ;; Move the pointer up to find the error we were at before
1057 ;; reparsing. Now next-error should properly go to the next one.
1058 (while (and compilation-error-list
1059 (/= error-pos
(car (car compilation-error-list
))))
1060 (setq compilation-error-list
(cdr compilation-error-list
))))))
1061 (setq reparse
(cdr reparse
)))
1063 ;; if necessary, restore point and mark
1064 (if (not (vc-context-matches-p (point) point-context
))
1065 (let ((new-point (vc-find-position-by-context point-context
)))
1066 (if new-point
(goto-char new-point
))))
1069 (not (vc-context-matches-p (mark) mark-context
))
1070 (let ((new-mark (vc-find-position-by-context mark-context
)))
1071 (if new-mark
(set-mark new-mark
))))))
1073 (defun vc-revert-buffer1 (&optional arg no-confirm
)
1074 "Revert buffer, keeping point and mark where user expects them.
1075 Try to be clever in the face of changes due to expanded version control
1076 key words. This is important for typeahead to work as expected.
1077 ARG and NO-CONFIRM are passed on to `revert-buffer'."
1080 (let ((context (vc-buffer-context)))
1081 ;; Use save-excursion here, because it may be able to restore point
1082 ;; and mark properly even in cases where vc-restore-buffer-context
1083 ;; would fail. However, save-excursion might also get it wrong --
1084 ;; in this case, vc-restore-buffer-context gives it a second try.
1086 ;; t means don't call normal-mode;
1087 ;; that's to preserve various minor modes.
1088 (revert-buffer arg no-confirm t
))
1089 (vc-restore-buffer-context context
)))
1092 (defun vc-buffer-sync (&optional not-urgent
)
1093 "Make sure the current buffer and its working file are in sync.
1094 NOT-URGENT means it is ok to continue if the user says not to save."
1095 (if (buffer-modified-p)
1096 (if (or vc-suppress-confirm
1097 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
1100 (error "Aborted")))))
1102 (defun vc-default-latest-on-branch-p (backend file
)
1103 "Return non-nil if FILE is the latest on its branch.
1104 This default implementation always returns non-nil, which means that
1105 editing non-current versions is not supported by default."
1108 (defun vc-recompute-state (file)
1109 "Force a recomputation of the version control state of FILE.
1110 The state is computed using the exact, and possibly expensive
1111 function `vc-BACKEND-state', not the heuristic."
1112 (vc-file-setprop file
'vc-state
(vc-call state file
)))
1114 (defun vc-next-action-on-file (file verbose
&optional comment
)
1115 "Do The Right Thing for a given FILE under version control.
1116 If COMMENT is specified, it will be used as an admin or checkin comment.
1117 If VERBOSE is non-nil, query the user rather than using default parameters."
1118 (let ((visited (get-file-buffer file
))
1122 (switch-to-buffer-other-window visited
)
1123 (set-buffer visited
))
1124 ;; Check relation of buffer and file, and make sure
1125 ;; user knows what he's doing. First, finding the file
1126 ;; will check whether the file on disk is newer.
1127 ;; Ignore buffer-read-only during this test, and
1128 ;; preserve find-file-literally.
1129 (let ((buffer-read-only (not (file-writable-p file
))))
1130 (find-file-noselect file nil find-file-literally
))
1131 (if (not (verify-visited-file-modtime (current-buffer)))
1132 (if (yes-or-no-p "Replace file on disk with buffer contents? ")
1133 (write-file buffer-file-name
)
1135 ;; Now, check if we have unsaved changes.
1137 (if (buffer-modified-p)
1138 (or (y-or-n-p "Operate on disk file, keeping modified buffer? ")
1139 (error "Aborted")))))
1141 ;; Do the right thing
1142 (if (not (vc-registered file
))
1143 (vc-register verbose comment
)
1144 (vc-recompute-state file
)
1145 (if visited
(vc-mode-line file
))
1146 (setq state
(vc-state file
))
1149 ((or (eq state
'up-to-date
)
1150 (and verbose
(eq state
'needs-patch
)))
1153 ;; go to a different version
1155 (read-string "Branch, version, or backend to move to: "))
1156 (let ((vsym (intern-soft (upcase version
))))
1157 (if (member vsym vc-handled-backends
)
1158 (vc-transfer-file file vsym
)
1159 (vc-checkout file
(eq (vc-checkout-model file
) 'implicit
)
1161 ((not (eq (vc-checkout-model file
) 'implicit
))
1162 ;; check the file out
1163 (vc-checkout file t
))
1166 (message "%s is up-to-date" file
))))
1168 ;; Abnormal: edited but read-only
1169 ((and visited
(eq state
'edited
)
1170 buffer-read-only
(not (file-writable-p file
)))
1171 ;; Make the file+buffer read-write. If the user really wanted to
1172 ;; commit, he'll get a chance to do that next time around, anyway.
1173 (message "File is edited but read-only; making it writable")
1174 (set-file-modes buffer-file-name
1175 (logior (file-modes buffer-file-name
) 128))
1176 (toggle-read-only -
1))
1181 ;; For files with locking, if the file does not contain
1182 ;; any changes, just let go of the lock, i.e. revert.
1183 ((and (not (eq (vc-checkout-model file
) 'implicit
))
1184 (vc-workfile-unchanged-p file
)
1185 ;; If buffer is modified, that means the user just
1186 ;; said no to saving it; in that case, don't revert,
1187 ;; because the user might intend to save after
1188 ;; finishing the log entry.
1189 (not (and visited
(buffer-modified-p))))
1190 ;; DO NOT revert the file without asking the user!
1191 (if (not visited
) (find-file-other-window file
))
1192 (if (yes-or-no-p "Revert to master version? ")
1193 (vc-revert-buffer)))
1196 (vc-checkin file nil comment
)
1197 (setq version
(read-string "New version or backend: "))
1198 (let ((vsym (intern (upcase version
))))
1199 (if (member vsym vc-handled-backends
)
1200 (vc-transfer-file file vsym
)
1201 (vc-checkin file version comment
)))))))
1203 ;; locked by somebody else
1206 (error "Sorry, you can't steal the lock on %s this way"
1207 (file-name-nondirectory file
)))
1209 (if verbose
(read-string "Version to steal: ")
1210 (vc-workfile-version file
))
1214 ((eq state
'needs-patch
)
1215 (if (yes-or-no-p (format
1216 "%s is not up-to-date. Get latest version? "
1217 (file-name-nondirectory file
)))
1218 (vc-checkout file
(eq (vc-checkout-model file
) 'implicit
) t
)
1219 (if (and (not (eq (vc-checkout-model file
) 'implicit
))
1220 (yes-or-no-p "Lock this version? "))
1221 (vc-checkout file t
)
1222 (error "Aborted"))))
1225 ((eq state
'needs-merge
)
1226 (if (yes-or-no-p (format
1227 "%s is not up-to-date. Merge in changes now? "
1228 (file-name-nondirectory file
)))
1229 (vc-maybe-resolve-conflicts file
(vc-call merge-news file
))
1233 ((eq state
'unlocked-changes
)
1234 (if (not visited
) (find-file-other-window file
))
1235 (if (save-window-excursion
1236 (vc-version-diff file
(vc-workfile-version file
) nil
)
1237 (goto-char (point-min))
1238 (let ((inhibit-read-only t
))
1240 (format "Changes to %s since last lock:\n\n" file
)))
1242 (yes-or-no-p (concat "File has unlocked changes. "
1243 "Claim lock retaining changes? ")))
1244 (progn (vc-call steal-lock file
)
1245 (clear-visited-file-modtime)
1246 ;; Must clear any headers here because they wouldn't
1247 ;; show that the file is locked now.
1248 (vc-clear-headers file
)
1249 (write-file buffer-file-name
)
1250 (vc-mode-line file
))
1251 (if (not (yes-or-no-p
1252 "Revert to checked-in version, instead? "))
1253 (error "Checkout aborted")
1254 (vc-revert-buffer1 t t
)
1255 (vc-checkout file t
))))))))
1257 (defvar vc-dired-window-configuration
)
1259 (defun vc-next-action-dired (file rev comment
)
1260 "Call `vc-next-action-on-file' on all the marked files.
1261 Ignores FILE and REV, but passes on COMMENT."
1262 (let ((dired-buffer (current-buffer)))
1263 (dired-map-over-marks
1264 (let ((file (dired-get-filename)))
1265 (message "Processing %s..." file
)
1266 (vc-next-action-on-file file nil comment
)
1267 (set-buffer dired-buffer
)
1268 (set-window-configuration vc-dired-window-configuration
)
1269 (message "Processing %s...done" file
))
1271 (dired-move-to-filename))
1273 ;; Here's the major entry point.
1276 (defun vc-next-action (verbose)
1277 "Do the next logical version control operation on the current file.
1279 If you call this from within a VC dired buffer with no files marked,
1280 it will operate on the file in the current line.
1282 If you call this from within a VC dired buffer, and one or more
1283 files are marked, it will accept a log message and then operate on
1284 each one. The log message will be used as a comment for any register
1285 or checkin operations, but ignored when doing checkouts. Attempted
1286 lock steals will raise an error.
1288 A prefix argument lets you specify the version number to use.
1290 For RCS and SCCS files:
1291 If the file is not already registered, this registers it for version
1293 If the file is registered and not locked by anyone, this checks out
1294 a writable and locked file ready for editing.
1295 If the file is checked out and locked by the calling user, this
1296 first checks to see if the file has changed since checkout. If not,
1297 it performs a revert.
1298 If the file has been changed, this pops up a buffer for entry
1299 of a log message; when the message has been entered, it checks in the
1300 resulting changes along with the log message as change commentary. If
1301 the variable `vc-keep-workfiles' is non-nil (which is its default), a
1302 read-only copy of the changed file is left in place afterwards.
1303 If the file is registered and locked by someone else, you are given
1304 the option to steal the lock.
1307 If the file is not already registered, this registers it for version
1308 control. This does a \"cvs add\", but no \"cvs commit\".
1309 If the file is added but not committed, it is committed.
1310 If your working file is changed, but the repository file is
1311 unchanged, this pops up a buffer for entry of a log message; when the
1312 message has been entered, it checks in the resulting changes along
1313 with the logmessage as change commentary. A writable file is retained.
1314 If the repository file is changed, you are asked if you want to
1315 merge in the changes into your working copy."
1320 (let ((files (dired-get-marked-files)))
1321 (set (make-local-variable 'vc-dired-window-configuration
)
1322 (current-window-configuration))
1326 (if (not (vc-up-to-date-p f
)) "@" ""))
1328 (vc-next-action-dired nil nil
"dummy")
1329 (vc-start-entry nil nil nil nil
1330 "Enter a change comment for the marked files."
1331 'vc-next-action-dired
))
1333 (while vc-parent-buffer
1334 (pop-to-buffer vc-parent-buffer
))
1335 (if buffer-file-name
1336 (vc-next-action-on-file buffer-file-name verbose
)
1337 (error "Buffer %s is not associated with a file" (buffer-name)))))
1339 ;; These functions help the vc-next-action entry point
1342 (defun vc-register (&optional set-version comment
)
1343 "Register the current file into a version control system.
1344 With prefix argument SET-VERSION, allow user to specify initial version
1345 level. If COMMENT is present, use that as an initial comment.
1347 The version control system to use is found by cycling through the list
1348 `vc-handled-backends'. The first backend in that list which declares
1349 itself responsible for the file (usually because other files in that
1350 directory are already registered under that backend) will be used to
1351 register the file. If no backend declares itself responsible, the
1352 first backend that could register the file is used."
1354 (unless buffer-file-name
(error "No visited file"))
1355 (when (vc-backend buffer-file-name
)
1356 (if (vc-registered buffer-file-name
)
1357 (error "This file is already registered")
1358 (unless (y-or-n-p "Previous master file has vanished. Make a new one? ")
1359 (error "Aborted"))))
1360 ;; Watch out for new buffers of size 0: the corresponding file
1361 ;; does not exist yet, even though buffer-modified-p is nil.
1362 (if (and (not (buffer-modified-p))
1363 (zerop (buffer-size))
1364 (not (file-exists-p buffer-file-name
)))
1365 (set-buffer-modified-p t
))
1368 (vc-start-entry buffer-file-name
1370 (read-string (format "Initial version level for %s: "
1372 (let ((backend (vc-responsible-backend buffer-file-name
)))
1373 (if (vc-find-backend-function backend
'init-version
)
1374 (vc-call-backend backend
'init-version
)
1375 vc-default-init-version
)))
1376 (or comment
(not vc-initial-comment
))
1378 "Enter initial comment."
1379 (lambda (file rev comment
)
1380 (message "Registering %s... " file
)
1381 (let ((backend (vc-responsible-backend file t
)))
1382 (vc-file-clearprops file
)
1383 (vc-call-backend backend
'register file rev comment
)
1384 (vc-file-setprop file
'vc-backend backend
)
1385 (unless vc-make-backup-files
1386 (make-local-variable 'backup-inhibited
)
1387 (setq backup-inhibited t
)))
1388 (message "Registering %s... done" file
))))
1391 (defun vc-responsible-backend (file &optional register
)
1392 "Return the name of a backend system that is responsible for FILE.
1393 The optional argument REGISTER means that a backend suitable for
1394 registration should be found.
1396 If REGISTER is nil, then if FILE is already registered, return the
1397 backend of FILE. If FILE is not registered, or a directory, then the
1398 first backend in `vc-handled-backends' that declares itself
1399 responsible for FILE is returned. If no backend declares itself
1400 responsible, return the first backend.
1402 If REGISTER is non-nil, return the first responsible backend under
1403 which FILE is not yet registered. If there is no such backend, return
1404 the first backend under which FILE is not yet registered, but could
1406 (if (not vc-handled-backends
)
1407 (error "No handled backends"))
1408 (or (and (not (file-directory-p file
)) (not register
) (vc-backend file
))
1410 ;; First try: find a responsible backend. If this is for registration,
1411 ;; it must be a backend under which FILE is not yet registered.
1412 (dolist (backend vc-handled-backends
)
1413 (and (or (not register
)
1414 (not (vc-call-backend backend
'registered file
)))
1415 (vc-call-backend backend
'responsible-p file
)
1416 (throw 'found backend
)))
1417 ;; no responsible backend
1419 ;; if this is not for registration, the first backend must do
1420 (car vc-handled-backends
)
1421 ;; for registration, we need to find a new backend that
1422 ;; could register FILE
1423 (dolist (backend vc-handled-backends
)
1424 (and (not (vc-call-backend backend
'registered file
))
1425 (vc-call-backend backend
'could-register file
)
1426 (throw 'found backend
)))
1427 (error "No backend that could register")))))
1429 (defun vc-default-responsible-p (backend file
)
1430 "Indicate whether BACKEND is reponsible for FILE.
1431 The default is to return nil always."
1434 (defun vc-default-could-register (backend file
)
1435 "Return non-nil if BACKEND could be used to register FILE.
1436 The default implementation returns t for all files."
1439 (defun vc-resynch-window (file &optional keep noquery
)
1440 "If FILE is in the current buffer, either revert or unvisit it.
1441 The choice between revert (to see expanded keywords) and unvisit depends on
1442 `vc-keep-workfiles'. NOQUERY if non-nil inhibits confirmation for
1443 reverting. NOQUERY should be t *only* if it is known the only
1444 difference between the buffer and the file is due to version control
1445 rather than user editing!"
1446 (and (string= buffer-file-name file
)
1449 (vc-revert-buffer1 t noquery
)
1450 ;; TODO: Adjusting view mode might no longer be necessary
1451 ;; after RMS change to files.el of 1999-08-08. Investigate
1452 ;; this when we install the new VC.
1454 (if (file-writable-p file
)
1456 (let ((view-old-buffer-read-only nil
))
1458 (and (not view-mode
)
1459 (not (eq (get major-mode
'mode-class
) 'special
))
1460 (view-mode-enter))))
1461 (vc-mode-line buffer-file-name
))
1462 (kill-buffer (current-buffer)))))
1464 (defun vc-resynch-buffer (file &optional keep noquery
)
1465 "If FILE is currently visited, resynch its buffer."
1466 (if (string= buffer-file-name file
)
1467 (vc-resynch-window file keep noquery
)
1468 (let ((buffer (get-file-buffer file
)))
1470 (with-current-buffer buffer
1471 (vc-resynch-window file keep noquery
)))))
1472 (vc-dired-resynch-file file
))
1474 (defun vc-start-entry (file rev comment initial-contents msg action
&optional after-hook
)
1475 "Accept a comment for an operation on FILE revision REV.
1476 If COMMENT is nil, pop up a VC-log buffer, emit MSG, and set the
1477 action on close to ACTION. If COMMENT is a string and
1478 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial
1479 contents of the log entry buffer. If COMMENT is a string and
1480 INITIAL-CONTENTS is nil, do action immediately as if the user had
1481 entered COMMENT. If COMMENT is t, also do action immediately with an
1482 empty comment. Remember the file's buffer in `vc-parent-buffer'
1483 \(current one if no file). AFTER-HOOK specifies the local value
1484 for vc-log-operation-hook."
1485 (let ((parent (or (and file
(get-file-buffer file
)) (current-buffer))))
1486 (if vc-before-checkin-hook
1488 (with-current-buffer parent
1489 (run-hooks 'vc-before-checkin-hook
))
1490 (run-hooks 'vc-before-checkin-hook
)))
1491 (if (and comment
(not initial-contents
))
1492 (set-buffer (get-buffer-create "*VC-log*"))
1493 (pop-to-buffer (get-buffer-create "*VC-log*")))
1494 (set (make-local-variable 'vc-parent-buffer
) parent
)
1495 (set (make-local-variable 'vc-parent-buffer-name
)
1496 (concat " from " (buffer-name vc-parent-buffer
)))
1497 (if file
(vc-mode-line file
))
1499 (make-local-variable 'vc-log-after-operation-hook
)
1501 (setq vc-log-after-operation-hook after-hook
))
1502 (setq vc-log-operation action
)
1503 (setq vc-log-version rev
)
1506 (when (stringp comment
) (insert comment
)))
1507 (if (or (not comment
) initial-contents
)
1508 (message "%s Type C-c C-c when done" msg
)
1509 (vc-finish-logentry (eq comment t
)))))
1511 (defun vc-checkout (file &optional writable rev
)
1512 "Retrieve a copy of the revision REV of FILE.
1513 If WRITABLE is non-nil, make sure the retrieved file is writable.
1514 REV defaults to the latest revision.
1516 After check-out, runs the normal hook `vc-checkout-hook'."
1519 (vc-call make-version-backups-p file
)
1520 (vc-up-to-date-p file
)
1521 (vc-make-version-backup file
))
1525 (vc-call checkout file writable rev
)
1527 ;; Maybe the backend is not installed ;-(
1529 (let ((buf (get-file-buffer file
)))
1530 (when buf
(with-current-buffer buf
(toggle-read-only -
1)))))
1531 (signal (car err
) (cdr err
))))
1532 `((vc-state .
,(if (or (eq (vc-checkout-model file
) 'implicit
)
1534 (if (vc-call latest-on-branch-p file
)
1538 (vc-checkout-time .
,(nth 5 (file-attributes file
)))))
1539 (vc-resynch-buffer file t t
)
1540 (run-hooks 'vc-checkout-hook
))
1542 (defun vc-steal-lock (file rev owner
)
1543 "Steal the lock on FILE."
1544 (let (file-description)
1546 (setq file-description
(format "%s:%s" file rev
))
1547 (setq file-description file
))
1548 (if (not (yes-or-no-p (format "Steal the lock on %s from %s? "
1549 file-description owner
)))
1550 (error "Steal canceled"))
1551 (message "Stealing lock on %s..." file
)
1554 (vc-call steal-lock file rev
)
1555 `((vc-state . edited
)))
1556 (vc-resynch-buffer file t t
)
1557 (message "Stealing lock on %s...done" file
)
1558 ;; Write mail after actually stealing, because if the stealing
1559 ;; goes wrong, we don't want to send any mail.
1560 (compose-mail owner
(format "Stolen lock on %s" file-description
))
1561 (setq default-directory
(expand-file-name "~/"))
1562 (goto-char (point-max))
1564 (format "I stole the lock on %s, " file-description
)
1565 (current-time-string)
1567 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
1569 (defun vc-checkin (file &optional rev comment initial-contents
)
1571 The optional argument REV may be a string specifying the new version
1572 level (if nil increment the current level). COMMENT is a comment
1573 string; if omitted, a buffer is popped up to accept a comment. If
1574 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents
1575 of the log entry buffer.
1577 If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided
1578 that the version control system supports this mode of operation.
1580 Runs the normal hook `vc-checkin-hook'."
1582 file rev comment initial-contents
1583 "Enter a change comment."
1584 (lambda (file rev comment
)
1585 (message "Checking in %s..." file
)
1586 ;; "This log message intentionally left almost blank".
1587 ;; RCS 5.7 gripes about white-space-only comments too.
1588 (or (and comment
(string-match "[^\t\n ]" comment
))
1589 (setq comment
"*** empty log message ***"))
1592 ;; Change buffers to get local value of vc-checkin-switches.
1593 (with-current-buffer (or (get-file-buffer file
) (current-buffer))
1595 (vc-call checkin file rev comment
)
1596 (vc-delete-automatic-version-backups file
)))
1597 `((vc-state . up-to-date
)
1598 (vc-checkout-time .
,(nth 5 (file-attributes file
)))
1599 (vc-workfile-version . nil
)))
1600 (message "Checking in %s...done" file
))
1603 (defun vc-finish-logentry (&optional nocomment
)
1604 "Complete the operation implied by the current log entry.
1605 Use the contents of the current buffer as a check-in or registration
1606 comment. If the optional arg NOCOMMENT is non-nil, then don't check
1607 the buffer contents as a comment."
1609 ;; Check and record the comment, if any.
1611 ;; Comment too long?
1612 (vc-call-backend (or (and vc-log-file
(vc-backend vc-log-file
))
1613 (vc-responsible-backend default-directory
))
1615 (run-hooks 'vc-logentry-check-hook
))
1616 ;; Sync parent buffer in case the user modified it while editing the comment.
1617 ;; But not if it is a vc-dired buffer.
1618 (with-current-buffer vc-parent-buffer
1619 (or vc-dired-mode
(vc-buffer-sync)))
1620 (if (not vc-log-operation
) (error "No log operation is pending"))
1621 ;; save the parameters held in buffer-local variables
1622 (let ((log-operation vc-log-operation
)
1623 (log-file vc-log-file
)
1624 (log-version vc-log-version
)
1625 (log-entry (buffer-string))
1626 (after-hook vc-log-after-operation-hook
)
1627 (tmp-vc-parent-buffer vc-parent-buffer
))
1628 (pop-to-buffer vc-parent-buffer
)
1631 (funcall log-operation
1635 ;; Remove checkin window (after the checkin so that if that fails
1636 ;; we don't zap the *VC-log* buffer and the typing therein).
1637 (let ((logbuf (get-buffer "*VC-log*")))
1638 (cond ((and logbuf vc-delete-logbuf-window
)
1639 (delete-windows-on logbuf
(selected-frame))
1640 ;; Kill buffer and delete any other dedicated windows/frames.
1641 (kill-buffer logbuf
))
1642 (logbuf (pop-to-buffer "*VC-log*")
1644 (pop-to-buffer tmp-vc-parent-buffer
))))
1645 ;; Now make sure we see the expanded headers
1647 (vc-resynch-buffer log-file vc-keep-workfiles t
))
1649 (dired-move-to-filename))
1650 (run-hooks after-hook
'vc-finish-logentry-hook
)))
1652 ;; Code for access to the comment ring
1654 ;; Additional entry points for examining version histories
1657 (defun vc-diff (historic &optional not-urgent
)
1658 "Display diffs between file versions.
1659 Normally this compares the current file and buffer with the most
1660 recent checked in version of that file. This uses no arguments. With
1661 a prefix argument HISTORIC, it reads the file name to use and two
1662 version designators specifying which versions to compare. The
1663 optional argument NOT-URGENT non-nil means it is ok to say no to
1665 (interactive (list current-prefix-arg t
))
1667 (call-interactively 'vc-version-diff
)
1668 (vc-ensure-vc-buffer)
1669 (let ((file buffer-file-name
))
1670 (vc-buffer-sync not-urgent
)
1671 (if (vc-workfile-unchanged-p buffer-file-name
)
1672 (message "No changes to %s since latest version" file
)
1673 (vc-version-diff file nil nil
)))))
1675 (defun vc-version-diff (file rel1 rel2
)
1676 "List the differences between FILE's versions REL1 and REL2.
1677 If REL1 is empty or nil it means to use the current workfile version;
1678 REL2 empty or nil means the current file contents. FILE may also be
1679 a directory, in that case, generate diffs between the correponding
1680 versions of all registered files in or below it."
1682 (let ((file (expand-file-name
1683 (read-file-name (if buffer-file-name
1684 "File or dir to diff: (default visited file) "
1685 "File or dir to diff: ")
1686 default-directory buffer-file-name t
)))
1687 (rel1-default nil
) (rel2-default nil
))
1688 ;; compute default versions based on the file state
1690 ;; if it's a directory, don't supply any version default
1691 ((file-directory-p file
)
1693 ;; if the file is not up-to-date, use current version as older version
1694 ((not (vc-up-to-date-p file
))
1695 (setq rel1-default
(vc-workfile-version file
)))
1696 ;; if the file is not locked, use last and previous version as default
1698 (setq rel1-default
(vc-call previous-version file
1699 (vc-workfile-version file
)))
1700 (if (string= rel1-default
"") (setq rel1-default nil
))
1701 (setq rel2-default
(vc-workfile-version file
))))
1702 ;; construct argument list
1704 (read-string (if rel1-default
1705 (concat "Older version: (default "
1708 nil nil rel1-default
)
1709 (read-string (if rel2-default
1710 (concat "Newer version: (default "
1712 "Newer version (default: current source): ")
1713 nil nil rel2-default
))))
1714 (if (file-directory-p file
)
1715 ;; recursive directory diff
1717 (vc-setup-buffer "*vc-diff*")
1718 (if (string-equal rel1
"") (setq rel1 nil
))
1719 (if (string-equal rel2
"") (setq rel2 nil
))
1720 (let ((inhibit-read-only t
))
1721 (insert "Diffs between "
1722 (or rel1
"last version checked in")
1724 (or rel2
"current workfile(s)")
1726 (let ((dir (file-name-as-directory file
)))
1727 (vc-call-backend (vc-responsible-backend dir
)
1728 'diff-tree dir rel1 rel2
))
1729 (vc-exec-after `(let ((inhibit-read-only t
))
1730 (insert "\nEnd of diffs.\n"))))
1731 ;; Single file diff. It is important that the vc-controlled buffer
1732 ;; is still current at this time, because any local settings in that
1733 ;; buffer should affect the diff command.
1734 (vc-diff-internal file rel1 rel2
))
1735 (set-buffer "*vc-diff*")
1736 (if (and (zerop (buffer-size))
1737 (not (get-buffer-process (current-buffer))))
1741 (message "No changes to %s between %s and %s" file rel1 rel2
)
1742 (message "No changes to %s since %s" file rel1
))
1743 (message "No changes to %s since latest version" file
))
1745 (pop-to-buffer (current-buffer))
1746 ;; Gnus-5.8.5 sets up an autoload for diff-mode, even if it's
1747 ;; not available. Work around that.
1748 (if (require 'diff-mode nil t
) (diff-mode))
1749 (vc-exec-after '(let ((inhibit-read-only t
))
1750 (if (eq (buffer-size) 0)
1751 (insert "No differences found.\n"))
1752 (goto-char (point-min))
1753 (shrink-window-if-larger-than-buffer)))
1756 (defun vc-diff-internal (file rel1 rel2
)
1757 "Run diff to compare FILE's revisions REL1 and REL2.
1758 Diff output goes to the *vc-diff* buffer. The exit status of the diff
1759 command is returned.
1761 This function takes care to set up a proper coding system for diff output.
1762 If both revisions are available as local files, then it also does not
1763 actually call the backend, but performs a local diff."
1764 (if (or (not rel1
) (string-equal rel1
""))
1765 (setq rel1
(vc-workfile-version file
)))
1766 (if (string-equal rel2
"")
1768 (let ((file-rel1 (vc-version-backup-file file rel1
))
1769 (file-rel2 (if (not rel2
)
1771 (vc-version-backup-file file rel2
)))
1772 (coding-system-for-read (vc-coding-system-for-diff file
)))
1773 (if (and file-rel1 file-rel2
)
1774 (apply 'vc-do-command
"*vc-diff*" 1 "diff" nil
1775 (append (vc-switches nil
'diff
)
1776 (list (file-relative-name file-rel1
)
1777 (file-relative-name file-rel2
))))
1778 (vc-call diff file rel1 rel2
))))
1781 (defun vc-switches (backend op
)
1784 (let ((sym (vc-make-backend-sym
1785 backend
(intern (concat (symbol-name op
)
1787 (if (boundp sym
) (symbol-value sym
))))
1788 (let ((sym (intern (format "vc-%s-switches" (symbol-name op
)))))
1789 (if (boundp sym
) (symbol-value sym
)))
1791 ((eq op
'diff
) diff-switches
)))))
1792 (if (stringp switches
) (list switches
)
1793 ;; If not a list, return nil.
1794 ;; This is so we can set vc-diff-switches to t to override
1795 ;; any switches in diff-switches.
1796 (if (listp switches
) switches
))))
1798 ;; Old def for compatibility with Emacs-21.[123].
1799 (defmacro vc-diff-switches-list
(backend) `(vc-switches ',backend
'diff
))
1800 (make-obsolete 'vc-diff-switches-list
'vc-switches
"21.4")
1802 (defun vc-default-diff-tree (backend dir rel1 rel2
)
1803 "List differences for all registered files at and below DIR.
1804 The meaning of REL1 and REL2 is the same as for `vc-version-diff'."
1805 ;; This implementation does an explicit tree walk, and calls
1806 ;; vc-BACKEND-diff directly for each file. An optimization
1807 ;; would be to use `vc-diff-internal', so that diffs can be local,
1808 ;; and to call it only for files that are actually changed.
1809 ;; However, this is expensive for some backends, and so it is left
1810 ;; to backend-specific implementations.
1811 (setq default-directory dir
)
1816 `(let ((coding-system-for-read (vc-coding-system-for-diff ',f
)))
1817 (message "Looking at %s" ',f
)
1818 (vc-call-backend ',(vc-backend f
)
1819 'diff
',f
',rel1
',rel2
))))))
1821 (defun vc-coding-system-for-diff (file)
1822 "Return the coding system for reading diff output for FILE."
1823 (or coding-system-for-read
1824 ;; if we already have this file open,
1825 ;; use the buffer's coding system
1826 (let ((buf (find-buffer-visiting file
)))
1827 (if buf
(with-current-buffer buf
1828 buffer-file-coding-system
)))
1829 ;; otherwise, try to find one based on the file name
1830 (car (find-operation-coding-system 'insert-file-contents file
))
1831 ;; and a final fallback
1835 (defun vc-version-other-window (rev)
1836 "Visit version REV of the current file in another window.
1837 If the current file is named `F', the version is named `F.~REV~'.
1838 If `F.~REV~' already exists, use it instead of checking it out again."
1839 (interactive "sVersion to visit (default is workfile version): ")
1840 (vc-ensure-vc-buffer)
1841 (let* ((file buffer-file-name
)
1842 (version (if (string-equal rev
"")
1843 (vc-workfile-version file
)
1845 (switch-to-buffer-other-window (vc-find-version file version
))))
1847 (defun vc-find-version (file version
)
1848 "Read VERSION of FILE into a buffer and return the buffer."
1849 (let ((automatic-backup (vc-version-backup-file-name file version
))
1850 (filebuf (or (get-file-buffer file
) (current-buffer)))
1851 (filename (vc-version-backup-file-name file version
'manual
)))
1852 (unless (file-exists-p filename
)
1853 (if (file-exists-p automatic-backup
)
1854 (rename-file automatic-backup filename nil
)
1855 (message "Checking out %s..." filename
)
1856 (with-current-buffer filebuf
1859 (let ((coding-system-for-read 'no-conversion
)
1860 (coding-system-for-write 'no-conversion
))
1861 (with-temp-file filename
1862 (let ((outbuf (current-buffer)))
1863 ;; Change buffer to get local value of
1864 ;; vc-checkout-switches.
1865 (with-current-buffer filebuf
1866 (vc-call find-version file version outbuf
))))
1868 (if (and failed
(file-exists-p filename
))
1869 (delete-file filename
))))
1870 (vc-mode-line file
))
1871 (message "Checking out %s...done" filename
)))
1872 (find-file-noselect filename
)))
1874 (defun vc-default-find-version (backend file rev buffer
)
1875 "Provide the new `find-version' op based on the old `checkout' op.
1876 This is only for compatibility with old backends. They should be updated
1877 to provide the `find-version' operation instead."
1878 (let ((tmpfile (make-temp-file (expand-file-name file
))))
1881 (vc-call-backend backend
'checkout file nil rev tmpfile
)
1882 (with-current-buffer buffer
1883 (insert-file-contents-literally tmpfile
)))
1884 (delete-file tmpfile
))))
1886 ;; Header-insertion code
1889 (defun vc-insert-headers ()
1890 "Insert headers into a file for use with a version control system.
1891 Headers desired are inserted at point, and are pulled from
1892 the variable `vc-BACKEND-header'."
1894 (vc-ensure-vc-buffer)
1898 (if (or (not (vc-check-headers))
1899 (y-or-n-p "Version headers already exist. Insert another set? "))
1901 (let* ((delims (cdr (assq major-mode vc-comment-alist
)))
1902 (comment-start-vc (or (car delims
) comment-start
"#"))
1903 (comment-end-vc (or (car (cdr delims
)) comment-end
""))
1904 (hdsym (vc-make-backend-sym (vc-backend buffer-file-name
)
1906 (hdstrings (and (boundp hdsym
) (symbol-value hdsym
))))
1908 (insert comment-start-vc
"\t" s
"\t"
1909 comment-end-vc
"\n"))
1911 (if vc-static-header-alist
1913 (if (string-match (car f
) buffer-file-name
)
1914 (insert (format (cdr f
) (car hdstrings
)))))
1915 vc-static-header-alist
))
1919 (defun vc-clear-headers (&optional file
)
1920 "Clear all version headers in the current buffer (or FILE).
1921 The headers are reset to their non-expanded form."
1922 (let* ((filename (or file buffer-file-name
))
1923 (visited (find-buffer-visiting filename
))
1924 (backend (vc-backend filename
)))
1925 (when (vc-find-backend-function backend
'clear-headers
)
1927 (let ((context (vc-buffer-context)))
1928 ;; save-excursion may be able to relocate point and mark
1929 ;; properly. If it fails, vc-restore-buffer-context
1930 ;; will give it a second try.
1932 (vc-call-backend backend
'clear-headers
))
1933 (vc-restore-buffer-context context
))
1934 (set-buffer (find-file-noselect filename
))
1935 (vc-call-backend backend
'clear-headers
)
1936 (kill-buffer filename
)))))
1940 "Merge changes between two versions into the current buffer's file.
1941 This asks for two versions to merge from in the minibuffer. If the
1942 first version is a branch number, then merge all changes from that
1943 branch. If the first version is empty, merge news, i.e. recent changes
1944 from the current branch.
1946 See Info node `Merging'."
1948 (vc-ensure-vc-buffer)
1950 (let* ((file buffer-file-name
)
1951 (backend (vc-backend file
))
1952 (state (vc-state file
))
1953 first-version second-version status
)
1956 (error "File is locked by %s" state
))
1957 ((not (vc-editable-p file
))
1959 "File must be checked out for merging. Check out now? ")
1960 (vc-checkout file t
)
1961 (error "Merge aborted"))))
1963 (read-string (concat "Branch or version to merge from "
1964 "(default: news on current branch): ")))
1965 (if (string= first-version
"")
1966 (if (not (vc-find-backend-function backend
'merge-news
))
1967 (error "Sorry, merging news is not implemented for %s" backend
)
1968 (setq status
(vc-call merge-news file
)))
1969 (if (not (vc-find-backend-function backend
'merge
))
1970 (error "Sorry, merging is not implemented for %s" backend
)
1971 (if (not (vc-branch-p first-version
))
1972 (setq second-version
1973 (read-string "Second version: "
1974 (concat (vc-branch-part first-version
) ".")))
1975 ;; We want to merge an entire branch. Set versions
1976 ;; accordingly, so that vc-BACKEND-merge understands us.
1977 (setq second-version first-version
)
1978 ;; first-version must be the starting point of the branch
1979 (setq first-version
(vc-branch-part first-version
)))
1980 (setq status
(vc-call merge file first-version second-version
))))
1981 (vc-maybe-resolve-conflicts file status
"WORKFILE" "MERGE SOURCE")))
1983 (defun vc-maybe-resolve-conflicts (file status
&optional name-A name-B
)
1984 (vc-resynch-buffer file t
(not (buffer-modified-p)))
1985 (if (zerop status
) (message "Merge successful")
1987 (if (y-or-n-p "Conflicts detected. Resolve them now? ")
1988 (vc-resolve-conflicts name-A name-B
)
1989 (message "File contains conflict markers"))))
1992 (defalias 'vc-resolve-conflicts
'smerge-ediff
)
1994 ;; The VC directory major mode. Coopt Dired for this.
1995 ;; All VC commands get mapped into logical equivalents.
1997 (defvar vc-dired-switches
)
1998 (defvar vc-dired-terse-mode
)
2000 (defvar vc-dired-mode-map
2001 (let ((map (make-sparse-keymap))
2002 (vmap (make-sparse-keymap)))
2003 (define-key map
"\C-xv" vmap
)
2004 (define-key map
"v" vmap
)
2005 (set-keymap-parent vmap vc-prefix-map
)
2006 (define-key vmap
"t" 'vc-dired-toggle-terse-mode
)
2009 (define-derived-mode vc-dired-mode dired-mode
"Dired under VC"
2010 "The major mode used in VC directory buffers.
2012 It works like Dired, but lists only files under version control, with
2013 the current VC state of each file being indicated in the place of the
2014 file's link count, owner, group and size. Subdirectories are also
2015 listed, and you may insert them into the buffer as desired, like in
2018 All Dired commands operate normally, with the exception of `v', which
2019 is redefined as the version control prefix, so that you can type
2020 `vl', `v=' etc. to invoke `vc-print-log', `vc-diff', and the like on
2021 the file named in the current Dired buffer line. `vv' invokes
2022 `vc-next-action' on this file, or on all files currently marked.
2023 There is a special command, `*l', to mark all files currently locked."
2024 ;; define-derived-mode does it for us in Emacs-21, but not in Emacs-20.
2025 ;; We do it here because dired might not be loaded yet
2026 ;; when vc-dired-mode-map is initialized.
2027 (set-keymap-parent vc-dired-mode-map dired-mode-map
)
2028 (add-hook 'dired-after-readin-hook
'vc-dired-hook nil t
)
2029 ;; The following is slightly modified from dired.el,
2030 ;; because file lines look a bit different in vc-dired-mode
2031 ;; (the column before the date does not end in a digit).
2032 (set (make-local-variable 'dired-move-to-filename-regexp
)
2033 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
2034 ;; In some locales, month abbreviations are as short as 2 letters,
2035 ;; and they can be followed by ".".
2036 (month (concat l l
"+\\.?"))
2038 (yyyy "[0-9][0-9][0-9][0-9]")
2040 (HH:MM
"[ 0-2][0-9]:[0-5][0-9]")
2041 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
2042 (zone "[-+][0-2][0-9][0-5][0-9]")
2043 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
2044 (iso-time (concat HH
:MM
"\\(:" seconds
"\\( ?" zone
"\\)?\\)?"))
2045 (iso (concat "\\(\\(" yyyy
"-\\)?" iso-mm-dd
"[ T]" iso-time
2046 "\\|" yyyy
"-" iso-mm-dd
"\\)"))
2047 (western (concat "\\(" month s
"+" dd
"\\|" dd
"\\.?" s month
"\\)"
2049 "\\(" HH
:MM
"\\|" yyyy
"\\)"))
2050 (western-comma (concat month s
"+" dd
"," s
"+" yyyy
))
2051 ;; Japanese MS-Windows ls-lisp has one-digit months, and
2052 ;; omits the Kanji characters after month and day-of-month.
2055 (concat mm l
"?" s dd l
"?" s
"+"
2056 "\\(" HH
:MM
"\\|" yyyy l
"?" "\\)")))
2057 ;; the .* below ensures that we find the last match on a line
2059 "\\(" western
"\\|" western-comma
"\\|" japanese
"\\|" iso
"\\)"
2061 (and (boundp 'vc-dired-switches
)
2063 (set (make-local-variable 'dired-actual-switches
)
2065 (set (make-local-variable 'vc-dired-terse-mode
) vc-dired-terse-display
)
2066 (setq vc-dired-mode t
))
2068 (defun vc-dired-toggle-terse-mode ()
2069 "Toggle terse display in VC Dired."
2071 (if (not vc-dired-mode
)
2073 (setq vc-dired-terse-mode
(not vc-dired-terse-mode
))
2074 (if vc-dired-terse-mode
2078 (defun vc-dired-mark-locked ()
2079 "Mark all files currently locked."
2081 (dired-mark-if (let ((f (dired-get-filename nil t
)))
2083 (not (file-directory-p f
))
2084 (not (vc-up-to-date-p f
))))
2087 (define-key vc-dired-mode-map
"*l" 'vc-dired-mark-locked
)
2089 (defun vc-default-dired-state-info (backend file
)
2090 (let ((state (vc-state file
)))
2092 ((stringp state
) (concat "(" state
")"))
2093 ((eq state
'edited
) (concat "(" (vc-user-login-name) ")"))
2094 ((eq state
'needs-merge
) "(merge)")
2095 ((eq state
'needs-patch
) "(patch)")
2096 ((eq state
'unlocked-changes
) "(stale)"))))
2098 (defun vc-dired-reformat-line (vc-info)
2099 "Reformat a directory-listing line.
2100 Replace various columns with version control information, VC-INFO.
2101 This code, like dired, assumes UNIX -l format."
2103 (when (re-search-forward
2104 ;; Match link count, owner, group, size. Group may be missing,
2105 ;; and only the size is present in OS/2 -l format.
2106 "^..[drwxlts-]+ \\( *[0-9]+\\( [^ ]+ +\\([^ ]+ +\\)?[0-9]+\\)?\\) "
2107 (line-end-position) t
)
2108 (replace-match (substring (concat vc-info
" ") 0 10)
2111 (defun vc-dired-hook ()
2112 "Reformat the listing according to version control.
2113 Called by dired after any portion of a vc-dired buffer has been read in."
2114 (message "Getting version information... ")
2115 (let (subdir filename
(buffer-read-only nil
))
2116 (goto-char (point-min))
2119 ;; subdir header line
2120 ((setq subdir
(dired-get-subdir))
2121 ;; if the backend supports it, get the state
2122 ;; of all files in this directory at once
2123 (let ((backend (vc-responsible-backend subdir
)))
2124 (if (vc-find-backend-function backend
'dir-state
)
2125 (vc-call-backend backend
'dir-state subdir
)))
2127 ;; erase (but don't remove) the "total" line
2128 (delete-region (point) (line-end-position))
2132 ((setq filename
(dired-get-filename nil t
))
2135 ((file-directory-p filename
)
2137 ((member (file-name-nondirectory filename
)
2138 vc-directory-exclusion-list
)
2139 (let ((pos (point)))
2140 (dired-kill-tree filename
)
2143 (vc-dired-terse-mode
2144 ;; Don't show directories in terse mode. Don't use
2145 ;; dired-kill-line to remove it, because in recursive listings,
2146 ;; that would remove the directory contents as well.
2147 (delete-region (line-beginning-position)
2148 (progn (forward-line 1) (point))))
2149 ((string-match "\\`\\.\\.?\\'" (file-name-nondirectory filename
))
2152 (vc-dired-reformat-line nil
)
2155 ((and (vc-backend filename
)
2156 (not (and vc-dired-terse-mode
2157 (vc-up-to-date-p filename
))))
2158 (vc-dired-reformat-line (vc-call dired-state-info filename
))
2161 (dired-kill-line))))
2163 (t (forward-line 1))))
2165 (message "Getting version information... done")
2168 (cond ((eq (count-lines (point-min) (point-max)) 1)
2169 (goto-char (point-min))
2170 (message "No files locked under %s" default-directory
)))))
2172 (defun vc-dired-purge ()
2173 "Remove empty subdirs."
2174 (goto-char (point-min))
2175 (while (dired-get-subdir)
2177 (if (dired-get-filename nil t
)
2178 (if (not (dired-next-subdir 1 t
))
2179 (goto-char (point-max)))
2181 (if (not (string= (dired-current-directory) default-directory
))
2182 (dired-do-kill-lines t
"")
2183 ;; We cannot remove the top level directory.
2184 ;; Just make it look a little nicer.
2186 (or (eobp) (kill-line))
2187 (if (not (dired-next-subdir 1 t
))
2188 (goto-char (point-max))))))
2189 (goto-char (point-min)))
2191 (defun vc-dired-buffers-for-dir (dir)
2192 "Return a list of all vc-dired buffers that currently display DIR."
2194 ;; Check whether dired is loaded.
2195 (when (fboundp 'dired-buffers-for-dir
)
2196 (mapcar (lambda (buffer)
2197 (with-current-buffer buffer
2199 (setq result
(append result
(list buffer
))))))
2200 (dired-buffers-for-dir dir
)))
2203 (defun vc-dired-resynch-file (file)
2204 "Update the entries for FILE in any VC Dired buffers that list it."
2205 (let ((buffers (vc-dired-buffers-for-dir (file-name-directory file
))))
2207 (mapcar (lambda (buffer)
2208 (with-current-buffer buffer
2209 (if (dired-goto-file file
)
2210 ;; bind vc-dired-terse-mode to nil so that
2211 ;; files won't vanish when they are checked in
2212 (let ((vc-dired-terse-mode nil
))
2213 (dired-do-redisplay 1)))))
2217 (defun vc-directory (dir read-switches
)
2218 "Create a buffer in VC Dired Mode for directory DIR.
2220 See Info node `VC Dired Mode'.
2222 With prefix arg READ-SWITCHES, specify a value to override
2223 `dired-listing-switches' when generating the listing."
2224 (interactive "DDired under VC (directory): \nP")
2225 (let ((vc-dired-switches (concat vc-dired-listing-switches
2226 (if vc-dired-recurse
"R" ""))))
2228 (setq vc-dired-switches
2229 (read-string "Dired listing switches: "
2230 vc-dired-switches
)))
2232 (require 'dired-aux
)
2234 (dired-internal-noselect (expand-file-name (file-name-as-directory dir
))
2239 ;; Named-configuration entry points
2241 (defun vc-snapshot-precondition (dir)
2242 "Scan the tree below DIR, looking for files not up-to-date.
2243 If any file is not up-to-date, return the name of the first such file.
2244 \(This means, neither snapshot creation nor retrieval is allowed.\)
2245 If one or more of the files are currently visited, return `visited'.
2246 Otherwise, return nil."
2248 (catch 'vc-locked-example
2252 (if (not (vc-up-to-date-p f
)) (throw 'vc-locked-example f
)
2253 (if (get-file-buffer f
) (setq status
'visited
)))))
2257 (defun vc-create-snapshot (dir name branchp
)
2258 "Descending recursively from DIR, make a snapshot called NAME.
2259 For each registered file, the version level of its latest version
2260 becomes part of the named configuration. If the prefix argument
2261 BRANCHP is given, the snapshot is made as a new branch and the files
2262 are checked out in that new branch."
2264 (list (read-file-name "Directory: " default-directory default-directory t
)
2265 (read-string "New snapshot name: ")
2266 current-prefix-arg
))
2267 (message "Making %s... " (if branchp
"branch" "snapshot"))
2268 (if (file-directory-p dir
) (setq dir
(file-name-as-directory dir
)))
2269 (vc-call-backend (vc-responsible-backend dir
)
2270 'create-snapshot dir name branchp
)
2271 (message "Making %s... done" (if branchp
"branch" "snapshot")))
2273 (defun vc-default-create-snapshot (backend dir name branchp
)
2275 (error "VC backend %s does not support module branches" backend
))
2276 (let ((result (vc-snapshot-precondition dir
)))
2277 (if (stringp result
)
2278 (error "File %s is not up-to-date" result
)
2282 (vc-call assign-name f name
))))))
2285 (defun vc-retrieve-snapshot (dir name
)
2286 "Descending recursively from DIR, retrieve the snapshot called NAME.
2287 If NAME is empty, it refers to the latest versions.
2288 If locking is used for the files in DIR, then there must not be any
2289 locked files at or below DIR (but if NAME is empty, locked files are
2290 allowed and simply skipped)."
2292 (list (read-file-name "Directory: " default-directory default-directory t
)
2293 (read-string "Snapshot name to retrieve (default latest versions): ")))
2294 (let ((update (yes-or-no-p "Update any affected buffers? "))
2295 (msg (if (or (not name
) (string= name
""))
2296 (format "Updating %s... " (abbreviate-file-name dir
))
2297 (format "Retrieving snapshot into %s... "
2298 (abbreviate-file-name dir
)))))
2300 (vc-call-backend (vc-responsible-backend dir
)
2301 'retrieve-snapshot dir name update
)
2302 (message (concat msg
"done"))))
2304 (defun vc-default-retrieve-snapshot (backend dir name update
)
2305 (if (string= name
"")
2312 (vc-call checkout f nil
"")
2313 (if update
(vc-resynch-buffer f t t
)))))))
2314 (let ((result (vc-snapshot-precondition dir
)))
2315 (if (stringp result
)
2316 (error "File %s is locked" result
)
2317 (setq update
(and (eq result
'visited
) update
))
2320 (lambda (f) (vc-error-occurred
2321 (vc-call checkout f nil name
)
2322 (if update
(vc-resynch-buffer f t t
)))))))))
2324 ;; Miscellaneous other entry points
2327 (defun vc-print-log (&optional focus-rev
)
2328 "List the change log of the current buffer in a window.
2329 If FOCUS-REV is non-nil, leave the point at that revision."
2331 (vc-ensure-vc-buffer)
2332 (let* ((file buffer-file-name
)
2333 (print-log-args-length
2334 (length (cadr (symbol-function
2335 (vc-find-backend-function (vc-backend file
)
2337 (or focus-rev
(setq focus-rev
(vc-workfile-version file
)))
2338 ;; Don't switch to the output buffer before running the command,
2339 ;; so that any buffer-local settings in the vc-controlled
2340 ;; buffer can be accessed by the command.
2341 (if (> print-log-args-length
1)
2343 (vc-call print-log file
"*vc-change-log*")
2344 (set-buffer "*vc-change-log*"))
2345 ;; for backward compatibility
2346 (vc-call print-log file
)
2347 (set-buffer "*vc*"))
2348 (pop-to-buffer (current-buffer))
2351 `(let ((inhibit-read-only t
))
2352 (goto-char (point-max)) (forward-line -
1)
2353 (while (looking-at "=*\n")
2354 (delete-char (- (match-end 0) (match-beginning 0)))
2356 (goto-char (point-min))
2357 (if (looking-at "[\b\t\n\v\f\r ]+")
2358 (delete-char (- (match-end 0) (match-beginning 0))))
2359 (shrink-window-if-larger-than-buffer)
2360 ;; move point to the log entry for the current version
2361 (vc-call-backend ',(vc-backend file
)
2364 (set-buffer-modified-p nil
)))))
2366 (defun vc-default-show-log-entry (backend rev
)
2368 (log-view-goto-rev rev
)))
2370 (defun vc-default-comment-history (backend file
)
2371 "Return a string with all log entries stored in BACKEND for FILE."
2372 (if (vc-find-backend-function backend
'print-log
)
2373 (with-current-buffer "*vc*"
2374 (vc-call print-log file
)
2375 (vc-call wash-log file
)
2378 (defun vc-default-wash-log (backend file
)
2379 "Remove all non-comment information from log output.
2380 This default implementation works for RCS logs; backends should override
2381 it if their logs are not in RCS format."
2382 (let ((separator (concat "^-+\nrevision [0-9.]+\ndate: .*\n"
2383 "\\(branches: .*;\n\\)?"
2384 "\\(\\*\\*\\* empty log message \\*\\*\\*\n\\)?")))
2385 (goto-char (point-max)) (forward-line -
1)
2386 (while (looking-at "=*\n")
2387 (delete-char (- (match-end 0) (match-beginning 0)))
2389 (goto-char (point-min))
2390 (if (looking-at "[\b\t\n\v\f\r ]+")
2391 (delete-char (- (match-end 0) (match-beginning 0))))
2392 (goto-char (point-min))
2393 (re-search-forward separator nil t
)
2394 (delete-region (point-min) (point))
2395 (while (re-search-forward separator nil t
)
2396 (delete-region (match-beginning 0) (match-end 0)))))
2399 (defun vc-revert-buffer ()
2400 "Revert the current buffer's file to the version it was based on.
2401 This asks for confirmation if the buffer contents are not identical
2402 to that version. This function does not automatically pick up newer
2403 changes found in the master file; use \\[universal-argument] \\[vc-next-action] to do so."
2405 (vc-ensure-vc-buffer)
2406 ;; Make sure buffer is saved. If the user says `no', abort since
2407 ;; we cannot show the changes and ask for confirmation to discard them.
2408 (vc-buffer-sync nil
)
2409 (let ((file buffer-file-name
)
2410 ;; This operation should always ask for confirmation.
2411 (vc-suppress-confirm nil
)
2412 (obuf (current-buffer))
2414 (if (vc-up-to-date-p file
)
2415 (unless (yes-or-no-p "File seems up-to-date. Revert anyway? ")
2416 (error "Revert canceled")))
2417 (unless (vc-workfile-unchanged-p file
)
2418 ;; vc-diff selects the new window, which is not what we want:
2419 ;; if the new window is on another frame, that'd require the user
2420 ;; moving her mouse to answer the yes-or-no-p question.
2421 (let ((win (save-selected-window
2422 (setq status
(vc-diff nil t
)) (selected-window))))
2423 (vc-exec-after `(message nil
))
2426 (unless (yes-or-no-p "Discard changes? ")
2427 (error "Revert canceled"))
2429 (if (one-window-p t
)
2430 (if (window-dedicated-p (selected-window))
2431 (make-frame-invisible))
2432 (delete-window))))))
2435 (message "Reverting %s..." file
)
2436 (vc-revert-file file
)
2437 (message "Reverting %s...done" file
)))
2441 "Update the current buffer's file to the latest version on its branch.
2442 If the file contains no changes, and is not locked, then this simply replaces
2443 the working file with the latest version on its branch. If the file contains
2444 changes, and the backend supports merging news, then any recent changes from
2445 the current branch are merged into the working file."
2447 (vc-ensure-vc-buffer)
2448 (vc-buffer-sync nil
)
2449 (let ((file buffer-file-name
))
2450 (if (vc-up-to-date-p file
)
2451 (vc-checkout file nil
"")
2452 (if (eq (vc-checkout-model file
) 'locking
)
2453 (if (eq (vc-state file
) 'edited
)
2455 (substitute-command-keys
2456 "File is locked--type \\[vc-revert-buffer] to discard changes"))
2458 (substitute-command-keys
2459 "Unexpected file state (%s)--type \\[vc-next-action] to correct")
2461 (if (not (vc-find-backend-function (vc-backend file
) 'merge-news
))
2462 (error "Sorry, merging news is not implemented for %s"
2464 (vc-call merge-news file
)
2465 (vc-resynch-window file t t
))))))
2467 (defun vc-version-backup-file (file &optional rev
)
2468 "Return name of backup file for revision REV of FILE.
2469 If version backups should be used for FILE, and there exists
2470 such a backup for REV or the current workfile version of file,
2471 return its name; otherwise return nil."
2472 (when (vc-call make-version-backups-p file
)
2473 (let ((backup-file (vc-version-backup-file-name file rev
)))
2474 (if (file-exists-p backup-file
)
2476 ;; there is no automatic backup, but maybe the user made one manually
2477 (setq backup-file
(vc-version-backup-file-name file rev
'manual
))
2478 (if (file-exists-p backup-file
)
2481 (defun vc-revert-file (file)
2482 "Revert FILE back to the version it was based on."
2485 (let ((backup-file (vc-version-backup-file file
)))
2487 (copy-file backup-file file
'ok-if-already-exists
'keep-date
)
2488 (vc-delete-automatic-version-backups file
))
2489 (vc-call revert file backup-file
))
2490 `((vc-state . up-to-date
)
2491 (vc-checkout-time .
,(nth 5 (file-attributes file
)))))
2492 (vc-resynch-buffer file t t
))
2495 (defun vc-cancel-version (norevert)
2496 "Get rid of most recently checked in version of this file.
2497 A prefix argument NOREVERT means do not revert the buffer afterwards."
2499 (vc-ensure-vc-buffer)
2500 (let* ((file buffer-file-name
)
2501 (backend (vc-backend file
))
2502 (target (vc-workfile-version file
)))
2504 ((not (vc-find-backend-function backend
'cancel-version
))
2505 (error "Sorry, canceling versions is not supported under %s" backend
))
2506 ((not (vc-call latest-on-branch-p file
))
2507 (error "This is not the latest version; VC cannot cancel it"))
2508 ((not (vc-up-to-date-p file
))
2509 (error "%s" (substitute-command-keys "File is not up to date; use \\[vc-revert-buffer] to discard changes"))))
2510 (if (null (yes-or-no-p (format "Remove version %s from master? " target
)))
2512 (setq norevert
(or norevert
(not
2513 (yes-or-no-p "Revert buffer to most recent remaining version? "))))
2515 (message "Removing last change from %s..." file
)
2518 (vc-call cancel-version file norevert
)
2519 `((vc-state .
,(if norevert
'edited
'up-to-date
))
2520 (vc-checkout-time .
,(if norevert
2522 (nth 5 (file-attributes file
))))
2523 (vc-workfile-version . nil
)))
2524 (message "Removing last change from %s...done" file
)
2527 (norevert ;; clear version headers and mark the buffer modified
2528 (set-visited-file-name file
)
2529 (when (not vc-make-backup-files
)
2530 ;; inhibit backup for this buffer
2531 (make-local-variable 'backup-inhibited
)
2532 (setq backup-inhibited t
))
2533 (setq buffer-read-only nil
)
2536 (vc-dired-resynch-file file
))
2537 (t ;; revert buffer to file on disk
2538 (vc-resynch-buffer file t t
)))
2539 (message "Version %s has been removed from the master" target
))))
2542 (defun vc-switch-backend (file backend
)
2543 "Make BACKEND the current version control system for FILE.
2544 FILE must already be registered in BACKEND. The change is not
2545 permanent, only for the current session. This function only changes
2546 VC's perspective on FILE, it does not register or unregister it.
2547 By default, this command cycles through the registered backends.
2548 To get a prompt, use a prefix argument."
2552 (let ((backend (vc-backend buffer-file-name
))
2554 ;; Find the registered backends.
2555 (dolist (backend vc-handled-backends
)
2556 (when (vc-call-backend backend
'registered buffer-file-name
)
2557 (push backend backends
)))
2558 ;; Find the next backend.
2559 (let ((def (car (delq backend
(append (memq backend backends
) backends
))))
2560 (others (delete backend backends
)))
2562 ((null others
) (error "No other backend to switch to"))
2567 (format "Switch to backend [%s]: " def
)
2568 (mapcar (lambda (b) (list (downcase (symbol-name b
)))) backends
)
2569 nil t nil nil
(downcase (symbol-name def
))))))
2571 (unless (eq backend
(vc-backend file
))
2572 (vc-file-clearprops file
)
2573 (vc-file-setprop file
'vc-backend backend
)
2574 ;; Force recomputation of the state
2575 (unless (vc-call-backend backend
'registered file
)
2576 (vc-file-clearprops file
)
2577 (error "%s is not registered in %s" file backend
))
2578 (vc-mode-line file
)))
2581 (defun vc-transfer-file (file new-backend
)
2582 "Transfer FILE to another version control system NEW-BACKEND.
2583 If NEW-BACKEND has a higher precedence than FILE's current backend
2584 \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in
2585 NEW-BACKEND, using the version number from the current backend as the
2586 base level. If NEW-BACKEND has a lower precedence than the current
2587 backend, then commit all changes that were made under the current
2588 backend to NEW-BACKEND, and unregister FILE from the current backend.
2589 \(If FILE is not yet registered under NEW-BACKEND, register it.)"
2590 (let* ((old-backend (vc-backend file
))
2591 (edited (memq (vc-state file
) '(edited needs-merge
)))
2592 (registered (vc-call-backend new-backend
'registered file
))
2594 (and registered
; Never move if not registered in new-backend yet.
2595 ;; move if new-backend comes later in vc-handled-backends
2596 (or (memq new-backend
(memq old-backend vc-handled-backends
))
2597 (y-or-n-p "Final transfer? "))))
2599 (if (eq old-backend new-backend
)
2600 (error "%s is the current backend of %s" new-backend file
))
2602 (set-file-modes file
(logior (file-modes file
) 128))
2603 ;; `registered' might have switched under us.
2604 (vc-switch-backend file old-backend
)
2605 (let* ((rev (vc-workfile-version file
))
2606 (modified-file (and edited
(make-temp-file file
)))
2607 (unmodified-file (and modified-file
(vc-version-backup-file file
))))
2608 ;; Go back to the base unmodified file.
2612 (copy-file file modified-file
'ok-if-already-exists
)
2613 ;; If we have a local copy of the unmodified file, handle that
2614 ;; here and not in vc-revert-file because we don't want to
2615 ;; delete that copy -- it is still useful for OLD-BACKEND.
2617 (copy-file unmodified-file file
2618 'ok-if-already-exists
'keep-date
)
2619 (if (y-or-n-p "Get base version from master? ")
2620 (vc-revert-file file
))))
2621 (vc-call-backend new-backend
'receive-file file rev
))
2623 (vc-switch-backend file new-backend
)
2624 (unless (eq (vc-checkout-model file
) 'implicit
)
2625 (vc-checkout file t nil
))
2626 (rename-file modified-file file
'ok-if-already-exists
)
2627 (vc-file-setprop file
'vc-checkout-time nil
)))))
2629 (vc-switch-backend file old-backend
)
2630 (setq comment
(vc-call comment-history file
))
2631 (vc-call unregister file
))
2632 (vc-switch-backend file new-backend
)
2633 (when (or move edited
)
2634 (vc-file-setprop file
'vc-state
'edited
)
2636 (vc-checkin file nil comment
(stringp comment
)))))
2638 (defun vc-default-unregister (backend file
)
2639 "Default implementation of `vc-unregister', signals an error."
2640 (error "Unregistering files is not supported for %s" backend
))
2642 (defun vc-default-receive-file (backend file rev
)
2643 "Let BACKEND receive FILE from another version control system."
2644 (vc-call-backend backend
'register file rev
""))
2646 (defun vc-rename-master (oldmaster newfile templates
)
2647 "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES."
2648 (let* ((dir (file-name-directory (expand-file-name oldmaster
)))
2649 (newdir (or (file-name-directory newfile
) ""))
2650 (newbase (file-name-nondirectory newfile
))
2652 ;; List of potential master files for `newfile'
2654 (lambda (s) (vc-possible-master s newdir newbase
))
2656 (if (or (file-symlink-p oldmaster
)
2657 (file-symlink-p (file-name-directory oldmaster
)))
2658 (error "This is unsafe in the presence of symbolic links"))
2662 ;; If possible, keep the master file in the same directory.
2664 (if (and f
(string= (file-name-directory (expand-file-name f
)) dir
))
2666 ;; If not, just use the first possible place.
2668 (and f
(or (not (setq dir
(file-name-directory f
)))
2669 (file-directory-p dir
))
2671 (error "New file lacks a version control directory")))))
2673 (defun vc-delete-file (file)
2674 "Delete file and mark it as such in the version control system."
2675 (interactive "fVC delete file: ")
2676 (let ((buf (get-file-buffer file
))
2677 (backend (vc-backend file
)))
2679 (error "File %s is not under version control"
2680 (file-name-nondirectory file
)))
2681 (unless (vc-find-backend-function backend
'delete-file
)
2682 (error "Deleting files under %s is not supported in VC" backend
))
2683 (if (and buf
(buffer-modified-p buf
))
2684 (error "Please save files before deleting them"))
2685 (unless (y-or-n-p (format "Really want to delete %s ? "
2686 (file-name-nondirectory file
)))
2688 (unless (or (file-directory-p file
) (null make-backup-files
))
2689 (with-current-buffer (or buf
(find-file-noselect file
))
2690 (let ((backup-inhibited nil
))
2692 (vc-call delete-file file
)
2693 ;; If the backend hasn't deleted the file itself, let's do it for him.
2694 (if (file-exists-p file
) (delete-file file
))))
2696 (defun vc-default-rename-file (backend old new
)
2698 (add-name-to-file old new
)
2699 (error (rename-file old new
)))
2700 (vc-delete-file old
)
2701 (with-current-buffer (find-file-noselect new
)
2705 (defun vc-rename-file (old new
)
2706 "Rename file OLD to NEW, and rename its master file likewise."
2707 (interactive "fVC rename file: \nFRename to: ")
2708 (let ((oldbuf (get-file-buffer old
)))
2709 (if (and oldbuf
(buffer-modified-p oldbuf
))
2710 (error "Please save files before moving them"))
2711 (if (get-file-buffer new
)
2712 (error "Already editing new file name"))
2713 (if (file-exists-p new
)
2714 (error "New file already exists"))
2715 (let ((state (vc-state old
)))
2716 (unless (memq state
'(up-to-date edited
))
2717 (error "Please %s files before moving them"
2718 (if (stringp state
) "check in" "update"))))
2719 (vc-call rename-file old new
)
2720 (vc-file-clearprops old
)
2721 ;; Move the actual file (unless the backend did it already)
2722 (if (file-exists-p old
) (rename-file old new
))
2723 ;; ?? Renaming a file might change its contents due to keyword expansion.
2724 ;; We should really check out a new copy if the old copy was precisely equal
2725 ;; to some checked in version. However, testing for this is tricky....
2727 (with-current-buffer oldbuf
2728 (let ((buffer-read-only buffer-read-only
))
2729 (set-visited-file-name new
))
2732 (set-buffer-modified-p nil
)))))
2734 ;; Only defined in very recent Emacsen
2735 (defvar small-temporary-file-directory nil
)
2738 (defun vc-update-change-log (&rest args
)
2739 "Find change log file and add entries from recent version control logs.
2740 Normally, find log entries for all registered files in the default
2743 With prefix arg of \\[universal-argument], only find log entries for the current buffer's file.
2745 With any numeric prefix arg, find log entries for all currently visited
2746 files that are under version control. This puts all the entries in the
2747 log for the default directory, which may not be appropriate.
2749 From a program, any ARGS are assumed to be filenames for which
2750 log entries should be gathered."
2752 (cond ((consp current-prefix-arg
) ;C-u
2753 (list buffer-file-name
))
2754 (current-prefix-arg ;Numeric argument.
2756 (buffers (buffer-list))
2759 (setq file
(buffer-file-name (car buffers
)))
2760 (and file
(vc-backend file
)
2761 (setq files
(cons file files
)))
2762 (setq buffers
(cdr buffers
)))
2765 ;; Don't supply any filenames to backend; this means
2766 ;; it should find all relevant files relative to
2767 ;; the default-directory.
2769 (vc-call-backend (vc-responsible-backend default-directory
)
2770 'update-changelog args
))
2772 (defun vc-default-update-changelog (backend files
)
2773 "Default implementation of update-changelog.
2774 Uses `rcs2log' which only works for RCS and CVS."
2775 ;; FIXME: We (c|sh)ould add support for cvs2cl
2776 (let ((odefault default-directory
)
2777 (changelog (find-change-log))
2778 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
2779 (tempfile (make-temp-file
2780 (expand-file-name "vc"
2781 (or small-temporary-file-directory
2782 temporary-file-directory
))))
2783 (full-name (or add-log-full-name
2786 (format "uid%d" (number-to-string (user-uid)))))
2787 (mailing-address (or add-log-mailing-address
2788 user-mail-address
)))
2789 (find-file-other-window changelog
)
2790 (barf-if-buffer-read-only)
2793 (goto-char (point-min))
2795 (message "Computing change log entries...")
2796 (message "Computing change log entries... %s"
2799 (setq default-directory odefault
)
2800 (if (eq 0 (apply 'call-process
2801 (expand-file-name "rcs2log"
2803 nil
(list t tempfile
) nil
2805 "-u" (concat (vc-user-login-name)
2807 "\t" mailing-address
)
2811 (if (file-name-absolute-p f
)
2813 (concat odefault f
))))
2817 (set-buffer (get-buffer-create "*vc*")))
2819 (insert-file tempfile
)
2821 (setq default-directory
(file-name-directory changelog
))
2822 (delete-file tempfile
)))))
2824 ;; Annotate functionality
2826 ;; Declare globally instead of additional parameter to
2827 ;; temp-buffer-show-function (not possible to pass more than one
2828 ;; parameter). The use of annotate-ratio is deprecated in favor of
2829 ;; annotate-mode, which replaces it with the more sensible "span-to
2830 ;; days", along with autoscaling support.
2831 (defvar vc-annotate-ratio nil
"Global variable.")
2832 (defvar vc-annotate-backend nil
"Global variable.")
2834 ;; internal buffer-local variables
2835 (defvar vc-annotate-parent-file nil
)
2836 (defvar vc-annotate-parent-rev nil
)
2837 (defvar vc-annotate-parent-display-mode nil
)
2839 (defconst vc-annotate-font-lock-keywords
2840 ;; The fontification is done by vc-annotate-lines instead of font-lock.
2841 '((vc-annotate-lines)))
2843 (defun vc-annotate-get-backend (buffer)
2844 "Return the backend matching \"Annotate\" buffer BUFFER.
2845 Return nil if no match made. Associations are made based on
2846 `vc-annotate-buffers'."
2847 (cdr (assoc buffer vc-annotate-buffers
)))
2849 (define-derived-mode vc-annotate-mode fundamental-mode
"Annotate"
2850 "Major mode for output buffers of the `vc-annotate' command.
2852 You can use the mode-specific menu to alter the time-span of the used
2853 colors. See variable `vc-annotate-menu-elements' for customizing the
2855 (set (make-local-variable 'truncate-lines
) t
)
2856 (set (make-local-variable 'font-lock-defaults
)
2857 '(vc-annotate-font-lock-keywords t
))
2859 (vc-annotate-add-menu))
2861 (defun vc-annotate-display-default (&optional ratio
)
2862 "Display the output of \\[vc-annotate] using the default color range.
2863 The color range is given by `vc-annotate-color-map', scaled by RATIO
2864 if present. The current time is used as the offset."
2866 (message "Redisplaying annotation...")
2867 (vc-annotate-display
2868 (if ratio
(vc-annotate-time-span vc-annotate-color-map ratio
)))
2869 (message "Redisplaying annotation...done"))
2871 (defun vc-annotate-display-autoscale (&optional full
)
2872 "Highlight the output of \\[vc-annotate]] using an autoscaled color map.
2873 Autoscaling means that the map is scaled from the current time to the
2874 oldest annotation in the buffer, or, with argument FULL non-nil, to
2875 cover the range from the oldest annotation to the newest."
2878 (oldest 999999.
) ;Any CVS users at the founding of Rome?
2879 (current (vc-annotate-convert-time (current-time)))
2881 (message "Redisplaying annotation...")
2882 ;; Run through this file and find the oldest and newest dates annotated.
2884 (goto-char (point-min))
2885 (while (setq date
(vc-call-backend vc-annotate-backend
'annotate-time
))
2889 (setq oldest date
))))
2890 (vc-annotate-display
2891 (vc-annotate-time-span ;return the scaled colormap.
2892 vc-annotate-color-map
2893 (/ (- (if full newest current
) oldest
)
2894 (vc-annotate-car-last-cons vc-annotate-color-map
)))
2896 (message "Redisplaying annotation...done \(%s\)"
2898 (format "Spanned from %.1f to %.1f days old"
2901 (format "Spanned to %.1f days old" (- current oldest
))))))
2903 ;; Menu -- Using easymenu.el
2904 (defun vc-annotate-add-menu ()
2905 "Add the menu 'Annotate' to the menu bar in VC-Annotate mode."
2906 (let ((menu-elements vc-annotate-menu-elements
)
2909 ["Default" (unless (null vc-annotate-display-mode
)
2910 (setq vc-annotate-display-mode nil
)
2911 (vc-annotate-display-select))
2912 :style toggle
:selected
(null vc-annotate-display-mode
)]))
2913 (oldest-in-map (vc-annotate-car-last-cons vc-annotate-color-map
)))
2914 (while menu-elements
2915 (let* ((element (car menu-elements
))
2916 (days (* element oldest-in-map
)))
2917 (setq menu-elements
(cdr menu-elements
))
2920 `([,(format "Span %.1f days" days
)
2921 (unless (and (numberp vc-annotate-display-mode
)
2922 (= vc-annotate-display-mode
,days
))
2923 (vc-annotate-display-select nil
,days
))
2924 :style toggle
:selected
2925 (and (numberp vc-annotate-display-mode
)
2926 (= vc-annotate-display-mode
,days
)) ])))))
2932 (float (string-to-number
2933 (read-string "Span how many days? ")))))
2934 (vc-annotate-display-select nil days
)) t
])
2938 (unless (eq vc-annotate-display-mode
'scale
)
2939 (vc-annotate-display-select nil
'scale
))
2940 :style toggle
:selected
2941 (eq vc-annotate-display-mode
'scale
)])
2943 ["Span Oldest->Newest"
2944 (unless (eq vc-annotate-display-mode
'fullscale
)
2945 (vc-annotate-display-select nil
'fullscale
))
2946 :style toggle
:selected
2947 (eq vc-annotate-display-mode
'fullscale
)])
2949 (list ["Annotate previous revision"
2950 (call-interactively 'vc-annotate-prev-version
)])
2951 (list ["Annotate next revision"
2952 (call-interactively 'vc-annotate-next-version
)])
2953 (list ["Annotate revision at line"
2954 (vc-annotate-revision-at-line)])
2955 (list ["Annotate revision previous to line"
2956 (vc-annotate-revision-previous-to-line)])
2957 (list ["Annotate latest revision"
2958 (vc-annotate-workfile-version)])
2959 (list ["Show log of revision at line"
2960 (vc-annotate-show-log-revision-at-line)])
2961 (list ["Show diff of revision at line"
2962 (vc-annotate-show-diff-revision-at-line)])))
2965 (if (or (featurep 'easymenu
) (load "easymenu" t
))
2966 (easy-menu-define vc-annotate-mode-menu vc-annotate-mode-map
2967 "VC Annotate Display Menu" menu-def
))))
2969 (defun vc-annotate-display-select (&optional buffer mode
)
2970 "Highlight the output of \\[vc-annotate].
2971 By default, the current buffer is highlighted, unless overridden by
2972 BUFFER. `vc-annotate-display-mode' specifies the highlighting mode to
2973 use; you may override this using the second optional arg MODE."
2975 (if mode
(setq vc-annotate-display-mode mode
))
2978 (display-buffer buffer
))
2979 (if (not vc-annotate-mode
) ; Turn on vc-annotate-mode if not done
2981 (cond ((null vc-annotate-display-mode
)
2982 (vc-annotate-display-default vc-annotate-ratio
))
2983 ;; One of the auto-scaling modes
2984 ((eq vc-annotate-display-mode
'scale
)
2985 (vc-annotate-display-autoscale))
2986 ((eq vc-annotate-display-mode
'fullscale
)
2987 (vc-annotate-display-autoscale t
))
2988 ((numberp vc-annotate-display-mode
) ; A fixed number of days lookback
2989 (vc-annotate-display-default
2990 (/ vc-annotate-display-mode
(vc-annotate-car-last-cons
2991 vc-annotate-color-map
))))
2992 (t (error "No such display mode: %s"
2993 vc-annotate-display-mode
))))
2995 ;;;; (defun vc-BACKEND-annotate-command (file buffer) ...)
2996 ;;;; Execute "annotate" on FILE by using `call-process' and insert
2997 ;;;; the contents in BUFFER.
3000 (defun vc-annotate (prefix &optional revision display-mode
)
3001 "Display the edit history of the current file using colours.
3003 This command creates a buffer that shows, for each line of the current
3004 file, when it was last edited and by whom. Additionally, colours are
3005 used to show the age of each line--blue means oldest, red means
3006 youngest, and intermediate colours indicate intermediate ages. By
3007 default, the time scale stretches back one year into the past;
3008 everything that is older than that is shown in blue.
3010 With a prefix argument, this command asks two questions in the
3011 minibuffer. First, you may enter a version number; then the buffer
3012 displays and annotates that version instead of the current version
3013 \(type RET in the minibuffer to leave that default unchanged). Then,
3014 you are prompted for the time span in days which the color range
3015 should cover. For example, a time span of 20 days means that changes
3016 over the past 20 days are shown in red to blue, according to their
3017 age, and everything that is older than that is shown in blue.
3019 Customization variables:
3021 `vc-annotate-menu-elements' customizes the menu elements of the
3022 mode-specific menu. `vc-annotate-color-map' and
3023 `vc-annotate-very-old-color' defines the mapping of time to
3024 colors. `vc-annotate-background' specifies the background color."
3026 (vc-ensure-vc-buffer)
3027 (let* ((temp-buffer-name nil
)
3028 (temp-buffer-show-function 'vc-annotate-display-select
)
3029 (rev (or revision
(vc-workfile-version buffer-file-name
)))
3030 (bfn buffer-file-name
)
3031 (vc-annotate-version
3032 (if prefix
(read-string
3033 (format "Annotate from version: (default %s) " rev
)
3037 (setq vc-annotate-display-mode display-mode
)
3039 (setq vc-annotate-display-mode
3040 (float (string-to-number
3041 (read-string "Annotate span days: (default 20) "
3043 (setq temp-buffer-name
(format "*Annotate %s (rev %s)*"
3044 (buffer-name) vc-annotate-version
))
3045 (setq vc-annotate-backend
(vc-backend buffer-file-name
))
3046 (message "Annotating...")
3047 (if (not (vc-find-backend-function vc-annotate-backend
'annotate-command
))
3048 (error "Sorry, annotating is not implemented for %s"
3049 vc-annotate-backend
))
3050 (with-output-to-temp-buffer temp-buffer-name
3051 (vc-call-backend vc-annotate-backend
'annotate-command
3053 (get-buffer temp-buffer-name
)
3054 vc-annotate-version
))
3056 (set-buffer temp-buffer-name
)
3057 (set (make-local-variable 'vc-annotate-parent-file
) bfn
)
3058 (set (make-local-variable 'vc-annotate-parent-rev
) vc-annotate-version
)
3059 (set (make-local-variable 'vc-annotate-parent-display-mode
)
3060 vc-annotate-display-mode
))
3062 ;; Don't use the temp-buffer-name until the buffer is created
3063 ;; (only after `with-output-to-temp-buffer'.)
3064 (setq vc-annotate-buffers
3065 (append vc-annotate-buffers
3066 (list (cons (get-buffer temp-buffer-name
) vc-annotate-backend
))))
3067 (message "Annotating... done")))
3069 (defun vc-annotate-prev-version (prefix)
3070 "Visit the annotation of the version previous to this one.
3072 With a numeric prefix argument, annotate the version that many
3075 (vc-annotate-warp-version (- 0 prefix
)))
3077 (defun vc-annotate-next-version (prefix)
3078 "Visit the annotation of the version after this one.
3080 With a numeric prefix argument, annotate the version that many
3083 (vc-annotate-warp-version prefix
))
3085 (defun vc-annotate-workfile-version ()
3086 "Visit the annotation of the workfile version of this file."
3088 (if (not (equal major-mode
'vc-annotate-mode
))
3089 (message "Cannot be invoked outside of a vc annotate buffer")
3090 (let ((warp-rev (vc-workfile-version vc-annotate-parent-file
)))
3091 (if (equal warp-rev vc-annotate-parent-rev
)
3092 (message "Already at version %s" warp-rev
)
3093 (vc-annotate-warp-version warp-rev
)))))
3095 (defun vc-annotate-extract-revision-at-line ()
3096 "Extract the revision number of the current line."
3097 ;; This function must be invoked from a buffer in vc-annotate-mode
3098 (save-window-excursion
3099 (vc-ensure-vc-buffer)
3100 (setq vc-annotate-backend
(vc-backend buffer-file-name
)))
3101 (vc-call-backend vc-annotate-backend
'annotate-extract-revision-at-line
))
3103 (defun vc-annotate-revision-at-line ()
3104 "Visit the annotation of the version identified in the current line."
3106 (if (not (equal major-mode
'vc-annotate-mode
))
3107 (message "Cannot be invoked outside of a vc annotate buffer")
3108 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
3109 (if (not rev-at-line
)
3110 (message "Cannot extract revision number from the current line")
3111 (if (equal rev-at-line vc-annotate-parent-rev
)
3112 (message "Already at version %s" rev-at-line
)
3113 (vc-annotate-warp-version rev-at-line
))))))
3115 (defun vc-annotate-revision-previous-to-line ()
3116 "Visit the annotation of the version before the version at line."
3118 (if (not (equal major-mode
'vc-annotate-mode
))
3119 (message "Cannot be invoked outside of a vc annotate buffer")
3120 (let ((rev-at-line (vc-annotate-extract-revision-at-line))
3122 (if (not rev-at-line
)
3123 (message "Cannot extract revision number from the current line")
3125 (vc-call previous-version vc-annotate-parent-file rev-at-line
))
3126 (vc-annotate-warp-version prev-rev
)))))
3128 (defun vc-annotate-show-log-revision-at-line ()
3129 "Visit the log of the version at line."
3131 (if (not (equal major-mode
'vc-annotate-mode
))
3132 (message "Cannot be invoked outside of a vc annotate buffer")
3133 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
3134 (if (not rev-at-line
)
3135 (message "Cannot extract revision number from the current line")
3136 (vc-print-log rev-at-line
)))))
3138 (defun vc-annotate-show-diff-revision-at-line ()
3139 "Visit the diff of the version at line from its previous version."
3141 (if (not (equal major-mode
'vc-annotate-mode
))
3142 (message "Cannot be invoked outside of a vc annotate buffer")
3143 (let ((rev-at-line (vc-annotate-extract-revision-at-line))
3145 (if (not rev-at-line
)
3146 (message "Cannot extract revision number from the current line")
3148 (vc-call previous-version vc-annotate-parent-file rev-at-line
))
3150 (message "Cannot diff from any version prior to %s" rev-at-line
)
3151 (save-window-excursion
3152 (vc-version-diff vc-annotate-parent-file prev-rev rev-at-line
))
3153 (switch-to-buffer "*vc-diff*"))))))
3155 (defun vc-annotate-warp-version (revspec)
3156 "Annotate the version described by REVSPEC.
3158 If REVSPEC is a positive integer, warp that many versions
3159 forward, if possible, otherwise echo a warning message. If
3160 REVSPEC is a negative integer, warp that many versions backward,
3161 if possible, otherwise echo a warning message. If REVSPEC is a
3162 string, then it describes a revision number, so warp to that
3164 (if (not (equal major-mode
'vc-annotate-mode
))
3165 (message "Cannot be invoked outside of a vc annotate buffer")
3166 (let* ((oldline (line-number-at-pos))
3167 (revspeccopy revspec
)
3170 ((and (integerp revspec
) (> revspec
0))
3171 (setq newrev vc-annotate-parent-rev
)
3172 (while (and (> revspec
0) newrev
)
3173 (setq newrev
(vc-call next-version
3174 vc-annotate-parent-file newrev
))
3175 (setq revspec
(1- revspec
)))
3177 (message "Cannot increment %d versions from version %s"
3178 revspeccopy vc-annotate-parent-rev
)))
3179 ((and (integerp revspec
) (< revspec
0))
3180 (setq newrev vc-annotate-parent-rev
)
3181 (while (and (< revspec
0) newrev
)
3182 (setq newrev
(vc-call previous-version
3183 vc-annotate-parent-file newrev
))
3184 (setq revspec
(1+ revspec
)))
3186 (message "Cannot decrement %d versions from version %s"
3187 (- 0 revspeccopy
) vc-annotate-parent-rev
)))
3188 ((stringp revspec
) (setq newrev revspec
))
3189 (t (error "Invalid argument to vc-annotate-warp-version")))
3191 (save-window-excursion
3192 (find-file vc-annotate-parent-file
)
3193 (vc-annotate nil newrev vc-annotate-parent-display-mode
))
3194 (kill-buffer (current-buffer)) ;; kill the buffer we started from
3195 (switch-to-buffer (car (car (last vc-annotate-buffers
))))
3196 (goto-line (min oldline
(progn (goto-char (point-max))
3198 (line-number-at-pos))))))))
3200 (defun vc-annotate-car-last-cons (a-list)
3201 "Return car of last cons in association list A-LIST."
3202 (if (not (eq nil
(cdr a-list
)))
3203 (vc-annotate-car-last-cons (cdr a-list
))
3204 (car (car a-list
))))
3206 (defun vc-annotate-time-span (a-list span
&optional quantize
)
3207 "Apply factor SPAN to the time-span of association list A-LIST.
3208 Return the new alist.
3209 Optionally quantize to the factor of QUANTIZE."
3210 ;; Apply span to each car of every cons
3211 (if (not (eq nil a-list
))
3212 (append (list (cons (* (car (car a-list
)) span
)
3213 (cdr (car a-list
))))
3214 (vc-annotate-time-span (nthcdr (or quantize
; optional
3216 a-list
) span quantize
))))
3218 (defun vc-annotate-compcar (threshold a-list
)
3219 "Test successive cons cells of A-LIST against THRESHOLD.
3220 Return the first cons cell with a car that is not less than THRESHOLD,
3221 nil if no such cell exists."
3223 (tmp-cons (car a-list
)))
3224 (while (and tmp-cons
(< (car tmp-cons
) threshold
))
3225 (setq tmp-cons
(car (nthcdr i a-list
)))
3227 tmp-cons
)) ; Return the appropriate value
3229 (defun vc-annotate-convert-time (time)
3230 "Convert a time value to a floating-point number of days.
3231 The argument TIME is a list as returned by `current-time' or
3232 `encode-time', only the first two elements of that list are considered."
3233 (/ (+ (* (float (car time
)) (lsh 1 16)) (cadr time
)) 24 3600))
3235 (defun vc-annotate-difference (&optional offset
)
3236 "Return the time span in days to the next annotation.
3237 This calls the backend function annotate-time, and returns the
3238 difference in days between the time returned and the current time,
3239 or OFFSET if present."
3240 (let ((next-time (vc-call-backend vc-annotate-backend
'annotate-time
)))
3243 (vc-call-backend vc-annotate-backend
'annotate-current-time
))
3246 (defun vc-default-annotate-current-time (backend)
3247 "Return the current time, encoded as fractional days."
3248 (vc-annotate-convert-time (current-time)))
3250 (defvar vc-annotate-offset nil
)
3252 (defun vc-annotate-display (&optional color-map offset
)
3253 "Highlight `vc-annotate' output in the current buffer.
3254 COLOR-MAP, if present, overrides `vc-annotate-color-map'.
3255 The annotations are relative to the current time, unless overridden by OFFSET."
3256 (if (and color-map
(not (eq color-map vc-annotate-color-map
)))
3257 (set (make-local-variable 'vc-annotate-color-map
) color-map
))
3258 (set (make-local-variable 'vc-annotate-offset
) offset
)
3261 (defun vc-annotate-lines (limit)
3263 (while (and (< (point) limit
)
3264 (setq difference
(vc-annotate-difference vc-annotate-offset
)))
3265 (let* ((color (or (vc-annotate-compcar difference vc-annotate-color-map
)
3266 (cons nil vc-annotate-very-old-color
)))
3267 ;; substring from index 1 to remove any leading `#' in the name
3268 (face-name (concat "vc-annotate-face-" (substring (cdr color
) 1)))
3269 ;; Make the face if not done.
3270 (face (or (intern-soft face-name
)
3271 (let ((tmp-face (make-face (intern face-name
))))
3272 (set-face-foreground tmp-face
(cdr color
))
3273 (if vc-annotate-background
3274 (set-face-background tmp-face
3275 vc-annotate-background
))
3276 tmp-face
))) ; Return the face
3279 (put-text-property point
(point) 'face face
)))
3280 ;; Pretend to font-lock there were no matches.
3283 ;; Collect back-end-dependent stuff here
3285 (defalias 'vc-default-logentry-check
'ignore
)
3287 (defun vc-check-headers ()
3288 "Check if the current file has any headers in it."
3290 (vc-call-backend (vc-backend buffer-file-name
) 'check-headers
))
3292 (defun vc-default-check-headers (backend)
3293 "Default implementation of check-headers; always returns nil."
3296 ;; Back-end-dependent stuff ends here.
3298 ;; Set up key bindings for use while editing log messages
3300 (defun vc-log-edit (file)
3301 "Set up `log-edit' for use with VC on FILE."
3302 (setq default-directory
3303 (if file
(file-name-directory file
)
3304 (with-current-buffer vc-parent-buffer default-directory
)))
3305 (log-edit 'vc-finish-logentry nil
3306 (if file
`(lambda () ',(list (file-name-nondirectory file
)))
3307 ;; If FILE is nil, we were called from vc-dired.
3309 (with-current-buffer vc-parent-buffer
3310 (dired-get-marked-files t
)))))
3311 (set (make-local-variable 'vc-log-file
) file
)
3312 (make-local-variable 'vc-log-version
)
3313 (set-buffer-modified-p nil
)
3314 (setq buffer-file-name nil
))
3316 ;; These things should probably be generally available
3318 (defun vc-file-tree-walk (dirname func
&rest args
)
3319 "Walk recursively through DIRNAME.
3320 Invoke FUNC f ARGS on each VC-managed file f underneath it."
3321 (vc-file-tree-walk-internal (expand-file-name dirname
) func args
)
3322 (message "Traversing directory %s...done" dirname
))
3324 (defun vc-file-tree-walk-internal (file func args
)
3325 (if (not (file-directory-p file
))
3326 (if (vc-backend file
) (apply func file args
))
3327 (message "Traversing directory %s..." (abbreviate-file-name file
))
3328 (let ((dir (file-name-as-directory file
)))
3331 (string-equal f
".")
3332 (string-equal f
"..")
3333 (member f vc-directory-exclusion-list
)
3334 (let ((dirf (expand-file-name f dir
)))
3336 (file-symlink-p dirf
);; Avoid possible loops
3337 (vc-file-tree-walk-internal dirf func args
)))))
3338 (directory-files dir
)))))
3342 ;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
3344 ;; These may be useful to anyone who has to debug or extend the package.
3345 ;; (Note that this information corresponds to versions 5.x. Some of it
3346 ;; might have been invalidated by the additions to support branching
3347 ;; and RCS keyword lookup. AS, 1995/03/24)
3349 ;; A fundamental problem in VC is that there are time windows between
3350 ;; vc-next-action's computations of the file's version-control state and
3351 ;; the actions that change it. This is a window open to lossage in a
3352 ;; multi-user environment; someone else could nip in and change the state
3353 ;; of the master during it.
3355 ;; The performance problem is that rlog/prs calls are very expensive; we want
3356 ;; to avoid them as much as possible.
3360 ;; The performance problem, it turns out, simplifies in practice to the
3361 ;; problem of making vc-state fast. The two other functions that call
3362 ;; prs/rlog will not be so commonly used that the slowdown is a problem; one
3363 ;; makes snapshots, the other deletes the calling user's last change in the
3366 ;; The race condition implies that we have to either (a) lock the master
3367 ;; during the entire execution of vc-next-action, or (b) detect and
3368 ;; recover from errors resulting from dispatch on an out-of-date state.
3370 ;; Alternative (a) appears to be infeasible. The problem is that we can't
3371 ;; guarantee that the lock will ever be removed. Suppose a user starts a
3372 ;; checkin, the change message buffer pops up, and the user, having wandered
3373 ;; off to do something else, simply forgets about it?
3375 ;; Alternative (b), on the other hand, works well with a cheap way to speed up
3376 ;; vc-state. Usually, if a file is registered, we can read its locked/
3377 ;; unlocked state and its current owner from its permissions.
3379 ;; This shortcut will fail if someone has manually changed the workfile's
3380 ;; permissions; also if developers are munging the workfile in several
3381 ;; directories, with symlinks to a master (in this latter case, the
3382 ;; permissions shortcut will fail to detect a lock asserted from another
3385 ;; Note that these cases correspond exactly to the errors which could happen
3386 ;; because of a competing checkin/checkout race in between two instances of
3389 ;; For VC's purposes, a workfile/master pair may have the following states:
3391 ;; A. Unregistered. There is a workfile, there is no master.
3393 ;; B. Registered and not locked by anyone.
3395 ;; C. Locked by calling user and unchanged.
3397 ;; D. Locked by the calling user and changed.
3399 ;; E. Locked by someone other than the calling user.
3401 ;; This makes for 25 states and 20 error conditions. Here's the matrix:
3403 ;; VC's idea of state
3405 ;; V Actual state RCS action SCCS action Effect
3407 ;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
3408 ;; B 5 . 6 7 8 co -l get -e checkout
3409 ;; C 9 10 . 11 12 co -u unget; get revert
3410 ;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
3411 ;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
3413 ;; All commands take the master file name as a last argument (not shown).
3415 ;; In the discussion below, a "self-race" is a pathological situation in
3416 ;; which VC operations are being attempted simultaneously by two or more
3417 ;; Emacsen running under the same username.
3419 ;; The vc-next-action code has the following windows:
3422 ;; Between the check for existence of a master file and the call to
3423 ;; admin/checkin in vc-buffer-admin (apparent state A). This window may
3424 ;; never close if the initial-comment feature is on.
3427 ;; Between the call to vc-workfile-unchanged-p in and the immediately
3428 ;; following revert (apparent state C).
3431 ;; Between the call to vc-workfile-unchanged-p in and the following
3432 ;; checkin (apparent state D). This window may never close.
3435 ;; Between the unlock and the immediately following checkout during a
3436 ;; revert operation (apparent state C). Included in window Q.
3439 ;; Between vc-state and the following checkout (apparent state B).
3442 ;; Between vc-state and the following revert (apparent state C).
3443 ;; Includes windows Q and S.
3446 ;; Between vc-state and the following checkin (apparent state
3447 ;; D). This window may never be closed if the user fails to complete the
3448 ;; checkin message. Includes window R.
3451 ;; Between vc-state and the following steal-lock (apparent
3452 ;; state E). This window may never close if the user fails to complete
3453 ;; the steal-lock message. Includes window X.
3456 ;; Between the unlock and the immediately following re-lock during a
3457 ;; steal-lock operation (apparent state E). This window may never close
3458 ;; if the user fails to complete the steal-lock message.
3462 ;; Apparent state A ---
3464 ;; 1. File looked unregistered but is actually registered and not locked.
3466 ;; Potential cause: someone else's admin during window P, with
3467 ;; caller's admin happening before their checkout.
3469 ;; RCS: Prior to version 5.6.4, ci fails with message
3470 ;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
3471 ;; ci -i option and the message is "<file>,v: already exists".
3472 ;; SCCS: admin will fail with error (ad19).
3474 ;; We can let these errors be passed up to the user.
3476 ;; 2. File looked unregistered but is actually locked by caller, unchanged.
3478 ;; Potential cause: self-race during window P.
3480 ;; RCS: Prior to version 5.6.4, reverts the file to the last saved
3481 ;; version and unlocks it. From 5.6.4 onwards, VC uses the new
3482 ;; ci -i option, failing with message "<file>,v: already exists".
3483 ;; SCCS: will fail with error (ad19).
3485 ;; Either of these consequences is acceptable.
3487 ;; 3. File looked unregistered but is actually locked by caller, changed.
3489 ;; Potential cause: self-race during window P.
3491 ;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
3492 ;; a delta with a null change comment (the -t- switch will be
3493 ;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
3494 ;; failing with message "<file>,v: already exists".
3495 ;; SCCS: will fail with error (ad19).
3497 ;; 4. File looked unregistered but is locked by someone else.
3499 ;; Potential cause: someone else's admin during window P, with
3500 ;; caller's admin happening *after* their checkout.
3502 ;; RCS: Prior to version 5.6.4, ci fails with a
3503 ;; "no lock set by <user>" message. From 5.6.4 onwards,
3504 ;; VC uses the new ci -i option, failing with message
3505 ;; "<file>,v: already exists".
3506 ;; SCCS: will fail with error (ad19).
3508 ;; We can let these errors be passed up to the user.
3510 ;; Apparent state B ---
3512 ;; 5. File looked registered and not locked, but is actually unregistered.
3514 ;; Potential cause: master file got nuked during window P.
3516 ;; RCS: will fail with "RCS/<file>: No such file or directory"
3517 ;; SCCS: will fail with error ut4.
3519 ;; We can let these errors be passed up to the user.
3521 ;; 6. File looked registered and not locked, but is actually locked by the
3522 ;; calling user and unchanged.
3524 ;; Potential cause: self-race during window T.
3526 ;; RCS: in the same directory as the previous workfile, co -l will fail
3527 ;; with "co error: writable foo exists; checkout aborted". In any other
3528 ;; directory, checkout will succeed.
3529 ;; SCCS: will fail with ge17.
3531 ;; Either of these consequences is acceptable.
3533 ;; 7. File looked registered and not locked, but is actually locked by the
3534 ;; calling user and changed.
3538 ;; 8. File looked registered and not locked, but is actually locked by another
3541 ;; Potential cause: someone else checks it out during window T.
3543 ;; RCS: co error: revision 1.3 already locked by <user>
3544 ;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
3546 ;; We can let these errors be passed up to the user.
3548 ;; Apparent state C ---
3550 ;; 9. File looks locked by calling user and unchanged, but is unregistered.
3554 ;; 10. File looks locked by calling user and unchanged, but is actually not
3557 ;; Potential cause: a self-race in window U, or by the revert's
3558 ;; landing during window X of some other user's steal-lock or window S
3559 ;; of another user's revert.
3561 ;; RCS: succeeds, refreshing the file from the identical version in
3563 ;; SCCS: fails with error ut4 (p file nonexistent).
3565 ;; Either of these consequences is acceptable.
3567 ;; 11. File is locked by calling user. It looks unchanged, but is actually
3570 ;; Potential cause: the file would have to be touched by a self-race
3573 ;; The revert will succeed, removing whatever changes came with
3574 ;; the touch. It is theoretically possible that work could be lost.
3576 ;; 12. File looks like it's locked by the calling user and unchanged, but
3577 ;; it's actually locked by someone else.
3579 ;; Potential cause: a steal-lock in window V.
3581 ;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
3582 ;; SCCS: fails with error un2
3584 ;; We can pass these errors up to the user.
3586 ;; Apparent state D ---
3588 ;; 13. File looks like it's locked by the calling user and changed, but it's
3589 ;; actually unregistered.
3591 ;; Potential cause: master file got nuked during window P.
3593 ;; RCS: Prior to version 5.6.4, checks in the user's version as an
3594 ;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
3595 ;; option, failing with message "no such file or directory".
3596 ;; SCCS: will fail with error ut4.
3598 ;; This case is kind of nasty. Under RCS prior to version 5.6.4,
3599 ;; VC may fail to detect the loss of previous version information.
3601 ;; 14. File looks like it's locked by the calling user and changed, but it's
3602 ;; actually unlocked.
3604 ;; Potential cause: self-race in window V, or the checkin happening
3605 ;; during the window X of someone else's steal-lock or window S of
3606 ;; someone else's revert.
3608 ;; RCS: ci will fail with "no lock set by <user>".
3609 ;; SCCS: delta will fail with error ut4.
3611 ;; 15. File looks like it's locked by the calling user and changed, but it's
3612 ;; actually locked by the calling user and unchanged.
3614 ;; Potential cause: another self-race --- a whole checkin/checkout
3615 ;; sequence by the calling user would have to land in window R.
3617 ;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
3618 ;; RCS: reverts to the file state as of the second user's checkin, leaving
3619 ;; the file unlocked.
3621 ;; It is theoretically possible that work could be lost under RCS.
3623 ;; 16. File looks like it's locked by the calling user and changed, but it's
3624 ;; actually locked by a different user.
3626 ;; RCS: ci error: no lock set by <user>
3627 ;; SCCS: unget will fail with error un2
3629 ;; We can pass these errors up to the user.
3631 ;; Apparent state E ---
3633 ;; 17. File looks like it's locked by some other user, but it's actually
3638 ;; 18. File looks like it's locked by some other user, but it's actually
3641 ;; Potential cause: someone released a lock during window W.
3643 ;; RCS: The calling user will get the lock on the file.
3644 ;; SCCS: unget -n will fail with cm4.
3646 ;; Either of these consequences will be OK.
3648 ;; 19. File looks like it's locked by some other user, but it's actually
3649 ;; locked by the calling user and unchanged.
3651 ;; Potential cause: the other user relinquishing a lock followed by
3652 ;; a self-race, both in window W.
3654 ;; Under both RCS and SCCS, both unlock and lock will succeed, making
3655 ;; the sequence a no-op.
3657 ;; 20. File looks like it's locked by some other user, but it's actually
3658 ;; locked by the calling user and changed.
3664 ;; In order of decreasing severity:
3666 ;; Cases 11 and 15 are the only ones that potentially lose work.
3667 ;; They would require a self-race for this to happen.
3669 ;; Case 13 in RCS loses information about previous deltas, retaining
3670 ;; only the information in the current workfile. This can only happen
3671 ;; if the master file gets nuked in window P.
3673 ;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
3674 ;; no change comment in the master. This would require a self-race in
3675 ;; window P or R respectively.
3677 ;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
3679 ;; Unfortunately, it appears to me that no recovery is possible in these
3680 ;; cases. They don't yield error messages, so there's no way to tell that
3681 ;; a race condition has occurred.
3683 ;; All other cases don't change either the workfile or the master, and
3684 ;; trigger command errors which the user will see.
3686 ;; Thus, there is no explicit recovery code.
3688 ;;; arch-tag: ca82c1de-3091-4e26-af92-460abc6213a6