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