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