1 ;;; vc.el --- drive a version-control system from within Emacs
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 ;; Author: FSF (see below for full credits)
7 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
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., 51 Franklin Street, Fifth Floor,
27 ;; Boston, MA 02110-1301, 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 CVS, RCS, GNU Arch,
50 ;; Subversion, Meta-CVS, and SCCS (or its free replacement, CSSC).
52 ;; Some features will not work with old RCS versions. Where
53 ;; appropriate, VC finds out which version you have, and allows or
54 ;; disallows those features (stealing locks, for example, works only
55 ;; from 5.6.2 onwards).
56 ;; Even initial checkins will fail if your RCS version is so old that ci
57 ;; doesn't understand -t-; this has been known to happen to people running
60 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
62 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
63 ;; to be installed somewhere on Emacs's path for executables.
65 ;; If your site uses the ChangeLog convention supported by Emacs, the
66 ;; function log-edit-comment-to-change-log could prove a useful checkin hook,
67 ;; although you might prefer to use C-c C-a (i.e. log-edit-insert-changelog)
68 ;; from the commit buffer instead or to set `log-edit-setup-invert'.
70 ;; The vc code maintains some internal state in order to reduce expensive
71 ;; version-control operations to a minimum. Some names are only computed
72 ;; once. If you perform version control operations with the backend while
73 ;; vc's back is turned, or move/rename master files while vc is running,
74 ;; vc may get seriously confused. Don't do these things!
76 ;; Developer's notes on some concurrency issues are included at the end of
79 ;; ADDING SUPPORT FOR OTHER BACKENDS
81 ;; VC can use arbitrary version control systems as a backend. To add
82 ;; support for a new backend named SYS, write a library vc-sys.el that
83 ;; contains functions of the form `vc-sys-...' (note that SYS is in lower
84 ;; case for the function and library names). VC will use that library if
85 ;; you put the symbol SYS somewhere into the list of
86 ;; `vc-handled-backends'. Then, for example, if `vc-sys-registered'
87 ;; returns non-nil for a file, all SYS-specific versions of VC commands
88 ;; will be available for that file.
90 ;; VC keeps some per-file information in the form of properties (see
91 ;; vc-file-set/getprop in vc-hooks.el). The backend-specific functions
92 ;; do not generally need to be aware of these properties. For example,
93 ;; `vc-sys-workfile-version' should compute the workfile version and
94 ;; return it; it should not look it up in the property, and it needn't
95 ;; store it there either. However, if a backend-specific function does
96 ;; store a value in a property, that value takes precedence over any
97 ;; value that the generic code might want to set (check for uses of
98 ;; the macro `with-vc-properties' in vc.el).
100 ;; In the list of functions below, each identifier needs to be prepended
101 ;; with `vc-sys-'. Some of the functions are mandatory (marked with a
102 ;; `*'), others are optional (`-').
104 ;; STATE-QUERYING FUNCTIONS
106 ;; * registered (file)
108 ;; Return non-nil if FILE is registered in this backend. Both this
109 ;; function as well as `state' should be careful to fail gracefully in the
110 ;; event that the backend executable is absent.
114 ;; Return the current version control state of FILE. For a list of
115 ;; possible values, see `vc-state'. This function should do a full and
116 ;; reliable state computation; it is usually called immediately after
117 ;; C-x v v. If you want to use a faster heuristic when visiting a
118 ;; file, put that into `state-heuristic' below.
120 ;; - state-heuristic (file)
122 ;; If provided, this function is used to estimate the version control
123 ;; state of FILE at visiting time. It should be considerably faster
124 ;; than the implementation of `state'. For a list of possible values,
125 ;; see the doc string of `vc-state'.
129 ;; If provided, this function is used to find the version control state
130 ;; of all files in DIR in a fast way. The function should not return
131 ;; anything, but rather store the files' states into the corresponding
132 ;; `vc-state' properties.
134 ;; * workfile-version (file)
136 ;; Return the current workfile version of FILE.
138 ;; - latest-on-branch-p (file)
140 ;; Return non-nil if the current workfile version of FILE is the latest
141 ;; on its branch. The default implementation always returns t, which
142 ;; means that working with non-current versions is not supported by
145 ;; * checkout-model (file)
147 ;; Indicate whether FILE needs to be "checked out" before it can be
148 ;; edited. See `vc-checkout-model' for a list of possible values.
150 ;; - workfile-unchanged-p (file)
152 ;; Return non-nil if FILE is unchanged from its current workfile
153 ;; version. This function should do a brief comparison of FILE's
154 ;; contents with those of the master version. If the backend does not
155 ;; have such a brief-comparison feature, the default implementation of
156 ;; this function can be used, which delegates to a full
157 ;; vc-BACKEND-diff. (Note that vc-BACKEND-diff must not run
158 ;; asynchronously in this case, see variable `vc-disable-async-diff'.)
160 ;; - mode-line-string (file)
162 ;; If provided, this function should return the VC-specific mode line
163 ;; string for FILE. The default implementation deals well with all
164 ;; states that `vc-state' can return.
166 ;; - dired-state-info (file)
168 ;; Translate the `vc-state' property of FILE into a string that can be
169 ;; used in a vc-dired buffer. The default implementation deals well
170 ;; with all states that `vc-state' can return.
172 ;; STATE-CHANGING FUNCTIONS
174 ;; * register (file &optional rev comment)
176 ;; Register FILE in this backend. Optionally, an initial revision REV
177 ;; and an initial description of the file, COMMENT, may be specified.
178 ;; The implementation should pass the value of vc-register-switches
179 ;; to the backend command.
181 ;; - init-version (file)
183 ;; The initial version to use when registering FILE if one is not
184 ;; specified by the user. If not provided, the variable
185 ;; vc-default-init-version is used instead.
187 ;; - responsible-p (file)
189 ;; Return non-nil if this backend considers itself "responsible" for
190 ;; FILE, which can also be a directory. This function is used to find
191 ;; out what backend to use for registration of new files and for things
192 ;; like change log generation. The default implementation always
195 ;; - could-register (file)
197 ;; Return non-nil if FILE could be registered under this backend. The
198 ;; default implementation always returns t.
200 ;; - receive-file (file rev)
202 ;; Let this backend "receive" a file that is already registered under
203 ;; another backend. The default implementation simply calls `register'
204 ;; for FILE, but it can be overridden to do something more specific,
205 ;; e.g. keep revision numbers consistent or choose editing modes for
206 ;; FILE that resemble those of the other backend.
208 ;; - unregister (file)
210 ;; Unregister FILE from this backend. This is only needed if this
211 ;; backend may be used as a "more local" backend for temporary editing.
213 ;; * checkin (file rev comment)
215 ;; Commit changes in FILE to this backend. If REV is non-nil, that
216 ;; should become the new revision number. COMMENT is used as a
217 ;; check-in comment. The implementation should pass the value of
218 ;; vc-checkin-switches to the backend command.
220 ;; * find-version (file rev buffer)
222 ;; Fetch revision REV of file FILE and put it into BUFFER.
223 ;; If REV is the empty string, fetch the head of the trunk.
224 ;; The implementation should pass the value of vc-checkout-switches
225 ;; to the backend command.
227 ;; * checkout (file &optional editable rev)
229 ;; Check out revision REV of FILE into the working area. If EDITABLE
230 ;; is non-nil, FILE should be writable by the user and if locking is
231 ;; used for FILE, a lock should also be set. If REV is non-nil, that
232 ;; is the revision to check out (default is current workfile version).
233 ;; If REV is t, that means to check out the head of the current branch;
234 ;; if it is the empty string, check out the head of the trunk.
235 ;; The implementation should pass the value of vc-checkout-switches
236 ;; to the backend command.
238 ;; * revert (file &optional contents-done)
240 ;; Revert FILE back to the current workfile version. If optional
241 ;; arg CONTENTS-DONE is non-nil, then the contents of FILE have
242 ;; already been reverted from a version backup, and this function
243 ;; only needs to update the status of FILE within the backend.
245 ;; - cancel-version (file editable)
247 ;; Cancel the current workfile version of FILE, i.e. remove it from the
248 ;; master. EDITABLE non-nil means that FILE should be writable
249 ;; afterwards, and if locking is used for FILE, then a lock should also
250 ;; be set. If this function is not provided, trying to cancel a
251 ;; version is caught as an error.
253 ;; - merge (file rev1 rev2)
255 ;; Merge the changes between REV1 and REV2 into the current working file.
257 ;; - merge-news (file)
259 ;; Merge recent changes from the current branch into FILE.
261 ;; - steal-lock (file &optional version)
263 ;; Steal any lock on the current workfile version of FILE, or on
264 ;; VERSION if that is provided. This function is only needed if
265 ;; locking is used for files under this backend, and if files can
266 ;; indeed be locked by other users.
270 ;; * print-log (file &optional buffer)
272 ;; Insert the revision log of FILE into BUFFER, or the *vc* buffer
275 ;; - log-view-mode ()
277 ;; Mode to use for the output of print-log. This defaults to
278 ;; `log-view-mode' and is expected to be changed (if at all) to a derived
279 ;; mode of `log-view-mode'.
281 ;; - show-log-entry (version)
283 ;; If provided, search the log entry for VERSION in the current buffer,
284 ;; and make sure it is displayed in the buffer's window. The default
285 ;; implementation of this function works for RCS-style logs.
289 ;; Remove all non-comment information from the output of print-log. The
290 ;; default implementation of this function works for RCS-style logs.
292 ;; - logentry-check ()
294 ;; If defined, this function is run to find out whether the user
295 ;; entered a valid log entry for check-in. The log entry is in the
296 ;; current buffer, and if it is not a valid one, the function should
299 ;; - comment-history (file)
301 ;; Return a string containing all log entries that were made for FILE.
302 ;; This is used for transferring a file from one backend to another,
303 ;; retaining comment information. The default implementation of this
304 ;; function does this by calling print-log and then wash-log, and
305 ;; returning the resulting buffer contents as a string.
307 ;; - update-changelog (files)
309 ;; Using recent log entries, create ChangeLog entries for FILES, or for
310 ;; all files at or below the default-directory if FILES is nil. The
311 ;; default implementation runs rcs2log, which handles RCS- and
314 ;; * diff (file &optional rev1 rev2 buffer)
316 ;; Insert the diff for FILE into BUFFER, or the *vc-diff* buffer if
317 ;; BUFFER is nil. If REV1 and REV2 are non-nil, report differences
318 ;; from REV1 to REV2. If REV1 is nil, use the current workfile
319 ;; version (as found in the repository) as the older version; if
320 ;; REV2 is nil, use the current workfile contents as the newer
321 ;; version. This function should pass the value of (vc-switches
322 ;; BACKEND 'diff) to the backend command. It should return a status
323 ;; of either 0 (no differences found), or 1 (either non-empty diff
324 ;; or the diff is run asynchronously).
326 ;; - diff-tree (dir &optional rev1 rev2)
328 ;; Insert the diff for all files at and below DIR into the *vc-diff*
329 ;; buffer. The meaning of REV1 and REV2 is the same as for
330 ;; vc-BACKEND-diff. The default implementation does an explicit tree
331 ;; walk, calling vc-BACKEND-diff for each individual file.
333 ;; - annotate-command (file buf &optional rev)
335 ;; If this function is provided, it should produce an annotated display
336 ;; of FILE in BUF, relative to version REV. Annotation means each line
337 ;; of FILE displayed is prefixed with version information associated with
338 ;; its addition (deleted lines leave no history) and that the text of the
339 ;; file is fontified according to age.
341 ;; - annotate-time ()
343 ;; Only required if `annotate-command' is defined for the backend.
344 ;; Return the time of the next line of annotation at or after point,
345 ;; as a floating point fractional number of days. The helper
346 ;; function `vc-annotate-convert-time' may be useful for converting
347 ;; multi-part times as returned by `current-time' and `encode-time'
348 ;; to this format. Return nil if no more lines of annotation appear
349 ;; in the buffer. You can safely assume that point is placed at the
350 ;; beginning of each line, starting at `point-min'. The buffer that
351 ;; point is placed in is the Annotate output, as defined by the
352 ;; relevant backend. This function also affects how much of the line
353 ;; is fontified; where it leaves point is where fontification begins.
355 ;; - annotate-current-time ()
357 ;; Only required if `annotate-command' is defined for the backend,
358 ;; AND you'd like the current time considered to be anything besides
359 ;; (vs-annotate-convert-time (current-time)) -- i.e. the current
360 ;; time with hours, minutes, and seconds included. Probably safe to
361 ;; ignore. Return the current-time, in units of fractional days.
363 ;; - annotate-extract-revision-at-line ()
365 ;; Only required if `annotate-command' is defined for the backend.
366 ;; Invoked from a buffer in vc-annotate-mode, return the revision
367 ;; corresponding to the current line, or nil if there is no revision
368 ;; corresponding to the current line.
372 ;; - create-snapshot (dir name branchp)
374 ;; Take a snapshot of the current state of files under DIR and name it
375 ;; NAME. This should make sure that files are up-to-date before
376 ;; proceeding with the action. DIR can also be a file and if BRANCHP
377 ;; is specified, NAME should be created as a branch and DIR should be
378 ;; checked out under this new branch. The default implementation does
379 ;; not support branches but does a sanity check, a tree traversal and
380 ;; for each file calls `assign-name'.
382 ;; - assign-name (file name)
384 ;; Give name NAME to the current version of FILE, assuming it is
385 ;; up-to-date. Only used by the default version of `create-snapshot'.
387 ;; - retrieve-snapshot (dir name update)
389 ;; Retrieve a named snapshot of all registered files at or below DIR.
390 ;; If UPDATE is non-nil, then update buffers of any files in the
391 ;; snapshot that are currently visited. The default implementation
392 ;; does a sanity check whether there aren't any uncommitted changes at
393 ;; or below DIR, and then performs a tree walk, using the `checkout'
394 ;; function to retrieve the corresponding versions.
398 ;; - make-version-backups-p (file)
400 ;; Return non-nil if unmodified repository versions of FILE should be
401 ;; backed up locally. If this is done, VC can perform `diff' and
402 ;; `revert' operations itself, without calling the backend system. The
403 ;; default implementation always returns nil.
405 ;; - repository-hostname (dirname)
407 ;; Return the hostname that the backend will have to contact
408 ;; in order to operate on a file in DIRNAME. If the return value
409 ;; is nil, it means that the repository is local.
410 ;; This function is used in `vc-stay-local-p' which backends can use
411 ;; for their convenience.
413 ;; - previous-version (file rev)
415 ;; Return the version number that precedes REV for FILE, or nil if no such
418 ;; - next-version (file rev)
420 ;; Return the version number that follows REV for FILE, or nil if no such
423 ;; - check-headers ()
425 ;; Return non-nil if the current buffer contains any version headers.
427 ;; - clear-headers ()
429 ;; In the current buffer, reset all version headers to their unexpanded
430 ;; form. This function should be provided if the state-querying code
431 ;; for this backend uses the version headers to determine the state of
432 ;; a file. This function will then be called whenever VC changes the
433 ;; version control state in such a way that the headers would give
434 ;; wrong information.
436 ;; - delete-file (file)
438 ;; Delete FILE and mark it as deleted in the repository. If this
439 ;; function is not provided, the command `vc-delete-file' will
442 ;; - rename-file (old new)
444 ;; Rename file OLD to NEW, both in the working area and in the
445 ;; repository. If this function is not provided, the renaming
446 ;; will be done by (vc-delete-file old) and (vc-register new).
448 ;; - find-file-hook ()
450 ;; Operation called in current buffer when opening a file. This can
451 ;; be used by the backend to setup some local variables it might need.
453 ;; - find-file-not-found-hook ()
455 ;; Operation called in current buffer when opening a non-existing file.
456 ;; By default, this asks the user if she wants to check out the file.
465 (require 'dired) ; for dired-map-over-marks macro
466 (require 'dired-aux)) ; for dired-kill-{line,tree}
468 (if (not (assoc 'vc-parent-buffer minor-mode-alist))
469 (setq minor-mode-alist
470 (cons '(vc-parent-buffer vc-parent-buffer-name)
473 ;; General customization
476 "Version-control system in Emacs."
479 (defcustom vc-suppress-confirm nil
480 "If non-nil, treat user as expert; suppress yes-no prompts on some things."
484 (defcustom vc-delete-logbuf-window t
485 "If non-nil, delete the *VC-log* buffer and window after each logical action.
486 If nil, bury that buffer instead.
487 This is most useful if you have multiple windows on a frame and would like to
488 preserve the setting."
492 (defcustom vc-initial-comment nil
493 "If non-nil, prompt for initial comment when a file is registered."
497 (defcustom vc-default-init-version "1.1"
498 "A string used as the default version number when a new file is registered.
499 This can be overridden by giving a prefix argument to \\[vc-register]. This
500 can also be overridden by a particular VC backend."
505 (defcustom vc-command-messages nil
506 "If non-nil, display run messages from back-end commands."
510 (defcustom vc-checkin-switches nil
511 "A string or list of strings specifying extra switches for checkin.
512 These are passed to the checkin program by \\[vc-checkin]."
513 :type '(choice (const :tag "None" nil)
514 (string :tag "Argument String")
515 (repeat :tag "Argument List"
520 (defcustom vc-checkout-switches nil
521 "A string or list of strings specifying extra switches for checkout.
522 These are passed to the checkout program by \\[vc-checkout]."
523 :type '(choice (const :tag "None" nil)
524 (string :tag "Argument String")
525 (repeat :tag "Argument List"
530 (defcustom vc-register-switches nil
531 "A string or list of strings; extra switches for registering a file.
532 These are passed to the checkin program by \\[vc-register]."
533 :type '(choice (const :tag "None" nil)
534 (string :tag "Argument String")
535 (repeat :tag "Argument List"
540 (defcustom vc-dired-listing-switches "-al"
541 "Switches passed to `ls' for vc-dired. MUST contain the `l' option."
546 (defcustom vc-dired-recurse t
547 "If non-nil, show directory trees recursively in VC Dired."
552 (defcustom vc-dired-terse-display t
553 "If non-nil, show only locked files in VC Dired."
558 (defcustom vc-directory-exclusion-list '("SCCS" "RCS" "CVS" "MCVS" ".svn" "{arch}")
559 "List of directory names to be ignored when walking directory trees."
560 :type '(repeat string)
563 (defcustom vc-diff-switches nil
564 "A string or list of strings specifying switches for diff under VC.
565 When running diff under a given BACKEND, VC concatenates the values of
566 `diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to
567 get the switches for that command. Thus, `vc-diff-switches' should
568 contain switches that are specific to version control, but not
569 specific to any particular backend."
570 :type '(choice (const :tag "None" nil)
571 (string :tag "Argument String")
572 (repeat :tag "Argument List"
578 (defcustom vc-diff-knows-L nil
579 "*Indicates whether diff understands the -L option.
580 The value is either `yes', `no', or nil. If it is nil, VC tries
581 to use -L and sets this variable to remember whether it worked."
582 :type '(choice (const :tag "Work out" nil) (const yes) (const no))
585 (defcustom vc-allow-async-revert nil
586 "Specifies whether the diff during \\[vc-revert-buffer] may be asynchronous.
587 Enabling this option means that you can confirm a revert operation even
588 if the local changes in the file have not been found and displayed yet."
589 :type '(choice (const :tag "No" nil)
590 (const :tag "Yes" t))
595 (defcustom vc-checkout-hook nil
596 "Normal hook (list of functions) run after checking out a file.
602 (defcustom vc-annotate-display-mode 'fullscale
603 "Which mode to color the output of \\[vc-annotate] with by default."
604 :type '(choice (const :tag "By Color Map Range" nil)
605 (const :tag "Scale to Oldest" scale)
606 (const :tag "Scale Oldest->Newest" fullscale)
607 (number :tag "Specify Fractional Number of Days"
612 (defcustom vc-checkin-hook nil
613 "Normal hook (list of functions) run after a checkin is done.
614 See also `log-edit-done-hook'."
616 :options '(log-edit-comment-to-change-log)
620 (defcustom vc-before-checkin-hook nil
621 "Normal hook (list of functions) run before a file is checked in.
626 (defcustom vc-logentry-check-hook nil
627 "Normal hook run by `vc-backend-logentry-check'.
628 Use this to impose your own rules on the entry in addition to any the
629 version control backend imposes itself."
633 ;; Annotate customization
634 (defcustom vc-annotate-color-map
635 (if (and (tty-display-color-p) (<= (display-color-cells) 8))
636 ;; A custom sorted TTY colormap
642 (string-equal (car x) "white")
643 (string-equal (car x) "black") ))
648 ((or (string-equal a "red") (string-equal b "blue")) t)
649 ((or (string-equal b "red") (string-equal a "blue")) nil)
650 ((string-equal a "yellow") t)
651 ((string-equal b "yellow") nil)
652 ((string-equal a "cyan") t)
653 ((string-equal b "cyan") nil)
654 ((string-equal a "green") t)
655 ((string-equal b "green") nil)
656 ((string-equal a "magenta") t)
657 ((string-equal b "magenta") nil)
658 (t (string< a b))))))
660 (delta (/ (- 360. date) (1- (length colors)))))
664 (setq date (+ date delta)))) colors))
665 ;; Normal colormap: hue stepped from 0-240deg, value=1., saturation=0.75
684 "Association list of age versus color, for \\[vc-annotate].
685 Ages are given in units of fractional days. Default is eighteen
686 steps using a twenty day increment, from red to blue. For TTY
687 displays with 8 or fewer colors, the default is red to blue with
688 all other colors between (excluding black and white)."
692 (defcustom vc-annotate-very-old-color "#3F3FFF"
693 "Color for lines older than the current color range in \\[vc-annotate]]."
697 (defcustom vc-annotate-background "black"
698 "Background color for \\[vc-annotate].
699 Default color is used if nil."
703 (defcustom vc-annotate-menu-elements '(2 0.5 0.1 0.01)
704 "Menu elements for the mode-specific menu of VC-Annotate mode.
705 List of factors, used to expand/compress the time scale. See `vc-annotate'."
706 :type '(repeat number)
709 (defvar vc-annotate-mode-map
710 (let ((m (make-sparse-keymap)))
711 (define-key m "A" 'vc-annotate-revision-previous-to-line)
712 (define-key m "D" 'vc-annotate-show-diff-revision-at-line)
713 (define-key m "J" 'vc-annotate-revision-at-line)
714 (define-key m "L" 'vc-annotate-show-log-revision-at-line)
715 (define-key m "N" 'vc-annotate-next-version)
716 (define-key m "P" 'vc-annotate-prev-version)
717 (define-key m "W" 'vc-annotate-workfile-version)
719 "Local keymap used for VC-Annotate mode.")
721 ;; Header-insertion hair
723 (defcustom vc-static-header-alist
725 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
726 "*Associate static header string templates with file types.
727 A \%s in the template is replaced with the first string associated with
728 the file's version control type in `vc-header-alist'."
729 :type '(repeat (cons :format "%v"
730 (regexp :tag "File Type")
731 (string :tag "Header String")))
734 (defcustom vc-comment-alist
735 '((nroff-mode ".\\\"" ""))
736 "*Special comment delimiters for generating VC headers.
737 Add an entry in this list if you need to override the normal `comment-start'
738 and `comment-end' variables. This will only be necessary if the mode language
739 is sensitive to blank lines."
740 :type '(repeat (list :format "%v"
742 (string :tag "Comment Start")
743 (string :tag "Comment End")))
746 (defcustom vc-checkout-carefully (= (user-uid) 0)
747 "*Non-nil means be extra-careful in checkout.
748 Verify that the file really is not locked
749 and that its contents match what the master file says."
752 (make-obsolete-variable 'vc-checkout-carefully
753 "the corresponding checks are always done now."
757 ;; Variables the user doesn't need to know about.
758 (defvar vc-log-operation nil)
759 (defvar vc-log-after-operation-hook nil)
761 ;; In a log entry buffer, this is a local variable
762 ;; that points to the buffer for which it was made
763 ;; (either a file, or a VC dired buffer).
764 (defvar vc-parent-buffer nil)
765 (put 'vc-parent-buffer 'permanent-local t)
766 (defvar vc-parent-buffer-name nil)
767 (put 'vc-parent-buffer-name 'permanent-local t)
769 (defvar vc-disable-async-diff nil
770 "VC sets this to t locally to disable some async diff operations.
771 Backends that offer asynchronous diffs should respect this variable
772 in their implementation of vc-BACKEND-diff.")
775 (defvar vc-log-version)
777 (defvar vc-dired-mode nil)
778 (make-variable-buffer-local 'vc-dired-mode)
780 ;; functions that operate on RCS revision numbers. This code should
781 ;; also be moved into the backends. It stays for now, however, since
782 ;; it is used in code below.
784 (defun vc-trunk-p (rev)
785 "Return t if REV is a revision on the trunk."
786 (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev))))
788 (defun vc-branch-p (rev)
789 "Return t if REV is a branch revision."
790 (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev))))
793 (defun vc-branch-part (rev)
794 "Return the branch part of a revision number REV."
795 (let ((index (string-match "\\.[0-9]+\\'" rev)))
797 (substring rev 0 index))))
799 (defun vc-minor-part (rev)
800 "Return the minor version number of a revision number REV."
801 (string-match "[0-9]+\\'" rev)
802 (substring rev (match-beginning 0) (match-end 0)))
804 (defun vc-default-previous-version (backend file rev)
805 "Return the version number immediately preceding REV for FILE,
806 or nil if there is no previous version. This default
807 implementation works for MAJOR.MINOR-style version numbers as
808 used by RCS and CVS."
809 (let ((branch (vc-branch-part rev))
810 (minor-num (string-to-number (vc-minor-part rev))))
813 ;; version does probably not start a branch or release
814 (concat branch "." (number-to-string (1- minor-num)))
816 ;; we are at the beginning of the trunk --
817 ;; don't know anything to return here
819 ;; we are at the beginning of a branch --
820 ;; return version of starting point
821 (vc-branch-part branch))))))
823 (defun vc-default-next-version (backend file rev)
824 "Return the version number immediately following REV for FILE,
825 or nil if there is no next version. This default implementation
826 works for MAJOR.MINOR-style version numbers as used by RCS
828 (when (not (string= rev (vc-workfile-version file)))
829 (let ((branch (vc-branch-part rev))
830 (minor-num (string-to-number (vc-minor-part rev))))
831 (concat branch "." (number-to-string (1+ minor-num))))))
833 ;; File property caching
835 (defun vc-clear-context ()
836 "Clear all cached file properties."
838 (fillarray vc-file-prop-obarray 0))
840 (defmacro with-vc-properties (file form settings)
841 "Execute FORM, then maybe set per-file properties for FILE.
842 SETTINGS is an association list of property/value pairs. After
843 executing FORM, set those properties from SETTINGS that have not yet
844 been updated to their corresponding values."
846 `(let ((vc-touched-properties (list t)))
848 (mapcar (lambda (setting)
849 (let ((property (car setting)))
850 (unless (memq property vc-touched-properties)
851 (put (intern ,file vc-file-prop-obarray)
852 property (cdr setting)))))
855 ;; Random helper functions
857 (defsubst vc-editable-p (file)
858 "Return non-nil if FILE can be edited."
859 (or (eq (vc-checkout-model file) 'implicit)
860 (memq (vc-state file) '(edited needs-merge))))
862 ;; Two macros for elisp programming
864 (defmacro with-vc-file (file comment &rest body)
865 "Check out a writable copy of FILE if necessary, then execute BODY.
866 Check in FILE with COMMENT (a string) after BODY has been executed.
867 FILE is passed through `expand-file-name'; BODY executed within
868 `save-excursion'. If FILE is not under version control, or locked by
869 somebody else, signal error."
870 (declare (debug t) (indent 2))
871 (let ((filevar (make-symbol "file")))
872 `(let ((,filevar (expand-file-name ,file)))
873 (or (vc-backend ,filevar)
874 (error "File not under version control: `%s'" file))
875 (unless (vc-editable-p ,filevar)
876 (let ((state (vc-state ,filevar)))
878 (error "`%s' is locking `%s'" state ,filevar)
879 (vc-checkout ,filevar t))))
882 (vc-checkin ,filevar nil ,comment))))
885 (defmacro edit-vc-file (file comment &rest body)
886 "Edit FILE under version control, executing body.
887 Checkin with COMMENT after executing BODY.
888 This macro uses `with-vc-file', passing args to it.
889 However, before executing BODY, find FILE, and after BODY, save buffer."
890 (declare (debug t) (indent 2))
891 (let ((filevar (make-symbol "file")))
892 `(let ((,filevar (expand-file-name ,file)))
895 (set-buffer (find-file-noselect ,filevar))
899 (defun vc-ensure-vc-buffer ()
900 "Make sure that the current buffer visits a version-controlled file."
902 (set-buffer (find-file-noselect (dired-get-filename)))
903 (while vc-parent-buffer
904 (set-buffer vc-parent-buffer))
905 (if (not buffer-file-name)
906 (error "Buffer %s is not associated with a file" (buffer-name))
907 (if (not (vc-backend buffer-file-name))
908 (error "File %s is not under version control" buffer-file-name)))))
910 (defun vc-process-filter (p s)
911 "An alternative output filter for async process P.
912 One difference with the default filter is that this inserts S after markers.
913 Another is that undo information is not kept."
914 (with-current-buffer (process-buffer p)
916 (let ((buffer-undo-list t)
917 (inhibit-read-only t))
918 (goto-char (process-mark p))
920 (set-marker (process-mark p) (point))))))
922 (defun vc-setup-buffer (&optional buf)
923 "Prepare BUF for executing a VC command and make it current.
924 BUF defaults to \"*vc*\", can be a string and will be created if necessary."
925 (unless buf (setq buf "*vc*"))
926 (let ((camefrom (current-buffer))
927 (olddir default-directory))
928 (set-buffer (get-buffer-create buf))
929 (kill-all-local-variables)
930 (set (make-local-variable 'vc-parent-buffer) camefrom)
931 (set (make-local-variable 'vc-parent-buffer-name)
932 (concat " from " (buffer-name camefrom)))
933 (setq default-directory olddir)
934 (let ((buffer-undo-list t)
935 (inhibit-read-only t))
938 (defun vc-exec-after (code)
939 "Eval CODE when the current buffer's process is done.
940 If the current buffer has no process, just evaluate CODE.
941 Else, add CODE to the process' sentinel."
942 (let ((proc (get-buffer-process (current-buffer))))
944 ;; If there's no background process, just execute the code.
945 ;; We used to explicitly call delete-process on exited processes,
946 ;; but this led to timing problems causing process output to be
947 ;; lost. Terminated processes get deleted automatically
949 ((or (null proc) (eq (process-status proc) 'exit))
951 ;; If a process is running, add CODE to the sentinel
952 ((eq (process-status proc) 'run)
953 (let ((sentinel (process-sentinel proc)))
954 (set-process-sentinel proc
956 (with-current-buffer ',(current-buffer)
957 (goto-char (process-mark p))
958 ,@(append (cdr (cdr (cdr ;strip off `with-current-buffer buf
960 (car (cdr (cdr ;strip off `lambda (p s)'
962 (list `(vc-exec-after ',code))))))))
963 (t (error "Unexpected process state"))))
966 (defvar vc-post-command-functions nil
967 "Hook run at the end of `vc-do-command'.
968 Each function is called inside the buffer in which the command was run
969 and is passed 3 arguments: the COMMAND, the FILE and the FLAGS.")
971 (defvar w32-quote-process-args)
973 (defun vc-do-command (buffer okstatus command file &rest flags)
974 "Execute a VC command, notifying user and checking for errors.
975 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil or the
976 current buffer if BUFFER is t. If the destination buffer is not
977 already current, set it up properly and erase it. The command is
978 considered successful if its exit status does not exceed OKSTATUS (if
979 OKSTATUS is nil, that means to ignore error status, if it is `async', that
980 means not to wait for termination of the subprocess; if it is t it means to
981 ignore all execution errors). FILE is the
982 name of the working file (may also be nil, to execute commands that
983 don't expect a file name). If an optional list of FLAGS is present,
984 that is inserted into the command line before the filename."
985 (and file (setq file (expand-file-name file)))
986 (if vc-command-messages
987 (message "Running %s on %s..." command file))
989 (unless (or (eq buffer t)
990 (and (stringp buffer)
991 (string= (buffer-name) buffer))
992 (eq buffer (current-buffer)))
993 (vc-setup-buffer buffer))
994 (let ((squeezed (remq nil flags))
995 (inhibit-read-only t)
998 ;; FIXME: file-relative-name can return a bogus result because
999 ;; it doesn't look at the actual file-system to see if symlinks
1001 (setq squeezed (append squeezed (list (file-relative-name file)))))
1002 (let ((exec-path (append vc-path exec-path))
1003 ;; Add vc-path to PATH for the execution of this command.
1004 (process-environment
1005 (cons (concat "PATH=" (getenv "PATH")
1007 (mapconcat 'identity vc-path path-separator))
1008 process-environment))
1009 (w32-quote-process-args t))
1010 (if (and (eq okstatus 'async) (file-remote-p default-directory))
1011 ;; start-process does not support remote execution
1012 (setq okstatus nil))
1013 (if (eq okstatus 'async)
1015 (let ((process-connection-type nil))
1016 (apply 'start-process command (current-buffer) command
1018 (unless (active-minibuffer-window)
1019 (message "Running %s in the background..." command))
1020 ;;(set-process-sentinel proc (lambda (p msg) (delete-process p)))
1021 (set-process-filter proc 'vc-process-filter)
1023 `(unless (active-minibuffer-window)
1024 (message "Running %s in the background... done" ',command))))
1025 (let ((buffer-undo-list t))
1026 (setq status (apply 'process-file command nil t nil squeezed)))
1027 (when (and (not (eq t okstatus))
1028 (or (not (integerp status))
1029 (and okstatus (< okstatus status))))
1030 (pop-to-buffer (current-buffer))
1031 (goto-char (point-min))
1032 (shrink-window-if-larger-than-buffer)
1033 (error "Running %s...FAILED (%s)" command
1034 (if (integerp status) (format "status %d" status) status))))
1035 (if vc-command-messages
1036 (message "Running %s...OK" command)))
1038 `(run-hook-with-args 'vc-post-command-functions ',command ',file ',flags))
1041 (defun vc-position-context (posn)
1042 "Save a bit of the text around POSN in the current buffer.
1043 Used to help us find the corresponding position again later
1044 if markers are destroyed or corrupted."
1045 ;; A lot of this was shamelessly lifted from Sebastian Kremer's
1049 (buffer-substring posn
1050 (min (point-max) (+ posn 100)))))
1052 (defun vc-find-position-by-context (context)
1053 "Return the position of CONTEXT in the current buffer.
1054 If CONTEXT cannot be found, return nil."
1055 (let ((context-string (nth 2 context)))
1056 (if (equal "" context-string)
1059 (let ((diff (- (nth 1 context) (buffer-size))))
1060 (if (< diff 0) (setq diff (- diff)))
1061 (goto-char (nth 0 context))
1062 (if (or (search-forward context-string nil t)
1063 ;; Can't use search-backward since the match may continue
1065 (progn (goto-char (- (point) diff (length context-string)))
1066 ;; goto-char doesn't signal an error at
1067 ;; beginning of buffer like backward-char would
1068 (search-forward context-string nil t)))
1069 ;; to beginning of OSTRING
1070 (- (point) (length context-string))))))))
1072 (defun vc-context-matches-p (posn context)
1073 "Return t if POSN matches CONTEXT, nil otherwise."
1074 (let* ((context-string (nth 2 context))
1075 (len (length context-string))
1077 (if (> end (1+ (buffer-size)))
1079 (string= context-string (buffer-substring posn end)))))
1081 (defun vc-buffer-context ()
1082 "Return a list (POINT-CONTEXT MARK-CONTEXT REPARSE).
1083 Used by `vc-restore-buffer-context' to later restore the context."
1084 (let ((point-context (vc-position-context (point)))
1085 ;; Use mark-marker to avoid confusion in transient-mark-mode.
1086 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
1087 (vc-position-context (mark-marker))))
1088 ;; Make the right thing happen in transient-mark-mode.
1090 ;; The new compilation code does not use compilation-error-list any
1091 ;; more, so the code below is now ineffective and might as well
1092 ;; be disabled. -- Stef
1093 ;; ;; We may want to reparse the compilation buffer after revert
1094 ;; (reparse (and (boundp 'compilation-error-list) ;compile loaded
1095 ;; ;; Construct a list; each elt is nil or a buffer
1096 ;; ;; iff that buffer is a compilation output buffer
1097 ;; ;; that contains markers into the current buffer.
1098 ;; (save-current-buffer
1099 ;; (mapcar (lambda (buffer)
1100 ;; (set-buffer buffer)
1101 ;; (let ((errors (or
1102 ;; compilation-old-error-list
1103 ;; compilation-error-list))
1104 ;; (buffer-error-marked-p nil))
1105 ;; (while (and (consp errors)
1106 ;; (not buffer-error-marked-p))
1107 ;; (and (markerp (cdr (car errors)))
1110 ;; (cdr (car errors))))
1111 ;; (setq buffer-error-marked-p t))
1112 ;; (setq errors (cdr errors)))
1113 ;; (if buffer-error-marked-p buffer)))
1114 ;; (buffer-list)))))
1116 (list point-context mark-context reparse)))
1118 (defun vc-restore-buffer-context (context)
1119 "Restore point/mark, and reparse any affected compilation buffers.
1120 CONTEXT is that which `vc-buffer-context' returns."
1121 (let ((point-context (nth 0 context))
1122 (mark-context (nth 1 context))
1123 (reparse (nth 2 context)))
1124 ;; The new compilation code does not use compilation-error-list any
1125 ;; more, so the code below is now ineffective and might as well
1126 ;; be disabled. -- Stef
1127 ;; ;; Reparse affected compilation buffers.
1129 ;; (if (car reparse)
1130 ;; (with-current-buffer (car reparse)
1131 ;; (let ((compilation-last-buffer (current-buffer)) ;select buffer
1132 ;; ;; Record the position in the compilation buffer of
1133 ;; ;; the last error next-error went to.
1134 ;; (error-pos (marker-position
1135 ;; (car (car-safe compilation-error-list)))))
1136 ;; ;; Reparse the error messages as far as they were parsed before.
1137 ;; (compile-reinitialize-errors '(4) compilation-parsing-end)
1138 ;; ;; Move the pointer up to find the error we were at before
1139 ;; ;; reparsing. Now next-error should properly go to the next one.
1140 ;; (while (and compilation-error-list
1141 ;; (/= error-pos (car (car compilation-error-list))))
1142 ;; (setq compilation-error-list (cdr compilation-error-list))))))
1143 ;; (setq reparse (cdr reparse)))
1145 ;; if necessary, restore point and mark
1146 (if (not (vc-context-matches-p (point) point-context))
1147 (let ((new-point (vc-find-position-by-context point-context)))
1148 (if new-point (goto-char new-point))))
1151 (not (vc-context-matches-p (mark) mark-context))
1152 (let ((new-mark (vc-find-position-by-context mark-context)))
1153 (if new-mark (set-mark new-mark))))))
1155 (defun vc-revert-buffer1 (&optional arg no-confirm)
1156 "Revert buffer, keeping point and mark where user expects them.
1157 Try to be clever in the face of changes due to expanded version control
1158 key words. This is important for typeahead to work as expected.
1159 ARG and NO-CONFIRM are passed on to `revert-buffer'."
1162 (let ((context (vc-buffer-context)))
1163 ;; Use save-excursion here, because it may be able to restore point
1164 ;; and mark properly even in cases where vc-restore-buffer-context
1165 ;; would fail. However, save-excursion might also get it wrong --
1166 ;; in this case, vc-restore-buffer-context gives it a second try.
1168 ;; t means don't call normal-mode;
1169 ;; that's to preserve various minor modes.
1170 (revert-buffer arg no-confirm t))
1171 (vc-restore-buffer-context context)))
1174 (defun vc-buffer-sync (&optional not-urgent)
1175 "Make sure the current buffer and its working file are in sync.
1176 NOT-URGENT means it is ok to continue if the user says not to save."
1177 (if (buffer-modified-p)
1178 (if (or vc-suppress-confirm
1179 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
1182 (error "Aborted")))))
1184 (defun vc-default-latest-on-branch-p (backend file)
1185 "Return non-nil if FILE is the latest on its branch.
1186 This default implementation always returns non-nil, which means that
1187 editing non-current versions is not supported by default."
1190 (defun vc-next-action-on-file (file verbose &optional comment)
1191 "Do The Right Thing for a given FILE under version control.
1192 If COMMENT is specified, it will be used as an admin or checkin comment.
1193 If VERBOSE is non-nil, query the user rather than using default parameters."
1194 (let ((visited (get-file-buffer file))
1198 (switch-to-buffer-other-window visited)
1199 (set-buffer visited))
1200 ;; Check relation of buffer and file, and make sure
1201 ;; user knows what he's doing. First, finding the file
1202 ;; will check whether the file on disk is newer.
1203 ;; Ignore buffer-read-only during this test, and
1204 ;; preserve find-file-literally.
1205 (let ((buffer-read-only (not (file-writable-p file))))
1206 (find-file-noselect file nil find-file-literally))
1207 (if (not (verify-visited-file-modtime (current-buffer)))
1208 (if (yes-or-no-p "Replace file on disk with buffer contents? ")
1209 (write-file buffer-file-name)
1211 ;; Now, check if we have unsaved changes.
1213 (if (buffer-modified-p)
1214 (or (y-or-n-p "Operate on disk file, keeping modified buffer? ")
1215 (error "Aborted")))))
1217 ;; Do the right thing
1218 (if (not (vc-registered file))
1219 (vc-register verbose comment)
1220 (vc-recompute-state file)
1221 (if visited (vc-mode-line file))
1222 (setq state (vc-state file))
1225 ((or (eq state 'up-to-date)
1226 (and verbose (eq state 'needs-patch)))
1229 ;; go to a different version
1231 (read-string "Branch, version, or backend to move to: "))
1232 (let ((vsym (intern-soft (upcase version))))
1233 (if (member vsym vc-handled-backends)
1234 (vc-transfer-file file vsym)
1235 (vc-checkout file (eq (vc-checkout-model file) 'implicit)
1237 ((not (eq (vc-checkout-model file) 'implicit))
1238 ;; check the file out
1239 (vc-checkout file t))
1242 (message "%s is up-to-date" file))))
1244 ;; Abnormal: edited but read-only
1245 ((and visited (eq state 'edited)
1246 buffer-read-only (not (file-writable-p file)))
1247 ;; Make the file+buffer read-write. If the user really wanted to
1248 ;; commit, he'll get a chance to do that next time around, anyway.
1249 (message "File is edited but read-only; making it writable")
1250 (set-file-modes buffer-file-name
1251 (logior (file-modes buffer-file-name) 128))
1252 (toggle-read-only -1))
1257 ;; For files with locking, if the file does not contain
1258 ;; any changes, just let go of the lock, i.e. revert.
1259 ((and (not (eq (vc-checkout-model file) 'implicit))
1260 (vc-workfile-unchanged-p file)
1261 ;; If buffer is modified, that means the user just
1262 ;; said no to saving it; in that case, don't revert,
1263 ;; because the user might intend to save after
1264 ;; finishing the log entry.
1265 (not (and visited (buffer-modified-p))))
1266 ;; DO NOT revert the file without asking the user!
1267 (if (not visited) (find-file-other-window file))
1268 (if (yes-or-no-p "Revert to master version? ")
1269 (vc-revert-buffer)))
1272 (vc-checkin file nil comment)
1273 (setq version (read-string "New version or backend: "))
1274 (let ((vsym (intern (upcase version))))
1275 (if (member vsym vc-handled-backends)
1276 (vc-transfer-file file vsym)
1277 (vc-checkin file version comment)))))))
1279 ;; locked by somebody else
1282 (error "Sorry, you can't steal the lock on %s this way"
1283 (file-name-nondirectory file)))
1285 (if verbose (read-string "Version to steal: ")
1286 (vc-workfile-version file))
1290 ((eq state 'needs-patch)
1291 (if (yes-or-no-p (format
1292 "%s is not up-to-date. Get latest version? "
1293 (file-name-nondirectory file)))
1294 (vc-checkout file (eq (vc-checkout-model file) 'implicit) t)
1295 (if (and (not (eq (vc-checkout-model file) 'implicit))
1296 (yes-or-no-p "Lock this version? "))
1297 (vc-checkout file t)
1298 (error "Aborted"))))
1301 ((eq state 'needs-merge)
1302 (if (yes-or-no-p (format
1303 "%s is not up-to-date. Merge in changes now? "
1304 (file-name-nondirectory file)))
1305 (vc-maybe-resolve-conflicts file (vc-call merge-news file))
1309 ((eq state 'unlocked-changes)
1310 (if (not visited) (find-file-other-window file))
1311 (if (save-window-excursion
1312 (vc-version-diff file (vc-workfile-version file) nil)
1313 (goto-char (point-min))
1314 (let ((inhibit-read-only t))
1316 (format "Changes to %s since last lock:\n\n" file)))
1318 (yes-or-no-p (concat "File has unlocked changes. "
1319 "Claim lock retaining changes? ")))
1320 (progn (vc-call steal-lock file)
1321 (clear-visited-file-modtime)
1322 ;; Must clear any headers here because they wouldn't
1323 ;; show that the file is locked now.
1324 (vc-clear-headers file)
1325 (write-file buffer-file-name)
1326 (vc-mode-line file))
1327 (if (not (yes-or-no-p
1328 "Revert to checked-in version, instead? "))
1329 (error "Checkout aborted")
1330 (vc-revert-buffer1 t t)
1331 (vc-checkout file t))))))))
1333 (defvar vc-dired-window-configuration)
1335 (defun vc-next-action-dired (file rev comment)
1336 "Call `vc-next-action-on-file' on all the marked files.
1337 Ignores FILE and REV, but passes on COMMENT."
1338 (let ((dired-buffer (current-buffer)))
1339 (dired-map-over-marks
1340 (let ((file (dired-get-filename)))
1341 (message "Processing %s..." file)
1342 (vc-next-action-on-file file nil comment)
1343 (set-buffer dired-buffer)
1344 (set-window-configuration vc-dired-window-configuration)
1345 (message "Processing %s...done" file))
1347 (dired-move-to-filename))
1349 ;; Here's the major entry point.
1352 (defun vc-next-action (verbose)
1353 "Do the next logical version control operation on the current file.
1355 If you call this from within a VC dired buffer with no files marked,
1356 it will operate on the file in the current line.
1358 If you call this from within a VC dired buffer, and one or more
1359 files are marked, it will accept a log message and then operate on
1360 each one. The log message will be used as a comment for any register
1361 or checkin operations, but ignored when doing checkouts. Attempted
1362 lock steals will raise an error.
1364 A prefix argument lets you specify the version number to use.
1366 For RCS and SCCS files:
1367 If the file is not already registered, this registers it for version
1369 If the file is registered and not locked by anyone, this checks out
1370 a writable and locked file ready for editing.
1371 If the file is checked out and locked by the calling user, this
1372 first checks to see if the file has changed since checkout. If not,
1373 it performs a revert.
1374 If the file has been changed, this pops up a buffer for entry
1375 of a log message; when the message has been entered, it checks in the
1376 resulting changes along with the log message as change commentary. If
1377 the variable `vc-keep-workfiles' is non-nil (which is its default), a
1378 read-only copy of the changed file is left in place afterwards.
1379 If the file is registered and locked by someone else, you are given
1380 the option to steal the lock.
1383 If the file is not already registered, this registers it for version
1384 control. This does a \"cvs add\", but no \"cvs commit\".
1385 If the file is added but not committed, it is committed.
1386 If your working file is changed, but the repository file is
1387 unchanged, this pops up a buffer for entry of a log message; when the
1388 message has been entered, it checks in the resulting changes along
1389 with the logmessage as change commentary. A writable file is retained.
1390 If the repository file is changed, you are asked if you want to
1391 merge in the changes into your working copy."
1396 (let ((files (dired-get-marked-files)))
1397 (set (make-local-variable 'vc-dired-window-configuration)
1398 (current-window-configuration))
1402 (if (not (vc-up-to-date-p f)) "@" ""))
1404 (vc-next-action-dired nil nil "dummy")
1405 (vc-start-entry nil nil nil nil
1406 "Enter a change comment for the marked files."
1407 'vc-next-action-dired))
1409 (while vc-parent-buffer
1410 (pop-to-buffer vc-parent-buffer))
1411 (if buffer-file-name
1412 (vc-next-action-on-file buffer-file-name verbose)
1413 (error "Buffer %s is not associated with a file" (buffer-name)))))
1415 ;; These functions help the vc-next-action entry point
1417 (defun vc-default-init-version (backend) vc-default-init-version)
1420 (defun vc-register (&optional set-version comment)
1421 "Register the current file into a version control system.
1422 With prefix argument SET-VERSION, allow user to specify initial version
1423 level. If COMMENT is present, use that as an initial comment.
1425 The version control system to use is found by cycling through the list
1426 `vc-handled-backends'. The first backend in that list which declares
1427 itself responsible for the file (usually because other files in that
1428 directory are already registered under that backend) will be used to
1429 register the file. If no backend declares itself responsible, the
1430 first backend that could register the file is used."
1432 (unless buffer-file-name (error "No visited file"))
1433 (when (vc-backend buffer-file-name)
1434 (if (vc-registered buffer-file-name)
1435 (error "This file is already registered")
1436 (unless (y-or-n-p "Previous master file has vanished. Make a new one? ")
1437 (error "Aborted"))))
1438 ;; Watch out for new buffers of size 0: the corresponding file
1439 ;; does not exist yet, even though buffer-modified-p is nil.
1440 (if (and (not (buffer-modified-p))
1441 (zerop (buffer-size))
1442 (not (file-exists-p buffer-file-name)))
1443 (set-buffer-modified-p t))
1446 (vc-start-entry buffer-file-name
1448 (read-string (format "Initial version level for %s: "
1450 (vc-call-backend (vc-responsible-backend buffer-file-name)
1452 (or comment (not vc-initial-comment))
1454 "Enter initial comment."
1455 (lambda (file rev comment)
1456 (message "Registering %s... " file)
1457 (let ((backend (vc-responsible-backend file t)))
1458 (vc-file-clearprops file)
1459 (vc-call-backend backend 'register file rev comment)
1460 (vc-file-setprop file 'vc-backend backend)
1461 (unless vc-make-backup-files
1462 (make-local-variable 'backup-inhibited)
1463 (setq backup-inhibited t)))
1464 (message "Registering %s... done" file))))
1467 (defun vc-responsible-backend (file &optional register)
1468 "Return the name of a backend system that is responsible for FILE.
1469 The optional argument REGISTER means that a backend suitable for
1470 registration should be found.
1472 If REGISTER is nil, then if FILE is already registered, return the
1473 backend of FILE. If FILE is not registered, or a directory, then the
1474 first backend in `vc-handled-backends' that declares itself
1475 responsible for FILE is returned. If no backend declares itself
1476 responsible, return the first backend.
1478 If REGISTER is non-nil, return the first responsible backend under
1479 which FILE is not yet registered. If there is no such backend, return
1480 the first backend under which FILE is not yet registered, but could
1482 (if (not vc-handled-backends)
1483 (error "No handled backends"))
1484 (or (and (not (file-directory-p file)) (not register) (vc-backend file))
1486 ;; First try: find a responsible backend. If this is for registration,
1487 ;; it must be a backend under which FILE is not yet registered.
1488 (dolist (backend vc-handled-backends)
1489 (and (or (not register)
1490 (not (vc-call-backend backend 'registered file)))
1491 (vc-call-backend backend 'responsible-p file)
1492 (throw 'found backend)))
1493 ;; no responsible backend
1495 ;; if this is not for registration, the first backend must do
1496 (car vc-handled-backends)
1497 ;; for registration, we need to find a new backend that
1498 ;; could register FILE
1499 (dolist (backend vc-handled-backends)
1500 (and (not (vc-call-backend backend 'registered file))
1501 (vc-call-backend backend 'could-register file)
1502 (throw 'found backend)))
1503 (error "No backend that could register")))))
1505 (defun vc-default-responsible-p (backend file)
1506 "Indicate whether BACKEND is reponsible for FILE.
1507 The default is to return nil always."
1510 (defun vc-default-could-register (backend file)
1511 "Return non-nil if BACKEND could be used to register FILE.
1512 The default implementation returns t for all files."
1515 (defun vc-resynch-window (file &optional keep noquery)
1516 "If FILE is in the current buffer, either revert or unvisit it.
1517 The choice between revert (to see expanded keywords) and unvisit depends on
1518 `vc-keep-workfiles'. NOQUERY if non-nil inhibits confirmation for
1519 reverting. NOQUERY should be t *only* if it is known the only
1520 difference between the buffer and the file is due to version control
1521 rather than user editing!"
1522 (and (string= buffer-file-name file)
1525 (vc-revert-buffer1 t noquery)
1526 ;; TODO: Adjusting view mode might no longer be necessary
1527 ;; after RMS change to files.el of 1999-08-08. Investigate
1528 ;; this when we install the new VC.
1530 (if (file-writable-p file)
1532 (let ((view-old-buffer-read-only nil))
1534 (and (not view-mode)
1535 (not (eq (get major-mode 'mode-class) 'special))
1536 (view-mode-enter))))
1537 (vc-mode-line buffer-file-name))
1538 (kill-buffer (current-buffer)))))
1540 (defun vc-resynch-buffer (file &optional keep noquery)
1541 "If FILE is currently visited, resynch its buffer."
1542 (if (string= buffer-file-name file)
1543 (vc-resynch-window file keep noquery)
1544 (let ((buffer (get-file-buffer file)))
1546 (with-current-buffer buffer
1547 (vc-resynch-window file keep noquery)))))
1548 (vc-dired-resynch-file file))
1550 (defun vc-start-entry (file rev comment initial-contents msg action &optional after-hook)
1551 "Accept a comment for an operation on FILE revision REV.
1552 If COMMENT is nil, pop up a VC-log buffer, emit MSG, and set the
1553 action on close to ACTION. If COMMENT is a string and
1554 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial
1555 contents of the log entry buffer. If COMMENT is a string and
1556 INITIAL-CONTENTS is nil, do action immediately as if the user had
1557 entered COMMENT. If COMMENT is t, also do action immediately with an
1558 empty comment. Remember the file's buffer in `vc-parent-buffer'
1559 \(current one if no file). AFTER-HOOK specifies the local value
1560 for vc-log-operation-hook."
1561 (let ((parent (or (and file (get-file-buffer file)) (current-buffer))))
1562 (if vc-before-checkin-hook
1564 (with-current-buffer parent
1565 (run-hooks 'vc-before-checkin-hook))
1566 (run-hooks 'vc-before-checkin-hook)))
1567 (if (and comment (not initial-contents))
1568 (set-buffer (get-buffer-create "*VC-log*"))
1569 (pop-to-buffer (get-buffer-create "*VC-log*")))
1570 (set (make-local-variable 'vc-parent-buffer) parent)
1571 (set (make-local-variable 'vc-parent-buffer-name)
1572 (concat " from " (buffer-name vc-parent-buffer)))
1573 (if file (vc-mode-line file))
1575 (make-local-variable 'vc-log-after-operation-hook)
1577 (setq vc-log-after-operation-hook after-hook))
1578 (setq vc-log-operation action)
1579 (setq vc-log-version rev)
1582 (when (stringp comment) (insert comment)))
1583 (if (or (not comment) initial-contents)
1584 (message "%s Type C-c C-c when done" msg)
1585 (vc-finish-logentry (eq comment t)))))
1587 (defun vc-checkout (file &optional writable rev)
1588 "Retrieve a copy of the revision REV of FILE.
1589 If WRITABLE is non-nil, make sure the retrieved file is writable.
1590 REV defaults to the latest revision.
1592 After check-out, runs the normal hook `vc-checkout-hook'."
1595 (vc-call make-version-backups-p file)
1596 (vc-up-to-date-p file)
1597 (vc-make-version-backup file))
1601 (vc-call checkout file writable rev)
1603 ;; Maybe the backend is not installed ;-(
1605 (let ((buf (get-file-buffer file)))
1606 (when buf (with-current-buffer buf (toggle-read-only -1)))))
1607 (signal (car err) (cdr err))))
1608 `((vc-state . ,(if (or (eq (vc-checkout-model file) 'implicit)
1610 (if (vc-call latest-on-branch-p file)
1614 (vc-checkout-time . ,(nth 5 (file-attributes file)))))
1615 (vc-resynch-buffer file t t)
1616 (run-hooks 'vc-checkout-hook))
1618 (defun vc-steal-lock (file rev owner)
1619 "Steal the lock on FILE."
1620 (let (file-description)
1622 (setq file-description (format "%s:%s" file rev))
1623 (setq file-description file))
1624 (if (not (yes-or-no-p (format "Steal the lock on %s from %s? "
1625 file-description owner)))
1626 (error "Steal canceled"))
1627 (message "Stealing lock on %s..." file)
1630 (vc-call steal-lock file rev)
1631 `((vc-state . edited)))
1632 (vc-resynch-buffer file t t)
1633 (message "Stealing lock on %s...done" file)
1634 ;; Write mail after actually stealing, because if the stealing
1635 ;; goes wrong, we don't want to send any mail.
1636 (compose-mail owner (format "Stolen lock on %s" file-description))
1637 (setq default-directory (expand-file-name "~/"))
1638 (goto-char (point-max))
1640 (format "I stole the lock on %s, " file-description)
1641 (current-time-string)
1643 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
1645 (defun vc-checkin (file &optional rev comment initial-contents)
1647 The optional argument REV may be a string specifying the new version
1648 level (if nil increment the current level). COMMENT is a comment
1649 string; if omitted, a buffer is popped up to accept a comment. If
1650 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents
1651 of the log entry buffer.
1653 If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided
1654 that the version control system supports this mode of operation.
1656 Runs the normal hook `vc-checkin-hook'."
1658 file rev comment initial-contents
1659 "Enter a change comment."
1660 (lambda (file rev comment)
1661 (message "Checking in %s..." file)
1662 ;; "This log message intentionally left almost blank".
1663 ;; RCS 5.7 gripes about white-space-only comments too.
1664 (or (and comment (string-match "[^\t\n ]" comment))
1665 (setq comment "*** empty log message ***"))
1668 ;; Change buffers to get local value of vc-checkin-switches.
1669 (with-current-buffer (or (get-file-buffer file) (current-buffer))
1671 (vc-call checkin file rev comment)
1672 (vc-delete-automatic-version-backups file)))
1673 `((vc-state . up-to-date)
1674 (vc-checkout-time . ,(nth 5 (file-attributes file)))
1675 (vc-workfile-version . nil)))
1676 (message "Checking in %s...done" file))
1679 (defun vc-finish-logentry (&optional nocomment)
1680 "Complete the operation implied by the current log entry.
1681 Use the contents of the current buffer as a check-in or registration
1682 comment. If the optional arg NOCOMMENT is non-nil, then don't check
1683 the buffer contents as a comment."
1685 ;; Check and record the comment, if any.
1687 ;; Comment too long?
1688 (vc-call-backend (or (and vc-log-file (vc-backend vc-log-file))
1689 (vc-responsible-backend default-directory))
1691 (run-hooks 'vc-logentry-check-hook))
1692 ;; Sync parent buffer in case the user modified it while editing the comment.
1693 ;; But not if it is a vc-dired buffer.
1694 (with-current-buffer vc-parent-buffer
1695 (or vc-dired-mode (vc-buffer-sync)))
1696 (if (not vc-log-operation) (error "No log operation is pending"))
1697 ;; save the parameters held in buffer-local variables
1698 (let ((log-operation vc-log-operation)
1699 (log-file vc-log-file)
1700 (log-version vc-log-version)
1701 (log-entry (buffer-string))
1702 (after-hook vc-log-after-operation-hook)
1703 (tmp-vc-parent-buffer vc-parent-buffer))
1704 (pop-to-buffer vc-parent-buffer)
1707 (funcall log-operation
1711 ;; Remove checkin window (after the checkin so that if that fails
1712 ;; we don't zap the *VC-log* buffer and the typing therein).
1713 (let ((logbuf (get-buffer "*VC-log*")))
1714 (cond ((and logbuf vc-delete-logbuf-window)
1715 (delete-windows-on logbuf (selected-frame))
1716 ;; Kill buffer and delete any other dedicated windows/frames.
1717 (kill-buffer logbuf))
1718 (logbuf (pop-to-buffer "*VC-log*")
1720 (pop-to-buffer tmp-vc-parent-buffer))))
1721 ;; Now make sure we see the expanded headers
1723 (vc-resynch-buffer log-file vc-keep-workfiles t))
1725 (dired-move-to-filename))
1726 (run-hooks after-hook 'vc-finish-logentry-hook)))
1728 ;; Code for access to the comment ring
1730 ;; Additional entry points for examining version histories
1733 (defun vc-diff (historic &optional not-urgent)
1734 "Display diffs between file versions.
1735 Normally this compares the current file and buffer with the most
1736 recent checked in version of that file. This uses no arguments. With
1737 a prefix argument HISTORIC, it reads the file name to use and two
1738 version designators specifying which versions to compare. The
1739 optional argument NOT-URGENT non-nil means it is ok to say no to
1741 (interactive (list current-prefix-arg t))
1743 (call-interactively 'vc-version-diff)
1744 (vc-ensure-vc-buffer)
1745 (let ((file buffer-file-name))
1746 (vc-buffer-sync not-urgent)
1747 (if (vc-workfile-unchanged-p buffer-file-name)
1748 (message "No changes to %s since latest version" file)
1749 (vc-version-diff file nil nil)))))
1751 (defun vc-version-diff (file rev1 rev2)
1752 "List the differences between FILE's versions REV1 and REV2.
1753 If REV1 is empty or nil it means to use the current workfile version;
1754 REV2 empty or nil means the current file contents. FILE may also be
1755 a directory, in that case, generate diffs between the correponding
1756 versions of all registered files in or below it."
1758 (let ((file (expand-file-name
1759 (read-file-name (if buffer-file-name
1760 "File or dir to diff (default visited file): "
1761 "File or dir to diff: ")
1762 default-directory buffer-file-name t)))
1763 (rev1-default nil) (rev2-default nil))
1764 ;; compute default versions based on the file state
1766 ;; if it's a directory, don't supply any version default
1767 ((file-directory-p file)
1769 ;; if the file is not up-to-date, use current version as older version
1770 ((not (vc-up-to-date-p file))
1771 (setq rev1-default (vc-workfile-version file)))
1772 ;; if the file is not locked, use last and previous version as default
1774 (setq rev1-default (vc-call previous-version file
1775 (vc-workfile-version file)))
1776 (if (string= rev1-default "") (setq rev1-default nil))
1777 (setq rev2-default (vc-workfile-version file))))
1778 ;; construct argument list
1780 (read-string (if rev1-default
1781 (concat "Older version (default "
1784 nil nil rev1-default)
1785 (read-string (if rev2-default
1786 (concat "Newer version (default "
1788 "Newer version (default current source): ")
1789 nil nil rev2-default))))
1790 (if (file-directory-p file)
1791 ;; recursive directory diff
1793 (vc-setup-buffer "*vc-diff*")
1794 (if (string-equal rev1 "") (setq rev1 nil))
1795 (if (string-equal rev2 "") (setq rev2 nil))
1796 (let ((inhibit-read-only t))
1797 (insert "Diffs between "
1798 (or rev1 "last version checked in")
1800 (or rev2 "current workfile(s)")
1802 (let ((dir (file-name-as-directory file)))
1803 (vc-call-backend (vc-responsible-backend dir)
1804 'diff-tree dir rev1 rev2))
1805 (vc-exec-after `(let ((inhibit-read-only t))
1806 (insert "\nEnd of diffs.\n"))))
1807 ;; Single file diff. It is important that the vc-controlled buffer
1808 ;; is still current at this time, because any local settings in that
1809 ;; buffer should affect the diff command.
1810 (vc-diff-internal file rev1 rev2))
1811 (set-buffer "*vc-diff*")
1812 (if (and (zerop (buffer-size))
1813 (not (get-buffer-process (current-buffer))))
1817 (message "No changes to %s between %s and %s" file rev1 rev2)
1818 (message "No changes to %s since %s" file rev1))
1819 (message "No changes to %s since latest version" file))
1821 (pop-to-buffer (current-buffer))
1822 ;; Gnus-5.8.5 sets up an autoload for diff-mode, even if it's
1823 ;; not available. Work around that.
1824 (if (require 'diff-mode nil t) (diff-mode))
1825 (vc-exec-after '(let ((inhibit-read-only t))
1826 (if (eq (buffer-size) 0)
1827 (insert "No differences found.\n"))
1828 (goto-char (point-min))
1829 (shrink-window-if-larger-than-buffer)))
1832 (defun vc-diff-label (file file-rev rev)
1833 (concat (file-relative-name file)
1834 (format-time-string "\t%d %b %Y %T %z\t"
1835 (nth 5 (file-attributes file-rev)))
1838 (defun vc-diff-internal (file rev1 rev2)
1839 "Run diff to compare FILE's revisions REV1 and REV2.
1840 Diff output goes to the *vc-diff* buffer. The exit status of the diff
1841 command is returned.
1843 This function takes care to set up a proper coding system for diff output.
1844 If both revisions are available as local files, then it also does not
1845 actually call the backend, but performs a local diff."
1846 (if (or (not rev1) (string-equal rev1 ""))
1847 (setq rev1 (vc-workfile-version file)))
1848 (if (string-equal rev2 "")
1850 (let ((file-rev1 (vc-version-backup-file file rev1))
1851 (file-rev2 (if (not rev2)
1853 (vc-version-backup-file file rev2)))
1854 (coding-system-for-read (vc-coding-system-for-diff file)))
1855 (if (and file-rev1 file-rev2)
1857 (if (eq vc-diff-knows-L 'no)
1858 (apply 'vc-do-command "*vc-diff*" 1 "diff" nil
1859 (append (vc-switches nil 'diff)
1860 (list (file-relative-name file-rev1)
1861 (file-relative-name file-rev2))))
1862 (apply 'vc-do-command "*vc-diff*" 2 "diff" nil
1863 (append (vc-switches nil 'diff)
1864 ;; Provide explicit labels like RCS or
1865 ;; CVS would do so diff-mode refers to
1866 ;; `file' rather than to `file-rev1'
1867 ;; when trying to find/apply/undo
1869 (list "-L" (vc-diff-label file file-rev1 rev1)
1870 "-L" (vc-diff-label file file-rev2 rev2)
1871 (file-relative-name file-rev1)
1872 (file-relative-name file-rev2)))))))
1874 (if (not vc-diff-knows-L)
1875 (setq vc-diff-knows-L 'no
1876 status (apply 'vc-do-command "*vc-diff*" 1 "diff" nil
1878 (vc-switches nil 'diff)
1879 (list (file-relative-name file-rev1)
1880 (file-relative-name file-rev2)))))
1881 (error "diff failed"))
1882 (if (not vc-diff-knows-L) (setq vc-diff-knows-L 'yes)))
1884 (vc-call diff file rev1 rev2))))
1886 (defun vc-switches (backend op)
1889 (let ((sym (vc-make-backend-sym
1890 backend (intern (concat (symbol-name op)
1892 (if (boundp sym) (symbol-value sym))))
1893 (let ((sym (intern (format "vc-%s-switches" (symbol-name op)))))
1894 (if (boundp sym) (symbol-value sym)))
1896 ((eq op 'diff) diff-switches)))))
1897 (if (stringp switches) (list switches)
1898 ;; If not a list, return nil.
1899 ;; This is so we can set vc-diff-switches to t to override
1900 ;; any switches in diff-switches.
1901 (if (listp switches) switches))))
1903 ;; Old def for compatibility with Emacs-21.[123].
1904 (defmacro vc-diff-switches-list (backend) `(vc-switches ',backend 'diff))
1905 (make-obsolete 'vc-diff-switches-list 'vc-switches "22.1")
1907 (defun vc-default-diff-tree (backend dir rev1 rev2)
1908 "List differences for all registered files at and below DIR.
1909 The meaning of REV1 and REV2 is the same as for `vc-version-diff'."
1910 ;; This implementation does an explicit tree walk, and calls
1911 ;; vc-BACKEND-diff directly for each file. An optimization
1912 ;; would be to use `vc-diff-internal', so that diffs can be local,
1913 ;; and to call it only for files that are actually changed.
1914 ;; However, this is expensive for some backends, and so it is left
1915 ;; to backend-specific implementations.
1916 (setq default-directory dir)
1921 `(let ((coding-system-for-read (vc-coding-system-for-diff ',f)))
1922 (message "Looking at %s" ',f)
1923 (vc-call-backend ',(vc-backend f)
1924 'diff ',f ',rev1 ',rev2))))))
1926 (defun vc-coding-system-for-diff (file)
1927 "Return the coding system for reading diff output for FILE."
1928 (or coding-system-for-read
1929 ;; if we already have this file open,
1930 ;; use the buffer's coding system
1931 (let ((buf (find-buffer-visiting file)))
1932 (if buf (with-current-buffer buf
1933 buffer-file-coding-system)))
1934 ;; otherwise, try to find one based on the file name
1935 (car (find-operation-coding-system 'insert-file-contents file))
1936 ;; and a final fallback
1940 (defun vc-version-other-window (rev)
1941 "Visit version REV of the current file in another window.
1942 If the current file is named `F', the version is named `F.~REV~'.
1943 If `F.~REV~' already exists, use it instead of checking it out again."
1944 (interactive "sVersion to visit (default is workfile version): ")
1945 (vc-ensure-vc-buffer)
1946 (let* ((file buffer-file-name)
1947 (version (if (string-equal rev "")
1948 (vc-workfile-version file)
1950 (switch-to-buffer-other-window (vc-find-version file version))))
1952 (defun vc-find-version (file version)
1953 "Read VERSION of FILE into a buffer and return the buffer."
1954 (let ((automatic-backup (vc-version-backup-file-name file version))
1955 (filebuf (or (get-file-buffer file) (current-buffer)))
1956 (filename (vc-version-backup-file-name file version 'manual)))
1957 (unless (file-exists-p filename)
1958 (if (file-exists-p automatic-backup)
1959 (rename-file automatic-backup filename nil)
1960 (message "Checking out %s..." filename)
1961 (with-current-buffer filebuf
1964 (let ((coding-system-for-read 'no-conversion)
1965 (coding-system-for-write 'no-conversion))
1966 (with-temp-file filename
1967 (let ((outbuf (current-buffer)))
1968 ;; Change buffer to get local value of
1969 ;; vc-checkout-switches.
1970 (with-current-buffer filebuf
1971 (vc-call find-version file version outbuf))))
1973 (if (and failed (file-exists-p filename))
1974 (delete-file filename))))
1975 (vc-mode-line file))
1976 (message "Checking out %s...done" filename)))
1977 (find-file-noselect filename)))
1979 (defun vc-default-find-version (backend file rev buffer)
1980 "Provide the new `find-version' op based on the old `checkout' op.
1981 This is only for compatibility with old backends. They should be updated
1982 to provide the `find-version' operation instead."
1983 (let ((tmpfile (make-temp-file (expand-file-name file))))
1986 (vc-call-backend backend 'checkout file nil rev tmpfile)
1987 (with-current-buffer buffer
1988 (insert-file-contents-literally tmpfile)))
1989 (delete-file tmpfile))))
1991 ;; Header-insertion code
1994 (defun vc-insert-headers ()
1995 "Insert headers into a file for use with a version control system.
1996 Headers desired are inserted at point, and are pulled from
1997 the variable `vc-BACKEND-header'."
1999 (vc-ensure-vc-buffer)
2003 (if (or (not (vc-check-headers))
2004 (y-or-n-p "Version headers already exist. Insert another set? "))
2005 (let* ((delims (cdr (assq major-mode vc-comment-alist)))
2006 (comment-start-vc (or (car delims) comment-start "#"))
2007 (comment-end-vc (or (car (cdr delims)) comment-end ""))
2008 (hdsym (vc-make-backend-sym (vc-backend buffer-file-name)
2010 (hdstrings (and (boundp hdsym) (symbol-value hdsym))))
2011 (dolist (s hdstrings)
2012 (insert comment-start-vc "\t" s "\t"
2013 comment-end-vc "\n"))
2014 (if vc-static-header-alist
2015 (dolist (f vc-static-header-alist)
2016 (if (string-match (car f) buffer-file-name)
2017 (insert (format (cdr f) (car hdstrings)))))))))))
2019 (defun vc-clear-headers (&optional file)
2020 "Clear all version headers in the current buffer (or FILE).
2021 The headers are reset to their non-expanded form."
2022 (let* ((filename (or file buffer-file-name))
2023 (visited (find-buffer-visiting filename))
2024 (backend (vc-backend filename)))
2025 (when (vc-find-backend-function backend 'clear-headers)
2027 (let ((context (vc-buffer-context)))
2028 ;; save-excursion may be able to relocate point and mark
2029 ;; properly. If it fails, vc-restore-buffer-context
2030 ;; will give it a second try.
2032 (vc-call-backend backend 'clear-headers))
2033 (vc-restore-buffer-context context))
2034 (set-buffer (find-file-noselect filename))
2035 (vc-call-backend backend 'clear-headers)
2036 (kill-buffer filename)))))
2040 "Merge changes between two versions into the current buffer's file.
2041 This asks for two versions to merge from in the minibuffer. If the
2042 first version is a branch number, then merge all changes from that
2043 branch. If the first version is empty, merge news, i.e. recent changes
2044 from the current branch.
2046 See Info node `Merging'."
2048 (vc-ensure-vc-buffer)
2050 (let* ((file buffer-file-name)
2051 (backend (vc-backend file))
2052 (state (vc-state file))
2053 first-version second-version status)
2056 (error "File is locked by %s" state))
2057 ((not (vc-editable-p file))
2059 "File must be checked out for merging. Check out now? ")
2060 (vc-checkout file t)
2061 (error "Merge aborted"))))
2063 (read-string (concat "Branch or version to merge from "
2064 "(default news on current branch): ")))
2065 (if (string= first-version "")
2066 (if (not (vc-find-backend-function backend 'merge-news))
2067 (error "Sorry, merging news is not implemented for %s" backend)
2068 (setq status (vc-call merge-news file)))
2069 (if (not (vc-find-backend-function backend 'merge))
2070 (error "Sorry, merging is not implemented for %s" backend)
2071 (if (not (vc-branch-p first-version))
2072 (setq second-version
2073 (read-string "Second version: "
2074 (concat (vc-branch-part first-version) ".")))
2075 ;; We want to merge an entire branch. Set versions
2076 ;; accordingly, so that vc-BACKEND-merge understands us.
2077 (setq second-version first-version)
2078 ;; first-version must be the starting point of the branch
2079 (setq first-version (vc-branch-part first-version)))
2080 (setq status (vc-call merge file first-version second-version))))
2081 (vc-maybe-resolve-conflicts file status "WORKFILE" "MERGE SOURCE")))
2083 (defun vc-maybe-resolve-conflicts (file status &optional name-A name-B)
2084 (vc-resynch-buffer file t (not (buffer-modified-p)))
2085 (if (zerop status) (message "Merge successful")
2087 (message "File contains conflicts.")))
2090 (defalias 'vc-resolve-conflicts 'smerge-ediff)
2092 ;; The VC directory major mode. Coopt Dired for this.
2093 ;; All VC commands get mapped into logical equivalents.
2095 (defvar vc-dired-switches)
2096 (defvar vc-dired-terse-mode)
2098 (defvar vc-dired-mode-map
2099 (let ((map (make-sparse-keymap))
2100 (vmap (make-sparse-keymap)))
2101 (define-key map "\C-xv" vmap)
2102 (define-key map "v" vmap)
2103 (set-keymap-parent vmap vc-prefix-map)
2104 (define-key vmap "t" 'vc-dired-toggle-terse-mode)
2107 (define-derived-mode vc-dired-mode dired-mode "Dired under "
2108 "The major mode used in VC directory buffers.
2110 It works like Dired, but lists only files under version control, with
2111 the current VC state of each file being indicated in the place of the
2112 file's link count, owner, group and size. Subdirectories are also
2113 listed, and you may insert them into the buffer as desired, like in
2116 All Dired commands operate normally, with the exception of `v', which
2117 is redefined as the version control prefix, so that you can type
2118 `vl', `v=' etc. to invoke `vc-print-log', `vc-diff', and the like on
2119 the file named in the current Dired buffer line. `vv' invokes
2120 `vc-next-action' on this file, or on all files currently marked.
2121 There is a special command, `*l', to mark all files currently locked."
2122 ;; define-derived-mode does it for us in Emacs-21, but not in Emacs-20.
2123 ;; We do it here because dired might not be loaded yet
2124 ;; when vc-dired-mode-map is initialized.
2125 (set-keymap-parent vc-dired-mode-map dired-mode-map)
2126 (add-hook 'dired-after-readin-hook 'vc-dired-hook nil t)
2127 ;; The following is slightly modified from files.el,
2128 ;; because file lines look a bit different in vc-dired-mode
2129 ;; (the column before the date does not end in a digit).
2130 ;; albinus: It should be done in the original declaration. Problem
2131 ;; is the optional empty state-info; otherwise ")" would be good
2132 ;; enough as delimeter.
2133 (set (make-local-variable 'directory-listing-before-filename-regexp)
2134 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
2135 ;; In some locales, month abbreviations are as short as 2 letters,
2136 ;; and they can be followed by ".".
2137 (month (concat l l "+\\.?"))
2139 (yyyy "[0-9][0-9][0-9][0-9]")
2141 (HH:MM "[ 0-2][0-9]:[0-5][0-9]")
2142 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
2143 (zone "[-+][0-2][0-9][0-5][0-9]")
2144 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
2145 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
2146 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
2147 "\\|" yyyy "-" iso-mm-dd "\\)"))
2148 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
2150 "\\(" HH:MM "\\|" yyyy "\\)"))
2151 (western-comma (concat month s "+" dd "," s "+" yyyy))
2152 ;; Japanese MS-Windows ls-lisp has one-digit months, and
2153 ;; omits the Kanji characters after month and day-of-month.
2156 (concat mm l "?" s dd l "?" s "+"
2157 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
2158 ;; the .* below ensures that we find the last match on a line
2160 "\\(" western "\\|" western-comma "\\|" japanese "\\|" iso "\\)"
2162 (and (boundp 'vc-dired-switches)
2164 (set (make-local-variable 'dired-actual-switches)
2166 (set (make-local-variable 'vc-dired-terse-mode) vc-dired-terse-display)
2167 (setq mode-name (concat mode-name (symbol-name (vc-responsible-backend
2168 default-directory))))
2169 (setq vc-dired-mode t))
2171 (defun vc-dired-toggle-terse-mode ()
2172 "Toggle terse display in VC Dired."
2174 (if (not vc-dired-mode)
2176 (setq vc-dired-terse-mode (not vc-dired-terse-mode))
2177 (if vc-dired-terse-mode
2181 (defun vc-dired-mark-locked ()
2182 "Mark all files currently locked."
2184 (dired-mark-if (let ((f (dired-get-filename nil t)))
2186 (not (file-directory-p f))
2187 (not (vc-up-to-date-p f))))
2190 (define-key vc-dired-mode-map "*l" 'vc-dired-mark-locked)
2192 (defun vc-default-dired-state-info (backend file)
2193 (let ((state (vc-state file)))
2195 ((stringp state) (concat "(" state ")"))
2196 ((eq state 'edited) (concat "(" (vc-user-login-name file) ")"))
2197 ((eq state 'needs-merge) "(merge)")
2198 ((eq state 'needs-patch) "(patch)")
2199 ((eq state 'unlocked-changes) "(stale)"))))
2201 (defun vc-dired-reformat-line (vc-info)
2202 "Reformat a directory-listing line.
2203 Replace various columns with version control information, VC-INFO.
2204 This code, like dired, assumes UNIX -l format."
2206 (when (re-search-forward
2207 ;; Match link count, owner, group, size. Group may be missing,
2208 ;; and only the size is present in OS/2 -l format.
2209 "^..[drwxlts-]+ \\( *[0-9]+\\( [^ ]+ +\\([^ ]+ +\\)?[0-9]+\\)?\\) "
2210 (line-end-position) t)
2211 (replace-match (substring (concat vc-info " ") 0 10)
2214 (defun vc-dired-hook ()
2215 "Reformat the listing according to version control.
2216 Called by dired after any portion of a vc-dired buffer has been read in."
2217 (message "Getting version information... ")
2218 (let (subdir filename (buffer-read-only nil))
2219 (goto-char (point-min))
2222 ;; subdir header line
2223 ((setq subdir (dired-get-subdir))
2224 ;; if the backend supports it, get the state
2225 ;; of all files in this directory at once
2226 (let ((backend (vc-responsible-backend subdir)))
2227 ;; check `backend' can really handle `subdir'.
2228 (if (and (vc-call-backend backend 'responsible-p subdir)
2229 (vc-find-backend-function backend 'dir-state))
2230 (vc-call-backend backend 'dir-state subdir)))
2232 ;; erase (but don't remove) the "total" line
2233 (delete-region (point) (line-end-position))
2237 ((setq filename (dired-get-filename nil t))
2240 ((file-directory-p filename)
2242 ((member (file-name-nondirectory filename)
2243 vc-directory-exclusion-list)
2244 (let ((pos (point)))
2245 (dired-kill-tree filename)
2248 (vc-dired-terse-mode
2249 ;; Don't show directories in terse mode. Don't use
2250 ;; dired-kill-line to remove it, because in recursive listings,
2251 ;; that would remove the directory contents as well.
2252 (delete-region (line-beginning-position)
2253 (progn (forward-line 1) (point))))
2254 ((string-match "\\`\\.\\.?\\'" (file-name-nondirectory filename))
2257 (vc-dired-reformat-line nil)
2260 ((and (vc-backend filename)
2261 (not (and vc-dired-terse-mode
2262 (vc-up-to-date-p filename))))
2263 (vc-dired-reformat-line (vc-call dired-state-info filename))
2266 (dired-kill-line))))
2268 (t (forward-line 1))))
2270 (message "Getting version information... done")
2273 (cond ((eq (count-lines (point-min) (point-max)) 1)
2274 (goto-char (point-min))
2275 (message "No files locked under %s" default-directory)))))
2277 (defun vc-dired-purge ()
2278 "Remove empty subdirs."
2279 (goto-char (point-min))
2280 (while (dired-get-subdir)
2282 (if (dired-get-filename nil t)
2283 (if (not (dired-next-subdir 1 t))
2284 (goto-char (point-max)))
2286 (if (not (string= (dired-current-directory) default-directory))
2287 (dired-do-kill-lines t "")
2288 ;; We cannot remove the top level directory.
2289 ;; Just make it look a little nicer.
2291 (or (eobp) (kill-line))
2292 (if (not (dired-next-subdir 1 t))
2293 (goto-char (point-max))))))
2294 (goto-char (point-min)))
2296 (defun vc-dired-buffers-for-dir (dir)
2297 "Return a list of all vc-dired buffers that currently display DIR."
2299 ;; Check whether dired is loaded.
2300 (when (fboundp 'dired-buffers-for-dir)
2301 (mapcar (lambda (buffer)
2302 (with-current-buffer buffer
2304 (setq result (append result (list buffer))))))
2305 (dired-buffers-for-dir dir)))
2308 (defun vc-dired-resynch-file (file)
2309 "Update the entries for FILE in any VC Dired buffers that list it."
2310 (let ((buffers (vc-dired-buffers-for-dir (file-name-directory file))))
2312 (mapcar (lambda (buffer)
2313 (with-current-buffer buffer
2314 (if (dired-goto-file file)
2315 ;; bind vc-dired-terse-mode to nil so that
2316 ;; files won't vanish when they are checked in
2317 (let ((vc-dired-terse-mode nil))
2318 (dired-do-redisplay 1)))))
2322 (defun vc-directory (dir read-switches)
2323 "Create a buffer in VC Dired Mode for directory DIR.
2325 See Info node `VC Dired Mode'.
2327 With prefix arg READ-SWITCHES, specify a value to override
2328 `dired-listing-switches' when generating the listing."
2329 (interactive "DDired under VC (directory): \nP")
2330 (let ((vc-dired-switches (concat vc-dired-listing-switches
2331 (if vc-dired-recurse "R" ""))))
2332 (if (eq (string-match tramp-file-name-regexp dir) 0)
2333 (error "Sorry, vc-directory does not work over Tramp"))
2335 (setq vc-dired-switches
2336 (read-string "Dired listing switches: "
2337 vc-dired-switches)))
2339 (require 'dired-aux)
2341 (dired-internal-noselect (expand-file-name (file-name-as-directory dir))
2346 ;; Named-configuration entry points
2348 (defun vc-snapshot-precondition (dir)
2349 "Scan the tree below DIR, looking for files not up-to-date.
2350 If any file is not up-to-date, return the name of the first such file.
2351 \(This means, neither snapshot creation nor retrieval is allowed.\)
2352 If one or more of the files are currently visited, return `visited'.
2353 Otherwise, return nil."
2355 (catch 'vc-locked-example
2359 (if (not (vc-up-to-date-p f)) (throw 'vc-locked-example f)
2360 (if (get-file-buffer f) (setq status 'visited)))))
2364 (defun vc-create-snapshot (dir name branchp)
2365 "Descending recursively from DIR, make a snapshot called NAME.
2366 For each registered file, the version level of its latest version
2367 becomes part of the named configuration. If the prefix argument
2368 BRANCHP is given, the snapshot is made as a new branch and the files
2369 are checked out in that new branch."
2371 (list (read-file-name "Directory: " default-directory default-directory t)
2372 (read-string "New snapshot name: ")
2373 current-prefix-arg))
2374 (message "Making %s... " (if branchp "branch" "snapshot"))
2375 (if (file-directory-p dir) (setq dir (file-name-as-directory dir)))
2376 (vc-call-backend (vc-responsible-backend dir)
2377 'create-snapshot dir name branchp)
2378 (message "Making %s... done" (if branchp "branch" "snapshot")))
2380 (defun vc-default-create-snapshot (backend dir name branchp)
2382 (error "VC backend %s does not support module branches" backend))
2383 (let ((result (vc-snapshot-precondition dir)))
2384 (if (stringp result)
2385 (error "File %s is not up-to-date" result)
2389 (vc-call assign-name f name))))))
2392 (defun vc-retrieve-snapshot (dir name)
2393 "Descending recursively from DIR, retrieve the snapshot called NAME.
2394 If NAME is empty, it refers to the latest versions.
2395 If locking is used for the files in DIR, then there must not be any
2396 locked files at or below DIR (but if NAME is empty, locked files are
2397 allowed and simply skipped)."
2399 (list (read-file-name "Directory: " default-directory default-directory t)
2400 (read-string "Snapshot name to retrieve (default latest versions): ")))
2401 (let ((update (yes-or-no-p "Update any affected buffers? "))
2402 (msg (if (or (not name) (string= name ""))
2403 (format "Updating %s... " (abbreviate-file-name dir))
2404 (format "Retrieving snapshot into %s... "
2405 (abbreviate-file-name dir)))))
2407 (vc-call-backend (vc-responsible-backend dir)
2408 'retrieve-snapshot dir name update)
2409 (message "%s" (concat msg "done"))))
2411 (defun vc-default-retrieve-snapshot (backend dir name update)
2412 (if (string= name "")
2419 (vc-call checkout f nil "")
2420 (if update (vc-resynch-buffer f t t)))))))
2421 (let ((result (vc-snapshot-precondition dir)))
2422 (if (stringp result)
2423 (error "File %s is locked" result)
2424 (setq update (and (eq result 'visited) update))
2427 (lambda (f) (vc-error-occurred
2428 (vc-call checkout f nil name)
2429 (if update (vc-resynch-buffer f t t)))))))))
2431 ;; Miscellaneous other entry points
2434 (defun vc-print-log (&optional focus-rev)
2435 "List the change log of the current buffer in a window.
2436 If FOCUS-REV is non-nil, leave the point at that revision."
2438 (vc-ensure-vc-buffer)
2439 (let ((file buffer-file-name))
2440 (or focus-rev (setq focus-rev (vc-workfile-version file)))
2441 ;; Don't switch to the output buffer before running the command,
2442 ;; so that any buffer-local settings in the vc-controlled
2443 ;; buffer can be accessed by the command.
2446 (vc-call print-log file "*vc-change-log*")
2447 (set-buffer "*vc-change-log*"))
2448 (wrong-number-of-arguments
2449 ;; If this error came from the above call to print-log, try again
2450 ;; without the optional buffer argument (for backward compatibility).
2451 ;; Otherwise, resignal.
2452 (if (or (not (eq (cadr err)
2454 (vc-find-backend-function (vc-backend file)
2456 (not (eq (caddr err) 2)))
2457 (signal (car err) (cdr err))
2458 ;; for backward compatibility
2459 (vc-call print-log file)
2460 (set-buffer "*vc*"))))
2461 (pop-to-buffer (current-buffer))
2463 `(let ((inhibit-read-only t))
2464 (vc-call-backend ',(vc-backend file) 'log-view-mode)
2465 (goto-char (point-max)) (forward-line -1)
2466 (while (looking-at "=*\n")
2467 (delete-char (- (match-end 0) (match-beginning 0)))
2469 (goto-char (point-min))
2470 (if (looking-at "[\b\t\n\v\f\r ]+")
2471 (delete-char (- (match-end 0) (match-beginning 0))))
2472 ;; (shrink-window-if-larger-than-buffer)
2473 ;; move point to the log entry for the current version
2474 (vc-call-backend ',(vc-backend file)
2477 (set-buffer-modified-p nil)))))
2479 (defun vc-default-log-view-mode (backend) (log-view-mode))
2480 (defun vc-default-show-log-entry (backend rev)
2482 (log-view-goto-rev rev)))
2484 (defun vc-default-comment-history (backend file)
2485 "Return a string with all log entries stored in BACKEND for FILE."
2486 (if (vc-find-backend-function backend 'print-log)
2487 (with-current-buffer "*vc*"
2488 (vc-call print-log file)
2489 (vc-call wash-log file)
2492 (defun vc-default-wash-log (backend file)
2493 "Remove all non-comment information from log output.
2494 This default implementation works for RCS logs; backends should override
2495 it if their logs are not in RCS format."
2496 (let ((separator (concat "^-+\nrevision [0-9.]+\ndate: .*\n"
2497 "\\(branches: .*;\n\\)?"
2498 "\\(\\*\\*\\* empty log message \\*\\*\\*\n\\)?")))
2499 (goto-char (point-max)) (forward-line -1)
2500 (while (looking-at "=*\n")
2501 (delete-char (- (match-end 0) (match-beginning 0)))
2503 (goto-char (point-min))
2504 (if (looking-at "[\b\t\n\v\f\r ]+")
2505 (delete-char (- (match-end 0) (match-beginning 0))))
2506 (goto-char (point-min))
2507 (re-search-forward separator nil t)
2508 (delete-region (point-min) (point))
2509 (while (re-search-forward separator nil t)
2510 (delete-region (match-beginning 0) (match-end 0)))))
2513 (defun vc-revert-buffer ()
2514 "Revert the current buffer's file to the version it was based on.
2515 This asks for confirmation if the buffer contents are not identical
2516 to that version. This function does not automatically pick up newer
2517 changes found in the master file; use \\[universal-argument] \\[vc-next-action] to do so."
2519 (vc-ensure-vc-buffer)
2520 ;; Make sure buffer is saved. If the user says `no', abort since
2521 ;; we cannot show the changes and ask for confirmation to discard them.
2522 (vc-buffer-sync nil)
2523 (let ((file buffer-file-name)
2524 ;; This operation should always ask for confirmation.
2525 (vc-suppress-confirm nil)
2526 (obuf (current-buffer))
2528 (if (vc-up-to-date-p file)
2529 (unless (yes-or-no-p "File seems up-to-date. Revert anyway? ")
2530 (error "Revert canceled")))
2531 (unless (vc-workfile-unchanged-p file)
2532 (message "Finding changes...")
2533 ;; vc-diff selects the new window, which is not what we want:
2534 ;; if the new window is on another frame, that'd require the user
2535 ;; moving her mouse to answer the yes-or-no-p question.
2536 (let* ((vc-disable-async-diff (not vc-allow-async-revert))
2537 (win (save-selected-window
2538 (setq status (vc-diff nil t)) (selected-window))))
2539 (vc-exec-after `(message nil))
2542 (unless (yes-or-no-p "Discard changes? ")
2543 (error "Revert canceled"))
2545 (if (one-window-p t)
2546 (if (window-dedicated-p (selected-window))
2547 (make-frame-invisible))
2548 (delete-window))))))
2551 (message "Reverting %s..." file)
2552 (vc-revert-file file)
2553 (message "Reverting %s...done" file)))
2557 "Update the current buffer's file to the latest version on its branch.
2558 If the file contains no changes, and is not locked, then this simply replaces
2559 the working file with the latest version on its branch. If the file contains
2560 changes, and the backend supports merging news, then any recent changes from
2561 the current branch are merged into the working file."
2563 (vc-ensure-vc-buffer)
2564 (vc-buffer-sync nil)
2565 (let ((file buffer-file-name))
2566 (if (vc-up-to-date-p file)
2567 (vc-checkout file nil "")
2568 (if (eq (vc-checkout-model file) 'locking)
2569 (if (eq (vc-state file) 'edited)
2571 (substitute-command-keys
2572 "File is locked--type \\[vc-revert-buffer] to discard changes"))
2574 (substitute-command-keys
2575 "Unexpected file state (%s)--type \\[vc-next-action] to correct")
2577 (if (not (vc-find-backend-function (vc-backend file) 'merge-news))
2578 (error "Sorry, merging news is not implemented for %s"
2580 (vc-call merge-news file)
2581 (vc-resynch-window file t t))))))
2583 (defun vc-version-backup-file (file &optional rev)
2584 "Return name of backup file for revision REV of FILE.
2585 If version backups should be used for FILE, and there exists
2586 such a backup for REV or the current workfile version of file,
2587 return its name; otherwise return nil."
2588 (when (vc-call make-version-backups-p file)
2589 (let ((backup-file (vc-version-backup-file-name file rev)))
2590 (if (file-exists-p backup-file)
2592 ;; there is no automatic backup, but maybe the user made one manually
2593 (setq backup-file (vc-version-backup-file-name file rev 'manual))
2594 (if (file-exists-p backup-file)
2597 (defun vc-default-revert (backend file contents-done)
2598 (unless contents-done
2599 (let ((rev (vc-workfile-version file))
2600 (file-buffer (or (get-file-buffer file) (current-buffer))))
2601 (message "Checking out %s..." file)
2603 (backup-name (car (find-backup-file-name file))))
2605 (copy-file file backup-name 'ok-if-already-exists 'keep-date)
2606 (unless (file-writable-p file)
2607 (set-file-modes file (logior (file-modes file) 128))))
2609 (let ((coding-system-for-read 'no-conversion)
2610 (coding-system-for-write 'no-conversion))
2611 (with-temp-file file
2612 (let ((outbuf (current-buffer)))
2613 ;; Change buffer to get local value of vc-checkout-switches.
2614 (with-current-buffer file-buffer
2615 (let ((default-directory (file-name-directory file)))
2616 (vc-call find-version file rev outbuf)))))
2620 (rename-file backup-name file 'ok-if-already-exists)
2621 (and (not vc-make-backup-files) (delete-file backup-name))))))
2622 (message "Checking out %s...done" file))))
2624 (defun vc-revert-file (file)
2625 "Revert FILE back to the version it was based on."
2628 (let ((backup-file (vc-version-backup-file file)))
2630 (copy-file backup-file file 'ok-if-already-exists 'keep-date)
2631 (vc-delete-automatic-version-backups file))
2632 (vc-call revert file backup-file))
2633 `((vc-state . up-to-date)
2634 (vc-checkout-time . ,(nth 5 (file-attributes file)))))
2635 (vc-resynch-buffer file t t))
2638 (defun vc-cancel-version (norevert)
2639 "Get rid of most recently checked in version of this file.
2640 A prefix argument NOREVERT means do not revert the buffer afterwards."
2642 (vc-ensure-vc-buffer)
2643 (let* ((file buffer-file-name)
2644 (backend (vc-backend file))
2645 (target (vc-workfile-version file)))
2647 ((not (vc-find-backend-function backend 'cancel-version))
2648 (error "Sorry, canceling versions is not supported under %s" backend))
2649 ((not (vc-call latest-on-branch-p file))
2650 (error "This is not the latest version; VC cannot cancel it"))
2651 ((not (vc-up-to-date-p file))
2652 (error "%s" (substitute-command-keys "File is not up to date; use \\[vc-revert-buffer] to discard changes"))))
2653 (if (null (yes-or-no-p (format "Remove version %s from master? " target)))
2655 (setq norevert (or norevert (not
2656 (yes-or-no-p "Revert buffer to most recent remaining version? "))))
2658 (message "Removing last change from %s..." file)
2661 (vc-call cancel-version file norevert)
2662 `((vc-state . ,(if norevert 'edited 'up-to-date))
2663 (vc-checkout-time . ,(if norevert
2665 (nth 5 (file-attributes file))))
2666 (vc-workfile-version . nil)))
2667 (message "Removing last change from %s...done" file)
2670 (norevert ;; clear version headers and mark the buffer modified
2671 (set-visited-file-name file)
2672 (when (not vc-make-backup-files)
2673 ;; inhibit backup for this buffer
2674 (make-local-variable 'backup-inhibited)
2675 (setq backup-inhibited t))
2676 (setq buffer-read-only nil)
2679 (vc-dired-resynch-file file))
2680 (t ;; revert buffer to file on disk
2681 (vc-resynch-buffer file t t)))
2682 (message "Version %s has been removed from the master" target))))
2685 (defun vc-switch-backend (file backend)
2686 "Make BACKEND the current version control system for FILE.
2687 FILE must already be registered in BACKEND. The change is not
2688 permanent, only for the current session. This function only changes
2689 VC's perspective on FILE, it does not register or unregister it.
2690 By default, this command cycles through the registered backends.
2691 To get a prompt, use a prefix argument."
2694 (or buffer-file-name
2695 (error "There is no version-controlled file in this buffer"))
2696 (let ((backend (vc-backend buffer-file-name))
2701 (error "File %s is not under version control" buffer-file-name))
2702 ;; Find the registered backends.
2703 (dolist (backend vc-handled-backends)
2704 (when (vc-call-backend backend 'registered buffer-file-name)
2705 (push backend backends)))
2706 ;; Find the next backend.
2707 (let ((def (car (delq backend
2708 (append (memq backend backends) backends))))
2709 (others (delete backend backends)))
2711 ((null others) (error "No other backend to switch to"))
2716 (format "Switch to backend [%s]: " def)
2717 (mapcar (lambda (b) (list (downcase (symbol-name b)))) backends)
2718 nil t nil nil (downcase (symbol-name def))))))
2720 ;; Calling the `registered' method can mess up the file
2721 ;; properties, so we want to revert them to what they were.
2722 (if (and backend (delete backend backends))
2723 (vc-call-backend backend 'registered buffer-file-name))))))
2724 (unless (eq backend (vc-backend file))
2725 (vc-file-clearprops file)
2726 (vc-file-setprop file 'vc-backend backend)
2727 ;; Force recomputation of the state
2728 (unless (vc-call-backend backend 'registered file)
2729 (vc-file-clearprops file)
2730 (error "%s is not registered in %s" file backend))
2731 (vc-mode-line file)))
2734 (defun vc-transfer-file (file new-backend)
2735 "Transfer FILE to another version control system NEW-BACKEND.
2736 If NEW-BACKEND has a higher precedence than FILE's current backend
2737 \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in
2738 NEW-BACKEND, using the version number from the current backend as the
2739 base level. If NEW-BACKEND has a lower precedence than the current
2740 backend, then commit all changes that were made under the current
2741 backend to NEW-BACKEND, and unregister FILE from the current backend.
2742 \(If FILE is not yet registered under NEW-BACKEND, register it.)"
2743 (let* ((old-backend (vc-backend file))
2744 (edited (memq (vc-state file) '(edited needs-merge)))
2745 (registered (vc-call-backend new-backend 'registered file))
2747 (and registered ; Never move if not registered in new-backend yet.
2748 ;; move if new-backend comes later in vc-handled-backends
2749 (or (memq new-backend (memq old-backend vc-handled-backends))
2750 (y-or-n-p "Final transfer? "))))
2752 (if (eq old-backend new-backend)
2753 (error "%s is the current backend of %s" new-backend file))
2755 (set-file-modes file (logior (file-modes file) 128))
2756 ;; `registered' might have switched under us.
2757 (vc-switch-backend file old-backend)
2758 (let* ((rev (vc-workfile-version file))
2759 (modified-file (and edited (make-temp-file file)))
2760 (unmodified-file (and modified-file (vc-version-backup-file file))))
2761 ;; Go back to the base unmodified file.
2765 (copy-file file modified-file 'ok-if-already-exists)
2766 ;; If we have a local copy of the unmodified file, handle that
2767 ;; here and not in vc-revert-file because we don't want to
2768 ;; delete that copy -- it is still useful for OLD-BACKEND.
2770 (copy-file unmodified-file file
2771 'ok-if-already-exists 'keep-date)
2772 (if (y-or-n-p "Get base version from master? ")
2773 (vc-revert-file file))))
2774 (vc-call-backend new-backend 'receive-file file rev))
2776 (vc-switch-backend file new-backend)
2777 (unless (eq (vc-checkout-model file) 'implicit)
2778 (vc-checkout file t nil))
2779 (rename-file modified-file file 'ok-if-already-exists)
2780 (vc-file-setprop file 'vc-checkout-time nil)))))
2782 (vc-switch-backend file old-backend)
2783 (setq comment (vc-call comment-history file))
2784 (vc-call unregister file))
2785 (vc-switch-backend file new-backend)
2786 (when (or move edited)
2787 (vc-file-setprop file 'vc-state 'edited)
2789 (vc-checkin file nil comment (stringp comment)))))
2791 (defun vc-default-unregister (backend file)
2792 "Default implementation of `vc-unregister', signals an error."
2793 (error "Unregistering files is not supported for %s" backend))
2795 (defun vc-default-receive-file (backend file rev)
2796 "Let BACKEND receive FILE from another version control system."
2797 (vc-call-backend backend 'register file rev ""))
2799 (defun vc-rename-master (oldmaster newfile templates)
2800 "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES."
2801 (let* ((dir (file-name-directory (expand-file-name oldmaster)))
2802 (newdir (or (file-name-directory newfile) ""))
2803 (newbase (file-name-nondirectory newfile))
2805 ;; List of potential master files for `newfile'
2807 (lambda (s) (vc-possible-master s newdir newbase))
2809 (if (or (file-symlink-p oldmaster)
2810 (file-symlink-p (file-name-directory oldmaster)))
2811 (error "This is unsafe in the presence of symbolic links"))
2815 ;; If possible, keep the master file in the same directory.
2817 (if (and f (string= (file-name-directory (expand-file-name f)) dir))
2819 ;; If not, just use the first possible place.
2821 (and f (or (not (setq dir (file-name-directory f)))
2822 (file-directory-p dir))
2824 (error "New file lacks a version control directory")))))
2826 (defun vc-delete-file (file)
2827 "Delete file and mark it as such in the version control system."
2828 (interactive "fVC delete file: ")
2829 (let ((buf (get-file-buffer file))
2830 (backend (vc-backend file)))
2832 (error "File %s is not under version control"
2833 (file-name-nondirectory file)))
2834 (unless (vc-find-backend-function backend 'delete-file)
2835 (error "Deleting files under %s is not supported in VC" backend))
2836 (if (and buf (buffer-modified-p buf))
2837 (error "Please save files before deleting them"))
2838 (unless (y-or-n-p (format "Really want to delete %s? "
2839 (file-name-nondirectory file)))
2841 (unless (or (file-directory-p file) (null make-backup-files))
2842 (with-current-buffer (or buf (find-file-noselect file))
2843 (let ((backup-inhibited nil))
2845 (vc-call delete-file file)
2846 ;; If the backend hasn't deleted the file itself, let's do it for him.
2847 (if (file-exists-p file) (delete-file file))))
2849 (defun vc-default-rename-file (backend old new)
2851 (add-name-to-file old new)
2852 (error (rename-file old new)))
2853 (vc-delete-file old)
2854 (with-current-buffer (find-file-noselect new)
2858 (defun vc-rename-file (old new)
2859 "Rename file OLD to NEW, and rename its master file likewise."
2860 (interactive "fVC rename file: \nFRename to: ")
2861 (let ((oldbuf (get-file-buffer old)))
2862 (if (and oldbuf (buffer-modified-p oldbuf))
2863 (error "Please save files before moving them"))
2864 (if (get-file-buffer new)
2865 (error "Already editing new file name"))
2866 (if (file-exists-p new)
2867 (error "New file already exists"))
2868 (let ((state (vc-state old)))
2869 (unless (memq state '(up-to-date edited))
2870 (error "Please %s files before moving them"
2871 (if (stringp state) "check in" "update"))))
2872 (vc-call rename-file old new)
2873 (vc-file-clearprops old)
2874 ;; Move the actual file (unless the backend did it already)
2875 (if (file-exists-p old) (rename-file old new))
2876 ;; ?? Renaming a file might change its contents due to keyword expansion.
2877 ;; We should really check out a new copy if the old copy was precisely equal
2878 ;; to some checked in version. However, testing for this is tricky....
2880 (with-current-buffer oldbuf
2881 (let ((buffer-read-only buffer-read-only))
2882 (set-visited-file-name new))
2885 (set-buffer-modified-p nil)))))
2888 (defun vc-update-change-log (&rest args)
2889 "Find change log file and add entries from recent version control logs.
2890 Normally, find log entries for all registered files in the default
2893 With prefix arg of \\[universal-argument], only find log entries for the current buffer's file.
2895 With any numeric prefix arg, find log entries for all currently visited
2896 files that are under version control. This puts all the entries in the
2897 log for the default directory, which may not be appropriate.
2899 From a program, any ARGS are assumed to be filenames for which
2900 log entries should be gathered."
2902 (cond ((consp current-prefix-arg) ;C-u
2903 (list buffer-file-name))
2904 (current-prefix-arg ;Numeric argument.
2906 (buffers (buffer-list))
2909 (setq file (buffer-file-name (car buffers)))
2910 (and file (vc-backend file)
2911 (setq files (cons file files)))
2912 (setq buffers (cdr buffers)))
2915 ;; Don't supply any filenames to backend; this means
2916 ;; it should find all relevant files relative to
2917 ;; the default-directory.
2919 (dolist (file (or args (list default-directory)))
2920 (if (eq (string-match tramp-file-name-regexp file) 0)
2921 (error "Sorry, vc-update-change-log does not work over Tramp")))
2922 (vc-call-backend (vc-responsible-backend default-directory)
2923 'update-changelog args))
2925 (defalias 'vc-cvs-update-changelog 'vc-update-changelog-rcs2log)
2926 (defalias 'vc-rcs-update-changelog 'vc-update-changelog-rcs2log)
2927 ;; FIXME: This should probably be moved to vc-rcs.el and replaced in
2928 ;; vc-cvs.el by code using cvs2cl.
2929 (defun vc-update-changelog-rcs2log (files)
2930 "Default implementation of update-changelog.
2931 Uses `rcs2log' which only works for RCS and CVS."
2932 ;; FIXME: We (c|sh)ould add support for cvs2cl
2933 (let ((odefault default-directory)
2934 (changelog (find-change-log))
2935 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
2936 (tempfile (make-temp-file
2937 (expand-file-name "vc"
2938 (or small-temporary-file-directory
2939 temporary-file-directory))))
2940 (login-name (or user-login-name
2941 (format "uid%d" (number-to-string (user-uid)))))
2942 (full-name (or add-log-full-name
2945 (format "uid%d" (number-to-string (user-uid)))))
2946 (mailing-address (or add-log-mailing-address
2947 user-mail-address)))
2948 (find-file-other-window changelog)
2949 (barf-if-buffer-read-only)
2952 (goto-char (point-min))
2954 (message "Computing change log entries...")
2955 (message "Computing change log entries... %s"
2958 (setq default-directory odefault)
2959 (if (eq 0 (apply 'call-process
2960 (expand-file-name "rcs2log"
2962 nil (list t tempfile) nil
2964 "-u" (concat login-name
2966 "\t" mailing-address)
2970 (expand-file-name f odefault)))
2973 (pop-to-buffer (get-buffer-create "*vc*"))
2975 (insert-file-contents tempfile)
2977 (setq default-directory (file-name-directory changelog))
2978 (delete-file tempfile)))))
2980 ;; Annotate functionality
2982 ;; Declare globally instead of additional parameter to
2983 ;; temp-buffer-show-function (not possible to pass more than one
2984 ;; parameter). The use of annotate-ratio is deprecated in favor of
2985 ;; annotate-mode, which replaces it with the more sensible "span-to
2986 ;; days", along with autoscaling support.
2987 (defvar vc-annotate-ratio nil "Global variable.")
2989 ;; internal buffer-local variables
2990 (defvar vc-annotate-backend nil)
2991 (defvar vc-annotate-parent-file nil)
2992 (defvar vc-annotate-parent-rev nil)
2993 (defvar vc-annotate-parent-display-mode nil)
2995 (defconst vc-annotate-font-lock-keywords
2996 ;; The fontification is done by vc-annotate-lines instead of font-lock.
2997 '((vc-annotate-lines)))
2999 (define-derived-mode vc-annotate-mode fundamental-mode "Annotate"
3000 "Major mode for output buffers of the `vc-annotate' command.
3002 You can use the mode-specific menu to alter the time-span of the used
3003 colors. See variable `vc-annotate-menu-elements' for customizing the
3005 (set (make-local-variable 'truncate-lines) t)
3006 (set (make-local-variable 'font-lock-defaults)
3007 '(vc-annotate-font-lock-keywords t))
3010 (defun vc-annotate-display-default (ratio)
3011 "Display the output of \\[vc-annotate] using the default color range.
3012 The color range is given by `vc-annotate-color-map', scaled by RATIO.
3013 The current time is used as the offset."
3014 (interactive (progn (kill-local-variable 'vc-annotate-color-map) '(1.0)))
3015 (message "Redisplaying annotation...")
3016 (vc-annotate-display ratio)
3017 (message "Redisplaying annotation...done"))
3019 (defun vc-annotate-oldest-in-map (color-map)
3020 "Return the oldest time in the COLOR-MAP."
3021 ;; Since entries should be sorted, we can just use the last one.
3022 (caar (last color-map)))
3024 (defun vc-annotate-display-autoscale (&optional full)
3025 "Highlight the output of \\[vc-annotate] using an autoscaled color map.
3026 Autoscaling means that the map is scaled from the current time to the
3027 oldest annotation in the buffer, or, with prefix argument FULL, to
3028 cover the range from the oldest annotation to the newest."
3031 (oldest 999999.) ;Any CVS users at the founding of Rome?
3032 (current (vc-annotate-convert-time (current-time)))
3034 (message "Redisplaying annotation...")
3035 ;; Run through this file and find the oldest and newest dates annotated.
3037 (goto-char (point-min))
3038 (while (setq date (prog1 (vc-call-backend vc-annotate-backend
3044 (setq oldest date))))
3045 (vc-annotate-display
3046 (/ (- (if full newest current) oldest)
3047 (vc-annotate-oldest-in-map vc-annotate-color-map))
3049 (message "Redisplaying annotation...done \(%s\)"
3051 (format "Spanned from %.1f to %.1f days old"
3054 (format "Spanned to %.1f days old" (- current oldest))))))
3056 ;; Menu -- Using easymenu.el
3057 (easy-menu-define vc-annotate-mode-menu vc-annotate-mode-map
3058 "VC Annotate Display Menu"
3060 ["By Color Map Range" (unless (null vc-annotate-display-mode)
3061 (setq vc-annotate-display-mode nil)
3062 (vc-annotate-display-select))
3063 :style toggle :selected (null vc-annotate-display-mode)]
3064 ,@(let ((oldest-in-map (vc-annotate-oldest-in-map vc-annotate-color-map)))
3065 (mapcar (lambda (element)
3066 (let ((days (* element oldest-in-map)))
3067 `[,(format "Span %.1f days" days)
3068 (vc-annotate-display-select nil ,days)
3069 :style toggle :selected
3070 (eql vc-annotate-display-mode ,days) ]))
3071 vc-annotate-menu-elements))
3073 (vc-annotate-display-select
3074 nil (float (string-to-number (read-string "Span how many days? "))))]
3077 (unless (eq vc-annotate-display-mode 'scale)
3078 (vc-annotate-display-select nil 'scale))
3079 :style toggle :selected
3080 (eq vc-annotate-display-mode 'scale)]
3081 ["Span Oldest->Newest"
3082 (unless (eq vc-annotate-display-mode 'fullscale)
3083 (vc-annotate-display-select nil 'fullscale))
3084 :style toggle :selected
3085 (eq vc-annotate-display-mode 'fullscale)]
3087 ["Annotate previous revision" vc-annotate-prev-version]
3088 ["Annotate next revision" vc-annotate-next-version]
3089 ["Annotate revision at line" vc-annotate-revision-at-line]
3090 ["Annotate revision previous to line" vc-annotate-revision-previous-to-line]
3091 ["Annotate latest revision" vc-annotate-workfile-version]
3092 ["Show log of revision at line" vc-annotate-show-log-revision-at-line]
3093 ["Show diff of revision at line" vc-annotate-show-diff-revision-at-line]))
3095 (defun vc-annotate-display-select (&optional buffer mode)
3096 "Highlight the output of \\[vc-annotate].
3097 By default, the current buffer is highlighted, unless overridden by
3098 BUFFER. `vc-annotate-display-mode' specifies the highlighting mode to
3099 use; you may override this using the second optional arg MODE."
3101 (if mode (setq vc-annotate-display-mode mode))
3102 (pop-to-buffer (or buffer (current-buffer)))
3103 (cond ((null vc-annotate-display-mode)
3104 ;; The ratio is global, thus relative to the global color-map.
3105 (kill-local-variable 'vc-annotate-color-map)
3106 (vc-annotate-display-default (or vc-annotate-ratio 1.0)))
3107 ;; One of the auto-scaling modes
3108 ((eq vc-annotate-display-mode 'scale)
3109 (vc-annotate-display-autoscale))
3110 ((eq vc-annotate-display-mode 'fullscale)
3111 (vc-annotate-display-autoscale t))
3112 ((numberp vc-annotate-display-mode) ; A fixed number of days lookback
3113 (vc-annotate-display-default
3114 (/ vc-annotate-display-mode
3115 (vc-annotate-oldest-in-map vc-annotate-color-map))))
3116 (t (error "No such display mode: %s"
3117 vc-annotate-display-mode))))
3120 (defun vc-annotate (file rev &optional display-mode buf)
3121 "Display the edit history of the current file using colors.
3123 This command creates a buffer that shows, for each line of the current
3124 file, when it was last edited and by whom. Additionally, colors are
3125 used to show the age of each line--blue means oldest, red means
3126 youngest, and intermediate colors indicate intermediate ages. By
3127 default, the time scale stretches back one year into the past;
3128 everything that is older than that is shown in blue.
3130 With a prefix argument, this command asks two questions in the
3131 minibuffer. First, you may enter a version number; then the buffer
3132 displays and annotates that version instead of the current version
3133 \(type RET in the minibuffer to leave that default unchanged). Then,
3134 you are prompted for the time span in days which the color range
3135 should cover. For example, a time span of 20 days means that changes
3136 over the past 20 days are shown in red to blue, according to their
3137 age, and everything that is older than that is shown in blue.
3139 Customization variables:
3141 `vc-annotate-menu-elements' customizes the menu elements of the
3142 mode-specific menu. `vc-annotate-color-map' and
3143 `vc-annotate-very-old-color' defines the mapping of time to
3144 colors. `vc-annotate-background' specifies the background color."
3146 (save-current-buffer
3147 (vc-ensure-vc-buffer)
3148 (list buffer-file-name
3149 (let ((def (vc-workfile-version buffer-file-name)))
3150 (if (null current-prefix-arg) def
3152 (format "Annotate from version (default %s): " def)
3154 (if (null current-prefix-arg)
3155 vc-annotate-display-mode
3156 (float (string-to-number
3157 (read-string "Annotate span days (default 20): "
3159 (vc-ensure-vc-buffer)
3160 (setq vc-annotate-display-mode display-mode) ;Not sure why. --Stef
3161 (let* ((temp-buffer-name (format "*Annotate %s (rev %s)*" (buffer-name) rev))
3162 (temp-buffer-show-function 'vc-annotate-display-select)
3163 ;; If BUF is specified, we presume the caller maintains current line,
3164 ;; so we don't need to do it here. This implementation may give
3165 ;; strange results occasionally in the case of REV != WORKFILE-REV.
3166 (current-line (unless buf (line-number-at-pos))))
3167 (message "Annotating...")
3168 ;; If BUF is specified it tells in which buffer we should put the
3169 ;; annotations. This is used when switching annotations to another
3170 ;; revision, so we should update the buffer's name.
3171 (if buf (with-current-buffer buf
3172 (rename-buffer temp-buffer-name t)
3173 ;; In case it had to be uniquified.
3174 (setq temp-buffer-name (buffer-name))))
3175 (with-output-to-temp-buffer temp-buffer-name
3176 (vc-call annotate-command file (get-buffer temp-buffer-name) rev)
3177 ;; we must setup the mode first, and then set our local
3178 ;; variables before the show-function is called at the exit of
3179 ;; with-output-to-temp-buffer
3180 (with-current-buffer temp-buffer-name
3181 (if (not (equal major-mode 'vc-annotate-mode))
3183 (set (make-local-variable 'vc-annotate-backend) (vc-backend file))
3184 (set (make-local-variable 'vc-annotate-parent-file) file)
3185 (set (make-local-variable 'vc-annotate-parent-rev) rev)
3186 (set (make-local-variable 'vc-annotate-parent-display-mode)
3189 (goto-line current-line temp-buffer-name))
3190 (message "Annotating... done")))
3192 (defun vc-annotate-prev-version (prefix)
3193 "Visit the annotation of the version previous to this one.
3195 With a numeric prefix argument, annotate the version that many
3198 (vc-annotate-warp-version (- 0 prefix)))
3200 (defun vc-annotate-next-version (prefix)
3201 "Visit the annotation of the version after this one.
3203 With a numeric prefix argument, annotate the version that many
3206 (vc-annotate-warp-version prefix))
3208 (defun vc-annotate-workfile-version ()
3209 "Visit the annotation of the workfile version of this file."
3211 (if (not (equal major-mode 'vc-annotate-mode))
3212 (message "Cannot be invoked outside of a vc annotate buffer")
3213 (let ((warp-rev (vc-workfile-version vc-annotate-parent-file)))
3214 (if (equal warp-rev vc-annotate-parent-rev)
3215 (message "Already at version %s" warp-rev)
3216 (vc-annotate-warp-version warp-rev)))))
3218 (defun vc-annotate-extract-revision-at-line ()
3219 "Extract the revision number of the current line."
3220 ;; This function must be invoked from a buffer in vc-annotate-mode
3221 (vc-call-backend vc-annotate-backend 'annotate-extract-revision-at-line))
3223 (defun vc-annotate-revision-at-line ()
3224 "Visit the annotation of the version identified in the current line."
3226 (if (not (equal major-mode 'vc-annotate-mode))
3227 (message "Cannot be invoked outside of a vc annotate buffer")
3228 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
3229 (if (not rev-at-line)
3230 (message "Cannot extract revision number from the current line")
3231 (if (equal rev-at-line vc-annotate-parent-rev)
3232 (message "Already at version %s" rev-at-line)
3233 (vc-annotate-warp-version rev-at-line))))))
3235 (defun vc-annotate-revision-previous-to-line ()
3236 "Visit the annotation of the version before the version at line."
3238 (if (not (equal major-mode 'vc-annotate-mode))
3239 (message "Cannot be invoked outside of a vc annotate buffer")
3240 (let ((rev-at-line (vc-annotate-extract-revision-at-line))
3242 (if (not rev-at-line)
3243 (message "Cannot extract revision number from the current line")
3245 (vc-call previous-version vc-annotate-parent-file rev-at-line))
3246 (vc-annotate-warp-version prev-rev)))))
3248 (defun vc-annotate-show-log-revision-at-line ()
3249 "Visit the log of the version at line."
3251 (if (not (equal major-mode 'vc-annotate-mode))
3252 (message "Cannot be invoked outside of a vc annotate buffer")
3253 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
3254 (if (not rev-at-line)
3255 (message "Cannot extract revision number from the current line")
3256 (vc-print-log rev-at-line)))))
3258 (defun vc-annotate-show-diff-revision-at-line ()
3259 "Visit the diff of the version at line from its previous version."
3261 (if (not (equal major-mode 'vc-annotate-mode))
3262 (message "Cannot be invoked outside of a vc annotate buffer")
3263 (let ((rev-at-line (vc-annotate-extract-revision-at-line))
3265 (if (not rev-at-line)
3266 (message "Cannot extract revision number from the current line")
3268 (vc-call previous-version vc-annotate-parent-file rev-at-line))
3270 (message "Cannot diff from any version prior to %s" rev-at-line)
3271 (save-window-excursion
3272 (vc-version-diff vc-annotate-parent-file prev-rev rev-at-line))
3273 (switch-to-buffer "*vc-diff*"))))))
3275 (defun vc-annotate-warp-version (revspec)
3276 "Annotate the version described by REVSPEC.
3278 If REVSPEC is a positive integer, warp that many versions
3279 forward, if possible, otherwise echo a warning message. If
3280 REVSPEC is a negative integer, warp that many versions backward,
3281 if possible, otherwise echo a warning message. If REVSPEC is a
3282 string, then it describes a revision number, so warp to that
3284 (if (not (equal major-mode 'vc-annotate-mode))
3285 (message "Cannot be invoked outside of a vc annotate buffer")
3286 (let* ((buf (current-buffer))
3287 (oldline (line-number-at-pos))
3288 (revspeccopy revspec)
3291 ((and (integerp revspec) (> revspec 0))
3292 (setq newrev vc-annotate-parent-rev)
3293 (while (and (> revspec 0) newrev)
3294 (setq newrev (vc-call next-version
3295 vc-annotate-parent-file newrev))
3296 (setq revspec (1- revspec)))
3298 (message "Cannot increment %d versions from version %s"
3299 revspeccopy vc-annotate-parent-rev)))
3300 ((and (integerp revspec) (< revspec 0))
3301 (setq newrev vc-annotate-parent-rev)
3302 (while (and (< revspec 0) newrev)
3303 (setq newrev (vc-call previous-version
3304 vc-annotate-parent-file newrev))
3305 (setq revspec (1+ revspec)))
3307 (message "Cannot decrement %d versions from version %s"
3308 (- 0 revspeccopy) vc-annotate-parent-rev)))
3309 ((stringp revspec) (setq newrev revspec))
3310 (t (error "Invalid argument to vc-annotate-warp-version")))
3312 (vc-annotate vc-annotate-parent-file newrev
3313 vc-annotate-parent-display-mode
3315 (goto-line (min oldline (progn (goto-char (point-max))
3317 (line-number-at-pos))) buf)))))
3319 (defun vc-annotate-compcar (threshold a-list)
3320 "Test successive cons cells of A-LIST against THRESHOLD.
3321 Return the first cons cell with a car that is not less than THRESHOLD,
3322 nil if no such cell exists."
3324 (tmp-cons (car a-list)))
3325 (while (and tmp-cons (< (car tmp-cons) threshold))
3326 (setq tmp-cons (car (nthcdr i a-list)))
3328 tmp-cons)) ; Return the appropriate value
3330 (defun vc-annotate-convert-time (time)
3331 "Convert a time value to a floating-point number of days.
3332 The argument TIME is a list as returned by `current-time' or
3333 `encode-time', only the first two elements of that list are considered."
3334 (/ (+ (* (float (car time)) (lsh 1 16)) (cadr time)) 24 3600))
3336 (defun vc-annotate-difference (&optional offset)
3337 "Return the time span in days to the next annotation.
3338 This calls the backend function annotate-time, and returns the
3339 difference in days between the time returned and the current time,
3340 or OFFSET if present."
3341 (let ((next-time (vc-call-backend vc-annotate-backend 'annotate-time)))
3344 (vc-call-backend vc-annotate-backend 'annotate-current-time))
3347 (defun vc-default-annotate-current-time (backend)
3348 "Return the current time, encoded as fractional days."
3349 (vc-annotate-convert-time (current-time)))
3351 (defvar vc-annotate-offset nil)
3353 (defun vc-annotate-display (ratio &optional offset)
3354 "Highlight `vc-annotate' output in the current buffer.
3355 RATIO, is the expansion that should be applied to `vc-annotate-color-map'.
3356 The annotations are relative to the current time, unless overridden by OFFSET."
3358 (set (make-local-variable 'vc-annotate-color-map)
3359 (mapcar (lambda (elem) (cons (* (car elem) ratio) (cdr elem)))
3360 vc-annotate-color-map)))
3361 (set (make-local-variable 'vc-annotate-offset) offset)
3364 (defun vc-annotate-lines (limit)
3366 (while (and (< (point) limit)
3367 (setq difference (vc-annotate-difference vc-annotate-offset)))
3368 (let* ((color (or (vc-annotate-compcar difference vc-annotate-color-map)
3369 (cons nil vc-annotate-very-old-color)))
3370 ;; substring from index 1 to remove any leading `#' in the name
3371 (face-name (concat "vc-annotate-face-"
3373 (substring (cdr color) 0 1) "#")
3374 (substring (cdr color) 1)
3376 ;; Make the face if not done.
3377 (face (or (intern-soft face-name)
3378 (let ((tmp-face (make-face (intern face-name))))
3379 (set-face-foreground tmp-face (cdr color))
3380 (if vc-annotate-background
3381 (set-face-background tmp-face
3382 vc-annotate-background))
3383 tmp-face))) ; Return the face
3386 (put-text-property point (point) 'face face)))
3387 ;; Pretend to font-lock there were no matches.
3390 ;; Collect back-end-dependent stuff here
3392 (defalias 'vc-default-logentry-check 'ignore)
3394 (defun vc-check-headers ()
3395 "Check if the current file has any headers in it."
3397 (vc-call-backend (vc-backend buffer-file-name) 'check-headers))
3399 (defun vc-default-check-headers (backend)
3400 "Default implementation of check-headers; always returns nil."
3403 ;; Back-end-dependent stuff ends here.
3405 ;; Set up key bindings for use while editing log messages
3407 (defun vc-log-edit (file)
3408 "Set up `log-edit' for use with VC on FILE."
3409 (setq default-directory
3410 (if file (file-name-directory file)
3411 (with-current-buffer vc-parent-buffer default-directory)))
3412 (log-edit 'vc-finish-logentry nil
3413 (if file `(lambda () ',(list (file-name-nondirectory file)))
3414 ;; If FILE is nil, we were called from vc-dired.
3416 (with-current-buffer vc-parent-buffer
3417 (dired-get-marked-files t)))))
3418 (set (make-local-variable 'vc-log-file) file)
3419 (make-local-variable 'vc-log-version)
3420 (set-buffer-modified-p nil)
3421 (setq buffer-file-name nil))
3423 ;; These things should probably be generally available
3425 (defun vc-file-tree-walk (dirname func &rest args)
3426 "Walk recursively through DIRNAME.
3427 Invoke FUNC f ARGS on each VC-managed file f underneath it."
3428 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
3429 (message "Traversing directory %s...done" dirname))
3431 (defun vc-file-tree-walk-internal (file func args)
3432 (if (not (file-directory-p file))
3433 (if (vc-backend file) (apply func file args))
3434 (message "Traversing directory %s..." (abbreviate-file-name file))
3435 (let ((dir (file-name-as-directory file)))
3438 (string-equal f ".")
3439 (string-equal f "..")
3440 (member f vc-directory-exclusion-list)
3441 (let ((dirf (expand-file-name f dir)))
3443 (file-symlink-p dirf);; Avoid possible loops
3444 (vc-file-tree-walk-internal dirf func args)))))
3445 (directory-files dir)))))
3449 ;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
3451 ;; These may be useful to anyone who has to debug or extend the package.
3452 ;; (Note that this information corresponds to versions 5.x. Some of it
3453 ;; might have been invalidated by the additions to support branching
3454 ;; and RCS keyword lookup. AS, 1995/03/24)
3456 ;; A fundamental problem in VC is that there are time windows between
3457 ;; vc-next-action's computations of the file's version-control state and
3458 ;; the actions that change it. This is a window open to lossage in a
3459 ;; multi-user environment; someone else could nip in and change the state
3460 ;; of the master during it.
3462 ;; The performance problem is that rlog/prs calls are very expensive; we want
3463 ;; to avoid them as much as possible.
3467 ;; The performance problem, it turns out, simplifies in practice to the
3468 ;; problem of making vc-state fast. The two other functions that call
3469 ;; prs/rlog will not be so commonly used that the slowdown is a problem; one
3470 ;; makes snapshots, the other deletes the calling user's last change in the
3473 ;; The race condition implies that we have to either (a) lock the master
3474 ;; during the entire execution of vc-next-action, or (b) detect and
3475 ;; recover from errors resulting from dispatch on an out-of-date state.
3477 ;; Alternative (a) appears to be infeasible. The problem is that we can't
3478 ;; guarantee that the lock will ever be removed. Suppose a user starts a
3479 ;; checkin, the change message buffer pops up, and the user, having wandered
3480 ;; off to do something else, simply forgets about it?
3482 ;; Alternative (b), on the other hand, works well with a cheap way to speed up
3483 ;; vc-state. Usually, if a file is registered, we can read its locked/
3484 ;; unlocked state and its current owner from its permissions.
3486 ;; This shortcut will fail if someone has manually changed the workfile's
3487 ;; permissions; also if developers are munging the workfile in several
3488 ;; directories, with symlinks to a master (in this latter case, the
3489 ;; permissions shortcut will fail to detect a lock asserted from another
3492 ;; Note that these cases correspond exactly to the errors which could happen
3493 ;; because of a competing checkin/checkout race in between two instances of
3496 ;; For VC's purposes, a workfile/master pair may have the following states:
3498 ;; A. Unregistered. There is a workfile, there is no master.
3500 ;; B. Registered and not locked by anyone.
3502 ;; C. Locked by calling user and unchanged.
3504 ;; D. Locked by the calling user and changed.
3506 ;; E. Locked by someone other than the calling user.
3508 ;; This makes for 25 states and 20 error conditions. Here's the matrix:
3510 ;; VC's idea of state
3512 ;; V Actual state RCS action SCCS action Effect
3514 ;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
3515 ;; B 5 . 6 7 8 co -l get -e checkout
3516 ;; C 9 10 . 11 12 co -u unget; get revert
3517 ;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
3518 ;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
3520 ;; All commands take the master file name as a last argument (not shown).
3522 ;; In the discussion below, a "self-race" is a pathological situation in
3523 ;; which VC operations are being attempted simultaneously by two or more
3524 ;; Emacsen running under the same username.
3526 ;; The vc-next-action code has the following windows:
3529 ;; Between the check for existence of a master file and the call to
3530 ;; admin/checkin in vc-buffer-admin (apparent state A). This window may
3531 ;; never close if the initial-comment feature is on.
3534 ;; Between the call to vc-workfile-unchanged-p in and the immediately
3535 ;; following revert (apparent state C).
3538 ;; Between the call to vc-workfile-unchanged-p in and the following
3539 ;; checkin (apparent state D). This window may never close.
3542 ;; Between the unlock and the immediately following checkout during a
3543 ;; revert operation (apparent state C). Included in window Q.
3546 ;; Between vc-state and the following checkout (apparent state B).
3549 ;; Between vc-state and the following revert (apparent state C).
3550 ;; Includes windows Q and S.
3553 ;; Between vc-state and the following checkin (apparent state
3554 ;; D). This window may never be closed if the user fails to complete the
3555 ;; checkin message. Includes window R.
3558 ;; Between vc-state and the following steal-lock (apparent
3559 ;; state E). This window may never close if the user fails to complete
3560 ;; the steal-lock message. Includes window X.
3563 ;; Between the unlock and the immediately following re-lock during a
3564 ;; steal-lock operation (apparent state E). This window may never close
3565 ;; if the user fails to complete the steal-lock message.
3569 ;; Apparent state A ---
3571 ;; 1. File looked unregistered but is actually registered and not locked.
3573 ;; Potential cause: someone else's admin during window P, with
3574 ;; caller's admin happening before their checkout.
3576 ;; RCS: Prior to version 5.6.4, ci fails with message
3577 ;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
3578 ;; ci -i option and the message is "<file>,v: already exists".
3579 ;; SCCS: admin will fail with error (ad19).
3581 ;; We can let these errors be passed up to the user.
3583 ;; 2. File looked unregistered but is actually locked by caller, unchanged.
3585 ;; Potential cause: self-race during window P.
3587 ;; RCS: Prior to version 5.6.4, reverts the file to the last saved
3588 ;; version and unlocks it. From 5.6.4 onwards, VC uses the new
3589 ;; ci -i option, failing with message "<file>,v: already exists".
3590 ;; SCCS: will fail with error (ad19).
3592 ;; Either of these consequences is acceptable.
3594 ;; 3. File looked unregistered but is actually locked by caller, changed.
3596 ;; Potential cause: self-race during window P.
3598 ;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
3599 ;; a delta with a null change comment (the -t- switch will be
3600 ;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
3601 ;; failing with message "<file>,v: already exists".
3602 ;; SCCS: will fail with error (ad19).
3604 ;; 4. File looked unregistered but is locked by someone else.
3606 ;; Potential cause: someone else's admin during window P, with
3607 ;; caller's admin happening *after* their checkout.
3609 ;; RCS: Prior to version 5.6.4, ci fails with a
3610 ;; "no lock set by <user>" message. From 5.6.4 onwards,
3611 ;; VC uses the new ci -i option, failing with message
3612 ;; "<file>,v: already exists".
3613 ;; SCCS: will fail with error (ad19).
3615 ;; We can let these errors be passed up to the user.
3617 ;; Apparent state B ---
3619 ;; 5. File looked registered and not locked, but is actually unregistered.
3621 ;; Potential cause: master file got nuked during window P.
3623 ;; RCS: will fail with "RCS/<file>: No such file or directory"
3624 ;; SCCS: will fail with error ut4.
3626 ;; We can let these errors be passed up to the user.
3628 ;; 6. File looked registered and not locked, but is actually locked by the
3629 ;; calling user and unchanged.
3631 ;; Potential cause: self-race during window T.
3633 ;; RCS: in the same directory as the previous workfile, co -l will fail
3634 ;; with "co error: writable foo exists; checkout aborted". In any other
3635 ;; directory, checkout will succeed.
3636 ;; SCCS: will fail with ge17.
3638 ;; Either of these consequences is acceptable.
3640 ;; 7. File looked registered and not locked, but is actually locked by the
3641 ;; calling user and changed.
3645 ;; 8. File looked registered and not locked, but is actually locked by another
3648 ;; Potential cause: someone else checks it out during window T.
3650 ;; RCS: co error: revision 1.3 already locked by <user>
3651 ;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
3653 ;; We can let these errors be passed up to the user.
3655 ;; Apparent state C ---
3657 ;; 9. File looks locked by calling user and unchanged, but is unregistered.
3661 ;; 10. File looks locked by calling user and unchanged, but is actually not
3664 ;; Potential cause: a self-race in window U, or by the revert's
3665 ;; landing during window X of some other user's steal-lock or window S
3666 ;; of another user's revert.
3668 ;; RCS: succeeds, refreshing the file from the identical version in
3670 ;; SCCS: fails with error ut4 (p file nonexistent).
3672 ;; Either of these consequences is acceptable.
3674 ;; 11. File is locked by calling user. It looks unchanged, but is actually
3677 ;; Potential cause: the file would have to be touched by a self-race
3680 ;; The revert will succeed, removing whatever changes came with
3681 ;; the touch. It is theoretically possible that work could be lost.
3683 ;; 12. File looks like it's locked by the calling user and unchanged, but
3684 ;; it's actually locked by someone else.
3686 ;; Potential cause: a steal-lock in window V.
3688 ;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
3689 ;; SCCS: fails with error un2
3691 ;; We can pass these errors up to the user.
3693 ;; Apparent state D ---
3695 ;; 13. File looks like it's locked by the calling user and changed, but it's
3696 ;; actually unregistered.
3698 ;; Potential cause: master file got nuked during window P.
3700 ;; RCS: Prior to version 5.6.4, checks in the user's version as an
3701 ;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
3702 ;; option, failing with message "no such file or directory".
3703 ;; SCCS: will fail with error ut4.
3705 ;; This case is kind of nasty. Under RCS prior to version 5.6.4,
3706 ;; VC may fail to detect the loss of previous version information.
3708 ;; 14. File looks like it's locked by the calling user and changed, but it's
3709 ;; actually unlocked.
3711 ;; Potential cause: self-race in window V, or the checkin happening
3712 ;; during the window X of someone else's steal-lock or window S of
3713 ;; someone else's revert.
3715 ;; RCS: ci will fail with "no lock set by <user>".
3716 ;; SCCS: delta will fail with error ut4.
3718 ;; 15. File looks like it's locked by the calling user and changed, but it's
3719 ;; actually locked by the calling user and unchanged.
3721 ;; Potential cause: another self-race --- a whole checkin/checkout
3722 ;; sequence by the calling user would have to land in window R.
3724 ;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
3725 ;; RCS: reverts to the file state as of the second user's checkin, leaving
3726 ;; the file unlocked.
3728 ;; It is theoretically possible that work could be lost under RCS.
3730 ;; 16. File looks like it's locked by the calling user and changed, but it's
3731 ;; actually locked by a different user.
3733 ;; RCS: ci error: no lock set by <user>
3734 ;; SCCS: unget will fail with error un2
3736 ;; We can pass these errors up to the user.
3738 ;; Apparent state E ---
3740 ;; 17. File looks like it's locked by some other user, but it's actually
3745 ;; 18. File looks like it's locked by some other user, but it's actually
3748 ;; Potential cause: someone released a lock during window W.
3750 ;; RCS: The calling user will get the lock on the file.
3751 ;; SCCS: unget -n will fail with cm4.
3753 ;; Either of these consequences will be OK.
3755 ;; 19. File looks like it's locked by some other user, but it's actually
3756 ;; locked by the calling user and unchanged.
3758 ;; Potential cause: the other user relinquishing a lock followed by
3759 ;; a self-race, both in window W.
3761 ;; Under both RCS and SCCS, both unlock and lock will succeed, making
3762 ;; the sequence a no-op.
3764 ;; 20. File looks like it's locked by some other user, but it's actually
3765 ;; locked by the calling user and changed.
3771 ;; In order of decreasing severity:
3773 ;; Cases 11 and 15 are the only ones that potentially lose work.
3774 ;; They would require a self-race for this to happen.
3776 ;; Case 13 in RCS loses information about previous deltas, retaining
3777 ;; only the information in the current workfile. This can only happen
3778 ;; if the master file gets nuked in window P.
3780 ;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
3781 ;; no change comment in the master. This would require a self-race in
3782 ;; window P or R respectively.
3784 ;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
3786 ;; Unfortunately, it appears to me that no recovery is possible in these
3787 ;; cases. They don't yield error messages, so there's no way to tell that
3788 ;; a race condition has occurred.
3790 ;; All other cases don't change either the workfile or the master, and
3791 ;; trigger command errors which the user will see.
3793 ;; Thus, there is no explicit recovery code.
3795 ;; arch-tag: ca82c1de-3091-4e26-af92-460abc6213a6