Auto-commit of loaddefs files.
[emacs.git] / lisp / vc / vc.el
blob87e4e1c51249a85f0f08d66cee7acd26a194f291
1 ;;; vc.el --- drive a version-control system from within Emacs -*- lexical-binding: t -*-
3 ;; Copyright (C) 1992-1998, 2000-2012 Free Software Foundation, Inc.
5 ;; Author: FSF (see below for full credits)
6 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
7 ;; Keywords: vc tools
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
24 ;;; Credits:
26 ;; VC was initially designed and implemented by Eric S. Raymond
27 ;; <esr@thyrsus.com> in 1992. Over the years, many other people have
28 ;; contributed substantial amounts of work to VC. These include:
30 ;; Per Cederqvist <ceder@lysator.liu.se>
31 ;; Paul Eggert <eggert@twinsun.com>
32 ;; Sebastian Kremer <sk@thp.uni-koeln.de>
33 ;; Martin Lorentzson <martinl@gnu.org>
34 ;; Dave Love <fx@gnu.org>
35 ;; Stefan Monnier <monnier@cs.yale.edu>
36 ;; Thien-Thi Nguyen <ttn@gnu.org>
37 ;; Dan Nicolaescu <dann@ics.uci.edu>
38 ;; J.D. Smith <jdsmith@alum.mit.edu>
39 ;; Andre Spiegel <spiegel@gnu.org>
40 ;; Richard Stallman <rms@gnu.org>
42 ;; In July 2007 ESR returned and redesigned the mode to cope better
43 ;; with modern version-control systems that do commits by fileset
44 ;; rather than per individual file.
46 ;; If you maintain a client of the mode or customize it in your .emacs,
47 ;; note that some backend functions which formerly took single file arguments
48 ;; now take a list of files. These include: register, checkin, print-log,
49 ;; rollback, and diff.
51 ;;; Commentary:
53 ;; This mode is fully documented in the Emacs user's manual.
55 ;; Supported version-control systems presently include CVS, RCS, GNU
56 ;; Arch, Subversion, Bzr, Git, Mercurial, Monotone and SCCS
57 ;; (or its free replacement, CSSC).
59 ;; If your site uses the ChangeLog convention supported by Emacs, the
60 ;; function `log-edit-comment-to-change-log' could prove a useful checkin hook,
61 ;; although you might prefer to use C-c C-a (i.e. `log-edit-insert-changelog')
62 ;; from the commit buffer instead or to set `log-edit-setup-invert'.
64 ;; When using SCCS, RCS, CVS: be careful not to do repo surgery, or
65 ;; operations like registrations and deletions and renames, outside VC
66 ;; while VC is running. The support for these systems was designed
67 ;; when disks were much slower, and the code maintains a lot of
68 ;; internal state in order to reduce expensive operations to a
69 ;; minimum. Thus, if you mess with the repo while VC's back is turned,
70 ;; VC may get seriously confused.
72 ;; When using Subversion or a later system, anything you do outside VC
73 ;; *through the VCS tools* should safely interlock with VC
74 ;; operations. Under these VC does little state caching, because local
75 ;; operations are assumed to be fast. The dividing line is
77 ;; ADDING SUPPORT FOR OTHER BACKENDS
79 ;; VC can use arbitrary version control systems as a backend. To add
80 ;; support for a new backend named SYS, write a library vc-sys.el that
81 ;; contains functions of the form `vc-sys-...' (note that SYS is in lower
82 ;; case for the function and library names). VC will use that library if
83 ;; you put the symbol SYS somewhere into the list of
84 ;; `vc-handled-backends'. Then, for example, if `vc-sys-registered'
85 ;; returns non-nil for a file, all SYS-specific versions of VC commands
86 ;; will be available for that file.
88 ;; VC keeps some per-file information in the form of properties (see
89 ;; vc-file-set/getprop in vc-hooks.el). The backend-specific functions
90 ;; do not generally need to be aware of these properties. For example,
91 ;; `vc-sys-working-revision' should compute the working revision and
92 ;; return it; it should not look it up in the property, and it needn't
93 ;; store it there either. However, if a backend-specific function does
94 ;; store a value in a property, that value takes precedence over any
95 ;; value that the generic code might want to set (check for uses of
96 ;; the macro `with-vc-properties' in vc.el).
98 ;; In the list of functions below, each identifier needs to be prepended
99 ;; with `vc-sys-'. Some of the functions are mandatory (marked with a
100 ;; `*'), others are optional (`-').
102 ;; BACKEND PROPERTIES
104 ;; * revision-granularity
106 ;; Takes no arguments. Returns either 'file or 'repository. Backends
107 ;; that return 'file have per-file revision numbering; backends
108 ;; that return 'repository have per-repository revision numbering,
109 ;; so a revision level implicitly identifies a changeset
111 ;; STATE-QUERYING FUNCTIONS
113 ;; * registered (file)
115 ;; Return non-nil if FILE is registered in this backend. Both this
116 ;; function as well as `state' should be careful to fail gracefully
117 ;; in the event that the backend executable is absent. It is
118 ;; preferable that this function's body is autoloaded, that way only
119 ;; calling vc-registered does not cause the backend to be loaded
120 ;; (all the vc-FOO-registered functions are called to try to find
121 ;; the controlling backend for FILE.
123 ;; * state (file)
125 ;; Return the current version control state of FILE. For a list of
126 ;; possible values, see `vc-state'. This function should do a full and
127 ;; reliable state computation; it is usually called immediately after
128 ;; C-x v v. If you want to use a faster heuristic when visiting a
129 ;; file, put that into `state-heuristic' below. Note that under most
130 ;; VCSes this won't be called at all, dir-status is used instead.
132 ;; - state-heuristic (file)
134 ;; If provided, this function is used to estimate the version control
135 ;; state of FILE at visiting time. It should be considerably faster
136 ;; than the implementation of `state'. For a list of possible values,
137 ;; see the doc string of `vc-state'.
139 ;; - dir-status (dir update-function)
141 ;; Produce RESULT: a list of lists of the form (FILE VC-STATE EXTRA)
142 ;; for the files in DIR.
143 ;; EXTRA can be used for backend specific information about FILE.
144 ;; If a command needs to be run to compute this list, it should be
145 ;; run asynchronously using (current-buffer) as the buffer for the
146 ;; command. When RESULT is computed, it should be passed back by
147 ;; doing: (funcall UPDATE-FUNCTION RESULT nil).
148 ;; If the backend uses a process filter, hence it produces partial results,
149 ;; they can be passed back by doing:
150 ;; (funcall UPDATE-FUNCTION RESULT t)
151 ;; and then do a (funcall UPDATE-FUNCTION RESULT nil)
152 ;; when all the results have been computed.
153 ;; To provide more backend specific functionality for `vc-dir'
154 ;; the following functions might be needed: `dir-extra-headers',
155 ;; `dir-printer', `extra-dir-menu' and `dir-status-files'.
157 ;; - dir-status-files (dir files default-state update-function)
159 ;; This function is identical to dir-status except that it should
160 ;; only report status for the specified FILES. Also it needs to
161 ;; report on all requested files, including up-to-date or ignored
162 ;; files. If not provided, the default is to consider that the files
163 ;; are in DEFAULT-STATE.
165 ;; - dir-extra-headers (dir)
167 ;; Return a string that will be added to the *vc-dir* buffer header.
169 ;; - dir-printer (fileinfo)
171 ;; Pretty print the `vc-dir-fileinfo' FILEINFO.
172 ;; If a backend needs to show more information than the default FILE
173 ;; and STATE in the vc-dir listing, it can store that extra
174 ;; information in `vc-dir-fileinfo->extra'. This function can be
175 ;; used to display that extra information in the *vc-dir* buffer.
177 ;; - status-fileinfo-extra (file)
179 ;; Compute `vc-dir-fileinfo->extra' for FILE.
181 ;; * working-revision (file)
183 ;; Return the working revision of FILE. This is the revision fetched
184 ;; by the last checkout or update, not necessarily the same thing as the
185 ;; head or tip revision. Should return "0" for a file added but not yet
186 ;; committed.
188 ;; - latest-on-branch-p (file)
190 ;; Return non-nil if the working revision of FILE is the latest revision
191 ;; on its branch (many VCSes call this the 'tip' or 'head' revision).
192 ;; The default implementation always returns t, which means that
193 ;; working with non-current revisions is not supported by default.
195 ;; * checkout-model (files)
197 ;; Indicate whether FILES need to be "checked out" before they can be
198 ;; edited. See `vc-checkout-model' for a list of possible values.
200 ;; - workfile-unchanged-p (file)
202 ;; Return non-nil if FILE is unchanged from the working revision.
203 ;; This function should do a brief comparison of FILE's contents
204 ;; with those of the repository copy of the working revision. If
205 ;; the backend does not have such a brief-comparison feature, the
206 ;; default implementation of this function can be used, which
207 ;; delegates to a full vc-BACKEND-diff. (Note that vc-BACKEND-diff
208 ;; must not run asynchronously in this case, see variable
209 ;; `vc-disable-async-diff'.)
211 ;; - mode-line-string (file)
213 ;; If provided, this function should return the VC-specific mode
214 ;; line string for FILE. The returned string should have a
215 ;; `help-echo' property which is the text to be displayed as a
216 ;; tooltip when the mouse hovers over the VC entry on the mode-line.
217 ;; The default implementation deals well with all states that
218 ;; `vc-state' can return.
220 ;; STATE-CHANGING FUNCTIONS
222 ;; * create-repo (backend)
224 ;; Create an empty repository in the current directory and initialize
225 ;; it so VC mode can add files to it. For file-oriented systems, this
226 ;; need do no more than create a subdirectory with the right name.
228 ;; * register (files &optional rev comment)
230 ;; Register FILES in this backend. Optionally, an initial revision REV
231 ;; and an initial description of the file, COMMENT, may be specified,
232 ;; but it is not guaranteed that the backend will do anything with this.
233 ;; The implementation should pass the value of vc-register-switches
234 ;; to the backend command. (Note: in older versions of VC, this
235 ;; command took a single file argument and not a list.)
237 ;; - init-revision (file)
239 ;; The initial revision to use when registering FILE if one is not
240 ;; specified by the user. If not provided, the variable
241 ;; vc-default-init-revision is used instead.
243 ;; - responsible-p (file)
245 ;; Return non-nil if this backend considers itself "responsible" for
246 ;; FILE, which can also be a directory. This function is used to find
247 ;; out what backend to use for registration of new files and for things
248 ;; like change log generation. The default implementation always
249 ;; returns nil.
251 ;; - could-register (file)
253 ;; Return non-nil if FILE could be registered under this backend. The
254 ;; default implementation always returns t.
256 ;; - receive-file (file rev)
258 ;; Let this backend "receive" a file that is already registered under
259 ;; another backend. The default implementation simply calls `register'
260 ;; for FILE, but it can be overridden to do something more specific,
261 ;; e.g. keep revision numbers consistent or choose editing modes for
262 ;; FILE that resemble those of the other backend.
264 ;; - unregister (file)
266 ;; Unregister FILE from this backend. This is only needed if this
267 ;; backend may be used as a "more local" backend for temporary editing.
269 ;; * checkin (files rev comment)
271 ;; Commit changes in FILES to this backend. REV is a historical artifact
272 ;; and should be ignored. COMMENT is used as a check-in comment.
273 ;; The implementation should pass the value of vc-checkin-switches to
274 ;; the backend command.
276 ;; * find-revision (file rev buffer)
278 ;; Fetch revision REV of file FILE and put it into BUFFER.
279 ;; If REV is the empty string, fetch the head of the trunk.
280 ;; The implementation should pass the value of vc-checkout-switches
281 ;; to the backend command.
283 ;; * checkout (file &optional editable rev)
285 ;; Check out revision REV of FILE into the working area. If EDITABLE
286 ;; is non-nil, FILE should be writable by the user and if locking is
287 ;; used for FILE, a lock should also be set. If REV is non-nil, that
288 ;; is the revision to check out (default is the working revision).
289 ;; If REV is t, that means to check out the head of the current branch;
290 ;; if it is the empty string, check out the head of the trunk.
291 ;; The implementation should pass the value of vc-checkout-switches
292 ;; to the backend command.
294 ;; * revert (file &optional contents-done)
296 ;; Revert FILE back to the working revision. If optional
297 ;; arg CONTENTS-DONE is non-nil, then the contents of FILE have
298 ;; already been reverted from a version backup, and this function
299 ;; only needs to update the status of FILE within the backend.
300 ;; If FILE is in the `added' state it should be returned to the
301 ;; `unregistered' state.
303 ;; - rollback (files)
305 ;; Remove the tip revision of each of FILES from the repository. If
306 ;; this function is not provided, trying to cancel a revision is
307 ;; caught as an error. (Most backends don't provide it.) (Also
308 ;; note that older versions of this backend command were called
309 ;; 'cancel-version' and took a single file arg, not a list of
310 ;; files.)
312 ;; - merge (file rev1 rev2)
314 ;; Merge the changes between REV1 and REV2 into the current working file
315 ;; (for non-distributed VCS).
317 ;; - merge-branch ()
319 ;; Merge another branch into the current one, prompting for a
320 ;; location to merge from.
322 ;; - merge-news (file)
324 ;; Merge recent changes from the current branch into FILE.
325 ;; (for non-distributed VCS).
327 ;; - pull (prompt)
329 ;; Pull "upstream" changes into the current branch (for distributed
330 ;; VCS). If PROMPT is non-nil, or if necessary, prompt for a
331 ;; location to pull from.
333 ;; - steal-lock (file &optional revision)
335 ;; Steal any lock on the working revision of FILE, or on REVISION if
336 ;; that is provided. This function is only needed if locking is
337 ;; used for files under this backend, and if files can indeed be
338 ;; locked by other users.
340 ;; - modify-change-comment (files rev comment)
342 ;; Modify the change comments associated with the files at the
343 ;; given revision. This is optional, many backends do not support it.
345 ;; - mark-resolved (files)
347 ;; Mark conflicts as resolved. Some VC systems need to run a
348 ;; command to mark conflicts as resolved.
350 ;; HISTORY FUNCTIONS
352 ;; * print-log (files buffer &optional shortlog start-revision limit)
354 ;; Insert the revision log for FILES into BUFFER.
355 ;; If SHORTLOG is true insert a short version of the log.
356 ;; If LIMIT is true insert only insert LIMIT log entries. If the
357 ;; backend does not support limiting the number of entries to show
358 ;; it should return `limit-unsupported'.
359 ;; If START-REVISION is given, then show the log starting from the
360 ;; revision. At this point START-REVISION is only required to work
361 ;; in conjunction with LIMIT = 1.
363 ;; * log-outgoing (backend remote-location)
365 ;; Insert in BUFFER the revision log for the changes that will be
366 ;; sent when performing a push operation to REMOTE-LOCATION.
368 ;; * log-incoming (backend remote-location)
370 ;; Insert in BUFFER the revision log for the changes that will be
371 ;; received when performing a pull operation from REMOTE-LOCATION.
373 ;; - log-view-mode ()
375 ;; Mode to use for the output of print-log. This defaults to
376 ;; `log-view-mode' and is expected to be changed (if at all) to a derived
377 ;; mode of `log-view-mode'.
379 ;; - show-log-entry (revision)
381 ;; If provided, search the log entry for REVISION in the current buffer,
382 ;; and make sure it is displayed in the buffer's window. The default
383 ;; implementation of this function works for RCS-style logs.
385 ;; - comment-history (file)
387 ;; Return a string containing all log entries that were made for FILE.
388 ;; This is used for transferring a file from one backend to another,
389 ;; retaining comment information.
391 ;; - update-changelog (files)
393 ;; Using recent log entries, create ChangeLog entries for FILES, or for
394 ;; all files at or below the default-directory if FILES is nil. The
395 ;; default implementation runs rcs2log, which handles RCS- and
396 ;; CVS-style logs.
398 ;; * diff (files &optional rev1 rev2 buffer)
400 ;; Insert the diff for FILE into BUFFER, or the *vc-diff* buffer if
401 ;; BUFFER is nil. If REV1 and REV2 are non-nil, report differences
402 ;; from REV1 to REV2. If REV1 is nil, use the working revision (as
403 ;; found in the repository) as the older revision; if REV2 is nil,
404 ;; use the current working-copy contents as the newer revision. This
405 ;; function should pass the value of (vc-switches BACKEND 'diff) to
406 ;; the backend command. It should return a status of either 0 (no
407 ;; differences found), or 1 (either non-empty diff or the diff is
408 ;; run asynchronously).
410 ;; - revision-completion-table (files)
412 ;; Return a completion table for existing revisions of FILES.
413 ;; The default is to not use any completion table.
415 ;; - annotate-command (file buf &optional rev)
417 ;; If this function is provided, it should produce an annotated display
418 ;; of FILE in BUF, relative to revision REV. Annotation means each line
419 ;; of FILE displayed is prefixed with version information associated with
420 ;; its addition (deleted lines leave no history) and that the text of the
421 ;; file is fontified according to age.
423 ;; - annotate-time ()
425 ;; Only required if `annotate-command' is defined for the backend.
426 ;; Return the time of the next line of annotation at or after point,
427 ;; as a floating point fractional number of days. The helper
428 ;; function `vc-annotate-convert-time' may be useful for converting
429 ;; multi-part times as returned by `current-time' and `encode-time'
430 ;; to this format. Return nil if no more lines of annotation appear
431 ;; in the buffer. You can safely assume that point is placed at the
432 ;; beginning of each line, starting at `point-min'. The buffer that
433 ;; point is placed in is the Annotate output, as defined by the
434 ;; relevant backend. This function also affects how much of the line
435 ;; is fontified; where it leaves point is where fontification begins.
437 ;; - annotate-current-time ()
439 ;; Only required if `annotate-command' is defined for the backend,
440 ;; AND you'd like the current time considered to be anything besides
441 ;; (vc-annotate-convert-time (current-time)) -- i.e. the current
442 ;; time with hours, minutes, and seconds included. Probably safe to
443 ;; ignore. Return the current-time, in units of fractional days.
445 ;; - annotate-extract-revision-at-line ()
447 ;; Only required if `annotate-command' is defined for the backend.
448 ;; Invoked from a buffer in vc-annotate-mode, return the revision
449 ;; corresponding to the current line, or nil if there is no revision
450 ;; corresponding to the current line.
451 ;; If the backend supports annotating through copies and renames,
452 ;; and displays a file name and a revision, then return a cons
453 ;; (REVISION . FILENAME).
455 ;; TAG SYSTEM
457 ;; - create-tag (dir name branchp)
459 ;; Attach the tag NAME to the state of the working copy. This
460 ;; should make sure that files are up-to-date before proceeding with
461 ;; the action. DIR can also be a file and if BRANCHP is specified,
462 ;; NAME should be created as a branch and DIR should be checked out
463 ;; under this new branch. The default implementation does not
464 ;; support branches but does a sanity check, a tree traversal and
465 ;; assigns the tag to each file.
467 ;; - retrieve-tag (dir name update)
469 ;; Retrieve the version tagged by NAME of all registered files at or below DIR.
470 ;; If UPDATE is non-nil, then update buffers of any files in the
471 ;; tag that are currently visited. The default implementation
472 ;; does a sanity check whether there aren't any uncommitted changes at
473 ;; or below DIR, and then performs a tree walk, using the `checkout'
474 ;; function to retrieve the corresponding revisions.
476 ;; MISCELLANEOUS
478 ;; - make-version-backups-p (file)
480 ;; Return non-nil if unmodified repository revisions of FILE should be
481 ;; backed up locally. If this is done, VC can perform `diff' and
482 ;; `revert' operations itself, without calling the backend system. The
483 ;; default implementation always returns nil.
485 ;; - root (file)
486 ;; Return the root of the VC controlled hierarchy for file.
488 ;; - repository-hostname (dirname)
490 ;; Return the hostname that the backend will have to contact
491 ;; in order to operate on a file in DIRNAME. If the return value
492 ;; is nil, it means that the repository is local.
493 ;; This function is used in `vc-stay-local-p' which backends can use
494 ;; for their convenience.
496 ;; - previous-revision (file rev)
498 ;; Return the revision number that precedes REV for FILE, or nil if no such
499 ;; revision exists.
501 ;; - next-revision (file rev)
503 ;; Return the revision number that follows REV for FILE, or nil if no such
504 ;; revision exists.
506 ;; - log-edit-mode ()
508 ;; Turn on the mode used for editing the check in log. This
509 ;; defaults to `log-edit-mode'. If changed, it should use a mode
510 ;; derived from`log-edit-mode'.
512 ;; - check-headers ()
514 ;; Return non-nil if the current buffer contains any version headers.
516 ;; - clear-headers ()
518 ;; In the current buffer, reset all version headers to their unexpanded
519 ;; form. This function should be provided if the state-querying code
520 ;; for this backend uses the version headers to determine the state of
521 ;; a file. This function will then be called whenever VC changes the
522 ;; version control state in such a way that the headers would give
523 ;; wrong information.
525 ;; - delete-file (file)
527 ;; Delete FILE and mark it as deleted in the repository. If this
528 ;; function is not provided, the command `vc-delete-file' will
529 ;; signal an error.
531 ;; - rename-file (old new)
533 ;; Rename file OLD to NEW, both in the working area and in the
534 ;; repository. If this function is not provided, the renaming
535 ;; will be done by (vc-delete-file old) and (vc-register new).
537 ;; - find-file-hook ()
539 ;; Operation called in current buffer when opening a file. This can
540 ;; be used by the backend to setup some local variables it might need.
542 ;; - extra-menu ()
544 ;; Return a menu keymap, the items in the keymap will appear at the
545 ;; end of the Version Control menu. The goal is to allow backends
546 ;; to specify extra menu items that appear in the VC menu. This way
547 ;; you can provide menu entries for functionality that is specific
548 ;; to your backend and which does not map to any of the VC generic
549 ;; concepts.
551 ;; - extra-dir-menu ()
553 ;; Return a menu keymap, the items in the keymap will appear at the
554 ;; end of the VC Status menu. The goal is to allow backends to
555 ;; specify extra menu items that appear in the VC Status menu. This
556 ;; makes it possible to provide menu entries for functionality that
557 ;; is specific to a backend and which does not map to any of the VC
558 ;; generic concepts.
560 ;; - conflicted-files (dir)
562 ;; Return the list of files where conflict resolution is needed in
563 ;; the project that contains DIR.
564 ;; FIXME: what should it do with non-text conflicts?
566 ;;; Todo:
568 ;; - Get rid of the "master file" terminology.
570 ;; - Add key-binding for vc-delete-file.
572 ;;;; New Primitives:
574 ;; - deal with push/pull operations.
576 ;; - add a mechanism for editing the underlying VCS's list of files
577 ;; to be ignored, when that's possible.
579 ;;;; Primitives that need changing:
581 ;; - vc-update/vc-merge should deal with VC systems that don't
582 ;; update/merge on a file basis, but on a whole repository basis.
583 ;; vc-update and vc-merge assume the arguments are always files,
584 ;; they don't deal with directories. Make sure the *vc-dir* buffer
585 ;; is updated after these operations.
586 ;; At least bzr, git and hg should benefit from this.
588 ;;;; Improved branch and tag handling:
590 ;; - add a generic mechanism for remembering the current branch names,
591 ;; display the branch name in the mode-line. Replace
592 ;; vc-cvs-sticky-tag with that.
594 ;;;; Internal cleanups:
596 ;; - backends that care about vc-stay-local should try to take it into
597 ;; account for vc-dir. Is this likely to be useful??? YES!
599 ;; - vc-expand-dirs should take a backend parameter and only look for
600 ;; files managed by that backend.
602 ;; - Another important thing: merge all the status-like backend operations.
603 ;; We should remove dir-status, state, and dir-status-files, and
604 ;; replace them with just `status' which takes a fileset and a continuation
605 ;; (like dir-status) and returns a buffer in which the process(es) are run
606 ;; (or nil if it worked synchronously). Hopefully we can define the old
607 ;; 4 operations in term of this one.
609 ;;;; Other
611 ;; - when a file is in `conflict' state, turn on smerge-mode.
613 ;; - figure out what to do with conflicts that are not caused by the
614 ;; file contents, but by metadata or other causes. Example: File A
615 ;; gets renamed to B in one branch and to C in another and you merge
616 ;; the two branches. Or you locally add file FOO and then pull a
617 ;; change that also adds a new file FOO, ...
619 ;; - make it easier to write logs. Maybe C-x 4 a should add to the log
620 ;; buffer, if one is present, instead of adding to the ChangeLog.
622 ;; - When vc-next-action calls vc-checkin it could pre-fill the
623 ;; *vc-log* buffer with some obvious items: the list of files that
624 ;; were added, the list of files that were removed. If the diff is
625 ;; available, maybe it could even call something like
626 ;; `diff-add-change-log-entries-other-window' to create a detailed
627 ;; skeleton for the log...
629 ;; - most vc-dir backends need more work. They might need to
630 ;; provide custom headers, use the `extra' field and deal with all
631 ;; possible VC states.
633 ;; - add a function that calls vc-dir to `find-directory-functions'.
635 ;; - vc-diff, vc-annotate, etc. need to deal better with unregistered
636 ;; files. Now that unregistered and ignored files are shown in
637 ;; vc-dir, it is possible that these commands are called
638 ;; for unregistered/ignored files.
640 ;; - vc-next-action needs work in order to work with multiple
641 ;; backends: `vc-state' returns the state for the default backend,
642 ;; not for the backend in the current *vc-dir* buffer.
644 ;; - vc-dir-kill-dir-status-process should not be specific to dir-status,
645 ;; it should work for other async commands done through vc-do-command
646 ;; as well,
648 ;; - vc-dir toolbar needs more icons.
650 ;; - The backends should avoid using `vc-file-setprop' and `vc-file-getprop'.
652 ;;; Code:
654 (require 'vc-hooks)
655 (require 'vc-dispatcher)
656 (require 'ediff)
658 (declare-function diff-setup-whitespace "diff-mode" ())
660 (eval-when-compile
661 (require 'cl)
662 (require 'dired))
664 (unless (assoc 'vc-parent-buffer minor-mode-alist)
665 (setq minor-mode-alist
666 (cons '(vc-parent-buffer vc-parent-buffer-name)
667 minor-mode-alist)))
669 ;; General customization
671 (defgroup vc nil
672 "Emacs interface to version control systems."
673 :group 'tools)
675 (defcustom vc-initial-comment nil
676 "If non-nil, prompt for initial comment when a file is registered."
677 :type 'boolean
678 :group 'vc)
680 (make-obsolete-variable 'vc-initial-comment "it has no effect." "23.2")
682 (defcustom vc-default-init-revision "1.1"
683 "A string used as the default revision number when a new file is registered.
684 This can be overridden by giving a prefix argument to \\[vc-register]. This
685 can also be overridden by a particular VC backend."
686 :type 'string
687 :group 'vc
688 :version "20.3")
690 (defcustom vc-checkin-switches nil
691 "A string or list of strings specifying extra switches for checkin.
692 These are passed to the checkin program by \\[vc-checkin]."
693 :type '(choice (const :tag "None" nil)
694 (string :tag "Argument String")
695 (repeat :tag "Argument List"
696 :value ("")
697 string))
698 :group 'vc)
700 (defcustom vc-checkout-switches nil
701 "A string or list of strings specifying extra switches for checkout.
702 These are passed to the checkout program by \\[vc-checkout]."
703 :type '(choice (const :tag "None" nil)
704 (string :tag "Argument String")
705 (repeat :tag "Argument List"
706 :value ("")
707 string))
708 :group 'vc)
710 (defcustom vc-register-switches nil
711 "A string or list of strings; extra switches for registering a file.
712 These are passed to the checkin program by \\[vc-register]."
713 :type '(choice (const :tag "None" nil)
714 (string :tag "Argument String")
715 (repeat :tag "Argument List"
716 :value ("")
717 string))
718 :group 'vc)
720 (defcustom vc-diff-switches nil
721 "A string or list of strings specifying switches for diff under VC.
722 When running diff under a given BACKEND, VC uses the first
723 non-nil value of `vc-BACKEND-diff-switches', `vc-diff-switches',
724 and `diff-switches', in that order. Since nil means to check the
725 next variable in the sequence, either of the first two may use
726 the value t to mean no switches at all. `vc-diff-switches'
727 should contain switches that are specific to version control, but
728 not specific to any particular backend."
729 :type '(choice (const :tag "Unspecified" nil)
730 (const :tag "None" t)
731 (string :tag "Argument String")
732 (repeat :tag "Argument List" :value ("") string))
733 :group 'vc
734 :version "21.1")
736 (defcustom vc-diff-knows-L nil
737 "Indicates whether diff understands the -L option.
738 The value is either `yes', `no', or nil. If it is nil, VC tries
739 to use -L and sets this variable to remember whether it worked."
740 :type '(choice (const :tag "Work out" nil) (const yes) (const no))
741 :group 'vc)
743 (defcustom vc-log-show-limit 2000
744 "Limit the number of items shown by the VC log commands.
745 Zero means unlimited.
746 Not all VC backends are able to support this feature."
747 :type 'integer
748 :group 'vc)
750 (defcustom vc-allow-async-revert nil
751 "Specifies whether the diff during \\[vc-revert] may be asynchronous.
752 Enabling this option means that you can confirm a revert operation even
753 if the local changes in the file have not been found and displayed yet."
754 :type '(choice (const :tag "No" nil)
755 (const :tag "Yes" t))
756 :group 'vc
757 :version "22.1")
759 ;;;###autoload
760 (defcustom vc-checkout-hook nil
761 "Normal hook (list of functions) run after checking out a file.
762 See `run-hooks'."
763 :type 'hook
764 :group 'vc
765 :version "21.1")
767 ;;;###autoload
768 (defcustom vc-checkin-hook nil
769 "Normal hook (list of functions) run after commit or file checkin.
770 See also `log-edit-done-hook'."
771 :type 'hook
772 :options '(log-edit-comment-to-change-log)
773 :group 'vc)
775 ;;;###autoload
776 (defcustom vc-before-checkin-hook nil
777 "Normal hook (list of functions) run before a commit or a file checkin.
778 See `run-hooks'."
779 :type 'hook
780 :group 'vc)
782 (defcustom vc-revert-show-diff t
783 "If non-nil, `vc-revert' shows a `vc-diff' buffer before querying."
784 :type 'boolean
785 :group 'vc
786 :version "24.1")
788 ;; Header-insertion hair
790 (defcustom vc-static-header-alist
791 '(("\\.c\\'" .
792 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
793 "Associate static header string templates with file types.
794 A \%s in the template is replaced with the first string associated with
795 the file's version control type in `vc-BACKEND-header'."
796 :type '(repeat (cons :format "%v"
797 (regexp :tag "File Type")
798 (string :tag "Header String")))
799 :group 'vc)
801 (defcustom vc-comment-alist
802 '((nroff-mode ".\\\"" ""))
803 "Special comment delimiters for generating VC headers.
804 Add an entry in this list if you need to override the normal `comment-start'
805 and `comment-end' variables. This will only be necessary if the mode language
806 is sensitive to blank lines."
807 :type '(repeat (list :format "%v"
808 (symbol :tag "Mode")
809 (string :tag "Comment Start")
810 (string :tag "Comment End")))
811 :group 'vc)
813 (defcustom vc-checkout-carefully (= (user-uid) 0)
814 "Non-nil means be extra-careful in checkout.
815 Verify that the file really is not locked
816 and that its contents match what the repository version says."
817 :type 'boolean
818 :group 'vc)
819 (make-obsolete-variable 'vc-checkout-carefully
820 "the corresponding checks are always done now."
821 "21.1")
824 ;; Variables users don't need to see
826 (defvar vc-disable-async-diff nil
827 "VC sets this to t locally to disable some async diff operations.
828 Backends that offer asynchronous diffs should respect this variable
829 in their implementation of vc-BACKEND-diff.")
831 ;; File property caching
833 (defun vc-clear-context ()
834 "Clear all cached file properties."
835 (interactive)
836 (fillarray vc-file-prop-obarray 0))
838 (defmacro with-vc-properties (files form settings)
839 "Execute FORM, then maybe set per-file properties for FILES.
840 If any of FILES is actually a directory, then do the same for all
841 buffers for files in that directory.
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."
845 (declare (debug t))
846 `(let ((vc-touched-properties (list t))
847 (flist nil))
848 (dolist (file ,files)
849 (if (file-directory-p file)
850 (dolist (buffer (buffer-list))
851 (let ((fname (buffer-file-name buffer)))
852 (when (and fname (string-prefix-p file fname))
853 (push fname flist))))
854 (push file flist)))
855 ,form
856 (dolist (file flist)
857 (dolist (setting ,settings)
858 (let ((property (car setting)))
859 (unless (memq property vc-touched-properties)
860 (put (intern file vc-file-prop-obarray)
861 property (cdr setting))))))))
863 ;;; Code for deducing what fileset and backend to assume
865 (defun vc-backend-for-registration (file)
866 "Return a backend that can be used for registering FILE.
868 If no backend declares itself responsible for FILE, then FILE
869 must not be in a version controlled directory, so try to create a
870 repository, prompting for the directory and the VC backend to
871 use."
872 (catch 'found
873 ;; First try: find a responsible backend, it must be a backend
874 ;; under which FILE is not yet registered.
875 (dolist (backend vc-handled-backends)
876 (and (not (vc-call-backend backend 'registered file))
877 (vc-call-backend backend 'responsible-p file)
878 (throw 'found backend)))
879 ;; no responsible backend
880 (let* ((possible-backends
881 (let (pos)
882 (dolist (crt vc-handled-backends)
883 (when (vc-find-backend-function crt 'create-repo)
884 (push crt pos)))
885 pos))
887 (intern
888 ;; Read the VC backend from the user, only
889 ;; complete with the backends that have the
890 ;; 'create-repo method.
891 (completing-read
892 (format "%s is not in a version controlled directory.\nUse VC backend: " file)
893 (mapcar 'symbol-name possible-backends) nil t)))
894 (repo-dir
895 (let ((def-dir (file-name-directory file)))
896 ;; read the directory where to create the
897 ;; repository, make sure it's a parent of
898 ;; file.
899 (read-file-name
900 (format "create %s repository in: " bk)
901 default-directory def-dir t nil
902 (lambda (arg)
903 (message "arg %s" arg)
904 (and (file-directory-p arg)
905 (string-prefix-p (expand-file-name arg) def-dir)))))))
906 (let ((default-directory repo-dir))
907 (vc-call-backend bk 'create-repo))
908 (throw 'found bk))))
910 (defun vc-responsible-backend (file)
911 "Return the name of a backend system that is responsible for FILE.
913 If FILE is already registered, return the
914 backend of FILE. If FILE is not registered, then the
915 first backend in `vc-handled-backends' that declares itself
916 responsible for FILE is returned."
917 (or (and (not (file-directory-p file)) (vc-backend file))
918 (catch 'found
919 ;; First try: find a responsible backend. If this is for registration,
920 ;; it must be a backend under which FILE is not yet registered.
921 (dolist (backend vc-handled-backends)
922 (and (vc-call-backend backend 'responsible-p file)
923 (throw 'found backend))))
924 (error "No VC backend is responsible for %s" file)))
926 (defun vc-expand-dirs (file-or-dir-list)
927 "Expands directories in a file list specification.
928 Within directories, only files already under version control are noticed."
929 (let ((flattened '()))
930 (dolist (node file-or-dir-list)
931 (when (file-directory-p node)
932 (vc-file-tree-walk
933 node (lambda (f) (when (vc-backend f) (push f flattened)))))
934 (unless (file-directory-p node) (push node flattened)))
935 (nreverse flattened)))
937 (defvar vc-dir-backend)
938 (defvar log-view-vc-backend)
939 (defvar diff-vc-backend)
941 (defun vc-deduce-backend ()
942 (cond ((derived-mode-p 'vc-dir-mode) vc-dir-backend)
943 ((derived-mode-p 'log-view-mode) log-view-vc-backend)
944 ((derived-mode-p 'diff-mode) diff-vc-backend)
945 ;; Maybe we could even use comint-mode rather than shell-mode?
946 ((derived-mode-p 'dired-mode 'shell-mode 'compilation-mode)
947 (vc-responsible-backend default-directory))
948 (vc-mode (vc-backend buffer-file-name))))
950 (declare-function vc-dir-current-file "vc-dir" ())
951 (declare-function vc-dir-deduce-fileset "vc-dir" (&optional state-model-only-files))
953 (defun vc-deduce-fileset (&optional observer allow-unregistered
954 state-model-only-files)
955 "Deduce a set of files and a backend to which to apply an operation.
956 Return (BACKEND FILESET FILESET-ONLY-FILES STATE CHECKOUT-MODEL).
958 If we're in VC-dir mode, FILESET is the list of marked files.
959 Otherwise, if in a buffer visiting a version-controlled file,
960 FILESET is a single-file fileset containing that file.
961 Otherwise, if ALLOW-UNREGISTERED is non-nil and the visited file
962 is unregistered, FILESET is a single-file fileset containing it.
963 Otherwise, throw an error.
965 STATE-MODEL-ONLY-FILES if non-nil, means that the caller needs
966 the FILESET-ONLY-FILES STATE and MODEL info. Otherwise, that
967 part may be skipped.
968 BEWARE: this function may change the
969 current buffer."
970 ;; FIXME: OBSERVER is unused. The name is not intuitive and is not
971 ;; documented. It's set to t when called from diff and print-log.
972 (let (backend)
973 (cond
974 ((derived-mode-p 'vc-dir-mode)
975 (vc-dir-deduce-fileset state-model-only-files))
976 ((derived-mode-p 'dired-mode)
977 (if observer
978 (vc-dired-deduce-fileset)
979 (error "State changing VC operations not supported in `dired-mode'")))
980 ((setq backend (vc-backend buffer-file-name))
981 (if state-model-only-files
982 (list backend (list buffer-file-name)
983 (list buffer-file-name)
984 (vc-state buffer-file-name)
985 (vc-checkout-model backend buffer-file-name))
986 (list backend (list buffer-file-name))))
987 ((and (buffer-live-p vc-parent-buffer)
988 ;; FIXME: Why this test? --Stef
989 (or (buffer-file-name vc-parent-buffer)
990 (with-current-buffer vc-parent-buffer
991 (derived-mode-p 'vc-dir-mode))))
992 (progn ;FIXME: Why not `with-current-buffer'? --Stef.
993 (set-buffer vc-parent-buffer)
994 (vc-deduce-fileset observer allow-unregistered state-model-only-files)))
995 ((not buffer-file-name)
996 (error "Buffer %s is not associated with a file" (buffer-name)))
997 ((and allow-unregistered (not (vc-registered buffer-file-name)))
998 (if state-model-only-files
999 (list (vc-backend-for-registration (buffer-file-name))
1000 (list buffer-file-name)
1001 (list buffer-file-name)
1002 (when state-model-only-files 'unregistered)
1003 nil)
1004 (list (vc-backend-for-registration (buffer-file-name))
1005 (list buffer-file-name))))
1006 (t (error "No fileset is available here")))))
1008 (defun vc-dired-deduce-fileset ()
1009 (let ((backend (vc-responsible-backend default-directory)))
1010 (unless backend (error "Directory not under VC"))
1011 (list backend
1012 (dired-map-over-marks (dired-get-filename nil t) nil))))
1014 (defun vc-ensure-vc-buffer ()
1015 "Make sure that the current buffer visits a version-controlled file."
1016 (cond
1017 ((derived-mode-p 'vc-dir-mode)
1018 (set-buffer (find-file-noselect (vc-dir-current-file))))
1020 (while (and vc-parent-buffer
1021 (buffer-live-p vc-parent-buffer)
1022 ;; Avoid infinite looping when vc-parent-buffer and
1023 ;; current buffer are the same buffer.
1024 (not (eq vc-parent-buffer (current-buffer))))
1025 (set-buffer vc-parent-buffer))
1026 (if (not buffer-file-name)
1027 (error "Buffer %s is not associated with a file" (buffer-name))
1028 (unless (vc-backend buffer-file-name)
1029 (error "File %s is not under version control" buffer-file-name))))))
1031 ;;; Support for the C-x v v command.
1032 ;; This is where all the single-file-oriented code from before the fileset
1033 ;; rewrite lives.
1035 (defsubst vc-editable-p (file)
1036 "Return non-nil if FILE can be edited."
1037 (let ((backend (vc-backend file)))
1038 (and backend
1039 (or (eq (vc-checkout-model backend (list file)) 'implicit)
1040 (memq (vc-state file) '(edited needs-merge conflict))))))
1042 (defun vc-compatible-state (p q)
1043 "Controls which states can be in the same commit."
1045 (eq p q)
1046 (and (member p '(edited added removed)) (member q '(edited added removed)))))
1048 ;; Here's the major entry point.
1050 ;;;###autoload
1051 (defun vc-next-action (verbose)
1052 "Do the next logical version control operation on the current fileset.
1053 This requires that all files in the current VC fileset be in the
1054 same state. If not, signal an error.
1056 For merging-based version control systems:
1057 If every file in the VC fileset is not registered for version
1058 control, register the fileset (but don't commit).
1059 If every work file in the VC fileset is added or changed, pop
1060 up a *vc-log* buffer to commit the fileset.
1061 For a centralized version control system, if any work file in
1062 the VC fileset is out of date, offer to update the fileset.
1064 For old-style locking-based version control systems, like RCS:
1065 If every file is not registered, register the file(s).
1066 If every file is registered and unlocked, check out (lock)
1067 the file(s) for editing.
1068 If every file is locked by you and has changes, pop up a
1069 *vc-log* buffer to check in the changes. If the variable
1070 `vc-keep-workfiles' is non-nil (the default), leave a
1071 read-only copy of each changed file after checking in.
1072 If every file is locked by you and unchanged, unlock them.
1073 If every file is locked by someone else, offer to steal the lock."
1074 (interactive "P")
1075 (let* ((vc-fileset (vc-deduce-fileset nil t 'state-model-only-files))
1076 (backend (car vc-fileset))
1077 (files (nth 1 vc-fileset))
1078 ;; (fileset-only-files (nth 2 vc-fileset))
1079 ;; FIXME: We used to call `vc-recompute-state' here.
1080 (state (nth 3 vc-fileset))
1081 ;; The backend should check that the checkout-model is consistent
1082 ;; among all the `files'.
1083 (model (nth 4 vc-fileset)))
1085 ;; Do the right thing
1086 (cond
1087 ((eq state 'missing)
1088 (error "Fileset files are missing, so cannot be operated on"))
1089 ((eq state 'ignored)
1090 (error "Fileset files are ignored by the version-control system"))
1091 ((or (null state) (eq state 'unregistered))
1092 (vc-register nil vc-fileset))
1093 ;; Files are up-to-date, or need a merge and user specified a revision
1094 ((or (eq state 'up-to-date) (and verbose (eq state 'needs-update)))
1095 (cond
1096 (verbose
1097 ;; go to a different revision
1098 (let* ((revision
1099 (read-string "Branch, revision, or backend to move to: "))
1100 (revision-downcase (downcase revision)))
1101 (if (member
1102 revision-downcase
1103 (mapcar (lambda (arg) (downcase (symbol-name arg)))
1104 vc-handled-backends))
1105 (let ((vsym (intern-soft revision-downcase)))
1106 (dolist (file files) (vc-transfer-file file vsym)))
1107 (dolist (file files)
1108 (vc-checkout file (eq model 'implicit) revision)))))
1109 ((not (eq model 'implicit))
1110 ;; check the files out
1111 (dolist (file files) (vc-checkout file t)))
1113 ;; do nothing
1114 (message "Fileset is up-to-date"))))
1115 ;; Files have local changes
1116 ((vc-compatible-state state 'edited)
1117 (let ((ready-for-commit files))
1118 ;; If files are edited but read-only, give user a chance to correct.
1119 (dolist (file files)
1120 ;; If committing a mix of removed and edited files, the
1121 ;; fileset has state = 'edited. Rather than checking the
1122 ;; state of each individual file in the fileset, it seems
1123 ;; simplest to just check if the file exists. Bug#9781.
1124 (when (and (file-exists-p file) (not (file-writable-p file)))
1125 ;; Make the file+buffer read-write.
1126 (unless (y-or-n-p (format "%s is edited but read-only; make it writable and continue? " file))
1127 (error "Aborted"))
1128 ;; Maybe we somehow lost permissions on the directory.
1129 (condition-case nil
1130 (set-file-modes file (logior (file-modes file) 128))
1131 (error (error "Unable to make file writable")))
1132 (let ((visited (get-file-buffer file)))
1133 (when visited
1134 (with-current-buffer visited
1135 (toggle-read-only -1))))))
1136 ;; Allow user to revert files with no changes
1137 (save-excursion
1138 (dolist (file files)
1139 (let ((visited (get-file-buffer file)))
1140 ;; For files with locking, if the file does not contain
1141 ;; any changes, just let go of the lock, i.e. revert.
1142 (when (and (not (eq model 'implicit))
1143 (vc-workfile-unchanged-p file)
1144 ;; If buffer is modified, that means the user just
1145 ;; said no to saving it; in that case, don't revert,
1146 ;; because the user might intend to save after
1147 ;; finishing the log entry and committing.
1148 (not (and visited (buffer-modified-p))))
1149 (vc-revert-file file)
1150 (setq ready-for-commit (delete file ready-for-commit))))))
1151 ;; Remaining files need to be committed
1152 (if (not ready-for-commit)
1153 (message "No files remain to be committed")
1154 (if (not verbose)
1155 (vc-checkin ready-for-commit backend)
1156 (let* ((revision (read-string "New revision or backend: "))
1157 (revision-downcase (downcase revision)))
1158 (if (member
1159 revision-downcase
1160 (mapcar (lambda (arg) (downcase (symbol-name arg)))
1161 vc-handled-backends))
1162 (let ((vsym (intern revision-downcase)))
1163 (dolist (file files) (vc-transfer-file file vsym)))
1164 (vc-checkin ready-for-commit backend revision)))))))
1165 ;; locked by somebody else (locking VCSes only)
1166 ((stringp state)
1167 ;; In the old days, we computed the revision once and used it on
1168 ;; the single file. Then, for the 2007-2008 fileset rewrite, we
1169 ;; computed the revision once (incorrectly, using a free var) and
1170 ;; used it on all files. To fix the free var bug, we can either
1171 ;; use `(car files)' or do what we do here: distribute the
1172 ;; revision computation among `files'. Although this may be
1173 ;; tedious for those backends where a "revision" is a trans-file
1174 ;; concept, it is nonetheless correct for both those and (more
1175 ;; importantly) for those where "revision" is a per-file concept.
1176 ;; If the intersection of the former group and "locking VCSes" is
1177 ;; non-empty [I vaguely doubt it --ttn], we can reinstate the
1178 ;; pre-computation approach of yore.
1179 (dolist (file files)
1180 (vc-steal-lock
1181 file (if verbose
1182 (read-string (format "%s revision to steal: " file))
1183 (vc-working-revision file))
1184 state)))
1185 ;; conflict
1186 ((eq state 'conflict)
1187 ;; FIXME: Is it really the UI we want to provide?
1188 ;; In my experience, the conflicted files should be marked as resolved
1189 ;; one-by-one when saving the file after resolving the conflicts.
1190 ;; I.e. stating explicitly that the conflicts are resolved is done
1191 ;; very rarely.
1192 (vc-mark-resolved backend files))
1193 ;; needs-update
1194 ((eq state 'needs-update)
1195 (dolist (file files)
1196 (if (yes-or-no-p (format
1197 "%s is not up-to-date. Get latest revision? "
1198 (file-name-nondirectory file)))
1199 (vc-checkout file (eq model 'implicit) t)
1200 (when (and (not (eq model 'implicit))
1201 (yes-or-no-p "Lock this revision? "))
1202 (vc-checkout file t)))))
1203 ;; needs-merge
1204 ((eq state 'needs-merge)
1205 (dolist (file files)
1206 (when (yes-or-no-p (format
1207 "%s is not up-to-date. Merge in changes now? "
1208 (file-name-nondirectory file)))
1209 (vc-maybe-resolve-conflicts
1210 file (vc-call-backend backend 'merge-news file)))))
1212 ;; unlocked-changes
1213 ((eq state 'unlocked-changes)
1214 (dolist (file files)
1215 (when (not (equal buffer-file-name file))
1216 (find-file-other-window file))
1217 (if (save-window-excursion
1218 (vc-diff-internal nil
1219 (cons (car vc-fileset) (cons (cadr vc-fileset) (list file)))
1220 (vc-working-revision file) nil)
1221 (goto-char (point-min))
1222 (let ((inhibit-read-only t))
1223 (insert
1224 (format "Changes to %s since last lock:\n\n" file)))
1225 (not (beep))
1226 (yes-or-no-p (concat "File has unlocked changes. "
1227 "Claim lock retaining changes? ")))
1228 (progn (vc-call-backend backend 'steal-lock file)
1229 (clear-visited-file-modtime)
1230 ;; Must clear any headers here because they wouldn't
1231 ;; show that the file is locked now.
1232 (vc-clear-headers file)
1233 (write-file buffer-file-name)
1234 (vc-mode-line file backend))
1235 (if (not (yes-or-no-p
1236 "Revert to checked-in revision, instead? "))
1237 (error "Checkout aborted")
1238 (vc-revert-buffer-internal t t)
1239 (vc-checkout file t)))))
1240 ;; Unknown fileset state
1242 (error "Fileset is in an unknown state %s" state)))))
1244 (defun vc-create-repo (backend)
1245 "Create an empty repository in the current directory."
1246 (interactive
1247 (list
1248 (intern
1249 (upcase
1250 (completing-read
1251 "Create repository for: "
1252 (mapcar (lambda (b) (list (downcase (symbol-name b)))) vc-handled-backends)
1253 nil t)))))
1254 (vc-call-backend backend 'create-repo))
1256 (declare-function vc-dir-move-to-goal-column "vc-dir" ())
1258 ;;;###autoload
1259 (defun vc-register (&optional set-revision vc-fileset comment)
1260 "Register into a version control system.
1261 If VC-FILESET is given, register the files in that fileset.
1262 Otherwise register the current file.
1263 With prefix argument SET-REVISION, allow user to specify initial revision
1264 level. If COMMENT is present, use that as an initial comment.
1266 The version control system to use is found by cycling through the list
1267 `vc-handled-backends'. The first backend in that list which declares
1268 itself responsible for the file (usually because other files in that
1269 directory are already registered under that backend) will be used to
1270 register the file. If no backend declares itself responsible, the
1271 first backend that could register the file is used."
1272 (interactive "P")
1273 (let* ((fileset-arg (or vc-fileset (vc-deduce-fileset nil t)))
1274 (backend (car fileset-arg))
1275 (files (nth 1 fileset-arg)))
1276 ;; We used to operate on `only-files', but VC wants to provide the
1277 ;; possibility to register directories rather than files only, since
1278 ;; many VCS allow that as well.
1279 (dolist (fname files)
1280 (let ((bname (get-file-buffer fname)))
1281 (unless fname (setq fname buffer-file-name))
1282 (when (vc-backend fname)
1283 (if (vc-registered fname)
1284 (error "This file is already registered")
1285 (unless (y-or-n-p "Previous master file has vanished. Make a new one? ")
1286 (error "Aborted"))))
1287 ;; Watch out for new buffers of size 0: the corresponding file
1288 ;; does not exist yet, even though buffer-modified-p is nil.
1289 (when bname
1290 (with-current-buffer bname
1291 (when (and (not (buffer-modified-p))
1292 (zerop (buffer-size))
1293 (not (file-exists-p buffer-file-name)))
1294 (set-buffer-modified-p t))
1295 (vc-buffer-sync)))))
1296 (message "Registering %s... " files)
1297 (mapc 'vc-file-clearprops files)
1298 (vc-call-backend backend 'register files
1299 (if set-revision
1300 (read-string (format "Initial revision level for %s: " files))
1301 (vc-call-backend backend 'init-revision))
1302 comment)
1303 (mapc
1304 (lambda (file)
1305 (vc-file-setprop file 'vc-backend backend)
1306 ;; FIXME: This is wrong: it should set `backup-inhibited' in all
1307 ;; the buffers visiting files affected by this `vc-register', not
1308 ;; in the current-buffer.
1309 ;; (unless vc-make-backup-files
1310 ;; (make-local-variable 'backup-inhibited)
1311 ;; (setq backup-inhibited t))
1313 (vc-resynch-buffer file vc-keep-workfiles t))
1314 files)
1315 (when (derived-mode-p 'vc-dir-mode)
1316 (vc-dir-move-to-goal-column))
1317 (message "Registering %s... done" files)))
1319 (defun vc-register-with (backend)
1320 "Register the current file with a specified back end."
1321 (interactive "SBackend: ")
1322 (when (not (member backend vc-handled-backends))
1323 (error "Unknown back end"))
1324 (let ((vc-handled-backends (list backend)))
1325 (call-interactively 'vc-register)))
1327 (defun vc-checkout (file &optional writable rev)
1328 "Retrieve a copy of the revision REV of FILE.
1329 If WRITABLE is non-nil, make sure the retrieved file is writable.
1330 REV defaults to the latest revision.
1332 After check-out, runs the normal hook `vc-checkout-hook'."
1333 (and writable
1334 (not rev)
1335 (vc-call make-version-backups-p file)
1336 (vc-up-to-date-p file)
1337 (vc-make-version-backup file))
1338 (let ((backend (vc-backend file)))
1339 (with-vc-properties (list file)
1340 (condition-case err
1341 (vc-call-backend backend 'checkout file writable rev)
1342 (file-error
1343 ;; Maybe the backend is not installed ;-(
1344 (when writable
1345 (let ((buf (get-file-buffer file)))
1346 (when buf (with-current-buffer buf (toggle-read-only -1)))))
1347 (signal (car err) (cdr err))))
1348 `((vc-state . ,(if (or (eq (vc-checkout-model backend (list file)) 'implicit)
1349 (not writable))
1350 (if (vc-call-backend backend 'latest-on-branch-p file)
1351 'up-to-date
1352 'needs-update)
1353 'edited))
1354 (vc-checkout-time . ,(nth 5 (file-attributes file))))))
1355 (vc-resynch-buffer file t t)
1356 (run-hooks 'vc-checkout-hook))
1358 (defun vc-mark-resolved (backend files)
1359 (prog1 (with-vc-properties
1360 files
1361 (vc-call-backend backend 'mark-resolved files)
1362 ;; FIXME: Is this TRTD? Might not be.
1363 `((vc-state . edited)))
1364 (message
1365 (substitute-command-keys
1366 "Conflicts have been resolved in %s. \
1367 Type \\[vc-next-action] to check in changes.")
1368 (if (> (length files) 1)
1369 (format "%d files" (length files))
1370 "this file"))))
1372 (defun vc-steal-lock (file rev owner)
1373 "Steal the lock on FILE."
1374 (let (file-description)
1375 (if rev
1376 (setq file-description (format "%s:%s" file rev))
1377 (setq file-description file))
1378 (when (not (yes-or-no-p (format "Steal the lock on %s from %s? "
1379 file-description owner)))
1380 (error "Steal canceled"))
1381 (message "Stealing lock on %s..." file)
1382 (with-vc-properties
1383 (list file)
1384 (vc-call steal-lock file rev)
1385 `((vc-state . edited)))
1386 (vc-resynch-buffer file t t)
1387 (message "Stealing lock on %s...done" file)
1388 ;; Write mail after actually stealing, because if the stealing
1389 ;; goes wrong, we don't want to send any mail.
1390 (compose-mail owner (format "Stolen lock on %s" file-description))
1391 (setq default-directory (expand-file-name "~/"))
1392 (goto-char (point-max))
1393 (insert
1394 (format "I stole the lock on %s, " file-description)
1395 (current-time-string)
1396 ".\n")
1397 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
1399 (defun vc-checkin (files backend &optional rev comment initial-contents)
1400 "Check in FILES.
1401 The optional argument REV may be a string specifying the new revision
1402 level (strongly deprecated). COMMENT is a comment
1403 string; if omitted, a buffer is popped up to accept a comment. If
1404 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents
1405 of the log entry buffer.
1407 If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided
1408 that the version control system supports this mode of operation.
1410 Runs the normal hooks `vc-before-checkin-hook' and `vc-checkin-hook'."
1411 (when vc-before-checkin-hook
1412 (run-hooks 'vc-before-checkin-hook))
1413 (vc-start-logentry
1414 files comment initial-contents
1415 "Enter a change comment."
1416 "*vc-log*"
1417 (lambda ()
1418 (vc-call-backend backend 'log-edit-mode))
1419 (lambda (files comment)
1420 (message "Checking in %s..." (vc-delistify files))
1421 ;; "This log message intentionally left almost blank".
1422 ;; RCS 5.7 gripes about white-space-only comments too.
1423 (or (and comment (string-match "[^\t\n ]" comment))
1424 (setq comment "*** empty log message ***"))
1425 (with-vc-properties
1426 files
1427 ;; We used to change buffers to get local value of
1428 ;; vc-checkin-switches, but 'the' local buffer is
1429 ;; not a well-defined concept for filesets.
1430 (progn
1431 (vc-call-backend backend 'checkin files rev comment)
1432 (mapc 'vc-delete-automatic-version-backups files))
1433 `((vc-state . up-to-date)
1434 (vc-checkout-time . ,(nth 5 (file-attributes file)))
1435 (vc-working-revision . nil)))
1436 (message "Checking in %s...done" (vc-delistify files)))
1437 'vc-checkin-hook))
1439 ;;; Additional entry points for examining version histories
1441 ;; (defun vc-default-diff-tree (backend dir rev1 rev2)
1442 ;; "List differences for all registered files at and below DIR.
1443 ;; The meaning of REV1 and REV2 is the same as for `vc-revision-diff'."
1444 ;; ;; This implementation does an explicit tree walk, and calls
1445 ;; ;; vc-BACKEND-diff directly for each file. An optimization
1446 ;; ;; would be to use `vc-diff-internal', so that diffs can be local,
1447 ;; ;; and to call it only for files that are actually changed.
1448 ;; ;; However, this is expensive for some backends, and so it is left
1449 ;; ;; to backend-specific implementations.
1450 ;; (setq default-directory dir)
1451 ;; (vc-file-tree-walk
1452 ;; default-directory
1453 ;; (lambda (f)
1454 ;; (vc-exec-after
1455 ;; `(let ((coding-system-for-read (vc-coding-system-for-diff ',f)))
1456 ;; (message "Looking at %s" ',f)
1457 ;; (vc-call-backend ',(vc-backend f)
1458 ;; 'diff (list ',f) ',rev1 ',rev2))))))
1460 (defvar vc-coding-system-inherit-eol t
1461 "When non-nil, inherit the EOL format for reading Diff output from the file.
1463 Used in `vc-coding-system-for-diff' to determine the EOL format to use
1464 for reading Diff output for a file. If non-nil, the EOL format is
1465 inherited from the file itself.
1466 Set this variable to nil if your Diff tool might use a different
1467 EOL. Then Emacs will auto-detect the EOL format in Diff output, which
1468 gives better results.") ;; Cf. bug#4451.
1470 (defun vc-coding-system-for-diff (file)
1471 "Return the coding system for reading diff output for FILE."
1472 (or coding-system-for-read
1473 ;; if we already have this file open,
1474 ;; use the buffer's coding system
1475 (let ((buf (find-buffer-visiting file)))
1476 (when buf (with-current-buffer buf
1477 (if vc-coding-system-inherit-eol
1478 buffer-file-coding-system
1479 ;; Don't inherit the EOL part of the coding-system,
1480 ;; because some Diff tools may choose to use
1481 ;; a different one. bug#4451.
1482 (coding-system-base buffer-file-coding-system)))))
1483 ;; otherwise, try to find one based on the file name
1484 (car (find-operation-coding-system 'insert-file-contents file))
1485 ;; and a final fallback
1486 'undecided))
1488 (defun vc-switches (backend op)
1489 "Return a list of vc-BACKEND switches for operation OP.
1490 BACKEND is a symbol such as `CVS', which will be downcased.
1491 OP is a symbol such as `diff'.
1493 In decreasing order of preference, return the value of:
1494 vc-BACKEND-OP-switches (e.g. `vc-cvs-diff-switches');
1495 vc-OP-switches (e.g. `vc-diff-switches'); or, in the case of
1496 diff only, `diff-switches'.
1498 If the chosen value is not a string or a list, return nil.
1499 This is so that you may set, e.g. `vc-svn-diff-switches' to t in order
1500 to override the value of `vc-diff-switches' and `diff-switches'."
1501 (let ((switches
1502 (or (when backend
1503 (let ((sym (vc-make-backend-sym
1504 backend (intern (concat (symbol-name op)
1505 "-switches")))))
1506 (when (boundp sym) (symbol-value sym))))
1507 (let ((sym (intern (format "vc-%s-switches" (symbol-name op)))))
1508 (when (boundp sym) (symbol-value sym)))
1509 (cond
1510 ((eq op 'diff) diff-switches)))))
1511 (if (stringp switches) (list switches)
1512 ;; If not a list, return nil.
1513 ;; This is so we can set vc-diff-switches to t to override
1514 ;; any switches in diff-switches.
1515 (when (listp switches) switches))))
1517 ;; Old def for compatibility with Emacs-21.[123].
1518 (defmacro vc-diff-switches-list (backend) `(vc-switches ',backend 'diff))
1519 (make-obsolete 'vc-diff-switches-list 'vc-switches "22.1")
1521 (defun vc-diff-finish (buffer messages)
1522 ;; The empty sync output case has already been handled, so the only
1523 ;; possibility of an empty output is for an async process.
1524 (when (buffer-live-p buffer)
1525 (let ((window (get-buffer-window buffer t))
1526 (emptyp (zerop (buffer-size buffer))))
1527 (with-current-buffer buffer
1528 (and messages emptyp
1529 (let ((inhibit-read-only t))
1530 (insert (cdr messages) ".\n")
1531 (message "%s" (cdr messages))))
1532 (diff-setup-whitespace)
1533 (goto-char (point-min))
1534 (when window
1535 (shrink-window-if-larger-than-buffer window)))
1536 (when (and messages (not emptyp))
1537 (message "%sdone" (car messages))))))
1539 (defvar vc-diff-added-files nil
1540 "If non-nil, diff added files by comparing them to /dev/null.")
1542 (defun vc-diff-internal (async vc-fileset rev1 rev2 &optional verbose buffer)
1543 "Report diffs between two revisions of a fileset.
1544 Output goes to the buffer BUFFER, which defaults to *vc-diff*.
1545 BUFFER, if non-nil, should be a buffer or a buffer name.
1546 Return t if the buffer had changes, nil otherwise."
1547 (unless buffer
1548 (setq buffer "*vc-diff*"))
1549 (let* ((files (cadr vc-fileset))
1550 (messages (cons (format "Finding changes in %s..."
1551 (vc-delistify files))
1552 (format "No changes between %s and %s"
1553 (or rev1 "working revision")
1554 (or rev2 "workfile"))))
1555 ;; Set coding system based on the first file. It's a kluge,
1556 ;; but the only way to set it for each file included would
1557 ;; be to call the back end separately for each file.
1558 (coding-system-for-read
1559 (if files (vc-coding-system-for-diff (car files)) 'undecided)))
1560 (vc-setup-buffer buffer)
1561 (message "%s" (car messages))
1562 ;; Many backends don't handle well the case of a file that has been
1563 ;; added but not yet committed to the repo (notably CVS and Subversion).
1564 ;; Do that work here so the backends don't have to futz with it. --ESR
1566 ;; Actually most backends (including CVS) have options to control the
1567 ;; behavior since which one is better depends on the user and on the
1568 ;; situation). Worse yet: this code does not handle the case where
1569 ;; `file' is a directory which contains added files.
1570 ;; I made it conditional on vc-diff-added-files but it should probably
1571 ;; just be removed (or copied/moved to specific backends). --Stef.
1572 (when vc-diff-added-files
1573 (let ((filtered '())
1574 process-file-side-effects)
1575 (dolist (file files)
1576 (if (or (file-directory-p file)
1577 (not (string= (vc-working-revision file) "0")))
1578 (push file filtered)
1579 ;; This file is added but not yet committed;
1580 ;; there is no repository version to diff against.
1581 (if (or rev1 rev2)
1582 (error "No revisions of %s exist" file)
1583 ;; We regard this as "changed".
1584 ;; Diff it against /dev/null.
1585 (apply 'vc-do-command buffer
1586 1 "diff" file
1587 (append (vc-switches nil 'diff) '("/dev/null"))))))
1588 (setq files (nreverse filtered))))
1589 (let ((vc-disable-async-diff (not async)))
1590 (vc-call-backend (car vc-fileset) 'diff files rev1 rev2 buffer))
1591 (set-buffer buffer)
1592 (if (and (zerop (buffer-size))
1593 (not (get-buffer-process (current-buffer))))
1594 ;; Treat this case specially so as not to pop the buffer.
1595 (progn
1596 (message "%s" (cdr messages))
1597 nil)
1598 (diff-mode)
1599 (set (make-local-variable 'diff-vc-backend) (car vc-fileset))
1600 (set (make-local-variable 'revert-buffer-function)
1601 `(lambda (ignore-auto noconfirm)
1602 (vc-diff-internal ,async ',vc-fileset ,rev1 ,rev2 ,verbose)))
1603 ;; Make the *vc-diff* buffer read only, the diff-mode key
1604 ;; bindings are nicer for read only buffers. pcl-cvs does the
1605 ;; same thing.
1606 (setq buffer-read-only t)
1607 ;; Display the buffer, but at the end because it can change point.
1608 (pop-to-buffer (current-buffer))
1609 ;; The diff process may finish early, so call `vc-diff-finish'
1610 ;; after `pop-to-buffer'; the former assumes the diff buffer is
1611 ;; shown in some window.
1612 (vc-exec-after `(vc-diff-finish ,(current-buffer)
1613 ',(when verbose messages)))
1614 ;; In the async case, we return t even if there are no differences
1615 ;; because we don't know that yet.
1616 t)))
1618 (defun vc-read-revision (prompt &optional files backend default initial-input)
1619 (cond
1620 ((null files)
1621 (let ((vc-fileset (vc-deduce-fileset t))) ;FIXME: why t? --Stef
1622 (setq files (cadr vc-fileset))
1623 (setq backend (car vc-fileset))))
1624 ((null backend) (setq backend (vc-backend (car files)))))
1625 (let ((completion-table
1626 (vc-call-backend backend 'revision-completion-table files)))
1627 (if completion-table
1628 (completing-read prompt completion-table
1629 nil nil initial-input nil default)
1630 (read-string prompt initial-input nil default))))
1632 (defun vc-diff-build-argument-list-internal ()
1633 "Build argument list for calling internal diff functions."
1634 (let* ((vc-fileset (vc-deduce-fileset t)) ;FIXME: why t? --Stef
1635 (files (cadr vc-fileset))
1636 (backend (car vc-fileset))
1637 (first (car files))
1638 (rev1-default nil)
1639 (rev2-default nil))
1640 (cond
1641 ;; someday we may be able to do revision completion on non-singleton
1642 ;; filesets, but not yet.
1643 ((/= (length files) 1)
1644 nil)
1645 ;; if it's a directory, don't supply any revision default
1646 ((file-directory-p first)
1647 nil)
1648 ;; if the file is not up-to-date, use working revision as older revision
1649 ((not (vc-up-to-date-p first))
1650 (setq rev1-default (vc-working-revision first)))
1651 ;; if the file is not locked, use last and previous revisions as defaults
1653 (setq rev1-default (vc-call-backend backend 'previous-revision first
1654 (vc-working-revision first)))
1655 (when (string= rev1-default "") (setq rev1-default nil))
1656 (setq rev2-default (vc-working-revision first))))
1657 ;; construct argument list
1658 (let* ((rev1-prompt (if rev1-default
1659 (concat "Older revision (default "
1660 rev1-default "): ")
1661 "Older revision: "))
1662 (rev2-prompt (concat "Newer revision (default "
1663 (or rev2-default "current source") "): "))
1664 (rev1 (vc-read-revision rev1-prompt files backend rev1-default))
1665 (rev2 (vc-read-revision rev2-prompt files backend rev2-default)))
1666 (when (string= rev1 "") (setq rev1 nil))
1667 (when (string= rev2 "") (setq rev2 nil))
1668 (list files rev1 rev2))))
1670 ;;;###autoload
1671 (defun vc-version-diff (_files rev1 rev2)
1672 "Report diffs between revisions of the fileset in the repository history."
1673 (interactive (vc-diff-build-argument-list-internal))
1674 ;; All that was just so we could do argument completion!
1675 (when (and (not rev1) rev2)
1676 (error "Not a valid revision range"))
1677 ;; Yes, it's painful to call (vc-deduce-fileset) again. Alas, the
1678 ;; placement rules for (interactive) don't actually leave us a choice.
1679 (vc-diff-internal t (vc-deduce-fileset t) rev1 rev2
1680 (called-interactively-p 'interactive)))
1682 ;;;###autoload
1683 (defun vc-diff (historic &optional not-urgent)
1684 "Display diffs between file revisions.
1685 Normally this compares the currently selected fileset with their
1686 working revisions. With a prefix argument HISTORIC, it reads two revision
1687 designators specifying which revisions to compare.
1689 The optional argument NOT-URGENT non-nil means it is ok to say no to
1690 saving the buffer."
1691 (interactive (list current-prefix-arg t))
1692 (if historic
1693 (call-interactively 'vc-version-diff)
1694 (when buffer-file-name (vc-buffer-sync not-urgent))
1695 (vc-diff-internal t (vc-deduce-fileset t) nil nil
1696 (called-interactively-p 'interactive))))
1698 (declare-function ediff-vc-internal (rev1 rev2 &optional startup-hooks))
1700 ;;;###autoload
1701 (defun vc-version-ediff (files rev1 rev2)
1702 "Show differences between revisions of the fileset in the
1703 repository history using ediff."
1704 (interactive (vc-diff-build-argument-list-internal))
1705 ;; All that was just so we could do argument completion!
1706 (when (and (not rev1) rev2)
1707 (error "Not a valid revision range"))
1709 (message "%s" (format "Finding changes in %s..." (vc-delistify files)))
1711 ;; Functions ediff-(vc|rcs)-internal use "" instead of nil.
1712 (when (null rev1) (setq rev1 ""))
1713 (when (null rev2) (setq rev2 ""))
1715 (cond
1716 ;; FIXME We only support running ediff on one file for now.
1717 ;; We could spin off an ediff session per file in the file set.
1718 ((= (length files) 1)
1719 (ediff-load-version-control)
1720 (find-file (car files)) ;FIXME: find-file from Elisp is bad.
1721 (ediff-vc-internal rev1 rev2 nil))
1723 (error "More than one file is not supported"))))
1725 ;;;###autoload
1726 (defun vc-ediff (historic &optional not-urgent)
1727 "Display diffs between file revisions using ediff.
1728 Normally this compares the currently selected fileset with their
1729 working revisions. With a prefix argument HISTORIC, it reads two revision
1730 designators specifying which revisions to compare.
1732 The optional argument NOT-URGENT non-nil means it is ok to say no to
1733 saving the buffer."
1734 (interactive (list current-prefix-arg t))
1735 (if historic
1736 (call-interactively 'vc-version-ediff)
1737 (when buffer-file-name (vc-buffer-sync not-urgent))
1738 (vc-version-ediff (cadr (vc-deduce-fileset t)) nil nil)))
1740 ;;;###autoload
1741 (defun vc-root-diff (historic &optional not-urgent)
1742 "Display diffs between VC-controlled whole tree revisions.
1743 Normally, this compares the tree corresponding to the current
1744 fileset with the working revision.
1745 With a prefix argument HISTORIC, prompt for two revision
1746 designators specifying which revisions to compare.
1748 The optional argument NOT-URGENT non-nil means it is ok to say no to
1749 saving the buffer."
1750 (interactive (list current-prefix-arg t))
1751 (if historic
1752 ;; FIXME: this does not work right, `vc-version-diff' ends up
1753 ;; calling `vc-deduce-fileset' to find the files to diff, and
1754 ;; that's not what we want here, we want the diff for the VC root dir.
1755 (call-interactively 'vc-version-diff)
1756 (when buffer-file-name (vc-buffer-sync not-urgent))
1757 (let ((backend (vc-deduce-backend))
1758 rootdir working-revision)
1759 (unless backend
1760 (error "Buffer is not version controlled"))
1761 (setq rootdir (vc-call-backend backend 'root default-directory))
1762 (setq working-revision (vc-working-revision rootdir))
1763 ;; VC diff for the root directory produces output that is
1764 ;; relative to it. Bind default-directory to the root directory
1765 ;; here, this way the *vc-diff* buffer is setup correctly, so
1766 ;; relative file names work.
1767 (let ((default-directory rootdir))
1768 (vc-diff-internal
1769 t (list backend (list rootdir) working-revision) nil nil
1770 (called-interactively-p 'interactive))))))
1772 ;;;###autoload
1773 (defun vc-revision-other-window (rev)
1774 "Visit revision REV of the current file in another window.
1775 If the current file is named `F', the revision is named `F.~REV~'.
1776 If `F.~REV~' already exists, use it instead of checking it out again."
1777 (interactive
1778 (save-current-buffer
1779 (vc-ensure-vc-buffer)
1780 (list
1781 (vc-read-revision "Revision to visit (default is working revision): "
1782 (list buffer-file-name)))))
1783 (vc-ensure-vc-buffer)
1784 (let* ((file buffer-file-name)
1785 (revision (if (string-equal rev "")
1786 (vc-working-revision file)
1787 rev)))
1788 (switch-to-buffer-other-window (vc-find-revision file revision))))
1790 (defun vc-find-revision (file revision &optional backend)
1791 "Read REVISION of FILE into a buffer and return the buffer.
1792 Use BACKEND as the VC backend if specified."
1793 (let ((automatic-backup (vc-version-backup-file-name file revision))
1794 (filebuf (or (get-file-buffer file) (current-buffer)))
1795 (filename (vc-version-backup-file-name file revision 'manual)))
1796 (unless (file-exists-p filename)
1797 (if (file-exists-p automatic-backup)
1798 (rename-file automatic-backup filename nil)
1799 (message "Checking out %s..." filename)
1800 (with-current-buffer filebuf
1801 (let ((failed t))
1802 (unwind-protect
1803 (let ((coding-system-for-read 'no-conversion)
1804 (coding-system-for-write 'no-conversion))
1805 (with-temp-file filename
1806 (let ((outbuf (current-buffer)))
1807 ;; Change buffer to get local value of
1808 ;; vc-checkout-switches.
1809 (with-current-buffer filebuf
1810 (if backend
1811 (vc-call-backend backend 'find-revision file revision outbuf)
1812 (vc-call find-revision file revision outbuf)))))
1813 (setq failed nil))
1814 (when (and failed (file-exists-p filename))
1815 (delete-file filename))))
1816 (vc-mode-line file))
1817 (message "Checking out %s...done" filename)))
1818 (let ((result-buf (find-file-noselect filename)))
1819 (with-current-buffer result-buf
1820 ;; Set the parent buffer so that things like
1821 ;; C-x v g, C-x v l, ... etc work.
1822 (set (make-local-variable 'vc-parent-buffer) filebuf))
1823 result-buf)))
1825 ;; Header-insertion code
1827 ;;;###autoload
1828 (defun vc-insert-headers ()
1829 "Insert headers into a file for use with a version control system.
1830 Headers desired are inserted at point, and are pulled from
1831 the variable `vc-BACKEND-header'."
1832 (interactive)
1833 (vc-ensure-vc-buffer)
1834 (save-excursion
1835 (save-restriction
1836 (widen)
1837 (when (or (not (vc-check-headers))
1838 (y-or-n-p "Version headers already exist. Insert another set? "))
1839 (let* ((delims (cdr (assq major-mode vc-comment-alist)))
1840 (comment-start-vc (or (car delims) comment-start "#"))
1841 (comment-end-vc (or (car (cdr delims)) comment-end ""))
1842 (hdsym (vc-make-backend-sym (vc-backend buffer-file-name)
1843 'header))
1844 (hdstrings (and (boundp hdsym) (symbol-value hdsym))))
1845 (dolist (s hdstrings)
1846 (insert comment-start-vc "\t" s "\t"
1847 comment-end-vc "\n"))
1848 (when vc-static-header-alist
1849 (dolist (f vc-static-header-alist)
1850 (when (string-match (car f) buffer-file-name)
1851 (insert (format (cdr f) (car hdstrings)))))))))))
1853 (defun vc-clear-headers (&optional file)
1854 "Clear all version headers in the current buffer (or FILE).
1855 The headers are reset to their non-expanded form."
1856 (let* ((filename (or file buffer-file-name))
1857 (visited (find-buffer-visiting filename))
1858 (backend (vc-backend filename)))
1859 (when (vc-find-backend-function backend 'clear-headers)
1860 (if visited
1861 (let ((context (vc-buffer-context)))
1862 ;; save-excursion may be able to relocate point and mark
1863 ;; properly. If it fails, vc-restore-buffer-context
1864 ;; will give it a second try.
1865 (save-excursion
1866 (vc-call-backend backend 'clear-headers))
1867 (vc-restore-buffer-context context))
1868 (set-buffer (find-file-noselect filename))
1869 (vc-call-backend backend 'clear-headers)
1870 (kill-buffer filename)))))
1872 (defun vc-modify-change-comment (files rev oldcomment)
1873 "Edit the comment associated with the given files and revision."
1874 ;; Less of a kluge than it looks like; log-view mode only passes
1875 ;; this function a singleton list. Arguments left in this form in
1876 ;; case the more general operation ever becomes meaningful.
1877 (let ((backend (vc-responsible-backend (car files))))
1878 (vc-start-logentry
1879 files oldcomment t
1880 "Enter a replacement change comment."
1881 "*vc-log*"
1882 (lambda () (vc-call-backend backend 'log-edit-mode))
1883 (lambda (files comment)
1884 (vc-call-backend backend
1885 'modify-change-comment files rev comment)))))
1887 ;;;###autoload
1888 (defun vc-merge ()
1889 "Perform a version control merge operation.
1890 You must be visiting a version controlled file, or in a `vc-dir' buffer.
1891 On a distributed version control system, this runs a \"merge\"
1892 operation to incorporate changes from another branch onto the
1893 current branch, prompting for an argument list.
1895 On a non-distributed version control system, this merges changes
1896 between two revisions into the current fileset. This asks for
1897 two revisions to merge from in the minibuffer. If the first
1898 revision is a branch number, then merge all changes from that
1899 branch. If the first revision is empty, merge the most recent
1900 changes from the current branch."
1901 (interactive)
1902 (let* ((vc-fileset (vc-deduce-fileset t))
1903 (backend (car vc-fileset))
1904 (files (cadr vc-fileset)))
1905 (cond
1906 ;; If a branch-merge operation is defined, use it.
1907 ((vc-find-backend-function backend 'merge-branch)
1908 (vc-call-backend backend 'merge-branch))
1909 ;; Otherwise, do a per-file merge.
1910 ((vc-find-backend-function backend 'merge)
1911 (vc-buffer-sync)
1912 (dolist (file files)
1913 (let* ((state (vc-state file))
1914 first-revision second-revision status)
1915 (cond
1916 ((stringp state) ;; Locking VCses only
1917 (error "File %s is locked by %s" file state))
1918 ((not (vc-editable-p file))
1919 (vc-checkout file t)))
1920 (setq first-revision
1921 (vc-read-revision
1922 (concat "Merge " file
1923 " from branch or revision "
1924 "(default news on current branch): ")
1925 (list file)
1926 backend))
1927 (cond
1928 ((string= first-revision "")
1929 (setq status (vc-call-backend backend 'merge-news file)))
1931 (if (not (vc-branch-p first-revision))
1932 (setq second-revision
1933 (vc-read-revision
1934 "Second revision: "
1935 (list file) backend nil
1936 ;; FIXME: This is CVS/RCS/SCCS specific.
1937 (concat (vc-branch-part first-revision) ".")))
1938 ;; We want to merge an entire branch. Set revisions
1939 ;; accordingly, so that vc-BACKEND-merge understands us.
1940 (setq second-revision first-revision)
1941 ;; first-revision must be the starting point of the branch
1942 (setq first-revision (vc-branch-part first-revision)))
1943 (setq status (vc-call-backend backend 'merge file
1944 first-revision second-revision))))
1945 (vc-maybe-resolve-conflicts file status "WORKFILE" "MERGE SOURCE"))))
1947 (error "Sorry, merging is not implemented for %s" backend)))))
1950 (defun vc-maybe-resolve-conflicts (file status &optional _name-A _name-B)
1951 (vc-resynch-buffer file t (not (buffer-modified-p)))
1952 (if (zerop status) (message "Merge successful")
1953 (smerge-mode 1)
1954 (message "File contains conflicts.")))
1956 ;;;###autoload
1957 (defalias 'vc-resolve-conflicts 'smerge-ediff)
1959 ;; TODO: This is OK but maybe we could integrate it better.
1960 ;; E.g. it could be run semi-automatically (via a prompt?) when saving a file
1961 ;; that was conflicted (i.e. upon mark-resolved).
1962 ;; FIXME: should we add an "other-window" version? Or maybe we should
1963 ;; hook it inside find-file so it automatically works for
1964 ;; find-file-other-window as well. E.g. find-file could use a new
1965 ;; `default-next-file' variable for its default file (M-n), and
1966 ;; we could then set it upon mark-resolve, so C-x C-s C-x C-f M-n would
1967 ;; automatically offer the next conflicted file.
1968 (defun vc-find-conflicted-file ()
1969 "Visit the next conflicted file in the current project."
1970 (interactive)
1971 (let* ((backend (or (if buffer-file-name (vc-backend buffer-file-name))
1972 (vc-responsible-backend default-directory)
1973 (error "No VC backend")))
1974 (files (vc-call-backend backend
1975 'conflicted-files default-directory)))
1976 ;; Don't try and visit the current file.
1977 (if (equal (car files) buffer-file-name) (pop files))
1978 (if (null files)
1979 (message "No more conflicted files")
1980 (find-file (pop files))
1981 (message "%s more conflicted files after this one"
1982 (if files (length files) "No")))))
1984 ;; Named-configuration entry points
1986 (defun vc-tag-precondition (dir)
1987 "Scan the tree below DIR, looking for files not up-to-date.
1988 If any file is not up-to-date, return the name of the first such file.
1989 \(This means, neither tag creation nor retrieval is allowed.\)
1990 If one or more of the files are currently visited, return `visited'.
1991 Otherwise, return nil."
1992 (let ((status nil))
1993 (catch 'vc-locked-example
1994 (vc-file-tree-walk
1996 (lambda (f)
1997 (if (not (vc-up-to-date-p f)) (throw 'vc-locked-example f)
1998 (when (get-file-buffer f) (setq status 'visited)))))
1999 status)))
2001 ;;;###autoload
2002 (defun vc-create-tag (dir name branchp)
2003 "Descending recursively from DIR, make a tag called NAME.
2004 For each registered file, the working revision becomes part of
2005 the named configuration. If the prefix argument BRANCHP is
2006 given, the tag is made as a new branch and the files are
2007 checked out in that new branch."
2008 (interactive
2009 (let ((granularity
2010 (vc-call-backend (vc-responsible-backend default-directory)
2011 'revision-granularity)))
2012 (list
2013 (if (eq granularity 'repository)
2014 ;; For VC's that do not work at file level, it's pointless
2015 ;; to ask for a directory, branches are created at repository level.
2016 default-directory
2017 (read-directory-name "Directory: " default-directory default-directory t))
2018 (read-string (if current-prefix-arg "New branch name: " "New tag name: "))
2019 current-prefix-arg)))
2020 (message "Making %s... " (if branchp "branch" "tag"))
2021 (when (file-directory-p dir) (setq dir (file-name-as-directory dir)))
2022 (vc-call-backend (vc-responsible-backend dir)
2023 'create-tag dir name branchp)
2024 (vc-resynch-buffer dir t t t)
2025 (message "Making %s... done" (if branchp "branch" "tag")))
2027 ;;;###autoload
2028 (defun vc-retrieve-tag (dir name)
2029 "Descending recursively from DIR, retrieve the tag called NAME.
2030 If NAME is empty, it refers to the latest revisions.
2031 If locking is used for the files in DIR, then there must not be any
2032 locked files at or below DIR (but if NAME is empty, locked files are
2033 allowed and simply skipped)."
2034 (interactive
2035 (let ((granularity
2036 (vc-call-backend (vc-responsible-backend default-directory)
2037 'revision-granularity)))
2038 (list
2039 (if (eq granularity 'repository)
2040 ;; For VC's that do not work at file level, it's pointless
2041 ;; to ask for a directory, branches are created at repository level.
2042 default-directory
2043 (read-directory-name "Directory: " default-directory default-directory t))
2044 (read-string "Tag name to retrieve (default latest revisions): "))))
2045 (let ((update (yes-or-no-p "Update any affected buffers? "))
2046 (msg (if (or (not name) (string= name ""))
2047 (format "Updating %s... " (abbreviate-file-name dir))
2048 (format "Retrieving tag into %s... "
2049 (abbreviate-file-name dir)))))
2050 (message "%s" msg)
2051 (vc-call-backend (vc-responsible-backend dir)
2052 'retrieve-tag dir name update)
2053 (vc-resynch-buffer dir t t t)
2054 (message "%s" (concat msg "done"))))
2057 ;; Miscellaneous other entry points
2059 ;; FIXME: this should be a defcustom
2060 ;; FIXME: maybe add another choice:
2061 ;; `root-directory' (or somesuch), which would mean show a short log
2062 ;; for the root directory.
2063 (defvar vc-log-short-style '(directory)
2064 "Whether or not to show a short log.
2065 If it contains `directory' then if the fileset contains a directory show a short log.
2066 If it contains `file' then show short logs for files.
2067 Not all VC backends support short logs!")
2069 (defvar log-view-vc-fileset)
2071 (defun vc-print-log-setup-buttons (working-revision is-start-revision limit pl-return)
2072 (when (and limit (not (eq 'limit-unsupported pl-return))
2073 (not is-start-revision))
2074 (goto-char (point-max))
2075 (insert "\n")
2076 (insert-text-button "Show 2X entries"
2077 'action (lambda (&rest _ignore)
2078 (vc-print-log-internal
2079 log-view-vc-backend log-view-vc-fileset
2080 working-revision nil (* 2 limit)))
2081 'help-echo "Show the log again, and double the number of log entries shown")
2082 (insert " ")
2083 (insert-text-button "Show unlimited entries"
2084 'action (lambda (&rest _ignore)
2085 (vc-print-log-internal
2086 log-view-vc-backend log-view-vc-fileset
2087 working-revision nil nil))
2088 'help-echo "Show the log again, including all entries")))
2090 (defun vc-print-log-internal (backend files working-revision
2091 &optional is-start-revision limit)
2092 ;; Don't switch to the output buffer before running the command,
2093 ;; so that any buffer-local settings in the vc-controlled
2094 ;; buffer can be accessed by the command.
2095 (let ((dir-present nil)
2096 (vc-short-log nil)
2097 (buffer-name "*vc-change-log*")
2098 type)
2099 (dolist (file files)
2100 (when (file-directory-p file)
2101 (setq dir-present t)))
2102 (setq vc-short-log
2103 (not (null (if dir-present
2104 (memq 'directory vc-log-short-style)
2105 (memq 'file vc-log-short-style)))))
2106 (setq type (if vc-short-log 'short 'long))
2107 (let ((shortlog vc-short-log))
2108 (vc-log-internal-common
2109 backend buffer-name files type
2110 (lambda (bk buf _type-arg files-arg)
2111 (vc-call-backend bk 'print-log files-arg buf shortlog
2112 (when is-start-revision working-revision) limit))
2113 (lambda (_bk _files-arg ret)
2114 (vc-print-log-setup-buttons working-revision
2115 is-start-revision limit ret))
2116 (lambda (bk)
2117 (vc-call-backend bk 'show-log-entry working-revision))
2118 (lambda (_ignore-auto _noconfirm)
2119 (vc-print-log-internal backend files working-revision
2120 is-start-revision limit))))))
2122 (defvar vc-log-view-type nil
2123 "Set this to differentiate the different types of logs.")
2124 (put 'vc-log-view-type 'permanent-local t)
2126 (defun vc-log-internal-common (backend
2127 buffer-name
2128 files
2129 type
2130 backend-func
2131 setup-buttons-func
2132 goto-location-func
2133 rev-buff-func)
2134 (let (retval)
2135 (with-current-buffer (get-buffer-create buffer-name)
2136 (set (make-local-variable 'vc-log-view-type) type))
2137 (setq retval (funcall backend-func backend buffer-name type files))
2138 (pop-to-buffer buffer-name)
2139 (let ((inhibit-read-only t))
2140 ;; log-view-mode used to be called with inhibit-read-only bound
2141 ;; to t, so let's keep doing it, just in case.
2142 (vc-call-backend backend 'log-view-mode)
2143 (set (make-local-variable 'log-view-vc-backend) backend)
2144 (set (make-local-variable 'log-view-vc-fileset) files)
2145 (set (make-local-variable 'revert-buffer-function)
2146 rev-buff-func))
2147 (vc-exec-after
2148 `(let ((inhibit-read-only t))
2149 (funcall ',setup-buttons-func ',backend ',files ',retval)
2150 (shrink-window-if-larger-than-buffer)
2151 (funcall ',goto-location-func ',backend)
2152 (setq vc-sentinel-movepoint (point))
2153 (set-buffer-modified-p nil)))))
2155 (defun vc-incoming-outgoing-internal (backend remote-location buffer-name type)
2156 (vc-log-internal-common
2157 backend buffer-name nil type
2158 (lambda (bk buf type-arg _files)
2159 (vc-call-backend bk type-arg buf remote-location))
2160 (lambda (_bk _files-arg _ret) nil)
2161 (lambda (_bk) (goto-char (point-min)))
2162 (lambda (_ignore-auto _noconfirm)
2163 (vc-incoming-outgoing-internal backend remote-location buffer-name type))))
2165 ;;;###autoload
2166 (defun vc-print-log (&optional working-revision limit)
2167 "List the change log of the current fileset in a window.
2168 If WORKING-REVISION is non-nil, leave point at that revision.
2169 If LIMIT is non-nil, it should be a number specifying the maximum
2170 number of revisions to show; the default is `vc-log-show-limit'.
2172 When called interactively with a prefix argument, prompt for
2173 WORKING-REVISION and LIMIT."
2174 (interactive
2175 (cond
2176 (current-prefix-arg
2177 (let ((rev (read-from-minibuffer "Log from revision (default: last revision): " nil
2178 nil nil nil))
2179 (lim (string-to-number
2180 (read-from-minibuffer
2181 "Limit display (unlimited: 0): "
2182 (format "%s" vc-log-show-limit)
2183 nil nil nil))))
2184 (when (string= rev "") (setq rev nil))
2185 (when (<= lim 0) (setq lim nil))
2186 (list rev lim)))
2188 (list nil (when (> vc-log-show-limit 0) vc-log-show-limit)))))
2189 (let* ((vc-fileset (vc-deduce-fileset t)) ;FIXME: Why t? --Stef
2190 (backend (car vc-fileset))
2191 (files (cadr vc-fileset))
2192 (working-revision (or working-revision (vc-working-revision (car files)))))
2193 (vc-print-log-internal backend files working-revision nil limit)))
2195 ;;;###autoload
2196 (defun vc-print-root-log (&optional limit)
2197 "List the change log for the current VC controlled tree in a window.
2198 If LIMIT is non-nil, it should be a number specifying the maximum
2199 number of revisions to show; the default is `vc-log-show-limit'.
2200 When called interactively with a prefix argument, prompt for LIMIT."
2201 (interactive
2202 (cond
2203 (current-prefix-arg
2204 (let ((lim (string-to-number
2205 (read-from-minibuffer
2206 "Limit display (unlimited: 0): "
2207 (format "%s" vc-log-show-limit)
2208 nil nil nil))))
2209 (when (<= lim 0) (setq lim nil))
2210 (list lim)))
2212 (list (when (> vc-log-show-limit 0) vc-log-show-limit)))))
2213 (let ((backend (vc-deduce-backend))
2214 rootdir working-revision)
2215 (unless backend
2216 (error "Buffer is not version controlled"))
2217 (setq rootdir (vc-call-backend backend 'root default-directory))
2218 (setq working-revision (vc-working-revision rootdir))
2219 (vc-print-log-internal backend (list rootdir) working-revision nil limit)))
2221 ;;;###autoload
2222 (defun vc-log-incoming (&optional remote-location)
2223 "Show a log of changes that will be received with a pull operation from REMOTE-LOCATION.
2224 When called interactively with a prefix argument, prompt for REMOTE-LOCATION.."
2225 (interactive
2226 (when current-prefix-arg
2227 (list (read-string "Remote location (empty for default): "))))
2228 (let ((backend (vc-deduce-backend)))
2229 (unless backend
2230 (error "Buffer is not version controlled"))
2231 (vc-incoming-outgoing-internal backend remote-location "*vc-incoming*"
2232 'log-incoming)))
2234 ;;;###autoload
2235 (defun vc-log-outgoing (&optional remote-location)
2236 "Show a log of changes that will be sent with a push operation to REMOTE-LOCATION.
2237 When called interactively with a prefix argument, prompt for REMOTE-LOCATION."
2238 (interactive
2239 (when current-prefix-arg
2240 (list (read-string "Remote location (empty for default): "))))
2241 (let ((backend (vc-deduce-backend)))
2242 (unless backend
2243 (error "Buffer is not version controlled"))
2244 (vc-incoming-outgoing-internal backend remote-location "*vc-outgoing*"
2245 'log-outgoing)))
2247 ;;;###autoload
2248 (defun vc-revert ()
2249 "Revert working copies of the selected fileset to their repository contents.
2250 This asks for confirmation if the buffer contents are not identical
2251 to the working revision (except for keyword expansion)."
2252 (interactive)
2253 (let* ((vc-fileset (vc-deduce-fileset))
2254 (files (cadr vc-fileset))
2255 (queried nil)
2256 diff-buffer)
2257 ;; If any of the files is visited by the current buffer, make sure
2258 ;; buffer is saved. If the user says `no', abort since we cannot
2259 ;; show the changes and ask for confirmation to discard them.
2260 (when (or (not files) (memq (buffer-file-name) files))
2261 (vc-buffer-sync nil))
2262 (dolist (file files)
2263 (let ((buf (get-file-buffer file)))
2264 (when (and buf (buffer-modified-p buf))
2265 (error "Please kill or save all modified buffers before reverting")))
2266 (when (vc-up-to-date-p file)
2267 (if (yes-or-no-p (format "%s seems up-to-date. Revert anyway? " file))
2268 (setq queried t)
2269 (error "Revert canceled"))))
2270 (unwind-protect
2271 (when (if vc-revert-show-diff
2272 (progn
2273 (setq diff-buffer (generate-new-buffer-name "*vc-diff*"))
2274 (vc-diff-internal vc-allow-async-revert vc-fileset
2275 nil nil nil diff-buffer))
2276 ;; Avoid querying the user again.
2277 (null queried))
2278 (unless (yes-or-no-p
2279 (format "Discard changes in %s? "
2280 (let ((str (vc-delistify files))
2281 (nfiles (length files)))
2282 (if (< (length str) 50)
2284 (format "%d file%s" nfiles
2285 (if (= nfiles 1) "" "s"))))))
2286 (error "Revert canceled")))
2287 (when diff-buffer
2288 (quit-windows-on diff-buffer)))
2289 (dolist (file files)
2290 (message "Reverting %s..." (vc-delistify files))
2291 (vc-revert-file file)
2292 (message "Reverting %s...done" (vc-delistify files)))))
2294 ;;;###autoload
2295 (defun vc-rollback ()
2296 "Roll back (remove) the most recent changeset committed to the repository.
2297 This may be either a file-level or a repository-level operation,
2298 depending on the underlying version-control system."
2299 (interactive)
2300 (let* ((vc-fileset (vc-deduce-fileset))
2301 (backend (car vc-fileset))
2302 (files (cadr vc-fileset))
2303 (granularity (vc-call-backend backend 'revision-granularity)))
2304 (unless (vc-find-backend-function backend 'rollback)
2305 (error "Rollback is not supported in %s" backend))
2306 (when (and (not (eq granularity 'repository)) (/= (length files) 1))
2307 (error "Rollback requires a singleton fileset or repository versioning"))
2308 ;; FIXME: latest-on-branch-p should take the fileset.
2309 (when (not (vc-call-backend backend 'latest-on-branch-p (car files)))
2310 (error "Rollback is only possible at the tip revision"))
2311 ;; If any of the files is visited by the current buffer, make
2312 ;; sure buffer is saved. If the user says `no', abort since
2313 ;; we cannot show the changes and ask for confirmation to
2314 ;; discard them.
2315 (when (or (not files) (memq (buffer-file-name) files))
2316 (vc-buffer-sync nil))
2317 (dolist (file files)
2318 (when (buffer-modified-p (get-file-buffer file))
2319 (error "Please kill or save all modified buffers before rollback"))
2320 (when (not (vc-up-to-date-p file))
2321 (error "Please revert all modified workfiles before rollback")))
2322 ;; Accumulate changes associated with the fileset
2323 (vc-setup-buffer "*vc-diff*")
2324 (not-modified)
2325 (message "Finding changes...")
2326 (let* ((tip (vc-working-revision (car files)))
2327 ;; FIXME: `previous-revision' should take the fileset.
2328 (previous (vc-call-backend backend 'previous-revision
2329 (car files) tip)))
2330 (vc-diff-internal nil vc-fileset previous tip))
2331 ;; Display changes
2332 (unless (yes-or-no-p "Discard these revisions? ")
2333 (error "Rollback canceled"))
2334 (quit-windows-on "*vc-diff*")
2335 ;; Do the actual reversions
2336 (message "Rolling back %s..." (vc-delistify files))
2337 (with-vc-properties
2338 files
2339 (vc-call-backend backend 'rollback files)
2340 `((vc-state . ,'up-to-date)
2341 (vc-checkout-time . , (nth 5 (file-attributes file)))
2342 (vc-working-revision . nil)))
2343 (dolist (f files) (vc-resynch-buffer f t t))
2344 (message "Rolling back %s...done" (vc-delistify files))))
2346 ;;;###autoload
2347 (define-obsolete-function-alias 'vc-revert-buffer 'vc-revert "23.1")
2349 ;;;###autoload
2350 (defun vc-pull (&optional arg)
2351 "Update the current fileset or branch.
2352 You must be visiting a version controlled file, or in a `vc-dir' buffer.
2353 On a distributed version control system, this runs a \"pull\"
2354 operation to update the current branch, prompting for an argument
2355 list if required. Optional prefix ARG forces a prompt.
2357 On a non-distributed version control system, update the current
2358 fileset to the tip revisions. For each unchanged and unlocked
2359 file, this simply replaces the work file with the latest revision
2360 on its branch. If the file contains changes, any changes in the
2361 tip revision are merged into the working file."
2362 (interactive "P")
2363 (let* ((vc-fileset (vc-deduce-fileset t))
2364 (backend (car vc-fileset))
2365 (files (cadr vc-fileset)))
2366 (cond
2367 ;; If a pull operation is defined, use it.
2368 ((vc-find-backend-function backend 'pull)
2369 (vc-call-backend backend 'pull arg))
2370 ;; If VCS has `merge-news' functionality (CVS and SVN), use it.
2371 ((vc-find-backend-function backend 'merge-news)
2372 (save-some-buffers ; save buffers visiting files
2373 nil (lambda ()
2374 (and (buffer-modified-p)
2375 (let ((file (buffer-file-name)))
2376 (and file (member file files))))))
2377 (dolist (file files)
2378 (if (vc-up-to-date-p file)
2379 (vc-checkout file nil t)
2380 (vc-maybe-resolve-conflicts
2381 file (vc-call-backend backend 'merge-news file)))))
2382 ;; For a locking VCS, check out each file.
2383 ((eq (vc-checkout-model backend files) 'locking)
2384 (dolist (file files)
2385 (if (vc-up-to-date-p file)
2386 (vc-checkout file nil t))))
2388 (error "VC update is unsupported for `%s'" backend)))))
2390 ;;;###autoload
2391 (defalias 'vc-update 'vc-pull)
2393 (defun vc-version-backup-file (file &optional rev)
2394 "Return name of backup file for revision REV of FILE.
2395 If version backups should be used for FILE, and there exists
2396 such a backup for REV or the working revision of file, return
2397 its name; otherwise return nil."
2398 (when (vc-call make-version-backups-p file)
2399 (let ((backup-file (vc-version-backup-file-name file rev)))
2400 (if (file-exists-p backup-file)
2401 backup-file
2402 ;; there is no automatic backup, but maybe the user made one manually
2403 (setq backup-file (vc-version-backup-file-name file rev 'manual))
2404 (when (file-exists-p backup-file)
2405 backup-file)))))
2407 (defun vc-revert-file (file)
2408 "Revert FILE back to the repository working revision it was based on."
2409 (with-vc-properties
2410 (list file)
2411 (let ((backup-file (vc-version-backup-file file)))
2412 (when backup-file
2413 (copy-file backup-file file 'ok-if-already-exists)
2414 (vc-delete-automatic-version-backups file))
2415 (vc-call revert file backup-file))
2416 `((vc-state . up-to-date)
2417 (vc-checkout-time . ,(nth 5 (file-attributes file)))))
2418 (vc-resynch-buffer file t t))
2420 ;;;###autoload
2421 (defun vc-switch-backend (file backend)
2422 "Make BACKEND the current version control system for FILE.
2423 FILE must already be registered in BACKEND. The change is not
2424 permanent, only for the current session. This function only changes
2425 VC's perspective on FILE, it does not register or unregister it.
2426 By default, this command cycles through the registered backends.
2427 To get a prompt, use a prefix argument."
2428 (interactive
2429 (list
2430 (or buffer-file-name
2431 (error "There is no version-controlled file in this buffer"))
2432 (let ((crt-bk (vc-backend buffer-file-name))
2433 (backends nil))
2434 (unless crt-bk
2435 (error "File %s is not under version control" buffer-file-name))
2436 ;; Find the registered backends.
2437 (dolist (crt vc-handled-backends)
2438 (when (and (vc-call-backend crt 'registered buffer-file-name)
2439 (not (eq crt-bk crt)))
2440 (push crt backends)))
2441 ;; Find the next backend.
2442 (let ((def (car backends))
2443 (others backends))
2444 (cond
2445 ((null others) (error "No other backend to switch to"))
2446 (current-prefix-arg
2447 (intern
2448 (upcase
2449 (completing-read
2450 (format "Switch to backend [%s]: " def)
2451 (mapcar (lambda (b) (list (downcase (symbol-name b)))) backends)
2452 nil t nil nil (downcase (symbol-name def))))))
2453 (t def))))))
2454 (unless (eq backend (vc-backend file))
2455 (vc-file-clearprops file)
2456 (vc-file-setprop file 'vc-backend backend)
2457 ;; Force recomputation of the state
2458 (unless (vc-call-backend backend 'registered file)
2459 (vc-file-clearprops file)
2460 (error "%s is not registered in %s" file backend))
2461 (vc-mode-line file)))
2463 ;;;###autoload
2464 (defun vc-transfer-file (file new-backend)
2465 "Transfer FILE to another version control system NEW-BACKEND.
2466 If NEW-BACKEND has a higher precedence than FILE's current backend
2467 \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in
2468 NEW-BACKEND, using the revision number from the current backend as the
2469 base level. If NEW-BACKEND has a lower precedence than the current
2470 backend, then commit all changes that were made under the current
2471 backend to NEW-BACKEND, and unregister FILE from the current backend.
2472 \(If FILE is not yet registered under NEW-BACKEND, register it.)"
2473 (let* ((old-backend (vc-backend file))
2474 (edited (memq (vc-state file) '(edited needs-merge)))
2475 (registered (vc-call-backend new-backend 'registered file))
2476 (move
2477 (and registered ; Never move if not registered in new-backend yet.
2478 ;; move if new-backend comes later in vc-handled-backends
2479 (or (memq new-backend (memq old-backend vc-handled-backends))
2480 (y-or-n-p "Final transfer? "))))
2481 (comment nil))
2482 (when (eq old-backend new-backend)
2483 (error "%s is the current backend of %s" new-backend file))
2484 (if registered
2485 (set-file-modes file (logior (file-modes file) 128))
2486 ;; `registered' might have switched under us.
2487 (vc-switch-backend file old-backend)
2488 (let* ((rev (vc-working-revision file))
2489 (modified-file (and edited (make-temp-file file)))
2490 (unmodified-file (and modified-file (vc-version-backup-file file))))
2491 ;; Go back to the base unmodified file.
2492 (unwind-protect
2493 (progn
2494 (when modified-file
2495 (copy-file file modified-file 'ok-if-already-exists)
2496 ;; If we have a local copy of the unmodified file, handle that
2497 ;; here and not in vc-revert-file because we don't want to
2498 ;; delete that copy -- it is still useful for OLD-BACKEND.
2499 (if unmodified-file
2500 (copy-file unmodified-file file
2501 'ok-if-already-exists 'keep-date)
2502 (when (y-or-n-p "Get base revision from repository? ")
2503 (vc-revert-file file))))
2504 (vc-call-backend new-backend 'receive-file file rev))
2505 (when modified-file
2506 (vc-switch-backend file new-backend)
2507 (unless (eq (vc-checkout-model new-backend (list file)) 'implicit)
2508 (vc-checkout file t nil))
2509 (rename-file modified-file file 'ok-if-already-exists)
2510 (vc-file-setprop file 'vc-checkout-time nil)))))
2511 (when move
2512 (vc-switch-backend file old-backend)
2513 (setq comment (vc-call-backend old-backend 'comment-history file))
2514 (vc-call-backend old-backend 'unregister file))
2515 (vc-switch-backend file new-backend)
2516 (when (or move edited)
2517 (vc-file-setprop file 'vc-state 'edited)
2518 (vc-mode-line file new-backend)
2519 (vc-checkin file new-backend nil comment (stringp comment)))))
2521 (defun vc-rename-master (oldmaster newfile templates)
2522 "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES."
2523 (let* ((dir (file-name-directory (expand-file-name oldmaster)))
2524 (newdir (or (file-name-directory newfile) ""))
2525 (newbase (file-name-nondirectory newfile))
2526 (masters
2527 ;; List of potential master files for `newfile'
2528 (mapcar
2529 (lambda (s) (vc-possible-master s newdir newbase))
2530 templates)))
2531 (when (or (file-symlink-p oldmaster)
2532 (file-symlink-p (file-name-directory oldmaster)))
2533 (error "This is unsafe in the presence of symbolic links"))
2534 (rename-file
2535 oldmaster
2536 (catch 'found
2537 ;; If possible, keep the master file in the same directory.
2538 (dolist (f masters)
2539 (when (and f (string= (file-name-directory (expand-file-name f)) dir))
2540 (throw 'found f)))
2541 ;; If not, just use the first possible place.
2542 (dolist (f masters)
2543 (and f (or (not (setq dir (file-name-directory f)))
2544 (file-directory-p dir))
2545 (throw 'found f)))
2546 (error "New file lacks a version control directory")))))
2548 ;;;###autoload
2549 (defun vc-delete-file (file)
2550 "Delete file and mark it as such in the version control system."
2551 (interactive "fVC delete file: ")
2552 (setq file (expand-file-name file))
2553 (let ((buf (get-file-buffer file))
2554 (backend (vc-backend file)))
2555 (unless backend
2556 (error "File %s is not under version control"
2557 (file-name-nondirectory file)))
2558 (unless (vc-find-backend-function backend 'delete-file)
2559 (error "Deleting files under %s is not supported in VC" backend))
2560 (when (and buf (buffer-modified-p buf))
2561 (error "Please save or undo your changes before deleting %s" file))
2562 (let ((state (vc-state file)))
2563 (when (eq state 'edited)
2564 (error "Please commit or undo your changes before deleting %s" file))
2565 (when (eq state 'conflict)
2566 (error "Please resolve the conflicts before deleting %s" file)))
2567 (unless (y-or-n-p (format "Really want to delete %s? "
2568 (file-name-nondirectory file)))
2569 (error "Abort!"))
2570 (unless (or (file-directory-p file) (null make-backup-files)
2571 (not (file-exists-p file)))
2572 (with-current-buffer (or buf (find-file-noselect file))
2573 (let ((backup-inhibited nil))
2574 (backup-buffer))))
2575 ;; Bind `default-directory' so that the command that the backend
2576 ;; runs to remove the file is invoked in the correct context.
2577 (let ((default-directory (file-name-directory file)))
2578 (vc-call-backend backend 'delete-file file))
2579 ;; If the backend hasn't deleted the file itself, let's do it for him.
2580 (when (file-exists-p file) (delete-file file))
2581 ;; Forget what VC knew about the file.
2582 (vc-file-clearprops file)
2583 ;; Make sure the buffer is deleted and the *vc-dir* buffers are
2584 ;; updated after this.
2585 (vc-resynch-buffer file nil t)))
2587 ;;;###autoload
2588 (defun vc-rename-file (old new)
2589 "Rename file OLD to NEW in both work area and repository."
2590 (interactive "fVC rename file: \nFRename to: ")
2591 ;; in CL I would have said (setq new (merge-pathnames new old))
2592 (let ((old-base (file-name-nondirectory old)))
2593 (when (and (not (string= "" old-base))
2594 (string= "" (file-name-nondirectory new)))
2595 (setq new (concat new old-base))))
2596 (let ((oldbuf (get-file-buffer old)))
2597 (when (and oldbuf (buffer-modified-p oldbuf))
2598 (error "Please save files before moving them"))
2599 (when (get-file-buffer new)
2600 (error "Already editing new file name"))
2601 (when (file-exists-p new)
2602 (error "New file already exists"))
2603 (let ((state (vc-state old)))
2604 (unless (memq state '(up-to-date edited))
2605 (error "Please %s files before moving them"
2606 (if (stringp state) "check in" "update"))))
2607 (vc-call rename-file old new)
2608 (vc-file-clearprops old)
2609 ;; Move the actual file (unless the backend did it already)
2610 (when (file-exists-p old) (rename-file old new))
2611 ;; ?? Renaming a file might change its contents due to keyword expansion.
2612 ;; We should really check out a new copy if the old copy was precisely equal
2613 ;; to some checked-in revision. However, testing for this is tricky....
2614 (when oldbuf
2615 (with-current-buffer oldbuf
2616 (let ((buffer-read-only buffer-read-only))
2617 (set-visited-file-name new))
2618 (vc-mode-line new (vc-backend new))
2619 (set-buffer-modified-p nil)))))
2621 ;;;###autoload
2622 (defun vc-update-change-log (&rest args)
2623 "Find change log file and add entries from recent version control logs.
2624 Normally, find log entries for all registered files in the default
2625 directory.
2627 With prefix arg of \\[universal-argument], only find log entries for the current buffer's file.
2629 With any numeric prefix arg, find log entries for all currently visited
2630 files that are under version control. This puts all the entries in the
2631 log for the default directory, which may not be appropriate.
2633 From a program, any ARGS are assumed to be filenames for which
2634 log entries should be gathered."
2635 (interactive
2636 (cond ((consp current-prefix-arg) ;C-u
2637 (list buffer-file-name))
2638 (current-prefix-arg ;Numeric argument.
2639 (let ((files nil)
2640 (buffers (buffer-list))
2641 file)
2642 (while buffers
2643 (setq file (buffer-file-name (car buffers)))
2644 (and file (vc-backend file)
2645 (setq files (cons file files)))
2646 (setq buffers (cdr buffers)))
2647 files))
2649 ;; Don't supply any filenames to backend; this means
2650 ;; it should find all relevant files relative to
2651 ;; the default-directory.
2652 nil)))
2653 (vc-call-backend (vc-responsible-backend default-directory)
2654 'update-changelog args))
2656 ;; functions that operate on RCS revision numbers. This code should
2657 ;; also be moved into the backends. It stays for now, however, since
2658 ;; it is used in code below.
2659 (defun vc-branch-p (rev)
2660 "Return t if REV is a branch revision."
2661 (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev))))
2663 ;;;###autoload
2664 (defun vc-branch-part (rev)
2665 "Return the branch part of a revision number REV."
2666 (let ((index (string-match "\\.[0-9]+\\'" rev)))
2667 (when index
2668 (substring rev 0 index))))
2670 (defun vc-default-responsible-p (_backend _file)
2671 "Indicate whether BACKEND is responsible for FILE.
2672 The default is to return nil always."
2673 nil)
2675 (defun vc-default-could-register (_backend _file)
2676 "Return non-nil if BACKEND could be used to register FILE.
2677 The default implementation returns t for all files."
2680 (defun vc-default-latest-on-branch-p (_backend _file)
2681 "Return non-nil if FILE is the latest on its branch.
2682 This default implementation always returns non-nil, which means that
2683 editing non-current revisions is not supported by default."
2686 (defun vc-default-init-revision (_backend) vc-default-init-revision)
2688 (defun vc-default-find-revision (backend file rev buffer)
2689 "Provide the new `find-revision' op based on the old `checkout' op.
2690 This is only for compatibility with old backends. They should be updated
2691 to provide the `find-revision' operation instead."
2692 (let ((tmpfile (make-temp-file (expand-file-name file))))
2693 (unwind-protect
2694 (progn
2695 (vc-call-backend backend 'checkout file nil rev tmpfile)
2696 (with-current-buffer buffer
2697 (insert-file-contents-literally tmpfile)))
2698 (delete-file tmpfile))))
2700 (defun vc-default-rename-file (_backend old new)
2701 (condition-case nil
2702 (add-name-to-file old new)
2703 (error (rename-file old new)))
2704 (vc-delete-file old)
2705 (with-current-buffer (find-file-noselect new)
2706 (vc-register)))
2708 (defalias 'vc-default-check-headers 'ignore)
2710 (declare-function log-edit-mode "log-edit" ())
2712 (defun vc-default-log-edit-mode (_backend) (log-edit-mode))
2714 (defun vc-default-log-view-mode (_backend) (log-view-mode))
2716 (defun vc-default-show-log-entry (_backend rev)
2717 (with-no-warnings
2718 (log-view-goto-rev rev)))
2720 (defun vc-default-comment-history (backend file)
2721 "Return a string with all log entries stored in BACKEND for FILE."
2722 (when (vc-find-backend-function backend 'print-log)
2723 (with-current-buffer "*vc*"
2724 (vc-call-backend backend 'print-log (list file))
2725 (buffer-string))))
2727 (defun vc-default-receive-file (backend file rev)
2728 "Let BACKEND receive FILE from another version control system."
2729 (vc-call-backend backend 'register (list file) rev ""))
2731 (defun vc-default-retrieve-tag (backend dir name update)
2732 (if (string= name "")
2733 (progn
2734 (vc-file-tree-walk
2736 (lambda (f) (and
2737 (vc-up-to-date-p f)
2738 (vc-error-occurred
2739 (vc-call-backend backend 'checkout f nil "")
2740 (when update (vc-resynch-buffer f t t)))))))
2741 (let ((result (vc-tag-precondition dir)))
2742 (if (stringp result)
2743 (error "File %s is locked" result)
2744 (setq update (and (eq result 'visited) update))
2745 (vc-file-tree-walk
2747 (lambda (f) (vc-error-occurred
2748 (vc-call-backend backend 'checkout f nil name)
2749 (when update (vc-resynch-buffer f t t)))))))))
2751 (defun vc-default-revert (backend file contents-done)
2752 (unless contents-done
2753 (let ((rev (vc-working-revision file))
2754 (file-buffer (or (get-file-buffer file) (current-buffer))))
2755 (message "Checking out %s..." file)
2756 (let ((failed t)
2757 (backup-name (car (find-backup-file-name file))))
2758 (when backup-name
2759 (copy-file file backup-name 'ok-if-already-exists 'keep-date)
2760 (unless (file-writable-p file)
2761 (set-file-modes file (logior (file-modes file) 128))))
2762 (unwind-protect
2763 (let ((coding-system-for-read 'no-conversion)
2764 (coding-system-for-write 'no-conversion))
2765 (with-temp-file file
2766 (let ((outbuf (current-buffer)))
2767 ;; Change buffer to get local value of vc-checkout-switches.
2768 (with-current-buffer file-buffer
2769 (let ((default-directory (file-name-directory file)))
2770 (vc-call-backend backend 'find-revision
2771 file rev outbuf)))))
2772 (setq failed nil))
2773 (when backup-name
2774 (if failed
2775 (rename-file backup-name file 'ok-if-already-exists)
2776 (and (not vc-make-backup-files) (delete-file backup-name))))))
2777 (message "Checking out %s...done" file))))
2779 (defalias 'vc-default-revision-completion-table 'ignore)
2780 (defalias 'vc-default-mark-resolved 'ignore)
2782 (defun vc-default-dir-status-files (_backend _dir files default-state update-function)
2783 (funcall update-function
2784 (mapcar (lambda (file) (list file default-state)) files)))
2786 (defun vc-check-headers ()
2787 "Check if the current file has any headers in it."
2788 (interactive)
2789 (vc-call-backend (vc-backend buffer-file-name) 'check-headers))
2793 ;; These things should probably be generally available
2794 (define-obsolete-function-alias 'vc-string-prefix-p 'string-prefix-p "24.2")
2796 (defun vc-file-tree-walk (dirname func &rest args)
2797 "Walk recursively through DIRNAME.
2798 Invoke FUNC f ARGS on each VC-managed file f underneath it."
2799 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
2800 (message "Traversing directory %s...done" dirname))
2802 (defun vc-file-tree-walk-internal (file func args)
2803 (if (not (file-directory-p file))
2804 (when (vc-backend file) (apply func file args))
2805 (message "Traversing directory %s..." (abbreviate-file-name file))
2806 (let ((dir (file-name-as-directory file)))
2807 (mapcar
2808 (lambda (f) (or
2809 (string-equal f ".")
2810 (string-equal f "..")
2811 (member f vc-directory-exclusion-list)
2812 (let ((dirf (expand-file-name f dir)))
2814 (file-symlink-p dirf) ;; Avoid possible loops.
2815 (vc-file-tree-walk-internal dirf func args)))))
2816 (directory-files dir)))))
2818 (provide 'vc)
2820 ;;; vc.el ends here