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