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