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