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 | ;; | |
370fded4 | 441 | ;; TAG SYSTEM |
fcb500ea | 442 | ;; |
370fded4 | 443 | ;; - create-tag (dir name branchp) |
fcb500ea | 444 | ;; |
370fded4 ER |
445 | ;; Attach the tag NAME to the state of the working copy. This |
446 | ;; should make sure that files are up-to-date before proceeding with | |
447 | ;; the action. DIR can also be a file and if BRANCHP is specified, | |
448 | ;; NAME should be created as a branch and DIR should be checked out | |
449 | ;; under this new branch. The default implementation does not | |
450 | ;; support branches but does a sanity check, a tree traversal and | |
451 | ;; assigns the tag to each file. | |
fcb500ea | 452 | ;; |
370fded4 | 453 | ;; - retrieve-tag (dir name update) |
fcb500ea | 454 | ;; |
370fded4 | 455 | ;; Retrieve the version tagged by NAME of all registered files at or below DIR. |
fcb500ea | 456 | ;; If UPDATE is non-nil, then update buffers of any files in the |
370fded4 | 457 | ;; tag that are currently visited. The default implementation |
fcb500ea AS |
458 | ;; does a sanity check whether there aren't any uncommitted changes at |
459 | ;; or below DIR, and then performs a tree walk, using the `checkout' | |
ac3f4c6f | 460 | ;; function to retrieve the corresponding revisions. |
fcb500ea AS |
461 | ;; |
462 | ;; MISCELLANEOUS | |
463 | ;; | |
f4263e47 TTN |
464 | ;; - root (dir) |
465 | ;; | |
466 | ;; Return DIR's "root" directory, that is, a parent directory of | |
467 | ;; DIR for which the same backend as used for DIR applies. If no | |
468 | ;; such parent exists, this function should return DIR. | |
469 | ;; | |
aae91380 | 470 | ;; - make-version-backups-p (file) |
fcb500ea | 471 | ;; |
ac3f4c6f | 472 | ;; Return non-nil if unmodified repository revisions of FILE should be |
fcb500ea AS |
473 | ;; backed up locally. If this is done, VC can perform `diff' and |
474 | ;; `revert' operations itself, without calling the backend system. The | |
475 | ;; default implementation always returns nil. | |
476 | ;; | |
a36319a4 SM |
477 | ;; - repository-hostname (dirname) |
478 | ;; | |
479 | ;; Return the hostname that the backend will have to contact | |
480 | ;; in order to operate on a file in DIRNAME. If the return value | |
0452b6e7 | 481 | ;; is nil, it means that the repository is local. |
a36319a4 SM |
482 | ;; This function is used in `vc-stay-local-p' which backends can use |
483 | ;; for their convenience. | |
484 | ;; | |
ac3f4c6f | 485 | ;; - previous-revision (file rev) |
869131a5 | 486 | ;; |
ac3f4c6f ER |
487 | ;; Return the revision number that precedes REV for FILE, or nil if no such |
488 | ;; revision exists. | |
1b5a7343 | 489 | ;; |
ac3f4c6f | 490 | ;; - next-revision (file rev) |
1b5a7343 | 491 | ;; |
ac3f4c6f ER |
492 | ;; Return the revision number that follows REV for FILE, or nil if no such |
493 | ;; revision exists. | |
869131a5 | 494 | ;; |
aae91380 | 495 | ;; - check-headers () |
fcb500ea AS |
496 | ;; |
497 | ;; Return non-nil if the current buffer contains any version headers. | |
498 | ;; | |
aae91380 | 499 | ;; - clear-headers () |
fcb500ea AS |
500 | ;; |
501 | ;; In the current buffer, reset all version headers to their unexpanded | |
502 | ;; form. This function should be provided if the state-querying code | |
503 | ;; for this backend uses the version headers to determine the state of | |
504 | ;; a file. This function will then be called whenever VC changes the | |
505 | ;; version control state in such a way that the headers would give | |
506 | ;; wrong information. | |
507 | ;; | |
a36319a4 SM |
508 | ;; - delete-file (file) |
509 | ;; | |
510 | ;; Delete FILE and mark it as deleted in the repository. If this | |
511 | ;; function is not provided, the command `vc-delete-file' will | |
512 | ;; signal an error. | |
513 | ;; | |
099bd78a | 514 | ;; - rename-file (old new) |
fcb500ea AS |
515 | ;; |
516 | ;; Rename file OLD to NEW, both in the working area and in the | |
a36319a4 SM |
517 | ;; repository. If this function is not provided, the renaming |
518 | ;; will be done by (vc-delete-file old) and (vc-register new). | |
86a65190 | 519 | ;; |
6e54fa53 SM |
520 | ;; - find-file-hook () |
521 | ;; | |
81c63b50 | 522 | ;; Operation called in current buffer when opening a file. This can |
6e54fa53 | 523 | ;; be used by the backend to setup some local variables it might need. |
cb223bba | 524 | ;; |
81c63b50 SM |
525 | ;; - find-file-not-found-hook () |
526 | ;; | |
527 | ;; Operation called in current buffer when opening a non-existing file. | |
528 | ;; By default, this asks the user if she wants to check out the file. | |
cb223bba DN |
529 | ;; |
530 | ;; - extra-menu () | |
531 | ;; | |
532 | ;; Return a menu keymap, the items in the keymap will appear at the | |
533 | ;; end of the Version Control menu. The goal is to allow backends | |
534 | ;; to specify extra menu items that appear in the VC menu. This way | |
535 | ;; you can provide menu entries for functionality that is specific | |
536 | ;; to your backend and which does not map to any of the VC generic | |
537 | ;; concepts. | |
6656ecaa DN |
538 | ;; |
539 | ;; - extra-status-menu () | |
540 | ;; | |
25a4ea6d DN |
541 | ;; Return a menu keymap, the items in the keymap will appear at the |
542 | ;; end of the VC Status menu. The goal is to allow backends to | |
543 | ;; specify extra menu items that appear in the VC Status menu. This | |
544 | ;; makes it possible to provide menu entries for functionality that | |
545 | ;; is specific to a backend and which does not map to any of the VC | |
546 | ;; generic concepts. | |
aae91380 | 547 | |
ba463d9e DN |
548 | ;;; Todo: |
549 | ||
ee91bfdf SM |
550 | ;; - Add key-binding for vc-delete-file. |
551 | ||
2e4f4469 ER |
552 | ;;;; New Primitives: |
553 | ;; | |
fc30d544 DN |
554 | ;; - deal with push/pull operations. |
555 | ;; | |
2e4f4469 ER |
556 | ;; - add a mechanism for editing the underlying VCS's list of files |
557 | ;; to be ignored, when that's possible. | |
fc30d544 | 558 | ;; |
84cb74cf DN |
559 | ;;;; Primitives that need changing: |
560 | ;; | |
561 | ;; - vc-update/vc-merge should deal with VC systems that don't | |
562 | ;; update/merge on a file basis, but on a whole repository basis. | |
563 | ;; vc-update and vc-merge assume the arguments are always files, | |
564 | ;; they don't deal with directories. Make sure the *vc-dir* buffer | |
565 | ;; is updated after these operations. | |
566 | ;; At least bzr, git and hg should benefit from this. | |
567 | ;; | |
2e4f4469 | 568 | ;;;; Improved branch and tag handling: |
7fbb4797 | 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 | ;; | |
370fded4 | 578 | ;; - vc-create-tag and vc-retrieve-tag should update the |
2e4f4469 ER |
579 | ;; buffers that might be visiting the affected files. |
580 | ;; | |
581 | ;;;; Default Behavior: | |
582 | ;; | |
583 | ;; - do not default to RCS anymore when the current directory is not | |
584 | ;; controlled by any VCS and the user does C-x v v | |
585 | ;; | |
586 | ;; - vc-responsible-backend should not return RCS if no backend | |
587 | ;; declares itself responsible. | |
588 | ;; | |
589 | ;;;; Internal cleanups: | |
590 | ;; | |
591 | ;; - backends that care about vc-stay-local should try to take it into | |
ee91bfdf | 592 | ;; account for vc-dir. Is this likely to be useful??? YES! |
2e4f4469 ER |
593 | ;; |
594 | ;; - vc-expand-dirs should take a backend parameter and only look for | |
595 | ;; files managed by that backend. | |
596 | ;; | |
597 | ;; - Another important thing: merge all the status-like backend operations. | |
598 | ;; We should remove dir-status, state, and dir-status-files, and | |
599 | ;; replace them with just `status' which takes a fileset and a continuation | |
600 | ;; (like dir-status) and returns a buffer in which the process(es) are run | |
601 | ;; (or nil if it worked synchronously). Hopefully we can define the old | |
602 | ;; 4 operations in term of this one. | |
603 | ;; | |
604 | ;;;; Other | |
605 | ;; | |
606 | ;; - when a file is in `conflict' state, turn on smerge-mode. | |
607 | ;; | |
608 | ;; - figure out what to do with conflicts that are not caused by the | |
609 | ;; file contents, but by metadata or other causes. Example: File A | |
610 | ;; gets renamed to B in one branch and to C in another and you merge | |
611 | ;; the two branches. Or you locally add file FOO and then pull a | |
612 | ;; change that also adds a new file FOO, ... | |
613 | ;; | |
30cd7dc2 DN |
614 | ;; - C-x v l should insert the file set in the *VC-log* buffer so that |
615 | ;; log-view can recognize it and use it for its commands. | |
616 | ;; | |
5a84a937 | 617 | ;; - vc-diff should be able to show the diff for all files in a |
7fbb4797 DN |
618 | ;; changeset, especially for VC systems that have per repository |
619 | ;; version numbers. log-view should take advantage of this. | |
5a84a937 | 620 | ;; |
fc30d544 DN |
621 | ;; - make it easier to write logs. Maybe C-x 4 a should add to the log |
622 | ;; buffer, if one is present, instead of adding to the ChangeLog. | |
ba463d9e | 623 | ;; |
5bd20ee6 DN |
624 | ;; - When vc-next-action calls vc-checkin it could pre-fill the |
625 | ;; *VC-log* buffer with some obvious items: the list of files that | |
626 | ;; were added, the list of files that were removed. If the diff is | |
627 | ;; available, maybe it could even call something like | |
628 | ;; `diff-add-change-log-entries-other-window' to create a detailed | |
629 | ;; skeleton for the log... | |
630 | ;; | |
e1aec6fb | 631 | ;; - most vc-dir backends need more work. They might need to |
7fbb4797 DN |
632 | ;; provide custom headers, use the `extra' field and deal with all |
633 | ;; possible VC states. | |
634 | ;; | |
8234f5be | 635 | ;; - add a function that calls vc-dir to `find-directory-functions'. |
d6f47dff | 636 | ;; |
d3201e0b DN |
637 | ;; - vc-diff, vc-annotate, etc. need to deal better with unregistered |
638 | ;; files. Now that unregistered and ignored files are shown in | |
4903369a | 639 | ;; vc-dir, it is possible that these commands are called |
d3201e0b DN |
640 | ;; for unregistered/ignored files. |
641 | ;; | |
a84615c7 SS |
642 | ;; - Using multiple backends needs work. Given a CVS directory with some |
643 | ;; files checked into git (but not all), using C-x v l to get a log file | |
644 | ;; from a file only present in git, and then typing RET on some log entry, | |
18a083fd ER |
645 | ;; vc will bombs out because it wants to see the file being in CVS. |
646 | ;; Those logs should likely use a local variable to hardware the VC they | |
647 | ;; are supposed to work with. | |
648 | ;; | |
30cd7dc2 DN |
649 | ;;;; Problems: |
650 | ;; | |
651 | ;; - log-view-diff does not work anymore in the case when the log was | |
652 | ;; created from more than one file. The error is: | |
653 | ;; vc-derived-from-dir-mode: Lisp nesting exceeds `max-lisp-eval-depth'. | |
654 | ;; | |
655 | ;; - the vc-dir display is now bogus for git and mercurial. | |
656 | ;; | |
657 | ;; - the CVS vc-dir display is now incorrect from some states. | |
658 | ;; | |
659 | ;; - vc-dir is now broken for RCS and SCCS. | |
660 | ;; | |
661 | ;; - the *vc-dir* buffer is not updated correctly anymore after VC | |
662 | ;; operations that change the file state. | |
663 | ;; | |
664 | ;; - the mouse3 menu for vc-dir does not have a title anymore. | |
665 | ;; | |
666 | ;; - the menu for the *vc-dir* buffer uses the wrong name now. | |
667 | ;; | |
fcb500ea | 668 | ;;; Code: |
0e362f54 | 669 | |
594722a8 | 670 | (require 'vc-hooks) |
92d1eebf | 671 | (require 'vc-dispatcher) |
64db3a90 | 672 | (require 'tool-bar) |
7fbb4797 | 673 | (require 'ewoc) |
64db3a90 | 674 | |
b1ddeeb7 | 675 | (eval-when-compile |
4f61cc3e | 676 | (require 'cl)) |
b1ddeeb7 | 677 | |
b5446276 DN |
678 | (unless (assoc 'vc-parent-buffer minor-mode-alist) |
679 | (setq minor-mode-alist | |
680 | (cons '(vc-parent-buffer vc-parent-buffer-name) | |
681 | minor-mode-alist))) | |
594722a8 ER |
682 | |
683 | ;; General customization | |
684 | ||
0101cc40 RS |
685 | (defgroup vc nil |
686 | "Version-control system in Emacs." | |
687 | :group 'tools) | |
688 | ||
0101cc40 | 689 | (defcustom vc-initial-comment nil |
04864eb0 | 690 | "If non-nil, prompt for initial comment when a file is registered." |
0101cc40 RS |
691 | :type 'boolean |
692 | :group 'vc) | |
693 | ||
ac3f4c6f ER |
694 | (defcustom vc-default-init-revision "1.1" |
695 | "A string used as the default revision number when a new file is registered. | |
b470cb65 AS |
696 | This can be overridden by giving a prefix argument to \\[vc-register]. This |
697 | can also be overridden by a particular VC backend." | |
0d53f466 | 698 | :type 'string |
cd32a7ba DN |
699 | :group 'vc |
700 | :version "20.3") | |
0d53f466 | 701 | |
0101cc40 | 702 | (defcustom vc-checkin-switches nil |
04864eb0 | 703 | "A string or list of strings specifying extra switches for checkin. |
0101cc40 RS |
704 | These are passed to the checkin program by \\[vc-checkin]." |
705 | :type '(choice (const :tag "None" nil) | |
706 | (string :tag "Argument String") | |
707 | (repeat :tag "Argument List" | |
708 | :value ("") | |
709 | string)) | |
710 | :group 'vc) | |
711 | ||
712 | (defcustom vc-checkout-switches nil | |
04864eb0 | 713 | "A string or list of strings specifying extra switches for checkout. |
0101cc40 RS |
714 | These are passed to the checkout program by \\[vc-checkout]." |
715 | :type '(choice (const :tag "None" nil) | |
716 | (string :tag "Argument String") | |
717 | (repeat :tag "Argument List" | |
718 | :value ("") | |
719 | string)) | |
720 | :group 'vc) | |
721 | ||
722 | (defcustom vc-register-switches nil | |
04864eb0 | 723 | "A string or list of strings; extra switches for registering a file. |
0101cc40 RS |
724 | These are passed to the checkin program by \\[vc-register]." |
725 | :type '(choice (const :tag "None" nil) | |
726 | (string :tag "Argument String") | |
727 | (repeat :tag "Argument List" | |
728 | :value ("") | |
729 | string)) | |
730 | :group 'vc) | |
731 | ||
acc5b122 | 732 | (defcustom vc-diff-switches nil |
04864eb0 | 733 | "A string or list of strings specifying switches for diff under VC. |
b453817c AS |
734 | When running diff under a given BACKEND, VC concatenates the values of |
735 | `diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to | |
736 | get the switches for that command. Thus, `vc-diff-switches' should | |
737 | contain switches that are specific to version control, but not | |
738 | specific to any particular backend." | |
acc5b122 AS |
739 | :type '(choice (const :tag "None" nil) |
740 | (string :tag "Argument String") | |
741 | (repeat :tag "Argument List" | |
742 | :value ("") | |
743 | string)) | |
744 | :group 'vc | |
745 | :version "21.1") | |
746 | ||
48033a08 AS |
747 | (defcustom vc-diff-knows-L nil |
748 | "*Indicates whether diff understands the -L option. | |
749 | The value is either `yes', `no', or nil. If it is nil, VC tries | |
750 | to use -L and sets this variable to remember whether it worked." | |
751 | :type '(choice (const :tag "Work out" nil) (const yes) (const no)) | |
752 | :group 'vc) | |
753 | ||
f1d1d46a | 754 | (defcustom vc-allow-async-revert nil |
e4d26892 | 755 | "Specifies whether the diff during \\[vc-revert] may be asynchronous. |
f1d1d46a AS |
756 | Enabling this option means that you can confirm a revert operation even |
757 | if the local changes in the file have not been found and displayed yet." | |
758 | :type '(choice (const :tag "No" nil) | |
759 | (const :tag "Yes" t)) | |
760 | :group 'vc | |
bf247b6e | 761 | :version "22.1") |
f1d1d46a | 762 | |
7cad930d AS |
763 | ;;;###autoload |
764 | (defcustom vc-checkout-hook nil | |
04864eb0 | 765 | "Normal hook (list of functions) run after checking out a file. |
7cad930d AS |
766 | See `run-hooks'." |
767 | :type 'hook | |
768 | :group 'vc | |
769 | :version "21.1") | |
770 | ||
da7c8a12 | 771 | (defcustom vc-annotate-display-mode 'fullscale |
6f1ecae4 | 772 | "Which mode to color the output of \\[vc-annotate] with by default." |
da7c8a12 | 773 | :type '(choice (const :tag "By Color Map Range" nil) |
75665141 AS |
774 | (const :tag "Scale to Oldest" scale) |
775 | (const :tag "Scale Oldest->Newest" fullscale) | |
776 | (number :tag "Specify Fractional Number of Days" | |
777 | :value "20.5")) | |
778 | :group 'vc) | |
779 | ||
0e362f54 GM |
780 | ;;;###autoload |
781 | (defcustom vc-checkin-hook nil | |
61de26cb | 782 | "Normal hook (list of functions) run after commit or file checkin. |
1cca5da4 | 783 | See also `log-edit-done-hook'." |
0e362f54 | 784 | :type 'hook |
1cca5da4 | 785 | :options '(log-edit-comment-to-change-log) |
0e362f54 GM |
786 | :group 'vc) |
787 | ||
788 | ;;;###autoload | |
789 | (defcustom vc-before-checkin-hook nil | |
61de26cb | 790 | "Normal hook (list of functions) run before a commit or a file checkin. |
0e362f54 GM |
791 | See `run-hooks'." |
792 | :type 'hook | |
793 | :group 'vc) | |
794 | ||
0e362f54 | 795 | ;; Annotate customization |
7d2d9482 | 796 | (defcustom vc-annotate-color-map |
da7c8a12 S |
797 | (if (and (tty-display-color-p) (<= (display-color-cells) 8)) |
798 | ;; A custom sorted TTY colormap | |
799 | (let* ((colors | |
800 | (sort | |
801 | (delq nil | |
802 | (mapcar (lambda (x) | |
803 | (if (not (or | |
804 | (string-equal (car x) "white") | |
805 | (string-equal (car x) "black") )) | |
806 | (car x))) | |
807 | (tty-color-alist))) | |
808 | (lambda (a b) | |
809 | (cond | |
810 | ((or (string-equal a "red") (string-equal b "blue")) t) | |
811 | ((or (string-equal b "red") (string-equal a "blue")) nil) | |
812 | ((string-equal a "yellow") t) | |
813 | ((string-equal b "yellow") nil) | |
814 | ((string-equal a "cyan") t) | |
815 | ((string-equal b "cyan") nil) | |
816 | ((string-equal a "green") t) | |
817 | ((string-equal b "green") nil) | |
818 | ((string-equal a "magenta") t) | |
819 | ((string-equal b "magenta") nil) | |
820 | (t (string< a b)))))) | |
821 | (date 20.) | |
822 | (delta (/ (- 360. date) (1- (length colors))))) | |
823 | (mapcar (lambda (x) | |
824 | (prog1 | |
825 | (cons date x) | |
826 | (setq date (+ date delta)))) colors)) | |
827 | ;; Normal colormap: hue stepped from 0-240deg, value=1., saturation=0.75 | |
828 | '(( 20. . "#FF3F3F") | |
829 | ( 40. . "#FF6C3F") | |
830 | ( 60. . "#FF993F") | |
831 | ( 80. . "#FFC63F") | |
832 | (100. . "#FFF33F") | |
833 | (120. . "#DDFF3F") | |
834 | (140. . "#B0FF3F") | |
835 | (160. . "#83FF3F") | |
836 | (180. . "#56FF3F") | |
837 | (200. . "#3FFF56") | |
838 | (220. . "#3FFF83") | |
839 | (240. . "#3FFFB0") | |
840 | (260. . "#3FFFDD") | |
841 | (280. . "#3FF3FF") | |
842 | (300. . "#3FC6FF") | |
843 | (320. . "#3F99FF") | |
844 | (340. . "#3F6CFF") | |
845 | (360. . "#3F3FFF"))) | |
04864eb0 | 846 | "Association list of age versus color, for \\[vc-annotate]. |
da7c8a12 S |
847 | Ages are given in units of fractional days. Default is eighteen |
848 | steps using a twenty day increment, from red to blue. For TTY | |
849 | displays with 8 or fewer colors, the default is red to blue with | |
850 | all other colors between (excluding black and white)." | |
0e362f54 | 851 | :type 'alist |
7d2d9482 RS |
852 | :group 'vc) |
853 | ||
da7c8a12 | 854 | (defcustom vc-annotate-very-old-color "#3F3FFF" |
04864eb0 | 855 | "Color for lines older than the current color range in \\[vc-annotate]]." |
7d2d9482 RS |
856 | :type 'string |
857 | :group 'vc) | |
858 | ||
859 | (defcustom vc-annotate-background "black" | |
04864eb0 | 860 | "Background color for \\[vc-annotate]. |
7d2d9482 | 861 | Default color is used if nil." |
14b7a0b5 | 862 | :type '(choice (const :tag "Default background" nil) (color)) |
7d2d9482 RS |
863 | :group 'vc) |
864 | ||
865 | (defcustom vc-annotate-menu-elements '(2 0.5 0.1 0.01) | |
04864eb0 | 866 | "Menu elements for the mode-specific menu of VC-Annotate mode. |
7d2d9482 | 867 | List of factors, used to expand/compress the time scale. See `vc-annotate'." |
0e362f54 | 868 | :type '(repeat number) |
7d2d9482 RS |
869 | :group 'vc) |
870 | ||
0e362f54 GM |
871 | (defvar vc-annotate-mode-map |
872 | (let ((m (make-sparse-keymap))) | |
04864eb0 SM |
873 | (define-key m "A" 'vc-annotate-revision-previous-to-line) |
874 | (define-key m "D" 'vc-annotate-show-diff-revision-at-line) | |
f3ff0fe9 | 875 | (define-key m "f" 'vc-annotate-find-revision-at-line) |
04864eb0 SM |
876 | (define-key m "J" 'vc-annotate-revision-at-line) |
877 | (define-key m "L" 'vc-annotate-show-log-revision-at-line) | |
ac3f4c6f ER |
878 | (define-key m "N" 'vc-annotate-next-revision) |
879 | (define-key m "P" 'vc-annotate-prev-revision) | |
880 | (define-key m "W" 'vc-annotate-working-revision) | |
5731a8e0 | 881 | (define-key m "V" 'vc-annotate-toggle-annotation-visibility) |
0e362f54 GM |
882 | m) |
883 | "Local keymap used for VC-Annotate mode.") | |
67242a23 | 884 | |
594722a8 ER |
885 | ;; Header-insertion hair |
886 | ||
0101cc40 | 887 | (defcustom vc-static-header-alist |
04864eb0 | 888 | '(("\\.c\\'" . |
594722a8 | 889 | "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n")) |
0e362f54 GM |
890 | "*Associate static header string templates with file types. |
891 | A \%s in the template is replaced with the first string associated with | |
099bd78a | 892 | the file's version control type in `vc-header-alist'." |
0101cc40 RS |
893 | :type '(repeat (cons :format "%v" |
894 | (regexp :tag "File Type") | |
895 | (string :tag "Header String"))) | |
896 | :group 'vc) | |
7b4f934d | 897 | |
0101cc40 | 898 | (defcustom vc-comment-alist |
594722a8 | 899 | '((nroff-mode ".\\\"" "")) |
6f1ecae4 | 900 | "*Special comment delimiters for generating VC headers. |
099bd78a SM |
901 | Add an entry in this list if you need to override the normal `comment-start' |
902 | and `comment-end' variables. This will only be necessary if the mode language | |
0101cc40 RS |
903 | is sensitive to blank lines." |
904 | :type '(repeat (list :format "%v" | |
905 | (symbol :tag "Mode") | |
906 | (string :tag "Comment Start") | |
907 | (string :tag "Comment End"))) | |
908 | :group 'vc) | |
594722a8 | 909 | |
0101cc40 | 910 | (defcustom vc-checkout-carefully (= (user-uid) 0) |
bf142f28 | 911 | "*Non-nil means be extra-careful in checkout. |
bbf97570 | 912 | Verify that the file really is not locked |
0101cc40 RS |
913 | and that its contents match what the master file says." |
914 | :type 'boolean | |
915 | :group 'vc) | |
bf142f28 JB |
916 | (make-obsolete-variable 'vc-checkout-carefully |
917 | "the corresponding checks are always done now." | |
918 | "21.1") | |
bbf97570 | 919 | |
0e362f54 | 920 | \f |
83affd96 | 921 | ;; Variables users don't need to see |
594722a8 | 922 | |
f1d1d46a AS |
923 | (defvar vc-disable-async-diff nil |
924 | "VC sets this to t locally to disable some async diff operations. | |
925 | Backends that offer asynchronous diffs should respect this variable | |
926 | in their implementation of vc-BACKEND-diff.") | |
927 | ||
594722a8 ER |
928 | ;; File property caching |
929 | ||
8c0aaf40 | 930 | (defun vc-clear-context () |
11cdd167 | 931 | "Clear all cached file properties." |
8c0aaf40 | 932 | (interactive) |
11cdd167 | 933 | (fillarray vc-file-prop-obarray 0)) |
8c0aaf40 | 934 | |
d7b60083 ER |
935 | (defmacro with-vc-properties (files form settings) |
936 | "Execute FORM, then maybe set per-file properties for FILES. | |
6f1ecae4 AS |
937 | SETTINGS is an association list of property/value pairs. After |
938 | executing FORM, set those properties from SETTINGS that have not yet | |
939 | been updated to their corresponding values." | |
b4e4e3a8 | 940 | (declare (debug t)) |
169f0cae | 941 | `(let ((vc-touched-properties (list t))) |
099bd78a | 942 | ,form |
d7b60083 | 943 | (dolist (file ,files) |
a7192ddb SM |
944 | (dolist (setting ,settings) |
945 | (let ((property (car setting))) | |
946 | (unless (memq property vc-touched-properties) | |
947 | (put (intern file vc-file-prop-obarray) | |
948 | property (cdr setting)))))))) | |
099bd78a | 949 | |
d7b60083 ER |
950 | ;;; Code for deducing what fileset and backend to assume |
951 | ||
2765044b DN |
952 | (defun vc-responsible-backend (file &optional register) |
953 | "Return the name of a backend system that is responsible for FILE. | |
954 | The optional argument REGISTER means that a backend suitable for | |
955 | registration should be found. | |
956 | ||
957 | If REGISTER is nil, then if FILE is already registered, return the | |
958 | backend of FILE. If FILE is not registered, or a directory, then the | |
959 | first backend in `vc-handled-backends' that declares itself | |
960 | responsible for FILE is returned. If no backend declares itself | |
961 | responsible, return the first backend. | |
962 | ||
963 | If REGISTER is non-nil, return the first responsible backend under | |
964 | which FILE is not yet registered. If there is no such backend, return | |
965 | the first backend under which FILE is not yet registered, but could | |
966 | be registered." | |
b5446276 DN |
967 | (when (not vc-handled-backends) |
968 | (error "No handled backends")) | |
2765044b DN |
969 | (or (and (not (file-directory-p file)) (not register) (vc-backend file)) |
970 | (catch 'found | |
971 | ;; First try: find a responsible backend. If this is for registration, | |
972 | ;; it must be a backend under which FILE is not yet registered. | |
973 | (dolist (backend vc-handled-backends) | |
974 | (and (or (not register) | |
975 | (not (vc-call-backend backend 'registered file))) | |
976 | (vc-call-backend backend 'responsible-p file) | |
977 | (throw 'found backend))) | |
978 | ;; no responsible backend | |
979 | (if (not register) | |
980 | ;; if this is not for registration, the first backend must do | |
981 | (car vc-handled-backends) | |
982 | ;; for registration, we need to find a new backend that | |
983 | ;; could register FILE | |
984 | (dolist (backend vc-handled-backends) | |
985 | (and (not (vc-call-backend backend 'registered file)) | |
986 | (vc-call-backend backend 'could-register file) | |
987 | (throw 'found backend))) | |
988 | (error "No backend that could register"))))) | |
989 | ||
990 | (defun vc-expand-dirs (file-or-dir-list) | |
991 | "Expands directories in a file list specification. | |
77c5055c | 992 | Within directories, only files already under version control are noticed." |
2765044b DN |
993 | (let ((flattened '())) |
994 | (dolist (node file-or-dir-list) | |
77c5055c ER |
995 | (if (file-directory-p node) |
996 | (vc-file-tree-walk | |
997 | node (lambda (f) (when (vc-backend f) (push f flattened))))) | |
998 | (push node flattened)) | |
2765044b DN |
999 | (nreverse flattened))) |
1000 | ||
192350af ER |
1001 | (defun vc-derived-from-dir-mode (&optional buffer) |
1002 | "Are we in a VC-directory buffer, or do we have one as an ancestor?" | |
1003 | (let ((buffer (or buffer (current-buffer)))) | |
1004 | (cond ((derived-mode-p 'vc-dir-mode) t) | |
1005 | (vc-parent-buffer (vc-derived-from-dir-mode vc-parent-buffer)) | |
1006 | (t nil)))) | |
1007 | ||
cb5d44b6 | 1008 | (defun vc-deduce-fileset (&optional observer) |
86048828 | 1009 | "Deduce a set of files and a backend to which to apply an operation and |
734abae3 | 1010 | the common state of the fileset. Return (BACKEND . FILESET)." |
6986e5c9 ER |
1011 | (let* ((selection (vc-dispatcher-selection-set observer)) |
1012 | (raw (car selection)) ;; Selection as user made it | |
1013 | (cooked (cdr selection)) ;; Files only | |
734abae3 | 1014 | ;; FIXME: Store the backend in a buffer-local variable. |
192350af | 1015 | (backend (if (vc-derived-from-dir-mode (current-buffer)) |
30cd7dc2 DN |
1016 | ;; FIXME: this should use vc-dir-backend from |
1017 | ;; the *vc-dir* buffer. | |
734abae3 | 1018 | (vc-responsible-backend default-directory) |
6986e5c9 ER |
1019 | (assert (and (= 1 (length raw)) |
1020 | (not (file-directory-p (car raw))))) | |
1021 | (vc-backend (car cooked))))) | |
1022 | (cons backend selection))) | |
d7b60083 | 1023 | |
2765044b DN |
1024 | (defun vc-ensure-vc-buffer () |
1025 | "Make sure that the current buffer visits a version-controlled file." | |
ca8dfeda | 1026 | (cond |
4903369a | 1027 | ((vc-dispatcher-browsing) |
e1aec6fb | 1028 | (set-buffer (find-file-noselect (vc-dir-current-file)))) |
ca8dfeda | 1029 | (t |
772111be | 1030 | (while (and vc-parent-buffer |
cc72026b | 1031 | (buffer-live-p vc-parent-buffer) |
772111be MR |
1032 | ;; Avoid infinite looping when vc-parent-buffer and |
1033 | ;; current buffer are the same buffer. | |
1034 | (not (eq vc-parent-buffer (current-buffer)))) | |
2765044b DN |
1035 | (set-buffer vc-parent-buffer)) |
1036 | (if (not buffer-file-name) | |
1037 | (error "Buffer %s is not associated with a file" (buffer-name)) | |
b5446276 DN |
1038 | (unless (vc-backend buffer-file-name) |
1039 | (error "File %s is not under version control" buffer-file-name)))))) | |
2765044b | 1040 | |
e0607aaa SM |
1041 | ;;; Support for the C-x v v command. |
1042 | ;; This is where all the single-file-oriented code from before the fileset | |
1043 | ;; rewrite lives. | |
61de26cb | 1044 | |
2765044b DN |
1045 | (defsubst vc-editable-p (file) |
1046 | "Return non-nil if FILE can be edited." | |
e0607aaa SM |
1047 | (let ((backend (vc-backend file))) |
1048 | (and backend | |
70e2f6c7 | 1049 | (or (eq (vc-checkout-model backend (list file)) 'implicit) |
e0607aaa | 1050 | (memq (vc-state file) '(edited needs-merge conflict)))))) |
2765044b | 1051 | |
484c1b1f ER |
1052 | (defun vc-compatible-state (p q) |
1053 | "Controls which states can be in the same commit." | |
1054 | (or | |
1055 | (eq p q) | |
1056 | (and (member p '(edited added removed)) (member q '(edited added removed))))) | |
1057 | ||
2765044b DN |
1058 | ;; Here's the major entry point. |
1059 | ||
1060 | ;;;###autoload | |
1061 | (defun vc-next-action (verbose) | |
d7b60083 ER |
1062 | "Do the next logical version control operation on the current fileset. |
1063 | This requires that all files in the fileset be in the same state. | |
2765044b | 1064 | |
d7b60083 ER |
1065 | For locking systems: |
1066 | If every file is not already registered, this registers each for version | |
2765044b | 1067 | control. |
d7b60083 ER |
1068 | If every file is registered and not locked by anyone, this checks out |
1069 | a writable and locked file of each ready for editing. | |
1070 | If every file is checked out and locked by the calling user, this | |
1071 | first checks to see if each file has changed since checkout. If not, | |
1072 | it performs a revert on that file. | |
1073 | If every file has been changed, this pops up a buffer for entry | |
2765044b DN |
1074 | of a log message; when the message has been entered, it checks in the |
1075 | resulting changes along with the log message as change commentary. If | |
1076 | the variable `vc-keep-workfiles' is non-nil (which is its default), a | |
d7b60083 ER |
1077 | read-only copy of each changed file is left in place afterwards. |
1078 | If the affected file is registered and locked by someone else, you are | |
1079 | given the option to steal the lock(s). | |
1080 | ||
1081 | For merging systems: | |
1082 | If every file is not already registered, this registers each one for version | |
1083 | control. This does an add, but not a commit. | |
1084 | If every file is added but not committed, each one is committed. | |
1085 | If every working file is changed, but the corresponding repository file is | |
2765044b DN |
1086 | unchanged, this pops up a buffer for entry of a log message; when the |
1087 | message has been entered, it checks in the resulting changes along | |
1088 | with the logmessage as change commentary. A writable file is retained. | |
1089 | If the repository file is changed, you are asked if you want to | |
1090 | merge in the changes into your working copy." | |
2765044b | 1091 | (interactive "P") |
86048828 | 1092 | (let* ((vc-fileset (vc-deduce-fileset)) |
e0607aaa | 1093 | (backend (car vc-fileset)) |
6986e5c9 ER |
1094 | (files (cadr vc-fileset)) |
1095 | (fileset-only-files (cddr vc-fileset)) | |
ee5657de | 1096 | ;; FIXME: We used to call `vc-recompute-state' here. |
734abae3 SM |
1097 | (state (vc-state (car fileset-only-files))) |
1098 | ;; The backend should check that the checkout-model is consistent | |
1099 | ;; among all the `files'. | |
e0607aaa | 1100 | (model (vc-checkout-model backend files)) |
ac3f4c6f | 1101 | revision) |
734abae3 SM |
1102 | |
1103 | ;; Check that all files are in a consistent state, since we use that | |
1104 | ;; state to decide which operation to perform. | |
1105 | (dolist (file (cdr fileset-only-files)) | |
1106 | (unless (vc-compatible-state (vc-state file) state) | |
1107 | (error "%s:%s clashes with %s:%s" | |
1108 | file (vc-state file) (car fileset-only-files) state))) | |
1109 | ||
0e362f54 | 1110 | ;; Do the right thing |
a7192ddb | 1111 | (cond |
3c73c30e ER |
1112 | ((eq state 'missing) |
1113 | (error "Fileset files are missing, so cannot be operated on.")) | |
86048828 ER |
1114 | ((eq state 'ignored) |
1115 | (error "Fileset files are ignored by the version-control system.")) | |
1116 | ((eq state 'unregistered) | |
80296236 | 1117 | (mapc (lambda (arg) (vc-register nil arg)) files)) |
ac3f4c6f | 1118 | ;; Files are up-to-date, or need a merge and user specified a revision |
3702367b | 1119 | ((or (eq state 'up-to-date) (and verbose (eq state 'needs-update))) |
0e362f54 | 1120 | (cond |
d7b60083 | 1121 | (verbose |
ac3f4c6f ER |
1122 | ;; go to a different revision |
1123 | (setq revision (read-string "Branch, revision, or backend to move to: ")) | |
1124 | (let ((vsym (intern-soft (upcase revision)))) | |
d7b60083 | 1125 | (if (member vsym vc-handled-backends) |
a7192ddb SM |
1126 | (dolist (file files) (vc-transfer-file file vsym)) |
1127 | (dolist (file files) | |
1128 | (vc-checkout file (eq model 'implicit) revision))))) | |
d7b60083 ER |
1129 | ((not (eq model 'implicit)) |
1130 | ;; check the files out | |
a7192ddb | 1131 | (dolist (file files) (vc-checkout file t))) |
d7b60083 | 1132 | (t |
a7192ddb SM |
1133 | ;; do nothing |
1134 | (message "Fileset is up-to-date")))) | |
1135 | ;; Files have local changes | |
484c1b1f | 1136 | ((vc-compatible-state state 'edited) |
d7b60083 ER |
1137 | (let ((ready-for-commit files)) |
1138 | ;; If files are edited but read-only, give user a chance to correct | |
1139 | (dolist (file files) | |
e166638d DN |
1140 | (unless (file-writable-p file) |
1141 | ;; Make the file+buffer read-write. | |
1142 | (unless (y-or-n-p (format "%s is edited but read-only; make it writable and continue?" file)) | |
1143 | (error "Aborted")) | |
1144 | (set-file-modes file (logior (file-modes file) 128)) | |
1145 | (let ((visited (get-file-buffer file))) | |
1146 | (when visited | |
1147 | (with-current-buffer visited | |
1148 | (toggle-read-only -1)))))) | |
d7b60083 ER |
1149 | ;; Allow user to revert files with no changes |
1150 | (save-excursion | |
a7192ddb SM |
1151 | (dolist (file files) |
1152 | (let ((visited (get-file-buffer file))) | |
1153 | ;; For files with locking, if the file does not contain | |
1154 | ;; any changes, just let go of the lock, i.e. revert. | |
e166638d DN |
1155 | (when (and (not (eq model 'implicit)) |
1156 | (vc-workfile-unchanged-p file) | |
1157 | ;; If buffer is modified, that means the user just | |
1158 | ;; said no to saving it; in that case, don't revert, | |
1159 | ;; because the user might intend to save after | |
1160 | ;; finishing the log entry and committing. | |
1161 | (not (and visited (buffer-modified-p)))) | |
1162 | (vc-revert-file file) | |
1163 | (delete file ready-for-commit))))) | |
d7b60083 ER |
1164 | ;; Remaining files need to be committed |
1165 | (if (not ready-for-commit) | |
1166 | (message "No files remain to be committed") | |
1d502d5a | 1167 | (if (not verbose) |
d7b60083 ER |
1168 | (vc-checkin ready-for-commit) |
1169 | (progn | |
ac3f4c6f ER |
1170 | (setq revision (read-string "New revision or backend: ")) |
1171 | (let ((vsym (intern (upcase revision)))) | |
d7b60083 | 1172 | (if (member vsym vc-handled-backends) |
d36122a2 | 1173 | (dolist (file files) (vc-transfer-file file vsym)) |
ac3f4c6f | 1174 | (vc-checkin ready-for-commit revision)))))))) |
d7b60083 ER |
1175 | ;; locked by somebody else (locking VCSes only) |
1176 | ((stringp state) | |
d36122a2 TTN |
1177 | ;; In the old days, we computed the revision once and used it on |
1178 | ;; the single file. Then, for the 2007-2008 fileset rewrite, we | |
1179 | ;; computed the revision once (incorrectly, using a free var) and | |
1180 | ;; used it on all files. To fix the free var bug, we can either | |
1181 | ;; use `(car files)' or do what we do here: distribute the | |
1182 | ;; revision computation among `files'. Although this may be | |
1183 | ;; tedious for those backends where a "revision" is a trans-file | |
1184 | ;; concept, it is nonetheless correct for both those and (more | |
1185 | ;; importantly) for those where "revision" is a per-file concept. | |
1186 | ;; If the intersection of the former group and "locking VCSes" is | |
1187 | ;; non-empty [I vaguely doubt it --ttn], we can reinstate the | |
1188 | ;; pre-computation approach of yore. | |
1189 | (dolist (file files) | |
1190 | (vc-steal-lock | |
1191 | file (if verbose | |
1192 | (read-string (format "%s revision to steal: " file)) | |
1193 | (vc-working-revision file)) | |
1194 | state))) | |
7fbb4797 DN |
1195 | ;; conflict |
1196 | ((eq state 'conflict) | |
a749e19d SM |
1197 | ;; FIXME: Is it really the UI we want to provide? |
1198 | ;; In my experience, the conflicted files should be marked as resolved | |
1199 | ;; one-by-one when saving the file after resolving the conflicts. | |
1200 | ;; I.e. stating explicitly that the conflicts are resolved is done | |
1201 | ;; very rarely. | |
1202 | (vc-mark-resolved backend files)) | |
3702367b ER |
1203 | ;; needs-update |
1204 | ((eq state 'needs-update) | |
d7b60083 | 1205 | (dolist (file files) |
6f41eeb5 | 1206 | (if (yes-or-no-p (format |
ac3f4c6f | 1207 | "%s is not up-to-date. Get latest revision? " |
0e362f54 | 1208 | (file-name-nondirectory file))) |
d7b60083 | 1209 | (vc-checkout file (eq model 'implicit) t) |
e166638d DN |
1210 | (when (and (not (eq model 'implicit)) |
1211 | (yes-or-no-p "Lock this revision? ")) | |
1212 | (vc-checkout file t))))) | |
d7b60083 ER |
1213 | ;; needs-merge |
1214 | ((eq state 'needs-merge) | |
1215 | (dolist (file files) | |
e166638d | 1216 | (when (yes-or-no-p (format |
0e362f54 GM |
1217 | "%s is not up-to-date. Merge in changes now? " |
1218 | (file-name-nondirectory file))) | |
a749e19d SM |
1219 | (vc-maybe-resolve-conflicts |
1220 | file (vc-call-backend backend 'merge-news file))))) | |
46e33aee | 1221 | |
d7b60083 ER |
1222 | ;; unlocked-changes |
1223 | ((eq state 'unlocked-changes) | |
1224 | (dolist (file files) | |
b5446276 DN |
1225 | (when (not (equal buffer-file-name file)) |
1226 | (find-file-other-window file)) | |
0e362f54 | 1227 | (if (save-window-excursion |
86048828 ER |
1228 | (vc-diff-internal nil |
1229 | (cons (car vc-fileset) (cons (cadr vc-fileset) (list file))) | |
ae67f2d0 | 1230 | (vc-working-revision file) nil) |
0e362f54 | 1231 | (goto-char (point-min)) |
ceec5a0c | 1232 | (let ((inhibit-read-only t)) |
f4f34b33 | 1233 | (insert |
ceec5a0c | 1234 | (format "Changes to %s since last lock:\n\n" file))) |
0e362f54 GM |
1235 | (not (beep)) |
1236 | (yes-or-no-p (concat "File has unlocked changes. " | |
1237 | "Claim lock retaining changes? "))) | |
a749e19d | 1238 | (progn (vc-call-backend backend 'steal-lock file) |
61de26cb | 1239 | (clear-visited-file-modtime) |
0e362f54 GM |
1240 | ;; Must clear any headers here because they wouldn't |
1241 | ;; show that the file is locked now. | |
1242 | (vc-clear-headers file) | |
a36319a4 | 1243 | (write-file buffer-file-name) |
0e362f54 GM |
1244 | (vc-mode-line file)) |
1245 | (if (not (yes-or-no-p | |
ac3f4c6f | 1246 | "Revert to checked-in revision, instead? ")) |
0e362f54 | 1247 | (error "Checkout aborted") |
61de26cb | 1248 | (vc-revert-buffer-internal t t) |
3702367b ER |
1249 | (vc-checkout file t))))) |
1250 | ;; Unknown fileset state | |
1251 | (t | |
1252 | (error "Fileset is in an unknown state %s" state))))) | |
e1f297e6 | 1253 | |
61de26cb ER |
1254 | (defun vc-create-repo (backend) |
1255 | "Create an empty repository in the current directory." | |
1256 | (interactive | |
1257 | (list | |
1258 | (intern | |
1259 | (upcase | |
1260 | (completing-read | |
1261 | "Create repository for: " | |
1262 | (mapcar (lambda (b) (list (downcase (symbol-name b)))) vc-handled-backends) | |
1263 | nil t))))) | |
1264 | (vc-call-backend backend 'create-repo)) | |
1265 | ||
637a8ae9 | 1266 | ;;;###autoload |
80296236 | 1267 | (defun vc-register (&optional set-revision fname comment) |
30a308aa DN |
1268 | "Register into a version control system. |
1269 | If FNAME is given register that file, otherwise register the current file. | |
ac3f4c6f | 1270 | With prefix argument SET-REVISION, allow user to specify initial revision |
2765044b | 1271 | level. If COMMENT is present, use that as an initial comment. |
0e362f54 | 1272 | |
2765044b DN |
1273 | The version control system to use is found by cycling through the list |
1274 | `vc-handled-backends'. The first backend in that list which declares | |
1275 | itself responsible for the file (usually because other files in that | |
1276 | directory are already registered under that backend) will be used to | |
1277 | register the file. If no backend declares itself responsible, the | |
1278 | first backend that could register the file is used." | |
1279 | (interactive "P") | |
30a308aa DN |
1280 | (when (and (null fname) (null buffer-file-name)) (error "No visited file")) |
1281 | ||
5f01100a | 1282 | (let ((bname (if fname (get-file-buffer fname) (current-buffer)))) |
30a308aa DN |
1283 | (unless fname (setq fname buffer-file-name)) |
1284 | (when (vc-backend fname) | |
1285 | (if (vc-registered fname) | |
1286 | (error "This file is already registered") | |
1287 | (unless (y-or-n-p "Previous master file has vanished. Make a new one? ") | |
1288 | (error "Aborted")))) | |
1289 | ;; Watch out for new buffers of size 0: the corresponding file | |
1290 | ;; does not exist yet, even though buffer-modified-p is nil. | |
1291 | (when bname | |
1292 | (with-current-buffer bname | |
b5446276 | 1293 | (when (and (not (buffer-modified-p)) |
30a308aa DN |
1294 | (zerop (buffer-size)) |
1295 | (not (file-exists-p buffer-file-name))) | |
b5446276 | 1296 | (set-buffer-modified-p t)) |
30a308aa | 1297 | (vc-buffer-sync))) |
83affd96 | 1298 | (vc-start-logentry (list fname) |
30a308aa DN |
1299 | (if set-revision |
1300 | (read-string (format "Initial revision level for %s: " | |
1301 | fname)) | |
1302 | (vc-call-backend (vc-responsible-backend fname) | |
1303 | 'init-revision)) | |
1304 | (or comment (not vc-initial-comment)) | |
1305 | nil | |
1306 | "Enter initial comment." | |
400aec1a | 1307 | "*VC-log*" |
30a308aa DN |
1308 | (lambda (files rev comment) |
1309 | (dolist (file files) | |
1310 | (message "Registering %s... " file) | |
1311 | (let ((backend (vc-responsible-backend file t))) | |
1312 | (vc-file-clearprops file) | |
1313 | (vc-call-backend backend 'register (list file) rev comment) | |
1314 | (vc-file-setprop file 'vc-backend backend) | |
1315 | (unless vc-make-backup-files | |
1316 | (make-local-variable 'backup-inhibited) | |
1317 | (setq backup-inhibited t))) | |
1318 | (message "Registering %s... done" file)))))) | |
d7b60083 ER |
1319 | |
1320 | (defun vc-register-with (backend) | |
1321 | "Register the current file with a specified back end." | |
1322 | (interactive "SBackend: ") | |
b5446276 DN |
1323 | (when (not (member backend vc-handled-backends)) |
1324 | (error "Unknown back end.")) | |
d7b60083 ER |
1325 | (let ((vc-handled-backends (list backend))) |
1326 | (call-interactively 'vc-register))) | |
8989ab56 | 1327 | |
c6d4f628 | 1328 | (defun vc-checkout (file &optional writable rev) |
099bd78a SM |
1329 | "Retrieve a copy of the revision REV of FILE. |
1330 | If WRITABLE is non-nil, make sure the retrieved file is writable. | |
133a84aa AS |
1331 | REV defaults to the latest revision. |
1332 | ||
1333 | After check-out, runs the normal hook `vc-checkout-hook'." | |
ffda0460 AS |
1334 | (and writable |
1335 | (not rev) | |
10b48cc4 | 1336 | (vc-call make-version-backups-p file) |
ffda0460 | 1337 | (vc-up-to-date-p file) |
10b48cc4 | 1338 | (vc-make-version-backup file)) |
e0607aaa SM |
1339 | (let ((backend (vc-backend file))) |
1340 | (with-vc-properties (list file) | |
1341 | (condition-case err | |
af36f8ed | 1342 | (vc-call-backend backend 'checkout file writable rev) |
e0607aaa SM |
1343 | (file-error |
1344 | ;; Maybe the backend is not installed ;-( | |
1345 | (when writable | |
1346 | (let ((buf (get-file-buffer file))) | |
1347 | (when buf (with-current-buffer buf (toggle-read-only -1))))) | |
1348 | (signal (car err) (cdr err)))) | |
70e2f6c7 | 1349 | `((vc-state . ,(if (or (eq (vc-checkout-model backend (list file)) 'implicit) |
e0607aaa | 1350 | (not writable)) |
a749e19d | 1351 | (if (vc-call-backend backend 'latest-on-branch-p file) |
e0607aaa | 1352 | 'up-to-date |
3702367b | 1353 | 'needs-update) |
e0607aaa SM |
1354 | 'edited)) |
1355 | (vc-checkout-time . ,(nth 5 (file-attributes file)))))) | |
7cad930d AS |
1356 | (vc-resynch-buffer file t t) |
1357 | (run-hooks 'vc-checkout-hook)) | |
594722a8 | 1358 | |
a749e19d | 1359 | (defun vc-mark-resolved (backend files) |
7fbb4797 DN |
1360 | (with-vc-properties |
1361 | files | |
a749e19d | 1362 | (vc-call-backend backend 'mark-resolved files) |
7fbb4797 DN |
1363 | ;; XXX: Is this TRTD? Might not be. |
1364 | `((vc-state . edited)))) | |
1365 | ||
0e362f54 | 1366 | (defun vc-steal-lock (file rev owner) |
099bd78a | 1367 | "Steal the lock on FILE." |
29fc1ce9 | 1368 | (let (file-description) |
29fc1ce9 RS |
1369 | (if rev |
1370 | (setq file-description (format "%s:%s" file rev)) | |
1371 | (setq file-description file)) | |
b5446276 DN |
1372 | (when (not (yes-or-no-p (format "Steal the lock on %s from %s? " |
1373 | file-description owner))) | |
1374 | (error "Steal canceled")) | |
869131a5 AS |
1375 | (message "Stealing lock on %s..." file) |
1376 | (with-vc-properties | |
d7b60083 | 1377 | (list file) |
869131a5 AS |
1378 | (vc-call steal-lock file rev) |
1379 | `((vc-state . edited))) | |
1380 | (vc-resynch-buffer file t t) | |
1381 | (message "Stealing lock on %s...done" file) | |
1382 | ;; Write mail after actually stealing, because if the stealing | |
1383 | ;; goes wrong, we don't want to send any mail. | |
1384 | (compose-mail owner (format "Stolen lock on %s" file-description)) | |
29fc1ce9 | 1385 | (setq default-directory (expand-file-name "~/")) |
29fc1ce9 RS |
1386 | (goto-char (point-max)) |
1387 | (insert | |
1388 | (format "I stole the lock on %s, " file-description) | |
1389 | (current-time-string) | |
1390 | ".\n") | |
1391 | (message "Please explain why you stole the lock. Type C-c C-c when done."))) | |
594722a8 | 1392 | |
d7b60083 ER |
1393 | (defun vc-checkin (files &optional rev comment initial-contents) |
1394 | "Check in FILES. | |
ac3f4c6f | 1395 | The optional argument REV may be a string specifying the new revision |
0e362f54 | 1396 | level (if nil increment the current level). COMMENT is a comment |
0ab66291 AS |
1397 | string; if omitted, a buffer is popped up to accept a comment. If |
1398 | INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents | |
1399 | of the log entry buffer. | |
0e362f54 GM |
1400 | |
1401 | If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided | |
1402 | that the version control system supports this mode of operation. | |
861f3c29 | 1403 | |
17f039f3 ER |
1404 | Runs the normal hooks `vc-before-checkin-hook' and `vc-checkin-hook'." |
1405 | (when vc-before-checkin-hook | |
1406 | (run-hooks 'vc-before-checkin-hook)) | |
83affd96 | 1407 | (vc-start-logentry |
d7b60083 | 1408 | files rev comment initial-contents |
6f41eeb5 | 1409 | "Enter a change comment." |
400aec1a | 1410 | "*VC-log*" |
d7b60083 ER |
1411 | (lambda (files rev comment) |
1412 | (message "Checking in %s..." (vc-delistify files)) | |
0e362f54 GM |
1413 | ;; "This log message intentionally left almost blank". |
1414 | ;; RCS 5.7 gripes about white-space-only comments too. | |
1415 | (or (and comment (string-match "[^\t\n ]" comment)) | |
1416 | (setq comment "*** empty log message ***")) | |
46e33aee | 1417 | (with-vc-properties |
d7b60083 ER |
1418 | files |
1419 | ;; We used to change buffers to get local value of vc-checkin-switches, | |
1420 | ;; but 'the' local buffer is not a well-defined concept for filesets. | |
1421 | (progn | |
1422 | (vc-call checkin files rev comment) | |
1423 | (mapc 'vc-delete-automatic-version-backups files)) | |
a3255400 SM |
1424 | `((vc-state . up-to-date) |
1425 | (vc-checkout-time . ,(nth 5 (file-attributes file))) | |
ac3f4c6f | 1426 | (vc-working-revision . nil))) |
d7b60083 | 1427 | (message "Checking in %s...done" (vc-delistify files))) |
0e362f54 | 1428 | 'vc-checkin-hook)) |
594722a8 | 1429 | |
2765044b DN |
1430 | ;;; Additional entry points for examining version histories |
1431 | ||
a7192ddb SM |
1432 | ;; (defun vc-default-diff-tree (backend dir rev1 rev2) |
1433 | ;; "List differences for all registered files at and below DIR. | |
1434 | ;; The meaning of REV1 and REV2 is the same as for `vc-revision-diff'." | |
1435 | ;; ;; This implementation does an explicit tree walk, and calls | |
1436 | ;; ;; vc-BACKEND-diff directly for each file. An optimization | |
1437 | ;; ;; would be to use `vc-diff-internal', so that diffs can be local, | |
1438 | ;; ;; and to call it only for files that are actually changed. | |
1439 | ;; ;; However, this is expensive for some backends, and so it is left | |
1440 | ;; ;; to backend-specific implementations. | |
1441 | ;; (setq default-directory dir) | |
1442 | ;; (vc-file-tree-walk | |
1443 | ;; default-directory | |
1444 | ;; (lambda (f) | |
1445 | ;; (vc-exec-after | |
1446 | ;; `(let ((coding-system-for-read (vc-coding-system-for-diff ',f))) | |
1447 | ;; (message "Looking at %s" ',f) | |
1448 | ;; (vc-call-backend ',(vc-backend f) | |
1449 | ;; 'diff (list ',f) ',rev1 ',rev2)))))) | |
2765044b DN |
1450 | |
1451 | (defun vc-coding-system-for-diff (file) | |
1452 | "Return the coding system for reading diff output for FILE." | |
1453 | (or coding-system-for-read | |
1454 | ;; if we already have this file open, | |
1455 | ;; use the buffer's coding system | |
1456 | (let ((buf (find-buffer-visiting file))) | |
b5446276 DN |
1457 | (when buf (with-current-buffer buf |
1458 | buffer-file-coding-system))) | |
2765044b DN |
1459 | ;; otherwise, try to find one based on the file name |
1460 | (car (find-operation-coding-system 'insert-file-contents file)) | |
1461 | ;; and a final fallback | |
1462 | 'undecided)) | |
1463 | ||
1464 | (defun vc-switches (backend op) | |
1465 | (let ((switches | |
b5446276 DN |
1466 | (or (when backend |
1467 | (let ((sym (vc-make-backend-sym | |
1468 | backend (intern (concat (symbol-name op) | |
1469 | "-switches"))))) | |
1470 | (when (boundp sym) (symbol-value sym)))) | |
2765044b | 1471 | (let ((sym (intern (format "vc-%s-switches" (symbol-name op))))) |
b5446276 | 1472 | (when (boundp sym) (symbol-value sym))) |
2765044b DN |
1473 | (cond |
1474 | ((eq op 'diff) diff-switches))))) | |
1475 | (if (stringp switches) (list switches) | |
1476 | ;; If not a list, return nil. | |
1477 | ;; This is so we can set vc-diff-switches to t to override | |
1478 | ;; any switches in diff-switches. | |
b5446276 | 1479 | (when (listp switches) switches)))) |
594722a8 | 1480 | |
2765044b DN |
1481 | ;; Old def for compatibility with Emacs-21.[123]. |
1482 | (defmacro vc-diff-switches-list (backend) `(vc-switches ',backend 'diff)) | |
1483 | (make-obsolete 'vc-diff-switches-list 'vc-switches "22.1") | |
1484 | ||
1d5b2149 | 1485 | (defun vc-diff-finish (buffer messages) |
17f3909f | 1486 | ;; The empty sync output case has already been handled, so the only |
fddde1f0 | 1487 | ;; possibility of an empty output is for an async process. |
1d5b2149 TTN |
1488 | (when (buffer-live-p buffer) |
1489 | (let ((window (get-buffer-window buffer t)) | |
1490 | (emptyp (zerop (buffer-size buffer)))) | |
1491 | (with-current-buffer buffer | |
1492 | (and messages emptyp | |
1493 | (let ((inhibit-read-only t)) | |
1494 | (insert (cdr messages) ".\n") | |
1495 | (message "%s" (cdr messages)))) | |
1496 | (goto-char (point-min)) | |
fddde1f0 | 1497 | (when window |
1d5b2149 TTN |
1498 | (shrink-window-if-larger-than-buffer window))) |
1499 | (when (and messages (not emptyp)) | |
1500 | (message "%sdone" (car messages)))))) | |
d7b60083 | 1501 | |
a7192ddb SM |
1502 | (defvar vc-diff-added-files nil |
1503 | "If non-nil, diff added files by comparing them to /dev/null.") | |
1504 | ||
ae67f2d0 | 1505 | (defun vc-diff-internal (async vc-fileset rev1 rev2 &optional verbose) |
d7b60083 ER |
1506 | "Report diffs between two revisions of a fileset. |
1507 | Diff output goes to the *vc-diff* buffer. The function | |
1508 | returns t if the buffer had changes, nil otherwise." | |
6986e5c9 | 1509 | (let* ((files (cadr vc-fileset)) |
ae67f2d0 | 1510 | (messages (cons (format "Finding changes in %s..." |
1d5b2149 TTN |
1511 | (vc-delistify files)) |
1512 | (format "No changes between %s and %s" | |
1513 | (or rev1 "working revision") | |
1514 | (or rev2 "workfile")))) | |
d7b60083 ER |
1515 | ;; Set coding system based on the first file. It's a kluge, |
1516 | ;; but the only way to set it for each file included would | |
1517 | ;; be to call the back end separately for each file. | |
a7192ddb | 1518 | (coding-system-for-read |
d7b60083 ER |
1519 | (if files (vc-coding-system-for-diff (car files)) 'undecided))) |
1520 | (vc-setup-buffer "*vc-diff*") | |
1d5b2149 | 1521 | (message "%s" (car messages)) |
a7192ddb SM |
1522 | ;; Many backends don't handle well the case of a file that has been |
1523 | ;; added but not yet committed to the repo (notably CVS and Subversion). | |
1524 | ;; Do that work here so the backends don't have to futz with it. --ESR | |
1525 | ;; | |
1526 | ;; Actually most backends (including CVS) have options to control the | |
1527 | ;; behavior since which one is better depends on the user and on the | |
1528 | ;; situation). Worse yet: this code does not handle the case where | |
1529 | ;; `file' is a directory which contains added files. | |
1530 | ;; I made it conditional on vc-diff-added-files but it should probably | |
1531 | ;; just be removed (or copied/moved to specific backends). --Stef. | |
1532 | (when vc-diff-added-files | |
1533 | (let ((filtered '())) | |
1534 | (dolist (file files) | |
1535 | (if (or (file-directory-p file) | |
1536 | (not (string= (vc-working-revision file) "0"))) | |
1537 | (push file filtered) | |
1538 | ;; This file is added but not yet committed; | |
1539 | ;; there is no master file to diff against. | |
1540 | (if (or rev1 rev2) | |
1541 | (error "No revisions of %s exist" file) | |
1542 | ;; We regard this as "changed". | |
1543 | ;; Diff it against /dev/null. | |
1544 | (apply 'vc-do-command "*vc-diff*" | |
1545 | 1 "diff" file | |
1546 | (append (vc-switches nil 'diff) '("/dev/null")))))) | |
1547 | (setq files (nreverse filtered)))) | |
1548 | (let ((vc-disable-async-diff (not async))) | |
ae67f2d0 | 1549 | (vc-call-backend (car vc-fileset) 'diff files rev1 rev2 "*vc-diff*")) |
d7b60083 | 1550 | (set-buffer "*vc-diff*") |
17f3909f SM |
1551 | (if (and (zerop (buffer-size)) |
1552 | (not (get-buffer-process (current-buffer)))) | |
1553 | ;; Treat this case specially so as not to pop the buffer. | |
1554 | (progn | |
1d5b2149 | 1555 | (message "%s" (cdr messages)) |
17f3909f | 1556 | nil) |
e83d1fe8 | 1557 | (diff-mode) |
fe1919ab DN |
1558 | ;; Make the *vc-diff* buffer read only, the diff-mode key |
1559 | ;; bindings are nicer for read only buffers. pcl-cvs does the | |
1560 | ;; same thing. | |
1561 | (setq buffer-read-only t) | |
1d5b2149 TTN |
1562 | (vc-exec-after `(vc-diff-finish ,(current-buffer) ',(when verbose |
1563 | messages))) | |
4befebc1 SM |
1564 | ;; Display the buffer, but at the end because it can change point. |
1565 | (pop-to-buffer (current-buffer)) | |
17f3909f SM |
1566 | ;; In the async case, we return t even if there are no differences |
1567 | ;; because we don't know that yet. | |
1568 | t))) | |
594722a8 | 1569 | |
637a8ae9 | 1570 | ;;;###autoload |
a7192ddb | 1571 | (defun vc-version-diff (files rev1 rev2) |
d7b60083 | 1572 | "Report diffs between revisions of the fileset in the repository history." |
0e362f54 | 1573 | (interactive |
cb5d44b6 | 1574 | (let* ((vc-fileset (vc-deduce-fileset t)) |
6986e5c9 | 1575 | (files (cadr vc-fileset)) |
a749e19d | 1576 | (backend (car vc-fileset)) |
d7b60083 | 1577 | (first (car files)) |
d7b60083 | 1578 | (completion-table |
a749e19d | 1579 | (vc-call-backend backend 'revision-completion-table files)) |
d7b60083 ER |
1580 | (rev1-default nil) |
1581 | (rev2-default nil)) | |
c0d66cb2 | 1582 | (cond |
ac3f4c6f | 1583 | ;; someday we may be able to do revision completion on non-singleton |
d7b60083 ER |
1584 | ;; filesets, but not yet. |
1585 | ((/= (length files) 1) | |
1586 | nil) | |
ac3f4c6f | 1587 | ;; if it's a directory, don't supply any revision default |
d7b60083 | 1588 | ((file-directory-p first) |
c0d66cb2 | 1589 | nil) |
ac3f4c6f | 1590 | ;; if the file is not up-to-date, use working revision as older revision |
d7b60083 | 1591 | ((not (vc-up-to-date-p first)) |
ac3f4c6f ER |
1592 | (setq rev1-default (vc-working-revision first))) |
1593 | ;; if the file is not locked, use last and previous revisions as defaults | |
c0d66cb2 | 1594 | (t |
a749e19d SM |
1595 | (setq rev1-default (vc-call-backend backend 'previous-revision first |
1596 | (vc-working-revision first))) | |
b5446276 | 1597 | (when (string= rev1-default "") (setq rev1-default nil)) |
ac3f4c6f | 1598 | (setq rev2-default (vc-working-revision first)))) |
c0d66cb2 | 1599 | ;; construct argument list |
4d83a657 | 1600 | (let* ((rev1-prompt (if rev1-default |
ac3f4c6f | 1601 | (concat "Older revision (default " |
4d83a657 | 1602 | rev1-default "): ") |
ac3f4c6f ER |
1603 | "Older revision: ")) |
1604 | (rev2-prompt (concat "Newer revision (default " | |
4d83a657 SM |
1605 | (or rev2-default "current source") "): ")) |
1606 | (rev1 (if completion-table | |
1607 | (completing-read rev1-prompt completion-table | |
d7b60083 | 1608 | nil nil nil nil rev1-default) |
4d83a657 SM |
1609 | (read-string rev1-prompt nil nil rev1-default))) |
1610 | (rev2 (if completion-table | |
1611 | (completing-read rev2-prompt completion-table | |
d7b60083 | 1612 | nil nil nil nil rev2-default) |
4d83a657 | 1613 | (read-string rev2-prompt nil nil rev2-default)))) |
b5446276 DN |
1614 | (when (string= rev1 "") (setq rev1 nil)) |
1615 | (when (string= rev2 "") (setq rev2 nil)) | |
a7192ddb | 1616 | (list files rev1 rev2)))) |
86048828 | 1617 | ;; All that was just so we could do argument completion! |
ae67f2d0 DN |
1618 | (when (and (not rev1) rev2) |
1619 | (error "Not a valid revision range.")) | |
86048828 ER |
1620 | ;; Yes, it's painful to call (vc-deduce-fileset) again. Alas, the |
1621 | ;; placement rules for (interactive) don't actually leave us a choice. | |
1622 | (vc-diff-internal t (vc-deduce-fileset) rev1 rev2 (interactive-p))) | |
d7b60083 | 1623 | |
a7192ddb SM |
1624 | ;; (defun vc-contains-version-controlled-file (dir) |
1625 | ;; "Return t if DIR contains a version-controlled file, nil otherwise." | |
1626 | ;; (catch 'found | |
1627 | ;; (mapc (lambda (f) (and (not (file-directory-p f)) (vc-backend f) (throw 'found 't))) (directory-files dir)) | |
1628 | ;; nil)) | |
727c4443 | 1629 | |
d7b60083 | 1630 | ;;;###autoload |
a7192ddb | 1631 | (defun vc-diff (historic &optional not-urgent) |
ac3f4c6f | 1632 | "Display diffs between file revisions. |
727c4443 | 1633 | Normally this compares the currently selected fileset with their |
a7192ddb | 1634 | working revisions. With a prefix argument HISTORIC, it reads two revision |
727c4443 ER |
1635 | designators specifying which revisions to compare. |
1636 | ||
a7192ddb SM |
1637 | The optional argument NOT-URGENT non-nil means it is ok to say no to |
1638 | saving the buffer." | |
1639 | (interactive (list current-prefix-arg t)) | |
1640 | (if historic | |
1641 | (call-interactively 'vc-version-diff) | |
ae67f2d0 | 1642 | (when buffer-file-name (vc-buffer-sync not-urgent)) |
86048828 | 1643 | (vc-diff-internal t (vc-deduce-fileset) nil nil (interactive-p)))) |
2c87edc1 | 1644 | |
f1818994 | 1645 | ;;;###autoload |
ac3f4c6f ER |
1646 | (defun vc-revision-other-window (rev) |
1647 | "Visit revision REV of the current file in another window. | |
1648 | If the current file is named `F', the revision is named `F.~REV~'. | |
6f1ecae4 | 1649 | If `F.~REV~' already exists, use it instead of checking it out again." |
4d83a657 SM |
1650 | (interactive |
1651 | (save-current-buffer | |
1652 | (vc-ensure-vc-buffer) | |
1653 | (let ((completion-table | |
1654 | (vc-call revision-completion-table buffer-file-name)) | |
ac3f4c6f | 1655 | (prompt "Revision to visit (default is working revision): ")) |
4d83a657 SM |
1656 | (list |
1657 | (if completion-table | |
1658 | (completing-read prompt completion-table) | |
1659 | (read-string prompt)))))) | |
b6909007 | 1660 | (vc-ensure-vc-buffer) |
5e011cb2 | 1661 | (let* ((file buffer-file-name) |
ac3f4c6f ER |
1662 | (revision (if (string-equal rev "") |
1663 | (vc-working-revision file) | |
ac0aae44 | 1664 | rev))) |
ac3f4c6f | 1665 | (switch-to-buffer-other-window (vc-find-revision file revision)))) |
ac0aae44 | 1666 | |
ac3f4c6f ER |
1667 | (defun vc-find-revision (file revision) |
1668 | "Read REVISION of FILE into a buffer and return the buffer." | |
1669 | (let ((automatic-backup (vc-version-backup-file-name file revision)) | |
fd8160f7 | 1670 | (filebuf (or (get-file-buffer file) (current-buffer))) |
ac3f4c6f | 1671 | (filename (vc-version-backup-file-name file revision 'manual))) |
fd8160f7 | 1672 | (unless (file-exists-p filename) |
10b48cc4 | 1673 | (if (file-exists-p automatic-backup) |
fd8160f7 SM |
1674 | (rename-file automatic-backup filename nil) |
1675 | (message "Checking out %s..." filename) | |
1676 | (with-current-buffer filebuf | |
1677 | (let ((failed t)) | |
1678 | (unwind-protect | |
1679 | (let ((coding-system-for-read 'no-conversion) | |
1680 | (coding-system-for-write 'no-conversion)) | |
1681 | (with-temp-file filename | |
1682 | (let ((outbuf (current-buffer))) | |
1683 | ;; Change buffer to get local value of | |
1684 | ;; vc-checkout-switches. | |
1685 | (with-current-buffer filebuf | |
ac3f4c6f | 1686 | (vc-call find-revision file revision outbuf)))) |
fd8160f7 | 1687 | (setq failed nil)) |
48b43130 DN |
1688 | (when (and failed (file-exists-p filename)) |
1689 | (delete-file filename)))) | |
fd8160f7 SM |
1690 | (vc-mode-line file)) |
1691 | (message "Checking out %s...done" filename))) | |
48b43130 DN |
1692 | (let ((result-buf (find-file-noselect filename))) |
1693 | (with-current-buffer result-buf | |
83f1f73b | 1694 | ;; Set the parent buffer so that things like |
48b43130 | 1695 | ;; C-x v g, C-x v l, ... etc work. |
25a4ea6d | 1696 | (set (make-local-variable 'vc-parent-buffer) filebuf)) |
48b43130 | 1697 | result-buf))) |
fd8160f7 | 1698 | |
594722a8 ER |
1699 | ;; Header-insertion code |
1700 | ||
637a8ae9 | 1701 | ;;;###autoload |
594722a8 | 1702 | (defun vc-insert-headers () |
6f1ecae4 | 1703 | "Insert headers into a file for use with a version control system. |
b524ce9f | 1704 | Headers desired are inserted at point, and are pulled from |
0e362f54 | 1705 | the variable `vc-BACKEND-header'." |
594722a8 | 1706 | (interactive) |
b6909007 | 1707 | (vc-ensure-vc-buffer) |
594722a8 ER |
1708 | (save-excursion |
1709 | (save-restriction | |
1710 | (widen) | |
b5446276 DN |
1711 | (when (or (not (vc-check-headers)) |
1712 | (y-or-n-p "Version headers already exist. Insert another set? ")) | |
1713 | (let* ((delims (cdr (assq major-mode vc-comment-alist))) | |
1714 | (comment-start-vc (or (car delims) comment-start "#")) | |
1715 | (comment-end-vc (or (car (cdr delims)) comment-end "")) | |
1716 | (hdsym (vc-make-backend-sym (vc-backend buffer-file-name) | |
1717 | 'header)) | |
1718 | (hdstrings (and (boundp hdsym) (symbol-value hdsym)))) | |
1719 | (dolist (s hdstrings) | |
1720 | (insert comment-start-vc "\t" s "\t" | |
1721 | comment-end-vc "\n")) | |
1722 | (when vc-static-header-alist | |
1723 | (dolist (f vc-static-header-alist) | |
1724 | (when (string-match (car f) buffer-file-name) | |
1725 | (insert (format (cdr f) (car hdstrings))))))))))) | |
594722a8 | 1726 | |
0e362f54 | 1727 | (defun vc-clear-headers (&optional file) |
099bd78a | 1728 | "Clear all version headers in the current buffer (or FILE). |
6f1ecae4 | 1729 | The headers are reset to their non-expanded form." |
0e362f54 GM |
1730 | (let* ((filename (or file buffer-file-name)) |
1731 | (visited (find-buffer-visiting filename)) | |
1732 | (backend (vc-backend filename))) | |
1733 | (when (vc-find-backend-function backend 'clear-headers) | |
6f41eeb5 | 1734 | (if visited |
0e362f54 GM |
1735 | (let ((context (vc-buffer-context))) |
1736 | ;; save-excursion may be able to relocate point and mark | |
1737 | ;; properly. If it fails, vc-restore-buffer-context | |
1738 | ;; will give it a second try. | |
1739 | (save-excursion | |
1740 | (vc-call-backend backend 'clear-headers)) | |
1741 | (vc-restore-buffer-context context)) | |
7849e179 | 1742 | (set-buffer (find-file-noselect filename)) |
0e362f54 GM |
1743 | (vc-call-backend backend 'clear-headers) |
1744 | (kill-buffer filename))))) | |
c8de1d91 | 1745 | |
9b64a7f0 ER |
1746 | (defun vc-modify-change-comment (files rev oldcomment) |
1747 | "Edit the comment associated with the given files and revision." | |
83affd96 | 1748 | (vc-start-logentry |
9b64a7f0 ER |
1749 | files rev oldcomment t |
1750 | "Enter a replacement change comment." | |
400aec1a | 1751 | "*VC-log*" |
9b64a7f0 | 1752 | (lambda (files rev comment) |
df49d02e | 1753 | (vc-call-backend |
9b64a7f0 ER |
1754 | ;; Less of a kluge than it looks like; log-view mode only passes |
1755 | ;; this function a singleton list. Arguments left in this form in | |
df49d02e JB |
1756 | ;; case the more general operation ever becomes meaningful. |
1757 | (vc-responsible-backend (car files)) | |
9b64a7f0 ER |
1758 | 'modify-change-comment files rev comment)))) |
1759 | ||
b6909007 | 1760 | ;;;###autoload |
099bd78a | 1761 | (defun vc-merge () |
ac3f4c6f ER |
1762 | "Merge changes between two revisions into the current buffer's file. |
1763 | This asks for two revisions to merge from in the minibuffer. If the | |
1764 | first revision is a branch number, then merge all changes from that | |
1765 | branch. If the first revision is empty, merge news, i.e. recent changes | |
099bd78a | 1766 | from the current branch. |
0e362f54 GM |
1767 | |
1768 | See Info node `Merging'." | |
099bd78a | 1769 | (interactive) |
ccb141e8 AS |
1770 | (vc-ensure-vc-buffer) |
1771 | (vc-buffer-sync) | |
1772 | (let* ((file buffer-file-name) | |
1773 | (backend (vc-backend file)) | |
0e362f54 | 1774 | (state (vc-state file)) |
ac3f4c6f | 1775 | first-revision second-revision status) |
0e362f54 | 1776 | (cond |
61de26cb | 1777 | ((stringp state) ;; Locking VCses only |
0e362f54 GM |
1778 | (error "File is locked by %s" state)) |
1779 | ((not (vc-editable-p file)) | |
1780 | (if (y-or-n-p | |
1781 | "File must be checked out for merging. Check out now? ") | |
1782 | (vc-checkout file t) | |
1783 | (error "Merge aborted")))) | |
ac3f4c6f ER |
1784 | (setq first-revision |
1785 | (read-string (concat "Branch or revision to merge from " | |
5b76833f | 1786 | "(default news on current branch): "))) |
ac3f4c6f | 1787 | (if (string= first-revision "") |
a749e19d | 1788 | (setq status (vc-call-backend backend 'merge-news file)) |
099bd78a SM |
1789 | (if (not (vc-find-backend-function backend 'merge)) |
1790 | (error "Sorry, merging is not implemented for %s" backend) | |
ac3f4c6f ER |
1791 | (if (not (vc-branch-p first-revision)) |
1792 | (setq second-revision | |
1793 | (read-string "Second revision: " | |
1794 | (concat (vc-branch-part first-revision) "."))) | |
1795 | ;; We want to merge an entire branch. Set revisions | |
099bd78a | 1796 | ;; accordingly, so that vc-BACKEND-merge understands us. |
ac3f4c6f ER |
1797 | (setq second-revision first-revision) |
1798 | ;; first-revision must be the starting point of the branch | |
1799 | (setq first-revision (vc-branch-part first-revision))) | |
a749e19d SM |
1800 | (setq status (vc-call-backend backend 'merge file |
1801 | first-revision second-revision)))) | |
099bd78a | 1802 | (vc-maybe-resolve-conflicts file status "WORKFILE" "MERGE SOURCE"))) |
0e362f54 GM |
1803 | |
1804 | (defun vc-maybe-resolve-conflicts (file status &optional name-A name-B) | |
1805 | (vc-resynch-buffer file t (not (buffer-modified-p))) | |
1806 | (if (zerop status) (message "Merge successful") | |
28e4e2b4 | 1807 | (smerge-mode 1) |
8dc87047 | 1808 | (message "File contains conflicts."))) |
ccb141e8 AS |
1809 | |
1810 | ;;;###autoload | |
1168d6c2 | 1811 | (defalias 'vc-resolve-conflicts 'smerge-ediff) |
3b574573 | 1812 | |
b1ddeeb7 ER |
1813 | ;; VC status implementation |
1814 | ||
b1ddeeb7 | 1815 | (defun vc-default-status-extra-headers (backend dir) |
4f155125 | 1816 | ;; Be loud by default to remind people to add code to display |
b1ddeeb7 ER |
1817 | ;; backend specific headers. |
1818 | ;; XXX: change this to return nil before the release. | |
1819 | "Extra : Add backend specific headers here") | |
1820 | ||
1821 | (defun vc-dir-headers (backend dir) | |
1822 | "Display the headers in the *VC status* buffer. | |
1823 | It calls the `status-extra-headers' backend method to display backend | |
1824 | specific headers." | |
1825 | (concat | |
98712492 | 1826 | (propertize "VC backend: " 'face 'font-lock-type-face) |
b1ddeeb7 | 1827 | (propertize (format "%s\n" backend) 'face 'font-lock-variable-name-face) |
98712492 | 1828 | (propertize "Working dir: " 'face 'font-lock-type-face) |
b1ddeeb7 ER |
1829 | (propertize (format "%s\n" dir) 'face 'font-lock-variable-name-face) |
1830 | (vc-call-backend backend 'status-extra-headers dir) | |
1831 | "\n")) | |
1832 | ||
1833 | (defun vc-default-status-printer (backend fileentry) | |
1834 | "Pretty print FILEENTRY." | |
1835 | ;; If you change the layout here, change vc-dir-move-to-goal-column. | |
7c2ec3f9 ER |
1836 | (let* ((isdir (vc-dir-fileinfo->directory fileentry)) |
1837 | (state (if isdir 'DIRECTORY (vc-dir-fileinfo->state fileentry))) | |
1838 | (filename (vc-dir-fileinfo->name fileentry)) | |
1839 | (prettified (if isdir state (vc-call-backend backend 'prettify-state-info filename)))) | |
b1ddeeb7 ER |
1840 | (insert |
1841 | (propertize | |
1842 | (format "%c" (if (vc-dir-fileinfo->marked fileentry) ?* ? )) | |
1843 | 'face 'font-lock-type-face) | |
1844 | " " | |
1845 | (propertize | |
7c2ec3f9 | 1846 | (format "%-20s" prettified) |
b1ddeeb7 ER |
1847 | 'face (cond ((eq state 'up-to-date) 'font-lock-builtin-face) |
1848 | ((memq state '(missing conflict)) 'font-lock-warning-face) | |
1849 | (t 'font-lock-variable-name-face)) | |
1850 | 'mouse-face 'highlight) | |
1851 | " " | |
1852 | (propertize | |
7c2ec3f9 | 1853 | (format "%s" filename) |
b1ddeeb7 ER |
1854 | 'face 'font-lock-function-name-face |
1855 | 'mouse-face 'highlight)))) | |
1856 | ||
b1ddeeb7 ER |
1857 | (defun vc-default-extra-status-menu (backend) |
1858 | nil) | |
1859 | ||
b1ddeeb7 ER |
1860 | (defun vc-dir-refresh-files (files default-state) |
1861 | "Refresh some files in the VC status buffer." | |
1862 | (let ((backend (vc-responsible-backend default-directory)) | |
1863 | (status-buffer (current-buffer)) | |
1864 | (def-dir default-directory)) | |
1865 | (vc-set-mode-line-busy-indicator) | |
1866 | ;; Call the `dir-status-file' backend function. | |
1867 | ;; `dir-status-file' is supposed to be asynchronous. | |
1868 | ;; It should compute the results, and then call the function | |
1869 | ;; passed as an argument in order to update the vc-dir buffer | |
1870 | ;; with the results. | |
1871 | (unless (buffer-live-p vc-dir-process-buffer) | |
1872 | (setq vc-dir-process-buffer | |
1873 | (generate-new-buffer (format " *VC-%s* tmp status" backend)))) | |
1874 | (lexical-let ((buffer (current-buffer))) | |
1875 | (with-current-buffer vc-dir-process-buffer | |
1876 | (cd def-dir) | |
1877 | (erase-buffer) | |
1878 | (vc-call-backend | |
1879 | backend 'dir-status-files def-dir files default-state | |
1880 | (lambda (entries &optional more-to-come) | |
1881 | ;; ENTRIES is a list of (FILE VC_STATE EXTRA) items. | |
1882 | ;; If MORE-TO-COME is true, then more updates will come from | |
1883 | ;; the asynchronous process. | |
1884 | (with-current-buffer buffer | |
1885 | (vc-dir-update entries buffer) | |
1886 | (unless more-to-come | |
1887 | (setq mode-line-process nil) | |
1888 | ;; Remove the ones that haven't been updated at all. | |
1889 | ;; Those not-updated are those whose state is nil because the | |
1890 | ;; file/dir doesn't exist and isn't versioned. | |
1891 | (ewoc-filter vc-ewoc | |
1892 | (lambda (info) | |
1893 | (not (vc-dir-fileinfo->needs-update info)))))))))))) | |
1894 | ||
1895 | (defun vc-dir-refresh () | |
1896 | "Refresh the contents of the VC status buffer. | |
1897 | Throw an error if another update process is in progress." | |
1898 | (interactive) | |
1899 | (if (vc-dir-busy) | |
1900 | (error "Another update process is in progress, cannot run two at a time") | |
1901 | (let ((backend (vc-responsible-backend default-directory)) | |
1902 | (status-buffer (current-buffer)) | |
1903 | (def-dir default-directory)) | |
1904 | (vc-set-mode-line-busy-indicator) | |
1905 | ;; Call the `dir-status' backend function. | |
1906 | ;; `dir-status' is supposed to be asynchronous. | |
1907 | ;; It should compute the results, and then call the function | |
1908 | ;; passed as an argument in order to update the vc-dir buffer | |
1909 | ;; with the results. | |
1910 | ||
1911 | ;; Create a buffer that can be used by `dir-status' and call | |
1912 | ;; `dir-status' with this buffer as the current buffer. Use | |
1913 | ;; `vc-dir-process-buffer' to remember this buffer, so that | |
1914 | ;; it can be used later to kill the update process in case it | |
1915 | ;; takes too long. | |
1916 | (unless (buffer-live-p vc-dir-process-buffer) | |
1917 | (setq vc-dir-process-buffer | |
1918 | (generate-new-buffer (format " *VC-%s* tmp status" backend)))) | |
1919 | ;; set the needs-update flag on all entries | |
1920 | (ewoc-map (lambda (info) (setf (vc-dir-fileinfo->needs-update info) t) nil) | |
1921 | vc-ewoc) | |
1922 | (lexical-let ((buffer (current-buffer))) | |
1923 | (with-current-buffer vc-dir-process-buffer | |
1924 | (cd def-dir) | |
1925 | (erase-buffer) | |
1926 | (vc-call-backend | |
1927 | backend 'dir-status def-dir | |
1928 | (lambda (entries &optional more-to-come) | |
1929 | ;; ENTRIES is a list of (FILE VC_STATE EXTRA) items. | |
1930 | ;; If MORE-TO-COME is true, then more updates will come from | |
1931 | ;; the asynchronous process. | |
1932 | (with-current-buffer buffer | |
1933 | (vc-dir-update entries buffer) | |
1934 | (unless more-to-come | |
1935 | (let ((remaining | |
1936 | (ewoc-collect | |
1937 | vc-ewoc 'vc-dir-fileinfo->needs-update))) | |
1938 | (if remaining | |
1939 | (vc-dir-refresh-files | |
1940 | (mapcar 'vc-dir-fileinfo->name remaining) | |
1941 | 'up-to-date) | |
1942 | (setq mode-line-process nil)))))))))))) | |
1943 | ||
b1ddeeb7 ER |
1944 | (defun vc-dir-show-fileentry (file) |
1945 | "Insert an entry for a specific file into the current VC status listing. | |
1946 | This is typically used if the file is up-to-date (or has been added | |
1947 | outside of VC) and one wants to do some operation on it." | |
1948 | (interactive "fShow file: ") | |
1949 | (vc-dir-update (list (list (file-relative-name file) (vc-state file))) (current-buffer))) | |
1950 | ||
b1ddeeb7 ER |
1951 | (defun vc-dir-hide-up-to-date () |
1952 | "Hide up-to-date items from display." | |
1953 | (interactive) | |
1954 | (ewoc-filter | |
1955 | vc-ewoc | |
1956 | (lambda (crt) (not (eq (vc-dir-fileinfo->state crt) 'up-to-date))))) | |
1957 | ||
783b505b ER |
1958 | (defun vc-dir-register () |
1959 | "Register the marked files, or the current file if no marks." | |
1960 | (interactive) | |
1961 | ;; FIXME: Just pass the fileset to vc-register. | |
1962 | (mapc (lambda (arg) (vc-register nil arg)) | |
1963 | (or (vc-dir-marked-files) (list (vc-dir-current-file))))) | |
1964 | ||
b1ddeeb7 | 1965 | (defun vc-default-status-fileinfo-extra (backend file) |
cb625535 | 1966 | "Default absence of extra information returned for a file." |
b1ddeeb7 ER |
1967 | nil) |
1968 | ||
30cd7dc2 DN |
1969 | (defvar vc-dir-backend nil |
1970 | "The backend used by the current *vc-dir* buffer.") | |
1971 | ||
cb625535 ER |
1972 | ;; FIXME: Replace these with a more efficient dispatch |
1973 | ||
1974 | (defun vc-generic-status-printer (fileentry) | |
30cd7dc2 DN |
1975 | (vc-call-backend vc-dir-backend 'status-printer fileentry)) |
1976 | ||
cb625535 | 1977 | (defun vc-generic-state (file) |
30cd7dc2 | 1978 | (vc-call-backend vc-dir-backend 'state file)) |
cb625535 | 1979 | |
30cd7dc2 DN |
1980 | (defun vc-generic-status-fileinfo-extra (file) |
1981 | (vc-call-backend vc-dir-backend 'status-fileinfo-extra file)) | |
cb625535 | 1982 | |
97275f80 | 1983 | (defun vc-dir-extra-menu () |
30cd7dc2 | 1984 | (vc-call-backend vc-dir-backend 'extra-status-menu)) |
97275f80 | 1985 | |
cb625535 | 1986 | (defun vc-make-backend-object (file-or-dir) |
725aff3c | 1987 | "Create the backend capability object needed by vc-dispatcher." |
cb625535 ER |
1988 | (vc-create-client-object |
1989 | "VC status" | |
30cd7dc2 | 1990 | (vc-dir-headers vc-dir-backend file-or-dir) |
cb625535 ER |
1991 | #'vc-generic-status-printer |
1992 | #'vc-generic-state | |
1993 | #'vc-generic-status-fileinfo-extra | |
97275f80 ER |
1994 | #'vc-dir-refresh |
1995 | #'vc-dir-extra-menu)) | |
cb625535 ER |
1996 | |
1997 | ;;;###autoload | |
1998 | (defun vc-dir (dir) | |
1999 | "Show the VC status for DIR." | |
2000 | (interactive "DVC status for directory: ") | |
d536a904 | 2001 | (pop-to-buffer (vc-dir-prepare-status-buffer "*vc-dir*" dir)) |
734abae3 | 2002 | (if (and (derived-mode-p 'vc-dir-mode) (boundp 'client-object)) |
cb625535 ER |
2003 | (vc-dir-refresh) |
2004 | ;; Otherwise, initialize a new view using the dispatcher layer | |
2005 | (progn | |
30cd7dc2 | 2006 | (set (make-local-variable 'vc-dir-backend) (vc-responsible-backend dir)) |
cb625535 | 2007 | ;; Build a capability object and hand it to the dispatcher initializer |
a3e0b93f | 2008 | (vc-dir-mode (vc-make-backend-object dir)) |
734abae3 | 2009 | ;; FIXME: Make a derived-mode instead. |
cb625535 ER |
2010 | ;; Add VC-specific keybindings |
2011 | (let ((map (current-local-map))) | |
79ac8f50 | 2012 | (define-key map "v" 'vc-diff) ;; C-x v v |
cb625535 | 2013 | (define-key map "=" 'vc-diff) ;; C-x v = |
79ac8f50 | 2014 | (define-key map "i" 'vc-dir-register) ;; C-x v i |
cb625535 | 2015 | (define-key map "+" 'vc-update) ;; C-x v + |
cb625535 | 2016 | (define-key map "l" 'vc-print-log) ;; C-x v l |
79ac8f50 ER |
2017 | ;; More confusing than helpful, probably |
2018 | ;(define-key map "R" 'vc-revert) ;; u is taken by dispatcher unmark. | |
2019 | ;(define-key map "A" 'vc-annotate) ;; g is taken by dispatcher refresh | |
ee5d572f | 2020 | (define-key map "x" 'vc-dir-hide-up-to-date)) |
9a6b551b ER |
2021 | ) |
2022 | ;; FIXME: Needs to alter a buffer-local map, otherwise clients may clash | |
2023 | (let ((map vc-dir-menu-map)) | |
2024 | ;; VC info details | |
2025 | (define-key map [sepvcdet] '("--")) | |
2026 | (define-key map [remup] | |
2027 | '(menu-item "Hide up-to-date" vc-dir-hide-up-to-date | |
2028 | :help "Hide up-to-date items from display")) | |
2029 | ;; FIXME: This needs a key binding. And maybe a better name | |
2030 | ;; ("Insert" like PCL-CVS uses does not sound that great either)... | |
2031 | (define-key map [ins] | |
2032 | '(menu-item "Show File" vc-dir-show-fileentry | |
2033 | :help "Show a file in the VC status listing even though it might be up to date")) | |
2034 | (define-key map [annotate] | |
2035 | '(menu-item "Annotate" vc-annotate | |
2036 | :help "Display the edit history of the current file using colors")) | |
2037 | (define-key map [diff] | |
2038 | '(menu-item "Compare with Base Version" vc-diff | |
2039 | :help "Compare file set with the base version")) | |
2040 | (define-key map [log] | |
2041 | '(menu-item "Show history" vc-print-log | |
2042 | :help "List the change log of the current file set in a window")) | |
2043 | ;; VC commands. | |
2044 | (define-key map [sepvccmd] '("--")) | |
2045 | (define-key map [update] | |
2046 | '(menu-item "Update to latest version" vc-update | |
2047 | :help "Update the current fileset's files to their tip revisions")) | |
2048 | (define-key map [revert] | |
2049 | '(menu-item "Revert to base version" vc-revert | |
2050 | :help "Revert working copies of the selected fileset to their repository contents.")) | |
2051 | (define-key map [next-action] | |
2052 | ;; FIXME: This really really really needs a better name! | |
2053 | ;; And a key binding too. | |
2054 | '(menu-item "Check In/Out" vc-next-action | |
2055 | :help "Do the next logical version control operation on the current fileset")) | |
2056 | (define-key map [register] | |
2057 | '(menu-item "Register" vc-dir-register | |
2058 | :help "Register file set into the version control system")) | |
2059 | ))) | |
b1ddeeb7 | 2060 | |
594722a8 ER |
2061 | ;; Named-configuration entry points |
2062 | ||
370fded4 | 2063 | (defun vc-tag-precondition (dir) |
6f1ecae4 | 2064 | "Scan the tree below DIR, looking for files not up-to-date. |
099bd78a | 2065 | If any file is not up-to-date, return the name of the first such file. |
370fded4 | 2066 | \(This means, neither tag creation nor retrieval is allowed.\) |
099bd78a SM |
2067 | If one or more of the files are currently visited, return `visited'. |
2068 | Otherwise, return nil." | |
503b5c85 RS |
2069 | (let ((status nil)) |
2070 | (catch 'vc-locked-example | |
2071 | (vc-file-tree-walk | |
0e362f54 GM |
2072 | dir |
2073 | (lambda (f) | |
2074 | (if (not (vc-up-to-date-p f)) (throw 'vc-locked-example f) | |
b5446276 | 2075 | (when (get-file-buffer f) (setq status 'visited))))) |
503b5c85 | 2076 | status))) |
594722a8 | 2077 | |
637a8ae9 | 2078 | ;;;###autoload |
370fded4 ER |
2079 | (defun vc-create-tag (dir name branchp) |
2080 | "Descending recursively from DIR, make a tag called NAME. | |
ac3f4c6f ER |
2081 | For each registered file, the working revision becomes part of |
2082 | the named configuration. If the prefix argument BRANCHP is | |
370fded4 | 2083 | given, the tag is made as a new branch and the files are |
ac3f4c6f | 2084 | checked out in that new branch." |
0e362f54 GM |
2085 | (interactive |
2086 | (list (read-file-name "Directory: " default-directory default-directory t) | |
370fded4 | 2087 | (read-string "New tag name: ") |
0e362f54 | 2088 | current-prefix-arg)) |
370fded4 | 2089 | (message "Making %s... " (if branchp "branch" "tag")) |
b5446276 | 2090 | (when (file-directory-p dir) (setq dir (file-name-as-directory dir))) |
0e362f54 | 2091 | (vc-call-backend (vc-responsible-backend dir) |
370fded4 ER |
2092 | 'create-tag dir name branchp) |
2093 | (message "Making %s... done" (if branchp "branch" "tag"))) | |
0e362f54 | 2094 | |
637a8ae9 | 2095 | ;;;###autoload |
370fded4 ER |
2096 | (defun vc-retrieve-tag (dir name) |
2097 | "Descending recursively from DIR, retrieve the tag called NAME. | |
ac3f4c6f | 2098 | If NAME is empty, it refers to the latest revisions. |
099bd78a SM |
2099 | If locking is used for the files in DIR, then there must not be any |
2100 | locked files at or below DIR (but if NAME is empty, locked files are | |
2101 | allowed and simply skipped)." | |
0e362f54 GM |
2102 | (interactive |
2103 | (list (read-file-name "Directory: " default-directory default-directory t) | |
370fded4 | 2104 | (read-string "Tag name to retrieve (default latest revisions): "))) |
0e362f54 GM |
2105 | (let ((update (yes-or-no-p "Update any affected buffers? ")) |
2106 | (msg (if (or (not name) (string= name "")) | |
2107 | (format "Updating %s... " (abbreviate-file-name dir)) | |
370fded4 | 2108 | (format "Retrieving tag into %s... " |
0e362f54 | 2109 | (abbreviate-file-name dir))))) |
8a26c165 | 2110 | (message "%s" msg) |
0e362f54 | 2111 | (vc-call-backend (vc-responsible-backend dir) |
370fded4 | 2112 | 'retrieve-tag dir name update) |
8a26c165 | 2113 | (message "%s" (concat msg "done")))) |
0e362f54 | 2114 | |
594722a8 ER |
2115 | ;; Miscellaneous other entry points |
2116 | ||
637a8ae9 | 2117 | ;;;###autoload |
ac3f4c6f | 2118 | (defun vc-print-log (&optional working-revision) |
d7b60083 | 2119 | "List the change log of the current fileset in a window. |
ac3f4c6f | 2120 | If WORKING-REVISION is non-nil, leave the point at that revision." |
594722a8 | 2121 | (interactive) |
cb5d44b6 | 2122 | (let* ((vc-fileset (vc-deduce-fileset t)) |
ae67f2d0 | 2123 | (backend (car vc-fileset)) |
6986e5c9 | 2124 | (files (cadr vc-fileset)) |
ac3f4c6f | 2125 | (working-revision (or working-revision (vc-working-revision (car files))))) |
5217a76a SS |
2126 | ;; Don't switch to the output buffer before running the command, |
2127 | ;; so that any buffer-local settings in the vc-controlled | |
ac9ff209 | 2128 | ;; buffer can be accessed by the command. |
d7b60083 ER |
2129 | (vc-call-backend backend 'print-log files "*vc-change-log*") |
2130 | (pop-to-buffer "*vc-change-log*") | |
0e362f54 | 2131 | (vc-exec-after |
99cb8c8b | 2132 | `(let ((inhibit-read-only t)) |
d7b60083 | 2133 | (vc-call-backend ',backend 'log-view-mode) |
0e362f54 GM |
2134 | (goto-char (point-max)) (forward-line -1) |
2135 | (while (looking-at "=*\n") | |
2136 | (delete-char (- (match-end 0) (match-beginning 0))) | |
2137 | (forward-line -1)) | |
2138 | (goto-char (point-min)) | |
b5446276 DN |
2139 | (when (looking-at "[\b\t\n\v\f\r ]+") |
2140 | (delete-char (- (match-end 0) (match-beginning 0)))) | |
d7b60083 | 2141 | (shrink-window-if-larger-than-buffer) |
ac3f4c6f ER |
2142 | ;; move point to the log entry for the working revision |
2143 | (vc-call-backend ',backend 'show-log-entry ',working-revision) | |
86e80023 | 2144 | (setq vc-sentinel-movepoint (point)) |
99cb8c8b | 2145 | (set-buffer-modified-p nil))))) |
594722a8 | 2146 | |
637a8ae9 | 2147 | ;;;###autoload |
e4d26892 | 2148 | (defun vc-revert () |
d7b60083 | 2149 | "Revert working copies of the selected fileset to their repository contents. |
9c95ac44 | 2150 | This asks for confirmation if the buffer contents are not identical |
ac3f4c6f | 2151 | to the working revision (except for keyword expansion)." |
594722a8 | 2152 | (interactive) |
ae67f2d0 | 2153 | (let* ((vc-fileset (vc-deduce-fileset)) |
6986e5c9 | 2154 | (files (cadr vc-fileset))) |
d7b60083 ER |
2155 | ;; If any of the files is visited by the current buffer, make |
2156 | ;; sure buffer is saved. If the user says `no', abort since | |
2157 | ;; we cannot show the changes and ask for confirmation to | |
2158 | ;; discard them. | |
b5446276 DN |
2159 | (when (or (not files) (memq (buffer-file-name) files)) |
2160 | (vc-buffer-sync nil)) | |
d7b60083 | 2161 | (dolist (file files) |
a7192ddb | 2162 | (let ((buf (get-file-buffer file))) |
b5446276 | 2163 | (when (and buf (buffer-modified-p buf)) |
d7b60083 | 2164 | (error "Please kill or save all modified buffers before reverting."))) |
b5446276 DN |
2165 | (when (vc-up-to-date-p file) |
2166 | (unless (yes-or-no-p (format "%s seems up-to-date. Revert anyway? " file)) | |
2167 | (error "Revert canceled")))) | |
ae67f2d0 | 2168 | (when (vc-diff-internal vc-allow-async-revert vc-fileset nil nil) |
b5446276 DN |
2169 | (unless (yes-or-no-p (format "Discard changes in %s? " (vc-delistify files))) |
2170 | (error "Revert canceled")) | |
2171 | (delete-windows-on "*vc-diff*") | |
2172 | (kill-buffer "*vc-diff*")) | |
d7b60083 | 2173 | (dolist (file files) |
b5446276 DN |
2174 | (message "Reverting %s..." (vc-delistify files)) |
2175 | (vc-revert-file file) | |
2176 | (message "Reverting %s...done" (vc-delistify files))))) | |
594722a8 | 2177 | |
637a8ae9 | 2178 | ;;;###autoload |
d7b60083 ER |
2179 | (defun vc-rollback () |
2180 | "Roll back (remove) the most recent changeset committed to the repository. | |
2181 | This may be either a file-level or a repository-level operation, | |
2182 | depending on the underlying version-control system." | |
2183 | (interactive) | |
ae67f2d0 | 2184 | (let* ((vc-fileset (vc-deduce-fileset)) |
ae67f2d0 | 2185 | (backend (car vc-fileset)) |
6986e5c9 | 2186 | (files (cadr vc-fileset)) |
d7b60083 ER |
2187 | (granularity (vc-call-backend backend 'revision-granularity))) |
2188 | (unless (vc-find-backend-function backend 'rollback) | |
2189 | (error "Rollback is not supported in %s" backend)) | |
b5446276 DN |
2190 | (when (and (not (eq granularity 'repository)) (/= (length files) 1)) |
2191 | (error "Rollback requires a singleton fileset or repository versioning")) | |
a749e19d SM |
2192 | ;; FIXME: latest-on-branch-p should take the fileset. |
2193 | (when (not (vc-call-backend backend 'latest-on-branch-p (car files))) | |
b5446276 | 2194 | (error "Rollback is only possible at the tip revision.")) |
d7b60083 ER |
2195 | ;; If any of the files is visited by the current buffer, make |
2196 | ;; sure buffer is saved. If the user says `no', abort since | |
2197 | ;; we cannot show the changes and ask for confirmation to | |
2198 | ;; discard them. | |
b5446276 DN |
2199 | (when (or (not files) (memq (buffer-file-name) files)) |
2200 | (vc-buffer-sync nil)) | |
d7b60083 | 2201 | (dolist (file files) |
b5446276 DN |
2202 | (when (buffer-modified-p (get-file-buffer file)) |
2203 | (error "Please kill or save all modified buffers before rollback.")) | |
2204 | (when (not (vc-up-to-date-p file)) | |
2205 | (error "Please revert all modified workfiles before rollback."))) | |
d7b60083 ER |
2206 | ;; Accumulate changes associated with the fileset |
2207 | (vc-setup-buffer "*vc-diff*") | |
2208 | (not-modified) | |
2209 | (message "Finding changes...") | |
ac3f4c6f | 2210 | (let* ((tip (vc-working-revision (car files))) |
a749e19d SM |
2211 | ;; FIXME: `previous-revision' should take the fileset. |
2212 | (previous (vc-call-backend backend 'previous-revision | |
2213 | (car files) tip))) | |
ae67f2d0 | 2214 | (vc-diff-internal nil vc-fileset previous tip)) |
a7192ddb | 2215 | ;; Display changes |
d7b60083 ER |
2216 | (unless (yes-or-no-p "Discard these revisions? ") |
2217 | (error "Rollback canceled")) | |
2218 | (delete-windows-on "*vc-diff*") | |
2219 | (kill-buffer"*vc-diff*") | |
2220 | ;; Do the actual reversions | |
2221 | (message "Rolling back %s..." (vc-delistify files)) | |
2222 | (with-vc-properties | |
2223 | files | |
2224 | (vc-call-backend backend 'rollback files) | |
2225 | `((vc-state . ,'up-to-date) | |
2226 | (vc-checkout-time . , (nth 5 (file-attributes file))) | |
ac3f4c6f | 2227 | (vc-working-revision . nil))) |
a7192ddb | 2228 | (dolist (f files) (vc-resynch-buffer f t t)) |
d7b60083 | 2229 | (message "Rolling back %s...done" (vc-delistify files)))) |
0e362f54 | 2230 | |
2765044b DN |
2231 | ;;;###autoload |
2232 | (define-obsolete-function-alias 'vc-revert-buffer 'vc-revert "23.1") | |
2233 | ||
2234 | ;;;###autoload | |
2235 | (defun vc-update () | |
ac3f4c6f | 2236 | "Update the current fileset's files to their tip revisions. |
a7192ddb SM |
2237 | For each one that contains no changes, and is not locked, then this simply |
2238 | replaces the work file with the latest revision on its branch. If the file | |
2239 | contains changes, and the backend supports merging news, then any recent | |
d7b60083 | 2240 | changes from the current branch are merged into the working file." |
2765044b | 2241 | (interactive) |
ae67f2d0 | 2242 | (let* ((vc-fileset (vc-deduce-fileset)) |
86048828 | 2243 | (backend (car vc-fileset)) |
6986e5c9 | 2244 | (files (cadr vc-fileset))) |
ae67f2d0 DN |
2245 | (dolist (file files) |
2246 | (when (let ((buf (get-file-buffer file))) | |
2247 | (and buf (buffer-modified-p buf))) | |
2248 | (error "Please kill or save all modified buffers before updating.")) | |
2249 | (if (vc-up-to-date-p file) | |
2250 | (vc-checkout file nil t) | |
70e2f6c7 | 2251 | (if (eq (vc-checkout-model backend (list file)) 'locking) |
ae67f2d0 DN |
2252 | (if (eq (vc-state file) 'edited) |
2253 | (error "%s" | |
2254 | (substitute-command-keys | |
2255 | "File is locked--type \\[vc-revert] to discard changes")) | |
2256 | (error "Unexpected file state (%s) -- type %s" | |
2257 | (vc-state file) | |
1f325d92 | 2258 | (substitute-command-keys |
ae67f2d0 | 2259 | "\\[vc-next-action] to correct"))) |
a749e19d SM |
2260 | (vc-maybe-resolve-conflicts |
2261 | file (vc-call-backend backend 'merge-news file))))))) | |
2765044b DN |
2262 | |
2263 | (defun vc-version-backup-file (file &optional rev) | |
2264 | "Return name of backup file for revision REV of FILE. | |
2265 | If version backups should be used for FILE, and there exists | |
a7192ddb | 2266 | such a backup for REV or the working revision of file, return |
0d0e9356 | 2267 | its name; otherwise return nil." |
2765044b DN |
2268 | (when (vc-call make-version-backups-p file) |
2269 | (let ((backup-file (vc-version-backup-file-name file rev))) | |
2270 | (if (file-exists-p backup-file) | |
2271 | backup-file | |
2272 | ;; there is no automatic backup, but maybe the user made one manually | |
2273 | (setq backup-file (vc-version-backup-file-name file rev 'manual)) | |
b5446276 DN |
2274 | (when (file-exists-p backup-file) |
2275 | backup-file))))) | |
2765044b DN |
2276 | |
2277 | (defun vc-revert-file (file) | |
ac3f4c6f | 2278 | "Revert FILE back to the repository working revision it was based on." |
2765044b | 2279 | (with-vc-properties |
d7b60083 | 2280 | (list file) |
2765044b DN |
2281 | (let ((backup-file (vc-version-backup-file file))) |
2282 | (when backup-file | |
2283 | (copy-file backup-file file 'ok-if-already-exists 'keep-date) | |
2284 | (vc-delete-automatic-version-backups file)) | |
2285 | (vc-call revert file backup-file)) | |
2286 | `((vc-state . up-to-date) | |
2287 | (vc-checkout-time . ,(nth 5 (file-attributes file))))) | |
2288 | (vc-resynch-buffer file t t)) | |
2289 | ||
76e5906d | 2290 | ;;;###autoload |
1d502d5a | 2291 | (defun vc-switch-backend (file backend) |
7849e179 | 2292 | "Make BACKEND the current version control system for FILE. |
1d502d5a AS |
2293 | FILE must already be registered in BACKEND. The change is not |
2294 | permanent, only for the current session. This function only changes | |
7849e179 SM |
2295 | VC's perspective on FILE, it does not register or unregister it. |
2296 | By default, this command cycles through the registered backends. | |
2297 | To get a prompt, use a prefix argument." | |
2298 | (interactive | |
1d502d5a | 2299 | (list |
94ca88e3 AS |
2300 | (or buffer-file-name |
2301 | (error "There is no version-controlled file in this buffer")) | |
7849e179 SM |
2302 | (let ((backend (vc-backend buffer-file-name)) |
2303 | (backends nil)) | |
d7b60083 ER |
2304 | (unless backend |
2305 | (error "File %s is not under version control" buffer-file-name)) | |
2306 | ;; Find the registered backends. | |
2307 | (dolist (backend vc-handled-backends) | |
2308 | (when (vc-call-backend backend 'registered buffer-file-name) | |
2309 | (push backend backends))) | |
2310 | ;; Find the next backend. | |
2311 | (let ((def (car (delq backend (append (memq backend backends) backends)))) | |
2312 | (others (delete backend backends))) | |
2313 | (cond | |
2314 | ((null others) (error "No other backend to switch to")) | |
2315 | (current-prefix-arg | |
2316 | (intern | |
2317 | (upcase | |
2318 | (completing-read | |
2319 | (format "Switch to backend [%s]: " def) | |
2320 | (mapcar (lambda (b) (list (downcase (symbol-name b)))) backends) | |
2321 | nil t nil nil (downcase (symbol-name def)))))) | |
2322 | (t def)))))) | |
ceec5a0c | 2323 | (unless (eq backend (vc-backend file)) |
ceec5a0c SM |
2324 | (vc-file-clearprops file) |
2325 | (vc-file-setprop file 'vc-backend backend) | |
2326 | ;; Force recomputation of the state | |
a3255400 SM |
2327 | (unless (vc-call-backend backend 'registered file) |
2328 | (vc-file-clearprops file) | |
2329 | (error "%s is not registered in %s" file backend)) | |
ceec5a0c | 2330 | (vc-mode-line file))) |
1d502d5a | 2331 | |
21b50296 | 2332 | ;;;###autoload |
1d502d5a | 2333 | (defun vc-transfer-file (file new-backend) |
ceec5a0c | 2334 | "Transfer FILE to another version control system NEW-BACKEND. |
1d502d5a | 2335 | If NEW-BACKEND has a higher precedence than FILE's current backend |
ceec5a0c | 2336 | \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in |
ac3f4c6f | 2337 | NEW-BACKEND, using the revision number from the current backend as the |
1d502d5a AS |
2338 | base level. If NEW-BACKEND has a lower precedence than the current |
2339 | backend, then commit all changes that were made under the current | |
2340 | backend to NEW-BACKEND, and unregister FILE from the current backend. | |
2341 | \(If FILE is not yet registered under NEW-BACKEND, register it.)" | |
72cfc5fb AS |
2342 | (let* ((old-backend (vc-backend file)) |
2343 | (edited (memq (vc-state file) '(edited needs-merge))) | |
2344 | (registered (vc-call-backend new-backend 'registered file)) | |
2345 | (move | |
2346 | (and registered ; Never move if not registered in new-backend yet. | |
2347 | ;; move if new-backend comes later in vc-handled-backends | |
2348 | (or (memq new-backend (memq old-backend vc-handled-backends)) | |
ffda0460 | 2349 | (y-or-n-p "Final transfer? ")))) |
72cfc5fb | 2350 | (comment nil)) |
ae67f2d0 DN |
2351 | (when (eq old-backend new-backend) |
2352 | (error "%s is the current backend of %s" new-backend file)) | |
72cfc5fb AS |
2353 | (if registered |
2354 | (set-file-modes file (logior (file-modes file) 128)) | |
2355 | ;; `registered' might have switched under us. | |
2356 | (vc-switch-backend file old-backend) | |
ac3f4c6f | 2357 | (let* ((rev (vc-working-revision file)) |
c1b1b393 | 2358 | (modified-file (and edited (make-temp-file file))) |
ffda0460 | 2359 | (unmodified-file (and modified-file (vc-version-backup-file file)))) |
72cfc5fb AS |
2360 | ;; Go back to the base unmodified file. |
2361 | (unwind-protect | |
2362 | (progn | |
ffda0460 | 2363 | (when modified-file |
c1b1b393 | 2364 | (copy-file file modified-file 'ok-if-already-exists) |
ffda0460 AS |
2365 | ;; If we have a local copy of the unmodified file, handle that |
2366 | ;; here and not in vc-revert-file because we don't want to | |
2367 | ;; delete that copy -- it is still useful for OLD-BACKEND. | |
2368 | (if unmodified-file | |
b4e4e3a8 SM |
2369 | (copy-file unmodified-file file |
2370 | 'ok-if-already-exists 'keep-date) | |
ae67f2d0 DN |
2371 | (when (y-or-n-p "Get base revision from master? ") |
2372 | (vc-revert-file file)))) | |
72cfc5fb | 2373 | (vc-call-backend new-backend 'receive-file file rev)) |
ffda0460 | 2374 | (when modified-file |
72cfc5fb | 2375 | (vc-switch-backend file new-backend) |
70e2f6c7 | 2376 | (unless (eq (vc-checkout-model new-backend (list file)) 'implicit) |
72cfc5fb | 2377 | (vc-checkout file t nil)) |
ffda0460 AS |
2378 | (rename-file modified-file file 'ok-if-already-exists) |
2379 | (vc-file-setprop file 'vc-checkout-time nil))))) | |
72cfc5fb AS |
2380 | (when move |
2381 | (vc-switch-backend file old-backend) | |
a749e19d SM |
2382 | (setq comment (vc-call-backend old-backend 'comment-history file)) |
2383 | (vc-call-backend old-backend 'unregister file)) | |
72cfc5fb AS |
2384 | (vc-switch-backend file new-backend) |
2385 | (when (or move edited) | |
1d502d5a | 2386 | (vc-file-setprop file 'vc-state 'edited) |
ffda0460 | 2387 | (vc-mode-line file) |
0ab66291 | 2388 | (vc-checkin file nil comment (stringp comment))))) |
1d502d5a | 2389 | |
0e362f54 GM |
2390 | (defun vc-rename-master (oldmaster newfile templates) |
2391 | "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES." | |
2392 | (let* ((dir (file-name-directory (expand-file-name oldmaster))) | |
2393 | (newdir (or (file-name-directory newfile) "")) | |
2394 | (newbase (file-name-nondirectory newfile)) | |
2395 | (masters | |
2396 | ;; List of potential master files for `newfile' | |
2397 | (mapcar | |
2398 | (lambda (s) (vc-possible-master s newdir newbase)) | |
2399 | templates))) | |
b5446276 DN |
2400 | (when (or (file-symlink-p oldmaster) |
2401 | (file-symlink-p (file-name-directory oldmaster))) | |
2402 | (error "This is unsafe in the presence of symbolic links")) | |
0e362f54 GM |
2403 | (rename-file |
2404 | oldmaster | |
2405 | (catch 'found | |
2406 | ;; If possible, keep the master file in the same directory. | |
b4e4e3a8 | 2407 | (dolist (f masters) |
ae67f2d0 DN |
2408 | (when (and f (string= (file-name-directory (expand-file-name f)) dir)) |
2409 | (throw 'found f))) | |
0e362f54 | 2410 | ;; If not, just use the first possible place. |
b4e4e3a8 SM |
2411 | (dolist (f masters) |
2412 | (and f (or (not (setq dir (file-name-directory f))) | |
2413 | (file-directory-p dir)) | |
2414 | (throw 'found f))) | |
0e362f54 | 2415 | (error "New file lacks a version control directory"))))) |
594722a8 | 2416 | |
a36319a4 SM |
2417 | (defun vc-delete-file (file) |
2418 | "Delete file and mark it as such in the version control system." | |
2419 | (interactive "fVC delete file: ") | |
484c3092 | 2420 | (setq file (expand-file-name file)) |
c6e44350 AS |
2421 | (let ((buf (get-file-buffer file)) |
2422 | (backend (vc-backend file))) | |
2423 | (unless backend | |
86a65190 | 2424 | (error "File %s is not under version control" |
c6e44350 | 2425 | (file-name-nondirectory file))) |
a36319a4 | 2426 | (unless (vc-find-backend-function backend 'delete-file) |
c6e44350 | 2427 | (error "Deleting files under %s is not supported in VC" backend)) |
b5446276 | 2428 | (when (and buf (buffer-modified-p buf)) |
a84615c7 SS |
2429 | (error "Please save or undo your changes before deleting %s" file)) |
2430 | (let ((state (vc-state file))) | |
2431 | (when (eq state 'edited) | |
2432 | (error "Please commit or undo your changes before deleting %s" file)) | |
2433 | (when (eq state 'conflict) | |
2434 | (error "Please resolve the conflicts before deleting %s" file))) | |
ce5a3ac0 | 2435 | (unless (y-or-n-p (format "Really want to delete %s? " |
a36319a4 SM |
2436 | (file-name-nondirectory file))) |
2437 | (error "Abort!")) | |
775237d3 SS |
2438 | (unless (or (file-directory-p file) (null make-backup-files) |
2439 | (not (file-exists-p file))) | |
a36319a4 SM |
2440 | (with-current-buffer (or buf (find-file-noselect file)) |
2441 | (let ((backup-inhibited nil)) | |
ee91bfdf | 2442 | (backup-buffer)))) |
a749e19d | 2443 | (vc-call-backend backend 'delete-file file) |
a36319a4 | 2444 | ;; If the backend hasn't deleted the file itself, let's do it for him. |
b5446276 | 2445 | (when (file-exists-p file) (delete-file file)) |
484c3092 DN |
2446 | ;; Forget what VC knew about the file. |
2447 | (vc-file-clearprops file) | |
ee91bfdf SM |
2448 | ;; Since we've deleted the file and we've made sure the buffer had no |
2449 | ;; unsaved changes, we can kill the buffer. Much easier than trying to | |
2450 | ;; properly refresh its VC state. | |
2451 | (when buf (kill-buffer buf)))) | |
a36319a4 | 2452 | |
29fc1ce9 | 2453 | ;;;###autoload |
594722a8 | 2454 | (defun vc-rename-file (old new) |
34291cd2 RS |
2455 | "Rename file OLD to NEW, and rename its master file likewise." |
2456 | (interactive "fVC rename file: \nFRename to: ") | |
a36319a4 | 2457 | (let ((oldbuf (get-file-buffer old))) |
b5446276 DN |
2458 | (when (and oldbuf (buffer-modified-p oldbuf)) |
2459 | (error "Please save files before moving them")) | |
2460 | (when (get-file-buffer new) | |
2461 | (error "Already editing new file name")) | |
2462 | (when (file-exists-p new) | |
2463 | (error "New file already exists")) | |
86a65190 | 2464 | (let ((state (vc-state old))) |
a36319a4 SM |
2465 | (unless (memq state '(up-to-date edited)) |
2466 | (error "Please %s files before moving them" | |
2467 | (if (stringp state) "check in" "update")))) | |
2468 | (vc-call rename-file old new) | |
b4e4e3a8 | 2469 | (vc-file-clearprops old) |
0e362f54 | 2470 | ;; Move the actual file (unless the backend did it already) |
b5446276 | 2471 | (when (file-exists-p old) (rename-file old new)) |
0e362f54 GM |
2472 | ;; ?? Renaming a file might change its contents due to keyword expansion. |
2473 | ;; We should really check out a new copy if the old copy was precisely equal | |
ac3f4c6f | 2474 | ;; to some checked-in revision. However, testing for this is tricky.... |
b5446276 DN |
2475 | (when oldbuf |
2476 | (with-current-buffer oldbuf | |
2477 | (let ((buffer-read-only buffer-read-only)) | |
2478 | (set-visited-file-name new)) | |
2479 | (vc-backend new) | |
2480 | (vc-mode-line new) | |
2481 | (set-buffer-modified-p nil))))) | |
0e362f54 | 2482 | |
637a8ae9 | 2483 | ;;;###autoload |
f35ecf88 | 2484 | (defun vc-update-change-log (&rest args) |
0e362f54 | 2485 | "Find change log file and add entries from recent version control logs. |
d68e6990 | 2486 | Normally, find log entries for all registered files in the default |
0e362f54 | 2487 | directory. |
d68e6990 | 2488 | |
099bd78a | 2489 | With prefix arg of \\[universal-argument], only find log entries for the current buffer's file. |
d68e6990 RS |
2490 | |
2491 | With any numeric prefix arg, find log entries for all currently visited | |
2492 | files that are under version control. This puts all the entries in the | |
2493 | log for the default directory, which may not be appropriate. | |
2494 | ||
099bd78a | 2495 | From a program, any ARGS are assumed to be filenames for which |
0e362f54 | 2496 | log entries should be gathered." |
67242a23 RM |
2497 | (interactive |
2498 | (cond ((consp current-prefix-arg) ;C-u | |
2499 | (list buffer-file-name)) | |
2500 | (current-prefix-arg ;Numeric argument. | |
2501 | (let ((files nil) | |
2502 | (buffers (buffer-list)) | |
2503 | file) | |
2504 | (while buffers | |
2505 | (setq file (buffer-file-name (car buffers))) | |
f3c61d82 | 2506 | (and file (vc-backend file) |
4b40fdea | 2507 | (setq files (cons file files))) |
67242a23 | 2508 | (setq buffers (cdr buffers))) |
4b40fdea PE |
2509 | files)) |
2510 | (t | |
0e362f54 GM |
2511 | ;; Don't supply any filenames to backend; this means |
2512 | ;; it should find all relevant files relative to | |
2513 | ;; the default-directory. | |
73a9679c | 2514 | nil))) |
0e362f54 GM |
2515 | (vc-call-backend (vc-responsible-backend default-directory) |
2516 | 'update-changelog args)) | |
2517 | ||
ac3f4c6f | 2518 | ;;; The default back end. Assumes RCS-like revision numbering. |
61de26cb ER |
2519 | |
2520 | (defun vc-default-revision-granularity () | |
2521 | (error "Your backend will not work with this version of VC mode.")) | |
2522 | ||
2765044b DN |
2523 | ;; functions that operate on RCS revision numbers. This code should |
2524 | ;; also be moved into the backends. It stays for now, however, since | |
2525 | ;; it is used in code below. | |
2526 | ;;;###autoload | |
2527 | (defun vc-trunk-p (rev) | |
2528 | "Return t if REV is a revision on the trunk." | |
2529 | (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev)))) | |
2530 | ||
2531 | (defun vc-branch-p (rev) | |
2532 | "Return t if REV is a branch revision." | |
2533 | (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev)))) | |
2534 | ||
2535 | ;;;###autoload | |
2536 | (defun vc-branch-part (rev) | |
2537 | "Return the branch part of a revision number REV." | |
2538 | (let ((index (string-match "\\.[0-9]+\\'" rev))) | |
b5446276 DN |
2539 | (when index |
2540 | (substring rev 0 index)))) | |
2765044b DN |
2541 | |
2542 | (defun vc-minor-part (rev) | |
ac3f4c6f | 2543 | "Return the minor revision number of a revision number REV." |
2765044b DN |
2544 | (string-match "[0-9]+\\'" rev) |
2545 | (substring rev (match-beginning 0) (match-end 0))) | |
2546 | ||
ac3f4c6f ER |
2547 | (defun vc-default-previous-revision (backend file rev) |
2548 | "Return the revision number immediately preceding REV for FILE, | |
2549 | or nil if there is no previous revision. This default | |
2550 | implementation works for MAJOR.MINOR-style revision numbers as | |
2765044b DN |
2551 | used by RCS and CVS." |
2552 | (let ((branch (vc-branch-part rev)) | |
2553 | (minor-num (string-to-number (vc-minor-part rev)))) | |
2554 | (when branch | |
2555 | (if (> minor-num 1) | |
ac3f4c6f | 2556 | ;; revision does probably not start a branch or release |
2765044b DN |
2557 | (concat branch "." (number-to-string (1- minor-num))) |
2558 | (if (vc-trunk-p rev) | |
2559 | ;; we are at the beginning of the trunk -- | |
2560 | ;; don't know anything to return here | |
2561 | nil | |
2562 | ;; we are at the beginning of a branch -- | |
ac3f4c6f | 2563 | ;; return revision of starting point |
2765044b DN |
2564 | (vc-branch-part branch)))))) |
2565 | ||
ac3f4c6f ER |
2566 | (defun vc-default-next-revision (backend file rev) |
2567 | "Return the revision number immediately following REV for FILE, | |
2568 | or nil if there is no next revision. This default implementation | |
2569 | works for MAJOR.MINOR-style revision numbers as used by RCS | |
2765044b | 2570 | and CVS." |
ac3f4c6f | 2571 | (when (not (string= rev (vc-working-revision file))) |
2765044b DN |
2572 | (let ((branch (vc-branch-part rev)) |
2573 | (minor-num (string-to-number (vc-minor-part rev)))) | |
2574 | (concat branch "." (number-to-string (1+ minor-num)))))) | |
2575 | ||
2576 | (defun vc-default-responsible-p (backend file) | |
2577 | "Indicate whether BACKEND is reponsible for FILE. | |
2578 | The default is to return nil always." | |
2579 | nil) | |
2580 | ||
2581 | (defun vc-default-could-register (backend file) | |
2582 | "Return non-nil if BACKEND could be used to register FILE. | |
2583 | The default implementation returns t for all files." | |
2584 | t) | |
2585 | ||
2586 | (defun vc-default-latest-on-branch-p (backend file) | |
2587 | "Return non-nil if FILE is the latest on its branch. | |
2588 | This default implementation always returns non-nil, which means that | |
ac3f4c6f | 2589 | editing non-current revisions is not supported by default." |
2765044b DN |
2590 | t) |
2591 | ||
ac3f4c6f | 2592 | (defun vc-default-init-revision (backend) vc-default-init-revision) |
2765044b | 2593 | |
45fd3a00 SM |
2594 | (defalias 'vc-cvs-update-changelog 'vc-update-changelog-rcs2log) |
2595 | (defalias 'vc-rcs-update-changelog 'vc-update-changelog-rcs2log) | |
2596 | ;; FIXME: This should probably be moved to vc-rcs.el and replaced in | |
2597 | ;; vc-cvs.el by code using cvs2cl. | |
0b8dce84 | 2598 | (defun vc-update-changelog-rcs2log (files) |
099bd78a SM |
2599 | "Default implementation of update-changelog. |
2600 | Uses `rcs2log' which only works for RCS and CVS." | |
0e362f54 | 2601 | ;; FIXME: We (c|sh)ould add support for cvs2cl |
449decf5 | 2602 | (let ((odefault default-directory) |
124c852b RS |
2603 | (changelog (find-change-log)) |
2604 | ;; Presumably not portable to non-Unixy systems, along with rcs2log: | |
c1b1b393 | 2605 | (tempfile (make-temp-file |
57c298c4 EZ |
2606 | (expand-file-name "vc" |
2607 | (or small-temporary-file-directory | |
2608 | temporary-file-directory)))) | |
510f6466 AS |
2609 | (login-name (or user-login-name |
2610 | (format "uid%d" (number-to-string (user-uid))))) | |
b91916f3 | 2611 | (full-name (or add-log-full-name |
8172cd86 AS |
2612 | (user-full-name) |
2613 | (user-login-name) | |
2614 | (format "uid%d" (number-to-string (user-uid))))) | |
b91916f3 RS |
2615 | (mailing-address (or add-log-mailing-address |
2616 | user-mail-address))) | |
124c852b | 2617 | (find-file-other-window changelog) |
41dfb835 RS |
2618 | (barf-if-buffer-read-only) |
2619 | (vc-buffer-sync) | |
2620 | (undo-boundary) | |
2621 | (goto-char (point-min)) | |
2622 | (push-mark) | |
2623 | (message "Computing change log entries...") | |
4b40fdea | 2624 | (message "Computing change log entries... %s" |
124c852b RS |
2625 | (unwind-protect |
2626 | (progn | |
0e362f54 | 2627 | (setq default-directory odefault) |
6f41eeb5 DL |
2628 | (if (eq 0 (apply 'call-process |
2629 | (expand-file-name "rcs2log" | |
2630 | exec-directory) | |
0e362f54 GM |
2631 | nil (list t tempfile) nil |
2632 | "-c" changelog | |
510f6466 | 2633 | "-u" (concat login-name |
0e362f54 GM |
2634 | "\t" full-name |
2635 | "\t" mailing-address) | |
2636 | (mapcar | |
2637 | (lambda (f) | |
2638 | (file-relative-name | |
d7b60083 | 2639 | (expand-file-name f odefault))) |
0e362f54 GM |
2640 | files))) |
2641 | "done" | |
04864eb0 | 2642 | (pop-to-buffer (get-buffer-create "*vc*")) |
124c852b | 2643 | (erase-buffer) |
54ebae28 | 2644 | (insert-file-contents tempfile) |
124c852b | 2645 | "failed")) |
0e362f54 | 2646 | (setq default-directory (file-name-directory changelog)) |
124c852b | 2647 | (delete-file tempfile))))) |
7d2d9482 | 2648 | |
ac3f4c6f ER |
2649 | (defun vc-default-find-revision (backend file rev buffer) |
2650 | "Provide the new `find-revision' op based on the old `checkout' op. | |
2765044b | 2651 | This is only for compatibility with old backends. They should be updated |
ac3f4c6f | 2652 | to provide the `find-revision' operation instead." |
2765044b DN |
2653 | (let ((tmpfile (make-temp-file (expand-file-name file)))) |
2654 | (unwind-protect | |
2655 | (progn | |
2656 | (vc-call-backend backend 'checkout file nil rev tmpfile) | |
2657 | (with-current-buffer buffer | |
2658 | (insert-file-contents-literally tmpfile))) | |
2659 | (delete-file tmpfile)))) | |
2660 | ||
0a299408 | 2661 | (defun vc-default-prettify-state-info (backend file) |
d7b60083 ER |
2662 | (let* ((state (vc-state file)) |
2663 | (statestring | |
2664 | (cond | |
7c2ec3f9 | 2665 | ((stringp state) (concat "(locked:" state ")")) |
45b24b4d | 2666 | ((eq state 'edited) "(modified)") |
d7b60083 | 2667 | ((eq state 'needs-merge) "(merge)") |
3702367b | 2668 | ((eq state 'needs-update) "(update)") |
0f67cc71 | 2669 | ((eq state 'added) "(added)") |
484c1b1f | 2670 | ((eq state 'removed) "(removed)") |
e6244c1b | 2671 | ((eq state 'ignored) "(ignored)") |
7c2ec3f9 | 2672 | ((eq state 'unregistered) "(unregistered)") |
722f037f | 2673 | ((eq state 'unlocked-changes) "(stale)") |
7c2ec3f9 | 2674 | (t (concat "(unknown:" state ")")))) |
d7b60083 ER |
2675 | (buffer |
2676 | (get-file-buffer file)) | |
2677 | (modflag | |
2678 | (if (and buffer (buffer-modified-p buffer)) "+" ""))) | |
2679 | (concat statestring modflag))) | |
2765044b DN |
2680 | |
2681 | (defun vc-default-rename-file (backend old new) | |
2682 | (condition-case nil | |
2683 | (add-name-to-file old new) | |
2684 | (error (rename-file old new))) | |
2685 | (vc-delete-file old) | |
2686 | (with-current-buffer (find-file-noselect new) | |
2687 | (vc-register))) | |
2688 | ||
17f3909f | 2689 | (defalias 'vc-default-check-headers 'ignore) |
2765044b DN |
2690 | |
2691 | (defun vc-default-log-view-mode (backend) (log-view-mode)) | |
2692 | ||
2693 | (defun vc-default-show-log-entry (backend rev) | |
2694 | (with-no-warnings | |
2695 | (log-view-goto-rev rev))) | |
2696 | ||
2697 | (defun vc-default-comment-history (backend file) | |
2698 | "Return a string with all log entries stored in BACKEND for FILE." | |
7fbb4797 DN |
2699 | (when (vc-find-backend-function backend 'print-log) |
2700 | (with-current-buffer "*vc*" | |
a749e19d | 2701 | (vc-call-backend backend 'print-log (list file)) |
7fbb4797 | 2702 | (buffer-string)))) |
2765044b | 2703 | |
2765044b DN |
2704 | (defun vc-default-receive-file (backend file rev) |
2705 | "Let BACKEND receive FILE from another version control system." | |
2706 | (vc-call-backend backend 'register file rev "")) | |
2707 | ||
370fded4 | 2708 | (defun vc-default-retrieve-tag (backend dir name update) |
2765044b DN |
2709 | (if (string= name "") |
2710 | (progn | |
2711 | (vc-file-tree-walk | |
2712 | dir | |
2713 | (lambda (f) (and | |
2714 | (vc-up-to-date-p f) | |
2715 | (vc-error-occurred | |
a749e19d | 2716 | (vc-call-backend backend 'checkout f nil "") |
b5446276 | 2717 | (when update (vc-resynch-buffer f t t))))))) |
370fded4 | 2718 | (let ((result (vc-tag-precondition dir))) |
2765044b DN |
2719 | (if (stringp result) |
2720 | (error "File %s is locked" result) | |
2721 | (setq update (and (eq result 'visited) update)) | |
2722 | (vc-file-tree-walk | |
2723 | dir | |
2724 | (lambda (f) (vc-error-occurred | |
a749e19d | 2725 | (vc-call-backend backend 'checkout f nil name) |
b5446276 | 2726 | (when update (vc-resynch-buffer f t t))))))))) |
2765044b DN |
2727 | |
2728 | (defun vc-default-revert (backend file contents-done) | |
2729 | (unless contents-done | |
ac3f4c6f | 2730 | (let ((rev (vc-working-revision file)) |
2765044b DN |
2731 | (file-buffer (or (get-file-buffer file) (current-buffer)))) |
2732 | (message "Checking out %s..." file) | |
2733 | (let ((failed t) | |
2734 | (backup-name (car (find-backup-file-name file)))) | |
2735 | (when backup-name | |
2736 | (copy-file file backup-name 'ok-if-already-exists 'keep-date) | |
2737 | (unless (file-writable-p file) | |
2738 | (set-file-modes file (logior (file-modes file) 128)))) | |
2739 | (unwind-protect | |
2740 | (let ((coding-system-for-read 'no-conversion) | |
2741 | (coding-system-for-write 'no-conversion)) | |
2742 | (with-temp-file file | |
2743 | (let ((outbuf (current-buffer))) | |
2744 | ;; Change buffer to get local value of vc-checkout-switches. | |
2745 | (with-current-buffer file-buffer | |
2746 | (let ((default-directory (file-name-directory file))) | |
a749e19d SM |
2747 | (vc-call-backend backend 'find-revision |
2748 | file rev outbuf))))) | |
2765044b DN |
2749 | (setq failed nil)) |
2750 | (when backup-name | |
2751 | (if failed | |
2752 | (rename-file backup-name file 'ok-if-already-exists) | |
2753 | (and (not vc-make-backup-files) (delete-file backup-name)))))) | |
2754 | (message "Checking out %s...done" file)))) | |
2755 | ||
17f3909f | 2756 | (defalias 'vc-default-revision-completion-table 'ignore) |
2765044b | 2757 | |
fb0ac090 AJ |
2758 | (defun vc-default-dir-status-files (backend dir files default-state update-function) |
2759 | (funcall update-function | |
2760 | (mapcar (lambda (file) (list file default-state)) files))) | |
2761 | ||
2765044b DN |
2762 | (defun vc-check-headers () |
2763 | "Check if the current file has any headers in it." | |
2764 | (interactive) | |
2765 | (vc-call-backend (vc-backend buffer-file-name) 'check-headers)) | |
2766 | ||
2767 | ;;; Annotate functionality | |
7d2d9482 | 2768 | |
f80f7bc2 RS |
2769 | ;; Declare globally instead of additional parameter to |
2770 | ;; temp-buffer-show-function (not possible to pass more than one | |
75665141 AS |
2771 | ;; parameter). The use of annotate-ratio is deprecated in favor of |
2772 | ;; annotate-mode, which replaces it with the more sensible "span-to | |
2773 | ;; days", along with autoscaling support. | |
099bd78a | 2774 | (defvar vc-annotate-ratio nil "Global variable.") |
0e362f54 | 2775 | |
1b5a7343 | 2776 | ;; internal buffer-local variables |
04864eb0 | 2777 | (defvar vc-annotate-backend nil) |
1b5a7343 AS |
2778 | (defvar vc-annotate-parent-file nil) |
2779 | (defvar vc-annotate-parent-rev nil) | |
2780 | (defvar vc-annotate-parent-display-mode nil) | |
1b5a7343 | 2781 | |
f66a6225 SM |
2782 | (defconst vc-annotate-font-lock-keywords |
2783 | ;; The fontification is done by vc-annotate-lines instead of font-lock. | |
2784 | '((vc-annotate-lines))) | |
2785 | ||
93113211 | 2786 | (define-derived-mode vc-annotate-mode fundamental-mode "Annotate" |
6f1ecae4 | 2787 | "Major mode for output buffers of the `vc-annotate' command. |
7d2d9482 RS |
2788 | |
2789 | You can use the mode-specific menu to alter the time-span of the used | |
2790 | colors. See variable `vc-annotate-menu-elements' for customizing the | |
2791 | menu items." | |
5731a8e0 TTN |
2792 | ;; Frob buffer-invisibility-spec so that if it is originally a naked t, |
2793 | ;; it will become a list, to avoid initial annotations being invisible. | |
2794 | (add-to-invisibility-spec 'foo) | |
2795 | (remove-from-invisibility-spec 'foo) | |
f66a6225 SM |
2796 | (set (make-local-variable 'truncate-lines) t) |
2797 | (set (make-local-variable 'font-lock-defaults) | |
2798 | '(vc-annotate-font-lock-keywords t)) | |
04864eb0 | 2799 | (view-mode 1)) |
7d2d9482 | 2800 | |
5731a8e0 TTN |
2801 | (defun vc-annotate-toggle-annotation-visibility () |
2802 | "Toggle whether or not the annotation is visible." | |
2803 | (interactive) | |
2804 | (funcall (if (memq 'vc-annotate-annotation buffer-invisibility-spec) | |
2805 | 'remove-from-invisibility-spec | |
2806 | 'add-to-invisibility-spec) | |
2807 | 'vc-annotate-annotation) | |
2808 | (force-window-update (current-buffer))) | |
2809 | ||
97461c84 | 2810 | (defun vc-annotate-display-default (ratio) |
6f1ecae4 | 2811 | "Display the output of \\[vc-annotate] using the default color range. |
97461c84 SM |
2812 | The color range is given by `vc-annotate-color-map', scaled by RATIO. |
2813 | The current time is used as the offset." | |
2814 | (interactive (progn (kill-local-variable 'vc-annotate-color-map) '(1.0))) | |
f80f7bc2 | 2815 | (message "Redisplaying annotation...") |
97461c84 | 2816 | (vc-annotate-display ratio) |
f80f7bc2 | 2817 | (message "Redisplaying annotation...done")) |
7d2d9482 | 2818 | |
97461c84 SM |
2819 | (defun vc-annotate-oldest-in-map (color-map) |
2820 | "Return the oldest time in the COLOR-MAP." | |
2821 | ;; Since entries should be sorted, we can just use the last one. | |
2822 | (caar (last color-map))) | |
6149bbfb | 2823 | |
5731a8e0 TTN |
2824 | (defun vc-annotate-get-time-set-line-props () |
2825 | (let ((bol (point)) | |
2826 | (date (vc-call-backend vc-annotate-backend 'annotate-time)) | |
2827 | (inhibit-read-only t)) | |
f605fc58 | 2828 | (assert (>= (point) bol)) |
5731a8e0 TTN |
2829 | (put-text-property bol (point) 'invisible 'vc-annotate-annotation) |
2830 | date)) | |
2831 | ||
75665141 | 2832 | (defun vc-annotate-display-autoscale (&optional full) |
946b248f | 2833 | "Highlight the output of \\[vc-annotate] using an autoscaled color map. |
6f1ecae4 | 2834 | Autoscaling means that the map is scaled from the current time to the |
f36e4afe | 2835 | oldest annotation in the buffer, or, with prefix argument FULL, to |
6f1ecae4 | 2836 | cover the range from the oldest annotation to the newest." |
f36e4afe | 2837 | (interactive "P") |
75665141 AS |
2838 | (let ((newest 0.0) |
2839 | (oldest 999999.) ;Any CVS users at the founding of Rome? | |
2840 | (current (vc-annotate-convert-time (current-time))) | |
2841 | date) | |
2842 | (message "Redisplaying annotation...") | |
2843 | ;; Run through this file and find the oldest and newest dates annotated. | |
2844 | (save-excursion | |
2845 | (goto-char (point-min)) | |
7c33af85 | 2846 | (while (not (eobp)) |
5731a8e0 | 2847 | (when (setq date (vc-annotate-get-time-set-line-props)) |
b5446276 DN |
2848 | (when (> date newest) |
2849 | (setq newest date)) | |
2850 | (when (< date oldest) | |
2851 | (setq oldest date))) | |
7c33af85 | 2852 | (forward-line 1))) |
75665141 | 2853 | (vc-annotate-display |
97461c84 SM |
2854 | (/ (- (if full newest current) oldest) |
2855 | (vc-annotate-oldest-in-map vc-annotate-color-map)) | |
75665141 | 2856 | (if full newest)) |
99cb8c8b SS |
2857 | (message "Redisplaying annotation...done \(%s\)" |
2858 | (if full | |
2859 | (format "Spanned from %.1f to %.1f days old" | |
75665141 AS |
2860 | (- current oldest) |
2861 | (- current newest)) | |
2862 | (format "Spanned to %.1f days old" (- current oldest)))))) | |
2863 | ||
2864 | ;; Menu -- Using easymenu.el | |
04864eb0 SM |
2865 | (easy-menu-define vc-annotate-mode-menu vc-annotate-mode-map |
2866 | "VC Annotate Display Menu" | |
2867 | `("VC-Annotate" | |
da7c8a12 | 2868 | ["By Color Map Range" (unless (null vc-annotate-display-mode) |
04864eb0 SM |
2869 | (setq vc-annotate-display-mode nil) |
2870 | (vc-annotate-display-select)) | |
2871 | :style toggle :selected (null vc-annotate-display-mode)] | |
97461c84 | 2872 | ,@(let ((oldest-in-map (vc-annotate-oldest-in-map vc-annotate-color-map))) |
04864eb0 SM |
2873 | (mapcar (lambda (element) |
2874 | (let ((days (* element oldest-in-map))) | |
07a95b81 SM |
2875 | `[,(format "Span %.1f days" days) |
2876 | (vc-annotate-display-select nil ,days) | |
2877 | :style toggle :selected | |
2878 | (eql vc-annotate-display-mode ,days) ])) | |
04864eb0 SM |
2879 | vc-annotate-menu-elements)) |
2880 | ["Span ..." | |
07a95b81 SM |
2881 | (vc-annotate-display-select |
2882 | nil (float (string-to-number (read-string "Span how many days? "))))] | |
04864eb0 SM |
2883 | "--" |
2884 | ["Span to Oldest" | |
2885 | (unless (eq vc-annotate-display-mode 'scale) | |
2886 | (vc-annotate-display-select nil 'scale)) | |
df04e22c | 2887 | :help |
f3ff0fe9 | 2888 | "Use an autoscaled color map from the oldest annotation to the current time" |
04864eb0 SM |
2889 | :style toggle :selected |
2890 | (eq vc-annotate-display-mode 'scale)] | |
2891 | ["Span Oldest->Newest" | |
2892 | (unless (eq vc-annotate-display-mode 'fullscale) | |
2893 | (vc-annotate-display-select nil 'fullscale)) | |
df04e22c | 2894 | :help |
f3ff0fe9 | 2895 | "Use an autoscaled color map from the oldest to the newest annotation" |
04864eb0 SM |
2896 | :style toggle :selected |
2897 | (eq vc-annotate-display-mode 'fullscale)] | |
2898 | "--" | |
f3ff0fe9 | 2899 | ["Toggle annotation visibility" vc-annotate-toggle-annotation-visibility |
df04e22c | 2900 | :help |
f3ff0fe9 DN |
2901 | "Toggle whether the annotation is visible or not"] |
2902 | ["Annotate previous revision" vc-annotate-prev-revision | |
2903 | :help "Visit the annotation of the revision previous to this one"] | |
2904 | ["Annotate next revision" vc-annotate-next-revision | |
2905 | :help "Visit the annotation of the revision after this one"] | |
2906 | ["Annotate revision at line" vc-annotate-revision-at-line | |
df04e22c | 2907 | :help |
f3ff0fe9 DN |
2908 | "Visit the annotation of the revision identified in the current line"] |
2909 | ["Annotate revision previous to line" vc-annotate-revision-previous-to-line | |
2910 | :help "Visit the annotation of the revision before the revision at line"] | |
2911 | ["Annotate latest revision" vc-annotate-working-revision | |
2912 | :help "Visit the annotation of the working revision of this file"] | |
2913 | ["Show log of revision at line" vc-annotate-show-log-revision-at-line | |
2914 | :help "Visit the log of the revision at line"] | |
2915 | ["Show diff of revision at line" vc-annotate-show-diff-revision-at-line | |
df04e22c | 2916 | :help |
f3ff0fe9 DN |
2917 | "Visit the diff of the revision at line from its previous revision"] |
2918 | ["Visit revision at line" vc-annotate-find-revision-at-line | |
2919 | :help "Visit the revision identified in the current line"])) | |
75665141 AS |
2920 | |
2921 | (defun vc-annotate-display-select (&optional buffer mode) | |
6f1ecae4 AS |
2922 | "Highlight the output of \\[vc-annotate]. |
2923 | By default, the current buffer is highlighted, unless overridden by | |
2924 | BUFFER. `vc-annotate-display-mode' specifies the highlighting mode to | |
2925 | use; you may override this using the second optional arg MODE." | |
2926 | (interactive) | |
b5446276 | 2927 | (when mode (setq vc-annotate-display-mode mode)) |
8a8f8697 | 2928 | (pop-to-buffer (or buffer (current-buffer))) |
f66a6225 | 2929 | (cond ((null vc-annotate-display-mode) |
07a95b81 SM |
2930 | ;; The ratio is global, thus relative to the global color-map. |
2931 | (kill-local-variable 'vc-annotate-color-map) | |
97461c84 SM |
2932 | (vc-annotate-display-default (or vc-annotate-ratio 1.0))) |
2933 | ;; One of the auto-scaling modes | |
f66a6225 | 2934 | ((eq vc-annotate-display-mode 'scale) |
7c33af85 | 2935 | (vc-exec-after `(vc-annotate-display-autoscale))) |
f66a6225 | 2936 | ((eq vc-annotate-display-mode 'fullscale) |
7c33af85 | 2937 | (vc-exec-after `(vc-annotate-display-autoscale t))) |
75665141 AS |
2938 | ((numberp vc-annotate-display-mode) ; A fixed number of days lookback |
2939 | (vc-annotate-display-default | |
97461c84 SM |
2940 | (/ vc-annotate-display-mode |
2941 | (vc-annotate-oldest-in-map vc-annotate-color-map)))) | |
f66a6225 SM |
2942 | (t (error "No such display mode: %s" |
2943 | vc-annotate-display-mode)))) | |
0e362f54 | 2944 | |
7d2d9482 | 2945 | ;;;###autoload |
bae9f9e3 | 2946 | (defun vc-annotate (file rev &optional display-mode buf move-point-to) |
aa406465 | 2947 | "Display the edit history of the current file using colors. |
1cec418c AS |
2948 | |
2949 | This command creates a buffer that shows, for each line of the current | |
aa406465 | 2950 | file, when it was last edited and by whom. Additionally, colors are |
1cec418c | 2951 | used to show the age of each line--blue means oldest, red means |
aa406465 | 2952 | youngest, and intermediate colors indicate intermediate ages. By |
1cec418c AS |
2953 | default, the time scale stretches back one year into the past; |
2954 | everything that is older than that is shown in blue. | |
2955 | ||
2956 | With a prefix argument, this command asks two questions in the | |
ac3f4c6f ER |
2957 | minibuffer. First, you may enter a revision number; then the buffer |
2958 | displays and annotates that revision instead of the working revision | |
eb407e67 | 2959 | \(type RET in the minibuffer to leave that default unchanged). Then, |
ecd50f65 AS |
2960 | you are prompted for the time span in days which the color range |
2961 | should cover. For example, a time span of 20 days means that changes | |
2962 | over the past 20 days are shown in red to blue, according to their | |
2963 | age, and everything that is older than that is shown in blue. | |
1cec418c | 2964 | |
bae9f9e3 DN |
2965 | If MOVE-POINT-TO is given, move the point to that line. |
2966 | ||
1cec418c | 2967 | Customization variables: |
7d2d9482 RS |
2968 | |
2969 | `vc-annotate-menu-elements' customizes the menu elements of the | |
a7192ddb SM |
2970 | mode-specific menu. `vc-annotate-color-map' and |
2971 | `vc-annotate-very-old-color' define the mapping of time to colors. | |
2972 | `vc-annotate-background' specifies the background color." | |
04864eb0 SM |
2973 | (interactive |
2974 | (save-current-buffer | |
2975 | (vc-ensure-vc-buffer) | |
2976 | (list buffer-file-name | |
ac3f4c6f | 2977 | (let ((def (vc-working-revision buffer-file-name))) |
04864eb0 SM |
2978 | (if (null current-prefix-arg) def |
2979 | (read-string | |
ac3f4c6f | 2980 | (format "Annotate from revision (default %s): " def) |
04864eb0 SM |
2981 | nil nil def))) |
2982 | (if (null current-prefix-arg) | |
2983 | vc-annotate-display-mode | |
2984 | (float (string-to-number | |
2985 | (read-string "Annotate span days (default 20): " | |
2986 | nil nil "20"))))))) | |
b6909007 | 2987 | (vc-ensure-vc-buffer) |
04864eb0 SM |
2988 | (setq vc-annotate-display-mode display-mode) ;Not sure why. --Stef |
2989 | (let* ((temp-buffer-name (format "*Annotate %s (rev %s)*" (buffer-name) rev)) | |
1867d8cb TTN |
2990 | (temp-buffer-show-function 'vc-annotate-display-select) |
2991 | ;; If BUF is specified, we presume the caller maintains current line, | |
2992 | ;; so we don't need to do it here. This implementation may give | |
2993 | ;; strange results occasionally in the case of REV != WORKFILE-REV. | |
bae9f9e3 | 2994 | (current-line (or move-point-to (unless buf (line-number-at-pos))))) |
afe35502 | 2995 | (message "Annotating...") |
04864eb0 SM |
2996 | ;; If BUF is specified it tells in which buffer we should put the |
2997 | ;; annotations. This is used when switching annotations to another | |
2998 | ;; revision, so we should update the buffer's name. | |
b5446276 DN |
2999 | (when buf (with-current-buffer buf |
3000 | (rename-buffer temp-buffer-name t) | |
3001 | ;; In case it had to be uniquified. | |
3002 | (setq temp-buffer-name (buffer-name)))) | |
46e33aee | 3003 | (with-output-to-temp-buffer temp-buffer-name |
a749e19d SM |
3004 | (let ((backend (vc-backend file))) |
3005 | (vc-call-backend backend 'annotate-command file | |
3006 | (get-buffer temp-buffer-name) rev) | |
3007 | ;; we must setup the mode first, and then set our local | |
3008 | ;; variables before the show-function is called at the exit of | |
3009 | ;; with-output-to-temp-buffer | |
3010 | (with-current-buffer temp-buffer-name | |
3011 | (unless (equal major-mode 'vc-annotate-mode) | |
3012 | (vc-annotate-mode)) | |
3013 | (set (make-local-variable 'vc-annotate-backend) backend) | |
3014 | (set (make-local-variable 'vc-annotate-parent-file) file) | |
3015 | (set (make-local-variable 'vc-annotate-parent-rev) rev) | |
3016 | (set (make-local-variable 'vc-annotate-parent-display-mode) | |
3017 | display-mode)))) | |
cd42ec7d | 3018 | |
ebaac04d SM |
3019 | (with-current-buffer temp-buffer-name |
3020 | (vc-exec-after | |
3021 | `(progn | |
3022 | ;; Ideally, we'd rather not move point if the user has already | |
3023 | ;; moved it elsewhere, but really point here is not the position | |
3024 | ;; of the user's cursor :-( | |
3025 | (when ,current-line ;(and (bobp)) | |
86e80023 | 3026 | (goto-line ,current-line) |
01823b77 | 3027 | (setq vc-sentinel-movepoint (point))) |
ebaac04d SM |
3028 | (unless (active-minibuffer-window) |
3029 | (message "Annotating... done"))))))) | |
7d2d9482 | 3030 | |
ac3f4c6f ER |
3031 | (defun vc-annotate-prev-revision (prefix) |
3032 | "Visit the annotation of the revision previous to this one. | |
1b5a7343 | 3033 | |
ac3f4c6f ER |
3034 | With a numeric prefix argument, annotate the revision that many |
3035 | revisions previous." | |
1b5a7343 | 3036 | (interactive "p") |
ac3f4c6f | 3037 | (vc-annotate-warp-revision (- 0 prefix))) |
1b5a7343 | 3038 | |
ac3f4c6f ER |
3039 | (defun vc-annotate-next-revision (prefix) |
3040 | "Visit the annotation of the revision after this one. | |
1b5a7343 | 3041 | |
ac3f4c6f ER |
3042 | With a numeric prefix argument, annotate the revision that many |
3043 | revisions after." | |
1b5a7343 | 3044 | (interactive "p") |
ac3f4c6f | 3045 | (vc-annotate-warp-revision prefix)) |
1b5a7343 | 3046 | |
ac3f4c6f ER |
3047 | (defun vc-annotate-working-revision () |
3048 | "Visit the annotation of the working revision of this file." | |
1b5a7343 AS |
3049 | (interactive) |
3050 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3051 | (message "Cannot be invoked outside of a vc annotate buffer") | |
ac3f4c6f | 3052 | (let ((warp-rev (vc-working-revision vc-annotate-parent-file))) |
1b5a7343 | 3053 | (if (equal warp-rev vc-annotate-parent-rev) |
ac3f4c6f ER |
3054 | (message "Already at revision %s" warp-rev) |
3055 | (vc-annotate-warp-revision warp-rev))))) | |
1b5a7343 AS |
3056 | |
3057 | (defun vc-annotate-extract-revision-at-line () | |
3058 | "Extract the revision number of the current line." | |
3059 | ;; This function must be invoked from a buffer in vc-annotate-mode | |
1b5a7343 AS |
3060 | (vc-call-backend vc-annotate-backend 'annotate-extract-revision-at-line)) |
3061 | ||
3062 | (defun vc-annotate-revision-at-line () | |
ac3f4c6f | 3063 | "Visit the annotation of the revision identified in the current line." |
1b5a7343 AS |
3064 | (interactive) |
3065 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3066 | (message "Cannot be invoked outside of a vc annotate buffer") | |
3067 | (let ((rev-at-line (vc-annotate-extract-revision-at-line))) | |
3068 | (if (not rev-at-line) | |
3069 | (message "Cannot extract revision number from the current line") | |
3070 | (if (equal rev-at-line vc-annotate-parent-rev) | |
ac3f4c6f ER |
3071 | (message "Already at revision %s" rev-at-line) |
3072 | (vc-annotate-warp-revision rev-at-line)))))) | |
1b5a7343 | 3073 | |
f3ff0fe9 DN |
3074 | (defun vc-annotate-find-revision-at-line () |
3075 | "Visit the revision identified in the current line." | |
3076 | (interactive) | |
3077 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3078 | (message "Cannot be invoked outside of a vc annotate buffer") | |
3079 | (let ((rev-at-line (vc-annotate-extract-revision-at-line))) | |
3080 | (if (not rev-at-line) | |
3081 | (message "Cannot extract revision number from the current line") | |
3082 | (vc-revision-other-window rev-at-line))))) | |
3083 | ||
1b5a7343 | 3084 | (defun vc-annotate-revision-previous-to-line () |
ac3f4c6f | 3085 | "Visit the annotation of the revision before the revision at line." |
1b5a7343 AS |
3086 | (interactive) |
3087 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3088 | (message "Cannot be invoked outside of a vc annotate buffer") | |
3089 | (let ((rev-at-line (vc-annotate-extract-revision-at-line)) | |
3090 | (prev-rev nil)) | |
3091 | (if (not rev-at-line) | |
3092 | (message "Cannot extract revision number from the current line") | |
3093 | (setq prev-rev | |
a749e19d SM |
3094 | (vc-call-backend vc-annotate-backend 'previous-revision |
3095 | vc-annotate-parent-file rev-at-line)) | |
ac3f4c6f | 3096 | (vc-annotate-warp-revision prev-rev))))) |
1b5a7343 AS |
3097 | |
3098 | (defun vc-annotate-show-log-revision-at-line () | |
ac3f4c6f | 3099 | "Visit the log of the revision at line." |
1b5a7343 AS |
3100 | (interactive) |
3101 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3102 | (message "Cannot be invoked outside of a vc annotate buffer") | |
3103 | (let ((rev-at-line (vc-annotate-extract-revision-at-line))) | |
3104 | (if (not rev-at-line) | |
3105 | (message "Cannot extract revision number from the current line") | |
3106 | (vc-print-log rev-at-line))))) | |
3107 | ||
3108 | (defun vc-annotate-show-diff-revision-at-line () | |
ac3f4c6f | 3109 | "Visit the diff of the revision at line from its previous revision." |
1b5a7343 AS |
3110 | (interactive) |
3111 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3112 | (message "Cannot be invoked outside of a vc annotate buffer") | |
3113 | (let ((rev-at-line (vc-annotate-extract-revision-at-line)) | |
3114 | (prev-rev nil)) | |
3115 | (if (not rev-at-line) | |
3116 | (message "Cannot extract revision number from the current line") | |
3117 | (setq prev-rev | |
a749e19d SM |
3118 | (vc-call-backend vc-annotate-backend 'previous-revision |
3119 | vc-annotate-parent-file rev-at-line)) | |
1b5a7343 | 3120 | (if (not prev-rev) |
ac3f4c6f | 3121 | (message "Cannot diff from any revision prior to %s" rev-at-line) |
1b5a7343 | 3122 | (save-window-excursion |
ae67f2d0 DN |
3123 | (vc-diff-internal |
3124 | nil | |
4f155125 DN |
3125 | ;; The value passed here should follow what |
3126 | ;; `vc-deduce-fileset' returns. | |
3127 | (cons vc-annotate-backend | |
3128 | (cons (list vc-annotate-parent-file) nil)) | |
ae67f2d0 | 3129 | prev-rev rev-at-line)) |
1b5a7343 AS |
3130 | (switch-to-buffer "*vc-diff*")))))) |
3131 | ||
ac3f4c6f ER |
3132 | (defun vc-annotate-warp-revision (revspec) |
3133 | "Annotate the revision described by REVSPEC. | |
1b5a7343 | 3134 | |
ac3f4c6f | 3135 | If REVSPEC is a positive integer, warp that many revisions |
1b5a7343 | 3136 | forward, if possible, otherwise echo a warning message. If |
ac3f4c6f | 3137 | REVSPEC is a negative integer, warp that many revisions backward, |
1b5a7343 AS |
3138 | if possible, otherwise echo a warning message. If REVSPEC is a |
3139 | string, then it describes a revision number, so warp to that | |
3140 | revision." | |
3141 | (if (not (equal major-mode 'vc-annotate-mode)) | |
3142 | (message "Cannot be invoked outside of a vc annotate buffer") | |
da7c8a12 S |
3143 | (let* ((buf (current-buffer)) |
3144 | (oldline (line-number-at-pos)) | |
1b5a7343 AS |
3145 | (revspeccopy revspec) |
3146 | (newrev nil)) | |
3147 | (cond | |
3148 | ((and (integerp revspec) (> revspec 0)) | |
3149 | (setq newrev vc-annotate-parent-rev) | |
3150 | (while (and (> revspec 0) newrev) | |
a749e19d SM |
3151 | (setq newrev (vc-call-backend vc-annotate-backend 'next-revision |
3152 | vc-annotate-parent-file newrev)) | |
3153 | (setq revspec (1- revspec))) | |
b5446276 DN |
3154 | (unless newrev |
3155 | (message "Cannot increment %d revisions from revision %s" | |
3156 | revspeccopy vc-annotate-parent-rev))) | |
1b5a7343 AS |
3157 | ((and (integerp revspec) (< revspec 0)) |
3158 | (setq newrev vc-annotate-parent-rev) | |
3159 | (while (and (< revspec 0) newrev) | |
a749e19d SM |
3160 | (setq newrev (vc-call-backend vc-annotate-backend 'previous-revision |
3161 | vc-annotate-parent-file newrev)) | |
3162 | (setq revspec (1+ revspec))) | |
b5446276 DN |
3163 | (unless newrev |
3164 | (message "Cannot decrement %d revisions from revision %s" | |
3165 | (- 0 revspeccopy) vc-annotate-parent-rev))) | |
1b5a7343 | 3166 | ((stringp revspec) (setq newrev revspec)) |
ac3f4c6f | 3167 | (t (error "Invalid argument to vc-annotate-warp-revision"))) |
1b5a7343 | 3168 | (when newrev |
04864eb0 SM |
3169 | (vc-annotate vc-annotate-parent-file newrev |
3170 | vc-annotate-parent-display-mode | |
bae9f9e3 DN |
3171 | buf |
3172 | ;; Pass the current line so that vc-annotate will | |
3173 | ;; place the point in the line. | |
3174 | (min oldline (progn (goto-char (point-max)) | |
a749e19d SM |
3175 | (forward-line -1) |
3176 | (line-number-at-pos)))))))) | |
1b5a7343 | 3177 | |
f70419a8 | 3178 | (defun vc-annotate-compcar (threshold a-list) |
6f1ecae4 AS |
3179 | "Test successive cons cells of A-LIST against THRESHOLD. |
3180 | Return the first cons cell with a car that is not less than THRESHOLD, | |
3181 | nil if no such cell exists." | |
f70419a8 RS |
3182 | (let ((i 1) |
3183 | (tmp-cons (car a-list))) | |
3184 | (while (and tmp-cons (< (car tmp-cons) threshold)) | |
3185 | (setq tmp-cons (car (nthcdr i a-list))) | |
3186 | (setq i (+ i 1))) | |
3187 | tmp-cons)) ; Return the appropriate value | |
3188 | ||
75665141 | 3189 | (defun vc-annotate-convert-time (time) |
6f1ecae4 AS |
3190 | "Convert a time value to a floating-point number of days. |
3191 | The argument TIME is a list as returned by `current-time' or | |
3192 | `encode-time', only the first two elements of that list are considered." | |
75665141 AS |
3193 | (/ (+ (* (float (car time)) (lsh 1 16)) (cadr time)) 24 3600)) |
3194 | ||
3195 | (defun vc-annotate-difference (&optional offset) | |
6f1ecae4 AS |
3196 | "Return the time span in days to the next annotation. |
3197 | This calls the backend function annotate-time, and returns the | |
3198 | difference in days between the time returned and the current time, | |
3199 | or OFFSET if present." | |
5731a8e0 | 3200 | (let ((next-time (vc-annotate-get-time-set-line-props))) |
b5446276 DN |
3201 | (when next-time |
3202 | (- (or offset | |
3203 | (vc-call-backend vc-annotate-backend 'annotate-current-time)) | |
3204 | next-time)))) | |
75665141 AS |
3205 | |
3206 | (defun vc-default-annotate-current-time (backend) | |
3207 | "Return the current time, encoded as fractional days." | |
3208 | (vc-annotate-convert-time (current-time))) | |
99cb8c8b | 3209 | |
07577777 JPW |
3210 | (defvar vc-annotate-offset nil) |
3211 | ||
97461c84 | 3212 | (defun vc-annotate-display (ratio &optional offset) |
6f1ecae4 | 3213 | "Highlight `vc-annotate' output in the current buffer. |
97461c84 | 3214 | RATIO, is the expansion that should be applied to `vc-annotate-color-map'. |
bf142f28 | 3215 | The annotations are relative to the current time, unless overridden by OFFSET." |
b5446276 DN |
3216 | (when (/= ratio 1.0) |
3217 | (set (make-local-variable 'vc-annotate-color-map) | |
3218 | (mapcar (lambda (elem) (cons (* (car elem) ratio) (cdr elem))) | |
3219 | vc-annotate-color-map))) | |
f66a6225 SM |
3220 | (set (make-local-variable 'vc-annotate-offset) offset) |
3221 | (font-lock-mode 1)) | |
3222 | ||
f66a6225 | 3223 | (defun vc-annotate-lines (limit) |
7c33af85 SM |
3224 | (while (< (point) limit) |
3225 | (let ((difference (vc-annotate-difference vc-annotate-offset)) | |
3226 | (start (point)) | |
3227 | (end (progn (forward-line 1) (point)))) | |
3228 | (when difference | |
3229 | (let* ((color (or (vc-annotate-compcar difference vc-annotate-color-map) | |
3230 | (cons nil vc-annotate-very-old-color))) | |
3231 | ;; substring from index 1 to remove any leading `#' in the name | |
3232 | (face-name (concat "vc-annotate-face-" | |
3233 | (if (string-equal | |
3234 | (substring (cdr color) 0 1) "#") | |
3235 | (substring (cdr color) 1) | |
3236 | (cdr color)))) | |
3237 | ;; Make the face if not done. | |
3238 | (face (or (intern-soft face-name) | |
3239 | (let ((tmp-face (make-face (intern face-name)))) | |
3240 | (set-face-foreground tmp-face (cdr color)) | |
b5446276 DN |
3241 | (when vc-annotate-background |
3242 | (set-face-background tmp-face | |
3243 | vc-annotate-background)) | |
7c33af85 SM |
3244 | tmp-face)))) ; Return the face |
3245 | (put-text-property start end 'face face))))) | |
3246 | ;; Pretend to font-lock there were no matches. | |
3247 | nil) | |
7d2d9482 | 3248 | \f |
594722a8 | 3249 | |
b1ddeeb7 ER |
3250 | ;; These things should probably be generally available |
3251 | ||
3252 | (defun vc-file-tree-walk (dirname func &rest args) | |
3253 | "Walk recursively through DIRNAME. | |
3254 | Invoke FUNC f ARGS on each VC-managed file f underneath it." | |
3255 | (vc-file-tree-walk-internal (expand-file-name dirname) func args) | |
3256 | (message "Traversing directory %s...done" dirname)) | |
3257 | ||
3258 | (defun vc-file-tree-walk-internal (file func args) | |
3259 | (if (not (file-directory-p file)) | |
3260 | (when (vc-backend file) (apply func file args)) | |
3261 | (message "Traversing directory %s..." (abbreviate-file-name file)) | |
3262 | (let ((dir (file-name-as-directory file))) | |
3263 | (mapcar | |
3264 | (lambda (f) (or | |
3265 | (string-equal f ".") | |
3266 | (string-equal f "..") | |
3267 | (member f vc-directory-exclusion-list) | |
3268 | (let ((dirf (expand-file-name f dir))) | |
3269 | (or | |
3270 | (file-symlink-p dirf) ;; Avoid possible loops. | |
3271 | (vc-file-tree-walk-internal dirf func args))))) | |
3272 | (directory-files dir))))) | |
3273 | ||
594722a8 ER |
3274 | (provide 'vc) |
3275 | ||
0452b6e7 | 3276 | ;; arch-tag: ca82c1de-3091-4e26-af92-460abc6213a6 |
594722a8 | 3277 | ;;; vc.el ends here |