Commit | Line | Data |
---|---|---|
66321b2f | 1 | ;;; vc.el --- drive a version-control system from within Emacs |
594722a8 | 2 | |
0d30b337 | 3 | ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000, |
f52749ed GM |
4 | ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 |
5 | ;; Free Software Foundation, Inc. | |
594722a8 | 6 | |
0e362f54 GM |
7 | ;; Author: FSF (see below for full credits) |
8 | ;; Maintainer: Andre Spiegel <spiegel@gnu.org> | |
284b3043 | 9 | ;; Keywords: tools |
594722a8 ER |
10 | |
11 | ;; This file is part of GNU Emacs. | |
12 | ||
eb3fa2cf | 13 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
594722a8 | 14 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
15 | ;; the Free Software Foundation, either version 3 of the License, or |
16 | ;; (at your option) any later version. | |
594722a8 ER |
17 | |
18 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
19 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
21 | ;; GNU General Public License for more details. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 24 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
594722a8 | 25 | |
0e362f54 GM |
26 | ;;; Credits: |
27 | ||
28 | ;; VC was initially designed and implemented by Eric S. Raymond | |
61de26cb | 29 | ;; <esr@thyrsus.com> in 1992. Over the years, many other people have |
0e362f54 | 30 | ;; contributed substantial amounts of work to VC. These include: |
61de26cb | 31 | ;; |
0e362f54 GM |
32 | ;; Per Cederqvist <ceder@lysator.liu.se> |
33 | ;; Paul Eggert <eggert@twinsun.com> | |
34 | ;; Sebastian Kremer <sk@thp.uni-koeln.de> | |
35 | ;; Martin Lorentzson <martinl@gnu.org> | |
166a0ef7 | 36 | ;; Dave Love <fx@gnu.org> |
0e362f54 | 37 | ;; Stefan Monnier <monnier@cs.yale.edu> |
7fbb4797 DN |
38 | ;; Thien-Thi Nguyen <ttn@gnu.org> |
39 | ;; Dan Nicolaescu <dann@ics.uci.edu> | |
6f1ecae4 | 40 | ;; J.D. Smith <jdsmith@alum.mit.edu> |
0e362f54 GM |
41 | ;; Andre Spiegel <spiegel@gnu.org> |
42 | ;; Richard Stallman <rms@gnu.org> | |
61de26cb ER |
43 | ;; |
44 | ;; In July 2007 ESR returned and redesigned the mode to cope better | |
45 | ;; with modern version-control systems that do commits by fileset | |
46 | ;; rather than per individual file. | |
47 | ;; | |
a7192ddb SM |
48 | ;; If you maintain a client of the mode or customize it in your .emacs, |
49 | ;; note that some backend functions which formerly took single file arguments | |
61de26cb ER |
50 | ;; now take a list of files. These include: register, checkin, print-log, |
51 | ;; rollback, and diff. | |
0e362f54 | 52 | |
594722a8 ER |
53 | ;;; Commentary: |
54 | ||
1a2f456b ER |
55 | ;; This mode is fully documented in the Emacs user's manual. |
56 | ;; | |
c0edfa75 | 57 | ;; Supported version-control systems presently include CVS, RCS, GNU |
6aa5d910 | 58 | ;; Arch, Subversion, Bzr, Git, Mercurial, Monotone and SCCS |
5e8c0b8b | 59 | ;; (or its free replacement, CSSC). |
b0c9bc8c AS |
60 | ;; |
61 | ;; Some features will not work with old RCS versions. Where | |
62 | ;; appropriate, VC finds out which version you have, and allows or | |
0e362f54 | 63 | ;; disallows those features (stealing locks, for example, works only |
b0c9bc8c | 64 | ;; from 5.6.2 onwards). |
632e9525 RS |
65 | ;; Even initial checkins will fail if your RCS version is so old that ci |
66 | ;; doesn't understand -t-; this has been known to happen to people running | |
0e362f54 | 67 | ;; NExTSTEP 3.0. |
594722a8 | 68 | ;; |
0e362f54 | 69 | ;; You can support the RCS -x option by customizing vc-rcs-master-templates. |
594722a8 ER |
70 | ;; |
71 | ;; Proper function of the SCCS diff commands requires the shellscript vcdiff | |
72 | ;; to be installed somewhere on Emacs's path for executables. | |
73 | ;; | |
1a2f456b | 74 | ;; If your site uses the ChangeLog convention supported by Emacs, the |
93a142e1 DN |
75 | ;; function `log-edit-comment-to-change-log' could prove a useful checkin hook, |
76 | ;; although you might prefer to use C-c C-a (i.e. `log-edit-insert-changelog') | |
1cca5da4 | 77 | ;; from the commit buffer instead or to set `log-edit-setup-invert'. |
1a2f456b | 78 | ;; |
594722a8 ER |
79 | ;; The vc code maintains some internal state in order to reduce expensive |
80 | ;; version-control operations to a minimum. Some names are only computed | |
3b37b179 | 81 | ;; once. If you perform version control operations with the backend while |
594722a8 ER |
82 | ;; vc's back is turned, or move/rename master files while vc is running, |
83 | ;; vc may get seriously confused. Don't do these things! | |
84 | ;; | |
85 | ;; Developer's notes on some concurrency issues are included at the end of | |
86 | ;; the file. | |
0e362f54 | 87 | ;; |
fcb500ea AS |
88 | ;; ADDING SUPPORT FOR OTHER BACKENDS |
89 | ;; | |
90 | ;; VC can use arbitrary version control systems as a backend. To add | |
91 | ;; support for a new backend named SYS, write a library vc-sys.el that | |
92 | ;; contains functions of the form `vc-sys-...' (note that SYS is in lower | |
93 | ;; case for the function and library names). VC will use that library if | |
94 | ;; you put the symbol SYS somewhere into the list of | |
95 | ;; `vc-handled-backends'. Then, for example, if `vc-sys-registered' | |
96 | ;; returns non-nil for a file, all SYS-specific versions of VC commands | |
97 | ;; will be available for that file. | |
98 | ;; | |
99 | ;; VC keeps some per-file information in the form of properties (see | |
100 | ;; vc-file-set/getprop in vc-hooks.el). The backend-specific functions | |
101 | ;; do not generally need to be aware of these properties. For example, | |
ac3f4c6f | 102 | ;; `vc-sys-working-revision' should compute the working revision and |
fcb500ea AS |
103 | ;; return it; it should not look it up in the property, and it needn't |
104 | ;; store it there either. However, if a backend-specific function does | |
105 | ;; store a value in a property, that value takes precedence over any | |
99cb8c8b | 106 | ;; value that the generic code might want to set (check for uses of |
fcb500ea AS |
107 | ;; the macro `with-vc-properties' in vc.el). |
108 | ;; | |
109 | ;; In the list of functions below, each identifier needs to be prepended | |
110 | ;; with `vc-sys-'. Some of the functions are mandatory (marked with a | |
111 | ;; `*'), others are optional (`-'). | |
112 | ;; | |
8cdd17b4 ER |
113 | ;; BACKEND PROPERTIES |
114 | ;; | |
115 | ;; * revision-granularity | |
116 | ;; | |
61de26cb ER |
117 | ;; Takes no arguments. Returns either 'file or 'repository. Backends |
118 | ;; that return 'file have per-file revision numbering; backends | |
119 | ;; that return 'repository have per-repository revision numbering, | |
120 | ;; so a revision level implicitly identifies a changeset | |
a7192ddb | 121 | ;; |
fcb500ea AS |
122 | ;; STATE-QUERYING FUNCTIONS |
123 | ;; | |
0e362f54 | 124 | ;; * registered (file) |
fcb500ea | 125 | ;; |
37a5e97a | 126 | ;; Return non-nil if FILE is registered in this backend. Both this |
73770b03 DN |
127 | ;; function as well as `state' should be careful to fail gracefully |
128 | ;; in the event that the backend executable is absent. It is | |
129 | ;; preferable that this function's body is autoloaded, that way only | |
130 | ;; calling vc-registered does not cause the backend to be loaded | |
131 | ;; (all the vc-FOO-registered functions are called to try to find | |
132 | ;; the controlling backend for FILE. | |
fcb500ea | 133 | ;; |
99cb8c8b | 134 | ;; * state (file) |
fcb500ea AS |
135 | ;; |
136 | ;; Return the current version control state of FILE. For a list of | |
137 | ;; possible values, see `vc-state'. This function should do a full and | |
138 | ;; reliable state computation; it is usually called immediately after | |
139 | ;; C-x v v. If you want to use a faster heuristic when visiting a | |
3702367b | 140 | ;; file, put that into `state-heuristic' below. Note that under most |
4903369a | 141 | ;; VCSes this won't be called at all, dir-status is used instead. |
fcb500ea | 142 | ;; |
0e362f54 | 143 | ;; - state-heuristic (file) |
fcb500ea AS |
144 | ;; |
145 | ;; If provided, this function is used to estimate the version control | |
146 | ;; state of FILE at visiting time. It should be considerably faster | |
147 | ;; than the implementation of `state'. For a list of possible values, | |
148 | ;; see the doc string of `vc-state'. | |
149 | ;; | |
c1b51374 | 150 | ;; - dir-status (dir update-function) |
00ca5ce2 | 151 | ;; |
1b3f2d4e DN |
152 | ;; Produce RESULT: a list of lists of the form (FILE VC-STATE EXTRA) |
153 | ;; for the files in DIR. | |
154 | ;; EXTRA can be used for backend specific information about FILE. | |
155 | ;; If a command needs to be run to compute this list, it should be | |
156 | ;; run asynchronously using (current-buffer) as the buffer for the | |
157 | ;; command. When RESULT is computed, it should be passed back by | |
c1b51374 | 158 | ;; doing: (funcall UPDATE-FUNCTION RESULT nil). |
d63aa41f | 159 | ;; If the backend uses a process filter, hence it produces partial results, |
5a84a937 | 160 | ;; they can be passed back by doing: |
c1b51374 SM |
161 | ;; (funcall UPDATE-FUNCTION RESULT t) |
162 | ;; and then do a (funcall UPDATE-FUNCTION RESULT nil) | |
5a84a937 | 163 | ;; when all the results have been computed. |
e1aec6fb | 164 | ;; To provide more backend specific functionality for `vc-dir' |
5a84a937 | 165 | ;; the following functions might be needed: `status-extra-headers', |
fb0ac090 | 166 | ;; `status-printer', `extra-status-menu' and `dir-status-files'. |
00ca5ce2 | 167 | ;; |
fb0ac090 AJ |
168 | ;; - dir-status-files (dir files default-state update-function) |
169 | ;; | |
170 | ;; This function is identical to dir-status except that it should | |
171 | ;; only report status for the specified FILES. Also it needs to | |
172 | ;; report on all requested files, including up-to-date or ignored | |
173 | ;; files. If not provided, the default is to consider that the files | |
174 | ;; are in DEFAULT-STATE. | |
175 | ;; | |
15c5c970 | 176 | ;; - status-extra-headers (dir) |
115c0061 | 177 | ;; |
e1aec6fb | 178 | ;; Return a string that will be added to the *vc-dir* buffer header. |
15c5c970 | 179 | ;; |
58f10bff DN |
180 | ;; - status-printer (fileinfo) |
181 | ;; | |
e1aec6fb | 182 | ;; Pretty print the `vc-dir-fileinfo' FILEINFO. |
58f10bff | 183 | ;; If a backend needs to show more information than the default FILE |
e1aec6fb SM |
184 | ;; and STATE in the vc-dir listing, it can store that extra |
185 | ;; information in `vc-dir-fileinfo->extra'. This function can be | |
186 | ;; used to display that extra information in the *vc-dir* buffer. | |
58f10bff | 187 | ;; |
5a84a937 DN |
188 | ;; - status-fileinfo-extra (file) |
189 | ;; | |
e1aec6fb | 190 | ;; Compute `vc-dir-fileinfo->extra' for FILE. |
5a84a937 | 191 | ;; |
ac3f4c6f | 192 | ;; * working-revision (file) |
fcb500ea | 193 | ;; |
ac3f4c6f | 194 | ;; Return the working revision of FILE. This is the revision fetched |
61de26cb | 195 | ;; by the last checkout or upate, not necessarily the same thing as the |
a7192ddb | 196 | ;; head or tip revision. Should return "0" for a file added but not yet |
61de26cb | 197 | ;; committed. |
fcb500ea AS |
198 | ;; |
199 | ;; - latest-on-branch-p (file) | |
200 | ;; | |
ac3f4c6f ER |
201 | ;; Return non-nil if the working revision of FILE is the latest revision |
202 | ;; on its branch (many VCSes call this the 'tip' or 'head' revision). | |
0d0e9356 | 203 | ;; The default implementation always returns t, which means that |
ac3f4c6f | 204 | ;; working with non-current revisions is not supported by default. |
fcb500ea | 205 | ;; |
e0607aaa | 206 | ;; * checkout-model (files) |
fcb500ea | 207 | ;; |
e0607aaa | 208 | ;; Indicate whether FILES need to be "checked out" before they can be |
fcb500ea AS |
209 | ;; edited. See `vc-checkout-model' for a list of possible values. |
210 | ;; | |
aae91380 | 211 | ;; - workfile-unchanged-p (file) |
fcb500ea | 212 | ;; |
ac3f4c6f ER |
213 | ;; Return non-nil if FILE is unchanged from the working revision. |
214 | ;; This function should do a brief comparison of FILE's contents | |
215 | ;; with those of the repository master of the working revision. If | |
216 | ;; the backend does not have such a brief-comparison feature, the | |
217 | ;; default implementation of this function can be used, which | |
218 | ;; delegates to a full vc-BACKEND-diff. (Note that vc-BACKEND-diff | |
219 | ;; must not run asynchronously in this case, see variable | |
0d0e9356 | 220 | ;; `vc-disable-async-diff'.) |
fcb500ea | 221 | ;; |
0e362f54 | 222 | ;; - mode-line-string (file) |
fcb500ea | 223 | ;; |
3a12f9f8 | 224 | ;; If provided, this function should return the VC-specific mode |
a7192ddb | 225 | ;; line string for FILE. The returned string should have a |
3a12f9f8 DN |
226 | ;; `help-echo' property which is the text to be displayed as a |
227 | ;; tooltip when the mouse hovers over the VC entry on the mode-line. | |
228 | ;; The default implementation deals well with all states that | |
229 | ;; `vc-state' can return. | |
fcb500ea | 230 | ;; |
0a299408 | 231 | ;; - prettify-state-info (file) |
fcb500ea AS |
232 | ;; |
233 | ;; Translate the `vc-state' property of FILE into a string that can be | |
0a299408 | 234 | ;; used in a human-readable buffer. The default implementation deals well |
fcb500ea AS |
235 | ;; with all states that `vc-state' can return. |
236 | ;; | |
237 | ;; STATE-CHANGING FUNCTIONS | |
238 | ;; | |
61de26cb | 239 | ;; * create-repo (backend) |
8cdd17b4 | 240 | ;; |
a7192ddb SM |
241 | ;; Create an empty repository in the current directory and initialize |
242 | ;; it so VC mode can add files to it. For file-oriented systems, this | |
8cdd17b4 ER |
243 | ;; need do no more than create a subdirectory with the right name. |
244 | ;; | |
245 | ;; * register (files &optional rev comment) | |
fcb500ea | 246 | ;; |
8cdd17b4 ER |
247 | ;; Register FILES in this backend. Optionally, an initial revision REV |
248 | ;; and an initial description of the file, COMMENT, may be specified, | |
249 | ;; but it is not guaranteed that the backend will do anything with this. | |
ecd50f65 | 250 | ;; The implementation should pass the value of vc-register-switches |
a7192ddb | 251 | ;; to the backend command. (Note: in older versions of VC, this |
8cdd17b4 | 252 | ;; command took a single file argument and not a list.) |
fcb500ea | 253 | ;; |
ac3f4c6f | 254 | ;; - init-revision (file) |
b470cb65 | 255 | ;; |
ac3f4c6f | 256 | ;; The initial revision to use when registering FILE if one is not |
b470cb65 | 257 | ;; specified by the user. If not provided, the variable |
ac3f4c6f | 258 | ;; vc-default-init-revision is used instead. |
b470cb65 | 259 | ;; |
099bd78a | 260 | ;; - responsible-p (file) |
fcb500ea AS |
261 | ;; |
262 | ;; Return non-nil if this backend considers itself "responsible" for | |
263 | ;; FILE, which can also be a directory. This function is used to find | |
264 | ;; out what backend to use for registration of new files and for things | |
265 | ;; like change log generation. The default implementation always | |
266 | ;; returns nil. | |
267 | ;; | |
0e362f54 | 268 | ;; - could-register (file) |
fcb500ea AS |
269 | ;; |
270 | ;; Return non-nil if FILE could be registered under this backend. The | |
271 | ;; default implementation always returns t. | |
272 | ;; | |
aae91380 | 273 | ;; - receive-file (file rev) |
fcb500ea AS |
274 | ;; |
275 | ;; Let this backend "receive" a file that is already registered under | |
276 | ;; another backend. The default implementation simply calls `register' | |
277 | ;; for FILE, but it can be overridden to do something more specific, | |
278 | ;; e.g. keep revision numbers consistent or choose editing modes for | |
279 | ;; FILE that resemble those of the other backend. | |
280 | ;; | |
281 | ;; - unregister (file) | |
282 | ;; | |
283 | ;; Unregister FILE from this backend. This is only needed if this | |
284 | ;; backend may be used as a "more local" backend for temporary editing. | |
285 | ;; | |
8cdd17b4 | 286 | ;; * checkin (files rev comment) |
fcb500ea | 287 | ;; |
8cdd17b4 ER |
288 | ;; Commit changes in FILES to this backend. If REV is non-nil, that |
289 | ;; should become the new revision number (not all backends do | |
290 | ;; anything with it). COMMENT is used as a check-in comment. The | |
291 | ;; implementation should pass the value of vc-checkin-switches to | |
a7192ddb | 292 | ;; the backend command. (Note: in older versions of VC, this |
8cdd17b4 | 293 | ;; command took a single file argument and not a list.) |
fcb500ea | 294 | ;; |
ac3f4c6f | 295 | ;; * find-revision (file rev buffer) |
fd8160f7 SM |
296 | ;; |
297 | ;; Fetch revision REV of file FILE and put it into BUFFER. | |
298 | ;; If REV is the empty string, fetch the head of the trunk. | |
299 | ;; The implementation should pass the value of vc-checkout-switches | |
300 | ;; to the backend command. | |
301 | ;; | |
9e6da495 | 302 | ;; * checkout (file &optional editable rev) |
fcb500ea AS |
303 | ;; |
304 | ;; Check out revision REV of FILE into the working area. If EDITABLE | |
305 | ;; is non-nil, FILE should be writable by the user and if locking is | |
306 | ;; used for FILE, a lock should also be set. If REV is non-nil, that | |
ac3f4c6f | 307 | ;; is the revision to check out (default is the working revision). |
4279775b AS |
308 | ;; If REV is t, that means to check out the head of the current branch; |
309 | ;; if it is the empty string, check out the head of the trunk. | |
310 | ;; The implementation should pass the value of vc-checkout-switches | |
fd8160f7 | 311 | ;; to the backend command. |
fcb500ea | 312 | ;; |
bbfc07d3 | 313 | ;; * revert (file &optional contents-done) |
fcb500ea | 314 | ;; |
ac3f4c6f | 315 | ;; Revert FILE back to the working revision. If optional |
bbfc07d3 AS |
316 | ;; arg CONTENTS-DONE is non-nil, then the contents of FILE have |
317 | ;; already been reverted from a version backup, and this function | |
318 | ;; only needs to update the status of FILE within the backend. | |
fcb500ea | 319 | ;; |
8cdd17b4 | 320 | ;; - rollback (files) |
fcb500ea | 321 | ;; |
ac3f4c6f ER |
322 | ;; Remove the tip revision of each of FILES from the repository. If |
323 | ;; this function is not provided, trying to cancel a revision is | |
8cdd17b4 ER |
324 | ;; caught as an error. (Most backends don't provide it.) (Also |
325 | ;; note that older versions of this backend command were called | |
326 | ;; 'cancel-version' and took a single file arg, not a list of | |
327 | ;; files.) | |
fcb500ea | 328 | ;; |
aae91380 | 329 | ;; - merge (file rev1 rev2) |
fcb500ea AS |
330 | ;; |
331 | ;; Merge the changes between REV1 and REV2 into the current working file. | |
332 | ;; | |
aae91380 | 333 | ;; - merge-news (file) |
fcb500ea AS |
334 | ;; |
335 | ;; Merge recent changes from the current branch into FILE. | |
336 | ;; | |
ac3f4c6f | 337 | ;; - steal-lock (file &optional revision) |
fcb500ea | 338 | ;; |
ac3f4c6f | 339 | ;; Steal any lock on the working revision of FILE, or on REVISION if |
0d0e9356 ER |
340 | ;; that is provided. This function is only needed if locking is |
341 | ;; used for files under this backend, and if files can indeed be | |
342 | ;; locked by other users. | |
fcb500ea | 343 | ;; |
9b64a7f0 ER |
344 | ;; - modify-change-comment (files rev comment) |
345 | ;; | |
df49d02e | 346 | ;; Modify the change comments associated with the files at the |
9b64a7f0 ER |
347 | ;; given revision. This is optional, many backends do not support it. |
348 | ;; | |
7fbb4797 DN |
349 | ;; - mark-resolved (files) |
350 | ;; | |
351 | ;; Mark conflicts as resolved. Some VC systems need to run a | |
352 | ;; command to mark conflicts as resolved. | |
353 | ;; | |
fcb500ea AS |
354 | ;; HISTORY FUNCTIONS |
355 | ;; | |
8cdd17b4 | 356 | ;; * print-log (files &optional buffer) |
fcb500ea | 357 | ;; |
8cdd17b4 ER |
358 | ;; Insert the revision log for FILES into BUFFER, or the *vc* buffer |
359 | ;; if BUFFER is nil. (Note: older versions of this function expected | |
360 | ;; only a single file argument.) | |
fcb500ea | 361 | ;; |
37a5e97a SM |
362 | ;; - log-view-mode () |
363 | ;; | |
364 | ;; Mode to use for the output of print-log. This defaults to | |
365 | ;; `log-view-mode' and is expected to be changed (if at all) to a derived | |
366 | ;; mode of `log-view-mode'. | |
367 | ;; | |
ac3f4c6f | 368 | ;; - show-log-entry (revision) |
fcb500ea | 369 | ;; |
ac3f4c6f | 370 | ;; If provided, search the log entry for REVISION in the current buffer, |
fcb500ea AS |
371 | ;; and make sure it is displayed in the buffer's window. The default |
372 | ;; implementation of this function works for RCS-style logs. | |
373 | ;; | |
aae91380 | 374 | ;; - comment-history (file) |
fcb500ea | 375 | ;; |
d6ba9c39 | 376 | ;; Return a string containing all log entries that were made for FILE. |
fcb500ea | 377 | ;; This is used for transferring a file from one backend to another, |
6aa5d910 | 378 | ;; retaining comment information. |
fcb500ea | 379 | ;; |
aae91380 | 380 | ;; - update-changelog (files) |
fcb500ea AS |
381 | ;; |
382 | ;; Using recent log entries, create ChangeLog entries for FILES, or for | |
383 | ;; all files at or below the default-directory if FILES is nil. The | |
384 | ;; default implementation runs rcs2log, which handles RCS- and | |
385 | ;; CVS-style logs. | |
386 | ;; | |
d7b60083 | 387 | ;; * diff (files &optional rev1 rev2 buffer) |
fcb500ea | 388 | ;; |
ac9ff209 AS |
389 | ;; Insert the diff for FILE into BUFFER, or the *vc-diff* buffer if |
390 | ;; BUFFER is nil. If REV1 and REV2 are non-nil, report differences | |
ac3f4c6f ER |
391 | ;; from REV1 to REV2. If REV1 is nil, use the working revision (as |
392 | ;; found in the repository) as the older revision; if REV2 is nil, | |
393 | ;; use the current working-copy contents as the newer revision. This | |
394 | ;; function should pass the value of (vc-switches BACKEND 'diff) to | |
395 | ;; the backend command. It should return a status of either 0 (no | |
396 | ;; differences found), or 1 (either non-empty diff or the diff is | |
397 | ;; run asynchronously). | |
fcb500ea | 398 | ;; |
a7192ddb | 399 | ;; - revision-completion-table (files) |
4d83a657 | 400 | ;; |
a7192ddb | 401 | ;; Return a completion table for existing revisions of FILES. |
4d83a657 SM |
402 | ;; The default is to not use any completion table. |
403 | ;; | |
3c42cc64 | 404 | ;; - annotate-command (file buf &optional rev) |
fcb500ea | 405 | ;; |
3c42cc64 | 406 | ;; If this function is provided, it should produce an annotated display |
ac3f4c6f | 407 | ;; of FILE in BUF, relative to revision REV. Annotation means each line |
3c42cc64 TTN |
408 | ;; of FILE displayed is prefixed with version information associated with |
409 | ;; its addition (deleted lines leave no history) and that the text of the | |
410 | ;; file is fontified according to age. | |
fcb500ea | 411 | ;; |
75665141 | 412 | ;; - annotate-time () |
fcb500ea AS |
413 | ;; |
414 | ;; Only required if `annotate-command' is defined for the backend. | |
75665141 AS |
415 | ;; Return the time of the next line of annotation at or after point, |
416 | ;; as a floating point fractional number of days. The helper | |
417 | ;; function `vc-annotate-convert-time' may be useful for converting | |
418 | ;; multi-part times as returned by `current-time' and `encode-time' | |
0ff9b955 | 419 | ;; to this format. Return nil if no more lines of annotation appear |
75665141 AS |
420 | ;; in the buffer. You can safely assume that point is placed at the |
421 | ;; beginning of each line, starting at `point-min'. The buffer that | |
422 | ;; point is placed in is the Annotate output, as defined by the | |
946b248f TTN |
423 | ;; relevant backend. This function also affects how much of the line |
424 | ;; is fontified; where it leaves point is where fontification begins. | |
75665141 AS |
425 | ;; |
426 | ;; - annotate-current-time () | |
427 | ;; | |
428 | ;; Only required if `annotate-command' is defined for the backend, | |
429 | ;; AND you'd like the current time considered to be anything besides | |
cb223bba | 430 | ;; (vc-annotate-convert-time (current-time)) -- i.e. the current |
75665141 AS |
431 | ;; time with hours, minutes, and seconds included. Probably safe to |
432 | ;; ignore. Return the current-time, in units of fractional days. | |
fcb500ea | 433 | ;; |
1b5a7343 AS |
434 | ;; - annotate-extract-revision-at-line () |
435 | ;; | |
436 | ;; Only required if `annotate-command' is defined for the backend. | |
437 | ;; Invoked from a buffer in vc-annotate-mode, return the revision | |
438 | ;; corresponding to the current line, or nil if there is no revision | |
439 | ;; corresponding to the current line. | |
440 | ;; | |
fcb500ea AS |
441 | ;; SNAPSHOT SYSTEM |
442 | ;; | |
0e362f54 | 443 | ;; - create-snapshot (dir name branchp) |
fcb500ea AS |
444 | ;; |
445 | ;; Take a snapshot of the current state of files under DIR and name it | |
446 | ;; NAME. This should make sure that files are up-to-date before | |
447 | ;; proceeding with the action. DIR can also be a file and if BRANCHP | |
448 | ;; is specified, NAME should be created as a branch and DIR should be | |
449 | ;; checked out under this new branch. The default implementation does | |
450 | ;; not support branches but does a sanity check, a tree traversal and | |
451 | ;; for each file calls `assign-name'. | |
452 | ;; | |
453 | ;; - assign-name (file name) | |
454 | ;; | |
ac3f4c6f | 455 | ;; Give name NAME to the working revision of FILE, assuming it is |
fcb500ea AS |
456 | ;; up-to-date. Only used by the default version of `create-snapshot'. |
457 | ;; | |
0e362f54 | 458 | ;; - retrieve-snapshot (dir name update) |
fcb500ea AS |
459 | ;; |
460 | ;; Retrieve a named snapshot of all registered files at or below DIR. | |
461 | ;; If UPDATE is non-nil, then update buffers of any files in the | |
462 | ;; snapshot that are currently visited. The default implementation | |
463 | ;; does a sanity check whether there aren't any uncommitted changes at | |
464 | ;; or below DIR, and then performs a tree walk, using the `checkout' | |
ac3f4c6f | 465 | ;; function to retrieve the corresponding revisions. |
fcb500ea AS |
466 | ;; |
467 | ;; MISCELLANEOUS | |
468 | ;; | |
f4263e47 TTN |
469 | ;; - root (dir) |
470 | ;; | |
471 | ;; Return DIR's "root" directory, that is, a parent directory of | |
472 | ;; DIR for which the same backend as used for DIR applies. If no | |
473 | ;; such parent exists, this function should return DIR. | |
474 | ;; | |
aae91380 | 475 | ;; - make-version-backups-p (file) |
fcb500ea | 476 | ;; |
ac3f4c6f | 477 | ;; Return non-nil if unmodified repository revisions of FILE should be |
fcb500ea AS |
478 | ;; backed up locally. If this is done, VC can perform `diff' and |
479 | ;; `revert' operations itself, without calling the backend system. The | |
480 | ;; default implementation always returns nil. | |
481 | ;; | |
a36319a4 SM |
482 | ;; - repository-hostname (dirname) |
483 | ;; | |
484 | ;; Return the hostname that the backend will have to contact | |
485 | ;; in order to operate on a file in DIRNAME. If the return value | |
0452b6e7 | 486 | ;; is nil, it means that the repository is local. |
a36319a4 SM |
487 | ;; This function is used in `vc-stay-local-p' which backends can use |
488 | ;; for their convenience. | |
489 | ;; | |
ac3f4c6f | 490 | ;; - previous-revision (file rev) |
869131a5 | 491 | ;; |
ac3f4c6f ER |
492 | ;; Return the revision number that precedes REV for FILE, or nil if no such |
493 | ;; revision exists. | |
1b5a7343 | 494 | ;; |
ac3f4c6f | 495 | ;; - next-revision (file rev) |
1b5a7343 | 496 | ;; |
ac3f4c6f ER |
497 | ;; Return the revision number that follows REV for FILE, or nil if no such |
498 | ;; revision exists. | |
869131a5 | 499 | ;; |
aae91380 | 500 | ;; - check-headers () |
fcb500ea AS |
501 | ;; |
502 | ;; Return non-nil if the current buffer contains any version headers. | |
503 | ;; | |
aae91380 | 504 | ;; - clear-headers () |
fcb500ea AS |
505 | ;; |
506 | ;; In the current buffer, reset all version headers to their unexpanded | |
507 | ;; form. This function should be provided if the state-querying code | |
508 | ;; for this backend uses the version headers to determine the state of | |
509 | ;; a file. This function will then be called whenever VC changes the | |
510 | ;; version control state in such a way that the headers would give | |
511 | ;; wrong information. | |
512 | ;; | |
a36319a4 SM |
513 | ;; - delete-file (file) |
514 | ;; | |
515 | ;; Delete FILE and mark it as deleted in the repository. If this | |
516 | ;; function is not provided, the command `vc-delete-file' will | |
517 | ;; signal an error. | |
518 | ;; | |
099bd78a | 519 | ;; - rename-file (old new) |
fcb500ea AS |
520 | ;; |
521 | ;; Rename file OLD to NEW, both in the working area and in the | |
a36319a4 SM |
522 | ;; repository. If this function is not provided, the renaming |
523 | ;; will be done by (vc-delete-file old) and (vc-register new). | |
86a65190 | 524 | ;; |
6e54fa53 SM |
525 | ;; - find-file-hook () |
526 | ;; | |
81c63b50 | 527 | ;; Operation called in current buffer when opening a file. This can |
6e54fa53 | 528 | ;; be used by the backend to setup some local variables it might need. |
cb223bba | 529 | ;; |
81c63b50 SM |
530 | ;; - find-file-not-found-hook () |
531 | ;; | |
532 | ;; Operation called in current buffer when opening a non-existing file. | |
533 | ;; By default, this asks the user if she wants to check out the file. | |
cb223bba DN |
534 | ;; |
535 | ;; - extra-menu () | |
536 | ;; | |
537 | ;; Return a menu keymap, the items in the keymap will appear at the | |
538 | ;; end of the Version Control menu. The goal is to allow backends | |
539 | ;; to specify extra menu items that appear in the VC menu. This way | |
540 | ;; you can provide menu entries for functionality that is specific | |
541 | ;; to your backend and which does not map to any of the VC generic | |
542 | ;; concepts. | |
6656ecaa DN |
543 | ;; |
544 | ;; - extra-status-menu () | |
545 | ;; | |
25a4ea6d DN |
546 | ;; Return a menu keymap, the items in the keymap will appear at the |
547 | ;; end of the VC Status menu. The goal is to allow backends to | |
548 | ;; specify extra menu items that appear in the VC Status menu. This | |
549 | ;; makes it possible to provide menu entries for functionality that | |
550 | ;; is specific to a backend and which does not map to any of the VC | |
551 | ;; generic concepts. | |
aae91380 | 552 | |
ba463d9e DN |
553 | ;;; Todo: |
554 | ||
ba463d9e DN |
555 | ;; - vc-update/vc-merge should deal with VC systems that don't |
556 | ;; update/merge on a file basis, but on a whole repository basis. | |
557 | ;; | |
fc30d544 DN |
558 | ;; - deal with push/pull operations. |
559 | ;; | |
560 | ;; - "snapshots" should be renamed to "branches", and thoroughly reworked. | |
561 | ;; | |
7fbb4797 DN |
562 | ;; - when a file is in `conflict' state, turn on smerge-mode. |
563 | ;; | |
564 | ;; - figure out what to do with conflicts that are not caused by the | |
7a3c8d3a ER |
565 | ;; file contents, but by metadata or other causes. Example: File A |
566 | ;; gets renamed to B in one branch and to C in another and you merge | |
567 | ;; the two branches. Or you locally add file FOO and then pull a | |
568 | ;; change that also adds a new file FOO, ... | |
ba463d9e | 569 | ;; |
fc30d544 DN |
570 | ;; - add a generic mechanism for remembering the current branch names, |
571 | ;; display the branch name in the mode-line. Replace | |
572 | ;; vc-cvs-sticky-tag with that. | |
573 | ;; | |
7a3c8d3a ER |
574 | ;; - C-x v b does switch to a different backend, but the mode line is not |
575 | ;; adapted accordingly. Also, it considers RCS and CVS to be the same, | |
576 | ;; which is pretty confusing. | |
577 | ;; | |
5a84a937 | 578 | ;; - vc-diff should be able to show the diff for all files in a |
7fbb4797 DN |
579 | ;; changeset, especially for VC systems that have per repository |
580 | ;; version numbers. log-view should take advantage of this. | |
5a84a937 | 581 | ;; |
fc30d544 DN |
582 | ;; - make it easier to write logs. Maybe C-x 4 a should add to the log |
583 | ;; buffer, if one is present, instead of adding to the ChangeLog. | |
ba463d9e | 584 | ;; |
9b4ab1b4 ER |
585 | ;; - add a mechanism for editing the underlying VCS's list of files |
586 | ;; to be ignored, when that's possible. | |
3b3cb336 | 587 | ;; |
5bd20ee6 DN |
588 | ;; - When vc-next-action calls vc-checkin it could pre-fill the |
589 | ;; *VC-log* buffer with some obvious items: the list of files that | |
590 | ;; were added, the list of files that were removed. If the diff is | |
591 | ;; available, maybe it could even call something like | |
592 | ;; `diff-add-change-log-entries-other-window' to create a detailed | |
593 | ;; skeleton for the log... | |
594 | ;; | |
5bd20ee6 DN |
595 | ;; - a way to do repository wide log (instead of just per |
596 | ;; file/fileset) is needed. Doing it per directory might be enough... | |
7fbb4797 | 597 | ;; |
e1aec6fb | 598 | ;; - most vc-dir backends need more work. They might need to |
7fbb4797 DN |
599 | ;; provide custom headers, use the `extra' field and deal with all |
600 | ;; possible VC states. | |
601 | ;; | |
e1aec6fb | 602 | ;; - add function that calls vc-dir to `find-directory-functions'. |
d6f47dff | 603 | ;; |
d3201e0b DN |
604 | ;; - vc-diff, vc-annotate, etc. need to deal better with unregistered |
605 | ;; files. Now that unregistered and ignored files are shown in | |
4903369a | 606 | ;; vc-dir, it is possible that these commands are called |
d3201e0b DN |
607 | ;; for unregistered/ignored files. |
608 | ;; | |
3f08440f DN |
609 | ;; - do not default to RCS anymore when the current directory is not |
610 | ;; controlled by any VCS and the user does C-x v v | |
611 | ;; | |
5bd20ee6 DN |
612 | ;; - vc-create-snapshot and vc-retrieve-snapshot should update the |
613 | ;; buffers that might be visiting the affected files. | |
1cb119fd | 614 | ;; |
a84615c7 SS |
615 | ;; - Using multiple backends needs work. Given a CVS directory with some |
616 | ;; files checked into git (but not all), using C-x v l to get a log file | |
617 | ;; from a file only present in git, and then typing RET on some log entry, | |
18a083fd ER |
618 | ;; vc will bombs out because it wants to see the file being in CVS. |
619 | ;; Those logs should likely use a local variable to hardware the VC they | |
620 | ;; are supposed to work with. | |
621 | ;; | |
7a3c8d3a | 622 | ;; - Another important thing: merge all the status-like backend operations. |
4903369a | 623 | ;; We should remove dir-status, state, and dir-status-files, and |
7a3c8d3a ER |
624 | ;; replace them with just `status' which takes a fileset and a continuation |
625 | ;; (like dir-status) and returns a buffer in which the process(es) are run | |
626 | ;; (or nil if it worked synchronously). Hopefully we can define the old | |
627 | ;; 4 operations in term of this one. | |
628 | ;; | |
80296236 DN |
629 | ;; - backends that care about vc-stay-local should try to take it into |
630 | ;; account for vc-dir. Is this likely to be useful??? | |
631 | ;; | |
0a299408 ER |
632 | ;; - vc-dir listing needs a footer generated when it's done to make it obvious |
633 | ;; that it has finished. | |
634 | ;; | |
7a3c8d3a | 635 | |
fcb500ea | 636 | ;;; Code: |
0e362f54 | 637 | |
594722a8 | 638 | (require 'vc-hooks) |
92d1eebf | 639 | (require 'vc-dispatcher) |
64db3a90 | 640 | (require 'tool-bar) |
7fbb4797 | 641 | (require 'ewoc) |
64db3a90 | 642 | |
b1ddeeb7 | 643 | (eval-when-compile |
4f61cc3e | 644 | (require 'cl)) |
b1ddeeb7 | 645 | |
b5446276 DN |
646 | (unless (assoc 'vc-parent-buffer minor-mode-alist) |
647 | (setq minor-mode-alist | |
648 | (cons '(vc-parent-buffer vc-parent-buffer-name) | |
649 | minor-mode-alist))) | |
594722a8 ER |
650 | |
651 | ;; General customization | |
652 | ||
0101cc40 RS |
653 | (defgroup vc nil |
654 | "Version-control system in Emacs." | |
655 | :group 'tools) | |
656 | ||
0101cc40 | 657 | (defcustom vc-initial-comment nil |
04864eb0 | 658 | "If non-nil, prompt for initial comment when a file is registered." |
0101cc40 RS |
659 | :type 'boolean |
660 | :group 'vc) | |
661 | ||
ac3f4c6f ER |
662 | (defcustom vc-default-init-revision "1.1" |
663 | "A string used as the default revision number when a new file is registered. | |
b470cb65 AS |
664 | This can be overridden by giving a prefix argument to \\[vc-register]. This |
665 | can also be overridden by a particular VC backend." | |
0d53f466 | 666 | :type 'string |
cd32a7ba DN |
667 | :group 'vc |
668 | :version "20.3") | |
0d53f466 | 669 | |
0101cc40 | 670 | (defcustom vc-checkin-switches nil |
04864eb0 | 671 | "A string or list of strings specifying extra switches for checkin. |
0101cc40 RS |
672 | These are passed to the checkin program by \\[vc-checkin]." |
673 | :type '(choice (const :tag "None" nil) | |
674 | (string :tag "Argument String") | |
675 | (repeat :tag "Argument List" | |
676 | :value ("") | |
677 | string)) | |
678 | :group 'vc) | |
679 | ||
680 | (defcustom vc-checkout-switches nil | |
04864eb0 | 681 | "A string or list of strings specifying extra switches for checkout. |
0101cc40 RS |
682 | These are passed to the checkout program by \\[vc-checkout]." |
683 | :type '(choice (const :tag "None" nil) | |
684 | (string :tag "Argument String") | |
685 | (repeat :tag "Argument List" | |
686 | :value ("") | |
687 | string)) | |
688 | :group 'vc) | |
689 | ||
690 | (defcustom vc-register-switches nil | |
04864eb0 | 691 | "A string or list of strings; extra switches for registering a file. |
0101cc40 RS |
692 | These are passed to the checkin program by \\[vc-register]." |
693 | :type '(choice (const :tag "None" nil) | |
694 | (string :tag "Argument String") | |
695 | (repeat :tag "Argument List" | |
696 | :value ("") | |
697 | string)) | |
698 | :group 'vc) | |
699 | ||
acc5b122 | 700 | (defcustom vc-diff-switches nil |
04864eb0 | 701 | "A string or list of strings specifying switches for diff under VC. |
b453817c AS |
702 | When running diff under a given BACKEND, VC concatenates the values of |
703 | `diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to | |
704 | get the switches for that command. Thus, `vc-diff-switches' should | |
705 | contain switches that are specific to version control, but not | |
706 | specific to any particular backend." | |
acc5b122 AS |
707 | :type '(choice (const :tag "None" nil) |
708 | (string :tag "Argument String") | |
709 | (repeat :tag "Argument List" | |
710 | :value ("") | |
711 | string)) | |
712 | :group 'vc | |
713 | :version "21.1") | |
714 | ||
48033a08 AS |
715 | (defcustom vc-diff-knows-L nil |
716 | "*Indicates whether diff understands the -L option. | |
717 | The value is either `yes', `no', or nil. If it is nil, VC tries | |
718 | to use -L and sets this variable to remember whether it worked." | |
719 | :type '(choice (const :tag "Work out" nil) (const yes) (const no)) | |
720 | :group 'vc) | |
721 | ||
f1d1d46a | 722 | (defcustom vc-allow-async-revert nil |
e4d26892 | 723 | "Specifies whether the diff during \\[vc-revert] may be asynchronous. |
f1d1d46a AS |
724 | Enabling this option means that you can confirm a revert operation even |
725 | if the local changes in the file have not been found and displayed yet." | |
726 | :type '(choice (const :tag "No" nil) | |
727 | (const :tag "Yes" t)) | |
728 | :group 'vc | |
bf247b6e | 729 | :version "22.1") |
f1d1d46a | 730 | |
7cad930d AS |
731 | ;;;###autoload |
732 | (defcustom vc-checkout-hook nil | |
04864eb0 | 733 | "Normal hook (list of functions) run after checking out a file. |
7cad930d AS |
734 | See `run-hooks'." |
735 | :type 'hook | |
736 | :group 'vc | |
737 | :version "21.1") | |
738 | ||
da7c8a12 | 739 | (defcustom vc-annotate-display-mode 'fullscale |
6f1ecae4 | 740 | "Which mode to color the output of \\[vc-annotate] with by default." |
da7c8a12 | 741 | :type '(choice (const :tag "By Color Map Range" nil) |
75665141 AS |
742 | (const :tag "Scale to Oldest" scale) |
743 | (const :tag "Scale Oldest->Newest" fullscale) | |
744 | (number :tag "Specify Fractional Number of Days" | |
745 | :value "20.5")) | |
746 | :group 'vc) | |
747 | ||
0e362f54 GM |
748 | ;;;###autoload |
749 | (defcustom vc-checkin-hook nil | |
61de26cb | 750 | "Normal hook (list of functions) run after commit or file checkin. |
1cca5da4 | 751 | See also `log-edit-done-hook'." |
0e362f54 | 752 | :type 'hook |
1cca5da4 | 753 | :options '(log-edit-comment-to-change-log) |
0e362f54 GM |
754 | :group 'vc) |
755 | ||
756 | ;;;###autoload | |
757 | (defcustom vc-before-checkin-hook nil | |
61de26cb | 758 | "Normal hook (list of functions) run before a commit or a file checkin. |
0e362f54 GM |
759 | See `run-hooks'." |
760 | :type 'hook | |
761 | :group 'vc) | |
762 | ||
0e362f54 | 763 | ;; Annotate customization |
7d2d9482 | 764 | (defcustom vc-annotate-color-map |
da7c8a12 S |
765 | (if (and (tty-display-color-p) (<= (display-color-cells) 8)) |
766 | ;; A custom sorted TTY colormap | |
767 | (let* ((colors | |
768 | (sort | |
769 | (delq nil | |
770 | (mapcar (lambda (x) | |
771 | (if (not (or | |
772 | (string-equal (car x) "white") | |
773 | (string-equal (car x) "black") )) | |
774 | (car x))) | |
775 | (tty-color-alist))) | |
776 | (lambda (a b) | |
777 | (cond | |
778 | ((or (string-equal a "red") (string-equal b "blue")) t) | |
779 | ((or (string-equal b "red") (string-equal a "blue")) nil) | |
780 | ((string-equal a "yellow") t) | |
781 | ((string-equal b "yellow") nil) | |
782 | ((string-equal a "cyan") t) | |
783 | ((string-equal b "cyan") nil) | |
784 | ((string-equal a "green") t) | |
785 | ((string-equal b "green") nil) | |
786 | ((string-equal a "magenta") t) | |
787 | ((string-equal b "magenta") nil) | |
788 | (t (string< a b)))))) | |
789 | (date 20.) | |
790 | (delta (/ (- 360. date) (1- (length colors))))) | |
791 | (mapcar (lambda (x) | |
792 | (prog1 | |
793 | (cons date x) | |
794 | (setq date (+ date delta)))) colors)) | |
795 | ;; Normal colormap: hue stepped from 0-240deg, value=1., saturation=0.75 | |
796 | '(( 20. . "#FF3F3F") | |
797 | ( 40. . "#FF6C3F") | |
798 | ( 60. . "#FF993F") | |
799 | ( 80. . "#FFC63F") | |
800 | (100. . "#FFF33F") | |
801 | (120. . "#DDFF3F") | |
802 | (140. . "#B0FF3F") | |
803 | (160. . "#83FF3F") | |
804 | (180. . "#56FF3F") | |
805 | (200. . "#3FFF56") | |
806 | (220. . "#3FFF83") | |
807 | (240. . "#3FFFB0") | |
808 | (260. . "#3FFFDD") | |
809 | (280. . "#3FF3FF") | |
810 | (300. . "#3FC6FF") | |
811 | (320. . "#3F99FF") | |
812 | (340. . "#3F6CFF") | |
813 | (360. . "#3F3FFF"))) | |
04864eb0 | 814 | "Association list of age versus color, for \\[vc-annotate]. |
da7c8a12 S |
815 | Ages are given in units of fractional days. Default is eighteen |
816 | steps using a twenty day increment, from red to blue. For TTY | |
817 | displays with 8 or fewer colors, the default is red to blue with | |
818 | all other colors between (excluding black and white)." | |
0e362f54 | 819 | :type 'alist |
7d2d9482 RS |
820 | :group 'vc) |
821 | ||
da7c8a12 | 822 | (defcustom vc-annotate-very-old-color "#3F3FFF" |
04864eb0 | 823 | "Color for lines older than the current color range in \\[vc-annotate]]." |
7d2d9482 RS |
824 | :type 'string |
825 | :group 'vc) | |
826 | ||
827 | (defcustom vc-annotate-background "black" | |
04864eb0 | 828 | "Background color for \\[vc-annotate]. |
7d2d9482 | 829 | Default color is used if nil." |
14b7a0b5 | 830 | :type '(choice (const :tag "Default background" nil) (color)) |
7d2d9482 RS |
831 | :group 'vc) |
832 | ||
833 | (defcustom vc-annotate-menu-elements '(2 0.5 0.1 0.01) | |
04864eb0 | 834 | "Menu elements for the mode-specific menu of VC-Annotate mode. |
7d2d9482 | 835 | List of factors, used to expand/compress the time scale. See `vc-annotate'." |
0e362f54 | 836 | :type '(repeat number) |
7d2d9482 RS |
837 | :group 'vc) |
838 | ||
0e362f54 GM |
839 | (defvar vc-annotate-mode-map |
840 | (let ((m (make-sparse-keymap))) | |
04864eb0 SM |
841 | (define-key m "A" 'vc-annotate-revision-previous-to-line) |
842 | (define-key m "D" 'vc-annotate-show-diff-revision-at-line) | |
f3ff0fe9 | 843 | (define-key m "f" 'vc-annotate-find-revision-at-line) |
04864eb0 SM |
844 | (define-key m "J" 'vc-annotate-revision-at-line) |
845 | (define-key m "L" 'vc-annotate-show-log-revision-at-line) | |
ac3f4c6f ER |
846 | (define-key m "N" 'vc-annotate-next-revision) |
847 | (define-key m "P" 'vc-annotate-prev-revision) | |
848 | (define-key m "W" 'vc-annotate-working-revision) | |
5731a8e0 | 849 | (define-key m "V" 'vc-annotate-toggle-annotation-visibility) |
0e362f54 GM |
850 | m) |
851 | "Local keymap used for VC-Annotate mode.") | |
67242a23 | 852 | |
594722a8 ER |
853 | ;; Header-insertion hair |
854 | ||
0101cc40 | 855 | (defcustom vc-static-header-alist |
04864eb0 | 856 | '(("\\.c\\'" . |
594722a8 | 857 | "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n")) |
0e362f54 GM |
858 | "*Associate static header string templates with file types. |
859 | A \%s in the template is replaced with the first string associated with | |
099bd78a | 860 | the file's version control type in `vc-header-alist'." |
0101cc40 RS |
861 | :type '(repeat (cons :format "%v" |
862 | (regexp :tag "File Type") | |
863 | (string :tag "Header String"))) | |
864 | :group 'vc) | |
7b4f934d | 865 | |
0101cc40 | 866 | (defcustom vc-comment-alist |
594722a8 | 867 | '((nroff-mode ".\\\"" "")) |
6f1ecae4 | 868 | "*Special comment delimiters for generating VC headers. |
099bd78a SM |
869 | Add an entry in this list if you need to override the normal `comment-start' |
870 | and `comment-end' variables. This will only be necessary if the mode language | |
0101cc40 RS |
871 | is sensitive to blank lines." |
872 | :type '(repeat (list :format "%v" | |
873 | (symbol :tag "Mode") | |
874 | (string :tag "Comment Start") | |
875 | (string :tag "Comment End"))) | |
876 | :group 'vc) | |
594722a8 | 877 | |
0101cc40 | 878 | (defcustom vc-checkout-carefully (= (user-uid) 0) |
bf142f28 | 879 | "*Non-nil means be extra-careful in checkout. |
bbf97570 | 880 | Verify that the file really is not locked |
0101cc40 RS |
881 | and that its contents match what the master file says." |
882 | :type 'boolean | |
883 | :group 'vc) | |
bf142f28 JB |
884 | (make-obsolete-variable 'vc-checkout-carefully |
885 | "the corresponding checks are always done now." | |
886 | "21.1") | |
bbf97570 | 887 | |
0e362f54 | 888 | \f |
83affd96 | 889 | ;; Variables users don't need to see |
594722a8 | 890 | |
f1d1d46a AS |
891 | (defvar vc-disable-async-diff nil |
892 | "VC sets this to t locally to disable some async diff operations. | |
893 | Backends that offer asynchronous diffs should respect this variable | |
894 | in their implementation of vc-BACKEND-diff.") | |
895 | ||
594722a8 ER |
896 | ;; File property caching |
897 | ||
8c0aaf40 | 898 | (defun vc-clear-context () |
11cdd167 | 899 | "Clear all cached file properties." |
8c0aaf40 | 900 | (interactive) |
11cdd167 | 901 | (fillarray vc-file-prop-obarray 0)) |
8c0aaf40 | 902 | |
d7b60083 ER |
903 | (defmacro with-vc-properties (files form settings) |
904 | "Execute FORM, then maybe set per-file properties for FILES. | |
6f1ecae4 AS |
905 | SETTINGS is an association list of property/value pairs. After |
906 | executing FORM, set those properties from SETTINGS that have not yet | |
907 | been updated to their corresponding values." | |
b4e4e3a8 | 908 | (declare (debug t)) |
169f0cae | 909 | `(let ((vc-touched-properties (list t))) |
099bd78a | 910 | ,form |
d7b60083 | 911 | (dolist (file ,files) |
a7192ddb SM |
912 | (dolist (setting ,settings) |
913 | (let ((property (car setting))) | |
914 | (unless (memq property vc-touched-properties) | |
915 | (put (intern file vc-file-prop-obarray) | |
916 | property (cdr setting)))))))) | |
099bd78a | 917 | |
ec402ad4 | 918 | ;; Two macros for elisp programming |
61de26cb | 919 | |
709822e8 AS |
920 | ;;;###autoload |
921 | (defmacro with-vc-file (file comment &rest body) | |
6f1ecae4 | 922 | "Check out a writable copy of FILE if necessary, then execute BODY. |
0e362f54 GM |
923 | Check in FILE with COMMENT (a string) after BODY has been executed. |
924 | FILE is passed through `expand-file-name'; BODY executed within | |
61de26cb | 925 | `save-excursion'. If FILE is not under version control, or you are |
a7192ddb | 926 | using a locking version-control system and the file is locked by |
709822e8 | 927 | somebody else, signal error." |
b4e4e3a8 | 928 | (declare (debug t) (indent 2)) |
169f0cae AS |
929 | (let ((filevar (make-symbol "file"))) |
930 | `(let ((,filevar (expand-file-name ,file))) | |
931 | (or (vc-backend ,filevar) | |
2df5044f | 932 | (error "File not under version control: `%s'" file)) |
169f0cae AS |
933 | (unless (vc-editable-p ,filevar) |
934 | (let ((state (vc-state ,filevar))) | |
f1180544 | 935 | (if (stringp state) |
2df5044f | 936 | (error "`%s' is locking `%s'" state ,filevar) |
169f0cae AS |
937 | (vc-checkout ,filevar t)))) |
938 | (save-excursion | |
939 | ,@body) | |
d7b60083 | 940 | (vc-checkin (list ,filevar) nil ,comment)))) |
169f0cae | 941 | |
709822e8 AS |
942 | ;;;###autoload |
943 | (defmacro edit-vc-file (file comment &rest body) | |
0e362f54 GM |
944 | "Edit FILE under version control, executing body. |
945 | Checkin with COMMENT after executing BODY. | |
709822e8 AS |
946 | This macro uses `with-vc-file', passing args to it. |
947 | However, before executing BODY, find FILE, and after BODY, save buffer." | |
b4e4e3a8 | 948 | (declare (debug t) (indent 2)) |
169f0cae AS |
949 | (let ((filevar (make-symbol "file"))) |
950 | `(let ((,filevar (expand-file-name ,file))) | |
951 | (with-vc-file | |
952 | ,filevar ,comment | |
953 | (set-buffer (find-file-noselect ,filevar)) | |
954 | ,@body | |
955 | (save-buffer))))) | |
956 | ||
d7b60083 ER |
957 | ;;; Code for deducing what fileset and backend to assume |
958 | ||
2765044b DN |
959 | (defun vc-responsible-backend (file &optional register) |
960 | "Return the name of a backend system that is responsible for FILE. | |
961 | The optional argument REGISTER means that a backend suitable for | |
962 | registration should be found. | |
963 | ||
964 | If REGISTER is nil, then if FILE is already registered, return the | |
965 | backend of FILE. If FILE is not registered, or a directory, then the | |
966 | first backend in `vc-handled-backends' that declares itself | |
967 | responsible for FILE is returned. If no backend declares itself | |
968 | responsible, return the first backend. | |
969 | ||
970 | If REGISTER is non-nil, return the first responsible backend under | |
971 | which FILE is not yet registered. If there is no such backend, return | |
972 | the first backend under which FILE is not yet registered, but could | |
973 | be registered." | |
b5446276 DN |
974 | (when (not vc-handled-backends) |
975 | (error "No handled backends")) | |
2765044b DN |
976 | (or (and (not (file-directory-p file)) (not register) (vc-backend file)) |
977 | (catch 'found | |
978 | ;; First try: find a responsible backend. If this is for registration, | |
979 | ;; it must be a backend under which FILE is not yet registered. | |
980 | (dolist (backend vc-handled-backends) | |
981 | (and (or (not register) | |
982 | (not (vc-call-backend backend 'registered file))) | |
983 | (vc-call-backend backend 'responsible-p file) | |
984 | (throw 'found backend))) | |
985 | ;; no responsible backend | |
986 | (if (not register) | |
987 | ;; if this is not for registration, the first backend must do | |
988 | (car vc-handled-backends) | |
989 | ;; for registration, we need to find a new backend that | |
990 | ;; could register FILE | |
991 | (dolist (backend vc-handled-backends) | |
992 | (and (not (vc-call-backend backend 'registered file)) | |
993 | (vc-call-backend backend 'could-register file) | |
994 | (throw 'found backend))) | |
995 | (error "No backend that could register"))))) | |
996 | ||
997 | (defun vc-expand-dirs (file-or-dir-list) | |
998 | "Expands directories in a file list specification. | |
999 | Only files already under version control are noticed." | |
2765044b DN |
1000 | (let ((flattened '())) |
1001 | (dolist (node file-or-dir-list) | |
1002 | (vc-file-tree-walk | |
b5446276 | 1003 | node (lambda (f) (when (vc-backend f) (push f flattened))))) |
2765044b DN |
1004 | (nreverse flattened))) |
1005 | ||
86048828 ER |
1006 | (defun vc-deduce-fileset () |
1007 | "Deduce a set of files and a backend to which to apply an operation and | |
734abae3 | 1008 | the common state of the fileset. Return (BACKEND . FILESET)." |
86048828 | 1009 | (let* ((fileset (vc-dispatcher-selection-set)) |
734abae3 SM |
1010 | ;; FIXME: Store the backend in a buffer-local variable. |
1011 | (backend (if (derived-mode-p 'vc-dir-mode) | |
1012 | (vc-responsible-backend default-directory) | |
1013 | (assert (and (= 1 (length fileset)) | |
1014 | (not (file-directory-p (car fileset))))) | |
1015 | (vc-backend (car fileset))))) | |
1016 | (cons backend fileset))) | |
d7b60083 | 1017 | |
2765044b DN |
1018 | (defun vc-ensure-vc-buffer () |
1019 | "Make sure that the current buffer visits a version-controlled file." | |
ca8dfeda | 1020 | (cond |
4903369a | 1021 | ((vc-dispatcher-browsing) |
e1aec6fb | 1022 | (set-buffer (find-file-noselect (vc-dir-current-file)))) |
ca8dfeda | 1023 | (t |
772111be | 1024 | (while (and vc-parent-buffer |
cc72026b | 1025 | (buffer-live-p vc-parent-buffer) |
772111be MR |
1026 | ;; Avoid infinite looping when vc-parent-buffer and |
1027 | ;; current buffer are the same buffer. | |
1028 | (not (eq vc-parent-buffer (current-buffer)))) | |
2765044b DN |
1029 | (set-buffer vc-parent-buffer)) |
1030 | (if (not buffer-file-name) | |
1031 | (error "Buffer %s is not associated with a file" (buffer-name)) | |
b5446276 DN |
1032 | (unless (vc-backend buffer-file-name) |
1033 | (error "File %s is not under version control" buffer-file-name)))))) | |
2765044b | 1034 | |
e0607aaa SM |
1035 | ;;; Support for the C-x v v command. |
1036 | ;; This is where all the single-file-oriented code from before the fileset | |
1037 | ;; rewrite lives. | |
61de26cb | 1038 | |
2765044b DN |
1039 | (defsubst vc-editable-p (file) |
1040 | "Return non-nil if FILE can be edited." | |
e0607aaa SM |
1041 | (let ((backend (vc-backend file))) |
1042 | (and backend | |
70e2f6c7 | 1043 | (or (eq (vc-checkout-model backend (list file)) 'implicit) |
e0607aaa | 1044 | (memq (vc-state file) '(edited needs-merge conflict)))))) |
2765044b | 1045 | |
484c1b1f ER |
1046 | (defun vc-compatible-state (p q) |
1047 | "Controls which states can be in the same commit." | |
1048 | (or | |
1049 | (eq p q) | |
1050 | (and (member p '(edited added removed)) (member q '(edited added removed))))) | |
1051 | ||
2765044b DN |
1052 | ;; Here's the major entry point. |
1053 | ||
1054 | ;;;###autoload | |
1055 | (defun vc-next-action (verbose) | |
d7b60083 ER |
1056 | "Do the next logical version control operation on the current fileset. |
1057 | This requires that all files in the fileset be in the same state. | |
2765044b | 1058 | |
d7b60083 ER |
1059 | For locking systems: |
1060 | If every file is not already registered, this registers each for version | |
2765044b | 1061 | control. |
d7b60083 ER |
1062 | If every file is registered and not locked by anyone, this checks out |
1063 | a writable and locked file of each ready for editing. | |
1064 | If every file is checked out and locked by the calling user, this | |
1065 | first checks to see if each file has changed since checkout. If not, | |
1066 | it performs a revert on that file. | |
1067 | If every file has been changed, this pops up a buffer for entry | |
2765044b DN |
1068 | of a log message; when the message has been entered, it checks in the |
1069 | resulting changes along with the log message as change commentary. If | |
1070 | the variable `vc-keep-workfiles' is non-nil (which is its default), a | |
d7b60083 ER |
1071 | read-only copy of each changed file is left in place afterwards. |
1072 | If the affected file is registered and locked by someone else, you are | |
1073 | given the option to steal the lock(s). | |
1074 | ||
1075 | For merging systems: | |
1076 | If every file is not already registered, this registers each one for version | |
1077 | control. This does an add, but not a commit. | |
1078 | If every file is added but not committed, each one is committed. | |
1079 | If every working file is changed, but the corresponding repository file is | |
2765044b DN |
1080 | unchanged, this pops up a buffer for entry of a log message; when the |
1081 | message has been entered, it checks in the resulting changes along | |
1082 | with the logmessage as change commentary. A writable file is retained. | |
1083 | If the repository file is changed, you are asked if you want to | |
1084 | merge in the changes into your working copy." | |
2765044b | 1085 | (interactive "P") |
86048828 | 1086 | (let* ((vc-fileset (vc-deduce-fileset)) |
e0607aaa | 1087 | (backend (car vc-fileset)) |
734abae3 SM |
1088 | (files (cdr vc-fileset)) |
1089 | (fileset-only-files (vc-expand-dirs files)) | |
1090 | (state (vc-state (car fileset-only-files))) | |
1091 | ;; The backend should check that the checkout-model is consistent | |
1092 | ;; among all the `files'. | |
e0607aaa | 1093 | (model (vc-checkout-model backend files)) |
ac3f4c6f | 1094 | revision) |
734abae3 SM |
1095 | |
1096 | ;; Check that all files are in a consistent state, since we use that | |
1097 | ;; state to decide which operation to perform. | |
1098 | (dolist (file (cdr fileset-only-files)) | |
1099 | (unless (vc-compatible-state (vc-state file) state) | |
1100 | (error "%s:%s clashes with %s:%s" | |
1101 | file (vc-state file) (car fileset-only-files) state))) | |
1102 | ||
0e362f54 | 1103 | ;; Do the right thing |
a7192ddb | 1104 | (cond |
3c73c30e ER |
1105 | ((eq state 'missing) |
1106 | (error "Fileset files are missing, so cannot be operated on.")) | |
86048828 ER |
1107 | ((eq state 'ignored) |
1108 | (error "Fileset files are ignored by the version-control system.")) | |
1109 | ((eq state 'unregistered) | |
80296236 | 1110 | (mapc (lambda (arg) (vc-register nil arg)) files)) |
ac3f4c6f | 1111 | ;; Files are up-to-date, or need a merge and user specified a revision |
3702367b | 1112 | ((or (eq state 'up-to-date) (and verbose (eq state 'needs-update))) |
0e362f54 | 1113 | (cond |
d7b60083 | 1114 | (verbose |
ac3f4c6f ER |
1115 | ;; go to a different revision |
1116 | (setq revision (read-string "Branch, revision, or backend to move to: ")) | |
1117 | (let ((vsym (intern-soft (upcase revision)))) | |
d7b60083 | 1118 | (if (member vsym vc-handled-backends) |
a7192ddb SM |
1119 | (dolist (file files) (vc-transfer-file file vsym)) |
1120 | (dolist (file files) | |
1121 | (vc-checkout file (eq model 'implicit) revision))))) | |
d7b60083 ER |
1122 | ((not (eq model 'implicit)) |
1123 | ;; check the files out | |
a7192ddb | 1124 | (dolist (file files) (vc-checkout file t))) |
d7b60083 | 1125 | (t |
a7192ddb SM |
1126 | ;; do nothing |
1127 | (message "Fileset is up-to-date")))) | |
1128 | ;; Files have local changes | |
484c1b1f | 1129 | ((vc-compatible-state state 'edited) |
d7b60083 ER |
1130 | (let ((ready-for-commit files)) |
1131 | ;; If files are edited but read-only, give user a chance to correct | |
1132 | (dolist (file files) | |
e166638d DN |
1133 | (unless (file-writable-p file) |
1134 | ;; Make the file+buffer read-write. | |
1135 | (unless (y-or-n-p (format "%s is edited but read-only; make it writable and continue?" file)) | |
1136 | (error "Aborted")) | |
1137 | (set-file-modes file (logior (file-modes file) 128)) | |
1138 | (let ((visited (get-file-buffer file))) | |
1139 | (when visited | |
1140 | (with-current-buffer visited | |
1141 | (toggle-read-only -1)))))) | |
d7b60083 ER |
1142 | ;; Allow user to revert files with no changes |
1143 | (save-excursion | |
a7192ddb SM |
1144 | (dolist (file files) |
1145 | (let ((visited (get-file-buffer file))) | |
1146 | ;; For files with locking, if the file does not contain | |
1147 | ;; any changes, just let go of the lock, i.e. revert. | |
e166638d DN |
1148 | (when (and (not (eq model 'implicit)) |
1149 | (vc-workfile-unchanged-p file) | |
1150 | ;; If buffer is modified, that means the user just | |
1151 | ;; said no to saving it; in that case, don't revert, | |
1152 | ;; because the user might intend to save after | |
1153 | ;; finishing the log entry and committing. | |
1154 | (not (and visited (buffer-modified-p)))) | |
1155 | (vc-revert-file file) | |
1156 | (delete file ready-for-commit))))) | |
d7b60083 ER |
1157 | ;; Remaining files need to be committed |
1158 | (if (not ready-for-commit) | |
1159 | (message "No files remain to be committed") | |
1d502d5a | 1160 | (if (not verbose) |
d7b60083 ER |
1161 | (vc-checkin ready-for-commit) |
1162 | (progn | |
ac3f4c6f ER |
1163 | (setq revision (read-string "New revision or backend: ")) |
1164 | (let ((vsym (intern (upcase revision)))) | |
d7b60083 | 1165 | (if (member vsym vc-handled-backends) |
d36122a2 | 1166 | (dolist (file files) (vc-transfer-file file vsym)) |
ac3f4c6f | 1167 | (vc-checkin ready-for-commit revision)))))))) |
d7b60083 ER |
1168 | ;; locked by somebody else (locking VCSes only) |
1169 | ((stringp state) | |
d36122a2 TTN |
1170 | ;; In the old days, we computed the revision once and used it on |
1171 | ;; the single file. Then, for the 2007-2008 fileset rewrite, we | |
1172 | ;; computed the revision once (incorrectly, using a free var) and | |
1173 | ;; used it on all files. To fix the free var bug, we can either | |
1174 | ;; use `(car files)' or do what we do here: distribute the | |
1175 | ;; revision computation among `files'. Although this may be | |
1176 | ;; tedious for those backends where a "revision" is a trans-file | |
1177 | ;; concept, it is nonetheless correct for both those and (more | |
1178 | ;; importantly) for those where "revision" is a per-file concept. | |
1179 | ;; If the intersection of the former group and "locking VCSes" is | |
1180 | ;; non-empty [I vaguely doubt it --ttn], we can reinstate the | |
1181 | ;; pre-computation approach of yore. | |
1182 | (dolist (file files) | |
1183 | (vc-steal-lock | |
1184 | file (if verbose | |
1185 | (read-string (format "%s revision to steal: " file)) | |
1186 | (vc-working-revision file)) | |
1187 | state))) | |
7fbb4797 DN |
1188 | ;; conflict |
1189 | ((eq state 'conflict) | |
a749e19d SM |
1190 | ;; FIXME: Is it really the UI we want to provide? |
1191 | ;; In my experience, the conflicted files should be marked as resolved | |
1192 | ;; one-by-one when saving the file after resolving the conflicts. | |
1193 | ;; I.e. stating explicitly that the conflicts are resolved is done | |
1194 | ;; very rarely. | |
1195 | (vc-mark-resolved backend files)) | |
3702367b ER |
1196 | ;; needs-update |
1197 | ((eq state 'needs-update) | |
d7b60083 | 1198 | (dolist (file files) |
6f41eeb5 | 1199 | (if (yes-or-no-p (format |
ac3f4c6f | 1200 | "%s is not up-to-date. Get latest revision? " |
0e362f54 | 1201 | (file-name-nondirectory file))) |
d7b60083 | 1202 | (vc-checkout file (eq model 'implicit) t) |
e166638d DN |
1203 | (when (and (not (eq model 'implicit)) |
1204 | (yes-or-no-p "Lock this revision? ")) | |
1205 | (vc-checkout file t))))) | |
d7b60083 ER |
1206 | ;; needs-merge |
1207 | ((eq state 'needs-merge) | |
1208 | (dolist (file files) | |
e166638d | 1209 | (when (yes-or-no-p (format |
0e362f54 GM |
1210 | "%s is not up-to-date. Merge in changes now? " |
1211 | (file-name-nondirectory file))) | |
a749e19d SM |
1212 | (vc-maybe-resolve-conflicts |
1213 | file (vc-call-backend backend 'merge-news file))))) | |
46e33aee | 1214 | |
d7b60083 ER |
1215 | ;; unlocked-changes |
1216 | ((eq state 'unlocked-changes) | |
1217 | (dolist (file files) | |
b5446276 DN |
1218 | (when (not (equal buffer-file-name file)) |
1219 | (find-file-other-window file)) | |
0e362f54 | 1220 | (if (save-window-excursion |
86048828 ER |
1221 | (vc-diff-internal nil |
1222 | (cons (car vc-fileset) (cons (cadr vc-fileset) (list file))) | |
ae67f2d0 | 1223 | (vc-working-revision file) nil) |
0e362f54 | 1224 | (goto-char (point-min)) |
ceec5a0c | 1225 | (let ((inhibit-read-only t)) |
f4f34b33 | 1226 | (insert |
ceec5a0c | 1227 | (format "Changes to %s since last lock:\n\n" file))) |
0e362f54 GM |
1228 | (not (beep)) |
1229 | (yes-or-no-p (concat "File has unlocked changes. " | |
1230 | "Claim lock retaining changes? "))) | |
a749e19d | 1231 | (progn (vc-call-backend backend 'steal-lock file) |
61de26cb | 1232 | (clear-visited-file-modtime) |
0e362f54 GM |
1233 | ;; Must clear any headers here because they wouldn't |
1234 | ;; show that the file is locked now. | |
1235 | (vc-clear-headers file) | |
a36319a4 | 1236 | (write-file buffer-file-name) |
0e362f54 GM |
1237 | (vc-mode-line file)) |
1238 | (if (not (yes-or-no-p | |
ac3f4c6f | 1239 | "Revert to checked-in revision, instead? ")) |
0e362f54 | 1240 | (error "Checkout aborted") |
61de26cb | 1241 | (vc-revert-buffer-internal t t) |
3702367b ER |
1242 | (vc-checkout file t))))) |
1243 | ;; Unknown fileset state | |
1244 | (t | |
1245 | (error "Fileset is in an unknown state %s" state))))) | |
e1f297e6 | 1246 | |
61de26cb ER |
1247 | (defun vc-create-repo (backend) |
1248 | "Create an empty repository in the current directory." | |
1249 | (interactive | |
1250 | (list | |
1251 | (intern | |
1252 | (upcase | |
1253 | (completing-read | |
1254 | "Create repository for: " | |
1255 | (mapcar (lambda (b) (list (downcase (symbol-name b)))) vc-handled-backends) | |
1256 | nil t))))) | |
1257 | (vc-call-backend backend 'create-repo)) | |
1258 | ||
637a8ae9 | 1259 | ;;;###autoload |
80296236 | 1260 | (defun vc-register (&optional set-revision fname comment) |
30a308aa DN |
1261 | "Register into a version control system. |
1262 | If FNAME is given register that file, otherwise register the current file. | |
ac3f4c6f | 1263 | With prefix argument SET-REVISION, allow user to specify initial revision |
2765044b | 1264 | level. If COMMENT is present, use that as an initial comment. |
0e362f54 | 1265 | |
2765044b DN |
1266 | The version control system to use is found by cycling through the list |
1267 | `vc-handled-backends'. The first backend in that list which declares | |
1268 | itself responsible for the file (usually because other files in that | |
1269 | directory are already registered under that backend) will be used to | |
1270 | register the file. If no backend declares itself responsible, the | |
1271 | first backend that could register the file is used." | |
1272 | (interactive "P") | |
30a308aa DN |
1273 | (when (and (null fname) (null buffer-file-name)) (error "No visited file")) |
1274 | ||
5f01100a | 1275 | (let ((bname (if fname (get-file-buffer fname) (current-buffer)))) |
30a308aa DN |
1276 | (unless fname (setq fname buffer-file-name)) |
1277 | (when (vc-backend fname) | |
1278 | (if (vc-registered fname) | |
1279 | (error "This file is already registered") | |
1280 | (unless (y-or-n-p "Previous master file has vanished. Make a new one? ") | |
1281 | (error "Aborted")))) | |
1282 | ;; Watch out for new buffers of size 0: the corresponding file | |
1283 | ;; does not exist yet, even though buffer-modified-p is nil. | |
1284 | (when bname | |
1285 | (with-current-buffer bname | |
b5446276 | 1286 | (when (and (not (buffer-modified-p)) |
30a308aa DN |
1287 | (zerop (buffer-size)) |
1288 | (not (file-exists-p buffer-file-name))) | |
b5446276 | 1289 | (set-buffer-modified-p t)) |
30a308aa | 1290 | (vc-buffer-sync))) |
83affd96 | 1291 | (vc-start-logentry (list fname) |
30a308aa DN |
1292 | (if set-revision |
1293 | (read-string (format "Initial revision level for %s: " | |
1294 | fname)) | |
1295 | (vc-call-backend (vc-responsible-backend fname) | |
1296 | 'init-revision)) | |
1297 | (or comment (not vc-initial-comment)) | |
1298 | nil | |
1299 | "Enter initial comment." | |
1300 | (lambda (files rev comment) | |
1301 | (dolist (file files) | |
1302 | (message "Registering %s... " file) | |
1303 | (let ((backend (vc-responsible-backend file t))) | |
1304 | (vc-file-clearprops file) | |
1305 | (vc-call-backend backend 'register (list file) rev comment) | |
1306 | (vc-file-setprop file 'vc-backend backend) | |
1307 | (unless vc-make-backup-files | |
1308 | (make-local-variable 'backup-inhibited) | |
1309 | (setq backup-inhibited t))) | |
1310 | (message "Registering %s... done" file)))))) | |
d7b60083 ER |
1311 | |
1312 | (defun vc-register-with (backend) | |
1313 | "Register the current file with a specified back end." | |
1314 | (interactive "SBackend: ") | |
b5446276 DN |
1315 | (when (not (member backend vc-handled-backends)) |
1316 | (error "Unknown back end.")) | |
d7b60083 ER |
1317 | (let ((vc-handled-backends (list backend))) |
1318 | (call-interactively 'vc-register))) | |
8989ab56 | 1319 | |
c6d4f628 | 1320 | (defun vc-checkout (file &optional writable rev) |
099bd78a SM |
1321 | "Retrieve a copy of the revision REV of FILE. |
1322 | If WRITABLE is non-nil, make sure the retrieved file is writable. | |
133a84aa AS |
1323 | REV defaults to the latest revision. |
1324 | ||
1325 | After check-out, runs the normal hook `vc-checkout-hook'." | |
ffda0460 AS |
1326 | (and writable |
1327 | (not rev) | |
10b48cc4 | 1328 | (vc-call make-version-backups-p file) |
ffda0460 | 1329 | (vc-up-to-date-p file) |
10b48cc4 | 1330 | (vc-make-version-backup file)) |
e0607aaa SM |
1331 | (let ((backend (vc-backend file))) |
1332 | (with-vc-properties (list file) | |
1333 | (condition-case err | |
af36f8ed | 1334 | (vc-call-backend backend 'checkout file writable rev) |
e0607aaa SM |
1335 | (file-error |
1336 | ;; Maybe the backend is not installed ;-( | |
1337 | (when writable | |
1338 | (let ((buf (get-file-buffer file))) | |
1339 | (when buf (with-current-buffer buf (toggle-read-only -1))))) | |
1340 | (signal (car err) (cdr err)))) | |
70e2f6c7 | 1341 | `((vc-state . ,(if (or (eq (vc-checkout-model backend (list file)) 'implicit) |
e0607aaa | 1342 | (not writable)) |
a749e19d | 1343 | (if (vc-call-backend backend 'latest-on-branch-p file) |
e0607aaa | 1344 | 'up-to-date |
3702367b | 1345 | 'needs-update) |
e0607aaa SM |
1346 | 'edited)) |
1347 | (vc-checkout-time . ,(nth 5 (file-attributes file)))))) | |
7cad930d AS |
1348 | (vc-resynch-buffer file t t) |
1349 | (run-hooks 'vc-checkout-hook)) | |
594722a8 | 1350 | |
a749e19d | 1351 | (defun vc-mark-resolved (backend files) |
7fbb4797 DN |
1352 | (with-vc-properties |
1353 | files | |
a749e19d | 1354 | (vc-call-backend backend 'mark-resolved files) |
7fbb4797 DN |
1355 | ;; XXX: Is this TRTD? Might not be. |
1356 | `((vc-state . edited)))) | |
1357 | ||
0e362f54 | 1358 | (defun vc-steal-lock (file rev owner) |
099bd78a | 1359 | "Steal the lock on FILE." |
29fc1ce9 | 1360 | (let (file-description) |
29fc1ce9 RS |
1361 | (if rev |
1362 | (setq file-description (format "%s:%s" file rev)) | |
1363 | (setq file-description file)) | |
b5446276 DN |
1364 | (when (not (yes-or-no-p (format "Steal the lock on %s from %s? " |
1365 | file-description owner))) | |
1366 | (error "Steal canceled")) | |
869131a5 AS |
1367 | (message "Stealing lock on %s..." file) |
1368 | (with-vc-properties | |
d7b60083 | 1369 | (list file) |
869131a5 AS |
1370 | (vc-call steal-lock file rev) |
1371 | `((vc-state . edited))) | |
1372 | (vc-resynch-buffer file t t) | |
1373 | (message "Stealing lock on %s...done" file) | |
1374 | ;; Write mail after actually stealing, because if the stealing | |
1375 | ;; goes wrong, we don't want to send any mail. | |
1376 | (compose-mail owner (format "Stolen lock on %s" file-description)) | |
29fc1ce9 | 1377 | (setq default-directory (expand-file-name "~/")) |
29fc1ce9 RS |
1378 | (goto-char (point-max)) |
1379 | (insert | |
1380 | (format "I stole the lock on %s, " file-description) | |
1381 | (current-time-string) | |
1382 | ".\n") | |
1383 | (message "Please explain why you stole the lock. Type C-c C-c when done."))) | |
594722a8 | 1384 | |
d7b60083 ER |
1385 | (defun vc-checkin (files &optional rev comment initial-contents) |
1386 | "Check in FILES. | |
ac3f4c6f | 1387 | The optional argument REV may be a string specifying the new revision |
0e362f54 | 1388 | level (if nil increment the current level). COMMENT is a comment |
0ab66291 AS |
1389 | string; if omitted, a buffer is popped up to accept a comment. If |
1390 | INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents | |
1391 | of the log entry buffer. | |
0e362f54 GM |
1392 | |
1393 | If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided | |
1394 | that the version control system supports this mode of operation. | |
861f3c29 | 1395 | |
17f039f3 ER |
1396 | Runs the normal hooks `vc-before-checkin-hook' and `vc-checkin-hook'." |
1397 | (when vc-before-checkin-hook | |
1398 | (run-hooks 'vc-before-checkin-hook)) | |
83affd96 | 1399 | (vc-start-logentry |
d7b60083 | 1400 | files rev comment initial-contents |
6f41eeb5 | 1401 | "Enter a change comment." |
d7b60083 ER |
1402 | (lambda (files rev comment) |
1403 | (message "Checking in %s..." (vc-delistify files)) | |
0e362f54 GM |
1404 | ;; "This log message intentionally left almost blank". |
1405 | ;; RCS 5.7 gripes about white-space-only comments too. | |
1406 | (or (and comment (string-match "[^\t\n ]" comment)) | |
1407 | (setq comment "*** empty log message ***")) | |
46e33aee | 1408 | (with-vc-properties |
d7b60083 ER |
1409 | files |
1410 | ;; We used to change buffers to get local value of vc-checkin-switches, | |
1411 | ;; but 'the' local buffer is not a well-defined concept for filesets. | |
1412 | (progn | |
1413 | (vc-call checkin files rev comment) | |
1414 | (mapc 'vc-delete-automatic-version-backups files)) | |
a3255400 SM |
1415 | `((vc-state . up-to-date) |
1416 | (vc-checkout-time . ,(nth 5 (file-attributes file))) | |
ac3f4c6f | 1417 | (vc-working-revision . nil))) |
d7b60083 | 1418 | (message "Checking in %s...done" (vc-delistify files))) |
0e362f54 | 1419 | 'vc-checkin-hook)) |
594722a8 | 1420 | |
2765044b DN |
1421 | ;;; Additional entry points for examining version histories |
1422 | ||
a7192ddb SM |
1423 | ;; (defun vc-default-diff-tree (backend dir rev1 rev2) |
1424 | ;; "List differences for all registered files at and below DIR. | |
1425 | ;; The meaning of REV1 and REV2 is the same as for `vc-revision-diff'." | |
1426 | ;; ;; This implementation does an explicit tree walk, and calls | |
1427 | ;; ;; vc-BACKEND-diff directly for each file. An optimization | |
1428 | ;; ;; would be to use `vc-diff-internal', so that diffs can be local, | |
1429 | ;; ;; and to call it only for files that are actually changed. | |
1430 | ;; ;; However, this is expensive for some backends, and so it is left | |
1431 | ;; ;; to backend-specific implementations. | |
1432 | ;; (setq default-directory dir) | |
1433 | ;; (vc-file-tree-walk | |
1434 | ;; default-directory | |
1435 | ;; (lambda (f) | |
1436 | ;; (vc-exec-after | |
1437 | ;; `(let ((coding-system-for-read (vc-coding-system-for-diff ',f))) | |
1438 | ;; (message "Looking at %s" ',f) | |
1439 | ;; (vc-call-backend ',(vc-backend f) | |
1440 | ;; 'diff (list ',f) ',rev1 ',rev2)))))) | |
2765044b DN |
1441 | |
1442 | (defun vc-coding-system-for-diff (file) | |
1443 | "Return the coding system for reading diff output for FILE." | |
1444 | (or coding-system-for-read | |
1445 | ;; if we already have this file open, | |
1446 | ;; use the buffer's coding system | |
1447 | (let ((buf (find-buffer-visiting file))) | |
b5446276 DN |
1448 | (when buf (with-current-buffer buf |
1449 | buffer-file-coding-system))) | |
2765044b DN |
1450 | ;; otherwise, try to find one based on the file name |
1451 | (car (find-operation-coding-system 'insert-file-contents file)) | |
1452 | ;; and a final fallback | |
1453 | 'undecided)) | |
1454 | ||
1455 | (defun vc-switches (backend op) | |
1456 | (let ((switches | |
b5446276 DN |
1457 | (or (when backend |
1458 | (let ((sym (vc-make-backend-sym | |
1459 | backend (intern (concat (symbol-name op) | |
1460 | "-switches"))))) | |
1461 | (when (boundp sym) (symbol-value sym)))) | |
2765044b | 1462 | (let ((sym (intern (format "vc-%s-switches" (symbol-name op))))) |
b5446276 | 1463 | (when (boundp sym) (symbol-value sym))) |
2765044b DN |
1464 | (cond |
1465 | ((eq op 'diff) diff-switches))))) | |
1466 | (if (stringp switches) (list switches) | |
1467 | ;; If not a list, return nil. | |
1468 | ;; This is so we can set vc-diff-switches to t to override | |
1469 | ;; any switches in diff-switches. | |
b5446276 | 1470 | (when (listp switches) switches)))) |
594722a8 | 1471 | |
2765044b DN |
1472 | ;; Old def for compatibility with Emacs-21.[123]. |
1473 | (defmacro vc-diff-switches-list (backend) `(vc-switches ',backend 'diff)) | |
1474 | (make-obsolete 'vc-diff-switches-list 'vc-switches "22.1") | |
1475 | ||
1d5b2149 | 1476 | (defun vc-diff-finish (buffer messages) |
17f3909f | 1477 | ;; The empty sync output case has already been handled, so the only |
fddde1f0 | 1478 | ;; possibility of an empty output is for an async process. |
1d5b2149 TTN |
1479 | (when (buffer-live-p buffer) |
1480 | (let ((window (get-buffer-window buffer t)) | |
1481 | (emptyp (zerop (buffer-size buffer)))) | |
1482 | (with-current-buffer buffer | |
1483 | (and messages emptyp | |
1484 | (let ((inhibit-read-only t)) | |
1485 | (insert (cdr messages) ".\n") | |
1486 | (message "%s" (cdr messages)))) | |
1487 | (goto-char (point-min)) | |
fddde1f0 | 1488 | (when window |
1d5b2149 TTN |
1489 | (shrink-window-if-larger-than-buffer window))) |
1490 | (when (and messages (not emptyp)) | |
1491 | (message "%sdone" (car messages)))))) | |
d7b60083 | 1492 | |
a7192ddb SM |
1493 | (defvar vc-diff-added-files nil |
1494 | "If non-nil, diff added files by comparing them to /dev/null.") | |
1495 | ||
ae67f2d0 | 1496 | (defun vc-diff-internal (async vc-fileset rev1 rev2 &optional verbose) |
d7b60083 ER |
1497 | "Report diffs between two revisions of a fileset. |
1498 | Diff output goes to the *vc-diff* buffer. The function | |
1499 | returns t if the buffer had changes, nil otherwise." | |
734abae3 | 1500 | (let* ((files (cdr vc-fileset)) |
ae67f2d0 | 1501 | (messages (cons (format "Finding changes in %s..." |
1d5b2149 TTN |
1502 | (vc-delistify files)) |
1503 | (format "No changes between %s and %s" | |
1504 | (or rev1 "working revision") | |
1505 | (or rev2 "workfile")))) | |
d7b60083 ER |
1506 | ;; Set coding system based on the first file. It's a kluge, |
1507 | ;; but the only way to set it for each file included would | |
1508 | ;; be to call the back end separately for each file. | |
a7192ddb | 1509 | (coding-system-for-read |
d7b60083 ER |
1510 | (if files (vc-coding-system-for-diff (car files)) 'undecided))) |
1511 | (vc-setup-buffer "*vc-diff*") | |
1d5b2149 | 1512 | (message "%s" (car messages)) |
a7192ddb SM |
1513 | ;; Many backends don't handle well the case of a file that has been |
1514 | ;; added but not yet committed to the repo (notably CVS and Subversion). | |
1515 | ;; Do that work here so the backends don't have to futz with it. --ESR | |
1516 | ;; | |
1517 | ;; Actually most backends (including CVS) have options to control the | |
1518 | ;; behavior since which one is better depends on the user and on the | |
1519 | ;; situation). Worse yet: this code does not handle the case where | |
1520 | ;; `file' is a directory which contains added files. | |
1521 | ;; I made it conditional on vc-diff-added-files but it should probably | |
1522 | ;; just be removed (or copied/moved to specific backends). --Stef. | |
1523 | (when vc-diff-added-files | |
1524 | (let ((filtered '())) | |
1525 | (dolist (file files) | |
1526 | (if (or (file-directory-p file) | |
1527 | (not (string= (vc-working-revision file) "0"))) | |
1528 | (push file filtered) | |
1529 | ;; This file is added but not yet committed; | |
1530 | ;; there is no master file to diff against. | |
1531 | (if (or rev1 rev2) | |
1532 | (error "No revisions of %s exist" file) | |
1533 | ;; We regard this as "changed". | |
1534 | ;; Diff it against /dev/null. | |
1535 | (apply 'vc-do-command "*vc-diff*" | |
1536 | 1 "diff" file | |
1537 | (append (vc-switches nil 'diff) '("/dev/null")))))) | |
1538 | (setq files (nreverse filtered)))) | |
1539 | (let ((vc-disable-async-diff (not async))) | |
ae67f2d0 | 1540 | (vc-call-backend (car vc-fileset) 'diff files rev1 rev2 "*vc-diff*")) |
d7b60083 | 1541 | (set-buffer "*vc-diff*") |
17f3909f SM |
1542 | (if (and (zerop (buffer-size)) |
1543 | (not (get-buffer-process (current-buffer)))) | |
1544 | ;; Treat this case specially so as not to pop the buffer. | |
1545 | (progn | |
1d5b2149 | 1546 | (message "%s" (cdr messages)) |
17f3909f | 1547 | nil) |
e83d1fe8 | 1548 | (diff-mode) |
fe1919ab DN |
1549 | ;; Make the *vc-diff* buffer read only, the diff-mode key |
1550 | ;; bindings are nicer for read only buffers. pcl-cvs does the | |
1551 | ;; same thing. | |
1552 | (setq buffer-read-only t) | |
1d5b2149 TTN |
1553 | (vc-exec-after `(vc-diff-finish ,(current-buffer) ',(when verbose |
1554 | messages))) | |
4befebc1 SM |
1555 | ;; Display the buffer, but at the end because it can change point. |
1556 | (pop-to-buffer (current-buffer)) | |
17f3909f SM |
1557 | ;; In the async case, we return t even if there are no differences |
1558 | ;; because we don't know that yet. | |
1559 | t))) | |
594722a8 | 1560 | |
637a8ae9 | 1561 | ;;;###autoload |
a7192ddb | 1562 | (defun vc-version-diff (files rev1 rev2) |
d7b60083 | 1563 | "Report diffs between revisions of the fileset in the repository history." |
0e362f54 | 1564 | (interactive |
86048828 | 1565 | (let* ((vc-fileset (vc-deduce-fileset)) |
734abae3 | 1566 | (files (cdr vc-fileset)) |
a749e19d | 1567 | (backend (car vc-fileset)) |
d7b60083 | 1568 | (first (car files)) |
d7b60083 | 1569 | (completion-table |
a749e19d | 1570 | (vc-call-backend backend 'revision-completion-table files)) |
d7b60083 ER |
1571 | (rev1-default nil) |
1572 | (rev2-default nil)) | |
c0d66cb2 | 1573 | (cond |
ac3f4c6f | 1574 | ;; someday we may be able to do revision completion on non-singleton |
d7b60083 ER |
1575 | ;; filesets, but not yet. |
1576 | ((/= (length files) 1) | |
1577 | nil) | |
ac3f4c6f | 1578 | ;; if it's a directory, don't supply any revision default |
d7b60083 | 1579 | ((file-directory-p first) |
c0d66cb2 | 1580 | nil) |
ac3f4c6f | 1581 | ;; if the file is not up-to-date, use working revision as older revision |
d7b60083 | 1582 | ((not (vc-up-to-date-p first)) |
ac3f4c6f ER |
1583 | (setq rev1-default (vc-working-revision first))) |
1584 | ;; if the file is not locked, use last and previous revisions as defaults | |
c0d66cb2 | 1585 | (t |
a749e19d SM |
1586 | (setq rev1-default (vc-call-backend backend 'previous-revision first |
1587 | (vc-working-revision first))) | |
b5446276 | 1588 | (when (string= rev1-default "") (setq rev1-default nil)) |
ac3f4c6f | 1589 | (setq rev2-default (vc-working-revision first)))) |
c0d66cb2 | 1590 | ;; construct argument list |
4d83a657 | 1591 | (let* ((rev1-prompt (if rev1-default |
ac3f4c6f | 1592 | (concat "Older revision (default " |
4d83a657 | 1593 | rev1-default "): ") |
ac3f4c6f ER |
1594 | "Older revision: ")) |
1595 | (rev2-prompt (concat "Newer revision (default " | |
4d83a657 SM |
1596 | (or rev2-default "current source") "): ")) |
1597 | (rev1 (if completion-table | |
1598 | (completing-read rev1-prompt completion-table | |
d7b60083 | 1599 | nil nil nil nil rev1-default) |
4d83a657 SM |
1600 | (read-string rev1-prompt nil nil rev1-default))) |
1601 | (rev2 (if completion-table | |
1602 | (completing-read rev2-prompt completion-table | |
d7b60083 | 1603 | nil nil nil nil rev2-default) |
4d83a657 | 1604 | (read-string rev2-prompt nil nil rev2-default)))) |
b5446276 DN |
1605 | (when (string= rev1 "") (setq rev1 nil)) |
1606 | (when (string= rev2 "") (setq rev2 nil)) | |
a7192ddb | 1607 | (list files rev1 rev2)))) |
86048828 | 1608 | ;; All that was just so we could do argument completion! |
ae67f2d0 DN |
1609 | (when (and (not rev1) rev2) |
1610 | (error "Not a valid revision range.")) | |
86048828 ER |
1611 | ;; Yes, it's painful to call (vc-deduce-fileset) again. Alas, the |
1612 | ;; placement rules for (interactive) don't actually leave us a choice. | |
1613 | (vc-diff-internal t (vc-deduce-fileset) rev1 rev2 (interactive-p))) | |
d7b60083 | 1614 | |
a7192ddb SM |
1615 | ;; (defun vc-contains-version-controlled-file (dir) |
1616 | ;; "Return t if DIR contains a version-controlled file, nil otherwise." | |
1617 | ;; (catch 'found | |
1618 | ;; (mapc (lambda (f) (and (not (file-directory-p f)) (vc-backend f) (throw 'found 't))) (directory-files dir)) | |
1619 | ;; nil)) | |
727c4443 | 1620 | |
d7b60083 | 1621 | ;;;###autoload |
a7192ddb | 1622 | (defun vc-diff (historic &optional not-urgent) |
ac3f4c6f | 1623 | "Display diffs between file revisions. |
727c4443 | 1624 | Normally this compares the currently selected fileset with their |
a7192ddb | 1625 | working revisions. With a prefix argument HISTORIC, it reads two revision |
727c4443 ER |
1626 | designators specifying which revisions to compare. |
1627 | ||
a7192ddb SM |
1628 | The optional argument NOT-URGENT non-nil means it is ok to say no to |
1629 | saving the buffer." | |
1630 | (interactive (list current-prefix-arg t)) | |
1631 | (if historic | |
1632 | (call-interactively 'vc-version-diff) | |
ae67f2d0 | 1633 | (when buffer-file-name (vc-buffer-sync not-urgent)) |
86048828 | 1634 | (vc-diff-internal t (vc-deduce-fileset) nil nil (interactive-p)))) |
2c87edc1 | 1635 | |
f1818994 | 1636 | ;;;###autoload |
ac3f4c6f ER |
1637 | (defun vc-revision-other-window (rev) |
1638 | "Visit revision REV of the current file in another window. | |
1639 | If the current file is named `F', the revision is named `F.~REV~'. | |
6f1ecae4 | 1640 | If `F.~REV~' already exists, use it instead of checking it out again." |
4d83a657 SM |
1641 | (interactive |
1642 | (save-current-buffer | |
1643 | (vc-ensure-vc-buffer) | |
1644 | (let ((completion-table | |
1645 | (vc-call revision-completion-table buffer-file-name)) | |
ac3f4c6f | 1646 | (prompt "Revision to visit (default is working revision): ")) |
4d83a657 SM |
1647 | (list |
1648 | (if completion-table | |
1649 | (completing-read prompt completion-table) | |
1650 | (read-string prompt)))))) | |
b6909007 | 1651 | (vc-ensure-vc-buffer) |
5e011cb2 | 1652 | (let* ((file buffer-file-name) |
ac3f4c6f ER |
1653 | (revision (if (string-equal rev "") |
1654 | (vc-working-revision file) | |
ac0aae44 | 1655 | rev))) |
ac3f4c6f | 1656 | (switch-to-buffer-other-window (vc-find-revision file revision)))) |
ac0aae44 | 1657 | |
ac3f4c6f ER |
1658 | (defun vc-find-revision (file revision) |
1659 | "Read REVISION of FILE into a buffer and return the buffer." | |
1660 | (let ((automatic-backup (vc-version-backup-file-name file revision)) | |
fd8160f7 | 1661 | (filebuf (or (get-file-buffer file) (current-buffer))) |
ac3f4c6f | 1662 | (filename (vc-version-backup-file-name file revision 'manual))) |
fd8160f7 | 1663 | (unless (file-exists-p filename) |
10b48cc4 | 1664 | (if (file-exists-p automatic-backup) |
fd8160f7 SM |
1665 | (rename-file automatic-backup filename nil) |
1666 | (message "Checking out %s..." filename) | |
1667 | (with-current-buffer filebuf | |
1668 | (let ((failed t)) | |
1669 | (unwind-protect | |
1670 | (let ((coding-system-for-read 'no-conversion) | |
1671 | (coding-system-for-write 'no-conversion)) | |
1672 | (with-temp-file filename | |
1673 | (let ((outbuf (current-buffer))) | |
1674 | ;; Change buffer to get local value of | |
1675 | ;; vc-checkout-switches. | |
1676 | (with-current-buffer filebuf | |
ac3f4c6f | 1677 | (vc-call find-revision file revision outbuf)))) |
fd8160f7 | 1678 | (setq failed nil)) |
48b43130 DN |
1679 | (when (and failed (file-exists-p filename)) |
1680 | (delete-file filename)))) | |
fd8160f7 SM |
1681 | (vc-mode-line file)) |
1682 | (message "Checking out %s...done" filename))) | |
48b43130 DN |
1683 | (let ((result-buf (find-file-noselect filename))) |
1684 | (with-current-buffer result-buf | |
83f1f73b | 1685 | ;; Set the parent buffer so that things like |
48b43130 | 1686 | ;; C-x v g, C-x v l, ... etc work. |
25a4ea6d | 1687 | (set (make-local-variable 'vc-parent-buffer) filebuf)) |
48b43130 | 1688 | result-buf))) |
fd8160f7 | 1689 | |
594722a8 ER |
1690 | ;; Header-insertion code |
1691 | ||
637a8ae9 | 1692 | ;;;###autoload |
594722a8 | 1693 | (defun vc-insert-headers () |
6f1ecae4 | 1694 | "Insert headers into a file for use with a version control system. |
b524ce9f | 1695 | Headers desired are inserted at point, and are pulled from |
0e362f54 | 1696 | the variable `vc-BACKEND-header'." |
594722a8 | 1697 | (interactive) |
b6909007 | 1698 | (vc-ensure-vc-buffer) |
594722a8 ER |
1699 | (save-excursion |
1700 | (save-restriction | |
1701 | (widen) | |
b5446276 DN |
1702 | (when (or (not (vc-check-headers)) |
1703 | (y-or-n-p "Version headers already exist. Insert another set? ")) | |
1704 | (let* ((delims (cdr (assq major-mode vc-comment-alist))) | |
1705 | (comment-start-vc (or (car delims) comment-start "#")) | |
1706 | (comment-end-vc (or (car (cdr delims)) comment-end "")) | |
1707 | (hdsym (vc-make-backend-sym (vc-backend buffer-file-name) | |
1708 | 'header)) | |
1709 | (hdstrings (and (boundp hdsym) (symbol-value hdsym)))) | |
1710 | (dolist (s hdstrings) | |
1711 | (insert comment-start-vc "\t" s "\t" | |
1712 | comment-end-vc "\n")) | |
1713 | (when vc-static-header-alist | |
1714 | (dolist (f vc-static-header-alist) | |
1715 | (when (string-match (car f) buffer-file-name) | |
1716 | (insert (format (cdr f) (car hdstrings))))))))))) | |
594722a8 | 1717 | |
0e362f54 | 1718 | (defun vc-clear-headers (&optional file) |
099bd78a | 1719 | "Clear all version headers in the current buffer (or FILE). |
6f1ecae4 | 1720 | The headers are reset to their non-expanded form." |
0e362f54 GM |
1721 | (let* ((filename (or file buffer-file-name)) |
1722 | (visited (find-buffer-visiting filename)) | |
1723 | (backend (vc-backend filename))) | |
1724 | (when (vc-find-backend-function backend 'clear-headers) | |
6f41eeb5 | 1725 | (if visited |
0e362f54 GM |
1726 | (let ((context (vc-buffer-context))) |
1727 | ;; save-excursion may be able to relocate point and mark | |
1728 | ;; properly. If it fails, vc-restore-buffer-context | |
1729 | ;; will give it a second try. | |
1730 | (save-excursion | |
1731 | (vc-call-backend backend 'clear-headers)) | |
1732 | (vc-restore-buffer-context context)) | |
7849e179 | 1733 | (set-buffer (find-file-noselect filename)) |
0e362f54 GM |
1734 | (vc-call-backend backend 'clear-headers) |
1735 | (kill-buffer filename))))) | |
c8de1d91 | 1736 | |
9b64a7f0 ER |
1737 | (defun vc-modify-change-comment (files rev oldcomment) |
1738 | "Edit the comment associated with the given files and revision." | |
83affd96 | 1739 | (vc-start-logentry |
9b64a7f0 ER |
1740 | files rev oldcomment t |
1741 | "Enter a replacement change comment." | |
1742 | (lambda (files rev comment) | |
df49d02e | 1743 | (vc-call-backend |
9b64a7f0 ER |
1744 | ;; Less of a kluge than it looks like; log-view mode only passes |
1745 | ;; this function a singleton list. Arguments left in this form in | |
df49d02e JB |
1746 | ;; case the more general operation ever becomes meaningful. |
1747 | (vc-responsible-backend (car files)) | |
9b64a7f0 ER |
1748 | 'modify-change-comment files rev comment)))) |
1749 | ||
b6909007 | 1750 | ;;;###autoload |
099bd78a | 1751 | (defun vc-merge () |
ac3f4c6f ER |
1752 | "Merge changes between two revisions into the current buffer's file. |
1753 | This asks for two revisions to merge from in the minibuffer. If the | |
1754 | first revision is a branch number, then merge all changes from that | |
1755 | branch. If the first revision is empty, merge news, i.e. recent changes | |
099bd78a | 1756 | from the current branch. |
0e362f54 GM |
1757 | |
1758 | See Info node `Merging'." | |
099bd78a | 1759 | (interactive) |
ccb141e8 AS |
1760 | (vc-ensure-vc-buffer) |
1761 | (vc-buffer-sync) | |
1762 | (let* ((file buffer-file-name) | |
1763 | (backend (vc-backend file)) | |
0e362f54 | 1764 | (state (vc-state file)) |
ac3f4c6f | 1765 | first-revision second-revision status) |
0e362f54 | 1766 | (cond |
61de26cb | 1767 | ((stringp state) ;; Locking VCses only |
0e362f54 GM |
1768 | (error "File is locked by %s" state)) |
1769 | ((not (vc-editable-p file)) | |
1770 | (if (y-or-n-p | |
1771 | "File must be checked out for merging. Check out now? ") | |
1772 | (vc-checkout file t) | |
1773 | (error "Merge aborted")))) | |
ac3f4c6f ER |
1774 | (setq first-revision |
1775 | (read-string (concat "Branch or revision to merge from " | |
5b76833f | 1776 | "(default news on current branch): "))) |
ac3f4c6f | 1777 | (if (string= first-revision "") |
a749e19d | 1778 | (setq status (vc-call-backend backend 'merge-news file)) |
099bd78a SM |
1779 | (if (not (vc-find-backend-function backend 'merge)) |
1780 | (error "Sorry, merging is not implemented for %s" backend) | |
ac3f4c6f ER |
1781 | (if (not (vc-branch-p first-revision)) |
1782 | (setq second-revision | |
1783 | (read-string "Second revision: " | |
1784 | (concat (vc-branch-part first-revision) "."))) | |
1785 | ;; We want to merge an entire branch. Set revisions | |
099bd78a | 1786 | ;; accordingly, so that vc-BACKEND-merge understands us. |
ac3f4c6f ER |
1787 | (setq second-revision first-revision) |
1788 | ;; first-revision must be the starting point of the branch | |
1789 | (setq first-revision (vc-branch-part first-revision))) | |
a749e19d SM |
1790 | (setq status (vc-call-backend backend 'merge file |
1791 | first-revision second-revision)))) | |
099bd78a | 1792 | (vc-maybe-resolve-conflicts file status "WORKFILE" "MERGE SOURCE"))) |
0e362f54 GM |
1793 | |
1794 | (defun vc-maybe-resolve-conflicts (file status &optional name-A name-B) | |
1795 | (vc-resynch-buffer file t (not (buffer-modified-p))) | |
1796 | (if (zerop status) (message "Merge successful") | |
28e4e2b4 | 1797 | (smerge-mode 1) |
8dc87047 | 1798 | (message "File contains conflicts."))) |
ccb141e8 AS |
1799 | |
1800 | ;;;###autoload | |
1168d6c2 | 1801 | (defalias 'vc-resolve-conflicts 'smerge-ediff) |
3b574573 | 1802 | |
b1ddeeb7 ER |
1803 | ;; VC status implementation |
1804 | ||
b1ddeeb7 ER |
1805 | (defun vc-default-status-extra-headers (backend dir) |
1806 | ;; Be loud by default to remind people to add coded to display | |
1807 | ;; backend specific headers. | |
1808 | ;; XXX: change this to return nil before the release. | |
1809 | "Extra : Add backend specific headers here") | |
1810 | ||
1811 | (defun vc-dir-headers (backend dir) | |
1812 | "Display the headers in the *VC status* buffer. | |
1813 | It calls the `status-extra-headers' backend method to display backend | |
1814 | specific headers." | |
1815 | (concat | |
1816 | (propertize "VC backend : " 'face 'font-lock-type-face) | |
1817 | (propertize (format "%s\n" backend) 'face 'font-lock-variable-name-face) | |
1818 | (propertize "Working dir: " 'face 'font-lock-type-face) | |
1819 | (propertize (format "%s\n" dir) 'face 'font-lock-variable-name-face) | |
1820 | (vc-call-backend backend 'status-extra-headers dir) | |
1821 | "\n")) | |
1822 | ||
1823 | (defun vc-default-status-printer (backend fileentry) | |
1824 | "Pretty print FILEENTRY." | |
1825 | ;; If you change the layout here, change vc-dir-move-to-goal-column. | |
1826 | (let ((state | |
1827 | (if (vc-dir-fileinfo->directory fileentry) | |
1828 | 'DIRECTORY | |
1829 | (vc-dir-fileinfo->state fileentry)))) | |
1830 | (insert | |
1831 | (propertize | |
1832 | (format "%c" (if (vc-dir-fileinfo->marked fileentry) ?* ? )) | |
1833 | 'face 'font-lock-type-face) | |
1834 | " " | |
1835 | (propertize | |
1836 | (format "%-20s" state) | |
1837 | 'face (cond ((eq state 'up-to-date) 'font-lock-builtin-face) | |
1838 | ((memq state '(missing conflict)) 'font-lock-warning-face) | |
1839 | (t 'font-lock-variable-name-face)) | |
1840 | 'mouse-face 'highlight) | |
1841 | " " | |
1842 | (propertize | |
1843 | (format "%s" (vc-dir-fileinfo->name fileentry)) | |
1844 | 'face 'font-lock-function-name-face | |
1845 | 'mouse-face 'highlight)))) | |
1846 | ||
b1ddeeb7 ER |
1847 | (defun vc-default-extra-status-menu (backend) |
1848 | nil) | |
1849 | ||
783b505b ER |
1850 | ;; This is used to that VC backends could add backend specific menu |
1851 | ;; items to vc-dir-menu-map. | |
1852 | (defun vc-dir-menu-map-filter (orig-binding) | |
1853 | (when (and (symbolp orig-binding) (fboundp orig-binding)) | |
1854 | (setq orig-binding (indirect-function orig-binding))) | |
1855 | (let ((ext-binding | |
1856 | (vc-call-backend (vc-responsible-backend default-directory) | |
1857 | 'extra-status-menu))) | |
1858 | (if (null ext-binding) | |
1859 | orig-binding | |
1860 | (append orig-binding | |
1861 | '("----") | |
1862 | ext-binding)))) | |
b1ddeeb7 ER |
1863 | |
1864 | (defun vc-dir-refresh-files (files default-state) | |
1865 | "Refresh some files in the VC status buffer." | |
1866 | (let ((backend (vc-responsible-backend default-directory)) | |
1867 | (status-buffer (current-buffer)) | |
1868 | (def-dir default-directory)) | |
1869 | (vc-set-mode-line-busy-indicator) | |
1870 | ;; Call the `dir-status-file' backend function. | |
1871 | ;; `dir-status-file' is supposed to be asynchronous. | |
1872 | ;; It should compute the results, and then call the function | |
1873 | ;; passed as an argument in order to update the vc-dir buffer | |
1874 | ;; with the results. | |
1875 | (unless (buffer-live-p vc-dir-process-buffer) | |
1876 | (setq vc-dir-process-buffer | |
1877 | (generate-new-buffer (format " *VC-%s* tmp status" backend)))) | |
1878 | (lexical-let ((buffer (current-buffer))) | |
1879 | (with-current-buffer vc-dir-process-buffer | |
1880 | (cd def-dir) | |
1881 | (erase-buffer) | |
1882 | (vc-call-backend | |
1883 | backend 'dir-status-files def-dir files default-state | |
1884 | (lambda (entries &optional more-to-come) | |
1885 | ;; ENTRIES is a list of (FILE VC_STATE EXTRA) items. | |
1886 | ;; If MORE-TO-COME is true, then more updates will come from | |
1887 | ;; the asynchronous process. | |
1888 | (with-current-buffer buffer | |
1889 | (vc-dir-update entries buffer) | |
1890 | (unless more-to-come | |
1891 | (setq mode-line-process nil) | |
1892 | ;; Remove the ones that haven't been updated at all. | |
1893 | ;; Those not-updated are those whose state is nil because the | |
1894 | ;; file/dir doesn't exist and isn't versioned. | |
1895 | (ewoc-filter vc-ewoc | |
1896 | (lambda (info) | |
1897 | (not (vc-dir-fileinfo->needs-update info)))))))))))) | |
1898 | ||
1899 | (defun vc-dir-refresh () | |
1900 | "Refresh the contents of the VC status buffer. | |
1901 | Throw an error if another update process is in progress." | |
1902 | (interactive) | |
1903 | (if (vc-dir-busy) | |
1904 | (error "Another update process is in progress, cannot run two at a time") | |
1905 | (let ((backend (vc-responsible-backend default-directory)) | |
1906 | (status-buffer (current-buffer)) | |
1907 | (def-dir default-directory)) | |
1908 | (vc-set-mode-line-busy-indicator) | |
1909 | ;; Call the `dir-status' backend function. | |
1910 | ;; `dir-status' is supposed to be asynchronous. | |
1911 | ;; It should compute the results, and then call the function | |
1912 | ;; passed as an argument in order to update the vc-dir buffer | |
1913 | ;; with the results. | |
1914 | ||
1915 | ;; Create a buffer that can be used by `dir-status' and call | |
1916 | ;; `dir-status' with this buffer as the current buffer. Use | |
1917 | ;; `vc-dir-process-buffer' to remember this buffer, so that | |
1918 | ;; it can be used later to kill the update process in case it | |
1919 | ;; takes too long. | |
1920 | (unless (buffer-live-p vc-dir-process-buffer) | |
1921 | (setq vc-dir-process-buffer | |
1922 | (generate-new-buffer (format " *VC-%s* tmp status" backend)))) | |
1923 | ;; set the needs-update flag on all entries | |
1924 | (ewoc-map (lambda (info) (setf (vc-dir-fileinfo->needs-update info) t) nil) | |
1925 | vc-ewoc) | |
1926 | (lexical-let ((buffer (current-buffer))) | |
1927 | (with-current-buffer vc-dir-process-buffer | |
1928 | (cd def-dir) | |
1929 | (erase-buffer) | |
1930 | (vc-call-backend | |
1931 | backend 'dir-status def-dir | |
1932 | (lambda (entries &optional more-to-come) | |
1933 | ;; ENTRIES is a list of (FILE VC_STATE EXTRA) items. | |
1934 | ;; If MORE-TO-COME is true, then more updates will come from | |
1935 | ;; the asynchronous process. | |
1936 | (with-current-buffer buffer | |
1937 | (vc-dir-update entries buffer) | |
1938 | (unless more-to-come | |
1939 | (let ((remaining | |
1940 | (ewoc-collect | |
1941 | vc-ewoc 'vc-dir-fileinfo->needs-update))) | |
1942 | (if remaining | |
1943 | (vc-dir-refresh-files | |
1944 | (mapcar 'vc-dir-fileinfo->name remaining) | |
1945 | 'up-to-date) | |
1946 | (setq mode-line-process nil)))))))))))) | |
1947 | ||
b1ddeeb7 ER |
1948 | (defun vc-dir-show-fileentry (file) |
1949 | "Insert an entry for a specific file into the current VC status listing. | |
1950 | This is typically used if the file is up-to-date (or has been added | |
1951 | outside of VC) and one wants to do some operation on it." | |
1952 | (interactive "fShow file: ") | |
1953 | (vc-dir-update (list (list (file-relative-name file) (vc-state file))) (current-buffer))) | |
1954 | ||
b1ddeeb7 ER |
1955 | (defun vc-dir-hide-up-to-date () |
1956 | "Hide up-to-date items from display." | |
1957 | (interactive) | |
1958 | (ewoc-filter | |
1959 | vc-ewoc | |
1960 | (lambda (crt) (not (eq (vc-dir-fileinfo->state crt) 'up-to-date))))) | |
1961 | ||
783b505b ER |
1962 | (defun vc-dir-register () |
1963 | "Register the marked files, or the current file if no marks." | |
1964 | (interactive) | |
1965 | ;; FIXME: Just pass the fileset to vc-register. | |
1966 | (mapc (lambda (arg) (vc-register nil arg)) | |
1967 | (or (vc-dir-marked-files) (list (vc-dir-current-file))))) | |
1968 | ||
b1ddeeb7 | 1969 | (defun vc-default-status-fileinfo-extra (backend file) |
cb625535 | 1970 | "Default absence of extra information returned for a file." |
b1ddeeb7 ER |
1971 | nil) |
1972 | ||
cb625535 ER |
1973 | ;; FIXME: Replace these with a more efficient dispatch |
1974 | ||
1975 | (defun vc-generic-status-printer (fileentry) | |
725aff3c | 1976 | (let* ((file (vc-dir-fileinfo->name fileentry)) |
d5bea229 | 1977 | (backend (vc-responsible-backend (expand-file-name file)))) |
d5079317 | 1978 | (vc-call-backend backend 'status-printer fileentry))) |
cb625535 ER |
1979 | |
1980 | (defun vc-generic-state (file) | |
d5bea229 | 1981 | (let ((backend (vc-responsible-backend (expand-file-name file)))) |
5ebf2aa5 | 1982 | (vc-call-backend backend 'state file))) |
cb625535 ER |
1983 | |
1984 | (defun vc-generic-status-fileinfo-extra (file) | |
d5bea229 | 1985 | (let ((backend (vc-responsible-backend (expand-file-name file)))) |
5ebf2aa5 | 1986 | (vc-call-backend backend 'status-fileinfo-extra file))) |
cb625535 ER |
1987 | |
1988 | (defun vc-generic-dir-headers (dir) | |
1989 | (let ((backend (vc-responsible-backend dir))) | |
1990 | (vc-dir-headers backend dir))) | |
1991 | ||
1992 | (defun vc-make-backend-object (file-or-dir) | |
725aff3c | 1993 | "Create the backend capability object needed by vc-dispatcher." |
cb625535 ER |
1994 | (vc-create-client-object |
1995 | "VC status" | |
1996 | (let ((backend (vc-responsible-backend file-or-dir))) | |
1997 | (vc-dir-headers backend file-or-dir)) | |
1998 | #'vc-generic-status-printer | |
1999 | #'vc-generic-state | |
2000 | #'vc-generic-status-fileinfo-extra | |
2001 | #'vc-dir-refresh)) | |
2002 | ||
2003 | ;;;###autoload | |
2004 | (defun vc-dir (dir) | |
2005 | "Show the VC status for DIR." | |
2006 | (interactive "DVC status for directory: ") | |
2007 | (pop-to-buffer (vc-dir-prepare-status-buffer dir)) | |
734abae3 | 2008 | (if (and (derived-mode-p 'vc-dir-mode) (boundp 'client-object)) |
cb625535 ER |
2009 | (vc-dir-refresh) |
2010 | ;; Otherwise, initialize a new view using the dispatcher layer | |
2011 | (progn | |
2012 | ;; Build a capability object and hand it to the dispatcher initializer | |
a3e0b93f | 2013 | (vc-dir-mode (vc-make-backend-object dir)) |
734abae3 | 2014 | ;; FIXME: Make a derived-mode instead. |
cb625535 ER |
2015 | ;; Add VC-specific keybindings |
2016 | (let ((map (current-local-map))) | |
2017 | (define-key map "=" 'vc-diff) ;; C-x v = | |
2018 | (define-key map "a" 'vc-dir-register) | |
2019 | (define-key map "+" 'vc-update) ;; C-x v + | |
2020 | (define-key map "R" 'vc-revert) ;; u is taken by dispatcher unmark. | |
2021 | (define-key map "A" 'vc-annotate) ;; g is taken by dispatcher referesh | |
2022 | (define-key map "l" 'vc-print-log) ;; C-x v l | |
ee5d572f | 2023 | (define-key map "x" 'vc-dir-hide-up-to-date)) |
9a6b551b ER |
2024 | ) |
2025 | ;; FIXME: Needs to alter a buffer-local map, otherwise clients may clash | |
2026 | (let ((map vc-dir-menu-map)) | |
2027 | ;; VC info details | |
2028 | (define-key map [sepvcdet] '("--")) | |
2029 | (define-key map [remup] | |
2030 | '(menu-item "Hide up-to-date" vc-dir-hide-up-to-date | |
2031 | :help "Hide up-to-date items from display")) | |
2032 | ;; FIXME: This needs a key binding. And maybe a better name | |
2033 | ;; ("Insert" like PCL-CVS uses does not sound that great either)... | |
2034 | (define-key map [ins] | |
2035 | '(menu-item "Show File" vc-dir-show-fileentry | |
2036 | :help "Show a file in the VC status listing even though it might be up to date")) | |
2037 | (define-key map [annotate] | |
2038 | '(menu-item "Annotate" vc-annotate | |
2039 | :help "Display the edit history of the current file using colors")) | |
2040 | (define-key map [diff] | |
2041 | '(menu-item "Compare with Base Version" vc-diff | |
2042 | :help "Compare file set with the base version")) | |
2043 | (define-key map [log] | |
2044 | '(menu-item "Show history" vc-print-log | |
2045 | :help "List the change log of the current file set in a window")) | |
2046 | ;; VC commands. | |
2047 | (define-key map [sepvccmd] '("--")) | |
2048 | (define-key map [update] | |
2049 | '(menu-item "Update to latest version" vc-update | |
2050 | :help "Update the current fileset's files to their tip revisions")) | |
2051 | (define-key map [revert] | |
2052 | '(menu-item "Revert to base version" vc-revert | |
2053 | :help "Revert working copies of the selected fileset to their repository contents.")) | |
2054 | (define-key map [next-action] | |
2055 | ;; FIXME: This really really really needs a better name! | |
2056 | ;; And a key binding too. | |
2057 | '(menu-item "Check In/Out" vc-next-action | |
2058 | :help "Do the next logical version control operation on the current fileset")) | |
2059 | (define-key map [register] | |
2060 | '(menu-item "Register" vc-dir-register | |
2061 | :help "Register file set into the version control system")) | |
2062 | ))) | |
b1ddeeb7 | 2063 | |
594722a8 ER |
2064 | ;; Named-configuration entry points |
2065 | ||
0e362f54 | 2066 | (defun vc-snapshot-precondition (dir) |
6f1ecae4 | 2067 | "Scan the tree below DIR, looking for files not up-to-date. |
099bd78a SM |
2068 | If any file is not up-to-date, return the name of the first such file. |
2069 | \(This means, neither snapshot creation nor retrieval is allowed.\) | |
2070 | If one or more of the files are currently visited, return `visited'. | |
2071 | Otherwise, return nil." | |
503b5c85 RS |
2072 | (let ((status nil)) |
2073 | (catch 'vc-locked-example | |
2074 | (vc-file-tree-walk | |
0e362f54 GM |
2075 | dir |
2076 | (lambda (f) | |
2077 | (if (not (vc-up-to-date-p f)) (throw 'vc-locked-example f) | |
b5446276 | 2078 | (when (get-file-buffer f) (setq status 'visited))))) |
503b5c85 | 2079 | status))) |
594722a8 | 2080 | |
637a8ae9 | 2081 | ;;;###autoload |
0e362f54 | 2082 | (defun vc-create-snapshot (dir name branchp) |
6f41eeb5 | 2083 | "Descending recursively from DIR, make a snapshot called NAME. |
ac3f4c6f ER |
2084 | For each registered file, the working revision becomes part of |
2085 | the named configuration. If the prefix argument BRANCHP is | |
2086 | given, the snapshot is made as a new branch and the files are | |
2087 | checked out in that new branch." | |
0e362f54 GM |
2088 | (interactive |
2089 | (list (read-file-name "Directory: " default-directory default-directory t) | |
2090 | (read-string "New snapshot name: ") | |
2091 | current-prefix-arg)) | |
2092 | (message "Making %s... " (if branchp "branch" "snapshot")) | |
b5446276 | 2093 | (when (file-directory-p dir) (setq dir (file-name-as-directory dir))) |
0e362f54 GM |
2094 | (vc-call-backend (vc-responsible-backend dir) |
2095 | 'create-snapshot dir name branchp) | |
2096 | (message "Making %s... done" (if branchp "branch" "snapshot"))) | |
2097 | ||
637a8ae9 | 2098 | ;;;###autoload |
0e362f54 | 2099 | (defun vc-retrieve-snapshot (dir name) |
099bd78a | 2100 | "Descending recursively from DIR, retrieve the snapshot called NAME. |
ac3f4c6f | 2101 | If NAME is empty, it refers to the latest revisions. |
099bd78a SM |
2102 | If locking is used for the files in DIR, then there must not be any |
2103 | locked files at or below DIR (but if NAME is empty, locked files are | |
2104 | allowed and simply skipped)." | |
0e362f54 GM |
2105 | (interactive |
2106 | (list (read-file-name "Directory: " default-directory default-directory t) | |
ac3f4c6f | 2107 | (read-string "Snapshot name to retrieve (default latest revisions): "))) |
0e362f54 GM |
2108 | (let ((update (yes-or-no-p "Update any affected buffers? ")) |
2109 | (msg (if (or (not name) (string= name "")) | |
2110 | (format "Updating %s... " (abbreviate-file-name dir)) | |
2111 | (format "Retrieving snapshot into %s... " | |
2112 | (abbreviate-file-name dir))))) | |
8a26c165 | 2113 | (message "%s" msg) |
0e362f54 GM |
2114 | (vc-call-backend (vc-responsible-backend dir) |
2115 | 'retrieve-snapshot dir name update) | |
8a26c165 | 2116 | (message "%s" (concat msg "done")))) |
0e362f54 | 2117 | |
594722a8 ER |
2118 | ;; Miscellaneous other entry points |
2119 | ||
637a8ae9 | 2120 | ;;;###autoload |
ac3f4c6f | 2121 | (defun vc-print-log (&optional working-revision) |
d7b60083 | 2122 | "List the change log of the current fileset in a window. |
ac3f4c6f | 2123 | If WORKING-REVISION is non-nil, leave the point at that revision." |
594722a8 | 2124 | (interactive) |
ae67f2d0 | 2125 | (let* ((vc-fileset (vc-deduce-fileset)) |
ae67f2d0 | 2126 | (backend (car vc-fileset)) |
734abae3 | 2127 | (files (cdr vc-fileset)) |
ac3f4c6f | 2128 | (working-revision (or working-revision (vc-working-revision (car files))))) |
5217a76a SS |
2129 | ;; Don't switch to the output buffer before running the command, |
2130 | ;; so that any buffer-local settings in the vc-controlled | |
ac9ff209 | 2131 | ;; buffer can be accessed by the command. |
d7b60083 ER |
2132 | (vc-call-backend backend 'print-log files "*vc-change-log*") |
2133 | (pop-to-buffer "*vc-change-log*") | |
0e362f54 | 2134 | (vc-exec-after |
99cb8c8b | 2135 | `(let ((inhibit-read-only t)) |
d7b60083 | 2136 | (vc-call-backend ',backend 'log-view-mode) |
0e362f54 GM |
2137 | (goto-char (point-max)) (forward-line -1) |
2138 | (while (looking-at "=*\n") | |
2139 | (delete-char (- (match-end 0) (match-beginning 0))) | |
2140 | (forward-line -1)) | |
2141 | (goto-char (point-min)) | |
b5446276 DN |
2142 | (when (looking-at "[\b\t\n\v\f\r ]+") |
2143 | (delete-char (- (match-end 0) (match-beginning 0)))) | |
d7b60083 | 2144 | (shrink-window-if-larger-than-buffer) |
ac3f4c6f ER |
2145 | ;; move point to the log entry for the working revision |
2146 | (vc-call-backend ',backend 'show-log-entry ',working-revision) | |
86e80023 | 2147 | (setq vc-sentinel-movepoint (point)) |
99cb8c8b | 2148 | (set-buffer-modified-p nil))))) |
594722a8 | 2149 | |
637a8ae9 | 2150 | ;;;###autoload |
e4d26892 | 2151 | (defun vc-revert () |
d7b60083 | 2152 | "Revert working copies of the selected fileset to their repository contents. |
9c95ac44 | 2153 | This asks for confirmation if the buffer contents are not identical |
ac3f4c6f | 2154 | to the working revision (except for keyword expansion)." |
594722a8 | 2155 | (interactive) |
ae67f2d0 | 2156 | (let* ((vc-fileset (vc-deduce-fileset)) |
734abae3 | 2157 | (files (cdr vc-fileset))) |
d7b60083 ER |
2158 | ;; If any of the files is visited by the current buffer, make |
2159 | ;; sure buffer is saved. If the user says `no', abort since | |
2160 | ;; we cannot show the changes and ask for confirmation to | |
2161 | ;; discard them. | |
b5446276 DN |
2162 | (when (or (not files) (memq (buffer-file-name) files)) |
2163 | (vc-buffer-sync nil)) | |
d7b60083 | 2164 | (dolist (file files) |
a7192ddb | 2165 | (let ((buf (get-file-buffer file))) |
b5446276 | 2166 | (when (and buf (buffer-modified-p buf)) |
d7b60083 | 2167 | (error "Please kill or save all modified buffers before reverting."))) |
b5446276 DN |
2168 | (when (vc-up-to-date-p file) |
2169 | (unless (yes-or-no-p (format "%s seems up-to-date. Revert anyway? " file)) | |
2170 | (error "Revert canceled")))) | |
ae67f2d0 | 2171 | (when (vc-diff-internal vc-allow-async-revert vc-fileset nil nil) |
b5446276 DN |
2172 | (unless (yes-or-no-p (format "Discard changes in %s? " (vc-delistify files))) |
2173 | (error "Revert canceled")) | |
2174 | (delete-windows-on "*vc-diff*") | |
2175 | (kill-buffer "*vc-diff*")) | |
d7b60083 | 2176 | (dolist (file files) |
b5446276 DN |
2177 | (message "Reverting %s..." (vc-delistify files)) |
2178 | (vc-revert-file file) | |
2179 | (message "Reverting %s...done" (vc-delistify files))))) | |
594722a8 | 2180 | |
637a8ae9 | 2181 | ;;;###autoload |
d7b60083 ER |
2182 | (defun vc-rollback () |
2183 | "Roll back (remove) the most recent changeset committed to the repository. | |
2184 | This may be either a file-level or a repository-level operation, | |
2185 | depending on the underlying version-control system." | |
2186 | (interactive) | |
ae67f2d0 | 2187 | (let* ((vc-fileset (vc-deduce-fileset)) |
ae67f2d0 | 2188 | (backend (car vc-fileset)) |
734abae3 | 2189 | (files (cdr vc-fileset)) |
d7b60083 ER |
2190 | (granularity (vc-call-backend backend 'revision-granularity))) |
2191 | (unless (vc-find-backend-function backend 'rollback) | |
2192 | (error "Rollback is not supported in %s" backend)) | |
b5446276 DN |
2193 | (when (and (not (eq granularity 'repository)) (/= (length files) 1)) |
2194 | (error "Rollback requires a singleton fileset or repository versioning")) | |
a749e19d SM |
2195 | ;; FIXME: latest-on-branch-p should take the fileset. |
2196 | (when (not (vc-call-backend backend 'latest-on-branch-p (car files))) | |
b5446276 | 2197 | (error "Rollback is only possible at the tip revision.")) |
d7b60083 ER |
2198 | ;; If any of the files is visited by the current buffer, make |
2199 | ;; sure buffer is saved. If the user says `no', abort since | |
2200 | ;; we cannot show the changes and ask for confirmation to | |
2201 | ;; discard them. | |
b5446276 DN |
2202 | (when (or (not files) (memq (buffer-file-name) files)) |
2203 | (vc-buffer-sync nil)) | |
d7b60083 | 2204 | (dolist (file files) |
b5446276 DN |
2205 | (when (buffer-modified-p (get-file-buffer file)) |
2206 | (error "Please kill or save all modified buffers before rollback.")) | |
2207 | (when (not (vc-up-to-date-p file)) | |
2208 | (error "Please revert all modified workfiles before rollback."))) | |
d7b60083 ER |
2209 | ;; Accumulate changes associated with the fileset |
2210 | (vc-setup-buffer "*vc-diff*") | |
2211 | (not-modified) | |
2212 | (message "Finding changes...") | |
ac3f4c6f | 2213 | (let* ((tip (vc-working-revision (car files))) |
a749e19d SM |
2214 | ;; FIXME: `previous-revision' should take the fileset. |
2215 | (previous (vc-call-backend backend 'previous-revision | |
2216 | (car files) tip))) | |
ae67f2d0 | 2217 | (vc-diff-internal nil vc-fileset previous tip)) |
a7192ddb | 2218 | ;; Display changes |
d7b60083 ER |
2219 | (unless (yes-or-no-p "Discard these revisions? ") |
2220 | (error "Rollback canceled")) | |
2221 | (delete-windows-on "*vc-diff*") | |
2222 | (kill-buffer"*vc-diff*") | |
2223 | ;; Do the actual reversions | |
2224 | (message "Rolling back %s..." (vc-delistify files)) | |
2225 | (with-vc-properties | |
2226 | files | |
2227 | (vc-call-backend backend 'rollback files) | |
2228 | `((vc-state . ,'up-to-date) | |
2229 | (vc-checkout-time . , (nth 5 (file-attributes file))) | |
ac3f4c6f | 2230 | (vc-working-revision . nil))) |
a7192ddb | 2231 | (dolist (f files) (vc-resynch-buffer f t t)) |
d7b60083 | 2232 | (message "Rolling back %s...done" (vc-delistify files)))) |
0e362f54 | 2233 | |
2765044b DN |
2234 | ;;;###autoload |
2235 | (define-obsolete-function-alias 'vc-revert-buffer 'vc-revert "23.1") | |
2236 | ||
2237 | ;;;###autoload | |
2238 | (defun vc-update () | |
ac3f4c6f | 2239 | "Update the current fileset's files to their tip revisions. |
a7192ddb SM |
2240 | For each one that contains no changes, and is not locked, then this simply |
2241 | replaces the work file with the latest revision on its branch. If the file | |
2242 | contains changes, and the backend supports merging news, then any recent | |
d7b60083 | 2243 | changes from the current branch are merged into the working file." |
2765044b | 2244 | (interactive) |
ae67f2d0 | 2245 | (let* ((vc-fileset (vc-deduce-fileset)) |
86048828 | 2246 | (backend (car vc-fileset)) |
734abae3 | 2247 | (files (cdr vc-fileset))) |
ae67f2d0 DN |
2248 | (dolist (file files) |
2249 | (when (let ((buf (get-file-buffer file))) | |
2250 | (and buf (buffer-modified-p buf))) | |
2251 | (error "Please kill or save all modified buffers before updating.")) | |
2252 | (if (vc-up-to-date-p file) | |
2253 | (vc-checkout file nil t) | |
70e2f6c7 | 2254 | (if (eq (vc-checkout-model backend (list file)) 'locking) |
ae67f2d0 DN |
2255 | (if (eq (vc-state file) 'edited) |
2256 | (error "%s" | |
2257 | (substitute-command-keys | |
2258 | "File is locked--type \\[vc-revert] to discard changes")) | |
2259 | (error "Unexpected file state (%s) -- type %s" | |
2260 | (vc-state file) | |
1f325d92 | 2261 | (substitute-command-keys |
ae67f2d0 | 2262 | "\\[vc-next-action] to correct"))) |
a749e19d SM |
2263 | (vc-maybe-resolve-conflicts |
2264 | file (vc-call-backend backend 'merge-news file))))))) | |
2765044b DN |
2265 | |
2266 | (defun vc-version-backup-file (file &optional rev) | |
2267 | "Return name of backup file for revision REV of FILE. | |
2268 | If version backups should be used for FILE, and there exists | |
a7192ddb | 2269 | such a backup for REV or the working revision of file, return |
0d0e9356 | 2270 | its name; otherwise return nil." |
2765044b DN |
2271 | (when (vc-call make-version-backups-p file) |
2272 | (let ((backup-file (vc-version-backup-file-name file rev))) | |
2273 | (if (file-exists-p backup-file) | |
2274 | backup-file | |
2275 | ;; there is no automatic backup, but maybe the user made one manually | |
2276 | (setq backup-file (vc-version-backup-file-name file rev 'manual)) | |
b5446276 DN |
2277 | (when (file-exists-p backup-file) |
2278 | backup-file))))) | |
2765044b DN |
2279 | |
2280 | (defun vc-revert-file (file) | |
ac3f4c6f | 2281 | "Revert FILE back to the repository working revision it was based on." |
2765044b | 2282 | (with-vc-properties |
d7b60083 | 2283 | (list file) |
2765044b DN |
2284 | (let ((backup-file (vc-version-backup-file file))) |
2285 | (when backup-file | |
2286 | (copy-file backup-file file 'ok-if-already-exists 'keep-date) | |
2287 | (vc-delete-automatic-version-backups file)) | |
2288 | (vc-call revert file backup-file)) | |
2289 | `((vc-state . up-to-date) | |
2290 | (vc-checkout-time . ,(nth 5 (file-attributes file))))) | |
2291 | (vc-resynch-buffer file t t)) | |
2292 | ||
76e5906d | 2293 | ;;;###autoload |
1d502d5a | 2294 | (defun vc-switch-backend (file backend) |
7849e179 | 2295 | "Make BACKEND the current version control system for FILE. |
1d502d5a AS |
2296 | FILE must already be registered in BACKEND. The change is not |
2297 | permanent, only for the current session. This function only changes | |
7849e179 SM |
2298 | VC's perspective on FILE, it does not register or unregister it. |
2299 | By default, this command cycles through the registered backends. | |
2300 | To get a prompt, use a prefix argument." | |
2301 | (interactive | |
1d502d5a | 2302 | (list |
94ca88e3 AS |
2303 | (or buffer-file-name |
2304 | (error "There is no version-controlled file in this buffer")) | |
7849e179 SM |
2305 | (let ((backend (vc-backend buffer-file-name)) |
2306 | (backends nil)) | |
d7b60083 ER |
2307 | (unless backend |
2308 | (error "File %s is not under version control" buffer-file-name)) | |
2309 | ;; Find the registered backends. | |
2310 | (dolist (backend vc-handled-backends) | |
2311 | (when (vc-call-backend backend 'registered buffer-file-name) | |
2312 | (push backend backends))) | |
2313 | ;; Find the next backend. | |
2314 | (let ((def (car (delq backend (append (memq backend backends) backends)))) | |
2315 | (others (delete backend backends))) | |
2316 | (cond | |
2317 | ((null others) (error "No other backend to switch to")) | |
2318 | (current-prefix-arg | |
2319 | (intern | |
2320 | (upcase | |
2321 | (completing-read | |
2322 | (format "Switch to backend [%s]: " def) | |
2323 | (mapcar (lambda (b) (list (downcase (symbol-name b)))) backends) | |
2324 | nil t nil nil (downcase (symbol-name def)))))) | |
2325 | (t def)))))) | |
ceec5a0c | 2326 | (unless (eq backend (vc-backend file)) |
ceec5a0c SM |
2327 | (vc-file-clearprops file) |
2328 | (vc-file-setprop file 'vc-backend backend) | |
2329 | ;; Force recomputation of the state | |
a3255400 SM |
2330 | (unless (vc-call-backend backend 'registered file) |
2331 | (vc-file-clearprops file) | |
2332 | (error "%s is not registered in %s" file backend)) | |
ceec5a0c | 2333 | (vc-mode-line file))) |
1d502d5a | 2334 | |
21b50296 | 2335 | ;;;###autoload |
1d502d5a | 2336 | (defun vc-transfer-file (file new-backend) |
ceec5a0c | 2337 | "Transfer FILE to another version control system NEW-BACKEND. |
1d502d5a | 2338 | If NEW-BACKEND has a higher precedence than FILE's current backend |
ceec5a0c | 2339 | \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in |
ac3f4c6f | 2340 | NEW-BACKEND, using the revision number from the current backend as the |
1d502d5a AS |
2341 | base level. If NEW-BACKEND has a lower precedence than the current |
2342 | backend, then commit all changes that were made under the current | |
2343 | backend to NEW-BACKEND, and unregister FILE from the current backend. | |
2344 | \(If FILE is not yet registered under NEW-BACKEND, register it.)" | |
72cfc5fb AS |
2345 | (let* ((old-backend (vc-backend file)) |
2346 | (edited (memq (vc-state file) '(edited needs-merge))) | |
2347 | (registered (vc-call-backend new-backend 'registered file)) | |
2348 | (move | |
2349 | (and registered ; Never move if not registered in new-backend yet. | |
2350 | ;; move if new-backend comes later in vc-handled-backends | |
2351 | (or (memq new-backend (memq old-backend vc-handled-backends)) | |
ffda0460 | 2352 | (y-or-n-p "Final transfer? ")))) |
72cfc5fb | 2353 | (comment nil)) |
ae67f2d0 DN |
2354 | (when (eq old-backend new-backend) |
2355 | (error "%s is the current backend of %s" new-backend file)) | |
72cfc5fb AS |
2356 | (if registered |
2357 | (set-file-modes file (logior (file-modes file) 128)) | |
2358 | ;; `registered' might have switched under us. | |
2359 | (vc-switch-backend file old-backend) | |
ac3f4c6f | 2360 | (let* ((rev (vc-working-revision file)) |
c1b1b393 | 2361 | (modified-file (and edited (make-temp-file file))) |
ffda0460 | 2362 | (unmodified-file (and modified-file (vc-version-backup-file file)))) |
72cfc5fb AS |
2363 | ;; Go back to the base unmodified file. |
2364 | (unwind-protect | |
2365 | (progn | |
ffda0460 | 2366 | (when modified-file |
c1b1b393 | 2367 | (copy-file file modified-file 'ok-if-already-exists) |
ffda0460 AS |
2368 | ;; If we have a local copy of the unmodified file, handle that |
2369 | ;; here and not in vc-revert-file because we don't want to | |
2370 | ;; delete that copy -- it is still useful for OLD-BACKEND. | |
2371 | (if unmodified-file | |
b4e4e3a8 SM |
2372 | (copy-file unmodified-file file |
2373 | 'ok-if-already-exists 'keep-date) | |
ae67f2d0 DN |
2374 | (when (y-or-n-p "Get base revision from master? ") |
2375 | (vc-revert-file file)))) | |
72cfc5fb | 2376 | (vc-call-backend new-backend 'receive-file file rev)) |
ffda0460 | 2377 | (when modified-file |
72cfc5fb | 2378 | (vc-switch-backend file new-backend) |
70e2f6c7 | 2379 | (unless (eq (vc-checkout-model new-backend (list file)) 'implicit) |
72cfc5fb | 2380 | (vc-checkout file t nil)) |
ffda0460 AS |
2381 | (rename-file modified-file file 'ok-if-already-exists) |
2382 | (vc-file-setprop file 'vc-checkout-time nil))))) | |
72cfc5fb AS |
2383 | (when move |
2384 | (vc-switch-backend file old-backend) | |
a749e19d SM |
2385 | (setq comment (vc-call-backend old-backend 'comment-history file)) |
2386 | (vc-call-backend old-backend 'unregister file)) | |
72cfc5fb AS |
2387 | (vc-switch-backend file new-backend) |
2388 | (when (or move edited) | |
1d502d5a | 2389 | (vc-file-setprop file 'vc-state 'edited) |
ffda0460 | 2390 | (vc-mode-line file) |
0ab66291 | 2391 | (vc-checkin file nil comment (stringp comment))))) |
1d502d5a | 2392 | |
0e362f54 GM |
2393 | (defun vc-rename-master (oldmaster newfile templates) |
2394 | "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES." | |
2395 | (let* ((dir (file-name-directory (expand-file-name oldmaster))) | |
2396 | (newdir (or (file-name-directory newfile) "")) | |
2397 | (newbase (file-name-nondirectory newfile)) | |
2398 | (masters | |
2399 | ;; List of potential master files for `newfile' | |
2400 | (mapcar | |
2401 | (lambda (s) (vc-possible-master s newdir newbase)) | |
2402 | templates))) | |
b5446276 DN |
2403 | (when (or (file-symlink-p oldmaster) |
2404 | (file-symlink-p (file-name-directory oldmaster))) | |
2405 | (error "This is unsafe in the presence of symbolic links")) | |
0e362f54 GM |
2406 | (rename-file |
2407 | oldmaster | |
2408 | (catch 'found | |
2409 | ;; If possible, keep the master file in the same directory. | |
b4e4e3a8 | 2410 | (dolist (f masters) |
ae67f2d0 DN |
2411 | (when (and f (string= (file-name-directory (expand-file-name f)) dir)) |
2412 | (throw 'found f))) | |
0e362f54 | 2413 | ;; If not, just use the first possible place. |
b4e4e3a8 SM |
2414 | (dolist (f masters) |
2415 | (and f (or (not (setq dir (file-name-directory f))) | |
2416 | (file-directory-p dir)) | |
2417 | (throw 'found f))) | |
0e362f54 | 2418 | (error "New file lacks a version control directory"))))) |
594722a8 | 2419 | |
a36319a4 SM |
2420 | (defun vc-delete-file (file) |
2421 | "Delete file and mark it as such in the version control system." | |
2422 | (interactive "fVC delete file: ") | |
484c3092 | 2423 | (setq file (expand-file-name file)) |
c6e44350 AS |
2424 | (let ((buf (get-file-buffer file)) |
2425 | (backend (vc-backend file))) | |
2426 | (unless backend | |
86a65190 | 2427 | (error "File %s is not under version control" |
c6e44350 | 2428 | (file-name-nondirectory file))) |
a36319a4 | 2429 | (unless (vc-find-backend-function backend 'delete-file) |
c6e44350 | 2430 | (error "Deleting files under %s is not supported in VC" backend)) |
b5446276 | 2431 | (when (and buf (buffer-modified-p buf)) |
a84615c7 SS |
2432 | (error "Please save or undo your changes before deleting %s" file)) |
2433 | (let ((state (vc-state file))) | |
2434 | (when (eq state 'edited) | |
2435 | (error "Please commit or undo your changes before deleting %s" file)) | |
2436 | (when (eq state 'conflict) | |
2437 | (error "Please resolve the conflicts before deleting %s" file))) | |
ce5a3ac0 | 2438 | (unless (y-or-n-p (format "Really want to delete %s? " |
a36319a4 SM |
2439 | (file-name-nondirectory file))) |
2440 | (error "Abort!")) | |
775237d3 SS |
2441 | (unless (or (file-directory-p file) (null make-backup-files) |
2442 | (not (file-exists-p file))) | |
a36319a4 SM |
2443 | (with-current-buffer (or buf (find-file-noselect file)) |
2444 | (let ((backup-inhibited nil)) | |
484c3092 DN |
2445 | (backup-buffer)) |
2446 | ;; If we didn't have a buffer visiting the file before this | |
2447 | ;; command, kill the buffer created by the above | |
2448 | ;; `find-file-noselect' call. | |
2449 | (unless buf (kill-buffer (current-buffer))))) | |
a749e19d | 2450 | (vc-call-backend backend 'delete-file file) |
a36319a4 | 2451 | ;; If the backend hasn't deleted the file itself, let's do it for him. |
b5446276 | 2452 | (when (file-exists-p file) (delete-file file)) |
484c3092 DN |
2453 | ;; Forget what VC knew about the file. |
2454 | (vc-file-clearprops file) | |
2455 | (vc-resynch-buffer file buf t))) | |
a36319a4 | 2456 | |
29fc1ce9 | 2457 | ;;;###autoload |
594722a8 | 2458 | (defun vc-rename-file (old new) |
34291cd2 RS |
2459 | "Rename file OLD to NEW, and rename its master file likewise." |
2460 | (interactive "fVC rename file: \nFRename to: ") | |
a36319a4 | 2461 | (let ((oldbuf (get-file-buffer old))) |
b5446276 DN |
2462 | (when (and oldbuf (buffer-modified-p oldbuf)) |
2463 | (error "Please save files before moving them")) | |
2464 | (when (get-file-buffer new) | |
2465 | (error "Already editing new file name")) | |
2466 | (when (file-exists-p new) | |
2467 | (error "New file already exists")) | |
86a65190 | 2468 | (let ((state (vc-state old))) |
a36319a4 SM |
2469 | (unless (memq state '(up-to-date edited)) |
2470 | (error "Please %s files before moving them" | |
2471 | (if (stringp state) "check in" "update")))) | |
2472 | (vc-call rename-file old new) | |
b4e4e3a8 | 2473 | (vc-file-clearprops old) |
0e362f54 | 2474 | ;; Move the actual file (unless the backend did it already) |
b5446276 | 2475 | (when (file-exists-p old) (rename-file old new)) |
0e362f54 GM |
2476 | ;; ?? Renaming a file might change its contents due to keyword expansion. |
2477 | ;; We should really check out a new copy if the old copy was precisely equal | |
ac3f4c6f | 2478 | ;; to some checked-in revision. However, testing for this is tricky.... |
b5446276 DN |
2479 | (when oldbuf |
2480 | (with-current-buffer oldbuf | |
2481 | (let ((buffer-read-only buffer-read-only)) | |
2482 | (set-visited-file-name new)) | |
2483 | (vc-backend new) | |
2484 | (vc-mode-line new) | |
2485 | (set-buffer-modified-p nil))))) | |
0e362f54 | 2486 | |
637a8ae9 | 2487 | ;;;###autoload |
f35ecf88 | 2488 | (defun vc-update-change-log (&rest args) |
0e362f54 | 2489 | "Find change log file and add entries from recent version control logs. |
d68e6990 | 2490 | Normally, find log entries for all registered files in the default |
0e362f54 | 2491 | directory. |
d68e6990 | 2492 | |
099bd78a | 2493 | With prefix arg of \\[universal-argument], only find log entries for the current buffer's file. |
d68e6990 RS |
2494 | |
2495 | With any numeric prefix arg, find log entries for all currently visited | |
2496 | files that are under version control. This puts all the entries in the | |
2497 | log for the default directory, which may not be appropriate. | |
2498 | ||
099bd78a | 2499 | From a program, any ARGS are assumed to be filenames for which |
0e362f54 | 2500 | log entries should be gathered." |
67242a23 RM |
2501 | (interactive |
2502 | (cond ((consp current-prefix-arg) ;C-u | |
2503 | (list buffer-file-name)) | |
2504 | (current-prefix-arg ;Numeric argument. | |
2505 | (let ((files nil) | |
2506 | (buffers (buffer-list)) | |
2507 | file) | |
2508 | (while buffers | |
2509 | (setq file (buffer-file-name (car buffers))) | |
f3c61d82 | 2510 | (and file (vc-backend file) |
4b40fdea | 2511 | (setq files (cons file files))) |
67242a23 | 2512 | (setq buffers (cdr buffers))) |
4b40fdea PE |
2513 | files)) |
2514 | (t | |
0e362f54 GM |
2515 | ;; Don't supply any filenames to backend; this means |
2516 | ;; it should find all relevant files relative to | |
2517 | ;; the default-directory. | |
73a9679c | 2518 | nil))) |
0e362f54 GM |
2519 | (vc-call-backend (vc-responsible-backend default-directory) |
2520 | 'update-changelog args)) | |
2521 | ||
ac3f4c6f | 2522 | ;;; The default back end. Assumes RCS-like revision numbering. |
61de26cb ER |
2523 | |
2524 | (defun vc-default-revision-granularity () | |
2525 | (error "Your backend will not work with this version of VC mode.")) | |
2526 | ||
2765044b DN |
2527 | ;; functions that operate on RCS revision numbers. This code should |
2528 | ;; also be moved into the backends. It stays for now, however, since | |
2529 | ;; it is used in code below. | |
2530 | ;;;###autoload | |
2531 | (defun vc-trunk-p (rev) | |
2532 | "Return t if REV is a revision on the trunk." | |
2533 | (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev)))) | |
2534 | ||
2535 | (defun vc-branch-p (rev) | |
2536 | "Return t if REV is a branch revision." | |
2537 | (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev)))) | |
2538 | ||
2539 | ;;;###autoload | |
2540 | (defun vc-branch-part (rev) | |
2541 | "Return the branch part of a revision number REV." | |
2542 | (let ((index (string-match "\\.[0-9]+\\'" rev))) | |
b5446276 DN |
2543 | (when index |
2544 | (substring rev 0 index)))) | |
2765044b DN |
2545 | |
2546 | (defun vc-minor-part (rev) | |
ac3f4c6f | 2547 | "Return the minor revision number of a revision number REV." |
2765044b DN |
2548 | (string-match "[0-9]+\\'" rev) |
2549 | (substring rev (match-beginning 0) (match-end 0))) | |
2550 | ||
ac3f4c6f ER |
2551 | (defun vc-default-previous-revision (backend file rev) |
2552 | "Return the revision number immediately preceding REV for FILE, | |
2553 | or nil if there is no previous revision. This default | |
2554 | implementation works for MAJOR.MINOR-style revision numbers as | |
2765044b DN |
2555 | used by RCS and CVS." |
2556 | (let ((branch (vc-branch-part rev)) | |
2557 | (minor-num (string-to-number (vc-minor-part rev)))) | |
2558 | (when branch | |
2559 | (if (> minor-num 1) | |
ac3f4c6f | 2560 | ;; revision does probably not start a branch or release |
2765044b DN |
2561 | (concat branch "." (number-to-string (1- minor-num))) |
2562 | (if (vc-trunk-p rev) | |
2563 | ;; we are at the beginning of the trunk -- | |
2564 | ;; don't know anything to return here | |
2565 | nil | |
2566 | ;; we are at the beginning of a branch -- | |
ac3f4c6f | 2567 | ;; return revision of starting point |
2765044b DN |
2568 | (vc-branch-part branch)))))) |
2569 | ||
ac3f4c6f ER |
2570 | (defun vc-default-next-revision (backend file rev) |
2571 | "Return the revision number immediately following REV for FILE, | |
2572 | or nil if there is no next revision. This default implementation | |
2573 | works for MAJOR.MINOR-style revision numbers as used by RCS | |
2765044b | 2574 | and CVS." |
ac3f4c6f | 2575 | (when (not (string= rev (vc-working-revision file))) |
2765044b DN |
2576 | (let ((branch (vc-branch-part rev)) |
2577 | (minor-num (string-to-number (vc-minor-part rev)))) | |
2578 | (concat branch "." (number-to-string (1+ minor-num)))))) | |
2579 | ||
2580 | (defun vc-default-responsible-p (backend file) | |
2581 | "Indicate whether BACKEND is reponsible for FILE. | |
2582 | The default is to return nil always." | |
2583 | nil) | |
2584 | ||
2585 | (defun vc-default-could-register (backend file) | |
2586 | "Return non-nil if BACKEND could be used to register FILE. | |
2587 | The default implementation returns t for all files." | |
2588 | t) | |
2589 | ||
2590 | (defun vc-default-latest-on-branch-p (backend file) | |
2591 | "Return non-nil if FILE is the latest on its branch. | |
2592 | This default implementation always returns non-nil, which means that | |
ac3f4c6f | 2593 | editing non-current revisions is not supported by default." |
2765044b DN |
2594 | t) |
2595 | ||
ac3f4c6f | 2596 | (defun vc-default-init-revision (backend) vc-default-init-revision) |
2765044b | 2597 | |
45fd3a00 SM |
2598 | (defalias 'vc-cvs-update-changelog 'vc-update-changelog-rcs2log) |
2599 | (defalias 'vc-rcs-update-changelog 'vc-update-changelog-rcs2log) | |
2600 | ;; FIXME: This should probably be moved to vc-rcs.el and replaced in | |
2601 | ;; vc-cvs.el by code using cvs2cl. | |
0b8dce84 | 2602 | (defun vc-update-changelog-rcs2log (files) |
099bd78a SM |
2603 | "Default implementation of update-changelog. |
2604 | Uses `rcs2log' which only works for RCS and CVS." | |
0e362f54 | 2605 | ;; FIXME: We (c|sh)ould add support for cvs2cl |
449decf5 | 2606 | (let ((odefault default-directory) |
124c852b RS |
2607 | (changelog (find-change-log)) |
2608 | ;; Presumably not portable to non-Unixy systems, along with rcs2log: | |
c1b1b393 | 2609 | (tempfile (make-temp-file |
57c298c4 EZ |
2610 | (expand-file-name "vc" |
2611 | (or small-temporary-file-directory | |
2612 | temporary-file-directory)))) | |
510f6466 AS |
2613 | (login-name (or user-login-name |
2614 | (format "uid%d" (number-to-string (user-uid))))) | |
b91916f3 | 2615 | (full-name (or add-log-full-name |
8172cd86 AS |
2616 | (user-full-name) |
2617 | (user-login-name) | |
2618 | (format "uid%d" (number-to-string (user-uid))))) | |
b91916f3 RS |
2619 | (mailing-address (or add-log-mailing-address |
2620 | user-mail-address))) | |
124c852b | 2621 | (find-file-other-window changelog) |
41dfb835 RS |
2622 | (barf-if-buffer-read-only) |
2623 | (vc-buffer-sync) | |
2624 | (undo-boundary) | |
2625 | (goto-char (point-min)) | |
2626 | (push-mark) | |
2627 | (message "Computing change log entries...") | |
4b40fdea | 2628 | (message "Computing change log entries... %s" |
124c852b RS |
2629 | (unwind-protect |
2630 | (progn | |
0e362f54 | 2631 | (setq default-directory odefault) |
6f41eeb5 DL |
2632 | (if (eq 0 (apply 'call-process |
2633 | (expand-file-name "rcs2log" | |
2634 | exec-directory) | |
0e362f54 GM |
2635 | nil (list t tempfile) nil |
2636 | "-c" changelog | |
510f6466 | 2637 | "-u" (concat login-name |
0e362f54 GM |
2638 | "\t" full-name |
2639 | "\t" mailing-address) | |
2640 | (mapcar | |
2641 | (lambda (f) | |
2642 | (file-relative-name | |
d7b60083 | 2643 | (expand-file-name f odefault))) |
0e362f54 GM |
2644 | files))) |
2645 | "done" | |
04864eb0 | 2646 | (pop-to-buffer (get-buffer-create "*vc*")) |
124c852b | 2647 | (erase-buffer) |
54ebae28 | 2648 | (insert-file-contents tempfile) |
124c852b | 2649 | "failed")) |
0e362f54 | 2650 | (setq default-directory (file-name-directory changelog)) |
124c852b | 2651 | (delete-file tempfile))))) |
7d2d9482 | 2652 | |
ac3f4c6f ER |
2653 | (defun vc-default-find-revision (backend file rev buffer) |
2654 | "Provide the new `find-revision' op based on the old `checkout' op. | |
2765044b | 2655 | This is only for compatibility with old backends. They should be updated |
ac3f4c6f | 2656 | to provide the `find-revision' operation instead." |
2765044b DN |
2657 | (let ((tmpfile (make-temp-file (expand-file-name file)))) |
2658 | (unwind-protect | |
2659 | (progn | |
2660 | (vc-call-backend backend 'checkout file nil rev tmpfile) | |
2661 | (with-current-buffer buffer | |
2662 | (insert-file-contents-literally tmpfile))) | |
2663 | (delete-file tmpfile)))) | |
2664 | ||
0a299408 | 2665 | (defun vc-default-prettify-state-info (backend file) |
d7b60083 ER |
2666 | (let* ((state (vc-state file)) |
2667 | (statestring | |
2668 | (cond | |
2669 | ((stringp state) (concat "(" state ")")) | |
45b24b4d | 2670 | ((eq state 'edited) "(modified)") |
d7b60083 | 2671 | ((eq state 'needs-merge) "(merge)") |
3702367b | 2672 | ((eq state 'needs-update) "(update)") |
0f67cc71 | 2673 | ((eq state 'added) "(added)") |
484c1b1f | 2674 | ((eq state 'removed) "(removed)") |
e6244c1b | 2675 | ((eq state 'ignored) "(ignored)") |
722f037f ER |
2676 | ((eq state 'unregistered) "?") |
2677 | ((eq state 'unlocked-changes) "(stale)") | |
2678 | ((not state) "(unknown)"))) | |
d7b60083 ER |
2679 | (buffer |
2680 | (get-file-buffer file)) | |
2681 | (modflag | |
2682 | (if (and buffer (buffer-modified-p buffer)) "+" ""))) | |
2683 | (concat statestring modflag))) | |
2765044b DN |
2684 | |
2685 | (defun vc-default-rename-file (backend old new) | |
2686 | (condition-case nil | |
2687 | (add-name-to-file old new) | |
2688 | (error (rename-file old new))) | |
2689 | (vc-delete-file old) | |
2690 | (with-current-buffer (find-file-noselect new) | |
2691 | (vc-register))) | |
2692 | ||
17f3909f | 2693 | (defalias 'vc-default-check-headers 'ignore) |
2765044b DN |
2694 | |
2695 | (defun vc-default-log-view-mode (backend) (log-view-mode)) | |
2696 | ||
2697 | (defun vc-default-show-log-entry (backend rev) | |
2698 | (with-no-warnings | |
2699 | (log-view-goto-rev rev))) | |
2700 | ||
2701 | (defun vc-default-comment-history (backend file) | |
2702 | "Return a string with all log entries stored in BACKEND for FILE." | |
7fbb4797 DN |
2703 | (when (vc-find-backend-function backend 'print-log) |
2704 | (with-current-buffer "*vc*" | |
a749e19d | 2705 | (vc-call-backend backend 'print-log (list file)) |
7fbb4797 | 2706 | (buffer-string)))) |
2765044b | 2707 | |
2765044b DN |
2708 | (defun vc-default-receive-file (backend file rev) |
2709 | "Let BACKEND receive FILE from another version control system." | |
2710 | (vc-call-backend backend 'register file rev "")) | |
2711 | ||
2712 | (defun vc-default-create-snapshot (backend dir name branchp) | |
2713 | (when branchp | |
2714 | (error "VC backend %s does not support module branches" backend)) | |
2715 | (let ((result (vc-snapshot-precondition dir))) | |
2716 | (if (stringp result) | |
2717 | (error "File %s is not up-to-date" result) | |
2718 | (vc-file-tree-walk | |
2719 | dir | |
2720 | (lambda (f) | |
a749e19d | 2721 | (vc-call-backend backend 'assign-name f name)))))) |
2765044b DN |
2722 | |
2723 | (defun vc-default-retrieve-snapshot (backend dir name update) | |
2724 | (if (string= name "") | |
2725 | (progn | |
2726 | (vc-file-tree-walk | |
2727 | dir | |
2728 | (lambda (f) (and | |
2729 | (vc-up-to-date-p f) | |
2730 | (vc-error-occurred | |
a749e19d | 2731 | (vc-call-backend backend 'checkout f nil "") |
b5446276 | 2732 | (when update (vc-resynch-buffer f t t))))))) |
2765044b DN |
2733 | (let ((result (vc-snapshot-precondition dir))) |
2734 | (if (stringp result) | |
2735 | (error "File %s is locked" result) | |
2736 | (setq update (and (eq result 'visited) update)) | |
2737 | (vc-file-tree-walk | |
2738 | dir | |
2739 | (lambda (f) (vc-error-occurred | |
a749e19d | 2740 | (vc-call-backend backend 'checkout f nil name) |
b5446276 | 2741 | (when update (vc-resynch-buffer f t t))))))))) |
2765044b DN |
2742 | |
2743 | (defun vc-default-revert (backend file contents-done) | |
2744 | (unless contents-done | |
ac3f4c6f | 2745 | (let ((rev (vc-working-revision file)) |
2765044b DN |
2746 | (file-buffer (or (get-file-buffer file) (current-buffer)))) |
2747 | (message "Checking out %s..." file) | |
2748 | (let ((failed t) | |
2749 | (backup-name (car (find-backup-file-name file)))) | |
2750 | (when backup-name | |
2751 | (copy-file file backup-name 'ok-if-already-exists 'keep-date) | |
2752 | (unless (file-writable-p file) | |
2753 | (set-file-modes file (logior (file-modes file) 128)))) | |
2754 | (unwind-protect | |
2755 | (let ((coding-system-for-read 'no-conversion) | |
2756 | (coding-system-for-write 'no-conversion)) | |
2757 | (with-temp-file file | |
2758 | (let ((outbuf (current-buffer))) | |
2759 | ;; Change buffer to get local value of vc-checkout-switches. | |
2760 | (with-current-buffer file-buffer | |
2761 | (let ((default-directory (file-name-directory file))) | |
a749e19d SM |
2762 | (vc-call-backend backend 'find-revision |
2763 | file rev outbuf))))) | |
2765044b DN |
2764 | (setq failed nil)) |
2765 | (when backup-name | |
2766 | (if failed | |
2767 | (rename-file backup-name file 'ok-if-already-exists) | |
2768 | (and (not vc-make-backup-files) (delete-file backup-name)))))) | |
2769 | (message "Checking out %s...done" file)))) | |
2770 | ||
17f3909f | 2771 | (defalias 'vc-default-revision-completion-table 'ignore) |
2765044b | 2772 | |
fb0ac090 AJ |
2773 | (defun vc-default-dir-status-files (backend dir files default-state update-function) |
2774 | (funcall update-function | |
2775 | (mapcar (lambda (file) (list file default-state)) files))) | |
2776 | ||
2765044b DN |
2777 | (defun vc-check-headers () |
2778 | "Check if the current file has any headers in it." | |
2779 | (interactive) | |
2780 | (vc-call-backend (vc-backend buffer-file-name) 'check-headers)) | |
2781 | ||
2782 | ;;; Annotate functionality | |
7d2d9482 | 2783 | |
f80f7bc2 RS |
2784 | ;; Declare globally instead of additional parameter to |
2785 | ;; temp-buffer-show-function (not possible to pass more than one | |
75665141 AS |
2786 | ;; parameter). The use of annotate-ratio is deprecated in favor of |
2787 | ;; annotate-mode, which replaces it with the more sensible "span-to | |
2788 | ;; days", along with autoscaling support. | |
099bd78a | 2789 | (defvar vc-annotate-ratio nil "Global variable.") |
0e362f54 | 2790 | |
1b5a7343 | 2791 | ;; internal buffer-local variables |
04864eb0 | 2792 | (defvar vc-annotate-backend nil) |
1b5a7343 AS |
2793 | (defvar vc-annotate-parent-file nil) |
2794 | (defvar vc-annotate-parent-rev nil) | |
2795 | (defvar vc-annotate-parent-display-mode nil) | |
1b5a7343 | 2796 | |
f66a6225 SM |
2797 | (defconst vc-annotate-font-lock-keywords |
2798 | ;; The fontification is done by vc-annotate-lines instead of font-lock. | |
2799 | '((vc-annotate-lines))) | |
2800 | ||
93113211 | 2801 | (define-derived-mode vc-annotate-mode fundamental-mode "Annotate" |
6f1ecae4 | 2802 | "Major mode for output buffers of the `vc-annotate' command. |
7d2d9482 RS |
2803 | |
2804 | You can use the mode-specific menu to alter the time-span of the used | |
2805 | colors. See variable `vc-annotate-menu-elements' for customizing the | |
2806 | menu items." | |
5731a8e0 TTN |
2807 | ;; Frob buffer-invisibility-spec so that if it is originally a naked t, |
2808 | ;; it will become a list, to avoid initial annotations being invisible. | |
2809 | (add-to-invisibility-spec 'foo) | |
2810 | (remove-from-invisibility-spec 'foo) | |
f66a6225 SM |
2811 | (set (make-local-variable 'truncate-lines) t) |
2812 | (set (make-local-variable 'font-lock-defaults) | |
2813 | '(vc-annotate-font-lock-keywords t)) | |
04864eb0 | 2814 | (view-mode 1)) |
7d2d9482 | 2815 | |
5731a8e0 TTN |
2816 | (defun vc-annotate-toggle-annotation-visibility () |
2817 | "Toggle whether or not the annotation is visible." | |
2818 | (interactive) | |
2819 | (funcall (if (memq 'vc-annotate-annotation buffer-invisibility-spec) | |
2820 | 'remove-from-invisibility-spec | |
2821 | 'add-to-invisibility-spec) | |
2822 | 'vc-annotate-annotation) | |
2823 | (force-window-update (current-buffer))) | |
2824 | ||
97461c84 | 2825 | (defun vc-annotate-display-default (ratio) |
6f1ecae4 | 2826 | "Display the output of \\[vc-annotate] using the default color range. |
97461c84 SM |
2827 | The color range is given by `vc-annotate-color-map', scaled by RATIO. |
2828 | The current time is used as the offset." | |
2829 | (interactive (progn (kill-local-variable 'vc-annotate-color-map) '(1.0))) | |
f80f7bc2 | 2830 | (message "Redisplaying annotation...") |
97461c84 | 2831 | (vc-annotate-display ratio) |
f80f7bc2 | 2832 | (message "Redisplaying annotation...done")) |
7d2d9482 | 2833 | |
97461c84 SM |
2834 | (defun vc-annotate-oldest-in-map (color-map) |
2835 | "Return the oldest time in the COLOR-MAP." | |
2836 | ;; Since entries should be sorted, we can just use the last one. | |
2837 | (caar (last color-map))) | |
6149bbfb | 2838 | |
5731a8e0 TTN |
2839 | (defun vc-annotate-get-time-set-line-props () |
2840 | (let ((bol (point)) | |
2841 | (date (vc-call-backend vc-annotate-backend 'annotate-time)) | |
2842 | (inhibit-read-only t)) | |
f605fc58 | 2843 | (assert (>= (point) bol)) |
5731a8e0 TTN |
2844 | (put-text-property bol (point) 'invisible 'vc-annotate-annotation) |
2845 | date)) | |
2846 | ||
75665141 | 2847 | (defun vc-annotate-display-autoscale (&optional full) |
946b248f | 2848 | "Highlight the output of \\[vc-annotate] using an autoscaled color map. |
6f1ecae4 | 2849 | Autoscaling means that the map is scaled from the current time to the |
f36e4afe | 2850 | oldest annotation in the buffer, or, with prefix argument FULL, to |
6f1ecae4 | 2851 | cover the range from the oldest annotation to the newest." |
f36e4afe | 2852 | (interactive "P") |
75665141 AS |
2853 | (let ((newest 0.0) |
2854 | (oldest 999999.) ;Any CVS users at the founding of Rome? | |
2855 | (current (vc-annotate-convert-time (current-time))) | |
2856 | date) | |
2857 | (message "Redisplaying annotation...") | |
2858 | ;; Run through this file and find the oldest and newest dates annotated. | |
2859 | (save-excursion | |
2860 | (goto-char (point-min)) | |
7c33af85 | 2861 | (while (not (eobp)) |
5731a8e0 | 2862 | (when (setq date (vc-annotate-get-time-set-line-props)) |
b5446276 DN |
2863 | (when (> date newest) |
2864 | (setq newest date)) | |
2865 | (when (< date oldest) | |
2866 | (setq oldest date))) | |
7c33af85 | 2867 | (forward-line 1))) |
75665141 | 2868 | (vc-annotate-display |
97461c84 SM |
2869 | (/ (- (if full newest current) oldest) |
2870 | (vc-annotate-oldest-in-map vc-annotate-color-map)) | |
75665141 | 2871 | (if full newest)) |
99cb8c8b SS |
2872 | (message "Redisplaying annotation...done \(%s\)" |
2873 | (if full | |
2874 | (format "Spanned from %.1f to %.1f days old" | |
75665141 AS |
2875 | (- current oldest) |
2876 | (- current newest)) | |
2877 | (format "Spanned to %.1f days old" (- current oldest)))))) | |
2878 | ||
2879 | ;; Menu -- Using easymenu.el | |
04864eb0 SM |
2880 | (easy-menu-define vc-annotate-mode-menu vc-annotate-mode-map |
2881 | "VC Annotate Display Menu" | |
2882 | `("VC-Annotate" | |
da7c8a12 | 2883 | ["By Color Map Range" (unless (null vc-annotate-display-mode) |
04864eb0 SM |
2884 | (setq vc-annotate-display-mode nil) |
2885 | (vc-annotate-display-select)) | |
2886 | :style toggle :selected (null vc-annotate-display-mode)] | |
97461c84 | 2887 | ,@(let ((oldest-in-map (vc-annotate-oldest-in-map vc-annotate-color-map))) |
04864eb0 SM |
2888 | (mapcar (lambda (element) |
2889 | (let ((days (* element oldest-in-map))) | |
07a95b81 SM |
2890 | `[,(format "Span %.1f days" days) |
2891 | (vc-annotate-display-select nil ,days) | |
2892 | :style toggle :selected | |
2893 | (eql vc-annotate-display-mode ,days) ])) | |
04864eb0 SM |
2894 | vc-annotate-menu-elements)) |
2895 | ["Span ..." | |
07a95b81 SM |
2896 | (vc-annotate-display-select |
2897 | nil (float (string-to-number (read-string "Span how many days? "))))] | |
04864eb0 SM |
2898 | "--" |
2899 | ["Span to Oldest" | |
2900 | (unless (eq vc-annotate-display-mode 'scale) | |
2901 | (vc-annotate-display-select nil 'scale)) | |
df04e22c | 2902 | :help |
f3ff0fe9 | 2903 | "Use an autoscaled color map from the oldest annotation to the current time" |
04864eb0 SM |
2904 | :style toggle :selected |
2905 | (eq vc-annotate-display-mode 'scale)] | |
2906 | ["Span Oldest->Newest" | |
2907 | (unless (eq vc-annotate-display-mode 'fullscale) | |
2908 | (vc-annotate-display-select nil 'fullscale)) | |
df04e22c | 2909 | :help |
f3ff0fe9 | 2910 | "Use an autoscaled color map from the oldest to the newest annotation" |
04864eb0 SM |
2911 | :style toggle :selected |
2912 | (eq vc-annotate-display-mode 'fullscale)] | |
2913 | "--" | |
f3ff0fe9 | 2914 | ["Toggle annotation visibility" vc-annotate-toggle-annotation-visibility |
df04e22c | 2915 | :help |
f3ff0fe9 DN |
2916 | "Toggle whether the annotation is visible or not"] |
2917 | ["Annotate previous revision" vc-annotate-prev-revision | |
2918 | :help "Visit the annotation of the revision previous to this one"] | |
2919 | ["Annotate next revision" vc-annotate-next-revision | |
2920 | :help "Visit the annotation of the revision after this one"] | |
2921 | ["Annotate revision at line" vc-annotate-revision-at-line | |
df04e22c | 2922 | :help |
f3ff0fe9 DN |
2923 | "Visit the annotation of the revision identified in the current line"] |
2924 | ["Annotate revision previous to line" vc-annotate-revision-previous-to-line | |
2925 | :help "Visit the annotation of the revision before the revision at line"] | |
2926 | ["Annotate latest revision" vc-annotate-working-revision | |
2927 | :help "Visit the annotation of the working revision of this file"] | |
2928 | ["Show log of revision at line" vc-annotate-show-log-revision-at-line | |
2929 | :help "Visit the log of the revision at line"] | |
2930 | ["Show diff of revision at line" vc-annotate-show-diff-revision-at-line | |
df04e22c | 2931 | :help |
f3ff0fe9 DN |
2932 | "Visit the diff of the revision at line from its previous revision"] |
2933 | ["Visit revision at line" vc-annotate-find-revision-at-line | |
2934 | :help "Visit the revision identified in the current line"])) | |
75665141 AS |
2935 | |
2936 | (defun vc-annotate-display-select (&optional buffer mode) | |
6f1ecae4 AS |
2937 | "Highlight the output of \\[vc-annotate]. |
2938 | By default, the current buffer is highlighted, unless overridden by | |
2939 | BUFFER. `vc-annotate-display-mode' specifies the highlighting mode to | |
2940 | use; you may override this using the second optional arg MODE." | |
2941 | (interactive) | |
b5446276 | 2942 | (when mode (setq vc-annotate-display-mode mode)) |
8a8f8697 | 2943 | (pop-to-buffer (or buffer (current-buffer))) |
f66a6225 | 2944 | (cond ((null vc-annotate-display-mode) |
07a95b81 SM |
2945 | ;; The ratio is global, thus relative to the global color-map. |
2946 | (kill-local-variable 'vc-annotate-color-map) | |
97461c84 SM |
2947 | (vc-annotate-display-default (or vc-annotate-ratio 1.0))) |
2948 | ;; One of the auto-scaling modes | |
f66a6225 | 2949 | ((eq vc-annotate-display-mode 'scale) |
7c33af85 | 2950 | (vc-exec-after `(vc-annotate-display-autoscale))) |
f66a6225 | 2951 | ((eq vc-annotate-display-mode 'fullscale) |
7c33af85 | 2952 | (vc-exec-after `(vc-annotate-display-autoscale t))) |
75665141 AS |
2953 | ((numberp vc-annotate-display-mode) ; A fixed number of days lookback |
2954 | (vc-annotate-display-default | |
97461c84 SM |
2955 | (/ vc-annotate-display-mode |
2956 | (vc-annotate-oldest-in-map vc-annotate-color-map)))) | |
f66a6225 SM |
2957 | (t (error "No such display mode: %s" |
2958 | vc-annotate-display-mode)))) | |
0e362f54 | 2959 | |
7d2d9482 | 2960 | ;;;###autoload |
bae9f9e3 | 2961 | (defun vc-annotate (file rev &optional display-mode buf move-point-to) |
aa406465 | 2962 | "Display the edit history of the current file using colors. |
1cec418c AS |
2963 | |
2964 | This command creates a buffer that shows, for each line of the current | |
aa406465 | 2965 | file, when it was last edited and by whom. Additionally, colors are |
1cec418c | 2966 | used to show the age of each line--blue means oldest, red means |
aa406465 | 2967 | youngest, and intermediate colors indicate intermediate ages. By |
1cec418c AS |
2968 | default, the time scale stretches back one year into the past; |
2969 | everything that is older than that is shown in blue. | |
2970 | ||
2971 | With a prefix argument, this command asks two questions in the | |
ac3f4c6f ER |
2972 | minibuffer. First, you may enter a revision number; then the buffer |
2973 | displays and annotates that revision instead of the working revision | |
eb407e67 | 2974 | \(type RET in the minibuffer to leave that default unchanged). Then, |
ecd50f65 AS |
2975 | you are prompted for the time span in days which the color range |
2976 | should cover. For example, a time span of 20 days means that changes | |
2977 | over the past 20 days are shown in red to blue, according to their | |
2978 | age, and everything that is older than that is shown in blue. | |
1cec418c | 2979 | |
bae9f9e3 DN |
2980 | If MOVE-POINT-TO is given, move the point to that line. |
2981 | ||
1cec418c | 2982 | Customization variables: |
7d2d9482 RS |
2983 | |
2984 | `vc-annotate-menu-elements' customizes the menu elements of the | |
a7192ddb SM |
2985 | mode-specific menu. `vc-annotate-color-map' and |
2986 | `vc-annotate-very-old-color' define the mapping of time to colors. | |
2987 | `vc-annotate-background' specifies the background color." | |
04864eb0 SM |
2988 | (interactive |
2989 | (save-current-buffer | |
2990 | (vc-ensure-vc-buffer) | |
2991 | (list buffer-file-name | |
ac3f4c6f | 2992 | (let ((def (vc-working-revision buffer-file-name))) |
04864eb0 SM |
2993 | (if (null current-prefix-arg) def |
2994 | (read-string | |
ac3f4c6f | 2995 | (format "Annotate from revision (default %s): " def) |
04864eb0 SM |
2996 | nil nil def))) |
2997 | (if (null current-prefix-arg) | |
2998 | vc-annotate-display-mode | |
2999 | (float (string-to-number | |
3000 | (read-string "Annotate span days (default 20): " | |
3001 | nil nil "20"))))))) | |
b6909007 | 3002 | (vc-ensure-vc-buffer) |
04864eb0 SM |
3003 | (setq vc-annotate-display-mode display-mode) ;Not sure why. --Stef |
3004 | (let* ((temp-buffer-name (format "*Annotate %s (rev %s)*" (buffer-name) rev)) | |
1867d8cb TTN |
3005 | (temp-buffer-show-function 'vc-annotate-display-select) |
3006 | ;; If BUF is specified, we presume the caller maintains current line, | |
3007 | ;; so we don't need to do it here. This implementation may give | |
3008 | ;; strange results occasionally in the case of REV != WORKFILE-REV. | |
bae9f9e3 | 3009 | (current-line (or move-point-to (unless buf (line-number-at-pos))))) |
afe35502 | 3010 | (message "Annotating...") |
04864eb0 SM |
3011 | ;; If BUF is specified it tells in which buffer we should put the |
3012 | ;; annotations. This is used when switching annotations to another | |
3013 | ;; revision, so we should update the buffer's name. | |
b5446276 DN |
3014 | (when buf (with-current-buffer buf |
3015 | (rename-buffer temp-buffer-name t) | |
3016 | ;; In case it had to be uniquified. | |
3017 | (setq temp-buffer-name (buffer-name)))) | |
46e33aee | 3018 | (with-output-to-temp-buffer temp-buffer-name |
a749e19d SM |
3019 | (let ((backend (vc-backend file))) |
3020 | (vc-call-backend backend 'annotate-command file | |
3021 | (get-buffer temp-buffer-name) rev) | |
3022 | ;; we must setup the mode first, and then set our local | |
3023 | ;; variables before the show-function is called at the exit of | |
3024 | ;; with-output-to-temp-buffer | |
3025 | (with-current-buffer temp-buffer-name | |
3026 | (unless (equal major-mode 'vc-annotate-mode) | |
3027 | (vc-annotate-mode)) | |
3028 | (set (make-local-variable 'vc-annotate-backend) backend) | |
3029 | (set (make-local-variable 'vc-annotate-parent-file) file) | |
3030 | (set (make-local-variable 'vc-annotate-parent-rev) rev) | |
3031 | (set (make-local-variable 'vc-annotate-parent-display-mode) | |
3032 | display-mode)))) | |
cd42ec7d | 3033 | |
ebaac04d SM |
3034 | (with-current-buffer temp-buffer-name |
3035 | (vc-exec-after | |
3036 | `(progn | |
3037 | ;; Ideally, we'd rather not move point if the user has already | |
3038 | ;; moved it elsewhere, but really point here is not the position | |
3039 | ;; of the user's cursor :-( | |
3040 | (when ,current-line ;(and (bobp)) | |
86e80023 | 3041 | (goto-line ,current-line) |
01823b77 | 3042 | (setq vc-sentinel-movepoint (point))) |
ebaac04d SM |
3043 | (unless (active-minibuffer-window) |
3044 | (message "Annotating... done"))))))) | |
7d2d9482 | 3045 | |
ac3f4c6f ER |
3046 | (defun vc-annotate-prev-revision (prefix) |
3047 | "Visit the annotation of the revision previous to this one. | |
1b5a7343 | 3048 | |
ac3f4c6f ER |
3049 | With a numeric prefix argument, annotate the revision that many |
3050 | revisions previous." | |
1b5a7343 | 3051 | (interactive "p") |
ac3f4c6f | 3052 | (vc-annotate-warp-revision (- 0 prefix))) |
1b5a7343 | 3053 | |
ac3f4c6f ER |
3054 | (defun vc-annotate-next-revision (prefix) |
3055 | "Visit the annotation of the revision after this one. | |
1b5a7343 | 3056 | |
ac3f4c6f ER |
3057 | With a numeric prefix argument, annotate the revision that many |
3058 | revisions after." | |
1b5a7343 | 3059 | (interactive "p") |
ac3f4c6f | 3060 | (vc-annotate-warp-revision prefix)) |
1b5a7343 | 3061 | |
ac3f4c6f ER |
3062 | (defun vc-annotate-working-revision () |
3063 | "Visit the annotation of the working revision of this file." | |
1b5a7343 AS |
3064 | (interactive) |
3065 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3066 | (message "Cannot be invoked outside of a vc annotate buffer") | |
ac3f4c6f | 3067 | (let ((warp-rev (vc-working-revision vc-annotate-parent-file))) |
1b5a7343 | 3068 | (if (equal warp-rev vc-annotate-parent-rev) |
ac3f4c6f ER |
3069 | (message "Already at revision %s" warp-rev) |
3070 | (vc-annotate-warp-revision warp-rev))))) | |
1b5a7343 AS |
3071 | |
3072 | (defun vc-annotate-extract-revision-at-line () | |
3073 | "Extract the revision number of the current line." | |
3074 | ;; This function must be invoked from a buffer in vc-annotate-mode | |
1b5a7343 AS |
3075 | (vc-call-backend vc-annotate-backend 'annotate-extract-revision-at-line)) |
3076 | ||
3077 | (defun vc-annotate-revision-at-line () | |
ac3f4c6f | 3078 | "Visit the annotation of the revision identified in the current line." |
1b5a7343 AS |
3079 | (interactive) |
3080 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3081 | (message "Cannot be invoked outside of a vc annotate buffer") | |
3082 | (let ((rev-at-line (vc-annotate-extract-revision-at-line))) | |
3083 | (if (not rev-at-line) | |
3084 | (message "Cannot extract revision number from the current line") | |
3085 | (if (equal rev-at-line vc-annotate-parent-rev) | |
ac3f4c6f ER |
3086 | (message "Already at revision %s" rev-at-line) |
3087 | (vc-annotate-warp-revision rev-at-line)))))) | |
1b5a7343 | 3088 | |
f3ff0fe9 DN |
3089 | (defun vc-annotate-find-revision-at-line () |
3090 | "Visit the revision identified in the current line." | |
3091 | (interactive) | |
3092 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3093 | (message "Cannot be invoked outside of a vc annotate buffer") | |
3094 | (let ((rev-at-line (vc-annotate-extract-revision-at-line))) | |
3095 | (if (not rev-at-line) | |
3096 | (message "Cannot extract revision number from the current line") | |
3097 | (vc-revision-other-window rev-at-line))))) | |
3098 | ||
1b5a7343 | 3099 | (defun vc-annotate-revision-previous-to-line () |
ac3f4c6f | 3100 | "Visit the annotation of the revision before the revision at line." |
1b5a7343 AS |
3101 | (interactive) |
3102 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3103 | (message "Cannot be invoked outside of a vc annotate buffer") | |
3104 | (let ((rev-at-line (vc-annotate-extract-revision-at-line)) | |
3105 | (prev-rev nil)) | |
3106 | (if (not rev-at-line) | |
3107 | (message "Cannot extract revision number from the current line") | |
3108 | (setq prev-rev | |
a749e19d SM |
3109 | (vc-call-backend vc-annotate-backend 'previous-revision |
3110 | vc-annotate-parent-file rev-at-line)) | |
ac3f4c6f | 3111 | (vc-annotate-warp-revision prev-rev))))) |
1b5a7343 AS |
3112 | |
3113 | (defun vc-annotate-show-log-revision-at-line () | |
ac3f4c6f | 3114 | "Visit the log of the revision at line." |
1b5a7343 AS |
3115 | (interactive) |
3116 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3117 | (message "Cannot be invoked outside of a vc annotate buffer") | |
3118 | (let ((rev-at-line (vc-annotate-extract-revision-at-line))) | |
3119 | (if (not rev-at-line) | |
3120 | (message "Cannot extract revision number from the current line") | |
3121 | (vc-print-log rev-at-line))))) | |
3122 | ||
3123 | (defun vc-annotate-show-diff-revision-at-line () | |
ac3f4c6f | 3124 | "Visit the diff of the revision at line from its previous revision." |
1b5a7343 AS |
3125 | (interactive) |
3126 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3127 | (message "Cannot be invoked outside of a vc annotate buffer") | |
3128 | (let ((rev-at-line (vc-annotate-extract-revision-at-line)) | |
3129 | (prev-rev nil)) | |
3130 | (if (not rev-at-line) | |
3131 | (message "Cannot extract revision number from the current line") | |
3132 | (setq prev-rev | |
a749e19d SM |
3133 | (vc-call-backend vc-annotate-backend 'previous-revision |
3134 | vc-annotate-parent-file rev-at-line)) | |
1b5a7343 | 3135 | (if (not prev-rev) |
ac3f4c6f | 3136 | (message "Cannot diff from any revision prior to %s" rev-at-line) |
1b5a7343 | 3137 | (save-window-excursion |
ae67f2d0 DN |
3138 | (vc-diff-internal |
3139 | nil | |
3140 | (cons (vc-backend vc-annotate-parent-file) | |
86048828 ER |
3141 | (cons nil |
3142 | (list vc-annotate-parent-file))) | |
ae67f2d0 | 3143 | prev-rev rev-at-line)) |
1b5a7343 AS |
3144 | (switch-to-buffer "*vc-diff*")))))) |
3145 | ||
ac3f4c6f ER |
3146 | (defun vc-annotate-warp-revision (revspec) |
3147 | "Annotate the revision described by REVSPEC. | |
1b5a7343 | 3148 | |
ac3f4c6f | 3149 | If REVSPEC is a positive integer, warp that many revisions |
1b5a7343 | 3150 | forward, if possible, otherwise echo a warning message. If |
ac3f4c6f | 3151 | REVSPEC is a negative integer, warp that many revisions backward, |
1b5a7343 AS |
3152 | if possible, otherwise echo a warning message. If REVSPEC is a |
3153 | string, then it describes a revision number, so warp to that | |
3154 | revision." | |
3155 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3156 | (message "Cannot be invoked outside of a vc annotate buffer") | |
da7c8a12 S |
3157 | (let* ((buf (current-buffer)) |
3158 | (oldline (line-number-at-pos)) | |
1b5a7343 AS |
3159 | (revspeccopy revspec) |
3160 | (newrev nil)) | |
3161 | (cond | |
3162 | ((and (integerp revspec) (> revspec 0)) | |
3163 | (setq newrev vc-annotate-parent-rev) | |
3164 | (while (and (> revspec 0) newrev) | |
a749e19d SM |
3165 | (setq newrev (vc-call-backend vc-annotate-backend 'next-revision |
3166 | vc-annotate-parent-file newrev)) | |
3167 | (setq revspec (1- revspec))) | |
b5446276 DN |
3168 | (unless newrev |
3169 | (message "Cannot increment %d revisions from revision %s" | |
3170 | revspeccopy vc-annotate-parent-rev))) | |
1b5a7343 AS |
3171 | ((and (integerp revspec) (< revspec 0)) |
3172 | (setq newrev vc-annotate-parent-rev) | |
3173 | (while (and (< revspec 0) newrev) | |
a749e19d SM |
3174 | (setq newrev (vc-call-backend vc-annotate-backend 'previous-revision |
3175 | vc-annotate-parent-file newrev)) | |
3176 | (setq revspec (1+ revspec))) | |
b5446276 DN |
3177 | (unless newrev |
3178 | (message "Cannot decrement %d revisions from revision %s" | |
3179 | (- 0 revspeccopy) vc-annotate-parent-rev))) | |
1b5a7343 | 3180 | ((stringp revspec) (setq newrev revspec)) |
ac3f4c6f | 3181 | (t (error "Invalid argument to vc-annotate-warp-revision"))) |
1b5a7343 | 3182 | (when newrev |
04864eb0 SM |
3183 | (vc-annotate vc-annotate-parent-file newrev |
3184 | vc-annotate-parent-display-mode | |
bae9f9e3 DN |
3185 | buf |
3186 | ;; Pass the current line so that vc-annotate will | |
3187 | ;; place the point in the line. | |
3188 | (min oldline (progn (goto-char (point-max)) | |
a749e19d SM |
3189 | (forward-line -1) |
3190 | (line-number-at-pos)))))))) | |
1b5a7343 | 3191 | |
f70419a8 | 3192 | (defun vc-annotate-compcar (threshold a-list) |
6f1ecae4 AS |
3193 | "Test successive cons cells of A-LIST against THRESHOLD. |
3194 | Return the first cons cell with a car that is not less than THRESHOLD, | |
3195 | nil if no such cell exists." | |
f70419a8 RS |
3196 | (let ((i 1) |
3197 | (tmp-cons (car a-list))) | |
3198 | (while (and tmp-cons (< (car tmp-cons) threshold)) | |
3199 | (setq tmp-cons (car (nthcdr i a-list))) | |
3200 | (setq i (+ i 1))) | |
3201 | tmp-cons)) ; Return the appropriate value | |
3202 | ||
75665141 | 3203 | (defun vc-annotate-convert-time (time) |
6f1ecae4 AS |
3204 | "Convert a time value to a floating-point number of days. |
3205 | The argument TIME is a list as returned by `current-time' or | |
3206 | `encode-time', only the first two elements of that list are considered." | |
75665141 AS |
3207 | (/ (+ (* (float (car time)) (lsh 1 16)) (cadr time)) 24 3600)) |
3208 | ||
3209 | (defun vc-annotate-difference (&optional offset) | |
6f1ecae4 AS |
3210 | "Return the time span in days to the next annotation. |
3211 | This calls the backend function annotate-time, and returns the | |
3212 | difference in days between the time returned and the current time, | |
3213 | or OFFSET if present." | |
5731a8e0 | 3214 | (let ((next-time (vc-annotate-get-time-set-line-props))) |
b5446276 DN |
3215 | (when next-time |
3216 | (- (or offset | |
3217 | (vc-call-backend vc-annotate-backend 'annotate-current-time)) | |
3218 | next-time)))) | |
75665141 AS |
3219 | |
3220 | (defun vc-default-annotate-current-time (backend) | |
3221 | "Return the current time, encoded as fractional days." | |
3222 | (vc-annotate-convert-time (current-time))) | |
99cb8c8b | 3223 | |
07577777 JPW |
3224 | (defvar vc-annotate-offset nil) |
3225 | ||
97461c84 | 3226 | (defun vc-annotate-display (ratio &optional offset) |
6f1ecae4 | 3227 | "Highlight `vc-annotate' output in the current buffer. |
97461c84 | 3228 | RATIO, is the expansion that should be applied to `vc-annotate-color-map'. |
bf142f28 | 3229 | The annotations are relative to the current time, unless overridden by OFFSET." |
b5446276 DN |
3230 | (when (/= ratio 1.0) |
3231 | (set (make-local-variable 'vc-annotate-color-map) | |
3232 | (mapcar (lambda (elem) (cons (* (car elem) ratio) (cdr elem))) | |
3233 | vc-annotate-color-map))) | |
f66a6225 SM |
3234 | (set (make-local-variable 'vc-annotate-offset) offset) |
3235 | (font-lock-mode 1)) | |
3236 | ||
f66a6225 | 3237 | (defun vc-annotate-lines (limit) |
7c33af85 SM |
3238 | (while (< (point) limit) |
3239 | (let ((difference (vc-annotate-difference vc-annotate-offset)) | |
3240 | (start (point)) | |
3241 | (end (progn (forward-line 1) (point)))) | |
3242 | (when difference | |
3243 | (let* ((color (or (vc-annotate-compcar difference vc-annotate-color-map) | |
3244 | (cons nil vc-annotate-very-old-color))) | |
3245 | ;; substring from index 1 to remove any leading `#' in the name | |
3246 | (face-name (concat "vc-annotate-face-" | |
3247 | (if (string-equal | |
3248 | (substring (cdr color) 0 1) "#") | |
3249 | (substring (cdr color) 1) | |
3250 | (cdr color)))) | |
3251 | ;; Make the face if not done. | |
3252 | (face (or (intern-soft face-name) | |
3253 | (let ((tmp-face (make-face (intern face-name)))) | |
3254 | (set-face-foreground tmp-face (cdr color)) | |
b5446276 DN |
3255 | (when vc-annotate-background |
3256 | (set-face-background tmp-face | |
3257 | vc-annotate-background)) | |
7c33af85 SM |
3258 | tmp-face)))) ; Return the face |
3259 | (put-text-property start end 'face face))))) | |
3260 | ;; Pretend to font-lock there were no matches. | |
3261 | nil) | |
7d2d9482 | 3262 | \f |
594722a8 ER |
3263 | |
3264 | ;; Set up key bindings for use while editing log messages | |
3265 | ||
d7b60083 | 3266 | (defun vc-log-edit (fileset) |
928ef6d9 | 3267 | "Set up `log-edit' for use with VC on FILE." |
099bd78a | 3268 | (setq default-directory |
d7b60083 | 3269 | (with-current-buffer vc-parent-buffer default-directory)) |
93a142e1 DN |
3270 | (log-edit 'vc-finish-logentry |
3271 | nil | |
3272 | `((log-edit-listfun . (lambda () ',fileset)) | |
3273 | (log-edit-diff-function . (lambda () (vc-diff nil))))) | |
d7b60083 | 3274 | (set (make-local-variable 'vc-log-fileset) fileset) |
ac3f4c6f | 3275 | (make-local-variable 'vc-log-revision) |
099bd78a | 3276 | (set-buffer-modified-p nil) |
0e362f54 | 3277 | (setq buffer-file-name nil)) |
594722a8 | 3278 | |
b1ddeeb7 ER |
3279 | ;; These things should probably be generally available |
3280 | ||
3281 | (defun vc-file-tree-walk (dirname func &rest args) | |
3282 | "Walk recursively through DIRNAME. | |
3283 | Invoke FUNC f ARGS on each VC-managed file f underneath it." | |
3284 | (vc-file-tree-walk-internal (expand-file-name dirname) func args) | |
3285 | (message "Traversing directory %s...done" dirname)) | |
3286 | ||
3287 | (defun vc-file-tree-walk-internal (file func args) | |
3288 | (if (not (file-directory-p file)) | |
3289 | (when (vc-backend file) (apply func file args)) | |
3290 | (message "Traversing directory %s..." (abbreviate-file-name file)) | |
3291 | (let ((dir (file-name-as-directory file))) | |
3292 | (mapcar | |
3293 | (lambda (f) (or | |
3294 | (string-equal f ".") | |
3295 | (string-equal f "..") | |
3296 | (member f vc-directory-exclusion-list) | |
3297 | (let ((dirf (expand-file-name f dir))) | |
3298 | (or | |
3299 | (file-symlink-p dirf) ;; Avoid possible loops. | |
3300 | (vc-file-tree-walk-internal dirf func args))))) | |
3301 | (directory-files dir))))) | |
3302 | ||
594722a8 ER |
3303 | (provide 'vc) |
3304 | ||
ec402ad4 SM |
3305 | ;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE |
3306 | ;; | |
ec402ad4 SM |
3307 | ;; These may be useful to anyone who has to debug or extend the package. |
3308 | ;; (Note that this information corresponds to versions 5.x. Some of it | |
3309 | ;; might have been invalidated by the additions to support branching | |
3310 | ;; and RCS keyword lookup. AS, 1995/03/24) | |
3311 | ;; | |
3312 | ;; A fundamental problem in VC is that there are time windows between | |
3313 | ;; vc-next-action's computations of the file's version-control state and | |
3314 | ;; the actions that change it. This is a window open to lossage in a | |
3315 | ;; multi-user environment; someone else could nip in and change the state | |
3316 | ;; of the master during it. | |
3317 | ;; | |
3318 | ;; The performance problem is that rlog/prs calls are very expensive; we want | |
3319 | ;; to avoid them as much as possible. | |
3320 | ;; | |
3321 | ;; ANALYSIS: | |
3322 | ;; | |
3323 | ;; The performance problem, it turns out, simplifies in practice to the | |
3324 | ;; problem of making vc-state fast. The two other functions that call | |
3325 | ;; prs/rlog will not be so commonly used that the slowdown is a problem; one | |
3326 | ;; makes snapshots, the other deletes the calling user's last change in the | |
3327 | ;; master. | |
3328 | ;; | |
3329 | ;; The race condition implies that we have to either (a) lock the master | |
3330 | ;; during the entire execution of vc-next-action, or (b) detect and | |
3331 | ;; recover from errors resulting from dispatch on an out-of-date state. | |
3332 | ;; | |
3333 | ;; Alternative (a) appears to be infeasible. The problem is that we can't | |
3334 | ;; guarantee that the lock will ever be removed. Suppose a user starts a | |
3335 | ;; checkin, the change message buffer pops up, and the user, having wandered | |
3336 | ;; off to do something else, simply forgets about it? | |
3337 | ;; | |
3338 | ;; Alternative (b), on the other hand, works well with a cheap way to speed up | |
3339 | ;; vc-state. Usually, if a file is registered, we can read its locked/ | |
3340 | ;; unlocked state and its current owner from its permissions. | |
3341 | ;; | |
3342 | ;; This shortcut will fail if someone has manually changed the workfile's | |
3343 | ;; permissions; also if developers are munging the workfile in several | |
3344 | ;; directories, with symlinks to a master (in this latter case, the | |
3345 | ;; permissions shortcut will fail to detect a lock asserted from another | |
3346 | ;; directory). | |
3347 | ;; | |
3348 | ;; Note that these cases correspond exactly to the errors which could happen | |
3349 | ;; because of a competing checkin/checkout race in between two instances of | |
3350 | ;; vc-next-action. | |
3351 | ;; | |
3352 | ;; For VC's purposes, a workfile/master pair may have the following states: | |
3353 | ;; | |
3354 | ;; A. Unregistered. There is a workfile, there is no master. | |
3355 | ;; | |
3356 | ;; B. Registered and not locked by anyone. | |
3357 | ;; | |
3358 | ;; C. Locked by calling user and unchanged. | |
3359 | ;; | |
3360 | ;; D. Locked by the calling user and changed. | |
3361 | ;; | |
3362 | ;; E. Locked by someone other than the calling user. | |
3363 | ;; | |
3364 | ;; This makes for 25 states and 20 error conditions. Here's the matrix: | |
3365 | ;; | |
3366 | ;; VC's idea of state | |
3367 | ;; | | |
3368 | ;; V Actual state RCS action SCCS action Effect | |
3369 | ;; A B C D E | |
3370 | ;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin | |
3371 | ;; B 5 . 6 7 8 co -l get -e checkout | |
3372 | ;; C 9 10 . 11 12 co -u unget; get revert | |
3373 | ;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin | |
3374 | ;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock | |
3375 | ;; | |
3376 | ;; All commands take the master file name as a last argument (not shown). | |
3377 | ;; | |
3378 | ;; In the discussion below, a "self-race" is a pathological situation in | |
3379 | ;; which VC operations are being attempted simultaneously by two or more | |
3380 | ;; Emacsen running under the same username. | |
3381 | ;; | |
3382 | ;; The vc-next-action code has the following windows: | |
3383 | ;; | |
3384 | ;; Window P: | |
3385 | ;; Between the check for existence of a master file and the call to | |
3386 | ;; admin/checkin in vc-buffer-admin (apparent state A). This window may | |
3387 | ;; never close if the initial-comment feature is on. | |
3388 | ;; | |
3389 | ;; Window Q: | |
3390 | ;; Between the call to vc-workfile-unchanged-p in and the immediately | |
3391 | ;; following revert (apparent state C). | |
3392 | ;; | |
3393 | ;; Window R: | |
3394 | ;; Between the call to vc-workfile-unchanged-p in and the following | |
3395 | ;; checkin (apparent state D). This window may never close. | |
3396 | ;; | |
3397 | ;; Window S: | |
3398 | ;; Between the unlock and the immediately following checkout during a | |
3399 | ;; revert operation (apparent state C). Included in window Q. | |
3400 | ;; | |
3401 | ;; Window T: | |
3402 | ;; Between vc-state and the following checkout (apparent state B). | |
3403 | ;; | |
3404 | ;; Window U: | |
3405 | ;; Between vc-state and the following revert (apparent state C). | |
3406 | ;; Includes windows Q and S. | |
3407 | ;; | |
3408 | ;; Window V: | |
3409 | ;; Between vc-state and the following checkin (apparent state | |
3410 | ;; D). This window may never be closed if the user fails to complete the | |
3411 | ;; checkin message. Includes window R. | |
3412 | ;; | |
3413 | ;; Window W: | |
3414 | ;; Between vc-state and the following steal-lock (apparent | |
3415 | ;; state E). This window may never close if the user fails to complete | |
3416 | ;; the steal-lock message. Includes window X. | |
3417 | ;; | |
3418 | ;; Window X: | |
3419 | ;; Between the unlock and the immediately following re-lock during a | |
3420 | ;; steal-lock operation (apparent state E). This window may never close | |
3421 | ;; if the user fails to complete the steal-lock message. | |
3422 | ;; | |
3423 | ;; Errors: | |
3424 | ;; | |
3425 | ;; Apparent state A --- | |
3426 | ;; | |
3427 | ;; 1. File looked unregistered but is actually registered and not locked. | |
3428 | ;; | |
3429 | ;; Potential cause: someone else's admin during window P, with | |
3430 | ;; caller's admin happening before their checkout. | |
3431 | ;; | |
3432 | ;; RCS: Prior to version 5.6.4, ci fails with message | |
3433 | ;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new | |
3434 | ;; ci -i option and the message is "<file>,v: already exists". | |
3435 | ;; SCCS: admin will fail with error (ad19). | |
3436 | ;; | |
3437 | ;; We can let these errors be passed up to the user. | |
3438 | ;; | |
3439 | ;; 2. File looked unregistered but is actually locked by caller, unchanged. | |
3440 | ;; | |
3441 | ;; Potential cause: self-race during window P. | |
3442 | ;; | |
3443 | ;; RCS: Prior to version 5.6.4, reverts the file to the last saved | |
3444 | ;; version and unlocks it. From 5.6.4 onwards, VC uses the new | |
3445 | ;; ci -i option, failing with message "<file>,v: already exists". | |
3446 | ;; SCCS: will fail with error (ad19). | |
3447 | ;; | |
3448 | ;; Either of these consequences is acceptable. | |
3449 | ;; | |
3450 | ;; 3. File looked unregistered but is actually locked by caller, changed. | |
3451 | ;; | |
3452 | ;; Potential cause: self-race during window P. | |
3453 | ;; | |
3454 | ;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as | |
3455 | ;; a delta with a null change comment (the -t- switch will be | |
3456 | ;; ignored). From 5.6.4 onwards, VC uses the new ci -i option, | |
3457 | ;; failing with message "<file>,v: already exists". | |
3458 | ;; SCCS: will fail with error (ad19). | |
3459 | ;; | |
3460 | ;; 4. File looked unregistered but is locked by someone else. | |
0e362f54 | 3461 | ;;; |
ec402ad4 SM |
3462 | ;; Potential cause: someone else's admin during window P, with |
3463 | ;; caller's admin happening *after* their checkout. | |
3464 | ;; | |
3465 | ;; RCS: Prior to version 5.6.4, ci fails with a | |
3466 | ;; "no lock set by <user>" message. From 5.6.4 onwards, | |
3467 | ;; VC uses the new ci -i option, failing with message | |
3468 | ;; "<file>,v: already exists". | |
3469 | ;; SCCS: will fail with error (ad19). | |
3470 | ;; | |
3471 | ;; We can let these errors be passed up to the user. | |
3472 | ;; | |
3473 | ;; Apparent state B --- | |
3474 | ;; | |
3475 | ;; 5. File looked registered and not locked, but is actually unregistered. | |
3476 | ;; | |
3477 | ;; Potential cause: master file got nuked during window P. | |
3478 | ;; | |
3479 | ;; RCS: will fail with "RCS/<file>: No such file or directory" | |
3480 | ;; SCCS: will fail with error ut4. | |
3481 | ;; | |
3482 | ;; We can let these errors be passed up to the user. | |
3483 | ;; | |
3484 | ;; 6. File looked registered and not locked, but is actually locked by the | |
3485 | ;; calling user and unchanged. | |
3486 | ;; | |
3487 | ;; Potential cause: self-race during window T. | |
3488 | ;; | |
3489 | ;; RCS: in the same directory as the previous workfile, co -l will fail | |
3490 | ;; with "co error: writable foo exists; checkout aborted". In any other | |
3491 | ;; directory, checkout will succeed. | |
3492 | ;; SCCS: will fail with ge17. | |
3493 | ;; | |
3494 | ;; Either of these consequences is acceptable. | |
3495 | ;; | |
3496 | ;; 7. File looked registered and not locked, but is actually locked by the | |
3497 | ;; calling user and changed. | |
3498 | ;; | |
3499 | ;; As case 6. | |
3500 | ;; | |
3501 | ;; 8. File looked registered and not locked, but is actually locked by another | |
3502 | ;; user. | |
3503 | ;; | |
3504 | ;; Potential cause: someone else checks it out during window T. | |
3505 | ;; | |
3506 | ;; RCS: co error: revision 1.3 already locked by <user> | |
3507 | ;; SCCS: fails with ge4 (in directory) or ut7 (outside it). | |
3508 | ;; | |
3509 | ;; We can let these errors be passed up to the user. | |
3510 | ;; | |
3511 | ;; Apparent state C --- | |
3512 | ;; | |
3513 | ;; 9. File looks locked by calling user and unchanged, but is unregistered. | |
3514 | ;; | |
3515 | ;; As case 5. | |
3516 | ;; | |
3517 | ;; 10. File looks locked by calling user and unchanged, but is actually not | |
3518 | ;; locked. | |
3519 | ;; | |
3520 | ;; Potential cause: a self-race in window U, or by the revert's | |
3521 | ;; landing during window X of some other user's steal-lock or window S | |
3522 | ;; of another user's revert. | |
3523 | ;; | |
3524 | ;; RCS: succeeds, refreshing the file from the identical version in | |
3525 | ;; the master. | |
3526 | ;; SCCS: fails with error ut4 (p file nonexistent). | |
3527 | ;; | |
3528 | ;; Either of these consequences is acceptable. | |
3529 | ;; | |
3530 | ;; 11. File is locked by calling user. It looks unchanged, but is actually | |
3531 | ;; changed. | |
3532 | ;; | |
3533 | ;; Potential cause: the file would have to be touched by a self-race | |
3534 | ;; during window Q. | |
3535 | ;; | |
3536 | ;; The revert will succeed, removing whatever changes came with | |
3537 | ;; the touch. It is theoretically possible that work could be lost. | |
3538 | ;; | |
3539 | ;; 12. File looks like it's locked by the calling user and unchanged, but | |
3540 | ;; it's actually locked by someone else. | |
3541 | ;; | |
3542 | ;; Potential cause: a steal-lock in window V. | |
3543 | ;; | |
3544 | ;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u | |
3545 | ;; SCCS: fails with error un2 | |
3546 | ;; | |
3547 | ;; We can pass these errors up to the user. | |
3548 | ;; | |
3549 | ;; Apparent state D --- | |
3550 | ;; | |
3551 | ;; 13. File looks like it's locked by the calling user and changed, but it's | |
3552 | ;; actually unregistered. | |
3553 | ;; | |
3554 | ;; Potential cause: master file got nuked during window P. | |
3555 | ;; | |
3556 | ;; RCS: Prior to version 5.6.4, checks in the user's version as an | |
3557 | ;; initial delta. From 5.6.4 onwards, VC uses the new ci -j | |
3558 | ;; option, failing with message "no such file or directory". | |
3559 | ;; SCCS: will fail with error ut4. | |
3560 | ;; | |
3561 | ;; This case is kind of nasty. Under RCS prior to version 5.6.4, | |
3562 | ;; VC may fail to detect the loss of previous version information. | |
3563 | ;; | |
3564 | ;; 14. File looks like it's locked by the calling user and changed, but it's | |
3565 | ;; actually unlocked. | |
3566 | ;; | |
3567 | ;; Potential cause: self-race in window V, or the checkin happening | |
3568 | ;; during the window X of someone else's steal-lock or window S of | |
3569 | ;; someone else's revert. | |
3570 | ;; | |
3571 | ;; RCS: ci will fail with "no lock set by <user>". | |
3572 | ;; SCCS: delta will fail with error ut4. | |
3573 | ;; | |
3574 | ;; 15. File looks like it's locked by the calling user and changed, but it's | |
3575 | ;; actually locked by the calling user and unchanged. | |
3576 | ;; | |
3577 | ;; Potential cause: another self-race --- a whole checkin/checkout | |
3578 | ;; sequence by the calling user would have to land in window R. | |
3579 | ;; | |
3580 | ;; SCCS: checks in a redundant delta and leaves the file unlocked as usual. | |
3581 | ;; RCS: reverts to the file state as of the second user's checkin, leaving | |
3582 | ;; the file unlocked. | |
3583 | ;; | |
3584 | ;; It is theoretically possible that work could be lost under RCS. | |
3585 | ;; | |
3586 | ;; 16. File looks like it's locked by the calling user and changed, but it's | |
3587 | ;; actually locked by a different user. | |
3588 | ;; | |
3589 | ;; RCS: ci error: no lock set by <user> | |
3590 | ;; SCCS: unget will fail with error un2 | |
3591 | ;; | |
3592 | ;; We can pass these errors up to the user. | |
3593 | ;; | |
3594 | ;; Apparent state E --- | |
3595 | ;; | |
3596 | ;; 17. File looks like it's locked by some other user, but it's actually | |
3597 | ;; unregistered. | |
3598 | ;; | |
3599 | ;; As case 13. | |
3600 | ;; | |
3601 | ;; 18. File looks like it's locked by some other user, but it's actually | |
3602 | ;; unlocked. | |
3603 | ;; | |
3604 | ;; Potential cause: someone released a lock during window W. | |
3605 | ;; | |
3606 | ;; RCS: The calling user will get the lock on the file. | |
3607 | ;; SCCS: unget -n will fail with cm4. | |
3608 | ;; | |
3609 | ;; Either of these consequences will be OK. | |
3610 | ;; | |
3611 | ;; 19. File looks like it's locked by some other user, but it's actually | |
3612 | ;; locked by the calling user and unchanged. | |
3613 | ;; | |
3614 | ;; Potential cause: the other user relinquishing a lock followed by | |
3615 | ;; a self-race, both in window W. | |
3616 | ;; | |
3617 | ;; Under both RCS and SCCS, both unlock and lock will succeed, making | |
3618 | ;; the sequence a no-op. | |
3619 | ;; | |
3620 | ;; 20. File looks like it's locked by some other user, but it's actually | |
3621 | ;; locked by the calling user and changed. | |
3622 | ;; | |
3623 | ;; As case 19. | |
3624 | ;; | |
3625 | ;; PROBLEM CASES: | |
3626 | ;; | |
3627 | ;; In order of decreasing severity: | |
3628 | ;; | |
3629 | ;; Cases 11 and 15 are the only ones that potentially lose work. | |
3630 | ;; They would require a self-race for this to happen. | |
3631 | ;; | |
3632 | ;; Case 13 in RCS loses information about previous deltas, retaining | |
3633 | ;; only the information in the current workfile. This can only happen | |
3634 | ;; if the master file gets nuked in window P. | |
3635 | ;; | |
3636 | ;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with | |
3637 | ;; no change comment in the master. This would require a self-race in | |
3638 | ;; window P or R respectively. | |
3639 | ;; | |
3640 | ;; Cases 2, 10, 19 and 20 do extra work, but make no changes. | |
3641 | ;; | |
3642 | ;; Unfortunately, it appears to me that no recovery is possible in these | |
3643 | ;; cases. They don't yield error messages, so there's no way to tell that | |
3644 | ;; a race condition has occurred. | |
3645 | ;; | |
3646 | ;; All other cases don't change either the workfile or the master, and | |
3647 | ;; trigger command errors which the user will see. | |
3648 | ;; | |
3649 | ;; Thus, there is no explicit recovery code. | |
594722a8 | 3650 | |
0452b6e7 | 3651 | ;; arch-tag: ca82c1de-3091-4e26-af92-460abc6213a6 |
594722a8 | 3652 | ;;; vc.el ends here |