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