Commit | Line | Data |
---|---|---|
66321b2f | 1 | ;;; vc.el --- drive a version-control system from within Emacs |
594722a8 | 2 | |
0d30b337 | 3 | ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000, |
f52749ed GM |
4 | ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 |
5 | ;; Free Software Foundation, Inc. | |
594722a8 | 6 | |
0e362f54 GM |
7 | ;; Author: FSF (see below for full credits) |
8 | ;; Maintainer: Andre Spiegel <spiegel@gnu.org> | |
284b3043 | 9 | ;; Keywords: tools |
594722a8 ER |
10 | |
11 | ;; This file is part of GNU Emacs. | |
12 | ||
13 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
14 | ;; it under the terms of the GNU General Public License as published by | |
b4aa6026 | 15 | ;; the Free Software Foundation; either version 3, or (at your option) |
594722a8 ER |
16 | ;; any later version. |
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 | |
b578f267 | 24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
25 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
26 | ;; Boston, MA 02110-1301, USA. | |
594722a8 | 27 | |
0e362f54 GM |
28 | ;;; Credits: |
29 | ||
30 | ;; VC was initially designed and implemented by Eric S. Raymond | |
61de26cb | 31 | ;; <esr@thyrsus.com> in 1992. Over the years, many other people have |
0e362f54 | 32 | ;; contributed substantial amounts of work to VC. These include: |
61de26cb | 33 | ;; |
0e362f54 GM |
34 | ;; Per Cederqvist <ceder@lysator.liu.se> |
35 | ;; Paul Eggert <eggert@twinsun.com> | |
36 | ;; Sebastian Kremer <sk@thp.uni-koeln.de> | |
37 | ;; Martin Lorentzson <martinl@gnu.org> | |
166a0ef7 | 38 | ;; Dave Love <fx@gnu.org> |
0e362f54 | 39 | ;; Stefan Monnier <monnier@cs.yale.edu> |
6f1ecae4 | 40 | ;; J.D. Smith <jdsmith@alum.mit.edu> |
0e362f54 GM |
41 | ;; Andre Spiegel <spiegel@gnu.org> |
42 | ;; Richard Stallman <rms@gnu.org> | |
6f1ecae4 | 43 | ;; Thien-Thi Nguyen <ttn@gnu.org> |
61de26cb ER |
44 | ;; |
45 | ;; In July 2007 ESR returned and redesigned the mode to cope better | |
46 | ;; with modern version-control systems that do commits by fileset | |
47 | ;; rather than per individual file. | |
48 | ;; | |
49 | ;; Features in the new version: | |
50 | ;; * Key commands (vc-next-action = C-x v v, vc-print-log = C-x v l, vc-revert | |
a7192ddb | 51 | ;; = C-x v u, vc-rollback = C-x v c, vc-diff = C-x v =, vc-update = C-x v +) |
61de26cb ER |
52 | ;; now operate on filesets rather than individual files. |
53 | ;; * The fileset for a command is either (a) all marked files in VC-dired | |
54 | ;; mode, (b) the currently visited file if it's under version control, | |
55 | ;; or (c) the current directory if the visited buffer is not under | |
a7192ddb | 56 | ;; version control and a wildcarding-enable flag has been set. |
61de26cb | 57 | ;; |
a7192ddb SM |
58 | ;; If you maintain a client of the mode or customize it in your .emacs, |
59 | ;; note that some backend functions which formerly took single file arguments | |
61de26cb ER |
60 | ;; now take a list of files. These include: register, checkin, print-log, |
61 | ;; rollback, and diff. | |
0e362f54 | 62 | |
594722a8 ER |
63 | ;;; Commentary: |
64 | ||
1a2f456b ER |
65 | ;; This mode is fully documented in the Emacs user's manual. |
66 | ;; | |
c0edfa75 | 67 | ;; Supported version-control systems presently include CVS, RCS, GNU |
5e8c0b8b DN |
68 | ;; Arch, Subversion, Bzr, Git, Mercurial, Meta-CVS, Monotone and SCCS |
69 | ;; (or its free replacement, CSSC). | |
b0c9bc8c AS |
70 | ;; |
71 | ;; Some features will not work with old RCS versions. Where | |
72 | ;; appropriate, VC finds out which version you have, and allows or | |
0e362f54 | 73 | ;; disallows those features (stealing locks, for example, works only |
b0c9bc8c | 74 | ;; from 5.6.2 onwards). |
632e9525 RS |
75 | ;; Even initial checkins will fail if your RCS version is so old that ci |
76 | ;; doesn't understand -t-; this has been known to happen to people running | |
0e362f54 | 77 | ;; NExTSTEP 3.0. |
594722a8 | 78 | ;; |
0e362f54 | 79 | ;; You can support the RCS -x option by customizing vc-rcs-master-templates. |
594722a8 ER |
80 | ;; |
81 | ;; Proper function of the SCCS diff commands requires the shellscript vcdiff | |
82 | ;; to be installed somewhere on Emacs's path for executables. | |
83 | ;; | |
1a2f456b | 84 | ;; If your site uses the ChangeLog convention supported by Emacs, the |
93a142e1 DN |
85 | ;; function `log-edit-comment-to-change-log' could prove a useful checkin hook, |
86 | ;; although you might prefer to use C-c C-a (i.e. `log-edit-insert-changelog') | |
1cca5da4 | 87 | ;; from the commit buffer instead or to set `log-edit-setup-invert'. |
1a2f456b | 88 | ;; |
594722a8 ER |
89 | ;; The vc code maintains some internal state in order to reduce expensive |
90 | ;; version-control operations to a minimum. Some names are only computed | |
3b37b179 | 91 | ;; once. If you perform version control operations with the backend while |
594722a8 ER |
92 | ;; vc's back is turned, or move/rename master files while vc is running, |
93 | ;; vc may get seriously confused. Don't do these things! | |
94 | ;; | |
95 | ;; Developer's notes on some concurrency issues are included at the end of | |
96 | ;; the file. | |
0e362f54 | 97 | ;; |
fcb500ea AS |
98 | ;; ADDING SUPPORT FOR OTHER BACKENDS |
99 | ;; | |
100 | ;; VC can use arbitrary version control systems as a backend. To add | |
101 | ;; support for a new backend named SYS, write a library vc-sys.el that | |
102 | ;; contains functions of the form `vc-sys-...' (note that SYS is in lower | |
103 | ;; case for the function and library names). VC will use that library if | |
104 | ;; you put the symbol SYS somewhere into the list of | |
105 | ;; `vc-handled-backends'. Then, for example, if `vc-sys-registered' | |
106 | ;; returns non-nil for a file, all SYS-specific versions of VC commands | |
107 | ;; will be available for that file. | |
108 | ;; | |
109 | ;; VC keeps some per-file information in the form of properties (see | |
110 | ;; vc-file-set/getprop in vc-hooks.el). The backend-specific functions | |
111 | ;; do not generally need to be aware of these properties. For example, | |
ac3f4c6f | 112 | ;; `vc-sys-working-revision' should compute the working revision and |
fcb500ea AS |
113 | ;; return it; it should not look it up in the property, and it needn't |
114 | ;; store it there either. However, if a backend-specific function does | |
115 | ;; store a value in a property, that value takes precedence over any | |
99cb8c8b | 116 | ;; value that the generic code might want to set (check for uses of |
fcb500ea AS |
117 | ;; the macro `with-vc-properties' in vc.el). |
118 | ;; | |
119 | ;; In the list of functions below, each identifier needs to be prepended | |
120 | ;; with `vc-sys-'. Some of the functions are mandatory (marked with a | |
121 | ;; `*'), others are optional (`-'). | |
122 | ;; | |
8cdd17b4 ER |
123 | ;; BACKEND PROPERTIES |
124 | ;; | |
125 | ;; * revision-granularity | |
126 | ;; | |
61de26cb ER |
127 | ;; Takes no arguments. Returns either 'file or 'repository. Backends |
128 | ;; that return 'file have per-file revision numbering; backends | |
129 | ;; that return 'repository have per-repository revision numbering, | |
130 | ;; so a revision level implicitly identifies a changeset | |
a7192ddb | 131 | ;; |
fcb500ea AS |
132 | ;; STATE-QUERYING FUNCTIONS |
133 | ;; | |
0e362f54 | 134 | ;; * registered (file) |
fcb500ea | 135 | ;; |
37a5e97a | 136 | ;; Return non-nil if FILE is registered in this backend. Both this |
73770b03 DN |
137 | ;; function as well as `state' should be careful to fail gracefully |
138 | ;; in the event that the backend executable is absent. It is | |
139 | ;; preferable that this function's body is autoloaded, that way only | |
140 | ;; calling vc-registered does not cause the backend to be loaded | |
141 | ;; (all the vc-FOO-registered functions are called to try to find | |
142 | ;; the controlling backend for FILE. | |
fcb500ea | 143 | ;; |
99cb8c8b | 144 | ;; * state (file) |
fcb500ea AS |
145 | ;; |
146 | ;; Return the current version control state of FILE. For a list of | |
147 | ;; possible values, see `vc-state'. This function should do a full and | |
148 | ;; reliable state computation; it is usually called immediately after | |
149 | ;; C-x v v. If you want to use a faster heuristic when visiting a | |
150 | ;; file, put that into `state-heuristic' below. | |
151 | ;; | |
0e362f54 | 152 | ;; - state-heuristic (file) |
fcb500ea AS |
153 | ;; |
154 | ;; If provided, this function is used to estimate the version control | |
155 | ;; state of FILE at visiting time. It should be considerably faster | |
156 | ;; than the implementation of `state'. For a list of possible values, | |
157 | ;; see the doc string of `vc-state'. | |
158 | ;; | |
0e362f54 | 159 | ;; - dir-state (dir) |
fcb500ea | 160 | ;; |
484c1b1f | 161 | ;; If provided, this function is used to find the version control |
df49d02e | 162 | ;; state of as many files as possible in DIR, and all subdirectories |
484c1b1f ER |
163 | ;; of DIR, in a fast way; it is used to avoid expensive indivitual |
164 | ;; vc-state calls. The function should not return anything, but | |
55adbcc2 DN |
165 | ;; rather store the files' states into the corresponding properties. |
166 | ;; Two properties are required: `vc-backend' and `vc-state'. (Note: | |
167 | ;; in older versions this method was not required to recurse into | |
168 | ;; subdirectories.) | |
fcb500ea | 169 | ;; |
00ca5ce2 DN |
170 | ;; - dir-status (dir update-function status-buffer) |
171 | ;; | |
1b3f2d4e DN |
172 | ;; Produce RESULT: a list of lists of the form (FILE VC-STATE EXTRA) |
173 | ;; for the files in DIR. | |
174 | ;; EXTRA can be used for backend specific information about FILE. | |
175 | ;; If a command needs to be run to compute this list, it should be | |
176 | ;; run asynchronously using (current-buffer) as the buffer for the | |
177 | ;; command. When RESULT is computed, it should be passed back by | |
5a84a937 DN |
178 | ;; doing: (funcall UPDATE-FUNCTION RESULT STATUS-BUFFER nil). |
179 | ;; If the backend uses a process filter, hence it produces partial results, | |
180 | ;; they can be passed back by doing: | |
181 | ;; (funcall UPDATE-FUNCTION RESULT STATUS-BUFFER t) | |
182 | ;; and then do a (funcall UPDATE-FUNCTION RESULT STATUS-BUFFER nil) | |
183 | ;; when all the results have been computed. | |
184 | ;; To provide more backend specific functionality for `vc-status' | |
185 | ;; the following functions might be needed: `status-extra-headers', | |
186 | ;; `status-printer', `extra-status-menu' and `status-fileinfo-extra'. | |
187 | ;; This function is used by `vc-status', a replacement for | |
188 | ;; `vc-dired'. vc-status is still under development, and is NOT | |
189 | ;; feature complete. As such, the requirements for this function | |
190 | ;; might change. This is a replacement for `dir-state'. | |
00ca5ce2 | 191 | ;; |
15c5c970 | 192 | ;; - status-extra-headers (dir) |
115c0061 | 193 | ;; |
15c5c970 DN |
194 | ;; Return a string that will be added to the *vc-status* buffer header. |
195 | ;; | |
58f10bff DN |
196 | ;; - status-printer (fileinfo) |
197 | ;; | |
198 | ;; Pretty print the `vc-status-fileinfo' FILEINFO. | |
199 | ;; If a backend needs to show more information than the default FILE | |
200 | ;; and STATE in the vc-status listing, it can store that extra | |
201 | ;; information in `vc-status-fileinfo->extra'. This function can be | |
202 | ;; used to display that extra information in the vc-status buffer. | |
203 | ;; | |
5a84a937 DN |
204 | ;; - status-fileinfo-extra (file) |
205 | ;; | |
206 | ;; Compute `vc-status-fileinfo->extra' for FILE. | |
207 | ;; | |
ac3f4c6f | 208 | ;; * working-revision (file) |
fcb500ea | 209 | ;; |
ac3f4c6f | 210 | ;; Return the working revision of FILE. This is the revision fetched |
61de26cb | 211 | ;; by the last checkout or upate, not necessarily the same thing as the |
a7192ddb | 212 | ;; head or tip revision. Should return "0" for a file added but not yet |
61de26cb | 213 | ;; committed. |
fcb500ea AS |
214 | ;; |
215 | ;; - latest-on-branch-p (file) | |
216 | ;; | |
ac3f4c6f ER |
217 | ;; Return non-nil if the working revision of FILE is the latest revision |
218 | ;; on its branch (many VCSes call this the 'tip' or 'head' revision). | |
0d0e9356 | 219 | ;; The default implementation always returns t, which means that |
ac3f4c6f | 220 | ;; working with non-current revisions is not supported by default. |
fcb500ea | 221 | ;; |
0e362f54 | 222 | ;; * checkout-model (file) |
fcb500ea AS |
223 | ;; |
224 | ;; Indicate whether FILE needs to be "checked out" before it can be | |
225 | ;; edited. See `vc-checkout-model' for a list of possible values. | |
226 | ;; | |
aae91380 | 227 | ;; - workfile-unchanged-p (file) |
fcb500ea | 228 | ;; |
ac3f4c6f ER |
229 | ;; Return non-nil if FILE is unchanged from the working revision. |
230 | ;; This function should do a brief comparison of FILE's contents | |
231 | ;; with those of the repository master of the working revision. If | |
232 | ;; the backend does not have such a brief-comparison feature, the | |
233 | ;; default implementation of this function can be used, which | |
234 | ;; delegates to a full vc-BACKEND-diff. (Note that vc-BACKEND-diff | |
235 | ;; must not run asynchronously in this case, see variable | |
0d0e9356 | 236 | ;; `vc-disable-async-diff'.) |
fcb500ea | 237 | ;; |
0e362f54 | 238 | ;; - mode-line-string (file) |
fcb500ea | 239 | ;; |
3a12f9f8 | 240 | ;; If provided, this function should return the VC-specific mode |
a7192ddb | 241 | ;; line string for FILE. The returned string should have a |
3a12f9f8 DN |
242 | ;; `help-echo' property which is the text to be displayed as a |
243 | ;; tooltip when the mouse hovers over the VC entry on the mode-line. | |
244 | ;; The default implementation deals well with all states that | |
245 | ;; `vc-state' can return. | |
fcb500ea | 246 | ;; |
aae91380 | 247 | ;; - dired-state-info (file) |
fcb500ea AS |
248 | ;; |
249 | ;; Translate the `vc-state' property of FILE into a string that can be | |
250 | ;; used in a vc-dired buffer. The default implementation deals well | |
251 | ;; with all states that `vc-state' can return. | |
252 | ;; | |
253 | ;; STATE-CHANGING FUNCTIONS | |
254 | ;; | |
61de26cb | 255 | ;; * create-repo (backend) |
8cdd17b4 | 256 | ;; |
a7192ddb SM |
257 | ;; Create an empty repository in the current directory and initialize |
258 | ;; it so VC mode can add files to it. For file-oriented systems, this | |
8cdd17b4 ER |
259 | ;; need do no more than create a subdirectory with the right name. |
260 | ;; | |
261 | ;; * register (files &optional rev comment) | |
fcb500ea | 262 | ;; |
8cdd17b4 ER |
263 | ;; Register FILES in this backend. Optionally, an initial revision REV |
264 | ;; and an initial description of the file, COMMENT, may be specified, | |
265 | ;; but it is not guaranteed that the backend will do anything with this. | |
ecd50f65 | 266 | ;; The implementation should pass the value of vc-register-switches |
a7192ddb | 267 | ;; to the backend command. (Note: in older versions of VC, this |
8cdd17b4 | 268 | ;; command took a single file argument and not a list.) |
fcb500ea | 269 | ;; |
ac3f4c6f | 270 | ;; - init-revision (file) |
b470cb65 | 271 | ;; |
ac3f4c6f | 272 | ;; The initial revision to use when registering FILE if one is not |
b470cb65 | 273 | ;; specified by the user. If not provided, the variable |
ac3f4c6f | 274 | ;; vc-default-init-revision is used instead. |
b470cb65 | 275 | ;; |
099bd78a | 276 | ;; - responsible-p (file) |
fcb500ea AS |
277 | ;; |
278 | ;; Return non-nil if this backend considers itself "responsible" for | |
279 | ;; FILE, which can also be a directory. This function is used to find | |
280 | ;; out what backend to use for registration of new files and for things | |
281 | ;; like change log generation. The default implementation always | |
282 | ;; returns nil. | |
283 | ;; | |
0e362f54 | 284 | ;; - could-register (file) |
fcb500ea AS |
285 | ;; |
286 | ;; Return non-nil if FILE could be registered under this backend. The | |
287 | ;; default implementation always returns t. | |
288 | ;; | |
aae91380 | 289 | ;; - receive-file (file rev) |
fcb500ea AS |
290 | ;; |
291 | ;; Let this backend "receive" a file that is already registered under | |
292 | ;; another backend. The default implementation simply calls `register' | |
293 | ;; for FILE, but it can be overridden to do something more specific, | |
294 | ;; e.g. keep revision numbers consistent or choose editing modes for | |
295 | ;; FILE that resemble those of the other backend. | |
296 | ;; | |
297 | ;; - unregister (file) | |
298 | ;; | |
299 | ;; Unregister FILE from this backend. This is only needed if this | |
300 | ;; backend may be used as a "more local" backend for temporary editing. | |
301 | ;; | |
8cdd17b4 | 302 | ;; * checkin (files rev comment) |
fcb500ea | 303 | ;; |
8cdd17b4 ER |
304 | ;; Commit changes in FILES to this backend. If REV is non-nil, that |
305 | ;; should become the new revision number (not all backends do | |
306 | ;; anything with it). COMMENT is used as a check-in comment. The | |
307 | ;; implementation should pass the value of vc-checkin-switches to | |
a7192ddb | 308 | ;; the backend command. (Note: in older versions of VC, this |
8cdd17b4 | 309 | ;; command took a single file argument and not a list.) |
fcb500ea | 310 | ;; |
ac3f4c6f | 311 | ;; * find-revision (file rev buffer) |
fd8160f7 SM |
312 | ;; |
313 | ;; Fetch revision REV of file FILE and put it into BUFFER. | |
314 | ;; If REV is the empty string, fetch the head of the trunk. | |
315 | ;; The implementation should pass the value of vc-checkout-switches | |
316 | ;; to the backend command. | |
317 | ;; | |
9e6da495 | 318 | ;; * checkout (file &optional editable rev) |
fcb500ea AS |
319 | ;; |
320 | ;; Check out revision REV of FILE into the working area. If EDITABLE | |
321 | ;; is non-nil, FILE should be writable by the user and if locking is | |
322 | ;; used for FILE, a lock should also be set. If REV is non-nil, that | |
ac3f4c6f | 323 | ;; is the revision to check out (default is the working revision). |
4279775b AS |
324 | ;; If REV is t, that means to check out the head of the current branch; |
325 | ;; if it is the empty string, check out the head of the trunk. | |
326 | ;; The implementation should pass the value of vc-checkout-switches | |
fd8160f7 | 327 | ;; to the backend command. |
fcb500ea | 328 | ;; |
bbfc07d3 | 329 | ;; * revert (file &optional contents-done) |
fcb500ea | 330 | ;; |
ac3f4c6f | 331 | ;; Revert FILE back to the working revision. If optional |
bbfc07d3 AS |
332 | ;; arg CONTENTS-DONE is non-nil, then the contents of FILE have |
333 | ;; already been reverted from a version backup, and this function | |
334 | ;; only needs to update the status of FILE within the backend. | |
fcb500ea | 335 | ;; |
8cdd17b4 | 336 | ;; - rollback (files) |
fcb500ea | 337 | ;; |
ac3f4c6f ER |
338 | ;; Remove the tip revision of each of FILES from the repository. If |
339 | ;; this function is not provided, trying to cancel a revision is | |
8cdd17b4 ER |
340 | ;; caught as an error. (Most backends don't provide it.) (Also |
341 | ;; note that older versions of this backend command were called | |
342 | ;; 'cancel-version' and took a single file arg, not a list of | |
343 | ;; files.) | |
fcb500ea | 344 | ;; |
aae91380 | 345 | ;; - merge (file rev1 rev2) |
fcb500ea AS |
346 | ;; |
347 | ;; Merge the changes between REV1 and REV2 into the current working file. | |
348 | ;; | |
aae91380 | 349 | ;; - merge-news (file) |
fcb500ea AS |
350 | ;; |
351 | ;; Merge recent changes from the current branch into FILE. | |
352 | ;; | |
ac3f4c6f | 353 | ;; - steal-lock (file &optional revision) |
fcb500ea | 354 | ;; |
ac3f4c6f | 355 | ;; Steal any lock on the working revision of FILE, or on REVISION if |
0d0e9356 ER |
356 | ;; that is provided. This function is only needed if locking is |
357 | ;; used for files under this backend, and if files can indeed be | |
358 | ;; locked by other users. | |
fcb500ea | 359 | ;; |
9b64a7f0 ER |
360 | ;; - modify-change-comment (files rev comment) |
361 | ;; | |
df49d02e | 362 | ;; Modify the change comments associated with the files at the |
9b64a7f0 ER |
363 | ;; given revision. This is optional, many backends do not support it. |
364 | ;; | |
fcb500ea AS |
365 | ;; HISTORY FUNCTIONS |
366 | ;; | |
8cdd17b4 | 367 | ;; * print-log (files &optional buffer) |
fcb500ea | 368 | ;; |
8cdd17b4 ER |
369 | ;; Insert the revision log for FILES into BUFFER, or the *vc* buffer |
370 | ;; if BUFFER is nil. (Note: older versions of this function expected | |
371 | ;; only a single file argument.) | |
fcb500ea | 372 | ;; |
37a5e97a SM |
373 | ;; - log-view-mode () |
374 | ;; | |
375 | ;; Mode to use for the output of print-log. This defaults to | |
376 | ;; `log-view-mode' and is expected to be changed (if at all) to a derived | |
377 | ;; mode of `log-view-mode'. | |
378 | ;; | |
ac3f4c6f | 379 | ;; - show-log-entry (revision) |
fcb500ea | 380 | ;; |
ac3f4c6f | 381 | ;; If provided, search the log entry for REVISION in the current buffer, |
fcb500ea AS |
382 | ;; and make sure it is displayed in the buffer's window. The default |
383 | ;; implementation of this function works for RCS-style logs. | |
384 | ;; | |
aae91380 | 385 | ;; - wash-log (file) |
fcb500ea | 386 | ;; |
61de26cb | 387 | ;; Remove all non-comment information from the output of print-log. |
fcb500ea | 388 | ;; |
0e362f54 | 389 | ;; - logentry-check () |
fcb500ea AS |
390 | ;; |
391 | ;; If defined, this function is run to find out whether the user | |
392 | ;; entered a valid log entry for check-in. The log entry is in the | |
393 | ;; current buffer, and if it is not a valid one, the function should | |
394 | ;; throw an error. | |
395 | ;; | |
aae91380 | 396 | ;; - comment-history (file) |
fcb500ea | 397 | ;; |
d6ba9c39 | 398 | ;; Return a string containing all log entries that were made for FILE. |
fcb500ea AS |
399 | ;; This is used for transferring a file from one backend to another, |
400 | ;; retaining comment information. The default implementation of this | |
401 | ;; function does this by calling print-log and then wash-log, and | |
402 | ;; returning the resulting buffer contents as a string. | |
403 | ;; | |
aae91380 | 404 | ;; - update-changelog (files) |
fcb500ea AS |
405 | ;; |
406 | ;; Using recent log entries, create ChangeLog entries for FILES, or for | |
407 | ;; all files at or below the default-directory if FILES is nil. The | |
408 | ;; default implementation runs rcs2log, which handles RCS- and | |
409 | ;; CVS-style logs. | |
410 | ;; | |
d7b60083 | 411 | ;; * diff (files &optional rev1 rev2 buffer) |
fcb500ea | 412 | ;; |
ac9ff209 AS |
413 | ;; Insert the diff for FILE into BUFFER, or the *vc-diff* buffer if |
414 | ;; BUFFER is nil. If REV1 and REV2 are non-nil, report differences | |
ac3f4c6f ER |
415 | ;; from REV1 to REV2. If REV1 is nil, use the working revision (as |
416 | ;; found in the repository) as the older revision; if REV2 is nil, | |
417 | ;; use the current working-copy contents as the newer revision. This | |
418 | ;; function should pass the value of (vc-switches BACKEND 'diff) to | |
419 | ;; the backend command. It should return a status of either 0 (no | |
420 | ;; differences found), or 1 (either non-empty diff or the diff is | |
421 | ;; run asynchronously). | |
fcb500ea | 422 | ;; |
a7192ddb | 423 | ;; - revision-completion-table (files) |
4d83a657 | 424 | ;; |
a7192ddb | 425 | ;; Return a completion table for existing revisions of FILES. |
4d83a657 SM |
426 | ;; The default is to not use any completion table. |
427 | ;; | |
3c42cc64 | 428 | ;; - annotate-command (file buf &optional rev) |
fcb500ea | 429 | ;; |
3c42cc64 | 430 | ;; If this function is provided, it should produce an annotated display |
ac3f4c6f | 431 | ;; of FILE in BUF, relative to revision REV. Annotation means each line |
3c42cc64 TTN |
432 | ;; of FILE displayed is prefixed with version information associated with |
433 | ;; its addition (deleted lines leave no history) and that the text of the | |
434 | ;; file is fontified according to age. | |
fcb500ea | 435 | ;; |
75665141 | 436 | ;; - annotate-time () |
fcb500ea AS |
437 | ;; |
438 | ;; Only required if `annotate-command' is defined for the backend. | |
75665141 AS |
439 | ;; Return the time of the next line of annotation at or after point, |
440 | ;; as a floating point fractional number of days. The helper | |
441 | ;; function `vc-annotate-convert-time' may be useful for converting | |
442 | ;; multi-part times as returned by `current-time' and `encode-time' | |
0ff9b955 | 443 | ;; to this format. Return nil if no more lines of annotation appear |
75665141 AS |
444 | ;; in the buffer. You can safely assume that point is placed at the |
445 | ;; beginning of each line, starting at `point-min'. The buffer that | |
446 | ;; point is placed in is the Annotate output, as defined by the | |
946b248f TTN |
447 | ;; relevant backend. This function also affects how much of the line |
448 | ;; is fontified; where it leaves point is where fontification begins. | |
75665141 AS |
449 | ;; |
450 | ;; - annotate-current-time () | |
451 | ;; | |
452 | ;; Only required if `annotate-command' is defined for the backend, | |
453 | ;; AND you'd like the current time considered to be anything besides | |
cb223bba | 454 | ;; (vc-annotate-convert-time (current-time)) -- i.e. the current |
75665141 AS |
455 | ;; time with hours, minutes, and seconds included. Probably safe to |
456 | ;; ignore. Return the current-time, in units of fractional days. | |
fcb500ea | 457 | ;; |
1b5a7343 AS |
458 | ;; - annotate-extract-revision-at-line () |
459 | ;; | |
460 | ;; Only required if `annotate-command' is defined for the backend. | |
461 | ;; Invoked from a buffer in vc-annotate-mode, return the revision | |
462 | ;; corresponding to the current line, or nil if there is no revision | |
463 | ;; corresponding to the current line. | |
464 | ;; | |
fcb500ea AS |
465 | ;; SNAPSHOT SYSTEM |
466 | ;; | |
0e362f54 | 467 | ;; - create-snapshot (dir name branchp) |
fcb500ea AS |
468 | ;; |
469 | ;; Take a snapshot of the current state of files under DIR and name it | |
470 | ;; NAME. This should make sure that files are up-to-date before | |
471 | ;; proceeding with the action. DIR can also be a file and if BRANCHP | |
472 | ;; is specified, NAME should be created as a branch and DIR should be | |
473 | ;; checked out under this new branch. The default implementation does | |
474 | ;; not support branches but does a sanity check, a tree traversal and | |
475 | ;; for each file calls `assign-name'. | |
476 | ;; | |
477 | ;; - assign-name (file name) | |
478 | ;; | |
ac3f4c6f | 479 | ;; Give name NAME to the working revision of FILE, assuming it is |
fcb500ea AS |
480 | ;; up-to-date. Only used by the default version of `create-snapshot'. |
481 | ;; | |
0e362f54 | 482 | ;; - retrieve-snapshot (dir name update) |
fcb500ea AS |
483 | ;; |
484 | ;; Retrieve a named snapshot of all registered files at or below DIR. | |
485 | ;; If UPDATE is non-nil, then update buffers of any files in the | |
486 | ;; snapshot that are currently visited. The default implementation | |
487 | ;; does a sanity check whether there aren't any uncommitted changes at | |
488 | ;; or below DIR, and then performs a tree walk, using the `checkout' | |
ac3f4c6f | 489 | ;; function to retrieve the corresponding revisions. |
fcb500ea AS |
490 | ;; |
491 | ;; MISCELLANEOUS | |
492 | ;; | |
f4263e47 TTN |
493 | ;; - root (dir) |
494 | ;; | |
495 | ;; Return DIR's "root" directory, that is, a parent directory of | |
496 | ;; DIR for which the same backend as used for DIR applies. If no | |
497 | ;; such parent exists, this function should return DIR. | |
498 | ;; | |
aae91380 | 499 | ;; - make-version-backups-p (file) |
fcb500ea | 500 | ;; |
ac3f4c6f | 501 | ;; Return non-nil if unmodified repository revisions of FILE should be |
fcb500ea AS |
502 | ;; backed up locally. If this is done, VC can perform `diff' and |
503 | ;; `revert' operations itself, without calling the backend system. The | |
504 | ;; default implementation always returns nil. | |
505 | ;; | |
a36319a4 SM |
506 | ;; - repository-hostname (dirname) |
507 | ;; | |
508 | ;; Return the hostname that the backend will have to contact | |
509 | ;; in order to operate on a file in DIRNAME. If the return value | |
0452b6e7 | 510 | ;; is nil, it means that the repository is local. |
a36319a4 SM |
511 | ;; This function is used in `vc-stay-local-p' which backends can use |
512 | ;; for their convenience. | |
513 | ;; | |
ac3f4c6f | 514 | ;; - previous-revision (file rev) |
869131a5 | 515 | ;; |
ac3f4c6f ER |
516 | ;; Return the revision number that precedes REV for FILE, or nil if no such |
517 | ;; revision exists. | |
1b5a7343 | 518 | ;; |
ac3f4c6f | 519 | ;; - next-revision (file rev) |
1b5a7343 | 520 | ;; |
ac3f4c6f ER |
521 | ;; Return the revision number that follows REV for FILE, or nil if no such |
522 | ;; revision exists. | |
869131a5 | 523 | ;; |
aae91380 | 524 | ;; - check-headers () |
fcb500ea AS |
525 | ;; |
526 | ;; Return non-nil if the current buffer contains any version headers. | |
527 | ;; | |
aae91380 | 528 | ;; - clear-headers () |
fcb500ea AS |
529 | ;; |
530 | ;; In the current buffer, reset all version headers to their unexpanded | |
531 | ;; form. This function should be provided if the state-querying code | |
532 | ;; for this backend uses the version headers to determine the state of | |
533 | ;; a file. This function will then be called whenever VC changes the | |
534 | ;; version control state in such a way that the headers would give | |
535 | ;; wrong information. | |
536 | ;; | |
a36319a4 SM |
537 | ;; - delete-file (file) |
538 | ;; | |
539 | ;; Delete FILE and mark it as deleted in the repository. If this | |
540 | ;; function is not provided, the command `vc-delete-file' will | |
541 | ;; signal an error. | |
542 | ;; | |
099bd78a | 543 | ;; - rename-file (old new) |
fcb500ea AS |
544 | ;; |
545 | ;; Rename file OLD to NEW, both in the working area and in the | |
a36319a4 SM |
546 | ;; repository. If this function is not provided, the renaming |
547 | ;; will be done by (vc-delete-file old) and (vc-register new). | |
86a65190 | 548 | ;; |
6e54fa53 SM |
549 | ;; - find-file-hook () |
550 | ;; | |
81c63b50 | 551 | ;; Operation called in current buffer when opening a file. This can |
6e54fa53 | 552 | ;; be used by the backend to setup some local variables it might need. |
cb223bba | 553 | ;; |
81c63b50 SM |
554 | ;; - find-file-not-found-hook () |
555 | ;; | |
556 | ;; Operation called in current buffer when opening a non-existing file. | |
557 | ;; By default, this asks the user if she wants to check out the file. | |
cb223bba DN |
558 | ;; |
559 | ;; - extra-menu () | |
560 | ;; | |
561 | ;; Return a menu keymap, the items in the keymap will appear at the | |
562 | ;; end of the Version Control menu. The goal is to allow backends | |
563 | ;; to specify extra menu items that appear in the VC menu. This way | |
564 | ;; you can provide menu entries for functionality that is specific | |
565 | ;; to your backend and which does not map to any of the VC generic | |
566 | ;; concepts. | |
6656ecaa DN |
567 | ;; |
568 | ;; - extra-status-menu () | |
569 | ;; | |
25a4ea6d DN |
570 | ;; Return a menu keymap, the items in the keymap will appear at the |
571 | ;; end of the VC Status menu. The goal is to allow backends to | |
572 | ;; specify extra menu items that appear in the VC Status menu. This | |
573 | ;; makes it possible to provide menu entries for functionality that | |
574 | ;; is specific to a backend and which does not map to any of the VC | |
575 | ;; generic concepts. | |
aae91380 | 576 | |
ba463d9e DN |
577 | ;;; Todo: |
578 | ||
ba463d9e DN |
579 | ;; - vc-update/vc-merge should deal with VC systems that don't |
580 | ;; update/merge on a file basis, but on a whole repository basis. | |
581 | ;; | |
fc30d544 DN |
582 | ;; - deal with push/pull operations. |
583 | ;; | |
584 | ;; - "snapshots" should be renamed to "branches", and thoroughly reworked. | |
585 | ;; | |
3b3cb336 DN |
586 | ;; - the backend sometimes knows when a file it opens has been marked |
587 | ;; by the VCS as having a "conflict". Find a way to pass this info - | |
588 | ;; to VC so that it can turn on smerge-mode when opening such a | |
589 | ;; file. | |
ba463d9e | 590 | ;; |
fc30d544 DN |
591 | ;; - add a generic mechanism for remembering the current branch names, |
592 | ;; display the branch name in the mode-line. Replace | |
593 | ;; vc-cvs-sticky-tag with that. | |
594 | ;; | |
5a84a937 DN |
595 | ;; - vc-diff should be able to show the diff for all files in a |
596 | ;; changeset, especially for VC systems that have per repository version numbers. | |
597 | ;; log-view should take advantage of this. | |
598 | ;; | |
599 | ;; - a way to do repository wide log (instead of just per file/fileset) is needed. | |
600 | ;; | |
ba463d9e DN |
601 | ;; - the *VC-log* buffer needs font-locking. |
602 | ;; | |
fc30d544 DN |
603 | ;; - make it easier to write logs. Maybe C-x 4 a should add to the log |
604 | ;; buffer, if one is present, instead of adding to the ChangeLog. | |
ba463d9e | 605 | ;; |
e166638d DN |
606 | ;; - make vc-state for all backends return 'unregistered instead of |
607 | ;; nil for unregistered files, then update vc-next-action. | |
608 | ;; | |
3b3cb336 DN |
609 | ;; - vc-register should register a fileset at a time. The backends |
610 | ;; already support this, only the front-end needs to be change to | |
611 | ;; handle multiple files at a time. | |
612 | ;; | |
d05665bc | 613 | ;; - add a mechanism for ignoring files. |
3b3cb336 | 614 | ;; |
d05665bc DN |
615 | ;; - vc-next-action should do something about 'missing files. Maybe |
616 | ;; just warn, or offer to checkout. | |
3b3cb336 | 617 | ;; |
d05665bc | 618 | ;; - decide if vc-status should replace vc-dired. |
d6f47dff | 619 | ;; |
d05665bc | 620 | ;; - vc-status needs mouse bindings. |
4ac7bfcf | 621 | ;; |
0cc8ac2b DN |
622 | ;; - vc-status needs more key bindings for VC actions. |
623 | ;; | |
d6f47dff | 624 | ;; - vc-status toolbar needs more icons. |
25a4ea6d | 625 | ;; |
400fc6ed DN |
626 | ;; - the dir-status backend function should take as an argument an |
627 | ;; optional fileset. and return the results just for that fileset. | |
628 | ;; This can be used to speed up status buffer updates after VC | |
629 | ;; operations. | |
630 | ;; | |
631 | ;; - keep the *vc-status* buffer sorted by file name. | |
632 | ;; | |
25a4ea6d DN |
633 | ;; - vc-status: refresh should not completely wipe out the current |
634 | ;; contents of the vc-status buffer. | |
635 | ;; | |
d3201e0b DN |
636 | ;; - vc-diff, vc-annotate, etc. need to deal better with unregistered |
637 | ;; files. Now that unregistered and ignored files are shown in | |
638 | ;; vc-dired/vc-status, it is possible that these commands are called | |
639 | ;; for unregistered/ignored files. | |
640 | ;; | |
3f08440f DN |
641 | ;; - do not default to RCS anymore when the current directory is not |
642 | ;; controlled by any VCS and the user does C-x v v | |
643 | ;; | |
ba463d9e | 644 | |
fcb500ea | 645 | ;;; Code: |
0e362f54 | 646 | |
594722a8 | 647 | (require 'vc-hooks) |
64db3a90 JD |
648 | (require 'tool-bar) |
649 | ||
0e362f54 | 650 | (eval-when-compile |
7849e179 | 651 | (require 'cl) |
099bd78a SM |
652 | (require 'dired) ; for dired-map-over-marks macro |
653 | (require 'dired-aux)) ; for dired-kill-{line,tree} | |
8c0aaf40 ER |
654 | |
655 | (if (not (assoc 'vc-parent-buffer minor-mode-alist)) | |
656 | (setq minor-mode-alist | |
657 | (cons '(vc-parent-buffer vc-parent-buffer-name) | |
658 | minor-mode-alist))) | |
594722a8 ER |
659 | |
660 | ;; General customization | |
661 | ||
0101cc40 RS |
662 | (defgroup vc nil |
663 | "Version-control system in Emacs." | |
664 | :group 'tools) | |
665 | ||
666 | (defcustom vc-suppress-confirm nil | |
04864eb0 | 667 | "If non-nil, treat user as expert; suppress yes-no prompts on some things." |
0101cc40 RS |
668 | :type 'boolean |
669 | :group 'vc) | |
670 | ||
2c4eea90 | 671 | (defcustom vc-delete-logbuf-window t |
04864eb0 | 672 | "If non-nil, delete the *VC-log* buffer and window after each logical action. |
2c4eea90 KH |
673 | If nil, bury that buffer instead. |
674 | This is most useful if you have multiple windows on a frame and would like to | |
675 | preserve the setting." | |
676 | :type 'boolean | |
677 | :group 'vc) | |
678 | ||
0101cc40 | 679 | (defcustom vc-initial-comment nil |
04864eb0 | 680 | "If non-nil, prompt for initial comment when a file is registered." |
0101cc40 RS |
681 | :type 'boolean |
682 | :group 'vc) | |
683 | ||
ac3f4c6f ER |
684 | (defcustom vc-default-init-revision "1.1" |
685 | "A string used as the default revision number when a new file is registered. | |
b470cb65 AS |
686 | This can be overridden by giving a prefix argument to \\[vc-register]. This |
687 | can also be overridden by a particular VC backend." | |
0d53f466 | 688 | :type 'string |
cd32a7ba DN |
689 | :group 'vc |
690 | :version "20.3") | |
0d53f466 | 691 | |
0101cc40 | 692 | (defcustom vc-command-messages nil |
04864eb0 | 693 | "If non-nil, display run messages from back-end commands." |
0101cc40 RS |
694 | :type 'boolean |
695 | :group 'vc) | |
696 | ||
697 | (defcustom vc-checkin-switches nil | |
04864eb0 | 698 | "A string or list of strings specifying extra switches for checkin. |
0101cc40 RS |
699 | These are passed to the checkin program by \\[vc-checkin]." |
700 | :type '(choice (const :tag "None" nil) | |
701 | (string :tag "Argument String") | |
702 | (repeat :tag "Argument List" | |
703 | :value ("") | |
704 | string)) | |
705 | :group 'vc) | |
706 | ||
707 | (defcustom vc-checkout-switches nil | |
04864eb0 | 708 | "A string or list of strings specifying extra switches for checkout. |
0101cc40 RS |
709 | These are passed to the checkout program by \\[vc-checkout]." |
710 | :type '(choice (const :tag "None" nil) | |
711 | (string :tag "Argument String") | |
712 | (repeat :tag "Argument List" | |
713 | :value ("") | |
714 | string)) | |
715 | :group 'vc) | |
716 | ||
717 | (defcustom vc-register-switches nil | |
04864eb0 | 718 | "A string or list of strings; extra switches for registering a file. |
0101cc40 RS |
719 | These are passed to the checkin program by \\[vc-register]." |
720 | :type '(choice (const :tag "None" nil) | |
721 | (string :tag "Argument String") | |
722 | (repeat :tag "Argument List" | |
723 | :value ("") | |
724 | string)) | |
725 | :group 'vc) | |
726 | ||
0e362f54 | 727 | (defcustom vc-dired-listing-switches "-al" |
04864eb0 | 728 | "Switches passed to `ls' for vc-dired. MUST contain the `l' option." |
0e362f54 GM |
729 | :type 'string |
730 | :group 'vc | |
6f41eeb5 | 731 | :version "21.1") |
0e362f54 | 732 | |
3b574573 | 733 | (defcustom vc-dired-recurse t |
04864eb0 | 734 | "If non-nil, show directory trees recursively in VC Dired." |
3b574573 AS |
735 | :type 'boolean |
736 | :group 'vc | |
737 | :version "20.3") | |
738 | ||
739 | (defcustom vc-dired-terse-display t | |
61de26cb | 740 | "If non-nil, show only locked or locally modified files in VC Dired." |
3b574573 AS |
741 | :type 'boolean |
742 | :group 'vc | |
743 | :version "20.3") | |
744 | ||
acc5b122 | 745 | (defcustom vc-diff-switches nil |
04864eb0 | 746 | "A string or list of strings specifying switches for diff under VC. |
b453817c AS |
747 | When running diff under a given BACKEND, VC concatenates the values of |
748 | `diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to | |
749 | get the switches for that command. Thus, `vc-diff-switches' should | |
750 | contain switches that are specific to version control, but not | |
751 | specific to any particular backend." | |
acc5b122 AS |
752 | :type '(choice (const :tag "None" nil) |
753 | (string :tag "Argument String") | |
754 | (repeat :tag "Argument List" | |
755 | :value ("") | |
756 | string)) | |
757 | :group 'vc | |
758 | :version "21.1") | |
759 | ||
48033a08 AS |
760 | (defcustom vc-diff-knows-L nil |
761 | "*Indicates whether diff understands the -L option. | |
762 | The value is either `yes', `no', or nil. If it is nil, VC tries | |
763 | to use -L and sets this variable to remember whether it worked." | |
764 | :type '(choice (const :tag "Work out" nil) (const yes) (const no)) | |
765 | :group 'vc) | |
766 | ||
f1d1d46a | 767 | (defcustom vc-allow-async-revert nil |
e4d26892 | 768 | "Specifies whether the diff during \\[vc-revert] may be asynchronous. |
f1d1d46a AS |
769 | Enabling this option means that you can confirm a revert operation even |
770 | if the local changes in the file have not been found and displayed yet." | |
771 | :type '(choice (const :tag "No" nil) | |
772 | (const :tag "Yes" t)) | |
773 | :group 'vc | |
bf247b6e | 774 | :version "22.1") |
f1d1d46a | 775 | |
7cad930d AS |
776 | ;;;###autoload |
777 | (defcustom vc-checkout-hook nil | |
04864eb0 | 778 | "Normal hook (list of functions) run after checking out a file. |
7cad930d AS |
779 | See `run-hooks'." |
780 | :type 'hook | |
781 | :group 'vc | |
782 | :version "21.1") | |
783 | ||
da7c8a12 | 784 | (defcustom vc-annotate-display-mode 'fullscale |
6f1ecae4 | 785 | "Which mode to color the output of \\[vc-annotate] with by default." |
da7c8a12 | 786 | :type '(choice (const :tag "By Color Map Range" nil) |
75665141 AS |
787 | (const :tag "Scale to Oldest" scale) |
788 | (const :tag "Scale Oldest->Newest" fullscale) | |
789 | (number :tag "Specify Fractional Number of Days" | |
790 | :value "20.5")) | |
791 | :group 'vc) | |
792 | ||
0e362f54 GM |
793 | ;;;###autoload |
794 | (defcustom vc-checkin-hook nil | |
61de26cb | 795 | "Normal hook (list of functions) run after commit or file checkin. |
1cca5da4 | 796 | See also `log-edit-done-hook'." |
0e362f54 | 797 | :type 'hook |
1cca5da4 | 798 | :options '(log-edit-comment-to-change-log) |
0e362f54 GM |
799 | :group 'vc) |
800 | ||
801 | ;;;###autoload | |
802 | (defcustom vc-before-checkin-hook nil | |
61de26cb | 803 | "Normal hook (list of functions) run before a commit or a file checkin. |
0e362f54 GM |
804 | See `run-hooks'." |
805 | :type 'hook | |
806 | :group 'vc) | |
807 | ||
808 | (defcustom vc-logentry-check-hook nil | |
04864eb0 | 809 | "Normal hook run by `vc-backend-logentry-check'. |
0e362f54 GM |
810 | Use this to impose your own rules on the entry in addition to any the |
811 | version control backend imposes itself." | |
812 | :type 'hook | |
813 | :group 'vc) | |
2e810285 | 814 | |
0e362f54 | 815 | ;; Annotate customization |
7d2d9482 | 816 | (defcustom vc-annotate-color-map |
da7c8a12 S |
817 | (if (and (tty-display-color-p) (<= (display-color-cells) 8)) |
818 | ;; A custom sorted TTY colormap | |
819 | (let* ((colors | |
820 | (sort | |
821 | (delq nil | |
822 | (mapcar (lambda (x) | |
823 | (if (not (or | |
824 | (string-equal (car x) "white") | |
825 | (string-equal (car x) "black") )) | |
826 | (car x))) | |
827 | (tty-color-alist))) | |
828 | (lambda (a b) | |
829 | (cond | |
830 | ((or (string-equal a "red") (string-equal b "blue")) t) | |
831 | ((or (string-equal b "red") (string-equal a "blue")) nil) | |
832 | ((string-equal a "yellow") t) | |
833 | ((string-equal b "yellow") nil) | |
834 | ((string-equal a "cyan") t) | |
835 | ((string-equal b "cyan") nil) | |
836 | ((string-equal a "green") t) | |
837 | ((string-equal b "green") nil) | |
838 | ((string-equal a "magenta") t) | |
839 | ((string-equal b "magenta") nil) | |
840 | (t (string< a b)))))) | |
841 | (date 20.) | |
842 | (delta (/ (- 360. date) (1- (length colors))))) | |
843 | (mapcar (lambda (x) | |
844 | (prog1 | |
845 | (cons date x) | |
846 | (setq date (+ date delta)))) colors)) | |
847 | ;; Normal colormap: hue stepped from 0-240deg, value=1., saturation=0.75 | |
848 | '(( 20. . "#FF3F3F") | |
849 | ( 40. . "#FF6C3F") | |
850 | ( 60. . "#FF993F") | |
851 | ( 80. . "#FFC63F") | |
852 | (100. . "#FFF33F") | |
853 | (120. . "#DDFF3F") | |
854 | (140. . "#B0FF3F") | |
855 | (160. . "#83FF3F") | |
856 | (180. . "#56FF3F") | |
857 | (200. . "#3FFF56") | |
858 | (220. . "#3FFF83") | |
859 | (240. . "#3FFFB0") | |
860 | (260. . "#3FFFDD") | |
861 | (280. . "#3FF3FF") | |
862 | (300. . "#3FC6FF") | |
863 | (320. . "#3F99FF") | |
864 | (340. . "#3F6CFF") | |
865 | (360. . "#3F3FFF"))) | |
04864eb0 | 866 | "Association list of age versus color, for \\[vc-annotate]. |
da7c8a12 S |
867 | Ages are given in units of fractional days. Default is eighteen |
868 | steps using a twenty day increment, from red to blue. For TTY | |
869 | displays with 8 or fewer colors, the default is red to blue with | |
870 | all other colors between (excluding black and white)." | |
0e362f54 | 871 | :type 'alist |
7d2d9482 RS |
872 | :group 'vc) |
873 | ||
da7c8a12 | 874 | (defcustom vc-annotate-very-old-color "#3F3FFF" |
04864eb0 | 875 | "Color for lines older than the current color range in \\[vc-annotate]]." |
7d2d9482 RS |
876 | :type 'string |
877 | :group 'vc) | |
878 | ||
879 | (defcustom vc-annotate-background "black" | |
04864eb0 | 880 | "Background color for \\[vc-annotate]. |
7d2d9482 | 881 | Default color is used if nil." |
14b7a0b5 | 882 | :type '(choice (const :tag "Default background" nil) (color)) |
7d2d9482 RS |
883 | :group 'vc) |
884 | ||
885 | (defcustom vc-annotate-menu-elements '(2 0.5 0.1 0.01) | |
04864eb0 | 886 | "Menu elements for the mode-specific menu of VC-Annotate mode. |
7d2d9482 | 887 | List of factors, used to expand/compress the time scale. See `vc-annotate'." |
0e362f54 | 888 | :type '(repeat number) |
7d2d9482 RS |
889 | :group 'vc) |
890 | ||
0e362f54 GM |
891 | (defvar vc-annotate-mode-map |
892 | (let ((m (make-sparse-keymap))) | |
04864eb0 SM |
893 | (define-key m "A" 'vc-annotate-revision-previous-to-line) |
894 | (define-key m "D" 'vc-annotate-show-diff-revision-at-line) | |
f3ff0fe9 | 895 | (define-key m "f" 'vc-annotate-find-revision-at-line) |
04864eb0 SM |
896 | (define-key m "J" 'vc-annotate-revision-at-line) |
897 | (define-key m "L" 'vc-annotate-show-log-revision-at-line) | |
ac3f4c6f ER |
898 | (define-key m "N" 'vc-annotate-next-revision) |
899 | (define-key m "P" 'vc-annotate-prev-revision) | |
900 | (define-key m "W" 'vc-annotate-working-revision) | |
5731a8e0 | 901 | (define-key m "V" 'vc-annotate-toggle-annotation-visibility) |
0e362f54 GM |
902 | m) |
903 | "Local keymap used for VC-Annotate mode.") | |
67242a23 | 904 | |
594722a8 ER |
905 | ;; Header-insertion hair |
906 | ||
0101cc40 | 907 | (defcustom vc-static-header-alist |
04864eb0 | 908 | '(("\\.c\\'" . |
594722a8 | 909 | "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n")) |
0e362f54 GM |
910 | "*Associate static header string templates with file types. |
911 | A \%s in the template is replaced with the first string associated with | |
099bd78a | 912 | the file's version control type in `vc-header-alist'." |
0101cc40 RS |
913 | :type '(repeat (cons :format "%v" |
914 | (regexp :tag "File Type") | |
915 | (string :tag "Header String"))) | |
916 | :group 'vc) | |
7b4f934d | 917 | |
0101cc40 | 918 | (defcustom vc-comment-alist |
594722a8 | 919 | '((nroff-mode ".\\\"" "")) |
6f1ecae4 | 920 | "*Special comment delimiters for generating VC headers. |
099bd78a SM |
921 | Add an entry in this list if you need to override the normal `comment-start' |
922 | and `comment-end' variables. This will only be necessary if the mode language | |
0101cc40 RS |
923 | is sensitive to blank lines." |
924 | :type '(repeat (list :format "%v" | |
925 | (symbol :tag "Mode") | |
926 | (string :tag "Comment Start") | |
927 | (string :tag "Comment End"))) | |
928 | :group 'vc) | |
594722a8 | 929 | |
0101cc40 | 930 | (defcustom vc-checkout-carefully (= (user-uid) 0) |
bf142f28 | 931 | "*Non-nil means be extra-careful in checkout. |
bbf97570 | 932 | Verify that the file really is not locked |
0101cc40 RS |
933 | and that its contents match what the master file says." |
934 | :type 'boolean | |
935 | :group 'vc) | |
bf142f28 JB |
936 | (make-obsolete-variable 'vc-checkout-carefully |
937 | "the corresponding checks are always done now." | |
938 | "21.1") | |
bbf97570 | 939 | |
0e362f54 | 940 | \f |
594722a8 | 941 | ;; Variables the user doesn't need to know about. |
594722a8 | 942 | (defvar vc-log-operation nil) |
67242a23 | 943 | (defvar vc-log-after-operation-hook nil) |
04864eb0 | 944 | |
dbf87856 RS |
945 | ;; In a log entry buffer, this is a local variable |
946 | ;; that points to the buffer for which it was made | |
947 | ;; (either a file, or a VC dired buffer). | |
1a2f456b | 948 | (defvar vc-parent-buffer nil) |
0e362f54 | 949 | (put 'vc-parent-buffer 'permanent-local t) |
8c0aaf40 | 950 | (defvar vc-parent-buffer-name nil) |
0e362f54 | 951 | (put 'vc-parent-buffer-name 'permanent-local t) |
594722a8 | 952 | |
f1d1d46a AS |
953 | (defvar vc-disable-async-diff nil |
954 | "VC sets this to t locally to disable some async diff operations. | |
955 | Backends that offer asynchronous diffs should respect this variable | |
956 | in their implementation of vc-BACKEND-diff.") | |
957 | ||
d7b60083 | 958 | (defvar vc-log-fileset) |
ac3f4c6f | 959 | (defvar vc-log-revision) |
db59472c | 960 | |
8c0aaf40 | 961 | (defvar vc-dired-mode nil) |
e1f297e6 ER |
962 | (make-variable-buffer-local 'vc-dired-mode) |
963 | ||
594722a8 ER |
964 | ;; File property caching |
965 | ||
8c0aaf40 | 966 | (defun vc-clear-context () |
11cdd167 | 967 | "Clear all cached file properties." |
8c0aaf40 | 968 | (interactive) |
11cdd167 | 969 | (fillarray vc-file-prop-obarray 0)) |
8c0aaf40 | 970 | |
d7b60083 ER |
971 | (defmacro with-vc-properties (files form settings) |
972 | "Execute FORM, then maybe set per-file properties for FILES. | |
6f1ecae4 AS |
973 | SETTINGS is an association list of property/value pairs. After |
974 | executing FORM, set those properties from SETTINGS that have not yet | |
975 | been updated to their corresponding values." | |
b4e4e3a8 | 976 | (declare (debug t)) |
169f0cae | 977 | `(let ((vc-touched-properties (list t))) |
099bd78a | 978 | ,form |
d7b60083 | 979 | (dolist (file ,files) |
a7192ddb SM |
980 | (dolist (setting ,settings) |
981 | (let ((property (car setting))) | |
982 | (unless (memq property vc-touched-properties) | |
983 | (put (intern file vc-file-prop-obarray) | |
984 | property (cdr setting)))))))) | |
099bd78a | 985 | |
ec402ad4 | 986 | ;; Two macros for elisp programming |
61de26cb | 987 | |
709822e8 AS |
988 | ;;;###autoload |
989 | (defmacro with-vc-file (file comment &rest body) | |
6f1ecae4 | 990 | "Check out a writable copy of FILE if necessary, then execute BODY. |
0e362f54 GM |
991 | Check in FILE with COMMENT (a string) after BODY has been executed. |
992 | FILE is passed through `expand-file-name'; BODY executed within | |
61de26cb | 993 | `save-excursion'. If FILE is not under version control, or you are |
a7192ddb | 994 | using a locking version-control system and the file is locked by |
709822e8 | 995 | somebody else, signal error." |
b4e4e3a8 | 996 | (declare (debug t) (indent 2)) |
169f0cae AS |
997 | (let ((filevar (make-symbol "file"))) |
998 | `(let ((,filevar (expand-file-name ,file))) | |
999 | (or (vc-backend ,filevar) | |
2df5044f | 1000 | (error "File not under version control: `%s'" file)) |
169f0cae AS |
1001 | (unless (vc-editable-p ,filevar) |
1002 | (let ((state (vc-state ,filevar))) | |
f1180544 | 1003 | (if (stringp state) |
2df5044f | 1004 | (error "`%s' is locking `%s'" state ,filevar) |
169f0cae AS |
1005 | (vc-checkout ,filevar t)))) |
1006 | (save-excursion | |
1007 | ,@body) | |
d7b60083 | 1008 | (vc-checkin (list ,filevar) nil ,comment)))) |
169f0cae | 1009 | |
709822e8 AS |
1010 | ;;;###autoload |
1011 | (defmacro edit-vc-file (file comment &rest body) | |
0e362f54 GM |
1012 | "Edit FILE under version control, executing body. |
1013 | Checkin with COMMENT after executing BODY. | |
709822e8 AS |
1014 | This macro uses `with-vc-file', passing args to it. |
1015 | However, before executing BODY, find FILE, and after BODY, save buffer." | |
b4e4e3a8 | 1016 | (declare (debug t) (indent 2)) |
169f0cae AS |
1017 | (let ((filevar (make-symbol "file"))) |
1018 | `(let ((,filevar (expand-file-name ,file))) | |
1019 | (with-vc-file | |
1020 | ,filevar ,comment | |
1021 | (set-buffer (find-file-noselect ,filevar)) | |
1022 | ,@body | |
1023 | (save-buffer))))) | |
1024 | ||
61de26cb ER |
1025 | ;; Common command execution logic to be used by backends |
1026 | ||
0e362f54 | 1027 | (defun vc-process-filter (p s) |
099bd78a | 1028 | "An alternative output filter for async process P. |
58ce5535 TTN |
1029 | One difference with the default filter is that this inserts S after markers. |
1030 | Another is that undo information is not kept." | |
fddde1f0 TTN |
1031 | (let ((buffer (process-buffer p))) |
1032 | (when (buffer-live-p buffer) | |
1033 | (with-current-buffer buffer | |
1034 | (save-excursion | |
1035 | (let ((buffer-undo-list t) | |
1036 | (inhibit-read-only t)) | |
1037 | (goto-char (process-mark p)) | |
1038 | (insert s) | |
1039 | (set-marker (process-mark p) (point)))))))) | |
0e362f54 GM |
1040 | |
1041 | (defun vc-setup-buffer (&optional buf) | |
6f1ecae4 | 1042 | "Prepare BUF for executing a VC command and make it current. |
0e362f54 GM |
1043 | BUF defaults to \"*vc*\", can be a string and will be created if necessary." |
1044 | (unless buf (setq buf "*vc*")) | |
1045 | (let ((camefrom (current-buffer)) | |
1046 | (olddir default-directory)) | |
1047 | (set-buffer (get-buffer-create buf)) | |
1048 | (kill-all-local-variables) | |
1049 | (set (make-local-variable 'vc-parent-buffer) camefrom) | |
1050 | (set (make-local-variable 'vc-parent-buffer-name) | |
1051 | (concat " from " (buffer-name camefrom))) | |
1052 | (setq default-directory olddir) | |
58ce5535 TTN |
1053 | (let ((buffer-undo-list t) |
1054 | (inhibit-read-only t)) | |
0e362f54 GM |
1055 | (erase-buffer)))) |
1056 | ||
86e80023 SM |
1057 | (defvar vc-sentinel-movepoint) ;Dynamically scoped. |
1058 | ||
1059 | (defun vc-process-sentinel (p s) | |
b49fd377 TTN |
1060 | (let ((previous (process-get p 'vc-previous-sentinel)) |
1061 | (buf (process-buffer p))) | |
b49fd377 TTN |
1062 | ;; Impatient users sometime kill "slow" buffers; check liveness |
1063 | ;; to avoid "error in process sentinel: Selecting deleted buffer". | |
1064 | (when (buffer-live-p buf) | |
fddde1f0 | 1065 | (if previous (funcall previous p s)) |
b49fd377 TTN |
1066 | (with-current-buffer buf |
1067 | (setq mode-line-process | |
1068 | (let ((status (process-status p))) | |
1069 | ;; Leave mode-line uncluttered, normally. | |
b49fd377 TTN |
1070 | (unless (eq 'exit status) |
1071 | (format " (%s)" status)))) | |
1072 | (let (vc-sentinel-movepoint) | |
1073 | ;; Normally, we want async code such as sentinels to not move point. | |
1074 | (save-excursion | |
1075 | (goto-char (process-mark p)) | |
1076 | (let ((cmds (process-get p 'vc-sentinel-commands))) | |
1077 | (process-put p 'vc-sentinel-commands nil) | |
1078 | (dolist (cmd cmds) | |
1079 | ;; Each sentinel may move point and the next one should be run | |
1080 | ;; at that new point. We could get the same result by having | |
1081 | ;; each sentinel read&set process-mark, but since `cmd' needs | |
1082 | ;; to work both for async and sync processes, this would be | |
1083 | ;; difficult to achieve. | |
1084 | (vc-exec-after cmd)))) | |
1085 | ;; But sometimes the sentinels really want to move point. | |
1086 | (if vc-sentinel-movepoint | |
1087 | (let ((win (get-buffer-window (current-buffer) 0))) | |
1088 | (if (not win) | |
1089 | (goto-char vc-sentinel-movepoint) | |
1090 | (with-selected-window win | |
1091 | (goto-char vc-sentinel-movepoint)))))))))) | |
86e80023 | 1092 | |
d3201e0b DN |
1093 | (defun vc-set-mode-line-busy-indicator () |
1094 | (setq mode-line-process | |
c2062c3b GM |
1095 | (concat " " (propertize "[waiting...]" |
1096 | 'face 'mode-line-emphasis | |
1097 | 'help-echo | |
1098 | "A VC command is in progress in this buffer")))) | |
d3201e0b | 1099 | |
0e362f54 GM |
1100 | (defun vc-exec-after (code) |
1101 | "Eval CODE when the current buffer's process is done. | |
1102 | If the current buffer has no process, just evaluate CODE. | |
1103 | Else, add CODE to the process' sentinel." | |
1104 | (let ((proc (get-buffer-process (current-buffer)))) | |
1105 | (cond | |
1106 | ;; If there's no background process, just execute the code. | |
0f7ea453 CY |
1107 | ;; We used to explicitly call delete-process on exited processes, |
1108 | ;; but this led to timing problems causing process output to be | |
1109 | ;; lost. Terminated processes get deleted automatically | |
1110 | ;; anyway. -- cyd | |
1111 | ((or (null proc) (eq (process-status proc) 'exit)) | |
7c33af85 SM |
1112 | ;; Make sure we've read the process's output before going further. |
1113 | (if proc (accept-process-output proc)) | |
0f7ea453 | 1114 | (eval code)) |
0e362f54 GM |
1115 | ;; If a process is running, add CODE to the sentinel |
1116 | ((eq (process-status proc) 'run) | |
d3201e0b | 1117 | (vc-set-mode-line-busy-indicator) |
86e80023 SM |
1118 | (let ((previous (process-sentinel proc))) |
1119 | (unless (eq previous 'vc-process-sentinel) | |
1120 | (process-put proc 'vc-previous-sentinel previous)) | |
1121 | (set-process-sentinel proc 'vc-process-sentinel)) | |
1122 | (process-put proc 'vc-sentinel-commands | |
1d5b2149 TTN |
1123 | ;; We keep the code fragments in the order given |
1124 | ;; so that vc-diff-finish's message shows up in | |
1125 | ;; the presence of non-nil vc-command-messages. | |
1126 | (append (process-get proc 'vc-sentinel-commands) | |
1127 | (list code)))) | |
0e362f54 GM |
1128 | (t (error "Unexpected process state")))) |
1129 | nil) | |
1130 | ||
1131 | (defvar vc-post-command-functions nil | |
1132 | "Hook run at the end of `vc-do-command'. | |
1133 | Each function is called inside the buffer in which the command was run | |
d7b60083 | 1134 | and is passed 3 arguments: the COMMAND, the FILES and the FLAGS.") |
0e362f54 | 1135 | |
2765044b DN |
1136 | (defvar w32-quote-process-args) |
1137 | ||
8cdd17b4 ER |
1138 | (defun vc-delistify (filelist) |
1139 | "Smash a FILELIST into a file list string suitable for info messages." | |
2765044b | 1140 | ;; FIXME what about file names with spaces? |
d1a607bc | 1141 | (if (not filelist) "." (mapconcat 'identity filelist " "))) |
8cdd17b4 | 1142 | |
a84b80ba | 1143 | ;;;###autoload |
8cdd17b4 | 1144 | (defun vc-do-command (buffer okstatus command file-or-list &rest flags) |
6f1ecae4 | 1145 | "Execute a VC command, notifying user and checking for errors. |
ad339989 AS |
1146 | Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil or the |
1147 | current buffer if BUFFER is t. If the destination buffer is not | |
1148 | already current, set it up properly and erase it. The command is | |
1149 | considered successful if its exit status does not exceed OKSTATUS (if | |
c94dca60 | 1150 | OKSTATUS is nil, that means to ignore error status, if it is `async', that |
11c89a07 | 1151 | means not to wait for termination of the subprocess; if it is t it means to |
8cdd17b4 | 1152 | ignore all execution errors). FILE-OR-LIST is the name of a working file; |
a7192ddb | 1153 | it may be a list of files or be nil (to execute commands that don't expect |
8cdd17b4 | 1154 | a file name or set of files). If an optional list of FLAGS is present, |
0e362f54 | 1155 | that is inserted into the command line before the filename." |
8cdd17b4 ER |
1156 | ;; FIXME: file-relative-name can return a bogus result because |
1157 | ;; it doesn't look at the actual file-system to see if symlinks | |
1158 | ;; come into play. | |
d1a607bc SM |
1159 | (let* ((files |
1160 | (mapcar (lambda (f) (file-relative-name (expand-file-name f))) | |
1161 | (if (listp file-or-list) file-or-list (list file-or-list)))) | |
d7b60083 | 1162 | (full-command |
a7192ddb | 1163 | ;; What we're doing here is preparing a version of the command |
d7b60083 | 1164 | ;; for display in a debug-progess message. If it's fewer than |
a7192ddb | 1165 | ;; 20 characters display the entire command (without trailing |
d7b60083 ER |
1166 | ;; newline). Otherwise display the first 20 followed by an ellipsis. |
1167 | (concat (if (string= (substring command -1) "\n") | |
1168 | (substring command 0 -1) | |
1169 | command) | |
a7192ddb SM |
1170 | " " |
1171 | (vc-delistify (mapcar (lambda (s) (if (> (length s) 20) (concat (substring s 0 2) "...") s)) flags)) | |
d7b60083 | 1172 | " " (vc-delistify files)))) |
8cdd17b4 ER |
1173 | (save-current-buffer |
1174 | (unless (or (eq buffer t) | |
1175 | (and (stringp buffer) | |
1176 | (string= (buffer-name) buffer)) | |
1177 | (eq buffer (current-buffer))) | |
1178 | (vc-setup-buffer buffer)) | |
f605fc58 SM |
1179 | ;; If there's some previous async process still running, just kill it. |
1180 | (let ((oldproc (get-buffer-process (current-buffer)))) | |
1181 | ;; If we wanted to wait for oldproc to finish before doing | |
1182 | ;; something, we'd have used vc-eval-after. | |
1183 | ;; Use `delete-process' rather than `kill-process' because we don't | |
1184 | ;; want any of its output to appear from now on. | |
1185 | (if oldproc (delete-process oldproc))) | |
8cdd17b4 ER |
1186 | (let ((squeezed (remq nil flags)) |
1187 | (inhibit-read-only t) | |
1188 | (status 0)) | |
1189 | (when files | |
1190 | (setq squeezed (nconc squeezed files))) | |
1191 | (let ((exec-path (append vc-path exec-path)) | |
1192 | ;; Add vc-path to PATH for the execution of this command. | |
1193 | (process-environment | |
1194 | (cons (concat "PATH=" (getenv "PATH") | |
1195 | path-separator | |
1196 | (mapconcat 'identity vc-path path-separator)) | |
1197 | process-environment)) | |
1198 | (w32-quote-process-args t)) | |
1199 | (if (and (eq okstatus 'async) (file-remote-p default-directory)) | |
1200 | ;; start-process does not support remote execution | |
1201 | (setq okstatus nil)) | |
1202 | (if (eq okstatus 'async) | |
f605fc58 | 1203 | ;; Run asynchronously. |
8cdd17b4 ER |
1204 | (let ((proc |
1205 | (let ((process-connection-type nil)) | |
f605fc58 SM |
1206 | (apply 'start-file-process command (current-buffer) |
1207 | command squeezed)))) | |
d7b60083 ER |
1208 | (if vc-command-messages |
1209 | (message "Running %s in background..." full-command)) | |
8cdd17b4 ER |
1210 | ;;(set-process-sentinel proc (lambda (p msg) (delete-process p))) |
1211 | (set-process-filter proc 'vc-process-filter) | |
1212 | (vc-exec-after | |
d7b60083 ER |
1213 | `(if vc-command-messages |
1214 | (message "Running %s in background... done" ',full-command)))) | |
1215 | ;; Run synchrously | |
1216 | (if vc-command-messages | |
1217 | (message "Running %s in foreground..." full-command)) | |
8cdd17b4 ER |
1218 | (let ((buffer-undo-list t)) |
1219 | (setq status (apply 'process-file command nil t nil squeezed))) | |
1220 | (when (and (not (eq t okstatus)) | |
1221 | (or (not (integerp status)) | |
1222 | (and okstatus (< okstatus status)))) | |
f42d59a5 SM |
1223 | (unless (eq ?\s (aref (buffer-name (current-buffer)) 0)) |
1224 | (pop-to-buffer (current-buffer)) | |
1225 | (goto-char (point-min)) | |
1226 | (shrink-window-if-larger-than-buffer)) | |
8cdd17b4 ER |
1227 | (error "Running %s...FAILED (%s)" full-command |
1228 | (if (integerp status) (format "status %d" status) status)))) | |
e0752dd7 ER |
1229 | ;; We're done. But don't emit a status message if running |
1230 | ;; asychronously, it would just mislead. | |
1231 | (if (and vc-command-messages (not (eq okstatus 'async))) | |
d7b60083 | 1232 | (message "Running %s...OK = %d" full-command status))) |
8cdd17b4 | 1233 | (vc-exec-after |
a7192ddb | 1234 | `(run-hook-with-args 'vc-post-command-functions |
d7b60083 | 1235 | ',command ',file-or-list ',flags)) |
8cdd17b4 | 1236 | status)))) |
594722a8 | 1237 | |
c4ae7096 | 1238 | (defun vc-position-context (posn) |
099bd78a SM |
1239 | "Save a bit of the text around POSN in the current buffer. |
1240 | Used to help us find the corresponding position again later | |
1241 | if markers are destroyed or corrupted." | |
0e362f54 GM |
1242 | ;; A lot of this was shamelessly lifted from Sebastian Kremer's |
1243 | ;; rcs.el mode. | |
c4ae7096 JB |
1244 | (list posn |
1245 | (buffer-size) | |
1246 | (buffer-substring posn | |
1247 | (min (point-max) (+ posn 100))))) | |
1248 | ||
c4ae7096 | 1249 | (defun vc-find-position-by-context (context) |
6f1ecae4 AS |
1250 | "Return the position of CONTEXT in the current buffer. |
1251 | If CONTEXT cannot be found, return nil." | |
c4ae7096 JB |
1252 | (let ((context-string (nth 2 context))) |
1253 | (if (equal "" context-string) | |
1254 | (point-max) | |
1255 | (save-excursion | |
1256 | (let ((diff (- (nth 1 context) (buffer-size)))) | |
1257 | (if (< diff 0) (setq diff (- diff))) | |
1258 | (goto-char (nth 0 context)) | |
1259 | (if (or (search-forward context-string nil t) | |
1260 | ;; Can't use search-backward since the match may continue | |
1261 | ;; after point. | |
1262 | (progn (goto-char (- (point) diff (length context-string))) | |
1263 | ;; goto-char doesn't signal an error at | |
1264 | ;; beginning of buffer like backward-char would | |
1265 | (search-forward context-string nil t))) | |
1266 | ;; to beginning of OSTRING | |
1267 | (- (point) (length context-string)))))))) | |
1268 | ||
4b398f5d | 1269 | (defun vc-context-matches-p (posn context) |
099bd78a | 1270 | "Return t if POSN matches CONTEXT, nil otherwise." |
4b398f5d AS |
1271 | (let* ((context-string (nth 2 context)) |
1272 | (len (length context-string)) | |
1273 | (end (+ posn len))) | |
1274 | (if (> end (1+ (buffer-size))) | |
1275 | nil | |
1276 | (string= context-string (buffer-substring posn end))))) | |
1277 | ||
c8de1d91 | 1278 | (defun vc-buffer-context () |
099bd78a SM |
1279 | "Return a list (POINT-CONTEXT MARK-CONTEXT REPARSE). |
1280 | Used by `vc-restore-buffer-context' to later restore the context." | |
c4ae7096 | 1281 | (let ((point-context (vc-position-context (point))) |
cfadef63 RS |
1282 | ;; Use mark-marker to avoid confusion in transient-mark-mode. |
1283 | (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer)) | |
1284 | (vc-position-context (mark-marker)))) | |
1285 | ;; Make the right thing happen in transient-mark-mode. | |
ab877583 | 1286 | (mark-active nil) |
0452b6e7 SM |
1287 | ;; The new compilation code does not use compilation-error-list any |
1288 | ;; more, so the code below is now ineffective and might as well | |
1289 | ;; be disabled. -- Stef | |
1290 | ;; ;; We may want to reparse the compilation buffer after revert | |
1291 | ;; (reparse (and (boundp 'compilation-error-list) ;compile loaded | |
1292 | ;; ;; Construct a list; each elt is nil or a buffer | |
4837b516 | 1293 | ;; ;; if that buffer is a compilation output buffer |
0452b6e7 SM |
1294 | ;; ;; that contains markers into the current buffer. |
1295 | ;; (save-current-buffer | |
1296 | ;; (mapcar (lambda (buffer) | |
1297 | ;; (set-buffer buffer) | |
1298 | ;; (let ((errors (or | |
1299 | ;; compilation-old-error-list | |
1300 | ;; compilation-error-list)) | |
1301 | ;; (buffer-error-marked-p nil)) | |
1302 | ;; (while (and (consp errors) | |
1303 | ;; (not buffer-error-marked-p)) | |
1304 | ;; (and (markerp (cdr (car errors))) | |
1305 | ;; (eq buffer | |
1306 | ;; (marker-buffer | |
1307 | ;; (cdr (car errors)))) | |
1308 | ;; (setq buffer-error-marked-p t)) | |
1309 | ;; (setq errors (cdr errors))) | |
1310 | ;; (if buffer-error-marked-p buffer))) | |
1311 | ;; (buffer-list))))) | |
1312 | (reparse nil)) | |
c8de1d91 AS |
1313 | (list point-context mark-context reparse))) |
1314 | ||
1315 | (defun vc-restore-buffer-context (context) | |
0e362f54 | 1316 | "Restore point/mark, and reparse any affected compilation buffers. |
099bd78a | 1317 | CONTEXT is that which `vc-buffer-context' returns." |
c8de1d91 AS |
1318 | (let ((point-context (nth 0 context)) |
1319 | (mark-context (nth 1 context)) | |
a7192ddb SM |
1320 | ;; (reparse (nth 2 context)) |
1321 | ) | |
0452b6e7 SM |
1322 | ;; The new compilation code does not use compilation-error-list any |
1323 | ;; more, so the code below is now ineffective and might as well | |
1324 | ;; be disabled. -- Stef | |
1325 | ;; ;; Reparse affected compilation buffers. | |
1326 | ;; (while reparse | |
1327 | ;; (if (car reparse) | |
1328 | ;; (with-current-buffer (car reparse) | |
1329 | ;; (let ((compilation-last-buffer (current-buffer)) ;select buffer | |
1330 | ;; ;; Record the position in the compilation buffer of | |
1331 | ;; ;; the last error next-error went to. | |
1332 | ;; (error-pos (marker-position | |
1333 | ;; (car (car-safe compilation-error-list))))) | |
1334 | ;; ;; Reparse the error messages as far as they were parsed before. | |
1335 | ;; (compile-reinitialize-errors '(4) compilation-parsing-end) | |
1336 | ;; ;; Move the pointer up to find the error we were at before | |
1337 | ;; ;; reparsing. Now next-error should properly go to the next one. | |
1338 | ;; (while (and compilation-error-list | |
1339 | ;; (/= error-pos (car (car compilation-error-list)))) | |
1340 | ;; (setq compilation-error-list (cdr compilation-error-list)))))) | |
1341 | ;; (setq reparse (cdr reparse))) | |
e1f297e6 | 1342 | |
4b398f5d AS |
1343 | ;; if necessary, restore point and mark |
1344 | (if (not (vc-context-matches-p (point) point-context)) | |
1345 | (let ((new-point (vc-find-position-by-context point-context))) | |
1346 | (if new-point (goto-char new-point)))) | |
01e02ab3 AS |
1347 | (and mark-active |
1348 | mark-context | |
1349 | (not (vc-context-matches-p (mark) mark-context)) | |
1350 | (let ((new-mark (vc-find-position-by-context mark-context))) | |
1351 | (if new-mark (set-mark new-mark)))))) | |
c4ae7096 | 1352 | |
d7b60083 ER |
1353 | ;;; Code for deducing what fileset and backend to assume |
1354 | ||
2765044b DN |
1355 | (defun vc-responsible-backend (file &optional register) |
1356 | "Return the name of a backend system that is responsible for FILE. | |
1357 | The optional argument REGISTER means that a backend suitable for | |
1358 | registration should be found. | |
1359 | ||
1360 | If REGISTER is nil, then if FILE is already registered, return the | |
1361 | backend of FILE. If FILE is not registered, or a directory, then the | |
1362 | first backend in `vc-handled-backends' that declares itself | |
1363 | responsible for FILE is returned. If no backend declares itself | |
1364 | responsible, return the first backend. | |
1365 | ||
1366 | If REGISTER is non-nil, return the first responsible backend under | |
1367 | which FILE is not yet registered. If there is no such backend, return | |
1368 | the first backend under which FILE is not yet registered, but could | |
1369 | be registered." | |
1370 | (if (not vc-handled-backends) | |
1371 | (error "No handled backends")) | |
1372 | (or (and (not (file-directory-p file)) (not register) (vc-backend file)) | |
1373 | (catch 'found | |
1374 | ;; First try: find a responsible backend. If this is for registration, | |
1375 | ;; it must be a backend under which FILE is not yet registered. | |
1376 | (dolist (backend vc-handled-backends) | |
1377 | (and (or (not register) | |
1378 | (not (vc-call-backend backend 'registered file))) | |
1379 | (vc-call-backend backend 'responsible-p file) | |
1380 | (throw 'found backend))) | |
1381 | ;; no responsible backend | |
1382 | (if (not register) | |
1383 | ;; if this is not for registration, the first backend must do | |
1384 | (car vc-handled-backends) | |
1385 | ;; for registration, we need to find a new backend that | |
1386 | ;; could register FILE | |
1387 | (dolist (backend vc-handled-backends) | |
1388 | (and (not (vc-call-backend backend 'registered file)) | |
1389 | (vc-call-backend backend 'could-register file) | |
1390 | (throw 'found backend))) | |
1391 | (error "No backend that could register"))))) | |
1392 | ||
1393 | (defun vc-expand-dirs (file-or-dir-list) | |
1394 | "Expands directories in a file list specification. | |
1395 | Only files already under version control are noticed." | |
1396 | ;; FIXME: Kill this function. | |
1397 | (let ((flattened '())) | |
1398 | (dolist (node file-or-dir-list) | |
1399 | (vc-file-tree-walk | |
1400 | node (lambda (f) (if (vc-backend f) (push f flattened))))) | |
1401 | (nreverse flattened))) | |
1402 | ||
ccd9fab6 | 1403 | (defun vc-deduce-fileset (&optional allow-directory-wildcard allow-unregistered) |
a7192ddb SM |
1404 | "Deduce a set of files and a backend to which to apply an operation. |
1405 | ||
1406 | If we're in VC-dired mode, the fileset is the list of marked files. | |
1407 | Otherwise, if we're looking at a buffer visiting a version-controlled file, | |
1408 | the fileset is a singleton containing this file. | |
1409 | If neither of these things is true, but ALLOW-DIRECTORY-WILDCARD is on | |
1410 | and we're in a dired buffer, select the current directory. | |
ccd9fab6 ER |
1411 | If none of these conditions is met, but ALLOW_UNREGISTERED is in and the |
1412 | visited file is not registered, return a singletin fileset containing it. | |
a7192ddb SM |
1413 | Otherwise, throw an error." |
1414 | (cond (vc-dired-mode | |
1415 | (let ((marked (dired-map-over-marks (dired-get-filename) nil))) | |
d7b60083 ER |
1416 | (unless marked |
1417 | (error "No files have been selected.")) | |
1418 | ;; All members of the fileset must have the same backend | |
1419 | (let ((firstbackend (vc-backend (car marked)))) | |
a7192ddb SM |
1420 | (dolist (f (cdr marked)) |
1421 | (unless (eq (vc-backend f) firstbackend) | |
1422 | (error "All members of a fileset must be under the same version-control system.")))) | |
d7b60083 | 1423 | marked)) |
e11c1d93 DN |
1424 | ((eq major-mode 'vc-status-mode) |
1425 | (let ((marked (vc-status-marked-files))) | |
1426 | (if marked | |
1427 | marked | |
1428 | (list (vc-status-current-file))))) | |
1429 | ((vc-backend buffer-file-name) | |
d7b60083 | 1430 | (list buffer-file-name)) |
d24182bb DN |
1431 | ((and vc-parent-buffer (or (buffer-file-name vc-parent-buffer) |
1432 | (with-current-buffer vc-parent-buffer | |
76cdeb7d | 1433 | (or vc-dired-mode (eq major-mode 'vc-status-mode))))) |
d7b60083 ER |
1434 | (progn |
1435 | (set-buffer vc-parent-buffer) | |
1436 | (vc-deduce-fileset))) | |
a7192ddb SM |
1437 | ;; This is guarded by an enabling arg so users won't potentially |
1438 | ;; shoot themselves in the foot by modifying a fileset they can't | |
d7b60083 ER |
1439 | ;; verify by eyeball. Allow it for nondestructive commands like |
1440 | ;; making diffs, or possibly for destructive ones that have | |
1441 | ;; confirmation prompts. | |
a7192ddb SM |
1442 | ((and allow-directory-wildcard |
1443 | ;; I think this is a misfeature. For now, I'll leave it in, but | |
1444 | ;; I'll disable it anywhere else than in dired buffers. --Stef | |
1445 | (and (derived-mode-p 'dired-mode) | |
1446 | (equal buffer-file-name nil) | |
1447 | (equal list-buffers-directory default-directory))) | |
d7b60083 | 1448 | (progn |
d7b60083 ER |
1449 | (message "All version-controlled files below %s selected." |
1450 | default-directory) | |
1451 | (list default-directory))) | |
01823b77 | 1452 | ((and allow-unregistered (not (vc-registered buffer-file-name))) |
ccd9fab6 | 1453 | (list buffer-file-name)) |
d7b60083 ER |
1454 | (t (error "No fileset is available here.")))) |
1455 | ||
2765044b DN |
1456 | (defun vc-ensure-vc-buffer () |
1457 | "Make sure that the current buffer visits a version-controlled file." | |
ca8dfeda DN |
1458 | (cond |
1459 | (vc-dired-mode | |
1460 | (set-buffer (find-file-noselect (dired-get-filename)))) | |
1461 | ((eq major-mode 'vc-status-mode) | |
1462 | (set-buffer (find-file-noselect (vc-status-current-file)))) | |
1463 | (t | |
772111be | 1464 | (while (and vc-parent-buffer |
cc72026b | 1465 | (buffer-live-p vc-parent-buffer) |
772111be MR |
1466 | ;; Avoid infinite looping when vc-parent-buffer and |
1467 | ;; current buffer are the same buffer. | |
1468 | (not (eq vc-parent-buffer (current-buffer)))) | |
2765044b DN |
1469 | (set-buffer vc-parent-buffer)) |
1470 | (if (not buffer-file-name) | |
1471 | (error "Buffer %s is not associated with a file" (buffer-name)) | |
1472 | (if (not (vc-backend buffer-file-name)) | |
ca8dfeda | 1473 | (error "File %s is not under version control" buffer-file-name)))))) |
2765044b | 1474 | |
61de26cb ER |
1475 | ;;; Support for the C-x v v command. This is where all the single-file-oriented |
1476 | ;;; code from before the fileset rewrite lives. | |
1477 | ||
2765044b DN |
1478 | (defsubst vc-editable-p (file) |
1479 | "Return non-nil if FILE can be edited." | |
1480 | (or (eq (vc-checkout-model file) 'implicit) | |
1481 | (memq (vc-state file) '(edited needs-merge)))) | |
1482 | ||
61de26cb | 1483 | (defun vc-revert-buffer-internal (&optional arg no-confirm) |
6f1ecae4 | 1484 | "Revert buffer, keeping point and mark where user expects them. |
ac3f4c6f | 1485 | Try to be clever in the face of changes due to expanded version-control |
099bd78a SM |
1486 | key words. This is important for typeahead to work as expected. |
1487 | ARG and NO-CONFIRM are passed on to `revert-buffer'." | |
c8de1d91 AS |
1488 | (interactive "P") |
1489 | (widen) | |
1490 | (let ((context (vc-buffer-context))) | |
4b398f5d AS |
1491 | ;; Use save-excursion here, because it may be able to restore point |
1492 | ;; and mark properly even in cases where vc-restore-buffer-context | |
0e362f54 | 1493 | ;; would fail. However, save-excursion might also get it wrong -- |
4b398f5d AS |
1494 | ;; in this case, vc-restore-buffer-context gives it a second try. |
1495 | (save-excursion | |
0e362f54 | 1496 | ;; t means don't call normal-mode; |
4b398f5d AS |
1497 | ;; that's to preserve various minor modes. |
1498 | (revert-buffer arg no-confirm t)) | |
c8de1d91 AS |
1499 | (vc-restore-buffer-context context))) |
1500 | ||
97d3f950 | 1501 | (defun vc-buffer-sync (&optional not-urgent) |
099bd78a | 1502 | "Make sure the current buffer and its working file are in sync. |
0e362f54 | 1503 | NOT-URGENT means it is ok to continue if the user says not to save." |
bbf97570 | 1504 | (if (buffer-modified-p) |
97d3f950 RS |
1505 | (if (or vc-suppress-confirm |
1506 | (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name)))) | |
1507 | (save-buffer) | |
0e362f54 | 1508 | (unless not-urgent |
97d3f950 RS |
1509 | (error "Aborted"))))) |
1510 | ||
2765044b DN |
1511 | (defvar vc-dired-window-configuration) |
1512 | ||
484c1b1f ER |
1513 | (defun vc-compatible-state (p q) |
1514 | "Controls which states can be in the same commit." | |
1515 | (or | |
1516 | (eq p q) | |
1517 | (and (member p '(edited added removed)) (member q '(edited added removed))))) | |
1518 | ||
2765044b DN |
1519 | ;; Here's the major entry point. |
1520 | ||
1521 | ;;;###autoload | |
1522 | (defun vc-next-action (verbose) | |
d7b60083 ER |
1523 | "Do the next logical version control operation on the current fileset. |
1524 | This requires that all files in the fileset be in the same state. | |
2765044b | 1525 | |
d7b60083 ER |
1526 | For locking systems: |
1527 | If every file is not already registered, this registers each for version | |
2765044b | 1528 | control. |
d7b60083 ER |
1529 | If every file is registered and not locked by anyone, this checks out |
1530 | a writable and locked file of each ready for editing. | |
1531 | If every file is checked out and locked by the calling user, this | |
1532 | first checks to see if each file has changed since checkout. If not, | |
1533 | it performs a revert on that file. | |
1534 | If every file has been changed, this pops up a buffer for entry | |
2765044b DN |
1535 | of a log message; when the message has been entered, it checks in the |
1536 | resulting changes along with the log message as change commentary. If | |
1537 | the variable `vc-keep-workfiles' is non-nil (which is its default), a | |
d7b60083 ER |
1538 | read-only copy of each changed file is left in place afterwards. |
1539 | If the affected file is registered and locked by someone else, you are | |
1540 | given the option to steal the lock(s). | |
1541 | ||
1542 | For merging systems: | |
1543 | If every file is not already registered, this registers each one for version | |
1544 | control. This does an add, but not a commit. | |
1545 | If every file is added but not committed, each one is committed. | |
1546 | If every working file is changed, but the corresponding repository file is | |
2765044b DN |
1547 | unchanged, this pops up a buffer for entry of a log message; when the |
1548 | message has been entered, it checks in the resulting changes along | |
1549 | with the logmessage as change commentary. A writable file is retained. | |
1550 | If the repository file is changed, you are asked if you want to | |
1551 | merge in the changes into your working copy." | |
2765044b | 1552 | (interactive "P") |
ccd9fab6 | 1553 | (let* ((files (vc-deduce-fileset nil t)) |
d7b60083 ER |
1554 | (state (vc-state (car files))) |
1555 | (model (vc-checkout-model (car files))) | |
ac3f4c6f | 1556 | revision) |
d7b60083 ER |
1557 | ;; Verify that the fileset is homogenous |
1558 | (dolist (file (cdr files)) | |
e166638d DN |
1559 | (unless (vc-compatible-state (vc-state file) state) |
1560 | (error "Fileset is in a mixed-up state")) | |
1561 | (unless (eq (vc-checkout-model file) model) | |
d7b60083 ER |
1562 | (error "Fileset has mixed checkout models"))) |
1563 | ;; Check for buffers in the fileset not matching the on-disk contents. | |
1564 | (dolist (file files) | |
1565 | (let ((visited (get-file-buffer file))) | |
1566 | (when visited | |
76cdeb7d | 1567 | (if (or vc-dired-mode (eq major-mode 'vc-status-mode)) |
d7b60083 ER |
1568 | (switch-to-buffer-other-window visited) |
1569 | (set-buffer visited)) | |
1570 | ;; Check relation of buffer and file, and make sure | |
1571 | ;; user knows what he's doing. First, finding the file | |
1572 | ;; will check whether the file on disk is newer. | |
1573 | ;; Ignore buffer-read-only during this test, and | |
1574 | ;; preserve find-file-literally. | |
1575 | (let ((buffer-read-only (not (file-writable-p file)))) | |
1576 | (find-file-noselect file nil find-file-literally)) | |
1577 | (if (not (verify-visited-file-modtime (current-buffer))) | |
1578 | (if (yes-or-no-p (format "Replace %s on disk with buffer contents? " file)) | |
1579 | (write-file buffer-file-name) | |
1580 | (error "Aborted")) | |
1581 | ;; Now, check if we have unsaved changes. | |
1582 | (vc-buffer-sync t) | |
e166638d DN |
1583 | (when (buffer-modified-p) |
1584 | (or (y-or-n-p (message "Use %s on disk, keeping modified buffer? " file)) | |
1585 | (error "Aborted"))))))) | |
0e362f54 | 1586 | ;; Do the right thing |
a7192ddb | 1587 | (cond |
d7b60083 | 1588 | ;; Files aren't registered |
e166638d DN |
1589 | ((or (not state) ;; RCS uses nil for unregistered files. |
1590 | (eq state 'unregistered) | |
1591 | (eq state 'ignored)) | |
d7b60083 | 1592 | (mapc 'vc-register files)) |
ac3f4c6f | 1593 | ;; Files are up-to-date, or need a merge and user specified a revision |
d7b60083 | 1594 | ((or (eq state 'up-to-date) (and verbose (eq state 'needs-patch))) |
0e362f54 | 1595 | (cond |
d7b60083 | 1596 | (verbose |
ac3f4c6f ER |
1597 | ;; go to a different revision |
1598 | (setq revision (read-string "Branch, revision, or backend to move to: ")) | |
1599 | (let ((vsym (intern-soft (upcase revision)))) | |
d7b60083 | 1600 | (if (member vsym vc-handled-backends) |
a7192ddb SM |
1601 | (dolist (file files) (vc-transfer-file file vsym)) |
1602 | (dolist (file files) | |
1603 | (vc-checkout file (eq model 'implicit) revision))))) | |
d7b60083 ER |
1604 | ((not (eq model 'implicit)) |
1605 | ;; check the files out | |
a7192ddb | 1606 | (dolist (file files) (vc-checkout file t))) |
d7b60083 | 1607 | (t |
a7192ddb SM |
1608 | ;; do nothing |
1609 | (message "Fileset is up-to-date")))) | |
1610 | ;; Files have local changes | |
484c1b1f | 1611 | ((vc-compatible-state state 'edited) |
d7b60083 ER |
1612 | (let ((ready-for-commit files)) |
1613 | ;; If files are edited but read-only, give user a chance to correct | |
1614 | (dolist (file files) | |
e166638d DN |
1615 | (unless (file-writable-p file) |
1616 | ;; Make the file+buffer read-write. | |
1617 | (unless (y-or-n-p (format "%s is edited but read-only; make it writable and continue?" file)) | |
1618 | (error "Aborted")) | |
1619 | (set-file-modes file (logior (file-modes file) 128)) | |
1620 | (let ((visited (get-file-buffer file))) | |
1621 | (when visited | |
1622 | (with-current-buffer visited | |
1623 | (toggle-read-only -1)))))) | |
d7b60083 ER |
1624 | ;; Allow user to revert files with no changes |
1625 | (save-excursion | |
a7192ddb SM |
1626 | (dolist (file files) |
1627 | (let ((visited (get-file-buffer file))) | |
1628 | ;; For files with locking, if the file does not contain | |
1629 | ;; any changes, just let go of the lock, i.e. revert. | |
e166638d DN |
1630 | (when (and (not (eq model 'implicit)) |
1631 | (vc-workfile-unchanged-p file) | |
1632 | ;; If buffer is modified, that means the user just | |
1633 | ;; said no to saving it; in that case, don't revert, | |
1634 | ;; because the user might intend to save after | |
1635 | ;; finishing the log entry and committing. | |
1636 | (not (and visited (buffer-modified-p)))) | |
1637 | (vc-revert-file file) | |
1638 | (delete file ready-for-commit))))) | |
d7b60083 ER |
1639 | ;; Remaining files need to be committed |
1640 | (if (not ready-for-commit) | |
1641 | (message "No files remain to be committed") | |
1d502d5a | 1642 | (if (not verbose) |
d7b60083 ER |
1643 | (vc-checkin ready-for-commit) |
1644 | (progn | |
ac3f4c6f ER |
1645 | (setq revision (read-string "New revision or backend: ")) |
1646 | (let ((vsym (intern (upcase revision)))) | |
d7b60083 | 1647 | (if (member vsym vc-handled-backends) |
d36122a2 | 1648 | (dolist (file files) (vc-transfer-file file vsym)) |
ac3f4c6f | 1649 | (vc-checkin ready-for-commit revision)))))))) |
d7b60083 ER |
1650 | ;; locked by somebody else (locking VCSes only) |
1651 | ((stringp state) | |
d36122a2 TTN |
1652 | ;; In the old days, we computed the revision once and used it on |
1653 | ;; the single file. Then, for the 2007-2008 fileset rewrite, we | |
1654 | ;; computed the revision once (incorrectly, using a free var) and | |
1655 | ;; used it on all files. To fix the free var bug, we can either | |
1656 | ;; use `(car files)' or do what we do here: distribute the | |
1657 | ;; revision computation among `files'. Although this may be | |
1658 | ;; tedious for those backends where a "revision" is a trans-file | |
1659 | ;; concept, it is nonetheless correct for both those and (more | |
1660 | ;; importantly) for those where "revision" is a per-file concept. | |
1661 | ;; If the intersection of the former group and "locking VCSes" is | |
1662 | ;; non-empty [I vaguely doubt it --ttn], we can reinstate the | |
1663 | ;; pre-computation approach of yore. | |
1664 | (dolist (file files) | |
1665 | (vc-steal-lock | |
1666 | file (if verbose | |
1667 | (read-string (format "%s revision to steal: " file)) | |
1668 | (vc-working-revision file)) | |
1669 | state))) | |
a7192ddb | 1670 | ;; needs-patch |
d7b60083 ER |
1671 | ((eq state 'needs-patch) |
1672 | (dolist (file files) | |
6f41eeb5 | 1673 | (if (yes-or-no-p (format |
ac3f4c6f | 1674 | "%s is not up-to-date. Get latest revision? " |
0e362f54 | 1675 | (file-name-nondirectory file))) |
d7b60083 | 1676 | (vc-checkout file (eq model 'implicit) t) |
e166638d DN |
1677 | (when (and (not (eq model 'implicit)) |
1678 | (yes-or-no-p "Lock this revision? ")) | |
1679 | (vc-checkout file t))))) | |
d7b60083 ER |
1680 | ;; needs-merge |
1681 | ((eq state 'needs-merge) | |
1682 | (dolist (file files) | |
e166638d | 1683 | (when (yes-or-no-p (format |
0e362f54 GM |
1684 | "%s is not up-to-date. Merge in changes now? " |
1685 | (file-name-nondirectory file))) | |
e166638d | 1686 | (vc-maybe-resolve-conflicts file (vc-call merge-news file))))) |
46e33aee | 1687 | |
d7b60083 ER |
1688 | ;; unlocked-changes |
1689 | ((eq state 'unlocked-changes) | |
1690 | (dolist (file files) | |
a7192ddb | 1691 | (if (not (equal buffer-file-name file)) |
d7b60083 | 1692 | (find-file-other-window file)) |
0e362f54 | 1693 | (if (save-window-excursion |
a7192ddb | 1694 | (vc-diff-internal nil (list file) (vc-working-revision file) nil) |
0e362f54 | 1695 | (goto-char (point-min)) |
ceec5a0c | 1696 | (let ((inhibit-read-only t)) |
f4f34b33 | 1697 | (insert |
ceec5a0c | 1698 | (format "Changes to %s since last lock:\n\n" file))) |
0e362f54 GM |
1699 | (not (beep)) |
1700 | (yes-or-no-p (concat "File has unlocked changes. " | |
1701 | "Claim lock retaining changes? "))) | |
1702 | (progn (vc-call steal-lock file) | |
61de26cb | 1703 | (clear-visited-file-modtime) |
0e362f54 GM |
1704 | ;; Must clear any headers here because they wouldn't |
1705 | ;; show that the file is locked now. | |
1706 | (vc-clear-headers file) | |
a36319a4 | 1707 | (write-file buffer-file-name) |
0e362f54 GM |
1708 | (vc-mode-line file)) |
1709 | (if (not (yes-or-no-p | |
ac3f4c6f | 1710 | "Revert to checked-in revision, instead? ")) |
0e362f54 | 1711 | (error "Checkout aborted") |
61de26cb | 1712 | (vc-revert-buffer-internal t t) |
0e362f54 | 1713 | (vc-checkout file t)))))))) |
e1f297e6 | 1714 | |
61de26cb ER |
1715 | (defun vc-create-repo (backend) |
1716 | "Create an empty repository in the current directory." | |
1717 | (interactive | |
1718 | (list | |
1719 | (intern | |
1720 | (upcase | |
1721 | (completing-read | |
1722 | "Create repository for: " | |
1723 | (mapcar (lambda (b) (list (downcase (symbol-name b)))) vc-handled-backends) | |
1724 | nil t))))) | |
1725 | (vc-call-backend backend 'create-repo)) | |
1726 | ||
637a8ae9 | 1727 | ;;;###autoload |
30a308aa DN |
1728 | (defun vc-register (&optional fname set-revision comment) |
1729 | "Register into a version control system. | |
1730 | If FNAME is given register that file, otherwise register the current file. | |
ac3f4c6f | 1731 | With prefix argument SET-REVISION, allow user to specify initial revision |
2765044b | 1732 | level. If COMMENT is present, use that as an initial comment. |
0e362f54 | 1733 | |
2765044b DN |
1734 | The version control system to use is found by cycling through the list |
1735 | `vc-handled-backends'. The first backend in that list which declares | |
1736 | itself responsible for the file (usually because other files in that | |
1737 | directory are already registered under that backend) will be used to | |
1738 | register the file. If no backend declares itself responsible, the | |
1739 | first backend that could register the file is used." | |
1740 | (interactive "P") | |
30a308aa DN |
1741 | (when (and (null fname) (null buffer-file-name)) (error "No visited file")) |
1742 | ||
5f01100a | 1743 | (let ((bname (if fname (get-file-buffer fname) (current-buffer)))) |
30a308aa DN |
1744 | (unless fname (setq fname buffer-file-name)) |
1745 | (when (vc-backend fname) | |
1746 | (if (vc-registered fname) | |
1747 | (error "This file is already registered") | |
1748 | (unless (y-or-n-p "Previous master file has vanished. Make a new one? ") | |
1749 | (error "Aborted")))) | |
1750 | ;; Watch out for new buffers of size 0: the corresponding file | |
1751 | ;; does not exist yet, even though buffer-modified-p is nil. | |
1752 | (when bname | |
1753 | (with-current-buffer bname | |
1754 | (if (and (not (buffer-modified-p)) | |
1755 | (zerop (buffer-size)) | |
1756 | (not (file-exists-p buffer-file-name))) | |
1757 | (set-buffer-modified-p t)) | |
1758 | (vc-buffer-sync))) | |
1759 | (vc-start-entry (list fname) | |
1760 | (if set-revision | |
1761 | (read-string (format "Initial revision level for %s: " | |
1762 | fname)) | |
1763 | (vc-call-backend (vc-responsible-backend fname) | |
1764 | 'init-revision)) | |
1765 | (or comment (not vc-initial-comment)) | |
1766 | nil | |
1767 | "Enter initial comment." | |
1768 | (lambda (files rev comment) | |
1769 | (dolist (file files) | |
1770 | (message "Registering %s... " file) | |
1771 | (let ((backend (vc-responsible-backend file t))) | |
1772 | (vc-file-clearprops file) | |
1773 | (vc-call-backend backend 'register (list file) rev comment) | |
1774 | (vc-file-setprop file 'vc-backend backend) | |
1775 | (unless vc-make-backup-files | |
1776 | (make-local-variable 'backup-inhibited) | |
1777 | (setq backup-inhibited t))) | |
1778 | (message "Registering %s... done" file)))))) | |
d7b60083 ER |
1779 | |
1780 | (defun vc-register-with (backend) | |
1781 | "Register the current file with a specified back end." | |
1782 | (interactive "SBackend: ") | |
1783 | (if (not (member backend vc-handled-backends)) | |
1784 | (error "Unknown back end.")) | |
1785 | (let ((vc-handled-backends (list backend))) | |
1786 | (call-interactively 'vc-register))) | |
8989ab56 | 1787 | |
73e72da4 DN |
1788 | (declare-function view-mode-exit "view" (&optional return-to-alist exit-action all-win)) |
1789 | ||
624b4662 | 1790 | (defun vc-resynch-window (file &optional keep noquery) |
099bd78a SM |
1791 | "If FILE is in the current buffer, either revert or unvisit it. |
1792 | The choice between revert (to see expanded keywords) and unvisit depends on | |
1793 | `vc-keep-workfiles'. NOQUERY if non-nil inhibits confirmation for | |
0e362f54 GM |
1794 | reverting. NOQUERY should be t *only* if it is known the only |
1795 | difference between the buffer and the file is due to version control | |
1796 | rather than user editing!" | |
594722a8 ER |
1797 | (and (string= buffer-file-name file) |
1798 | (if keep | |
1799 | (progn | |
61de26cb | 1800 | (vc-revert-buffer-internal t noquery) |
0e362f54 GM |
1801 | ;; TODO: Adjusting view mode might no longer be necessary |
1802 | ;; after RMS change to files.el of 1999-08-08. Investigate | |
1803 | ;; this when we install the new VC. | |
f8791ebe AS |
1804 | (and view-read-only |
1805 | (if (file-writable-p file) | |
1806 | (and view-mode | |
1807 | (let ((view-old-buffer-read-only nil)) | |
1808 | (view-mode-exit))) | |
1809 | (and (not view-mode) | |
1810 | (not (eq (get major-mode 'mode-class) 'special)) | |
1811 | (view-mode-enter)))) | |
594722a8 | 1812 | (vc-mode-line buffer-file-name)) |
88a2ffaf | 1813 | (kill-buffer (current-buffer))))) |
594722a8 | 1814 | |
503b5c85 | 1815 | (defun vc-resynch-buffer (file &optional keep noquery) |
0e362f54 | 1816 | "If FILE is currently visited, resynch its buffer." |
4b398f5d AS |
1817 | (if (string= buffer-file-name file) |
1818 | (vc-resynch-window file keep noquery) | |
1819 | (let ((buffer (get-file-buffer file))) | |
21f3a277 DN |
1820 | (when buffer |
1821 | (with-current-buffer buffer | |
1822 | (vc-resynch-window file keep noquery))))) | |
1823 | (vc-dired-resynch-file file) | |
1824 | (when (memq 'vc-status-mark-buffer-changed after-save-hook) | |
1825 | (let ((buffer (get-file-buffer file))) | |
484c3092 | 1826 | (vc-status-mark-buffer-changed file)))) |
21f3a277 | 1827 | |
503b5c85 | 1828 | |
d7b60083 ER |
1829 | (defun vc-start-entry (files rev comment initial-contents msg action &optional after-hook) |
1830 | "Accept a comment for an operation on FILES revision REV. | |
6f41eeb5 | 1831 | If COMMENT is nil, pop up a VC-log buffer, emit MSG, and set the |
0ab66291 AS |
1832 | action on close to ACTION. If COMMENT is a string and |
1833 | INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial | |
1834 | contents of the log entry buffer. If COMMENT is a string and | |
1835 | INITIAL-CONTENTS is nil, do action immediately as if the user had | |
1836 | entered COMMENT. If COMMENT is t, also do action immediately with an | |
46e33aee TTN |
1837 | empty comment. Remember the file's buffer in `vc-parent-buffer' |
1838 | \(current one if no file). AFTER-HOOK specifies the local value | |
e166638d | 1839 | for `vc-log-after-operation-hook'." |
a7192ddb | 1840 | (let ((parent |
76cdeb7d | 1841 | (if (or (eq major-mode 'vc-dired-mode) (eq major-mode 'vc-status-mode)) |
c27f56ee DN |
1842 | ;; If we are called from VC dired, the parent buffer is |
1843 | ;; the current buffer. | |
1844 | (current-buffer) | |
1845 | (if (and files (equal (length files) 1)) | |
1846 | (get-file-buffer (car files)) | |
1847 | (current-buffer))))) | |
1848 | (when vc-before-checkin-hook | |
1849 | (if files | |
1850 | (with-current-buffer parent | |
1851 | (run-hooks 'vc-before-checkin-hook)) | |
1852 | (run-hooks 'vc-before-checkin-hook))) | |
0ab66291 | 1853 | (if (and comment (not initial-contents)) |
e1f297e6 ER |
1854 | (set-buffer (get-buffer-create "*VC-log*")) |
1855 | (pop-to-buffer (get-buffer-create "*VC-log*"))) | |
8c0aaf40 ER |
1856 | (set (make-local-variable 'vc-parent-buffer) parent) |
1857 | (set (make-local-variable 'vc-parent-buffer-name) | |
1858 | (concat " from " (buffer-name vc-parent-buffer))) | |
d7b60083 ER |
1859 | ;;(if file (vc-mode-line file)) |
1860 | (vc-log-edit files) | |
b965445f | 1861 | (make-local-variable 'vc-log-after-operation-hook) |
c27f56ee DN |
1862 | (when after-hook |
1863 | (setq vc-log-after-operation-hook after-hook)) | |
e1f297e6 | 1864 | (setq vc-log-operation action) |
ac3f4c6f | 1865 | (setq vc-log-revision rev) |
347bef30 SM |
1866 | (when comment |
1867 | (erase-buffer) | |
1868 | (when (stringp comment) (insert comment))) | |
1869 | (if (or (not comment) initial-contents) | |
1870 | (message "%s Type C-c C-c when done" msg) | |
1871 | (vc-finish-logentry (eq comment t))))) | |
e1f297e6 | 1872 | |
c6d4f628 | 1873 | (defun vc-checkout (file &optional writable rev) |
099bd78a SM |
1874 | "Retrieve a copy of the revision REV of FILE. |
1875 | If WRITABLE is non-nil, make sure the retrieved file is writable. | |
133a84aa AS |
1876 | REV defaults to the latest revision. |
1877 | ||
1878 | After check-out, runs the normal hook `vc-checkout-hook'." | |
ffda0460 AS |
1879 | (and writable |
1880 | (not rev) | |
10b48cc4 | 1881 | (vc-call make-version-backups-p file) |
ffda0460 | 1882 | (vc-up-to-date-p file) |
10b48cc4 | 1883 | (vc-make-version-backup file)) |
099bd78a | 1884 | (with-vc-properties |
d7b60083 | 1885 | (list file) |
099bd78a SM |
1886 | (condition-case err |
1887 | (vc-call checkout file writable rev) | |
1888 | (file-error | |
1889 | ;; Maybe the backend is not installed ;-( | |
1890 | (when writable | |
1891 | (let ((buf (get-file-buffer file))) | |
1892 | (when buf (with-current-buffer buf (toggle-read-only -1))))) | |
1893 | (signal (car err) (cdr err)))) | |
a3255400 SM |
1894 | `((vc-state . ,(if (or (eq (vc-checkout-model file) 'implicit) |
1895 | (not writable)) | |
1896 | (if (vc-call latest-on-branch-p file) | |
1897 | 'up-to-date | |
1898 | 'needs-patch) | |
1899 | 'edited)) | |
1900 | (vc-checkout-time . ,(nth 5 (file-attributes file))))) | |
7cad930d AS |
1901 | (vc-resynch-buffer file t t) |
1902 | (run-hooks 'vc-checkout-hook)) | |
594722a8 | 1903 | |
0e362f54 | 1904 | (defun vc-steal-lock (file rev owner) |
099bd78a | 1905 | "Steal the lock on FILE." |
29fc1ce9 | 1906 | (let (file-description) |
29fc1ce9 RS |
1907 | (if rev |
1908 | (setq file-description (format "%s:%s" file rev)) | |
1909 | (setq file-description file)) | |
4bc504c8 RS |
1910 | (if (not (yes-or-no-p (format "Steal the lock on %s from %s? " |
1911 | file-description owner))) | |
0e362f54 | 1912 | (error "Steal canceled")) |
869131a5 AS |
1913 | (message "Stealing lock on %s..." file) |
1914 | (with-vc-properties | |
d7b60083 | 1915 | (list file) |
869131a5 AS |
1916 | (vc-call steal-lock file rev) |
1917 | `((vc-state . edited))) | |
1918 | (vc-resynch-buffer file t t) | |
1919 | (message "Stealing lock on %s...done" file) | |
1920 | ;; Write mail after actually stealing, because if the stealing | |
1921 | ;; goes wrong, we don't want to send any mail. | |
1922 | (compose-mail owner (format "Stolen lock on %s" file-description)) | |
29fc1ce9 | 1923 | (setq default-directory (expand-file-name "~/")) |
29fc1ce9 RS |
1924 | (goto-char (point-max)) |
1925 | (insert | |
1926 | (format "I stole the lock on %s, " file-description) | |
1927 | (current-time-string) | |
1928 | ".\n") | |
1929 | (message "Please explain why you stole the lock. Type C-c C-c when done."))) | |
594722a8 | 1930 | |
d7b60083 ER |
1931 | (defun vc-checkin (files &optional rev comment initial-contents) |
1932 | "Check in FILES. | |
ac3f4c6f | 1933 | The optional argument REV may be a string specifying the new revision |
0e362f54 | 1934 | level (if nil increment the current level). COMMENT is a comment |
0ab66291 AS |
1935 | string; if omitted, a buffer is popped up to accept a comment. If |
1936 | INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents | |
1937 | of the log entry buffer. | |
0e362f54 GM |
1938 | |
1939 | If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided | |
1940 | that the version control system supports this mode of operation. | |
861f3c29 DL |
1941 | |
1942 | Runs the normal hook `vc-checkin-hook'." | |
6f41eeb5 | 1943 | (vc-start-entry |
d7b60083 | 1944 | files rev comment initial-contents |
6f41eeb5 | 1945 | "Enter a change comment." |
d7b60083 ER |
1946 | (lambda (files rev comment) |
1947 | (message "Checking in %s..." (vc-delistify files)) | |
0e362f54 GM |
1948 | ;; "This log message intentionally left almost blank". |
1949 | ;; RCS 5.7 gripes about white-space-only comments too. | |
1950 | (or (and comment (string-match "[^\t\n ]" comment)) | |
1951 | (setq comment "*** empty log message ***")) | |
46e33aee | 1952 | (with-vc-properties |
d7b60083 ER |
1953 | files |
1954 | ;; We used to change buffers to get local value of vc-checkin-switches, | |
1955 | ;; but 'the' local buffer is not a well-defined concept for filesets. | |
1956 | (progn | |
1957 | (vc-call checkin files rev comment) | |
1958 | (mapc 'vc-delete-automatic-version-backups files)) | |
a3255400 SM |
1959 | `((vc-state . up-to-date) |
1960 | (vc-checkout-time . ,(nth 5 (file-attributes file))) | |
ac3f4c6f | 1961 | (vc-working-revision . nil))) |
d7b60083 | 1962 | (message "Checking in %s...done" (vc-delistify files))) |
0e362f54 | 1963 | 'vc-checkin-hook)) |
594722a8 | 1964 | |
8c0aaf40 | 1965 | (defun vc-finish-logentry (&optional nocomment) |
6f1ecae4 AS |
1966 | "Complete the operation implied by the current log entry. |
1967 | Use the contents of the current buffer as a check-in or registration | |
1968 | comment. If the optional arg NOCOMMENT is non-nil, then don't check | |
11cdd167 | 1969 | the buffer contents as a comment." |
594722a8 | 1970 | (interactive) |
8c0aaf40 | 1971 | ;; Check and record the comment, if any. |
0e362f54 GM |
1972 | (unless nocomment |
1973 | ;; Comment too long? | |
a7192ddb | 1974 | (vc-call-backend (or (if vc-log-fileset (vc-backend vc-log-fileset)) |
0e362f54 GM |
1975 | (vc-responsible-backend default-directory)) |
1976 | 'logentry-check) | |
11cdd167 | 1977 | (run-hooks 'vc-logentry-check-hook)) |
b2396d1f | 1978 | ;; Sync parent buffer in case the user modified it while editing the comment. |
cdaf7a1a | 1979 | ;; But not if it is a vc-dired buffer. |
0e362f54 | 1980 | (with-current-buffer vc-parent-buffer |
76cdeb7d | 1981 | (or vc-dired-mode (eq major-mode 'vc-status-mode) (vc-buffer-sync))) |
d6ba9c39 ER |
1982 | (if (not vc-log-operation) |
1983 | (error "No log operation is pending")) | |
61dee1e7 AS |
1984 | ;; save the parameters held in buffer-local variables |
1985 | (let ((log-operation vc-log-operation) | |
d7b60083 | 1986 | (log-fileset vc-log-fileset) |
ac3f4c6f | 1987 | (log-revision vc-log-revision) |
61dee1e7 | 1988 | (log-entry (buffer-string)) |
2c4eea90 KH |
1989 | (after-hook vc-log-after-operation-hook) |
1990 | (tmp-vc-parent-buffer vc-parent-buffer)) | |
e2bef5c3 | 1991 | (pop-to-buffer vc-parent-buffer) |
61dee1e7 AS |
1992 | ;; OK, do it to it |
1993 | (save-excursion | |
0e362f54 | 1994 | (funcall log-operation |
d7b60083 | 1995 | log-fileset |
ac3f4c6f | 1996 | log-revision |
61dee1e7 | 1997 | log-entry)) |
df1e7b91 KH |
1998 | ;; Remove checkin window (after the checkin so that if that fails |
1999 | ;; we don't zap the *VC-log* buffer and the typing therein). | |
2000 | (let ((logbuf (get-buffer "*VC-log*"))) | |
2c4eea90 KH |
2001 | (cond ((and logbuf vc-delete-logbuf-window) |
2002 | (delete-windows-on logbuf (selected-frame)) | |
262c8cea | 2003 | ;; Kill buffer and delete any other dedicated windows/frames. |
2c4eea90 | 2004 | (kill-buffer logbuf)) |
0ab66291 AS |
2005 | (logbuf (pop-to-buffer "*VC-log*") |
2006 | (bury-buffer) | |
2007 | (pop-to-buffer tmp-vc-parent-buffer)))) | |
e2bef5c3 | 2008 | ;; Now make sure we see the expanded headers |
d7b60083 | 2009 | (if log-fileset |
a7192ddb SM |
2010 | (mapc |
2011 | (lambda (file) (vc-resynch-buffer file vc-keep-workfiles t)) | |
d7b60083 | 2012 | log-fileset)) |
76cdeb7d | 2013 | (if (or vc-dired-mode (eq major-mode 'vc-status-mode)) |
0ab66291 | 2014 | (dired-move-to-filename)) |
37667a5c | 2015 | (run-hooks after-hook 'vc-finish-logentry-hook))) |
594722a8 | 2016 | |
2765044b DN |
2017 | ;;; Additional entry points for examining version histories |
2018 | ||
a7192ddb SM |
2019 | ;; (defun vc-default-diff-tree (backend dir rev1 rev2) |
2020 | ;; "List differences for all registered files at and below DIR. | |
2021 | ;; The meaning of REV1 and REV2 is the same as for `vc-revision-diff'." | |
2022 | ;; ;; This implementation does an explicit tree walk, and calls | |
2023 | ;; ;; vc-BACKEND-diff directly for each file. An optimization | |
2024 | ;; ;; would be to use `vc-diff-internal', so that diffs can be local, | |
2025 | ;; ;; and to call it only for files that are actually changed. | |
2026 | ;; ;; However, this is expensive for some backends, and so it is left | |
2027 | ;; ;; to backend-specific implementations. | |
2028 | ;; (setq default-directory dir) | |
2029 | ;; (vc-file-tree-walk | |
2030 | ;; default-directory | |
2031 | ;; (lambda (f) | |
2032 | ;; (vc-exec-after | |
2033 | ;; `(let ((coding-system-for-read (vc-coding-system-for-diff ',f))) | |
2034 | ;; (message "Looking at %s" ',f) | |
2035 | ;; (vc-call-backend ',(vc-backend f) | |
2036 | ;; 'diff (list ',f) ',rev1 ',rev2)))))) | |
2765044b DN |
2037 | |
2038 | (defun vc-coding-system-for-diff (file) | |
2039 | "Return the coding system for reading diff output for FILE." | |
2040 | (or coding-system-for-read | |
2041 | ;; if we already have this file open, | |
2042 | ;; use the buffer's coding system | |
2043 | (let ((buf (find-buffer-visiting file))) | |
2044 | (if buf (with-current-buffer buf | |
2045 | buffer-file-coding-system))) | |
2046 | ;; otherwise, try to find one based on the file name | |
2047 | (car (find-operation-coding-system 'insert-file-contents file)) | |
2048 | ;; and a final fallback | |
2049 | 'undecided)) | |
2050 | ||
2051 | (defun vc-switches (backend op) | |
2052 | (let ((switches | |
2053 | (or (if backend | |
2054 | (let ((sym (vc-make-backend-sym | |
2055 | backend (intern (concat (symbol-name op) | |
2056 | "-switches"))))) | |
2057 | (if (boundp sym) (symbol-value sym)))) | |
2058 | (let ((sym (intern (format "vc-%s-switches" (symbol-name op))))) | |
2059 | (if (boundp sym) (symbol-value sym))) | |
2060 | (cond | |
2061 | ((eq op 'diff) diff-switches))))) | |
2062 | (if (stringp switches) (list switches) | |
2063 | ;; If not a list, return nil. | |
2064 | ;; This is so we can set vc-diff-switches to t to override | |
2065 | ;; any switches in diff-switches. | |
2066 | (if (listp switches) switches)))) | |
594722a8 | 2067 | |
2765044b DN |
2068 | ;; Old def for compatibility with Emacs-21.[123]. |
2069 | (defmacro vc-diff-switches-list (backend) `(vc-switches ',backend 'diff)) | |
2070 | (make-obsolete 'vc-diff-switches-list 'vc-switches "22.1") | |
2071 | ||
1d5b2149 | 2072 | (defun vc-diff-finish (buffer messages) |
17f3909f | 2073 | ;; The empty sync output case has already been handled, so the only |
fddde1f0 | 2074 | ;; possibility of an empty output is for an async process. |
1d5b2149 TTN |
2075 | (when (buffer-live-p buffer) |
2076 | (let ((window (get-buffer-window buffer t)) | |
2077 | (emptyp (zerop (buffer-size buffer)))) | |
2078 | (with-current-buffer buffer | |
2079 | (and messages emptyp | |
2080 | (let ((inhibit-read-only t)) | |
2081 | (insert (cdr messages) ".\n") | |
2082 | (message "%s" (cdr messages)))) | |
2083 | (goto-char (point-min)) | |
fddde1f0 | 2084 | (when window |
1d5b2149 TTN |
2085 | (shrink-window-if-larger-than-buffer window))) |
2086 | (when (and messages (not emptyp)) | |
2087 | (message "%sdone" (car messages)))))) | |
d7b60083 | 2088 | |
a7192ddb SM |
2089 | (defvar vc-diff-added-files nil |
2090 | "If non-nil, diff added files by comparing them to /dev/null.") | |
2091 | ||
2092 | (defun vc-diff-internal (async files rev1 rev2 &optional verbose) | |
d7b60083 ER |
2093 | "Report diffs between two revisions of a fileset. |
2094 | Diff output goes to the *vc-diff* buffer. The function | |
2095 | returns t if the buffer had changes, nil otherwise." | |
1d5b2149 TTN |
2096 | (let* ((messages (cons (format "Finding changes in %s..." |
2097 | (vc-delistify files)) | |
2098 | (format "No changes between %s and %s" | |
2099 | (or rev1 "working revision") | |
2100 | (or rev2 "workfile")))) | |
d7b60083 ER |
2101 | ;; Set coding system based on the first file. It's a kluge, |
2102 | ;; but the only way to set it for each file included would | |
2103 | ;; be to call the back end separately for each file. | |
a7192ddb | 2104 | (coding-system-for-read |
d7b60083 ER |
2105 | (if files (vc-coding-system-for-diff (car files)) 'undecided))) |
2106 | (vc-setup-buffer "*vc-diff*") | |
1d5b2149 | 2107 | (message "%s" (car messages)) |
a7192ddb SM |
2108 | ;; Many backends don't handle well the case of a file that has been |
2109 | ;; added but not yet committed to the repo (notably CVS and Subversion). | |
2110 | ;; Do that work here so the backends don't have to futz with it. --ESR | |
2111 | ;; | |
2112 | ;; Actually most backends (including CVS) have options to control the | |
2113 | ;; behavior since which one is better depends on the user and on the | |
2114 | ;; situation). Worse yet: this code does not handle the case where | |
2115 | ;; `file' is a directory which contains added files. | |
2116 | ;; I made it conditional on vc-diff-added-files but it should probably | |
2117 | ;; just be removed (or copied/moved to specific backends). --Stef. | |
2118 | (when vc-diff-added-files | |
2119 | (let ((filtered '())) | |
2120 | (dolist (file files) | |
2121 | (if (or (file-directory-p file) | |
2122 | (not (string= (vc-working-revision file) "0"))) | |
2123 | (push file filtered) | |
2124 | ;; This file is added but not yet committed; | |
2125 | ;; there is no master file to diff against. | |
2126 | (if (or rev1 rev2) | |
2127 | (error "No revisions of %s exist" file) | |
2128 | ;; We regard this as "changed". | |
2129 | ;; Diff it against /dev/null. | |
2130 | (apply 'vc-do-command "*vc-diff*" | |
2131 | 1 "diff" file | |
2132 | (append (vc-switches nil 'diff) '("/dev/null")))))) | |
2133 | (setq files (nreverse filtered)))) | |
2134 | (let ((vc-disable-async-diff (not async))) | |
2135 | (vc-call diff files rev1 rev2 "*vc-diff*")) | |
d7b60083 | 2136 | (set-buffer "*vc-diff*") |
17f3909f SM |
2137 | (if (and (zerop (buffer-size)) |
2138 | (not (get-buffer-process (current-buffer)))) | |
2139 | ;; Treat this case specially so as not to pop the buffer. | |
2140 | (progn | |
1d5b2149 | 2141 | (message "%s" (cdr messages)) |
17f3909f | 2142 | nil) |
e83d1fe8 | 2143 | (diff-mode) |
fe1919ab DN |
2144 | ;; Make the *vc-diff* buffer read only, the diff-mode key |
2145 | ;; bindings are nicer for read only buffers. pcl-cvs does the | |
2146 | ;; same thing. | |
2147 | (setq buffer-read-only t) | |
1d5b2149 TTN |
2148 | (vc-exec-after `(vc-diff-finish ,(current-buffer) ',(when verbose |
2149 | messages))) | |
4befebc1 SM |
2150 | ;; Display the buffer, but at the end because it can change point. |
2151 | (pop-to-buffer (current-buffer)) | |
17f3909f SM |
2152 | ;; In the async case, we return t even if there are no differences |
2153 | ;; because we don't know that yet. | |
2154 | t))) | |
594722a8 | 2155 | |
637a8ae9 | 2156 | ;;;###autoload |
a7192ddb | 2157 | (defun vc-version-diff (files rev1 rev2) |
d7b60083 | 2158 | "Report diffs between revisions of the fileset in the repository history." |
0e362f54 | 2159 | (interactive |
d7b60083 ER |
2160 | (let* ((files (vc-deduce-fileset t)) |
2161 | (first (car files)) | |
d7b60083 | 2162 | (completion-table |
a7192ddb | 2163 | (vc-call revision-completion-table files)) |
d7b60083 ER |
2164 | (rev1-default nil) |
2165 | (rev2-default nil)) | |
c0d66cb2 | 2166 | (cond |
ac3f4c6f | 2167 | ;; someday we may be able to do revision completion on non-singleton |
d7b60083 ER |
2168 | ;; filesets, but not yet. |
2169 | ((/= (length files) 1) | |
2170 | nil) | |
ac3f4c6f | 2171 | ;; if it's a directory, don't supply any revision default |
d7b60083 | 2172 | ((file-directory-p first) |
c0d66cb2 | 2173 | nil) |
ac3f4c6f | 2174 | ;; if the file is not up-to-date, use working revision as older revision |
d7b60083 | 2175 | ((not (vc-up-to-date-p first)) |
ac3f4c6f ER |
2176 | (setq rev1-default (vc-working-revision first))) |
2177 | ;; if the file is not locked, use last and previous revisions as defaults | |
c0d66cb2 | 2178 | (t |
ac3f4c6f ER |
2179 | (setq rev1-default (vc-call previous-revision first |
2180 | (vc-working-revision first))) | |
c63f9a0e | 2181 | (if (string= rev1-default "") (setq rev1-default nil)) |
ac3f4c6f | 2182 | (setq rev2-default (vc-working-revision first)))) |
c0d66cb2 | 2183 | ;; construct argument list |
4d83a657 | 2184 | (let* ((rev1-prompt (if rev1-default |
ac3f4c6f | 2185 | (concat "Older revision (default " |
4d83a657 | 2186 | rev1-default "): ") |
ac3f4c6f ER |
2187 | "Older revision: ")) |
2188 | (rev2-prompt (concat "Newer revision (default " | |
4d83a657 SM |
2189 | (or rev2-default "current source") "): ")) |
2190 | (rev1 (if completion-table | |
2191 | (completing-read rev1-prompt completion-table | |
d7b60083 | 2192 | nil nil nil nil rev1-default) |
4d83a657 SM |
2193 | (read-string rev1-prompt nil nil rev1-default))) |
2194 | (rev2 (if completion-table | |
2195 | (completing-read rev2-prompt completion-table | |
d7b60083 | 2196 | nil nil nil nil rev2-default) |
4d83a657 | 2197 | (read-string rev2-prompt nil nil rev2-default)))) |
d7b60083 ER |
2198 | (if (string= rev1 "") (setq rev1 nil)) |
2199 | (if (string= rev2 "") (setq rev2 nil)) | |
a7192ddb | 2200 | (list files rev1 rev2)))) |
d7b60083 ER |
2201 | (if (and (not rev1) rev2) |
2202 | (error "Not a valid revision range.")) | |
a7192ddb | 2203 | (vc-diff-internal t files rev1 rev2 (interactive-p))) |
d7b60083 | 2204 | |
a7192ddb SM |
2205 | ;; (defun vc-contains-version-controlled-file (dir) |
2206 | ;; "Return t if DIR contains a version-controlled file, nil otherwise." | |
2207 | ;; (catch 'found | |
2208 | ;; (mapc (lambda (f) (and (not (file-directory-p f)) (vc-backend f) (throw 'found 't))) (directory-files dir)) | |
2209 | ;; nil)) | |
727c4443 | 2210 | |
d7b60083 | 2211 | ;;;###autoload |
a7192ddb | 2212 | (defun vc-diff (historic &optional not-urgent) |
ac3f4c6f | 2213 | "Display diffs between file revisions. |
727c4443 | 2214 | Normally this compares the currently selected fileset with their |
a7192ddb | 2215 | working revisions. With a prefix argument HISTORIC, it reads two revision |
727c4443 ER |
2216 | designators specifying which revisions to compare. |
2217 | ||
2218 | If no current fileset is available (that is, we are not in | |
2219 | VC-Dired mode and the visited file of the current buffer is not | |
a7192ddb SM |
2220 | under version control) and we're in a Dired buffer, use |
2221 | the current directory. | |
2222 | The optional argument NOT-URGENT non-nil means it is ok to say no to | |
2223 | saving the buffer." | |
2224 | (interactive (list current-prefix-arg t)) | |
2225 | (if historic | |
2226 | (call-interactively 'vc-version-diff) | |
2227 | (let* ((files (vc-deduce-fileset t))) | |
2228 | (if buffer-file-name (vc-buffer-sync not-urgent)) | |
2229 | (vc-diff-internal t files nil nil (interactive-p))))) | |
727c4443 | 2230 | |
2c87edc1 | 2231 | |
f1818994 | 2232 | ;;;###autoload |
ac3f4c6f ER |
2233 | (defun vc-revision-other-window (rev) |
2234 | "Visit revision REV of the current file in another window. | |
2235 | If the current file is named `F', the revision is named `F.~REV~'. | |
6f1ecae4 | 2236 | If `F.~REV~' already exists, use it instead of checking it out again." |
4d83a657 SM |
2237 | (interactive |
2238 | (save-current-buffer | |
2239 | (vc-ensure-vc-buffer) | |
2240 | (let ((completion-table | |
2241 | (vc-call revision-completion-table buffer-file-name)) | |
ac3f4c6f | 2242 | (prompt "Revision to visit (default is working revision): ")) |
4d83a657 SM |
2243 | (list |
2244 | (if completion-table | |
2245 | (completing-read prompt completion-table) | |
2246 | (read-string prompt)))))) | |
b6909007 | 2247 | (vc-ensure-vc-buffer) |
5e011cb2 | 2248 | (let* ((file buffer-file-name) |
ac3f4c6f ER |
2249 | (revision (if (string-equal rev "") |
2250 | (vc-working-revision file) | |
ac0aae44 | 2251 | rev))) |
ac3f4c6f | 2252 | (switch-to-buffer-other-window (vc-find-revision file revision)))) |
ac0aae44 | 2253 | |
ac3f4c6f ER |
2254 | (defun vc-find-revision (file revision) |
2255 | "Read REVISION of FILE into a buffer and return the buffer." | |
2256 | (let ((automatic-backup (vc-version-backup-file-name file revision)) | |
fd8160f7 | 2257 | (filebuf (or (get-file-buffer file) (current-buffer))) |
ac3f4c6f | 2258 | (filename (vc-version-backup-file-name file revision 'manual))) |
fd8160f7 | 2259 | (unless (file-exists-p filename) |
10b48cc4 | 2260 | (if (file-exists-p automatic-backup) |
fd8160f7 SM |
2261 | (rename-file automatic-backup filename nil) |
2262 | (message "Checking out %s..." filename) | |
2263 | (with-current-buffer filebuf | |
2264 | (let ((failed t)) | |
2265 | (unwind-protect | |
2266 | (let ((coding-system-for-read 'no-conversion) | |
2267 | (coding-system-for-write 'no-conversion)) | |
2268 | (with-temp-file filename | |
2269 | (let ((outbuf (current-buffer))) | |
2270 | ;; Change buffer to get local value of | |
2271 | ;; vc-checkout-switches. | |
2272 | (with-current-buffer filebuf | |
ac3f4c6f | 2273 | (vc-call find-revision file revision outbuf)))) |
fd8160f7 | 2274 | (setq failed nil)) |
48b43130 DN |
2275 | (when (and failed (file-exists-p filename)) |
2276 | (delete-file filename)))) | |
fd8160f7 SM |
2277 | (vc-mode-line file)) |
2278 | (message "Checking out %s...done" filename))) | |
48b43130 DN |
2279 | (let ((result-buf (find-file-noselect filename))) |
2280 | (with-current-buffer result-buf | |
83f1f73b | 2281 | ;; Set the parent buffer so that things like |
48b43130 | 2282 | ;; C-x v g, C-x v l, ... etc work. |
25a4ea6d | 2283 | (set (make-local-variable 'vc-parent-buffer) filebuf)) |
48b43130 | 2284 | result-buf))) |
fd8160f7 | 2285 | |
594722a8 ER |
2286 | ;; Header-insertion code |
2287 | ||
637a8ae9 | 2288 | ;;;###autoload |
594722a8 | 2289 | (defun vc-insert-headers () |
6f1ecae4 | 2290 | "Insert headers into a file for use with a version control system. |
b524ce9f | 2291 | Headers desired are inserted at point, and are pulled from |
0e362f54 | 2292 | the variable `vc-BACKEND-header'." |
594722a8 | 2293 | (interactive) |
b6909007 | 2294 | (vc-ensure-vc-buffer) |
594722a8 ER |
2295 | (save-excursion |
2296 | (save-restriction | |
2297 | (widen) | |
2298 | (if (or (not (vc-check-headers)) | |
820bde8d | 2299 | (y-or-n-p "Version headers already exist. Insert another set? ")) |
04864eb0 SM |
2300 | (let* ((delims (cdr (assq major-mode vc-comment-alist))) |
2301 | (comment-start-vc (or (car delims) comment-start "#")) | |
2302 | (comment-end-vc (or (car (cdr delims)) comment-end "")) | |
2303 | (hdsym (vc-make-backend-sym (vc-backend buffer-file-name) | |
2304 | 'header)) | |
2305 | (hdstrings (and (boundp hdsym) (symbol-value hdsym)))) | |
2306 | (dolist (s hdstrings) | |
2307 | (insert comment-start-vc "\t" s "\t" | |
2308 | comment-end-vc "\n")) | |
2309 | (if vc-static-header-alist | |
2310 | (dolist (f vc-static-header-alist) | |
2311 | (if (string-match (car f) buffer-file-name) | |
2312 | (insert (format (cdr f) (car hdstrings))))))))))) | |
594722a8 | 2313 | |
0e362f54 | 2314 | (defun vc-clear-headers (&optional file) |
099bd78a | 2315 | "Clear all version headers in the current buffer (or FILE). |
6f1ecae4 | 2316 | The headers are reset to their non-expanded form." |
0e362f54 GM |
2317 | (let* ((filename (or file buffer-file-name)) |
2318 | (visited (find-buffer-visiting filename)) | |
2319 | (backend (vc-backend filename))) | |
2320 | (when (vc-find-backend-function backend 'clear-headers) | |
6f41eeb5 | 2321 | (if visited |
0e362f54 GM |
2322 | (let ((context (vc-buffer-context))) |
2323 | ;; save-excursion may be able to relocate point and mark | |
2324 | ;; properly. If it fails, vc-restore-buffer-context | |
2325 | ;; will give it a second try. | |
2326 | (save-excursion | |
2327 | (vc-call-backend backend 'clear-headers)) | |
2328 | (vc-restore-buffer-context context)) | |
7849e179 | 2329 | (set-buffer (find-file-noselect filename)) |
0e362f54 GM |
2330 | (vc-call-backend backend 'clear-headers) |
2331 | (kill-buffer filename))))) | |
c8de1d91 | 2332 | |
9b64a7f0 ER |
2333 | (defun vc-modify-change-comment (files rev oldcomment) |
2334 | "Edit the comment associated with the given files and revision." | |
2335 | (vc-start-entry | |
2336 | files rev oldcomment t | |
2337 | "Enter a replacement change comment." | |
2338 | (lambda (files rev comment) | |
df49d02e | 2339 | (vc-call-backend |
9b64a7f0 ER |
2340 | ;; Less of a kluge than it looks like; log-view mode only passes |
2341 | ;; this function a singleton list. Arguments left in this form in | |
df49d02e JB |
2342 | ;; case the more general operation ever becomes meaningful. |
2343 | (vc-responsible-backend (car files)) | |
9b64a7f0 ER |
2344 | 'modify-change-comment files rev comment)))) |
2345 | ||
b6909007 | 2346 | ;;;###autoload |
099bd78a | 2347 | (defun vc-merge () |
ac3f4c6f ER |
2348 | "Merge changes between two revisions into the current buffer's file. |
2349 | This asks for two revisions to merge from in the minibuffer. If the | |
2350 | first revision is a branch number, then merge all changes from that | |
2351 | branch. If the first revision is empty, merge news, i.e. recent changes | |
099bd78a | 2352 | from the current branch. |
0e362f54 GM |
2353 | |
2354 | See Info node `Merging'." | |
099bd78a | 2355 | (interactive) |
ccb141e8 AS |
2356 | (vc-ensure-vc-buffer) |
2357 | (vc-buffer-sync) | |
2358 | (let* ((file buffer-file-name) | |
2359 | (backend (vc-backend file)) | |
0e362f54 | 2360 | (state (vc-state file)) |
ac3f4c6f | 2361 | first-revision second-revision status) |
0e362f54 | 2362 | (cond |
61de26cb | 2363 | ((stringp state) ;; Locking VCses only |
0e362f54 GM |
2364 | (error "File is locked by %s" state)) |
2365 | ((not (vc-editable-p file)) | |
2366 | (if (y-or-n-p | |
2367 | "File must be checked out for merging. Check out now? ") | |
2368 | (vc-checkout file t) | |
2369 | (error "Merge aborted")))) | |
ac3f4c6f ER |
2370 | (setq first-revision |
2371 | (read-string (concat "Branch or revision to merge from " | |
5b76833f | 2372 | "(default news on current branch): "))) |
ac3f4c6f | 2373 | (if (string= first-revision "") |
099bd78a SM |
2374 | (if (not (vc-find-backend-function backend 'merge-news)) |
2375 | (error "Sorry, merging news is not implemented for %s" backend) | |
2376 | (setq status (vc-call merge-news file))) | |
2377 | (if (not (vc-find-backend-function backend 'merge)) | |
2378 | (error "Sorry, merging is not implemented for %s" backend) | |
ac3f4c6f ER |
2379 | (if (not (vc-branch-p first-revision)) |
2380 | (setq second-revision | |
2381 | (read-string "Second revision: " | |
2382 | (concat (vc-branch-part first-revision) "."))) | |
2383 | ;; We want to merge an entire branch. Set revisions | |
099bd78a | 2384 | ;; accordingly, so that vc-BACKEND-merge understands us. |
ac3f4c6f ER |
2385 | (setq second-revision first-revision) |
2386 | ;; first-revision must be the starting point of the branch | |
2387 | (setq first-revision (vc-branch-part first-revision))) | |
2388 | (setq status (vc-call merge file first-revision second-revision)))) | |
099bd78a | 2389 | (vc-maybe-resolve-conflicts file status "WORKFILE" "MERGE SOURCE"))) |
0e362f54 GM |
2390 | |
2391 | (defun vc-maybe-resolve-conflicts (file status &optional name-A name-B) | |
2392 | (vc-resynch-buffer file t (not (buffer-modified-p))) | |
2393 | (if (zerop status) (message "Merge successful") | |
28e4e2b4 | 2394 | (smerge-mode 1) |
8dc87047 | 2395 | (message "File contains conflicts."))) |
ccb141e8 AS |
2396 | |
2397 | ;;;###autoload | |
1168d6c2 | 2398 | (defalias 'vc-resolve-conflicts 'smerge-ediff) |
18483cf0 | 2399 | |
2f119435 | 2400 | ;; The VC directory major mode. Coopt Dired for this. |
e1f297e6 ER |
2401 | ;; All VC commands get mapped into logical equivalents. |
2402 | ||
beba4bd9 AS |
2403 | (defvar vc-dired-switches) |
2404 | (defvar vc-dired-terse-mode) | |
2405 | ||
0e362f54 GM |
2406 | (defvar vc-dired-mode-map |
2407 | (let ((map (make-sparse-keymap)) | |
2408 | (vmap (make-sparse-keymap))) | |
ec402ad4 | 2409 | (define-key map "\C-xv" vmap) |
0e362f54 | 2410 | (define-key map "v" vmap) |
ec402ad4 | 2411 | (set-keymap-parent vmap vc-prefix-map) |
0e362f54 GM |
2412 | (define-key vmap "t" 'vc-dired-toggle-terse-mode) |
2413 | map)) | |
2414 | ||
3827b532 | 2415 | (define-derived-mode vc-dired-mode dired-mode "Dired under " |
0e362f54 GM |
2416 | "The major mode used in VC directory buffers. |
2417 | ||
2418 | It works like Dired, but lists only files under version control, with | |
2419 | the current VC state of each file being indicated in the place of the | |
2420 | file's link count, owner, group and size. Subdirectories are also | |
2421 | listed, and you may insert them into the buffer as desired, like in | |
2422 | Dired. | |
2423 | ||
2424 | All Dired commands operate normally, with the exception of `v', which | |
2425 | is redefined as the version control prefix, so that you can type | |
3d30b8bc RS |
2426 | `vl', `v=' etc. to invoke `vc-print-log', `vc-diff', and the like on |
2427 | the file named in the current Dired buffer line. `vv' invokes | |
2428 | `vc-next-action' on this file, or on all files currently marked. | |
2429 | There is a special command, `*l', to mark all files currently locked." | |
099bd78a SM |
2430 | ;; define-derived-mode does it for us in Emacs-21, but not in Emacs-20. |
2431 | ;; We do it here because dired might not be loaded yet | |
2432 | ;; when vc-dired-mode-map is initialized. | |
2433 | (set-keymap-parent vc-dired-mode-map dired-mode-map) | |
421f0bfe | 2434 | (add-hook 'dired-after-readin-hook 'vc-dired-hook nil t) |
9bc260cf | 2435 | ;; The following is slightly modified from files.el, |
62c2e775 AS |
2436 | ;; because file lines look a bit different in vc-dired-mode |
2437 | ;; (the column before the date does not end in a digit). | |
ead91593 MA |
2438 | ;; albinus: It should be done in the original declaration. Problem |
2439 | ;; is the optional empty state-info; otherwise ")" would be good | |
2440 | ;; enough as delimeter. | |
9bc260cf | 2441 | (set (make-local-variable 'directory-listing-before-filename-regexp) |
62c2e775 | 2442 | (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)") |
570050dc AS |
2443 | ;; In some locales, month abbreviations are as short as 2 letters, |
2444 | ;; and they can be followed by ".". | |
2445 | (month (concat l l "+\\.?")) | |
2446 | (s " ") | |
2447 | (yyyy "[0-9][0-9][0-9][0-9]") | |
2448 | (dd "[ 0-3][0-9]") | |
2449 | (HH:MM "[ 0-2][0-9]:[0-5][0-9]") | |
2450 | (seconds "[0-6][0-9]\\([.,][0-9]+\\)?") | |
2451 | (zone "[-+][0-2][0-9][0-5][0-9]") | |
2452 | (iso-mm-dd "[01][0-9]-[0-3][0-9]") | |
2453 | (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?")) | |
2454 | (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time | |
2455 | "\\|" yyyy "-" iso-mm-dd "\\)")) | |
2456 | (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)" | |
2457 | s "+" | |
2458 | "\\(" HH:MM "\\|" yyyy "\\)")) | |
2459 | (western-comma (concat month s "+" dd "," s "+" yyyy)) | |
2460 | ;; Japanese MS-Windows ls-lisp has one-digit months, and | |
2461 | ;; omits the Kanji characters after month and day-of-month. | |
2462 | (mm "[ 0-1]?[0-9]") | |
2463 | (japanese | |
2464 | (concat mm l "?" s dd l "?" s "+" | |
2465 | "\\(" HH:MM "\\|" yyyy l "?" "\\)"))) | |
2466 | ;; the .* below ensures that we find the last match on a line | |
62c2e775 | 2467 | (concat ".*" s |
570050dc AS |
2468 | "\\(" western "\\|" western-comma "\\|" japanese "\\|" iso "\\)" |
2469 | s "+"))) | |
a0019b45 AS |
2470 | (and (boundp 'vc-dired-switches) |
2471 | vc-dired-switches | |
2472 | (set (make-local-variable 'dired-actual-switches) | |
2473 | vc-dired-switches)) | |
3b574573 | 2474 | (set (make-local-variable 'vc-dired-terse-mode) vc-dired-terse-display) |
9d2aebf6 MY |
2475 | (let ((backend-name (symbol-name (vc-responsible-backend |
2476 | default-directory)))) | |
2477 | (setq mode-name (concat mode-name backend-name)) | |
2478 | ;; Add menu after `vc-dired-mode-map' has `dired-mode-map' as the parent. | |
2479 | (let ((vc-dire-menu-map (copy-keymap vc-menu-map))) | |
a7192ddb | 2480 | (define-key-after (lookup-key vc-dired-mode-map [menu-bar]) [vc] |
9d2aebf6 | 2481 | (cons backend-name vc-dire-menu-map) 'subdir))) |
2f119435 AS |
2482 | (setq vc-dired-mode t)) |
2483 | ||
3b574573 AS |
2484 | (defun vc-dired-toggle-terse-mode () |
2485 | "Toggle terse display in VC Dired." | |
2486 | (interactive) | |
2487 | (if (not vc-dired-mode) | |
2488 | nil | |
2489 | (setq vc-dired-terse-mode (not vc-dired-terse-mode)) | |
2490 | (if vc-dired-terse-mode | |
2491 | (vc-dired-hook) | |
2492 | (revert-buffer)))) | |
2493 | ||
3d30b8bc RS |
2494 | (defun vc-dired-mark-locked () |
2495 | "Mark all files currently locked." | |
2496 | (interactive) | |
2497 | (dired-mark-if (let ((f (dired-get-filename nil t))) | |
2498 | (and f | |
2499 | (not (file-directory-p f)) | |
0e362f54 | 2500 | (not (vc-up-to-date-p f)))) |
3d30b8bc RS |
2501 | "locked file")) |
2502 | ||
2503 | (define-key vc-dired-mode-map "*l" 'vc-dired-mark-locked) | |
2504 | ||
b9a35ba5 | 2505 | (defun vc-dired-reformat-line (vc-info) |
0e362f54 | 2506 | "Reformat a directory-listing line. |
b9a35ba5 | 2507 | Replace various columns with version control information, VC-INFO. |
0e362f54 | 2508 | This code, like dired, assumes UNIX -l format." |
3d30b8bc | 2509 | (beginning-of-line) |
f1180544 | 2510 | (when (re-search-forward |
685e7bca AS |
2511 | ;; Match link count, owner, group, size. Group may be missing, |
2512 | ;; and only the size is present in OS/2 -l format. | |
2513 | "^..[drwxlts-]+ \\( *[0-9]+\\( [^ ]+ +\\([^ ]+ +\\)?[0-9]+\\)?\\) " | |
2514 | (line-end-position) t) | |
2515 | (replace-match (substring (concat vc-info " ") 0 10) | |
2516 | t t nil 1))) | |
3d30b8bc | 2517 | |
35d33ce7 ER |
2518 | (defun vc-dired-ignorable-p (filename) |
2519 | "Should FILENAME be ignored in VC-Dired listings?" | |
df49d02e | 2520 | (catch t |
9580f1fd | 2521 | ;; Ignore anything that wouldn't be found by completion (.o, .la, etc.) |
35d33ce7 | 2522 | (dolist (ignorable completion-ignored-extensions) |
df49d02e | 2523 | (let ((ext (substring filename |
35d33ce7 ER |
2524 | (- (length filename) |
2525 | (length ignorable))))) | |
2526 | (if (string= ignorable ext) (throw t t)))) | |
9580f1fd ER |
2527 | ;; Ignore Makefiles derived from something else |
2528 | (when (string= (file-name-nondirectory filename) "Makefile") | |
2529 | (let* ((dir (file-name-directory filename)) | |
2530 | (peers (directory-files (or dir default-directory)))) | |
2531 | (if (or (member "Makefile.in" peers) (member "Makefile.am" peers)) | |
2532 | (throw t t)))) | |
35d33ce7 ER |
2533 | nil)) |
2534 | ||
3d30b8bc | 2535 | (defun vc-dired-hook () |
0e362f54 GM |
2536 | "Reformat the listing according to version control. |
2537 | Called by dired after any portion of a vc-dired buffer has been read in." | |
3d30b8bc | 2538 | (message "Getting version information... ") |
cdce374a ER |
2539 | ;; if the backend supports it, get the state |
2540 | ;; of all files in this directory at once | |
2541 | (let ((backend (vc-responsible-backend default-directory))) | |
2542 | ;; check `backend' can really handle `default-directory'. | |
2543 | (if (and (vc-call-backend backend 'responsible-p default-directory) | |
2544 | (vc-find-backend-function backend 'dir-state)) | |
2545 | (vc-call-backend backend 'dir-state default-directory))) | |
df49d02e | 2546 | (let (filename |
484c1b1f ER |
2547 | (inhibit-read-only t) |
2548 | (buffer-undo-list t)) | |
3d30b8bc | 2549 | (goto-char (point-min)) |
0e362f54 GM |
2550 | (while (not (eobp)) |
2551 | (cond | |
3d30b8bc | 2552 | ;; subdir header line |
cdce374a | 2553 | ((dired-get-subdir) |
3d30b8bc RS |
2554 | (forward-line 1) |
2555 | ;; erase (but don't remove) the "total" line | |
0e362f54 GM |
2556 | (delete-region (point) (line-end-position)) |
2557 | (beginning-of-line) | |
2558 | (forward-line 1)) | |
2559 | ;; file line | |
3d30b8bc RS |
2560 | ((setq filename (dired-get-filename nil t)) |
2561 | (cond | |
3b574573 | 2562 | ;; subdir |
3d30b8bc | 2563 | ((file-directory-p filename) |
0e362f54 GM |
2564 | (cond |
2565 | ((member (file-name-nondirectory filename) | |
3b574573 AS |
2566 | vc-directory-exclusion-list) |
2567 | (let ((pos (point))) | |
2568 | (dired-kill-tree filename) | |
2569 | (goto-char pos) | |
2570 | (dired-kill-line))) | |
2571 | (vc-dired-terse-mode | |
633cee46 AS |
2572 | ;; Don't show directories in terse mode. Don't use |
2573 | ;; dired-kill-line to remove it, because in recursive listings, | |
2574 | ;; that would remove the directory contents as well. | |
0e362f54 | 2575 | (delete-region (line-beginning-position) |
633cee46 | 2576 | (progn (forward-line 1) (point)))) |
3b574573 AS |
2577 | ((string-match "\\`\\.\\.?\\'" (file-name-nondirectory filename)) |
2578 | (dired-kill-line)) | |
2579 | (t | |
3d30b8bc | 2580 | (vc-dired-reformat-line nil) |
3b574573 | 2581 | (forward-line 1)))) |
c59a2442 | 2582 | ;; Try to head off calling the expensive state query - |
35d33ce7 ER |
2583 | ;; ignore object files, TeX intermediate files, and so forth. |
2584 | ((vc-dired-ignorable-p filename) | |
2585 | (dired-kill-line)) | |
c59a2442 ER |
2586 | ;; Ordinary file -- call the (possibly expensive) state query |
2587 | ;; | |
2588 | ;; First case: unregistered or unknown. (Unknown shouldn't happen here) | |
2589 | ((member (vc-state filename) '(nil unregistered)) | |
2590 | (if vc-dired-terse-mode | |
2591 | (dired-kill-line) | |
2592 | (vc-dired-reformat-line "?") | |
2593 | (forward-line 1))) | |
df49d02e | 2594 | ;; Either we're in non-terse mode or it's out of date |
c59a2442 ER |
2595 | ((not (and vc-dired-terse-mode (vc-up-to-date-p filename))) |
2596 | (vc-dired-reformat-line (vc-call dired-state-info filename)) | |
2597 | (forward-line 1)) | |
df49d02e JB |
2598 | ;; Remaining cases are under version control but uninteresting |
2599 | (t | |
c59a2442 | 2600 | (dired-kill-line)))) |
3d30b8bc | 2601 | ;; any other line |
3b574573 AS |
2602 | (t (forward-line 1)))) |
2603 | (vc-dired-purge)) | |
2604 | (message "Getting version information... done") | |
2605 | (save-restriction | |
2606 | (widen) | |
633cee46 AS |
2607 | (cond ((eq (count-lines (point-min) (point-max)) 1) |
2608 | (goto-char (point-min)) | |
9580f1fd | 2609 | (message "No changes pending under %s" default-directory))))) |
3b574573 AS |
2610 | |
2611 | (defun vc-dired-purge () | |
0e362f54 | 2612 | "Remove empty subdirs." |
b4e4e3a8 SM |
2613 | (goto-char (point-min)) |
2614 | (while (dired-get-subdir) | |
2615 | (forward-line 2) | |
2616 | (if (dired-get-filename nil t) | |
2617 | (if (not (dired-next-subdir 1 t)) | |
2618 | (goto-char (point-max))) | |
2619 | (forward-line -2) | |
2620 | (if (not (string= (dired-current-directory) default-directory)) | |
2621 | (dired-do-kill-lines t "") | |
2622 | ;; We cannot remove the top level directory. | |
2623 | ;; Just make it look a little nicer. | |
2624 | (forward-line 1) | |
3c85843f | 2625 | (or (eobp) (kill-line)) |
b4e4e3a8 SM |
2626 | (if (not (dired-next-subdir 1 t)) |
2627 | (goto-char (point-max)))))) | |
2628 | (goto-char (point-min))) | |
2f119435 | 2629 | |
0e362f54 GM |
2630 | (defun vc-dired-buffers-for-dir (dir) |
2631 | "Return a list of all vc-dired buffers that currently display DIR." | |
2632 | (let (result) | |
099bd78a SM |
2633 | ;; Check whether dired is loaded. |
2634 | (when (fboundp 'dired-buffers-for-dir) | |
a7192ddb SM |
2635 | (dolist (buffer (dired-buffers-for-dir dir)) |
2636 | (with-current-buffer buffer | |
2637 | (if vc-dired-mode | |
2638 | (push buffer result))))) | |
2639 | (nreverse result))) | |
0e362f54 GM |
2640 | |
2641 | (defun vc-dired-resynch-file (file) | |
2642 | "Update the entries for FILE in any VC Dired buffers that list it." | |
2643 | (let ((buffers (vc-dired-buffers-for-dir (file-name-directory file)))) | |
2644 | (when buffers | |
2645 | (mapcar (lambda (buffer) | |
2646 | (with-current-buffer buffer | |
2647 | (if (dired-goto-file file) | |
2648 | ;; bind vc-dired-terse-mode to nil so that | |
2649 | ;; files won't vanish when they are checked in | |
2650 | (let ((vc-dired-terse-mode nil)) | |
2651 | (dired-do-redisplay 1))))) | |
2652 | buffers)))) | |
2653 | ||
637a8ae9 | 2654 | ;;;###autoload |
0e362f54 GM |
2655 | (defun vc-directory (dir read-switches) |
2656 | "Create a buffer in VC Dired Mode for directory DIR. | |
2657 | ||
2658 | See Info node `VC Dired Mode'. | |
2659 | ||
2660 | With prefix arg READ-SWITCHES, specify a value to override | |
2661 | `dired-listing-switches' when generating the listing." | |
2f119435 | 2662 | (interactive "DDired under VC (directory): \nP") |
0e362f54 | 2663 | (let ((vc-dired-switches (concat vc-dired-listing-switches |
3b574573 | 2664 | (if vc-dired-recurse "R" "")))) |
0e362f54 | 2665 | (if read-switches |
3b574573 AS |
2666 | (setq vc-dired-switches |
2667 | (read-string "Dired listing switches: " | |
2668 | vc-dired-switches))) | |
3d30b8bc RS |
2669 | (require 'dired) |
2670 | (require 'dired-aux) | |
0e362f54 GM |
2671 | (switch-to-buffer |
2672 | (dired-internal-noselect (expand-file-name (file-name-as-directory dir)) | |
2673 | vc-dired-switches | |
3d30b8bc | 2674 | 'vc-dired-mode)))) |
e70bdc98 | 2675 | |
8fcaf22f DN |
2676 | ;;; Experimental code for the vc-dired replacement |
2677 | (require 'ewoc) | |
2678 | ||
5a84a937 DN |
2679 | |
2680 | ;; Used to store information for the files displayed in the *VC status* buffer. | |
2681 | ;; Each item displayed corresponds to one of these defstructs. | |
8fcaf22f DN |
2682 | (defstruct (vc-status-fileinfo |
2683 | (:copier nil) | |
58f10bff DN |
2684 | (:constructor |
2685 | vc-status-create-fileinfo (name state extra &optional marked)) | |
8fcaf22f DN |
2686 | (:conc-name vc-status-fileinfo->)) |
2687 | marked | |
2688 | state | |
58f10bff DN |
2689 | name |
2690 | ;; For storing backend specific information. | |
2691 | extra) | |
8fcaf22f DN |
2692 | |
2693 | (defvar vc-status nil) | |
2694 | ||
15c5c970 | 2695 | (defun vc-default-status-extra-headers (backend dir) |
5a84a937 DN |
2696 | ;; Be loud by default to remind people to add coded to display |
2697 | ;; backend specific headers. | |
2698 | ;; XXX: change this to return nil before the release. | |
15c5c970 DN |
2699 | "Extra : Add backend specific headers here") |
2700 | ||
ca8dfeda | 2701 | (defun vc-status-headers (backend dir) |
5a84a937 DN |
2702 | "Display the headers in the *VC status* buffer. |
2703 | It calls the `status-extra-headers' backend method to display backend | |
2704 | specific headers." | |
ca8dfeda | 2705 | (concat |
15c5c970 DN |
2706 | (propertize "VC backend : " 'face 'font-lock-type-face) |
2707 | (propertize (format "%s\n" backend) 'face 'font-lock-variable-name-face) | |
2708 | (propertize "Working dir: " 'face 'font-lock-type-face) | |
2709 | (propertize (format "%s\n" dir) 'face 'font-lock-variable-name-face) | |
2710 | (vc-call-backend backend 'status-extra-headers dir) | |
2711 | "\n")) | |
8fcaf22f | 2712 | |
58f10bff | 2713 | (defun vc-default-status-printer (backend fileentry) |
8fcaf22f | 2714 | "Pretty print FILEENTRY." |
6656ecaa | 2715 | ;; If you change the layout here, change vc-status-move-to-goal-column. |
21f3a277 DN |
2716 | (let ((state (vc-status-fileinfo->state fileentry))) |
2717 | (insert | |
2718 | (propertize | |
2719 | (format "%c" (if (vc-status-fileinfo->marked fileentry) ?* ? )) | |
2720 | 'face 'font-lock-type-face) | |
2721 | " " | |
2722 | (propertize | |
2723 | (format "%-20s" state) | |
d6f47dff DN |
2724 | 'face (cond ((eq state 'up-to-date) 'font-lock-builtin-face) |
2725 | ((eq state 'missing) 'font-lock-warning-face) | |
2726 | (t 'font-lock-variable-name-face)) | |
21f3a277 DN |
2727 | 'mouse-face 'highlight) |
2728 | " " | |
2729 | (propertize | |
2730 | (format "%s" (vc-status-fileinfo->name fileentry)) | |
2731 | 'face 'font-lock-function-name-face | |
2732 | 'mouse-face 'highlight)))) | |
8fcaf22f | 2733 | |
58f10bff DN |
2734 | (defun vc-status-printer (fileentry) |
2735 | (let ((backend (vc-responsible-backend default-directory))) | |
2736 | (vc-call-backend backend 'status-printer fileentry))) | |
2737 | ||
ca8dfeda | 2738 | (defun vc-status-move-to-goal-column () |
5a84a937 | 2739 | ;; Used to keep the cursor on the file name column. |
ca8dfeda | 2740 | (beginning-of-line) |
58f10bff | 2741 | ;; Must be in sync with vc-default-status-printer. |
ca8dfeda DN |
2742 | (forward-char 25)) |
2743 | ||
e9e065e5 DN |
2744 | (defun vc-status-prepare-status-buffer (dir &optional create-new) |
2745 | "Find a *vc-status* buffer showing DIR, or create a new one." | |
2746 | (setq dir (expand-file-name dir)) | |
d39730b8 DN |
2747 | (let* ((bname "*vc-status*") |
2748 | ;; Look for another *vc-status* buffer visiting the same directory. | |
2749 | (buf (save-excursion | |
2750 | (unless create-new | |
2751 | (dolist (buffer (buffer-list)) | |
2752 | (set-buffer buffer) | |
2753 | (when (and (eq major-mode 'vc-status-mode) | |
2754 | (string= (expand-file-name default-directory) dir)) | |
2755 | (return buffer))))))) | |
2756 | (if buf | |
2757 | buf | |
2758 | ;; Create a new *vc-status* buffer. | |
2759 | (with-current-buffer (create-file-buffer bname) | |
2760 | (cd dir) | |
2761 | (vc-setup-buffer (current-buffer)) | |
4dc22208 DN |
2762 | ;; Reset the vc-parent-buffer-name so that it does not appear |
2763 | ;; in the mode-line. | |
2764 | (setq vc-parent-buffer-name nil) | |
d39730b8 | 2765 | (current-buffer))))) |
e9e065e5 | 2766 | |
e166638d | 2767 | ;;;###autoload |
8fcaf22f DN |
2768 | (defun vc-status (dir) |
2769 | "Show the VC status for DIR." | |
2770 | (interactive "DVC status for directory: ") | |
e9e065e5 | 2771 | (switch-to-buffer (vc-status-prepare-status-buffer dir)) |
d39730b8 DN |
2772 | (if (eq major-mode 'vc-status-mode) |
2773 | (vc-status-refresh) | |
2774 | (vc-status-mode))) | |
8fcaf22f | 2775 | |
25a4ea6d DN |
2776 | (defvar vc-status-menu-map |
2777 | (let ((map (make-sparse-keymap "VC-status"))) | |
d39730b8 | 2778 | (define-key map [quit] |
25a4ea6d DN |
2779 | '(menu-item "Quit" bury-buffer |
2780 | :help "Quit")) | |
d39730b8 DN |
2781 | (define-key map [kill] |
2782 | '(menu-item "Kill Update Command" vc-status-kill-dir-status-process | |
2783 | :enable vc-status-process-buffer | |
2784 | :help "Kill the command that updates VC status buffer")) | |
2785 | (define-key map [refresh] | |
25a4ea6d | 2786 | '(menu-item "Refresh" vc-status-refresh |
d39730b8 | 2787 | :enable (not vc-status-process-buffer) |
25a4ea6d | 2788 | :help "Refresh the contents of the VC status buffer")) |
d39730b8 | 2789 | (define-key map [remup] |
d6f47dff DN |
2790 | '(menu-item "Hide up-to-date" vc-status-hide-up-to-date |
2791 | :help "Hide up-to-date items from display")) | |
25a4ea6d | 2792 | ;; VC commands. |
115c0061 | 2793 | (define-key map [sepvccmd] '("--")) |
d39730b8 | 2794 | (define-key map [annotate] |
25a4ea6d DN |
2795 | '(menu-item "Annotate" vc-annotate |
2796 | :help "Display the edit history of the current file using colors")) | |
d39730b8 | 2797 | (define-key map [diff] |
25a4ea6d DN |
2798 | '(menu-item "Compare with Base Version" vc-diff |
2799 | :help "Compare file set with the base version")) | |
d39730b8 | 2800 | (define-key map [register] |
25a4ea6d DN |
2801 | '(menu-item "Register" vc-status-register |
2802 | :help "Register file set into the version control system")) | |
20f95df2 | 2803 | (define-key map [update] |
115c0061 | 2804 | '(menu-item "Update to latest version" vc-update |
20f95df2 | 2805 | :help "Update the current fileset's files to their tip revisions")) |
115c0061 DN |
2806 | (define-key map [revert] |
2807 | '(menu-item "Revert to base version" vc-revert | |
2808 | :help "Revert working copies of the selected fileset to their repository contents.")) | |
c6ea7ec6 DN |
2809 | (define-key map [log] |
2810 | '(menu-item "Show history" vc-print-log | |
2811 | :help "List the change log of the current file set in a window")) | |
25a4ea6d DN |
2812 | |
2813 | ;; Movement. | |
115c0061 | 2814 | (define-key map [sepmv] '("--")) |
d39730b8 | 2815 | (define-key map [next-line] |
25a4ea6d DN |
2816 | '(menu-item "Next line" vc-status-next-line |
2817 | :help "Go to the next line" :keys "n")) | |
d39730b8 | 2818 | (define-key map [previous-line] |
25a4ea6d DN |
2819 | '(menu-item "Previous line" vc-status-previous-line |
2820 | :help "Go to the previous line")) | |
2821 | ;; Marking. | |
115c0061 | 2822 | (define-key map [sepmrk] '("--")) |
d39730b8 | 2823 | (define-key map [unmark-all] |
25a4ea6d DN |
2824 | '(menu-item "Unmark All" vc-status-unmark-all-files |
2825 | :help "Unmark all files that are in the same state as the current file\ | |
2826 | \nWith prefix argument unmark all files")) | |
d39730b8 | 2827 | (define-key map [unmark-previous] |
25a4ea6d DN |
2828 | '(menu-item "Unmark previous " vc-status-unmark-file-up |
2829 | :help "Move to the previous line and unmark the file")) | |
2830 | ||
d39730b8 | 2831 | (define-key map [mark-all] |
64db3a90 | 2832 | '(menu-item "Mark All" vc-status-mark-all-files |
25a4ea6d DN |
2833 | :help "Mark all files that are in the same state as the current file\ |
2834 | \nWith prefix argument mark all files")) | |
d39730b8 | 2835 | (define-key map [unmark] |
25a4ea6d DN |
2836 | '(menu-item "Unmark" vc-status-unmark |
2837 | :help "Unmark the current file or all files in the region")) | |
2838 | ||
d39730b8 | 2839 | (define-key map [mark] |
25a4ea6d | 2840 | '(menu-item "Mark" vc-status-mark |
64db3a90 | 2841 | :help "Mark the current file or all files in the region")) |
25a4ea6d | 2842 | |
115c0061 | 2843 | (define-key map [sepopn] '("--")) |
d39730b8 | 2844 | (define-key map [open-other] |
25a4ea6d DN |
2845 | '(menu-item "Open in other window" vc-status-find-file-other-window |
2846 | :help "Find the file on the current line, in another window")) | |
d39730b8 | 2847 | (define-key map [open] |
25a4ea6d DN |
2848 | '(menu-item "Open file" vc-status-find-file |
2849 | :help "Find the file on the current line")) | |
2850 | map) | |
2851 | "Menu for VC status") | |
2852 | ||
2853 | (defalias 'vc-status-menu-map vc-status-menu-map) | |
2854 | ||
d048f3bf | 2855 | (defvar vc-status-mode-map |
ca8dfeda DN |
2856 | (let ((map (make-keymap))) |
2857 | (suppress-keymap map) | |
2858 | ;; Marking. | |
8bb38e87 | 2859 | (define-key map "m" 'vc-status-mark) |
b6fe5b19 | 2860 | (define-key map "M" 'vc-status-mark-all-files) |
8bb38e87 | 2861 | (define-key map "u" 'vc-status-unmark) |
ca8dfeda | 2862 | (define-key map "\C-?" 'vc-status-unmark-file-up) |
b6fe5b19 | 2863 | (define-key map "\M-\C-?" 'vc-status-unmark-all-files) |
ca8dfeda DN |
2864 | ;; Movement. |
2865 | (define-key map "n" 'vc-status-next-line) | |
2866 | (define-key map " " 'vc-status-next-line) | |
2867 | (define-key map "\t" 'vc-status-next-line) | |
2868 | (define-key map "p" 'vc-status-previous-line) | |
2869 | (define-key map [backtab] 'vc-status-previous-line) | |
2870 | ;; VC commands. | |
115c0061 | 2871 | (define-key map "=" 'vc-diff) ;; C-x v = |
ca8dfeda | 2872 | (define-key map "a" 'vc-status-register) |
115c0061 | 2873 | (define-key map "+" 'vc-update) ;; C-x v + |
5a84a937 DN |
2874 | |
2875 | ;;XXX: Maybe use something else here, so we can use 'U' for unmark | |
2876 | ;;all, similar to 'M'.. | |
115c0061 | 2877 | (define-key map "U" 'vc-revert) ;; u is taken by unmark. |
5a84a937 | 2878 | |
ca8dfeda DN |
2879 | ;; Can't be "g" (as in vc map), so "A" for "Annotate". |
2880 | (define-key map "A" 'vc-annotate) | |
115c0061 | 2881 | (define-key map "l" 'vc-print-log) ;; C-x v l |
ca8dfeda DN |
2882 | ;; The remainder. |
2883 | (define-key map "f" 'vc-status-find-file) | |
d6f47dff | 2884 | (define-key map "\C-m" 'vc-status-find-file) |
ca8dfeda | 2885 | (define-key map "o" 'vc-status-find-file-other-window) |
d6f47dff | 2886 | (define-key map "x" 'vc-status-hide-up-to-date) |
ca8dfeda DN |
2887 | (define-key map "q" 'bury-buffer) |
2888 | (define-key map "g" 'vc-status-refresh) | |
751c9f00 | 2889 | (define-key map "\C-c\C-c" 'vc-status-kill-dir-status-process) |
6656ecaa DN |
2890 | ;; Not working yet. Functions like vc-status-find-file need to |
2891 | ;; find the file from the mouse position, not `point'. | |
2892 | ;; (define-key map [(down-mouse-3)] 'vc-status-menu) | |
25a4ea6d DN |
2893 | |
2894 | ;; Hook up the menu. | |
2895 | (define-key map [menu-bar vc-status-mode] | |
2896 | '(menu-item | |
2897 | ;; This is used to that VC backends could add backend specific | |
2898 | ;; menu items to vc-status-menu-map. | |
2899 | "VC Status" vc-status-menu-map :filter vc-status-menu-map-filter)) | |
8fcaf22f DN |
2900 | map) |
2901 | "Keymap for VC status") | |
2902 | ||
7ee8e7eb DN |
2903 | (defun vc-default-extra-status-menu (backend) |
2904 | nil) | |
2905 | ||
5a84a937 DN |
2906 | ;; This is used to that VC backends could add backend specific menu |
2907 | ;; items to vc-status-menu-map. | |
6656ecaa | 2908 | (defun vc-status-menu-map-filter (orig-binding) |
d39730b8 DN |
2909 | (when (and (symbolp orig-binding) (fboundp orig-binding)) |
2910 | (setq orig-binding (indirect-function orig-binding))) | |
2911 | (let ((ext-binding | |
2912 | (vc-call-backend (vc-responsible-backend default-directory) | |
2913 | 'extra-status-menu))) | |
2914 | (if (null ext-binding) | |
2915 | orig-binding | |
2916 | (append orig-binding | |
2917 | '("----") | |
2918 | ext-binding)))) | |
6656ecaa | 2919 | |
6656ecaa DN |
2920 | (defun vc-status-menu (e) |
2921 | "Popup the VC status menu." | |
2922 | (interactive "e") | |
25a4ea6d | 2923 | (popup-menu vc-status-menu-map e)) |
6656ecaa | 2924 | |
934b91bf | 2925 | (defvar vc-status-tool-bar-map |
d39730b8 DN |
2926 | (let ((map (make-sparse-keymap))) |
2927 | (tool-bar-local-item-from-menu 'vc-status-find-file "open" | |
2928 | map vc-status-mode-map) | |
2929 | (tool-bar-local-item "bookmark_add" | |
2930 | 'vc-status-toggle-mark 'vc-status-toggle-mark map | |
2931 | :help "Toggle mark on current item") | |
2932 | (tool-bar-local-item-from-menu 'vc-status-previous-line "left-arrow" | |
2933 | map vc-status-mode-map | |
2934 | :rtl "right-arrow") | |
2935 | (tool-bar-local-item-from-menu 'vc-status-next-line "right-arrow" | |
2936 | map vc-status-mode-map | |
2937 | :rtl "left-arrow") | |
44a17812 JD |
2938 | (tool-bar-local-item-from-menu 'vc-print-log "info" |
2939 | map vc-status-mode-map) | |
d39730b8 DN |
2940 | (tool-bar-local-item-from-menu 'vc-status-refresh "refresh" |
2941 | map vc-status-mode-map) | |
2942 | (tool-bar-local-item-from-menu 'nonincremental-search-forward | |
2943 | "search" map) | |
2944 | (tool-bar-local-item-from-menu 'vc-status-kill-dir-status-process "cancel" | |
2945 | map vc-status-mode-map) | |
2946 | (tool-bar-local-item-from-menu 'bury-buffer "exit" | |
2947 | map vc-status-mode-map) | |
2948 | map)) | |
2949 | ||
751c9f00 DN |
2950 | (defvar vc-status-process-buffer nil |
2951 | "The buffer used for the asynchronous call that computes the VC status.") | |
2952 | ||
9b7b3814 DN |
2953 | (defvar vc-status-crt-marked nil |
2954 | "The list of marked files before `vc-status-refresh'.") | |
2955 | ||
8fcaf22f DN |
2956 | (defun vc-status-mode () |
2957 | "Major mode for VC status. | |
2958 | \\{vc-status-mode-map}" | |
2959 | (setq mode-name "*VC Status*") | |
2960 | (setq major-mode 'vc-status-mode) | |
2961 | (setq buffer-read-only t) | |
9b7b3814 | 2962 | (set (make-local-variable 'vc-status-crt-marked) nil) |
8fcaf22f | 2963 | (use-local-map vc-status-mode-map) |
934b91bf | 2964 | (set (make-local-variable 'tool-bar-map) vc-status-tool-bar-map) |
8fcaf22f DN |
2965 | (let ((buffer-read-only nil) |
2966 | (backend (vc-responsible-backend default-directory)) | |
2967 | entries) | |
2968 | (erase-buffer) | |
751c9f00 | 2969 | (set (make-local-variable 'vc-status-process-buffer) nil) |
8fcaf22f | 2970 | (set (make-local-variable 'vc-status) |
ca8dfeda DN |
2971 | (ewoc-create #'vc-status-printer |
2972 | (vc-status-headers backend default-directory))) | |
9f7ddd67 | 2973 | (add-hook 'after-save-hook 'vc-status-mark-buffer-changed) |
ca8dfeda DN |
2974 | (vc-status-refresh))) |
2975 | ||
2976 | (put 'vc-status-mode 'mode-class 'special) | |
2977 | ||
beac4378 AJ |
2978 | (defun vc-status-add-entries (entries buffer) |
2979 | ;; Add ENTRIES to the vc-status buffer BUFFER. | |
2980 | (with-current-buffer buffer | |
2981 | (when entries | |
2982 | ;; Insert the entries sorted by name into the ewoc. | |
2983 | ;; We assume the ewoc is sorted too, which should be the | |
2984 | ;; case if we always add entries with vc-status-add-entries. | |
2985 | (setq entries (sort (copy-sequence entries) | |
2986 | (lambda (entry1 entry2) | |
2987 | (string-lessp (car entry1) (car entry2))))) | |
2988 | (let ((entry (pop entries)) | |
2989 | (node (ewoc-nth vc-status 0))) | |
2990 | (while entry | |
2991 | (while (and vc-status-crt-marked | |
2992 | (string-lessp (car vc-status-crt-marked) (car entry))) | |
2993 | (setq vc-status-crt-marked (cdr vc-status-crt-marked))) | |
2994 | (let* ((file (car entry)) | |
2995 | (state (nth 1 entry)) | |
2996 | (extra (nth 2 entry)) | |
2997 | (marked (and vc-status-crt-marked | |
2998 | (string-equal (car vc-status-crt-marked) file)))) | |
2999 | (cond ((not node) | |
3000 | (setq node (ewoc-enter-last vc-status | |
3001 | (vc-status-create-fileinfo file state extra marked))) | |
3002 | (setq entry (pop entries))) | |
3003 | ((string-lessp (vc-status-fileinfo->name (ewoc-data node)) file) | |
3004 | (setq node (ewoc-next vc-status node))) | |
3005 | ((string-equal (vc-status-fileinfo->name (ewoc-data node)) file) | |
3006 | (setf (vc-status-fileinfo->state (ewoc-data node)) state) | |
3007 | (setf (vc-status-fileinfo->extra (ewoc-data node)) extra) | |
3008 | (ewoc-invalidate vc-status node) | |
3009 | (setq entry (pop entries))) | |
3010 | (t | |
3011 | (setq node (ewoc-enter-before vc-status node | |
3012 | (vc-status-create-fileinfo file state extra marked))) | |
3013 | (setq entry (pop entries)))))))))) | |
3014 | ||
5a84a937 DN |
3015 | (defun vc-update-vc-status-buffer (entries buffer &optional more-to-come) |
3016 | ;; ENTRIES is a list of (FILE VC_STATE EXTRA) items. | |
3017 | ;; BUFFER is the *vc-status* buffer to be updated with ENTRIES | |
3018 | ;; If MORE-TO-COME is true, then more updates will come from the | |
3019 | ;; asynchronous process. | |
5ab612e8 | 3020 | (with-current-buffer buffer |
751c9f00 | 3021 | (when entries |
beac4378 | 3022 | (vc-status-add-entries entries buffer) |
751c9f00 | 3023 | (ewoc-goto-node vc-status (ewoc-nth vc-status 0))) |
5a84a937 DN |
3024 | ;; No more updates are expected from the asynchronous process. |
3025 | (unless more-to-come | |
3026 | (setq vc-status-process-buffer nil) | |
3027 | ;; We are done, turn off the mode-line "in progress" message. | |
3028 | (setq mode-line-process nil)))) | |
5ab612e8 | 3029 | |
ca8dfeda | 3030 | (defun vc-status-refresh () |
d39730b8 DN |
3031 | "Refresh the contents of the VC status buffer. |
3032 | Throw an error if another update process is in progress." | |
ca8dfeda | 3033 | (interactive) |
d39730b8 DN |
3034 | (if vc-status-process-buffer |
3035 | (error "Another update process is in progress, cannot run two at a time") | |
d39730b8 | 3036 | ;; We clear the ewoc, but remember the marked files so that we can |
c6ea7ec6 | 3037 | ;; mark them again after the refresh is done. |
115c0061 | 3038 | ;; This is not very efficient; ewoc could use a new function here. |
d39730b8 DN |
3039 | (setq vc-status-crt-marked |
3040 | (mapcar | |
3041 | (lambda (elem) | |
3042 | (vc-status-fileinfo->name elem)) | |
3043 | (ewoc-collect | |
3044 | vc-status | |
3045 | (lambda (crt) (vc-status-fileinfo->marked crt))))) | |
3046 | (ewoc-filter vc-status (lambda (node) nil)) | |
3047 | ||
115c0061 DN |
3048 | (let ((backend (vc-responsible-backend default-directory)) |
3049 | (status-buffer (current-buffer)) | |
3050 | (def-dir default-directory)) | |
d39730b8 | 3051 | (vc-set-mode-line-busy-indicator) |
115c0061 DN |
3052 | ;; Call the `dir-status' backend function. |
3053 | ;; `dir-status' is supposed to be asynchronous. | |
3054 | ;; It should compute the results, and then call the function | |
3055 | ;; passed as an argument in order to update the vc-status buffer | |
3056 | ;; with the results. | |
3057 | ||
3058 | ;; Create a buffer that can be used by `dir-status' and call | |
3059 | ;; `dir-status' with this buffer as the current buffer. Use | |
3060 | ;; `vc-status-process-buffer' to remember this buffer, so that | |
3061 | ;; it can be used later to kill the update process in case it | |
3062 | ;; takes too long. | |
3063 | (setq vc-status-process-buffer | |
3064 | (get-buffer-create | |
5a84a937 | 3065 | (generate-new-buffer-name (format " *VC-%s* tmp status" backend)))) |
115c0061 DN |
3066 | (with-current-buffer vc-status-process-buffer |
3067 | (cd def-dir) | |
3068 | (erase-buffer) | |
3069 | (vc-call-backend backend 'dir-status def-dir | |
3070 | #'vc-update-vc-status-buffer status-buffer))))) | |
751c9f00 DN |
3071 | |
3072 | (defun vc-status-kill-dir-status-process () | |
3073 | "Kill the temporary buffer and associated process." | |
3074 | (interactive) | |
f56d71a5 | 3075 | (when (buffer-live-p vc-status-process-buffer) |
751c9f00 DN |
3076 | (let ((proc (get-buffer-process vc-status-process-buffer))) |
3077 | (when proc (delete-process proc)) | |
d39730b8 | 3078 | (setq vc-status-process-buffer nil) |
751c9f00 | 3079 | (setq mode-line-process nil)))) |
ca8dfeda DN |
3080 | |
3081 | (defun vc-status-next-line (arg) | |
3082 | "Go to the next line. | |
3083 | If a prefix argument is given, move by that many lines." | |
3084 | (interactive "p") | |
3085 | (ewoc-goto-next vc-status arg) | |
3086 | (vc-status-move-to-goal-column)) | |
3087 | ||
3088 | (defun vc-status-previous-line (arg) | |
3089 | "Go to the previous line. | |
3090 | If a prefix argument is given, move by that many lines." | |
3091 | (interactive "p") | |
3092 | (ewoc-goto-prev vc-status arg) | |
3093 | (vc-status-move-to-goal-column)) | |
8fcaf22f | 3094 | |
8bb38e87 DN |
3095 | (defun vc-status-mark-unmark (mark-unmark-function) |
3096 | (if (use-region-p) | |
3097 | (let ((firstl (line-number-at-pos (region-beginning))) | |
3098 | (lastl (line-number-at-pos (region-end)))) | |
3099 | (save-excursion | |
3100 | (goto-char (region-beginning)) | |
3101 | (while (<= (line-number-at-pos) lastl) | |
3102 | (funcall mark-unmark-function)))) | |
3103 | (funcall mark-unmark-function))) | |
3104 | ||
8fcaf22f | 3105 | (defun vc-status-mark-file () |
8bb38e87 | 3106 | ;; Mark the current file and move to the next line. |
8fcaf22f DN |
3107 | (let* ((crt (ewoc-locate vc-status)) |
3108 | (file (ewoc-data crt))) | |
3109 | (setf (vc-status-fileinfo->marked file) t) | |
3110 | (ewoc-invalidate vc-status crt) | |
ca8dfeda | 3111 | (vc-status-next-line 1))) |
8fcaf22f | 3112 | |
8bb38e87 DN |
3113 | (defun vc-status-mark () |
3114 | "Mark the current file or all files in the region. | |
3115 | If the region is active, mark all the files in the region. | |
3116 | Otherwise mark the file on the current line and move to the next | |
3117 | line." | |
3118 | (interactive) | |
3119 | (vc-status-mark-unmark 'vc-status-mark-file)) | |
3120 | ||
d3201e0b DN |
3121 | |
3122 | ;; XXX: Should this take the region into consideration? | |
3123 | (defun vc-status-mark-all-files (arg) | |
3124 | "Mark all files with the same state as the current one. | |
3125 | With a prefix argument mark all files. | |
3126 | ||
3127 | The VC commands operate on files that are on the same state. | |
3128 | This command is intended to make it easy to select all files that | |
3129 | share the same state." | |
3130 | (interactive "P") | |
3131 | (if arg | |
3132 | (ewoc-map | |
3133 | (lambda (filearg) | |
3134 | (unless (vc-status-fileinfo->marked filearg) | |
3135 | (setf (vc-status-fileinfo->marked filearg) t) | |
3136 | t)) | |
3137 | vc-status) | |
3138 | (let* ((crt (ewoc-locate vc-status)) | |
3139 | (crt-state (vc-status-fileinfo->state (ewoc-data crt)))) | |
3140 | (ewoc-map | |
3141 | (lambda (filearg) | |
3142 | (when (and (not (vc-status-fileinfo->marked filearg)) | |
3143 | (eq (vc-status-fileinfo->state filearg) crt-state)) | |
3144 | (setf (vc-status-fileinfo->marked filearg) t) | |
3145 | t)) | |
3146 | vc-status)))) | |
b6fe5b19 | 3147 | |
8fcaf22f | 3148 | (defun vc-status-unmark-file () |
8bb38e87 | 3149 | ;; Unmark the current file and move to the next line. |
8fcaf22f DN |
3150 | (let* ((crt (ewoc-locate vc-status)) |
3151 | (file (ewoc-data crt))) | |
3152 | (setf (vc-status-fileinfo->marked file) nil) | |
3153 | (ewoc-invalidate vc-status crt) | |
ca8dfeda DN |
3154 | (vc-status-next-line 1))) |
3155 | ||
8bb38e87 DN |
3156 | (defun vc-status-unmark () |
3157 | "Unmark the current file or all files in the region. | |
3158 | If the region is active, unmark all the files in the region. | |
3159 | Otherwise mark the file on the current line and move to the next | |
3160 | line." | |
3161 | (interactive) | |
3162 | (vc-status-mark-unmark 'vc-status-unmark-file)) | |
3163 | ||
ca8dfeda DN |
3164 | (defun vc-status-unmark-file-up () |
3165 | "Move to the previous line and unmark the file." | |
3166 | (interactive) | |
3167 | ;; If we're on the first line, we won't move up, but we will still | |
3168 | ;; remove the mark. This seems a bit odd but it is what buffer-menu | |
3169 | ;; does. | |
3170 | (let* ((prev (ewoc-goto-prev vc-status 1)) | |
3171 | (file (ewoc-data prev))) | |
3172 | (setf (vc-status-fileinfo->marked file) nil) | |
3173 | (ewoc-invalidate vc-status prev) | |
3174 | (vc-status-move-to-goal-column))) | |
3175 | ||
d3201e0b DN |
3176 | (defun vc-status-unmark-all-files (arg) |
3177 | "Unmark all files with the same state as the current one. | |
3178 | With a prefix argument mark all files. | |
3179 | ||
3180 | The VC commands operate on files that are on the same state. | |
3181 | This command is intended to make it easy to deselect all files | |
3182 | that share the same state." | |
3183 | (interactive "P") | |
3184 | (if arg | |
3185 | (ewoc-map | |
3186 | (lambda (filearg) | |
3187 | (when (vc-status-fileinfo->marked filearg) | |
3188 | (setf (vc-status-fileinfo->marked filearg) nil) | |
3189 | t)) | |
3190 | vc-status) | |
3191 | (let* ((crt (ewoc-locate vc-status)) | |
3192 | (crt-state (vc-status-fileinfo->state (ewoc-data crt)))) | |
3193 | (ewoc-map | |
3194 | (lambda (filearg) | |
3195 | (when (and (vc-status-fileinfo->marked filearg) | |
3196 | (eq (vc-status-fileinfo->state filearg) crt-state)) | |
3197 | (setf (vc-status-fileinfo->marked filearg) nil) | |
3198 | t)) | |
3199 | vc-status)))) | |
b6fe5b19 | 3200 | |
64db3a90 JD |
3201 | (defun vc-status-toggle-mark-file () |
3202 | (let* ((crt (ewoc-locate vc-status)) | |
3203 | (file (ewoc-data crt))) | |
3204 | (if (vc-status-fileinfo->marked file) | |
3205 | (vc-status-unmark-file) | |
3206 | (vc-status-mark-file)))) | |
3207 | ||
3208 | (defun vc-status-toggle-mark () | |
3209 | (interactive) | |
934b91bf | 3210 | (vc-status-mark-unmark 'vc-status-toggle-mark-file)) |
64db3a90 | 3211 | |
ca8dfeda DN |
3212 | (defun vc-status-register () |
3213 | "Register the marked files, or the current file if no marks." | |
3214 | (interactive) | |
3215 | (let ((files (or (vc-status-marked-files) | |
3216 | (list (vc-status-current-file))))) | |
3217 | (dolist (file files) | |
3218 | (vc-register file)))) | |
3219 | ||
3220 | (defun vc-status-find-file () | |
3221 | "Find the file on the current line." | |
3222 | (interactive) | |
3223 | (find-file (vc-status-current-file))) | |
3224 | ||
3225 | (defun vc-status-find-file-other-window () | |
3226 | "Find the file on the current line, in another window." | |
3227 | (interactive) | |
3228 | (find-file-other-window (vc-status-current-file))) | |
3229 | ||
3230 | (defun vc-status-current-file () | |
3231 | (let ((node (ewoc-locate vc-status))) | |
3232 | (unless node | |
3233 | (error "No file available.")) | |
3234 | (expand-file-name (vc-status-fileinfo->name (ewoc-data node))))) | |
8fcaf22f DN |
3235 | |
3236 | (defun vc-status-marked-files () | |
3237 | "Return the list of marked files" | |
d048f3bf | 3238 | (mapcar |
8fcaf22f DN |
3239 | (lambda (elem) |
3240 | (expand-file-name (vc-status-fileinfo->name elem))) | |
3241 | (ewoc-collect | |
d048f3bf | 3242 | vc-status |
8fcaf22f DN |
3243 | (lambda (crt) (vc-status-fileinfo->marked crt))))) |
3244 | ||
d6f47dff DN |
3245 | (defun vc-status-hide-up-to-date () |
3246 | "Hide up-to-date items from display." | |
21f3a277 DN |
3247 | (interactive) |
3248 | (ewoc-filter | |
3249 | vc-status | |
3250 | (lambda (crt) (not (eq (vc-status-fileinfo->state crt) 'up-to-date))))) | |
3251 | ||
5a84a937 DN |
3252 | (defun vc-default-status-fileinfo-extra (backend file) |
3253 | nil) | |
3254 | ||
484c3092 DN |
3255 | (defun vc-status-mark-buffer-changed (&optional fname) |
3256 | (let* ((file (or fname (expand-file-name buffer-file-name))) | |
9f7ddd67 DN |
3257 | (found-vc-status-buf nil)) |
3258 | (save-excursion | |
3259 | (dolist (status-buf (buffer-list)) | |
3260 | (set-buffer status-buf) | |
3261 | ;; look for a vc-status buffer that might show this file. | |
3262 | (when (eq major-mode 'vc-status-mode) | |
3263 | (setq found-vc-status-buf t) | |
21f3a277 | 3264 | (let ((ddir (expand-file-name default-directory))) |
9f7ddd67 | 3265 | ;; This test is cvs-string-prefix-p |
21f3a277 | 3266 | (when (eq t (compare-strings file nil (length ddir) ddir nil nil)) |
5a84a937 DN |
3267 | (let* |
3268 | ((file-short (substring file (length ddir))) | |
3269 | (backend (vc-backend file)) | |
3270 | (state (and backend (vc-state file))) | |
5a84a937 DN |
3271 | (extra |
3272 | (and backend | |
3273 | (vc-call-backend backend 'status-fileinfo-extra file))) | |
3274 | (entry | |
3275 | (list file-short (if state state 'unregistered) extra))) | |
beac4378 | 3276 | (vc-status-add-entries (list entry) status-buf)))))) |
9f7ddd67 DN |
3277 | ;; We didn't find any vc-status buffers, remove the hook, it is |
3278 | ;; not needed. | |
3279 | (unless found-vc-status-buf (remove-hook 'after-save-hook 'vc-status-mark-buffer-changed))))) | |
3280 | ||
8fcaf22f | 3281 | ;;; End experimental code. |
594722a8 ER |
3282 | |
3283 | ;; Named-configuration entry points | |
3284 | ||
0e362f54 | 3285 | (defun vc-snapshot-precondition (dir) |
6f1ecae4 | 3286 | "Scan the tree below DIR, looking for files not up-to-date. |
099bd78a SM |
3287 | If any file is not up-to-date, return the name of the first such file. |
3288 | \(This means, neither snapshot creation nor retrieval is allowed.\) | |
3289 | If one or more of the files are currently visited, return `visited'. | |
3290 | Otherwise, return nil." | |
503b5c85 RS |
3291 | (let ((status nil)) |
3292 | (catch 'vc-locked-example | |
3293 | (vc-file-tree-walk | |
0e362f54 GM |
3294 | dir |
3295 | (lambda (f) | |
3296 | (if (not (vc-up-to-date-p f)) (throw 'vc-locked-example f) | |
3297 | (if (get-file-buffer f) (setq status 'visited))))) | |
503b5c85 | 3298 | status))) |
594722a8 | 3299 | |
637a8ae9 | 3300 | ;;;###autoload |
0e362f54 | 3301 | (defun vc-create-snapshot (dir name branchp) |
6f41eeb5 | 3302 | "Descending recursively from DIR, make a snapshot called NAME. |
ac3f4c6f ER |
3303 | For each registered file, the working revision becomes part of |
3304 | the named configuration. If the prefix argument BRANCHP is | |
3305 | given, the snapshot is made as a new branch and the files are | |
3306 | checked out in that new branch." | |
0e362f54 GM |
3307 | (interactive |
3308 | (list (read-file-name "Directory: " default-directory default-directory t) | |
3309 | (read-string "New snapshot name: ") | |
3310 | current-prefix-arg)) | |
3311 | (message "Making %s... " (if branchp "branch" "snapshot")) | |
3312 | (if (file-directory-p dir) (setq dir (file-name-as-directory dir))) | |
3313 | (vc-call-backend (vc-responsible-backend dir) | |
3314 | 'create-snapshot dir name branchp) | |
3315 | (message "Making %s... done" (if branchp "branch" "snapshot"))) | |
3316 | ||
637a8ae9 | 3317 | ;;;###autoload |
0e362f54 | 3318 | (defun vc-retrieve-snapshot (dir name) |
099bd78a | 3319 | "Descending recursively from DIR, retrieve the snapshot called NAME. |
ac3f4c6f | 3320 | If NAME is empty, it refers to the latest revisions. |
099bd78a SM |
3321 | If locking is used for the files in DIR, then there must not be any |
3322 | locked files at or below DIR (but if NAME is empty, locked files are | |
3323 | allowed and simply skipped)." | |
0e362f54 GM |
3324 | (interactive |
3325 | (list (read-file-name "Directory: " default-directory default-directory t) | |
ac3f4c6f | 3326 | (read-string "Snapshot name to retrieve (default latest revisions): "))) |
0e362f54 GM |
3327 | (let ((update (yes-or-no-p "Update any affected buffers? ")) |
3328 | (msg (if (or (not name) (string= name "")) | |
3329 | (format "Updating %s... " (abbreviate-file-name dir)) | |
3330 | (format "Retrieving snapshot into %s... " | |
3331 | (abbreviate-file-name dir))))) | |
8a26c165 | 3332 | (message "%s" msg) |
0e362f54 GM |
3333 | (vc-call-backend (vc-responsible-backend dir) |
3334 | 'retrieve-snapshot dir name update) | |
8a26c165 | 3335 | (message "%s" (concat msg "done")))) |
0e362f54 | 3336 | |
594722a8 ER |
3337 | ;; Miscellaneous other entry points |
3338 | ||
637a8ae9 | 3339 | ;;;###autoload |
ac3f4c6f | 3340 | (defun vc-print-log (&optional working-revision) |
d7b60083 | 3341 | "List the change log of the current fileset in a window. |
ac3f4c6f | 3342 | If WORKING-REVISION is non-nil, leave the point at that revision." |
594722a8 | 3343 | (interactive) |
d7b60083 | 3344 | (let* ((files (vc-deduce-fileset)) |
a7192ddb | 3345 | (backend (vc-backend files)) |
ac3f4c6f | 3346 | (working-revision (or working-revision (vc-working-revision (car files))))) |
5217a76a SS |
3347 | ;; Don't switch to the output buffer before running the command, |
3348 | ;; so that any buffer-local settings in the vc-controlled | |
ac9ff209 | 3349 | ;; buffer can be accessed by the command. |
d7b60083 ER |
3350 | (vc-call-backend backend 'print-log files "*vc-change-log*") |
3351 | (pop-to-buffer "*vc-change-log*") | |
0e362f54 | 3352 | (vc-exec-after |
99cb8c8b | 3353 | `(let ((inhibit-read-only t)) |
d7b60083 | 3354 | (vc-call-backend ',backend 'log-view-mode) |
0e362f54 GM |
3355 | (goto-char (point-max)) (forward-line -1) |
3356 | (while (looking-at "=*\n") | |
3357 | (delete-char (- (match-end 0) (match-beginning 0))) | |
3358 | (forward-line -1)) | |
3359 | (goto-char (point-min)) | |
3360 | (if (looking-at "[\b\t\n\v\f\r ]+") | |
3361 | (delete-char (- (match-end 0) (match-beginning 0)))) | |
d7b60083 | 3362 | (shrink-window-if-larger-than-buffer) |
ac3f4c6f ER |
3363 | ;; move point to the log entry for the working revision |
3364 | (vc-call-backend ',backend 'show-log-entry ',working-revision) | |
86e80023 | 3365 | (setq vc-sentinel-movepoint (point)) |
99cb8c8b | 3366 | (set-buffer-modified-p nil))))) |
594722a8 | 3367 | |
637a8ae9 | 3368 | ;;;###autoload |
e4d26892 | 3369 | (defun vc-revert () |
d7b60083 | 3370 | "Revert working copies of the selected fileset to their repository contents. |
9c95ac44 | 3371 | This asks for confirmation if the buffer contents are not identical |
ac3f4c6f | 3372 | to the working revision (except for keyword expansion)." |
594722a8 | 3373 | (interactive) |
a7192ddb | 3374 | (let* ((files (vc-deduce-fileset))) |
d7b60083 ER |
3375 | ;; If any of the files is visited by the current buffer, make |
3376 | ;; sure buffer is saved. If the user says `no', abort since | |
3377 | ;; we cannot show the changes and ask for confirmation to | |
3378 | ;; discard them. | |
3379 | (if (or (not files) (memq (buffer-file-name) files)) | |
3380 | (vc-buffer-sync nil)) | |
3381 | (dolist (file files) | |
a7192ddb | 3382 | (let ((buf (get-file-buffer file))) |
d7b60083 ER |
3383 | (if (and buf (buffer-modified-p buf)) |
3384 | (error "Please kill or save all modified buffers before reverting."))) | |
3385 | (if (vc-up-to-date-p file) | |
3386 | (unless (yes-or-no-p (format "%s seems up-to-date. Revert anyway? " file)) | |
3387 | (error "Revert canceled")))) | |
a7192ddb | 3388 | (if (vc-diff-internal vc-allow-async-revert files nil nil) |
d7b60083 ER |
3389 | (progn |
3390 | (unless (yes-or-no-p (format "Discard changes in %s? " (vc-delistify files))) | |
3391 | (error "Revert canceled")) | |
3392 | (delete-windows-on "*vc-diff*") | |
3393 | (kill-buffer "*vc-diff*"))) | |
3394 | (dolist (file files) | |
3395 | (progn | |
3396 | (message "Reverting %s..." (vc-delistify files)) | |
3397 | (vc-revert-file file) | |
3398 | (message "Reverting %s...done" (vc-delistify files)))))) | |
594722a8 | 3399 | |
637a8ae9 | 3400 | ;;;###autoload |
d7b60083 ER |
3401 | (defun vc-rollback () |
3402 | "Roll back (remove) the most recent changeset committed to the repository. | |
3403 | This may be either a file-level or a repository-level operation, | |
3404 | depending on the underlying version-control system." | |
3405 | (interactive) | |
3406 | (let* ((files (vc-deduce-fileset)) | |
a7192ddb | 3407 | (backend (vc-backend files)) |
d7b60083 ER |
3408 | (granularity (vc-call-backend backend 'revision-granularity))) |
3409 | (unless (vc-find-backend-function backend 'rollback) | |
3410 | (error "Rollback is not supported in %s" backend)) | |
3411 | (if (and (not (eq granularity 'repository)) (/= (length files) 1)) | |
3412 | (error "Rollback requires a singleton fileset or repository versioning")) | |
3413 | (if (not (vc-call latest-on-branch-p (car files))) | |
3414 | (error "Rollback is only possible at the tip revision.")) | |
3415 | ;; If any of the files is visited by the current buffer, make | |
3416 | ;; sure buffer is saved. If the user says `no', abort since | |
3417 | ;; we cannot show the changes and ask for confirmation to | |
3418 | ;; discard them. | |
3419 | (if (or (not files) (memq (buffer-file-name) files)) | |
3420 | (vc-buffer-sync nil)) | |
3421 | (dolist (file files) | |
3422 | (if (buffer-modified-p (get-file-buffer file)) | |
3423 | (error "Please kill or save all modified buffers before rollback.")) | |
3424 | (if (not (vc-up-to-date-p file)) | |
3425 | (error "Please revert all modified workfiles before rollback."))) | |
3426 | ;; Accumulate changes associated with the fileset | |
3427 | (vc-setup-buffer "*vc-diff*") | |
3428 | (not-modified) | |
3429 | (message "Finding changes...") | |
ac3f4c6f ER |
3430 | (let* ((tip (vc-working-revision (car files))) |
3431 | (previous (vc-call previous-revision (car files) tip))) | |
a7192ddb SM |
3432 | (vc-diff-internal nil files previous tip)) |
3433 | ;; Display changes | |
d7b60083 ER |
3434 | (unless (yes-or-no-p "Discard these revisions? ") |
3435 | (error "Rollback canceled")) | |
3436 | (delete-windows-on "*vc-diff*") | |
3437 | (kill-buffer"*vc-diff*") | |
3438 | ;; Do the actual reversions | |
3439 | (message "Rolling back %s..." (vc-delistify files)) | |
3440 | (with-vc-properties | |
3441 | files | |
3442 | (vc-call-backend backend 'rollback files) | |
3443 | `((vc-state . ,'up-to-date) | |
3444 | (vc-checkout-time . , (nth 5 (file-attributes file))) | |
ac3f4c6f | 3445 | (vc-working-revision . nil))) |
a7192ddb | 3446 | (dolist (f files) (vc-resynch-buffer f t t)) |
d7b60083 | 3447 | (message "Rolling back %s...done" (vc-delistify files)))) |
0e362f54 | 3448 | |
2765044b DN |
3449 | ;;;###autoload |
3450 | (define-obsolete-function-alias 'vc-revert-buffer 'vc-revert "23.1") | |
3451 | ||
3452 | ;;;###autoload | |
3453 | (defun vc-update () | |
ac3f4c6f | 3454 | "Update the current fileset's files to their tip revisions. |
a7192ddb SM |
3455 | For each one that contains no changes, and is not locked, then this simply |
3456 | replaces the work file with the latest revision on its branch. If the file | |
3457 | contains changes, and the backend supports merging news, then any recent | |
d7b60083 | 3458 | changes from the current branch are merged into the working file." |
2765044b | 3459 | (interactive) |
d7b60083 | 3460 | (dolist (file (vc-deduce-fileset)) |
20f95df2 DN |
3461 | (when (let ((buf (get-file-buffer file))) |
3462 | (and buf (buffer-modified-p buf))) | |
3463 | (error "Please kill or save all modified buffers before updating.")) | |
2765044b | 3464 | (if (vc-up-to-date-p file) |
cea93de3 | 3465 | (vc-checkout file nil t) |
2765044b | 3466 | (if (eq (vc-checkout-model file) 'locking) |
d7b60083 | 3467 | (if (eq (vc-state file) 'edited) |
8c16bd8c | 3468 | (error "%s" |
1f325d92 DG |
3469 | (substitute-command-keys |
3470 | "File is locked--type \\[vc-revert] to discard changes")) | |
1388485d | 3471 | (error "Unexpected file state (%s) -- type %s" |
1f325d92 DG |
3472 | (vc-state file) |
3473 | (substitute-command-keys | |
3474 | "\\[vc-next-action] to correct"))) | |
d7b60083 ER |
3475 | (if (not (vc-find-backend-function (vc-backend file) 'merge-news)) |
3476 | (error "Sorry, merging news is not implemented for %s" | |
3477 | (vc-backend file)) | |
c6a234ac | 3478 | (vc-maybe-resolve-conflicts file (vc-call merge-news file))))))) |
2765044b DN |
3479 | |
3480 | (defun vc-version-backup-file (file &optional rev) | |
3481 | "Return name of backup file for revision REV of FILE. | |
3482 | If version backups should be used for FILE, and there exists | |
a7192ddb | 3483 | such a backup for REV or the working revision of file, return |
0d0e9356 | 3484 | its name; otherwise return nil." |
2765044b DN |
3485 | (when (vc-call make-version-backups-p file) |
3486 | (let ((backup-file (vc-version-backup-file-name file rev))) | |
3487 | (if (file-exists-p backup-file) | |
3488 | backup-file | |
3489 | ;; there is no automatic backup, but maybe the user made one manually | |
3490 | (setq backup-file (vc-version-backup-file-name file rev 'manual)) | |
3491 | (if (file-exists-p backup-file) | |
3492 | backup-file))))) | |
3493 | ||
3494 | (defun vc-revert-file (file) | |
ac3f4c6f | 3495 | "Revert FILE back to the repository working revision it was based on." |
2765044b | 3496 | (with-vc-properties |
d7b60083 | 3497 | (list file) |
2765044b DN |
3498 | (let ((backup-file (vc-version-backup-file file))) |
3499 | (when backup-file | |
3500 | (copy-file backup-file file 'ok-if-already-exists 'keep-date) | |
3501 | (vc-delete-automatic-version-backups file)) | |
3502 | (vc-call revert file backup-file)) | |
3503 | `((vc-state . up-to-date) | |
3504 | (vc-checkout-time . ,(nth 5 (file-attributes file))))) | |
3505 | (vc-resynch-buffer file t t)) | |
3506 | ||
76e5906d | 3507 | ;;;###autoload |
1d502d5a | 3508 | (defun vc-switch-backend (file backend) |
7849e179 | 3509 | "Make BACKEND the current version control system for FILE. |
1d502d5a AS |
3510 | FILE must already be registered in BACKEND. The change is not |
3511 | permanent, only for the current session. This function only changes | |
7849e179 SM |
3512 | VC's perspective on FILE, it does not register or unregister it. |
3513 | By default, this command cycles through the registered backends. | |
3514 | To get a prompt, use a prefix argument." | |
3515 | (interactive | |
1d502d5a | 3516 | (list |
94ca88e3 AS |
3517 | (or buffer-file-name |
3518 | (error "There is no version-controlled file in this buffer")) | |
7849e179 SM |
3519 | (let ((backend (vc-backend buffer-file-name)) |
3520 | (backends nil)) | |
d7b60083 ER |
3521 | (unless backend |
3522 | (error "File %s is not under version control" buffer-file-name)) | |
3523 | ;; Find the registered backends. | |
3524 | (dolist (backend vc-handled-backends) | |
3525 | (when (vc-call-backend backend 'registered buffer-file-name) | |
3526 | (push backend backends))) | |
3527 | ;; Find the next backend. | |
3528 | (let ((def (car (delq backend (append (memq backend backends) backends)))) | |
3529 | (others (delete backend backends))) | |
3530 | (cond | |
3531 | ((null others) (error "No other backend to switch to")) | |
3532 | (current-prefix-arg | |
3533 | (intern | |
3534 | (upcase | |
3535 | (completing-read | |
3536 | (format "Switch to backend [%s]: " def) | |
3537 | (mapcar (lambda (b) (list (downcase (symbol-name b)))) backends) | |
3538 | nil t nil nil (downcase (symbol-name def)))))) | |
3539 | (t def)))))) | |
ceec5a0c | 3540 | (unless (eq backend (vc-backend file)) |
ceec5a0c SM |
3541 | (vc-file-clearprops file) |
3542 | (vc-file-setprop file 'vc-backend backend) | |
3543 | ;; Force recomputation of the state | |
a3255400 SM |
3544 | (unless (vc-call-backend backend 'registered file) |
3545 | (vc-file-clearprops file) | |
3546 | (error "%s is not registered in %s" file backend)) | |
ceec5a0c | 3547 | (vc-mode-line file))) |
1d502d5a | 3548 | |
21b50296 | 3549 | ;;;###autoload |
1d502d5a | 3550 | (defun vc-transfer-file (file new-backend) |
ceec5a0c | 3551 | "Transfer FILE to another version control system NEW-BACKEND. |
1d502d5a | 3552 | If NEW-BACKEND has a higher precedence than FILE's current backend |
ceec5a0c | 3553 | \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in |
ac3f4c6f | 3554 | NEW-BACKEND, using the revision number from the current backend as the |
1d502d5a AS |
3555 | base level. If NEW-BACKEND has a lower precedence than the current |
3556 | backend, then commit all changes that were made under the current | |
3557 | backend to NEW-BACKEND, and unregister FILE from the current backend. | |
3558 | \(If FILE is not yet registered under NEW-BACKEND, register it.)" | |
72cfc5fb AS |
3559 | (let* ((old-backend (vc-backend file)) |
3560 | (edited (memq (vc-state file) '(edited needs-merge))) | |
3561 | (registered (vc-call-backend new-backend 'registered file)) | |
3562 | (move | |
3563 | (and registered ; Never move if not registered in new-backend yet. | |
3564 | ;; move if new-backend comes later in vc-handled-backends | |
3565 | (or (memq new-backend (memq old-backend vc-handled-backends)) | |
ffda0460 | 3566 | (y-or-n-p "Final transfer? ")))) |
72cfc5fb | 3567 | (comment nil)) |
1d502d5a | 3568 | (if (eq old-backend new-backend) |
72cfc5fb AS |
3569 | (error "%s is the current backend of %s" new-backend file)) |
3570 | (if registered | |
3571 | (set-file-modes file (logior (file-modes file) 128)) | |
3572 | ;; `registered' might have switched under us. | |
3573 | (vc-switch-backend file old-backend) | |
ac3f4c6f | 3574 | (let* ((rev (vc-working-revision file)) |
c1b1b393 | 3575 | (modified-file (and edited (make-temp-file file))) |
ffda0460 | 3576 | (unmodified-file (and modified-file (vc-version-backup-file file)))) |
72cfc5fb AS |
3577 | ;; Go back to the base unmodified file. |
3578 | (unwind-protect | |
3579 | (progn | |
ffda0460 | 3580 | (when modified-file |
c1b1b393 | 3581 | (copy-file file modified-file 'ok-if-already-exists) |
ffda0460 AS |
3582 | ;; If we have a local copy of the unmodified file, handle that |
3583 | ;; here and not in vc-revert-file because we don't want to | |
3584 | ;; delete that copy -- it is still useful for OLD-BACKEND. | |
3585 | (if unmodified-file | |
b4e4e3a8 SM |
3586 | (copy-file unmodified-file file |
3587 | 'ok-if-already-exists 'keep-date) | |
ac3f4c6f | 3588 | (if (y-or-n-p "Get base revision from master? ") |
ffda0460 | 3589 | (vc-revert-file file)))) |
72cfc5fb | 3590 | (vc-call-backend new-backend 'receive-file file rev)) |
ffda0460 | 3591 | (when modified-file |
72cfc5fb AS |
3592 | (vc-switch-backend file new-backend) |
3593 | (unless (eq (vc-checkout-model file) 'implicit) | |
3594 | (vc-checkout file t nil)) | |
ffda0460 AS |
3595 | (rename-file modified-file file 'ok-if-already-exists) |
3596 | (vc-file-setprop file 'vc-checkout-time nil))))) | |
72cfc5fb AS |
3597 | (when move |
3598 | (vc-switch-backend file old-backend) | |
3599 | (setq comment (vc-call comment-history file)) | |
3600 | (vc-call unregister file)) | |
3601 | (vc-switch-backend file new-backend) | |
3602 | (when (or move edited) | |
1d502d5a | 3603 | (vc-file-setprop file 'vc-state 'edited) |
ffda0460 | 3604 | (vc-mode-line file) |
0ab66291 | 3605 | (vc-checkin file nil comment (stringp comment))))) |
1d502d5a | 3606 | |
0e362f54 GM |
3607 | (defun vc-rename-master (oldmaster newfile templates) |
3608 | "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES." | |
3609 | (let* ((dir (file-name-directory (expand-file-name oldmaster))) | |
3610 | (newdir (or (file-name-directory newfile) "")) | |
3611 | (newbase (file-name-nondirectory newfile)) | |
3612 | (masters | |
3613 | ;; List of potential master files for `newfile' | |
3614 | (mapcar | |
3615 | (lambda (s) (vc-possible-master s newdir newbase)) | |
3616 | templates))) | |
3617 | (if (or (file-symlink-p oldmaster) | |
3618 | (file-symlink-p (file-name-directory oldmaster))) | |
6f1ecae4 | 3619 | (error "This is unsafe in the presence of symbolic links")) |
0e362f54 GM |
3620 | (rename-file |
3621 | oldmaster | |
3622 | (catch 'found | |
3623 | ;; If possible, keep the master file in the same directory. | |
b4e4e3a8 SM |
3624 | (dolist (f masters) |
3625 | (if (and f (string= (file-name-directory (expand-file-name f)) dir)) | |
3626 | (throw 'found f))) | |
0e362f54 | 3627 | ;; If not, just use the first possible place. |
b4e4e3a8 SM |
3628 | (dolist (f masters) |
3629 | (and f (or (not (setq dir (file-name-directory f))) | |
3630 | (file-directory-p dir)) | |
3631 | (throw 'found f))) | |
0e362f54 | 3632 | (error "New file lacks a version control directory"))))) |
594722a8 | 3633 | |
a36319a4 SM |
3634 | (defun vc-delete-file (file) |
3635 | "Delete file and mark it as such in the version control system." | |
3636 | (interactive "fVC delete file: ") | |
484c3092 | 3637 | (setq file (expand-file-name file)) |
c6e44350 AS |
3638 | (let ((buf (get-file-buffer file)) |
3639 | (backend (vc-backend file))) | |
3640 | (unless backend | |
86a65190 | 3641 | (error "File %s is not under version control" |
c6e44350 | 3642 | (file-name-nondirectory file))) |
a36319a4 | 3643 | (unless (vc-find-backend-function backend 'delete-file) |
c6e44350 | 3644 | (error "Deleting files under %s is not supported in VC" backend)) |
a36319a4 SM |
3645 | (if (and buf (buffer-modified-p buf)) |
3646 | (error "Please save files before deleting them")) | |
ce5a3ac0 | 3647 | (unless (y-or-n-p (format "Really want to delete %s? " |
a36319a4 SM |
3648 | (file-name-nondirectory file))) |
3649 | (error "Abort!")) | |
3650 | (unless (or (file-directory-p file) (null make-backup-files)) | |
3651 | (with-current-buffer (or buf (find-file-noselect file)) | |
3652 | (let ((backup-inhibited nil)) | |
484c3092 DN |
3653 | (backup-buffer)) |
3654 | ;; If we didn't have a buffer visiting the file before this | |
3655 | ;; command, kill the buffer created by the above | |
3656 | ;; `find-file-noselect' call. | |
3657 | (unless buf (kill-buffer (current-buffer))))) | |
a36319a4 SM |
3658 | (vc-call delete-file file) |
3659 | ;; If the backend hasn't deleted the file itself, let's do it for him. | |
484c3092 DN |
3660 | (if (file-exists-p file) (delete-file file)) |
3661 | ;; Forget what VC knew about the file. | |
3662 | (vc-file-clearprops file) | |
3663 | (vc-resynch-buffer file buf t))) | |
a36319a4 | 3664 | |
29fc1ce9 | 3665 | ;;;###autoload |
594722a8 | 3666 | (defun vc-rename-file (old new) |
34291cd2 RS |
3667 | "Rename file OLD to NEW, and rename its master file likewise." |
3668 | (interactive "fVC rename file: \nFRename to: ") | |
a36319a4 | 3669 | (let ((oldbuf (get-file-buffer old))) |
d52f0de9 | 3670 | (if (and oldbuf (buffer-modified-p oldbuf)) |
590cc449 | 3671 | (error "Please save files before moving them")) |
594722a8 | 3672 | (if (get-file-buffer new) |
590cc449 | 3673 | (error "Already editing new file name")) |
d52f0de9 RS |
3674 | (if (file-exists-p new) |
3675 | (error "New file already exists")) | |
86a65190 | 3676 | (let ((state (vc-state old))) |
a36319a4 SM |
3677 | (unless (memq state '(up-to-date edited)) |
3678 | (error "Please %s files before moving them" | |
3679 | (if (stringp state) "check in" "update")))) | |
3680 | (vc-call rename-file old new) | |
b4e4e3a8 | 3681 | (vc-file-clearprops old) |
0e362f54 | 3682 | ;; Move the actual file (unless the backend did it already) |
a36319a4 | 3683 | (if (file-exists-p old) (rename-file old new)) |
0e362f54 GM |
3684 | ;; ?? Renaming a file might change its contents due to keyword expansion. |
3685 | ;; We should really check out a new copy if the old copy was precisely equal | |
ac3f4c6f | 3686 | ;; to some checked-in revision. However, testing for this is tricky.... |
594722a8 | 3687 | (if oldbuf |
0e362f54 | 3688 | (with-current-buffer oldbuf |
4c145b9e RS |
3689 | (let ((buffer-read-only buffer-read-only)) |
3690 | (set-visited-file-name new)) | |
3691 | (vc-backend new) | |
3692 | (vc-mode-line new) | |
0e362f54 GM |
3693 | (set-buffer-modified-p nil))))) |
3694 | ||
637a8ae9 | 3695 | ;;;###autoload |
f35ecf88 | 3696 | (defun vc-update-change-log (&rest args) |
0e362f54 | 3697 | "Find change log file and add entries from recent version control logs. |
d68e6990 | 3698 | Normally, find log entries for all registered files in the default |
0e362f54 | 3699 | directory. |
d68e6990 | 3700 | |
099bd78a | 3701 | With prefix arg of \\[universal-argument], only find log entries for the current buffer's file. |
d68e6990 RS |
3702 | |
3703 | With any numeric prefix arg, find log entries for all currently visited | |
3704 | files that are under version control. This puts all the entries in the | |
3705 | log for the default directory, which may not be appropriate. | |
3706 | ||
099bd78a | 3707 | From a program, any ARGS are assumed to be filenames for which |
0e362f54 | 3708 | log entries should be gathered." |
67242a23 RM |
3709 | (interactive |
3710 | (cond ((consp current-prefix-arg) ;C-u | |
3711 | (list buffer-file-name)) | |
3712 | (current-prefix-arg ;Numeric argument. | |
3713 | (let ((files nil) | |
3714 | (buffers (buffer-list)) | |
3715 | file) | |
3716 | (while buffers | |
3717 | (setq file (buffer-file-name (car buffers))) | |
f3c61d82 | 3718 | (and file (vc-backend file) |
4b40fdea | 3719 | (setq files (cons file files))) |
67242a23 | 3720 | (setq buffers (cdr buffers))) |
4b40fdea PE |
3721 | files)) |
3722 | (t | |
0e362f54 GM |
3723 | ;; Don't supply any filenames to backend; this means |
3724 | ;; it should find all relevant files relative to | |
3725 | ;; the default-directory. | |
73a9679c | 3726 | nil))) |
0e362f54 GM |
3727 | (vc-call-backend (vc-responsible-backend default-directory) |
3728 | 'update-changelog args)) | |
3729 | ||
ac3f4c6f | 3730 | ;;; The default back end. Assumes RCS-like revision numbering. |
61de26cb ER |
3731 | |
3732 | (defun vc-default-revision-granularity () | |
3733 | (error "Your backend will not work with this version of VC mode.")) | |
3734 | ||
2765044b DN |
3735 | ;; functions that operate on RCS revision numbers. This code should |
3736 | ;; also be moved into the backends. It stays for now, however, since | |
3737 | ;; it is used in code below. | |
3738 | ;;;###autoload | |
3739 | (defun vc-trunk-p (rev) | |
3740 | "Return t if REV is a revision on the trunk." | |
3741 | (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev)))) | |
3742 | ||
3743 | (defun vc-branch-p (rev) | |
3744 | "Return t if REV is a branch revision." | |
3745 | (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev)))) | |
3746 | ||
3747 | ;;;###autoload | |
3748 | (defun vc-branch-part (rev) | |
3749 | "Return the branch part of a revision number REV." | |
3750 | (let ((index (string-match "\\.[0-9]+\\'" rev))) | |
3751 | (if index | |
3752 | (substring rev 0 index)))) | |
3753 | ||
3754 | (defun vc-minor-part (rev) | |
ac3f4c6f | 3755 | "Return the minor revision number of a revision number REV." |
2765044b DN |
3756 | (string-match "[0-9]+\\'" rev) |
3757 | (substring rev (match-beginning 0) (match-end 0))) | |
3758 | ||
ac3f4c6f ER |
3759 | (defun vc-default-previous-revision (backend file rev) |
3760 | "Return the revision number immediately preceding REV for FILE, | |
3761 | or nil if there is no previous revision. This default | |
3762 | implementation works for MAJOR.MINOR-style revision numbers as | |
2765044b DN |
3763 | used by RCS and CVS." |
3764 | (let ((branch (vc-branch-part rev)) | |
3765 | (minor-num (string-to-number (vc-minor-part rev)))) | |
3766 | (when branch | |
3767 | (if (> minor-num 1) | |
ac3f4c6f | 3768 | ;; revision does probably not start a branch or release |
2765044b DN |
3769 | (concat branch "." (number-to-string (1- minor-num))) |
3770 | (if (vc-trunk-p rev) | |
3771 | ;; we are at the beginning of the trunk -- | |
3772 | ;; don't know anything to return here | |
3773 | nil | |
3774 | ;; we are at the beginning of a branch -- | |
ac3f4c6f | 3775 | ;; return revision of starting point |
2765044b DN |
3776 | (vc-branch-part branch)))))) |
3777 | ||
ac3f4c6f ER |
3778 | (defun vc-default-next-revision (backend file rev) |
3779 | "Return the revision number immediately following REV for FILE, | |
3780 | or nil if there is no next revision. This default implementation | |
3781 | works for MAJOR.MINOR-style revision numbers as used by RCS | |
2765044b | 3782 | and CVS." |
ac3f4c6f | 3783 | (when (not (string= rev (vc-working-revision file))) |
2765044b DN |
3784 | (let ((branch (vc-branch-part rev)) |
3785 | (minor-num (string-to-number (vc-minor-part rev)))) | |
3786 | (concat branch "." (number-to-string (1+ minor-num)))))) | |
3787 | ||
3788 | (defun vc-default-responsible-p (backend file) | |
3789 | "Indicate whether BACKEND is reponsible for FILE. | |
3790 | The default is to return nil always." | |
3791 | nil) | |
3792 | ||
3793 | (defun vc-default-could-register (backend file) | |
3794 | "Return non-nil if BACKEND could be used to register FILE. | |
3795 | The default implementation returns t for all files." | |
3796 | t) | |
3797 | ||
3798 | (defun vc-default-latest-on-branch-p (backend file) | |
3799 | "Return non-nil if FILE is the latest on its branch. | |
3800 | This default implementation always returns non-nil, which means that | |
ac3f4c6f | 3801 | editing non-current revisions is not supported by default." |
2765044b DN |
3802 | t) |
3803 | ||
ac3f4c6f | 3804 | (defun vc-default-init-revision (backend) vc-default-init-revision) |
2765044b | 3805 | |
45fd3a00 SM |
3806 | (defalias 'vc-cvs-update-changelog 'vc-update-changelog-rcs2log) |
3807 | (defalias 'vc-rcs-update-changelog 'vc-update-changelog-rcs2log) | |
3808 | ;; FIXME: This should probably be moved to vc-rcs.el and replaced in | |
3809 | ;; vc-cvs.el by code using cvs2cl. | |
0b8dce84 | 3810 | (defun vc-update-changelog-rcs2log (files) |
099bd78a SM |
3811 | "Default implementation of update-changelog. |
3812 | Uses `rcs2log' which only works for RCS and CVS." | |
0e362f54 | 3813 | ;; FIXME: We (c|sh)ould add support for cvs2cl |
449decf5 | 3814 | (let ((odefault default-directory) |
124c852b RS |
3815 | (changelog (find-change-log)) |
3816 | ;; Presumably not portable to non-Unixy systems, along with rcs2log: | |
c1b1b393 | 3817 | (tempfile (make-temp-file |
57c298c4 EZ |
3818 | (expand-file-name "vc" |
3819 | (or small-temporary-file-directory | |
3820 | temporary-file-directory)))) | |
510f6466 AS |
3821 | (login-name (or user-login-name |
3822 | (format "uid%d" (number-to-string (user-uid))))) | |
b91916f3 | 3823 | (full-name (or add-log-full-name |
8172cd86 AS |
3824 | (user-full-name) |
3825 | (user-login-name) | |
3826 | (format "uid%d" (number-to-string (user-uid))))) | |
b91916f3 RS |
3827 | (mailing-address (or add-log-mailing-address |
3828 | user-mail-address))) | |
124c852b | 3829 | (find-file-other-window changelog) |
41dfb835 RS |
3830 | (barf-if-buffer-read-only) |
3831 | (vc-buffer-sync) | |
3832 | (undo-boundary) | |
3833 | (goto-char (point-min)) | |
3834 | (push-mark) | |
3835 | (message "Computing change log entries...") | |
4b40fdea | 3836 | (message "Computing change log entries... %s" |
124c852b RS |
3837 | (unwind-protect |
3838 | (progn | |
0e362f54 | 3839 | (setq default-directory odefault) |
6f41eeb5 DL |
3840 | (if (eq 0 (apply 'call-process |
3841 | (expand-file-name "rcs2log" | |
3842 | exec-directory) | |
0e362f54 GM |
3843 | nil (list t tempfile) nil |
3844 | "-c" changelog | |
510f6466 | 3845 | "-u" (concat login-name |
0e362f54 GM |
3846 | "\t" full-name |
3847 | "\t" mailing-address) | |
3848 | (mapcar | |
3849 | (lambda (f) | |
3850 | (file-relative-name | |
d7b60083 | 3851 | (expand-file-name f odefault))) |
0e362f54 GM |
3852 | files))) |
3853 | "done" | |
04864eb0 | 3854 | (pop-to-buffer (get-buffer-create "*vc*")) |
124c852b | 3855 | (erase-buffer) |
54ebae28 | 3856 | (insert-file-contents tempfile) |
124c852b | 3857 | "failed")) |
0e362f54 | 3858 | (setq default-directory (file-name-directory changelog)) |
124c852b | 3859 | (delete-file tempfile))))) |
7d2d9482 | 3860 | |
ac3f4c6f ER |
3861 | (defun vc-default-find-revision (backend file rev buffer) |
3862 | "Provide the new `find-revision' op based on the old `checkout' op. | |
2765044b | 3863 | This is only for compatibility with old backends. They should be updated |
ac3f4c6f | 3864 | to provide the `find-revision' operation instead." |
2765044b DN |
3865 | (let ((tmpfile (make-temp-file (expand-file-name file)))) |
3866 | (unwind-protect | |
3867 | (progn | |
3868 | (vc-call-backend backend 'checkout file nil rev tmpfile) | |
3869 | (with-current-buffer buffer | |
3870 | (insert-file-contents-literally tmpfile))) | |
3871 | (delete-file tmpfile)))) | |
3872 | ||
3873 | (defun vc-default-dired-state-info (backend file) | |
d7b60083 ER |
3874 | (let* ((state (vc-state file)) |
3875 | (statestring | |
3876 | (cond | |
3877 | ((stringp state) (concat "(" state ")")) | |
45b24b4d | 3878 | ((eq state 'edited) "(modified)") |
d7b60083 ER |
3879 | ((eq state 'needs-merge) "(merge)") |
3880 | ((eq state 'needs-patch) "(patch)") | |
0f67cc71 | 3881 | ((eq state 'added) "(added)") |
484c1b1f | 3882 | ((eq state 'removed) "(removed)") |
722f037f ER |
3883 | ((eq state 'ignored) "(ignored)") ;; dired-hook filters this out |
3884 | ((eq state 'unregistered) "?") | |
3885 | ((eq state 'unlocked-changes) "(stale)") | |
3886 | ((not state) "(unknown)"))) | |
d7b60083 ER |
3887 | (buffer |
3888 | (get-file-buffer file)) | |
3889 | (modflag | |
3890 | (if (and buffer (buffer-modified-p buffer)) "+" ""))) | |
3891 | (concat statestring modflag))) | |
2765044b DN |
3892 | |
3893 | (defun vc-default-rename-file (backend old new) | |
3894 | (condition-case nil | |
3895 | (add-name-to-file old new) | |
3896 | (error (rename-file old new))) | |
3897 | (vc-delete-file old) | |
3898 | (with-current-buffer (find-file-noselect new) | |
3899 | (vc-register))) | |
3900 | ||
3901 | (defalias 'vc-default-logentry-check 'ignore) | |
17f3909f | 3902 | (defalias 'vc-default-check-headers 'ignore) |
2765044b DN |
3903 | |
3904 | (defun vc-default-log-view-mode (backend) (log-view-mode)) | |
3905 | ||
3906 | (defun vc-default-show-log-entry (backend rev) | |
3907 | (with-no-warnings | |
3908 | (log-view-goto-rev rev))) | |
3909 | ||
3910 | (defun vc-default-comment-history (backend file) | |
3911 | "Return a string with all log entries stored in BACKEND for FILE." | |
3912 | (if (vc-find-backend-function backend 'print-log) | |
3913 | (with-current-buffer "*vc*" | |
3914 | (vc-call print-log (list file)) | |
3f57aeb7 | 3915 | (vc-call-backend backend 'wash-log) |
2765044b DN |
3916 | (buffer-string)))) |
3917 | ||
2765044b DN |
3918 | (defun vc-default-receive-file (backend file rev) |
3919 | "Let BACKEND receive FILE from another version control system." | |
3920 | (vc-call-backend backend 'register file rev "")) | |
3921 | ||
3922 | (defun vc-default-create-snapshot (backend dir name branchp) | |
3923 | (when branchp | |
3924 | (error "VC backend %s does not support module branches" backend)) | |
3925 | (let ((result (vc-snapshot-precondition dir))) | |
3926 | (if (stringp result) | |
3927 | (error "File %s is not up-to-date" result) | |
3928 | (vc-file-tree-walk | |
3929 | dir | |
3930 | (lambda (f) | |
3931 | (vc-call assign-name f name)))))) | |
3932 | ||
3933 | (defun vc-default-retrieve-snapshot (backend dir name update) | |
3934 | (if (string= name "") | |
3935 | (progn | |
3936 | (vc-file-tree-walk | |
3937 | dir | |
3938 | (lambda (f) (and | |
3939 | (vc-up-to-date-p f) | |
3940 | (vc-error-occurred | |
3941 | (vc-call checkout f nil "") | |
3942 | (if update (vc-resynch-buffer f t t))))))) | |
3943 | (let ((result (vc-snapshot-precondition dir))) | |
3944 | (if (stringp result) | |
3945 | (error "File %s is locked" result) | |
3946 | (setq update (and (eq result 'visited) update)) | |
3947 | (vc-file-tree-walk | |
3948 | dir | |
3949 | (lambda (f) (vc-error-occurred | |
3950 | (vc-call checkout f nil name) | |
3951 | (if update (vc-resynch-buffer f t t))))))))) | |
3952 | ||
3953 | (defun vc-default-revert (backend file contents-done) | |
3954 | (unless contents-done | |
ac3f4c6f | 3955 | (let ((rev (vc-working-revision file)) |
2765044b DN |
3956 | (file-buffer (or (get-file-buffer file) (current-buffer)))) |
3957 | (message "Checking out %s..." file) | |
3958 | (let ((failed t) | |
3959 | (backup-name (car (find-backup-file-name file)))) | |
3960 | (when backup-name | |
3961 | (copy-file file backup-name 'ok-if-already-exists 'keep-date) | |
3962 | (unless (file-writable-p file) | |
3963 | (set-file-modes file (logior (file-modes file) 128)))) | |
3964 | (unwind-protect | |
3965 | (let ((coding-system-for-read 'no-conversion) | |
3966 | (coding-system-for-write 'no-conversion)) | |
3967 | (with-temp-file file | |
3968 | (let ((outbuf (current-buffer))) | |
3969 | ;; Change buffer to get local value of vc-checkout-switches. | |
3970 | (with-current-buffer file-buffer | |
3971 | (let ((default-directory (file-name-directory file))) | |
ac3f4c6f | 3972 | (vc-call find-revision file rev outbuf))))) |
2765044b DN |
3973 | (setq failed nil)) |
3974 | (when backup-name | |
3975 | (if failed | |
3976 | (rename-file backup-name file 'ok-if-already-exists) | |
3977 | (and (not vc-make-backup-files) (delete-file backup-name)))))) | |
3978 | (message "Checking out %s...done" file)))) | |
3979 | ||
17f3909f | 3980 | (defalias 'vc-default-revision-completion-table 'ignore) |
2765044b DN |
3981 | |
3982 | (defun vc-check-headers () | |
3983 | "Check if the current file has any headers in it." | |
3984 | (interactive) | |
3985 | (vc-call-backend (vc-backend buffer-file-name) 'check-headers)) | |
3986 | ||
3987 | ;;; Annotate functionality | |
7d2d9482 | 3988 | |
f80f7bc2 RS |
3989 | ;; Declare globally instead of additional parameter to |
3990 | ;; temp-buffer-show-function (not possible to pass more than one | |
75665141 AS |
3991 | ;; parameter). The use of annotate-ratio is deprecated in favor of |
3992 | ;; annotate-mode, which replaces it with the more sensible "span-to | |
3993 | ;; days", along with autoscaling support. | |
099bd78a | 3994 | (defvar vc-annotate-ratio nil "Global variable.") |
0e362f54 | 3995 | |
1b5a7343 | 3996 | ;; internal buffer-local variables |
04864eb0 | 3997 | (defvar vc-annotate-backend nil) |
1b5a7343 AS |
3998 | (defvar vc-annotate-parent-file nil) |
3999 | (defvar vc-annotate-parent-rev nil) | |
4000 | (defvar vc-annotate-parent-display-mode nil) | |
1b5a7343 | 4001 | |
f66a6225 SM |
4002 | (defconst vc-annotate-font-lock-keywords |
4003 | ;; The fontification is done by vc-annotate-lines instead of font-lock. | |
4004 | '((vc-annotate-lines))) | |
4005 | ||
93113211 | 4006 | (define-derived-mode vc-annotate-mode fundamental-mode "Annotate" |
6f1ecae4 | 4007 | "Major mode for output buffers of the `vc-annotate' command. |
7d2d9482 RS |
4008 | |
4009 | You can use the mode-specific menu to alter the time-span of the used | |
4010 | colors. See variable `vc-annotate-menu-elements' for customizing the | |
4011 | menu items." | |
5731a8e0 TTN |
4012 | ;; Frob buffer-invisibility-spec so that if it is originally a naked t, |
4013 | ;; it will become a list, to avoid initial annotations being invisible. | |
4014 | (add-to-invisibility-spec 'foo) | |
4015 | (remove-from-invisibility-spec 'foo) | |
f66a6225 SM |
4016 | (set (make-local-variable 'truncate-lines) t) |
4017 | (set (make-local-variable 'font-lock-defaults) | |
4018 | '(vc-annotate-font-lock-keywords t)) | |
04864eb0 | 4019 | (view-mode 1)) |
7d2d9482 | 4020 | |
5731a8e0 TTN |
4021 | (defun vc-annotate-toggle-annotation-visibility () |
4022 | "Toggle whether or not the annotation is visible." | |
4023 | (interactive) | |
4024 | (funcall (if (memq 'vc-annotate-annotation buffer-invisibility-spec) | |
4025 | 'remove-from-invisibility-spec | |
4026 | 'add-to-invisibility-spec) | |
4027 | 'vc-annotate-annotation) | |
4028 | (force-window-update (current-buffer))) | |
4029 | ||
97461c84 | 4030 | (defun vc-annotate-display-default (ratio) |
6f1ecae4 | 4031 | "Display the output of \\[vc-annotate] using the default color range. |
97461c84 SM |
4032 | The color range is given by `vc-annotate-color-map', scaled by RATIO. |
4033 | The current time is used as the offset." | |
4034 | (interactive (progn (kill-local-variable 'vc-annotate-color-map) '(1.0))) | |
f80f7bc2 | 4035 | (message "Redisplaying annotation...") |
97461c84 | 4036 | (vc-annotate-display ratio) |
f80f7bc2 | 4037 | (message "Redisplaying annotation...done")) |
7d2d9482 | 4038 | |
97461c84 SM |
4039 | (defun vc-annotate-oldest-in-map (color-map) |
4040 | "Return the oldest time in the COLOR-MAP." | |
4041 | ;; Since entries should be sorted, we can just use the last one. | |
4042 | (caar (last color-map))) | |
6149bbfb | 4043 | |
5731a8e0 TTN |
4044 | (defun vc-annotate-get-time-set-line-props () |
4045 | (let ((bol (point)) | |
4046 | (date (vc-call-backend vc-annotate-backend 'annotate-time)) | |
4047 | (inhibit-read-only t)) | |
f605fc58 | 4048 | (assert (>= (point) bol)) |
5731a8e0 TTN |
4049 | (put-text-property bol (point) 'invisible 'vc-annotate-annotation) |
4050 | date)) | |
4051 | ||
75665141 | 4052 | (defun vc-annotate-display-autoscale (&optional full) |
946b248f | 4053 | "Highlight the output of \\[vc-annotate] using an autoscaled color map. |
6f1ecae4 | 4054 | Autoscaling means that the map is scaled from the current time to the |
f36e4afe | 4055 | oldest annotation in the buffer, or, with prefix argument FULL, to |
6f1ecae4 | 4056 | cover the range from the oldest annotation to the newest." |
f36e4afe | 4057 | (interactive "P") |
75665141 AS |
4058 | (let ((newest 0.0) |
4059 | (oldest 999999.) ;Any CVS users at the founding of Rome? | |
4060 | (current (vc-annotate-convert-time (current-time))) | |
4061 | date) | |
4062 | (message "Redisplaying annotation...") | |
4063 | ;; Run through this file and find the oldest and newest dates annotated. | |
4064 | (save-excursion | |
4065 | (goto-char (point-min)) | |
7c33af85 | 4066 | (while (not (eobp)) |
5731a8e0 | 4067 | (when (setq date (vc-annotate-get-time-set-line-props)) |
7c33af85 SM |
4068 | (if (> date newest) |
4069 | (setq newest date)) | |
4070 | (if (< date oldest) | |
4071 | (setq oldest date))) | |
4072 | (forward-line 1))) | |
75665141 | 4073 | (vc-annotate-display |
97461c84 SM |
4074 | (/ (- (if full newest current) oldest) |
4075 | (vc-annotate-oldest-in-map vc-annotate-color-map)) | |
75665141 | 4076 | (if full newest)) |
99cb8c8b SS |
4077 | (message "Redisplaying annotation...done \(%s\)" |
4078 | (if full | |
4079 | (format "Spanned from %.1f to %.1f days old" | |
75665141 AS |
4080 | (- current oldest) |
4081 | (- current newest)) | |
4082 | (format "Spanned to %.1f days old" (- current oldest)))))) | |
4083 | ||
4084 | ;; Menu -- Using easymenu.el | |
04864eb0 SM |
4085 | (easy-menu-define vc-annotate-mode-menu vc-annotate-mode-map |
4086 | "VC Annotate Display Menu" | |
4087 | `("VC-Annotate" | |
da7c8a12 | 4088 | ["By Color Map Range" (unless (null vc-annotate-display-mode) |
04864eb0 SM |
4089 | (setq vc-annotate-display-mode nil) |
4090 | (vc-annotate-display-select)) | |
4091 | :style toggle :selected (null vc-annotate-display-mode)] | |
97461c84 | 4092 | ,@(let ((oldest-in-map (vc-annotate-oldest-in-map vc-annotate-color-map))) |
04864eb0 SM |
4093 | (mapcar (lambda (element) |
4094 | (let ((days (* element oldest-in-map))) | |
07a95b81 SM |
4095 | `[,(format "Span %.1f days" days) |
4096 | (vc-annotate-display-select nil ,days) | |
4097 | :style toggle :selected | |
4098 | (eql vc-annotate-display-mode ,days) ])) | |
04864eb0 SM |
4099 | vc-annotate-menu-elements)) |
4100 | ["Span ..." | |
07a95b81 SM |
4101 | (vc-annotate-display-select |
4102 | nil (float (string-to-number (read-string "Span how many days? "))))] | |
04864eb0 SM |
4103 | "--" |
4104 | ["Span to Oldest" | |
4105 | (unless (eq vc-annotate-display-mode 'scale) | |
4106 | (vc-annotate-display-select nil 'scale)) | |
df04e22c | 4107 | :help |
f3ff0fe9 | 4108 | "Use an autoscaled color map from the oldest annotation to the current time" |
04864eb0 SM |
4109 | :style toggle :selected |
4110 | (eq vc-annotate-display-mode 'scale)] | |
4111 | ["Span Oldest->Newest" | |
4112 | (unless (eq vc-annotate-display-mode 'fullscale) | |
4113 | (vc-annotate-display-select nil 'fullscale)) | |
df04e22c | 4114 | :help |
f3ff0fe9 | 4115 | "Use an autoscaled color map from the oldest to the newest annotation" |
04864eb0 SM |
4116 | :style toggle :selected |
4117 | (eq vc-annotate-display-mode 'fullscale)] | |
4118 | "--" | |
f3ff0fe9 | 4119 | ["Toggle annotation visibility" vc-annotate-toggle-annotation-visibility |
df04e22c | 4120 | :help |
f3ff0fe9 DN |
4121 | "Toggle whether the annotation is visible or not"] |
4122 | ["Annotate previous revision" vc-annotate-prev-revision | |
4123 | :help "Visit the annotation of the revision previous to this one"] | |
4124 | ["Annotate next revision" vc-annotate-next-revision | |
4125 | :help "Visit the annotation of the revision after this one"] | |
4126 | ["Annotate revision at line" vc-annotate-revision-at-line | |
df04e22c | 4127 | :help |
f3ff0fe9 DN |
4128 | "Visit the annotation of the revision identified in the current line"] |
4129 | ["Annotate revision previous to line" vc-annotate-revision-previous-to-line | |
4130 | :help "Visit the annotation of the revision before the revision at line"] | |
4131 | ["Annotate latest revision" vc-annotate-working-revision | |
4132 | :help "Visit the annotation of the working revision of this file"] | |
4133 | ["Show log of revision at line" vc-annotate-show-log-revision-at-line | |
4134 | :help "Visit the log of the revision at line"] | |
4135 | ["Show diff of revision at line" vc-annotate-show-diff-revision-at-line | |
df04e22c | 4136 | :help |
f3ff0fe9 DN |
4137 | "Visit the diff of the revision at line from its previous revision"] |
4138 | ["Visit revision at line" vc-annotate-find-revision-at-line | |
4139 | :help "Visit the revision identified in the current line"])) | |
75665141 AS |
4140 | |
4141 | (defun vc-annotate-display-select (&optional buffer mode) | |
6f1ecae4 AS |
4142 | "Highlight the output of \\[vc-annotate]. |
4143 | By default, the current buffer is highlighted, unless overridden by | |
4144 | BUFFER. `vc-annotate-display-mode' specifies the highlighting mode to | |
4145 | use; you may override this using the second optional arg MODE." | |
4146 | (interactive) | |
75665141 | 4147 | (if mode (setq vc-annotate-display-mode mode)) |
8a8f8697 | 4148 | (pop-to-buffer (or buffer (current-buffer))) |
f66a6225 | 4149 | (cond ((null vc-annotate-display-mode) |
07a95b81 SM |
4150 | ;; The ratio is global, thus relative to the global color-map. |
4151 | (kill-local-variable 'vc-annotate-color-map) | |
97461c84 SM |
4152 | (vc-annotate-display-default (or vc-annotate-ratio 1.0))) |
4153 | ;; One of the auto-scaling modes | |
f66a6225 | 4154 | ((eq vc-annotate-display-mode 'scale) |
7c33af85 | 4155 | (vc-exec-after `(vc-annotate-display-autoscale))) |
f66a6225 | 4156 | ((eq vc-annotate-display-mode 'fullscale) |
7c33af85 | 4157 | (vc-exec-after `(vc-annotate-display-autoscale t))) |
75665141 AS |
4158 | ((numberp vc-annotate-display-mode) ; A fixed number of days lookback |
4159 | (vc-annotate-display-default | |
97461c84 SM |
4160 | (/ vc-annotate-display-mode |
4161 | (vc-annotate-oldest-in-map vc-annotate-color-map)))) | |
f66a6225 SM |
4162 | (t (error "No such display mode: %s" |
4163 | vc-annotate-display-mode)))) | |
0e362f54 | 4164 | |
7d2d9482 | 4165 | ;;;###autoload |
bae9f9e3 | 4166 | (defun vc-annotate (file rev &optional display-mode buf move-point-to) |
aa406465 | 4167 | "Display the edit history of the current file using colors. |
1cec418c AS |
4168 | |
4169 | This command creates a buffer that shows, for each line of the current | |
aa406465 | 4170 | file, when it was last edited and by whom. Additionally, colors are |
1cec418c | 4171 | used to show the age of each line--blue means oldest, red means |
aa406465 | 4172 | youngest, and intermediate colors indicate intermediate ages. By |
1cec418c AS |
4173 | default, the time scale stretches back one year into the past; |
4174 | everything that is older than that is shown in blue. | |
4175 | ||
4176 | With a prefix argument, this command asks two questions in the | |
ac3f4c6f ER |
4177 | minibuffer. First, you may enter a revision number; then the buffer |
4178 | displays and annotates that revision instead of the working revision | |
eb407e67 | 4179 | \(type RET in the minibuffer to leave that default unchanged). Then, |
ecd50f65 AS |
4180 | you are prompted for the time span in days which the color range |
4181 | should cover. For example, a time span of 20 days means that changes | |
4182 | over the past 20 days are shown in red to blue, according to their | |
4183 | age, and everything that is older than that is shown in blue. | |
1cec418c | 4184 | |
bae9f9e3 DN |
4185 | If MOVE-POINT-TO is given, move the point to that line. |
4186 | ||
1cec418c | 4187 | Customization variables: |
7d2d9482 RS |
4188 | |
4189 | `vc-annotate-menu-elements' customizes the menu elements of the | |
a7192ddb SM |
4190 | mode-specific menu. `vc-annotate-color-map' and |
4191 | `vc-annotate-very-old-color' define the mapping of time to colors. | |
4192 | `vc-annotate-background' specifies the background color." | |
04864eb0 SM |
4193 | (interactive |
4194 | (save-current-buffer | |
4195 | (vc-ensure-vc-buffer) | |
4196 | (list buffer-file-name | |
ac3f4c6f | 4197 | (let ((def (vc-working-revision buffer-file-name))) |
04864eb0 SM |
4198 | (if (null current-prefix-arg) def |
4199 | (read-string | |
ac3f4c6f | 4200 | (format "Annotate from revision (default %s): " def) |
04864eb0 SM |
4201 | nil nil def))) |
4202 | (if (null current-prefix-arg) | |
4203 | vc-annotate-display-mode | |
4204 | (float (string-to-number | |
4205 | (read-string "Annotate span days (default 20): " | |
4206 | nil nil "20"))))))) | |
b6909007 | 4207 | (vc-ensure-vc-buffer) |
04864eb0 SM |
4208 | (setq vc-annotate-display-mode display-mode) ;Not sure why. --Stef |
4209 | (let* ((temp-buffer-name (format "*Annotate %s (rev %s)*" (buffer-name) rev)) | |
1867d8cb TTN |
4210 | (temp-buffer-show-function 'vc-annotate-display-select) |
4211 | ;; If BUF is specified, we presume the caller maintains current line, | |
4212 | ;; so we don't need to do it here. This implementation may give | |
4213 | ;; strange results occasionally in the case of REV != WORKFILE-REV. | |
bae9f9e3 | 4214 | (current-line (or move-point-to (unless buf (line-number-at-pos))))) |
afe35502 | 4215 | (message "Annotating...") |
04864eb0 SM |
4216 | ;; If BUF is specified it tells in which buffer we should put the |
4217 | ;; annotations. This is used when switching annotations to another | |
4218 | ;; revision, so we should update the buffer's name. | |
4219 | (if buf (with-current-buffer buf | |
4220 | (rename-buffer temp-buffer-name t) | |
4221 | ;; In case it had to be uniquified. | |
4222 | (setq temp-buffer-name (buffer-name)))) | |
46e33aee | 4223 | (with-output-to-temp-buffer temp-buffer-name |
da7c8a12 S |
4224 | (vc-call annotate-command file (get-buffer temp-buffer-name) rev) |
4225 | ;; we must setup the mode first, and then set our local | |
4226 | ;; variables before the show-function is called at the exit of | |
4227 | ;; with-output-to-temp-buffer | |
4228 | (with-current-buffer temp-buffer-name | |
4229 | (if (not (equal major-mode 'vc-annotate-mode)) | |
4230 | (vc-annotate-mode)) | |
4231 | (set (make-local-variable 'vc-annotate-backend) (vc-backend file)) | |
4232 | (set (make-local-variable 'vc-annotate-parent-file) file) | |
4233 | (set (make-local-variable 'vc-annotate-parent-rev) rev) | |
4234 | (set (make-local-variable 'vc-annotate-parent-display-mode) | |
4235 | display-mode))) | |
cd42ec7d | 4236 | |
ebaac04d SM |
4237 | (with-current-buffer temp-buffer-name |
4238 | (vc-exec-after | |
4239 | `(progn | |
4240 | ;; Ideally, we'd rather not move point if the user has already | |
4241 | ;; moved it elsewhere, but really point here is not the position | |
4242 | ;; of the user's cursor :-( | |
4243 | (when ,current-line ;(and (bobp)) | |
86e80023 | 4244 | (goto-line ,current-line) |
01823b77 | 4245 | (setq vc-sentinel-movepoint (point))) |
ebaac04d SM |
4246 | (unless (active-minibuffer-window) |
4247 | (message "Annotating... done"))))))) | |
7d2d9482 | 4248 | |
ac3f4c6f ER |
4249 | (defun vc-annotate-prev-revision (prefix) |
4250 | "Visit the annotation of the revision previous to this one. | |
1b5a7343 | 4251 | |
ac3f4c6f ER |
4252 | With a numeric prefix argument, annotate the revision that many |
4253 | revisions previous." | |
1b5a7343 | 4254 | (interactive "p") |
ac3f4c6f | 4255 | (vc-annotate-warp-revision (- 0 prefix))) |
1b5a7343 | 4256 | |
ac3f4c6f ER |
4257 | (defun vc-annotate-next-revision (prefix) |
4258 | "Visit the annotation of the revision after this one. | |
1b5a7343 | 4259 | |
ac3f4c6f ER |
4260 | With a numeric prefix argument, annotate the revision that many |
4261 | revisions after." | |
1b5a7343 | 4262 | (interactive "p") |
ac3f4c6f | 4263 | (vc-annotate-warp-revision prefix)) |
1b5a7343 | 4264 | |
ac3f4c6f ER |
4265 | (defun vc-annotate-working-revision () |
4266 | "Visit the annotation of the working revision of this file." | |
1b5a7343 AS |
4267 | (interactive) |
4268 | (if (not (equal major-mode 'vc-annotate-mode)) | |
4269 | (message "Cannot be invoked outside of a vc annotate buffer") | |
ac3f4c6f | 4270 | (let ((warp-rev (vc-working-revision vc-annotate-parent-file))) |
1b5a7343 | 4271 | (if (equal warp-rev vc-annotate-parent-rev) |
ac3f4c6f ER |
4272 | (message "Already at revision %s" warp-rev) |
4273 | (vc-annotate-warp-revision warp-rev))))) | |
1b5a7343 AS |
4274 | |
4275 | (defun vc-annotate-extract-revision-at-line () | |
4276 | "Extract the revision number of the current line." | |
4277 | ;; This function must be invoked from a buffer in vc-annotate-mode | |
1b5a7343 AS |
4278 | (vc-call-backend vc-annotate-backend 'annotate-extract-revision-at-line)) |
4279 | ||
4280 | (defun vc-annotate-revision-at-line () | |
ac3f4c6f | 4281 | "Visit the annotation of the revision identified in the current line." |
1b5a7343 AS |
4282 | (interactive) |
4283 | (if (not (equal major-mode 'vc-annotate-mode)) | |
4284 | (message "Cannot be invoked outside of a vc annotate buffer") | |
4285 | (let ((rev-at-line (vc-annotate-extract-revision-at-line))) | |
4286 | (if (not rev-at-line) | |
4287 | (message "Cannot extract revision number from the current line") | |
4288 | (if (equal rev-at-line vc-annotate-parent-rev) | |
ac3f4c6f ER |
4289 | (message "Already at revision %s" rev-at-line) |
4290 | (vc-annotate-warp-revision rev-at-line)))))) | |
1b5a7343 | 4291 | |
f3ff0fe9 DN |
4292 | (defun vc-annotate-find-revision-at-line () |
4293 | "Visit the revision identified in the current line." | |
4294 | (interactive) | |
4295 | (if (not (equal major-mode 'vc-annotate-mode)) | |
4296 | (message "Cannot be invoked outside of a vc annotate buffer") | |
4297 | (let ((rev-at-line (vc-annotate-extract-revision-at-line))) | |
4298 | (if (not rev-at-line) | |
4299 | (message "Cannot extract revision number from the current line") | |
4300 | (vc-revision-other-window rev-at-line))))) | |
4301 | ||
1b5a7343 | 4302 | (defun vc-annotate-revision-previous-to-line () |
ac3f4c6f | 4303 | "Visit the annotation of the revision before the revision at line." |
1b5a7343 AS |
4304 | (interactive) |
4305 | (if (not (equal major-mode 'vc-annotate-mode)) | |
4306 | (message "Cannot be invoked outside of a vc annotate buffer") | |
4307 | (let ((rev-at-line (vc-annotate-extract-revision-at-line)) | |
4308 | (prev-rev nil)) | |
4309 | (if (not rev-at-line) | |
4310 | (message "Cannot extract revision number from the current line") | |
4311 | (setq prev-rev | |
ac3f4c6f ER |
4312 | (vc-call previous-revision vc-annotate-parent-file rev-at-line)) |
4313 | (vc-annotate-warp-revision prev-rev))))) | |
1b5a7343 AS |
4314 | |
4315 | (defun vc-annotate-show-log-revision-at-line () | |
ac3f4c6f | 4316 | "Visit the log of the revision at line." |
1b5a7343 AS |
4317 | (interactive) |
4318 | (if (not (equal major-mode 'vc-annotate-mode)) | |
4319 | (message "Cannot be invoked outside of a vc annotate buffer") | |
4320 | (let ((rev-at-line (vc-annotate-extract-revision-at-line))) | |
4321 | (if (not rev-at-line) | |
4322 | (message "Cannot extract revision number from the current line") | |
4323 | (vc-print-log rev-at-line))))) | |
4324 | ||
4325 | (defun vc-annotate-show-diff-revision-at-line () | |
ac3f4c6f | 4326 | "Visit the diff of the revision at line from its previous revision." |
1b5a7343 AS |
4327 | (interactive) |
4328 | (if (not (equal major-mode 'vc-annotate-mode)) | |
4329 | (message "Cannot be invoked outside of a vc annotate buffer") | |
4330 | (let ((rev-at-line (vc-annotate-extract-revision-at-line)) | |
4331 | (prev-rev nil)) | |
4332 | (if (not rev-at-line) | |
4333 | (message "Cannot extract revision number from the current line") | |
4334 | (setq prev-rev | |
ac3f4c6f | 4335 | (vc-call previous-revision vc-annotate-parent-file rev-at-line)) |
1b5a7343 | 4336 | (if (not prev-rev) |
ac3f4c6f | 4337 | (message "Cannot diff from any revision prior to %s" rev-at-line) |
1b5a7343 | 4338 | (save-window-excursion |
a7192ddb SM |
4339 | (vc-diff-internal nil (list vc-annotate-parent-file) |
4340 | prev-rev rev-at-line)) | |
1b5a7343 AS |
4341 | (switch-to-buffer "*vc-diff*")))))) |
4342 | ||
ac3f4c6f ER |
4343 | (defun vc-annotate-warp-revision (revspec) |
4344 | "Annotate the revision described by REVSPEC. | |
1b5a7343 | 4345 | |
ac3f4c6f | 4346 | If REVSPEC is a positive integer, warp that many revisions |
1b5a7343 | 4347 | forward, if possible, otherwise echo a warning message. If |
ac3f4c6f | 4348 | REVSPEC is a negative integer, warp that many revisions backward, |
1b5a7343 AS |
4349 | if possible, otherwise echo a warning message. If REVSPEC is a |
4350 | string, then it describes a revision number, so warp to that | |
4351 | revision." | |
4352 | (if (not (equal major-mode 'vc-annotate-mode)) | |
4353 | (message "Cannot be invoked outside of a vc annotate buffer") | |
da7c8a12 S |
4354 | (let* ((buf (current-buffer)) |
4355 | (oldline (line-number-at-pos)) | |
1b5a7343 AS |
4356 | (revspeccopy revspec) |
4357 | (newrev nil)) | |
4358 | (cond | |
4359 | ((and (integerp revspec) (> revspec 0)) | |
4360 | (setq newrev vc-annotate-parent-rev) | |
4361 | (while (and (> revspec 0) newrev) | |
ac3f4c6f | 4362 | (setq newrev (vc-call next-revision |
1b5a7343 AS |
4363 | vc-annotate-parent-file newrev)) |
4364 | (setq revspec (1- revspec))) | |
4365 | (if (not newrev) | |
ac3f4c6f | 4366 | (message "Cannot increment %d revisions from revision %s" |
1b5a7343 AS |
4367 | revspeccopy vc-annotate-parent-rev))) |
4368 | ((and (integerp revspec) (< revspec 0)) | |
4369 | (setq newrev vc-annotate-parent-rev) | |
4370 | (while (and (< revspec 0) newrev) | |
ac3f4c6f | 4371 | (setq newrev (vc-call previous-revision |
1b5a7343 AS |
4372 | vc-annotate-parent-file newrev)) |
4373 | (setq revspec (1+ revspec))) | |
4374 | (if (not newrev) | |
ac3f4c6f | 4375 | (message "Cannot decrement %d revisions from revision %s" |
1b5a7343 AS |
4376 | (- 0 revspeccopy) vc-annotate-parent-rev))) |
4377 | ((stringp revspec) (setq newrev revspec)) | |
ac3f4c6f | 4378 | (t (error "Invalid argument to vc-annotate-warp-revision"))) |
1b5a7343 | 4379 | (when newrev |
04864eb0 SM |
4380 | (vc-annotate vc-annotate-parent-file newrev |
4381 | vc-annotate-parent-display-mode | |
bae9f9e3 DN |
4382 | buf |
4383 | ;; Pass the current line so that vc-annotate will | |
4384 | ;; place the point in the line. | |
4385 | (min oldline (progn (goto-char (point-max)) | |
4386 | (forward-line -1) | |
4387 | (line-number-at-pos)))))))) | |
1b5a7343 | 4388 | |
f70419a8 | 4389 | (defun vc-annotate-compcar (threshold a-list) |
6f1ecae4 AS |
4390 | "Test successive cons cells of A-LIST against THRESHOLD. |
4391 | Return the first cons cell with a car that is not less than THRESHOLD, | |
4392 | nil if no such cell exists." | |
f70419a8 RS |
4393 | (let ((i 1) |
4394 | (tmp-cons (car a-list))) | |
4395 | (while (and tmp-cons (< (car tmp-cons) threshold)) | |
4396 | (setq tmp-cons (car (nthcdr i a-list))) | |
4397 | (setq i (+ i 1))) | |
4398 | tmp-cons)) ; Return the appropriate value | |
4399 | ||
75665141 | 4400 | (defun vc-annotate-convert-time (time) |
6f1ecae4 AS |
4401 | "Convert a time value to a floating-point number of days. |
4402 | The argument TIME is a list as returned by `current-time' or | |
4403 | `encode-time', only the first two elements of that list are considered." | |
75665141 AS |
4404 | (/ (+ (* (float (car time)) (lsh 1 16)) (cadr time)) 24 3600)) |
4405 | ||
4406 | (defun vc-annotate-difference (&optional offset) | |
6f1ecae4 AS |
4407 | "Return the time span in days to the next annotation. |
4408 | This calls the backend function annotate-time, and returns the | |
4409 | difference in days between the time returned and the current time, | |
4410 | or OFFSET if present." | |
5731a8e0 | 4411 | (let ((next-time (vc-annotate-get-time-set-line-props))) |
75665141 | 4412 | (if next-time |
99cb8c8b | 4413 | (- (or offset |
75665141 AS |
4414 | (vc-call-backend vc-annotate-backend 'annotate-current-time)) |
4415 | next-time)))) | |
4416 | ||
4417 | (defun vc-default-annotate-current-time (backend) | |
4418 | "Return the current time, encoded as fractional days." | |
4419 | (vc-annotate-convert-time (current-time))) | |
99cb8c8b | 4420 | |
07577777 JPW |
4421 | (defvar vc-annotate-offset nil) |
4422 | ||
97461c84 | 4423 | (defun vc-annotate-display (ratio &optional offset) |
6f1ecae4 | 4424 | "Highlight `vc-annotate' output in the current buffer. |
97461c84 | 4425 | RATIO, is the expansion that should be applied to `vc-annotate-color-map'. |
bf142f28 | 4426 | The annotations are relative to the current time, unless overridden by OFFSET." |
97461c84 SM |
4427 | (if (/= ratio 1.0) |
4428 | (set (make-local-variable 'vc-annotate-color-map) | |
4429 | (mapcar (lambda (elem) (cons (* (car elem) ratio) (cdr elem))) | |
4430 | vc-annotate-color-map))) | |
f66a6225 SM |
4431 | (set (make-local-variable 'vc-annotate-offset) offset) |
4432 | (font-lock-mode 1)) | |
4433 | ||
f66a6225 | 4434 | (defun vc-annotate-lines (limit) |
7c33af85 SM |
4435 | (while (< (point) limit) |
4436 | (let ((difference (vc-annotate-difference vc-annotate-offset)) | |
4437 | (start (point)) | |
4438 | (end (progn (forward-line 1) (point)))) | |
4439 | (when difference | |
4440 | (let* ((color (or (vc-annotate-compcar difference vc-annotate-color-map) | |
4441 | (cons nil vc-annotate-very-old-color))) | |
4442 | ;; substring from index 1 to remove any leading `#' in the name | |
4443 | (face-name (concat "vc-annotate-face-" | |
4444 | (if (string-equal | |
4445 | (substring (cdr color) 0 1) "#") | |
4446 | (substring (cdr color) 1) | |
4447 | (cdr color)))) | |
4448 | ;; Make the face if not done. | |
4449 | (face (or (intern-soft face-name) | |
4450 | (let ((tmp-face (make-face (intern face-name)))) | |
4451 | (set-face-foreground tmp-face (cdr color)) | |
4452 | (if vc-annotate-background | |
4453 | (set-face-background tmp-face | |
4454 | vc-annotate-background)) | |
4455 | tmp-face)))) ; Return the face | |
4456 | (put-text-property start end 'face face))))) | |
4457 | ;; Pretend to font-lock there were no matches. | |
4458 | nil) | |
7d2d9482 | 4459 | \f |
594722a8 ER |
4460 | |
4461 | ;; Set up key bindings for use while editing log messages | |
4462 | ||
d7b60083 | 4463 | (defun vc-log-edit (fileset) |
928ef6d9 | 4464 | "Set up `log-edit' for use with VC on FILE." |
099bd78a | 4465 | (setq default-directory |
d7b60083 | 4466 | (with-current-buffer vc-parent-buffer default-directory)) |
93a142e1 DN |
4467 | (log-edit 'vc-finish-logentry |
4468 | nil | |
4469 | `((log-edit-listfun . (lambda () ',fileset)) | |
4470 | (log-edit-diff-function . (lambda () (vc-diff nil))))) | |
d7b60083 | 4471 | (set (make-local-variable 'vc-log-fileset) fileset) |
ac3f4c6f | 4472 | (make-local-variable 'vc-log-revision) |
099bd78a | 4473 | (set-buffer-modified-p nil) |
0e362f54 | 4474 | (setq buffer-file-name nil)) |
594722a8 | 4475 | |
ec402ad4 | 4476 | ;; These things should probably be generally available |
594722a8 | 4477 | |
2f119435 AS |
4478 | (defun vc-file-tree-walk (dirname func &rest args) |
4479 | "Walk recursively through DIRNAME. | |
0e362f54 | 4480 | Invoke FUNC f ARGS on each VC-managed file f underneath it." |
2f119435 AS |
4481 | (vc-file-tree-walk-internal (expand-file-name dirname) func args) |
4482 | (message "Traversing directory %s...done" dirname)) | |
02da6253 PE |
4483 | |
4484 | (defun vc-file-tree-walk-internal (file func args) | |
4485 | (if (not (file-directory-p file)) | |
0e362f54 | 4486 | (if (vc-backend file) (apply func file args)) |
993a1a44 | 4487 | (message "Traversing directory %s..." (abbreviate-file-name file)) |
02da6253 PE |
4488 | (let ((dir (file-name-as-directory file))) |
4489 | (mapcar | |
0e362f54 | 4490 | (lambda (f) (or |
d1a607bc SM |
4491 | (string-equal f ".") |
4492 | (string-equal f "..") | |
4493 | (member f vc-directory-exclusion-list) | |
4494 | (let ((dirf (expand-file-name f dir))) | |
4495 | (or | |
4496 | (file-symlink-p dirf) ;; Avoid possible loops. | |
4497 | (vc-file-tree-walk-internal dirf func args))))) | |
02da6253 | 4498 | (directory-files dir))))) |
594722a8 ER |
4499 | |
4500 | (provide 'vc) | |
4501 | ||
ec402ad4 SM |
4502 | ;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE |
4503 | ;; | |
ec402ad4 SM |
4504 | ;; These may be useful to anyone who has to debug or extend the package. |
4505 | ;; (Note that this information corresponds to versions 5.x. Some of it | |
4506 | ;; might have been invalidated by the additions to support branching | |
4507 | ;; and RCS keyword lookup. AS, 1995/03/24) | |
4508 | ;; | |
4509 | ;; A fundamental problem in VC is that there are time windows between | |
4510 | ;; vc-next-action's computations of the file's version-control state and | |
4511 | ;; the actions that change it. This is a window open to lossage in a | |
4512 | ;; multi-user environment; someone else could nip in and change the state | |
4513 | ;; of the master during it. | |
4514 | ;; | |
4515 | ;; The performance problem is that rlog/prs calls are very expensive; we want | |
4516 | ;; to avoid them as much as possible. | |
4517 | ;; | |
4518 | ;; ANALYSIS: | |
4519 | ;; | |
4520 | ;; The performance problem, it turns out, simplifies in practice to the | |
4521 | ;; problem of making vc-state fast. The two other functions that call | |
4522 | ;; prs/rlog will not be so commonly used that the slowdown is a problem; one | |
4523 | ;; makes snapshots, the other deletes the calling user's last change in the | |
4524 | ;; master. | |
4525 | ;; | |
4526 | ;; The race condition implies that we have to either (a) lock the master | |
4527 | ;; during the entire execution of vc-next-action, or (b) detect and | |
4528 | ;; recover from errors resulting from dispatch on an out-of-date state. | |
4529 | ;; | |
4530 | ;; Alternative (a) appears to be infeasible. The problem is that we can't | |
4531 | ;; guarantee that the lock will ever be removed. Suppose a user starts a | |
4532 | ;; checkin, the change message buffer pops up, and the user, having wandered | |
4533 | ;; off to do something else, simply forgets about it? | |
4534 | ;; | |
4535 | ;; Alternative (b), on the other hand, works well with a cheap way to speed up | |
4536 | ;; vc-state. Usually, if a file is registered, we can read its locked/ | |
4537 | ;; unlocked state and its current owner from its permissions. | |
4538 | ;; | |
4539 | ;; This shortcut will fail if someone has manually changed the workfile's | |
4540 | ;; permissions; also if developers are munging the workfile in several | |
4541 | ;; directories, with symlinks to a master (in this latter case, the | |
4542 | ;; permissions shortcut will fail to detect a lock asserted from another | |
4543 | ;; directory). | |
4544 | ;; | |
4545 | ;; Note that these cases correspond exactly to the errors which could happen | |
4546 | ;; because of a competing checkin/checkout race in between two instances of | |
4547 | ;; vc-next-action. | |
4548 | ;; | |
4549 | ;; For VC's purposes, a workfile/master pair may have the following states: | |
4550 | ;; | |
4551 | ;; A. Unregistered. There is a workfile, there is no master. | |
4552 | ;; | |
4553 | ;; B. Registered and not locked by anyone. | |
4554 | ;; | |
4555 | ;; C. Locked by calling user and unchanged. | |
4556 | ;; | |
4557 | ;; D. Locked by the calling user and changed. | |
4558 | ;; | |
4559 | ;; E. Locked by someone other than the calling user. | |
4560 | ;; | |
4561 | ;; This makes for 25 states and 20 error conditions. Here's the matrix: | |
4562 | ;; | |
4563 | ;; VC's idea of state | |
4564 | ;; | | |
4565 | ;; V Actual state RCS action SCCS action Effect | |
4566 | ;; A B C D E | |
4567 | ;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin | |
4568 | ;; B 5 . 6 7 8 co -l get -e checkout | |
4569 | ;; C 9 10 . 11 12 co -u unget; get revert | |
4570 | ;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin | |
4571 | ;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock | |
4572 | ;; | |
4573 | ;; All commands take the master file name as a last argument (not shown). | |
4574 | ;; | |
4575 | ;; In the discussion below, a "self-race" is a pathological situation in | |
4576 | ;; which VC operations are being attempted simultaneously by two or more | |
4577 | ;; Emacsen running under the same username. | |
4578 | ;; | |
4579 | ;; The vc-next-action code has the following windows: | |
4580 | ;; | |
4581 | ;; Window P: | |
4582 | ;; Between the check for existence of a master file and the call to | |
4583 | ;; admin/checkin in vc-buffer-admin (apparent state A). This window may | |
4584 | ;; never close if the initial-comment feature is on. | |
4585 | ;; | |
4586 | ;; Window Q: | |
4587 | ;; Between the call to vc-workfile-unchanged-p in and the immediately | |
4588 | ;; following revert (apparent state C). | |
4589 | ;; | |
4590 | ;; Window R: | |
4591 | ;; Between the call to vc-workfile-unchanged-p in and the following | |
4592 | ;; checkin (apparent state D). This window may never close. | |
4593 | ;; | |
4594 | ;; Window S: | |
4595 | ;; Between the unlock and the immediately following checkout during a | |
4596 | ;; revert operation (apparent state C). Included in window Q. | |
4597 | ;; | |
4598 | ;; Window T: | |
4599 | ;; Between vc-state and the following checkout (apparent state B). | |
4600 | ;; | |
4601 | ;; Window U: | |
4602 | ;; Between vc-state and the following revert (apparent state C). | |
4603 | ;; Includes windows Q and S. | |
4604 | ;; | |
4605 | ;; Window V: | |
4606 | ;; Between vc-state and the following checkin (apparent state | |
4607 | ;; D). This window may never be closed if the user fails to complete the | |
4608 | ;; checkin message. Includes window R. | |
4609 | ;; | |
4610 | ;; Window W: | |
4611 | ;; Between vc-state and the following steal-lock (apparent | |
4612 | ;; state E). This window may never close if the user fails to complete | |
4613 | ;; the steal-lock message. Includes window X. | |
4614 | ;; | |
4615 | ;; Window X: | |
4616 | ;; Between the unlock and the immediately following re-lock during a | |
4617 | ;; steal-lock operation (apparent state E). This window may never close | |
4618 | ;; if the user fails to complete the steal-lock message. | |
4619 | ;; | |
4620 | ;; Errors: | |
4621 | ;; | |
4622 | ;; Apparent state A --- | |
4623 | ;; | |
4624 | ;; 1. File looked unregistered but is actually registered and not locked. | |
4625 | ;; | |
4626 | ;; Potential cause: someone else's admin during window P, with | |
4627 | ;; caller's admin happening before their checkout. | |
4628 | ;; | |
4629 | ;; RCS: Prior to version 5.6.4, ci fails with message | |
4630 | ;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new | |
4631 | ;; ci -i option and the message is "<file>,v: already exists". | |
4632 | ;; SCCS: admin will fail with error (ad19). | |
4633 | ;; | |
4634 | ;; We can let these errors be passed up to the user. | |
4635 | ;; | |
4636 | ;; 2. File looked unregistered but is actually locked by caller, unchanged. | |
4637 | ;; | |
4638 | ;; Potential cause: self-race during window P. | |
4639 | ;; | |
4640 | ;; RCS: Prior to version 5.6.4, reverts the file to the last saved | |
4641 | ;; version and unlocks it. From 5.6.4 onwards, VC uses the new | |
4642 | ;; ci -i option, failing with message "<file>,v: already exists". | |
4643 | ;; SCCS: will fail with error (ad19). | |
4644 | ;; | |
4645 | ;; Either of these consequences is acceptable. | |
4646 | ;; | |
4647 | ;; 3. File looked unregistered but is actually locked by caller, changed. | |
4648 | ;; | |
4649 | ;; Potential cause: self-race during window P. | |
4650 | ;; | |
4651 | ;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as | |
4652 | ;; a delta with a null change comment (the -t- switch will be | |
4653 | ;; ignored). From 5.6.4 onwards, VC uses the new ci -i option, | |
4654 | ;; failing with message "<file>,v: already exists". | |
4655 | ;; SCCS: will fail with error (ad19). | |
4656 | ;; | |
4657 | ;; 4. File looked unregistered but is locked by someone else. | |
0e362f54 | 4658 | ;;; |
ec402ad4 SM |
4659 | ;; Potential cause: someone else's admin during window P, with |
4660 | ;; caller's admin happening *after* their checkout. | |
4661 | ;; | |
4662 | ;; RCS: Prior to version 5.6.4, ci fails with a | |
4663 | ;; "no lock set by <user>" message. From 5.6.4 onwards, | |
4664 | ;; VC uses the new ci -i option, failing with message | |
4665 | ;; "<file>,v: already exists". | |
4666 | ;; SCCS: will fail with error (ad19). | |
4667 | ;; | |
4668 | ;; We can let these errors be passed up to the user. | |
4669 | ;; | |
4670 | ;; Apparent state B --- | |
4671 | ;; | |
4672 | ;; 5. File looked registered and not locked, but is actually unregistered. | |
4673 | ;; | |
4674 | ;; Potential cause: master file got nuked during window P. | |
4675 | ;; | |
4676 | ;; RCS: will fail with "RCS/<file>: No such file or directory" | |
4677 | ;; SCCS: will fail with error ut4. | |
4678 | ;; | |
4679 | ;; We can let these errors be passed up to the user. | |
4680 | ;; | |
4681 | ;; 6. File looked registered and not locked, but is actually locked by the | |
4682 | ;; calling user and unchanged. | |
4683 | ;; | |
4684 | ;; Potential cause: self-race during window T. | |
4685 | ;; | |
4686 | ;; RCS: in the same directory as the previous workfile, co -l will fail | |
4687 | ;; with "co error: writable foo exists; checkout aborted". In any other | |
4688 | ;; directory, checkout will succeed. | |
4689 | ;; SCCS: will fail with ge17. | |
4690 | ;; | |
4691 | ;; Either of these consequences is acceptable. | |
4692 | ;; | |
4693 | ;; 7. File looked registered and not locked, but is actually locked by the | |
4694 | ;; calling user and changed. | |
4695 | ;; | |
4696 | ;; As case 6. | |
4697 | ;; | |
4698 | ;; 8. File looked registered and not locked, but is actually locked by another | |
4699 | ;; user. | |
4700 | ;; | |
4701 | ;; Potential cause: someone else checks it out during window T. | |
4702 | ;; | |
4703 | ;; RCS: co error: revision 1.3 already locked by <user> | |
4704 | ;; SCCS: fails with ge4 (in directory) or ut7 (outside it). | |
4705 | ;; | |
4706 | ;; We can let these errors be passed up to the user. | |
4707 | ;; | |
4708 | ;; Apparent state C --- | |
4709 | ;; | |
4710 | ;; 9. File looks locked by calling user and unchanged, but is unregistered. | |
4711 | ;; | |
4712 | ;; As case 5. | |
4713 | ;; | |
4714 | ;; 10. File looks locked by calling user and unchanged, but is actually not | |
4715 | ;; locked. | |
4716 | ;; | |
4717 | ;; Potential cause: a self-race in window U, or by the revert's | |
4718 | ;; landing during window X of some other user's steal-lock or window S | |
4719 | ;; of another user's revert. | |
4720 | ;; | |
4721 | ;; RCS: succeeds, refreshing the file from the identical version in | |
4722 | ;; the master. | |
4723 | ;; SCCS: fails with error ut4 (p file nonexistent). | |
4724 | ;; | |
4725 | ;; Either of these consequences is acceptable. | |
4726 | ;; | |
4727 | ;; 11. File is locked by calling user. It looks unchanged, but is actually | |
4728 | ;; changed. | |
4729 | ;; | |
4730 | ;; Potential cause: the file would have to be touched by a self-race | |
4731 | ;; during window Q. | |
4732 | ;; | |
4733 | ;; The revert will succeed, removing whatever changes came with | |
4734 | ;; the touch. It is theoretically possible that work could be lost. | |
4735 | ;; | |
4736 | ;; 12. File looks like it's locked by the calling user and unchanged, but | |
4737 | ;; it's actually locked by someone else. | |
4738 | ;; | |
4739 | ;; Potential cause: a steal-lock in window V. | |
4740 | ;; | |
4741 | ;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u | |
4742 | ;; SCCS: fails with error un2 | |
4743 | ;; | |
4744 | ;; We can pass these errors up to the user. | |
4745 | ;; | |
4746 | ;; Apparent state D --- | |
4747 | ;; | |
4748 | ;; 13. File looks like it's locked by the calling user and changed, but it's | |
4749 | ;; actually unregistered. | |
4750 | ;; | |
4751 | ;; Potential cause: master file got nuked during window P. | |
4752 | ;; | |
4753 | ;; RCS: Prior to version 5.6.4, checks in the user's version as an | |
4754 | ;; initial delta. From 5.6.4 onwards, VC uses the new ci -j | |
4755 | ;; option, failing with message "no such file or directory". | |
4756 | ;; SCCS: will fail with error ut4. | |
4757 | ;; | |
4758 | ;; This case is kind of nasty. Under RCS prior to version 5.6.4, | |
4759 | ;; VC may fail to detect the loss of previous version information. | |
4760 | ;; | |
4761 | ;; 14. File looks like it's locked by the calling user and changed, but it's | |
4762 | ;; actually unlocked. | |
4763 | ;; | |
4764 | ;; Potential cause: self-race in window V, or the checkin happening | |
4765 | ;; during the window X of someone else's steal-lock or window S of | |
4766 | ;; someone else's revert. | |
4767 | ;; | |
4768 | ;; RCS: ci will fail with "no lock set by <user>". | |
4769 | ;; SCCS: delta will fail with error ut4. | |
4770 | ;; | |
4771 | ;; 15. File looks like it's locked by the calling user and changed, but it's | |
4772 | ;; actually locked by the calling user and unchanged. | |
4773 | ;; | |
4774 | ;; Potential cause: another self-race --- a whole checkin/checkout | |
4775 | ;; sequence by the calling user would have to land in window R. | |
4776 | ;; | |
4777 | ;; SCCS: checks in a redundant delta and leaves the file unlocked as usual. | |
4778 | ;; RCS: reverts to the file state as of the second user's checkin, leaving | |
4779 | ;; the file unlocked. | |
4780 | ;; | |
4781 | ;; It is theoretically possible that work could be lost under RCS. | |
4782 | ;; | |
4783 | ;; 16. File looks like it's locked by the calling user and changed, but it's | |
4784 | ;; actually locked by a different user. | |
4785 | ;; | |
4786 | ;; RCS: ci error: no lock set by <user> | |
4787 | ;; SCCS: unget will fail with error un2 | |
4788 | ;; | |
4789 | ;; We can pass these errors up to the user. | |
4790 | ;; | |
4791 | ;; Apparent state E --- | |
4792 | ;; | |
4793 | ;; 17. File looks like it's locked by some other user, but it's actually | |
4794 | ;; unregistered. | |
4795 | ;; | |
4796 | ;; As case 13. | |
4797 | ;; | |
4798 | ;; 18. File looks like it's locked by some other user, but it's actually | |
4799 | ;; unlocked. | |
4800 | ;; | |
4801 | ;; Potential cause: someone released a lock during window W. | |
4802 | ;; | |
4803 | ;; RCS: The calling user will get the lock on the file. | |
4804 | ;; SCCS: unget -n will fail with cm4. | |
4805 | ;; | |
4806 | ;; Either of these consequences will be OK. | |
4807 | ;; | |
4808 | ;; 19. File looks like it's locked by some other user, but it's actually | |
4809 | ;; locked by the calling user and unchanged. | |
4810 | ;; | |
4811 | ;; Potential cause: the other user relinquishing a lock followed by | |
4812 | ;; a self-race, both in window W. | |
4813 | ;; | |
4814 | ;; Under both RCS and SCCS, both unlock and lock will succeed, making | |
4815 | ;; the sequence a no-op. | |
4816 | ;; | |
4817 | ;; 20. File looks like it's locked by some other user, but it's actually | |
4818 | ;; locked by the calling user and changed. | |
4819 | ;; | |
4820 | ;; As case 19. | |
4821 | ;; | |
4822 | ;; PROBLEM CASES: | |
4823 | ;; | |
4824 | ;; In order of decreasing severity: | |
4825 | ;; | |
4826 | ;; Cases 11 and 15 are the only ones that potentially lose work. | |
4827 | ;; They would require a self-race for this to happen. | |
4828 | ;; | |
4829 | ;; Case 13 in RCS loses information about previous deltas, retaining | |
4830 | ;; only the information in the current workfile. This can only happen | |
4831 | ;; if the master file gets nuked in window P. | |
4832 | ;; | |
4833 | ;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with | |
4834 | ;; no change comment in the master. This would require a self-race in | |
4835 | ;; window P or R respectively. | |
4836 | ;; | |
4837 | ;; Cases 2, 10, 19 and 20 do extra work, but make no changes. | |
4838 | ;; | |
4839 | ;; Unfortunately, it appears to me that no recovery is possible in these | |
4840 | ;; cases. They don't yield error messages, so there's no way to tell that | |
4841 | ;; a race condition has occurred. | |
4842 | ;; | |
4843 | ;; All other cases don't change either the workfile or the master, and | |
4844 | ;; trigger command errors which the user will see. | |
4845 | ;; | |
4846 | ;; Thus, there is no explicit recovery code. | |
594722a8 | 4847 | |
0452b6e7 | 4848 | ;; arch-tag: ca82c1de-3091-4e26-af92-460abc6213a6 |
594722a8 | 4849 | ;;; vc.el ends here |