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