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