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