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