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