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