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
5 ;; Free Software Foundation, Inc.
7 ;; Author: FSF (see below for full credits)
8 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
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/>.
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.
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 ;; Some features will not work with old RCS versions. Where
62 ;; appropriate, VC finds out which version you have, and allows or
63 ;; disallows those features (stealing locks, for example, works only
64 ;; from 5.6.2 onwards).
65 ;; Even initial checkins will fail if your RCS version is so old that ci
66 ;; doesn't understand -t-; this has been known to happen to people running
69 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
71 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
72 ;; to be installed somewhere on Emacs's path for executables.
74 ;; If your site uses the ChangeLog convention supported by Emacs, the
75 ;; function `log-edit-comment-to-change-log' could prove a useful checkin hook,
76 ;; although you might prefer to use C-c C-a (i.e. `log-edit-insert-changelog')
77 ;; from the commit buffer instead or to set `log-edit-setup-invert'.
79 ;; The vc code maintains some internal state in order to reduce expensive
80 ;; version-control operations to a minimum. Some names are only computed
81 ;; once. If you perform version control operations with the backend while
82 ;; vc's back is turned, or move/rename master files while vc is running,
83 ;; vc may get seriously confused. Don't do these things!
85 ;; Developer's notes on some concurrency issues are included at the end of
88 ;; ADDING SUPPORT FOR OTHER BACKENDS
90 ;; VC can use arbitrary version control systems as a backend. To add
91 ;; support for a new backend named SYS, write a library vc-sys.el that
92 ;; contains functions of the form `vc-sys-...' (note that SYS is in lower
93 ;; case for the function and library names). VC will use that library if
94 ;; you put the symbol SYS somewhere into the list of
95 ;; `vc-handled-backends'. Then, for example, if `vc-sys-registered'
96 ;; returns non-nil for a file, all SYS-specific versions of VC commands
97 ;; will be available for that file.
99 ;; VC keeps some per-file information in the form of properties (see
100 ;; vc-file-set/getprop in vc-hooks.el). The backend-specific functions
101 ;; do not generally need to be aware of these properties. For example,
102 ;; `vc-sys-working-revision' should compute the working revision and
103 ;; return it; it should not look it up in the property, and it needn't
104 ;; store it there either. However, if a backend-specific function does
105 ;; store a value in a property, that value takes precedence over any
106 ;; value that the generic code might want to set (check for uses of
107 ;; the macro `with-vc-properties' in vc.el).
109 ;; In the list of functions below, each identifier needs to be prepended
110 ;; with `vc-sys-'. Some of the functions are mandatory (marked with a
111 ;; `*'), others are optional (`-').
113 ;; BACKEND PROPERTIES
115 ;; * revision-granularity
117 ;; Takes no arguments. Returns either 'file or 'repository. Backends
118 ;; that return 'file have per-file revision numbering; backends
119 ;; that return 'repository have per-repository revision numbering,
120 ;; so a revision level implicitly identifies a changeset
122 ;; STATE-QUERYING FUNCTIONS
124 ;; * registered (file)
126 ;; Return non-nil if FILE is registered in this backend. Both this
127 ;; function as well as `state' should be careful to fail gracefully
128 ;; in the event that the backend executable is absent. It is
129 ;; preferable that this function's body is autoloaded, that way only
130 ;; calling vc-registered does not cause the backend to be loaded
131 ;; (all the vc-FOO-registered functions are called to try to find
132 ;; the controlling backend for FILE.
136 ;; Return the current version control state of FILE. For a list of
137 ;; possible values, see `vc-state'. This function should do a full and
138 ;; reliable state computation; it is usually called immediately after
139 ;; C-x v v. If you want to use a faster heuristic when visiting a
140 ;; file, put that into `state-heuristic' below. Note that under most
141 ;; VCSes this won't be called at all, dir-status is used instead.
143 ;; - state-heuristic (file)
145 ;; If provided, this function is used to estimate the version control
146 ;; state of FILE at visiting time. It should be considerably faster
147 ;; than the implementation of `state'. For a list of possible values,
148 ;; see the doc string of `vc-state'.
150 ;; - dir-status (dir update-function)
152 ;; Produce RESULT: a list of lists of the form (FILE VC-STATE EXTRA)
153 ;; for the files in DIR.
154 ;; EXTRA can be used for backend specific information about FILE.
155 ;; If a command needs to be run to compute this list, it should be
156 ;; run asynchronously using (current-buffer) as the buffer for the
157 ;; command. When RESULT is computed, it should be passed back by
158 ;; doing: (funcall UPDATE-FUNCTION RESULT nil).
159 ;; If the backend uses a process filter, hence it produces partial results,
160 ;; they can be passed back by doing:
161 ;; (funcall UPDATE-FUNCTION RESULT t)
162 ;; and then do a (funcall UPDATE-FUNCTION RESULT nil)
163 ;; when all the results have been computed.
164 ;; To provide more backend specific functionality for `vc-dir'
165 ;; the following functions might be needed: `status-extra-headers',
166 ;; `status-printer', `extra-status-menu' and `dir-status-files'.
168 ;; - dir-status-files (dir files default-state update-function)
170 ;; This function is identical to dir-status except that it should
171 ;; only report status for the specified FILES. Also it needs to
172 ;; report on all requested files, including up-to-date or ignored
173 ;; files. If not provided, the default is to consider that the files
174 ;; are in DEFAULT-STATE.
176 ;; - status-extra-headers (dir)
178 ;; Return a string that will be added to the *vc-dir* buffer header.
180 ;; - status-printer (fileinfo)
182 ;; Pretty print the `vc-dir-fileinfo' FILEINFO.
183 ;; If a backend needs to show more information than the default FILE
184 ;; and STATE in the vc-dir listing, it can store that extra
185 ;; information in `vc-dir-fileinfo->extra'. This function can be
186 ;; used to display that extra information in the *vc-dir* buffer.
188 ;; - status-fileinfo-extra (file)
190 ;; Compute `vc-dir-fileinfo->extra' for FILE.
192 ;; * working-revision (file)
194 ;; Return the working revision of FILE. This is the revision fetched
195 ;; by the last checkout or upate, not necessarily the same thing as the
196 ;; head or tip revision. Should return "0" for a file added but not yet
199 ;; - latest-on-branch-p (file)
201 ;; Return non-nil if the working revision of FILE is the latest revision
202 ;; on its branch (many VCSes call this the 'tip' or 'head' revision).
203 ;; The default implementation always returns t, which means that
204 ;; working with non-current revisions is not supported by default.
206 ;; * checkout-model (files)
208 ;; Indicate whether FILES need to be "checked out" before they can be
209 ;; edited. See `vc-checkout-model' for a list of possible values.
211 ;; - workfile-unchanged-p (file)
213 ;; Return non-nil if FILE is unchanged from the working revision.
214 ;; This function should do a brief comparison of FILE's contents
215 ;; with those of the repository master of the working revision. If
216 ;; the backend does not have such a brief-comparison feature, the
217 ;; default implementation of this function can be used, which
218 ;; delegates to a full vc-BACKEND-diff. (Note that vc-BACKEND-diff
219 ;; must not run asynchronously in this case, see variable
220 ;; `vc-disable-async-diff'.)
222 ;; - mode-line-string (file)
224 ;; If provided, this function should return the VC-specific mode
225 ;; line string for FILE. The returned string should have a
226 ;; `help-echo' property which is the text to be displayed as a
227 ;; tooltip when the mouse hovers over the VC entry on the mode-line.
228 ;; The default implementation deals well with all states that
229 ;; `vc-state' can return.
231 ;; - prettify-state-info (file)
233 ;; Translate the `vc-state' property of FILE into a string that can be
234 ;; used in a human-readable buffer. The default implementation deals well
235 ;; with all states that `vc-state' can return.
237 ;; STATE-CHANGING FUNCTIONS
239 ;; * create-repo (backend)
241 ;; Create an empty repository in the current directory and initialize
242 ;; it so VC mode can add files to it. For file-oriented systems, this
243 ;; need do no more than create a subdirectory with the right name.
245 ;; * register (files &optional rev comment)
247 ;; Register FILES in this backend. Optionally, an initial revision REV
248 ;; and an initial description of the file, COMMENT, may be specified,
249 ;; but it is not guaranteed that the backend will do anything with this.
250 ;; The implementation should pass the value of vc-register-switches
251 ;; to the backend command. (Note: in older versions of VC, this
252 ;; command took a single file argument and not a list.)
254 ;; - init-revision (file)
256 ;; The initial revision to use when registering FILE if one is not
257 ;; specified by the user. If not provided, the variable
258 ;; vc-default-init-revision is used instead.
260 ;; - responsible-p (file)
262 ;; Return non-nil if this backend considers itself "responsible" for
263 ;; FILE, which can also be a directory. This function is used to find
264 ;; out what backend to use for registration of new files and for things
265 ;; like change log generation. The default implementation always
268 ;; - could-register (file)
270 ;; Return non-nil if FILE could be registered under this backend. The
271 ;; default implementation always returns t.
273 ;; - receive-file (file rev)
275 ;; Let this backend "receive" a file that is already registered under
276 ;; another backend. The default implementation simply calls `register'
277 ;; for FILE, but it can be overridden to do something more specific,
278 ;; e.g. keep revision numbers consistent or choose editing modes for
279 ;; FILE that resemble those of the other backend.
281 ;; - unregister (file)
283 ;; Unregister FILE from this backend. This is only needed if this
284 ;; backend may be used as a "more local" backend for temporary editing.
286 ;; * checkin (files rev comment)
288 ;; Commit changes in FILES to this backend. If REV is non-nil, that
289 ;; should become the new revision number (not all backends do
290 ;; anything with it). COMMENT is used as a check-in comment. The
291 ;; implementation should pass the value of vc-checkin-switches to
292 ;; the backend command. (Note: in older versions of VC, this
293 ;; command took a single file argument and not a list.)
295 ;; * find-revision (file rev buffer)
297 ;; Fetch revision REV of file FILE and put it into BUFFER.
298 ;; If REV is the empty string, fetch the head of the trunk.
299 ;; The implementation should pass the value of vc-checkout-switches
300 ;; to the backend command.
302 ;; * checkout (file &optional editable rev)
304 ;; Check out revision REV of FILE into the working area. If EDITABLE
305 ;; is non-nil, FILE should be writable by the user and if locking is
306 ;; used for FILE, a lock should also be set. If REV is non-nil, that
307 ;; is the revision to check out (default is the working revision).
308 ;; If REV is t, that means to check out the head of the current branch;
309 ;; if it is the empty string, check out the head of the trunk.
310 ;; The implementation should pass the value of vc-checkout-switches
311 ;; to the backend command.
313 ;; * revert (file &optional contents-done)
315 ;; Revert FILE back to the working revision. If optional
316 ;; arg CONTENTS-DONE is non-nil, then the contents of FILE have
317 ;; already been reverted from a version backup, and this function
318 ;; only needs to update the status of FILE within the backend.
320 ;; - rollback (files)
322 ;; Remove the tip revision of each of FILES from the repository. If
323 ;; this function is not provided, trying to cancel a revision is
324 ;; caught as an error. (Most backends don't provide it.) (Also
325 ;; note that older versions of this backend command were called
326 ;; 'cancel-version' and took a single file arg, not a list of
329 ;; - merge (file rev1 rev2)
331 ;; Merge the changes between REV1 and REV2 into the current working file.
333 ;; - merge-news (file)
335 ;; Merge recent changes from the current branch into FILE.
337 ;; - steal-lock (file &optional revision)
339 ;; Steal any lock on the working revision of FILE, or on REVISION if
340 ;; that is provided. This function is only needed if locking is
341 ;; used for files under this backend, and if files can indeed be
342 ;; locked by other users.
344 ;; - modify-change-comment (files rev comment)
346 ;; Modify the change comments associated with the files at the
347 ;; given revision. This is optional, many backends do not support it.
349 ;; - mark-resolved (files)
351 ;; Mark conflicts as resolved. Some VC systems need to run a
352 ;; command to mark conflicts as resolved.
356 ;; * print-log (files &optional buffer)
358 ;; Insert the revision log for FILES into BUFFER, or the *vc* buffer
359 ;; if BUFFER is nil. (Note: older versions of this function expected
360 ;; only a single file argument.)
362 ;; - log-view-mode ()
364 ;; Mode to use for the output of print-log. This defaults to
365 ;; `log-view-mode' and is expected to be changed (if at all) to a derived
366 ;; mode of `log-view-mode'.
368 ;; - show-log-entry (revision)
370 ;; If provided, search the log entry for REVISION in the current buffer,
371 ;; and make sure it is displayed in the buffer's window. The default
372 ;; implementation of this function works for RCS-style logs.
374 ;; - comment-history (file)
376 ;; Return a string containing all log entries that were made for FILE.
377 ;; This is used for transferring a file from one backend to another,
378 ;; retaining comment information.
380 ;; - update-changelog (files)
382 ;; Using recent log entries, create ChangeLog entries for FILES, or for
383 ;; all files at or below the default-directory if FILES is nil. The
384 ;; default implementation runs rcs2log, which handles RCS- and
387 ;; * diff (files &optional rev1 rev2 buffer)
389 ;; Insert the diff for FILE into BUFFER, or the *vc-diff* buffer if
390 ;; BUFFER is nil. If REV1 and REV2 are non-nil, report differences
391 ;; from REV1 to REV2. If REV1 is nil, use the working revision (as
392 ;; found in the repository) as the older revision; if REV2 is nil,
393 ;; use the current working-copy contents as the newer revision. This
394 ;; function should pass the value of (vc-switches BACKEND 'diff) to
395 ;; the backend command. It should return a status of either 0 (no
396 ;; differences found), or 1 (either non-empty diff or the diff is
397 ;; run asynchronously).
399 ;; - revision-completion-table (files)
401 ;; Return a completion table for existing revisions of FILES.
402 ;; The default is to not use any completion table.
404 ;; - annotate-command (file buf &optional rev)
406 ;; If this function is provided, it should produce an annotated display
407 ;; of FILE in BUF, relative to revision REV. Annotation means each line
408 ;; of FILE displayed is prefixed with version information associated with
409 ;; its addition (deleted lines leave no history) and that the text of the
410 ;; file is fontified according to age.
412 ;; - annotate-time ()
414 ;; Only required if `annotate-command' is defined for the backend.
415 ;; Return the time of the next line of annotation at or after point,
416 ;; as a floating point fractional number of days. The helper
417 ;; function `vc-annotate-convert-time' may be useful for converting
418 ;; multi-part times as returned by `current-time' and `encode-time'
419 ;; to this format. Return nil if no more lines of annotation appear
420 ;; in the buffer. You can safely assume that point is placed at the
421 ;; beginning of each line, starting at `point-min'. The buffer that
422 ;; point is placed in is the Annotate output, as defined by the
423 ;; relevant backend. This function also affects how much of the line
424 ;; is fontified; where it leaves point is where fontification begins.
426 ;; - annotate-current-time ()
428 ;; Only required if `annotate-command' is defined for the backend,
429 ;; AND you'd like the current time considered to be anything besides
430 ;; (vc-annotate-convert-time (current-time)) -- i.e. the current
431 ;; time with hours, minutes, and seconds included. Probably safe to
432 ;; ignore. Return the current-time, in units of fractional days.
434 ;; - annotate-extract-revision-at-line ()
436 ;; Only required if `annotate-command' is defined for the backend.
437 ;; Invoked from a buffer in vc-annotate-mode, return the revision
438 ;; corresponding to the current line, or nil if there is no revision
439 ;; corresponding to the current line.
443 ;; - create-snapshot (dir name branchp)
445 ;; Take a snapshot of the current state of files under DIR and name it
446 ;; NAME. This should make sure that files are up-to-date before
447 ;; proceeding with the action. DIR can also be a file and if BRANCHP
448 ;; is specified, NAME should be created as a branch and DIR should be
449 ;; checked out under this new branch. The default implementation does
450 ;; not support branches but does a sanity check, a tree traversal and
451 ;; for each file calls `assign-name'.
453 ;; - assign-name (file name)
455 ;; Give name NAME to the working revision of FILE, assuming it is
456 ;; up-to-date. Only used by the default version of `create-snapshot'.
458 ;; - retrieve-snapshot (dir name update)
460 ;; Retrieve a named snapshot of all registered files at or below DIR.
461 ;; If UPDATE is non-nil, then update buffers of any files in the
462 ;; snapshot that are currently visited. The default implementation
463 ;; does a sanity check whether there aren't any uncommitted changes at
464 ;; or below DIR, and then performs a tree walk, using the `checkout'
465 ;; function to retrieve the corresponding revisions.
471 ;; Return DIR's "root" directory, that is, a parent directory of
472 ;; DIR for which the same backend as used for DIR applies. If no
473 ;; such parent exists, this function should return DIR.
475 ;; - make-version-backups-p (file)
477 ;; Return non-nil if unmodified repository revisions of FILE should be
478 ;; backed up locally. If this is done, VC can perform `diff' and
479 ;; `revert' operations itself, without calling the backend system. The
480 ;; default implementation always returns nil.
482 ;; - repository-hostname (dirname)
484 ;; Return the hostname that the backend will have to contact
485 ;; in order to operate on a file in DIRNAME. If the return value
486 ;; is nil, it means that the repository is local.
487 ;; This function is used in `vc-stay-local-p' which backends can use
488 ;; for their convenience.
490 ;; - previous-revision (file rev)
492 ;; Return the revision number that precedes REV for FILE, or nil if no such
495 ;; - next-revision (file rev)
497 ;; Return the revision number that follows REV for FILE, or nil if no such
500 ;; - check-headers ()
502 ;; Return non-nil if the current buffer contains any version headers.
504 ;; - clear-headers ()
506 ;; In the current buffer, reset all version headers to their unexpanded
507 ;; form. This function should be provided if the state-querying code
508 ;; for this backend uses the version headers to determine the state of
509 ;; a file. This function will then be called whenever VC changes the
510 ;; version control state in such a way that the headers would give
511 ;; wrong information.
513 ;; - delete-file (file)
515 ;; Delete FILE and mark it as deleted in the repository. If this
516 ;; function is not provided, the command `vc-delete-file' will
519 ;; - rename-file (old new)
521 ;; Rename file OLD to NEW, both in the working area and in the
522 ;; repository. If this function is not provided, the renaming
523 ;; will be done by (vc-delete-file old) and (vc-register new).
525 ;; - find-file-hook ()
527 ;; Operation called in current buffer when opening a file. This can
528 ;; be used by the backend to setup some local variables it might need.
530 ;; - find-file-not-found-hook ()
532 ;; Operation called in current buffer when opening a non-existing file.
533 ;; By default, this asks the user if she wants to check out the file.
537 ;; Return a menu keymap, the items in the keymap will appear at the
538 ;; end of the Version Control menu. The goal is to allow backends
539 ;; to specify extra menu items that appear in the VC menu. This way
540 ;; you can provide menu entries for functionality that is specific
541 ;; to your backend and which does not map to any of the VC generic
544 ;; - extra-status-menu ()
546 ;; Return a menu keymap, the items in the keymap will appear at the
547 ;; end of the VC Status menu. The goal is to allow backends to
548 ;; specify extra menu items that appear in the VC Status menu. This
549 ;; makes it possible to provide menu entries for functionality that
550 ;; is specific to a backend and which does not map to any of the VC
557 ;; - deal with push/pull operations.
559 ;; - add a mechanism for editing the underlying VCS's list of files
560 ;; to be ignored, when that's possible.
562 ;;;; Primitives that need changing:
564 ;; - vc-update/vc-merge should deal with VC systems that don't
565 ;; update/merge on a file basis, but on a whole repository basis.
566 ;; vc-update and vc-merge assume the arguments are always files,
567 ;; they don't deal with directories. Make sure the *vc-dir* buffer
568 ;; is updated after these operations.
569 ;; At least bzr, git and hg should benefit from this.
571 ;;;; Improved branch and tag handling:
573 ;; - "snapshots" should be renamed to "tags", and thoroughly reworked.
575 ;; - add a generic mechanism for remembering the current branch names,
576 ;; display the branch name in the mode-line. Replace
577 ;; vc-cvs-sticky-tag with that.
579 ;; - C-x v b does switch to a different backend, but the mode line is not
580 ;; adapted accordingly. Also, it considers RCS and CVS to be the same,
581 ;; which is pretty confusing.
583 ;; - vc-create-snapshot and vc-retrieve-snapshot should update the
584 ;; buffers that might be visiting the affected files.
586 ;;;; Default Behavior:
588 ;; - do not default to RCS anymore when the current directory is not
589 ;; controlled by any VCS and the user does C-x v v
591 ;; - vc-responsible-backend should not return RCS if no backend
592 ;; declares itself responsible.
594 ;;;; Internal cleanups:
596 ;; - backends that care about vc-stay-local should try to take it into
597 ;; account for vc-dir. Is this likely to be useful???
599 ;; - vc-expand-dirs should take a backend parameter and only look for
600 ;; files managed by that backend.
602 ;; - Another important thing: merge all the status-like backend operations.
603 ;; We should remove dir-status, state, and dir-status-files, and
604 ;; replace them with just `status' which takes a fileset and a continuation
605 ;; (like dir-status) and returns a buffer in which the process(es) are run
606 ;; (or nil if it worked synchronously). Hopefully we can define the old
607 ;; 4 operations in term of this one.
611 ;; - when a file is in `conflict' state, turn on smerge-mode.
613 ;; - figure out what to do with conflicts that are not caused by the
614 ;; file contents, but by metadata or other causes. Example: File A
615 ;; gets renamed to B in one branch and to C in another and you merge
616 ;; the two branches. Or you locally add file FOO and then pull a
617 ;; change that also adds a new file FOO, ...
619 ;; - vc-diff should be able to show the diff for all files in a
620 ;; changeset, especially for VC systems that have per repository
621 ;; version numbers. log-view should take advantage of this.
623 ;; - make it easier to write logs. Maybe C-x 4 a should add to the log
624 ;; buffer, if one is present, instead of adding to the ChangeLog.
626 ;; - When vc-next-action calls vc-checkin it could pre-fill the
627 ;; *VC-log* buffer with some obvious items: the list of files that
628 ;; were added, the list of files that were removed. If the diff is
629 ;; available, maybe it could even call something like
630 ;; `diff-add-change-log-entries-other-window' to create a detailed
631 ;; skeleton for the log...
633 ;; - most vc-dir backends need more work. They might need to
634 ;; provide custom headers, use the `extra' field and deal with all
635 ;; possible VC states.
637 ;; - add a function that calls vc-dir to `find-directory-functions'.
639 ;; - vc-diff, vc-annotate, etc. need to deal better with unregistered
640 ;; files. Now that unregistered and ignored files are shown in
641 ;; vc-dir, it is possible that these commands are called
642 ;; for unregistered/ignored files.
644 ;; - Using multiple backends needs work. Given a CVS directory with some
645 ;; files checked into git (but not all), using C-x v l to get a log file
646 ;; from a file only present in git, and then typing RET on some log entry,
647 ;; vc will bombs out because it wants to see the file being in CVS.
648 ;; Those logs should likely use a local variable to hardware the VC they
649 ;; are supposed to work with.
655 (require 'vc-dispatcher
)
662 (unless (assoc 'vc-parent-buffer minor-mode-alist
)
663 (setq minor-mode-alist
664 (cons '(vc-parent-buffer vc-parent-buffer-name
)
667 ;; General customization
670 "Version-control system in Emacs."
673 (defcustom vc-initial-comment nil
674 "If non-nil, prompt for initial comment when a file is registered."
678 (defcustom vc-default-init-revision
"1.1"
679 "A string used as the default revision number when a new file is registered.
680 This can be overridden by giving a prefix argument to \\[vc-register]. This
681 can also be overridden by a particular VC backend."
686 (defcustom vc-checkin-switches nil
687 "A string or list of strings specifying extra switches for checkin.
688 These are passed to the checkin program by \\[vc-checkin]."
689 :type
'(choice (const :tag
"None" nil
)
690 (string :tag
"Argument String")
691 (repeat :tag
"Argument List"
696 (defcustom vc-checkout-switches nil
697 "A string or list of strings specifying extra switches for checkout.
698 These are passed to the checkout program by \\[vc-checkout]."
699 :type
'(choice (const :tag
"None" nil
)
700 (string :tag
"Argument String")
701 (repeat :tag
"Argument List"
706 (defcustom vc-register-switches nil
707 "A string or list of strings; extra switches for registering a file.
708 These are passed to the checkin program by \\[vc-register]."
709 :type
'(choice (const :tag
"None" nil
)
710 (string :tag
"Argument String")
711 (repeat :tag
"Argument List"
716 (defcustom vc-diff-switches nil
717 "A string or list of strings specifying switches for diff under VC.
718 When running diff under a given BACKEND, VC concatenates the values of
719 `diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to
720 get the switches for that command. Thus, `vc-diff-switches' should
721 contain switches that are specific to version control, but not
722 specific to any particular backend."
723 :type
'(choice (const :tag
"None" nil
)
724 (string :tag
"Argument String")
725 (repeat :tag
"Argument List"
731 (defcustom vc-diff-knows-L nil
732 "*Indicates whether diff understands the -L option.
733 The value is either `yes', `no', or nil. If it is nil, VC tries
734 to use -L and sets this variable to remember whether it worked."
735 :type
'(choice (const :tag
"Work out" nil
) (const yes
) (const no
))
738 (defcustom vc-allow-async-revert nil
739 "Specifies whether the diff during \\[vc-revert] may be asynchronous.
740 Enabling this option means that you can confirm a revert operation even
741 if the local changes in the file have not been found and displayed yet."
742 :type
'(choice (const :tag
"No" nil
)
743 (const :tag
"Yes" t
))
748 (defcustom vc-checkout-hook nil
749 "Normal hook (list of functions) run after checking out a file.
755 (defcustom vc-annotate-display-mode
'fullscale
756 "Which mode to color the output of \\[vc-annotate] with by default."
757 :type
'(choice (const :tag
"By Color Map Range" nil
)
758 (const :tag
"Scale to Oldest" scale
)
759 (const :tag
"Scale Oldest->Newest" fullscale
)
760 (number :tag
"Specify Fractional Number of Days"
765 (defcustom vc-checkin-hook nil
766 "Normal hook (list of functions) run after commit or file checkin.
767 See also `log-edit-done-hook'."
769 :options
'(log-edit-comment-to-change-log)
773 (defcustom vc-before-checkin-hook nil
774 "Normal hook (list of functions) run before a commit or a file checkin.
779 ;; Annotate customization
780 (defcustom vc-annotate-color-map
781 (if (and (tty-display-color-p) (<= (display-color-cells) 8))
782 ;; A custom sorted TTY colormap
788 (string-equal (car x
) "white")
789 (string-equal (car x
) "black") ))
794 ((or (string-equal a
"red") (string-equal b
"blue")) t
)
795 ((or (string-equal b
"red") (string-equal a
"blue")) nil
)
796 ((string-equal a
"yellow") t
)
797 ((string-equal b
"yellow") nil
)
798 ((string-equal a
"cyan") t
)
799 ((string-equal b
"cyan") nil
)
800 ((string-equal a
"green") t
)
801 ((string-equal b
"green") nil
)
802 ((string-equal a
"magenta") t
)
803 ((string-equal b
"magenta") nil
)
804 (t (string< a b
))))))
806 (delta (/ (- 360. date
) (1- (length colors
)))))
810 (setq date
(+ date delta
)))) colors
))
811 ;; Normal colormap: hue stepped from 0-240deg, value=1., saturation=0.75
830 "Association list of age versus color, for \\[vc-annotate].
831 Ages are given in units of fractional days. Default is eighteen
832 steps using a twenty day increment, from red to blue. For TTY
833 displays with 8 or fewer colors, the default is red to blue with
834 all other colors between (excluding black and white)."
838 (defcustom vc-annotate-very-old-color
"#3F3FFF"
839 "Color for lines older than the current color range in \\[vc-annotate]]."
843 (defcustom vc-annotate-background
"black"
844 "Background color for \\[vc-annotate].
845 Default color is used if nil."
846 :type
'(choice (const :tag
"Default background" nil
) (color))
849 (defcustom vc-annotate-menu-elements
'(2 0.5 0.1 0.01)
850 "Menu elements for the mode-specific menu of VC-Annotate mode.
851 List of factors, used to expand/compress the time scale. See `vc-annotate'."
852 :type
'(repeat number
)
855 (defvar vc-annotate-mode-map
856 (let ((m (make-sparse-keymap)))
857 (define-key m
"A" 'vc-annotate-revision-previous-to-line
)
858 (define-key m
"D" 'vc-annotate-show-diff-revision-at-line
)
859 (define-key m
"f" 'vc-annotate-find-revision-at-line
)
860 (define-key m
"J" 'vc-annotate-revision-at-line
)
861 (define-key m
"L" 'vc-annotate-show-log-revision-at-line
)
862 (define-key m
"N" 'vc-annotate-next-revision
)
863 (define-key m
"P" 'vc-annotate-prev-revision
)
864 (define-key m
"W" 'vc-annotate-working-revision
)
865 (define-key m
"V" 'vc-annotate-toggle-annotation-visibility
)
867 "Local keymap used for VC-Annotate mode.")
869 ;; Header-insertion hair
871 (defcustom vc-static-header-alist
873 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
874 "*Associate static header string templates with file types.
875 A \%s in the template is replaced with the first string associated with
876 the file's version control type in `vc-header-alist'."
877 :type
'(repeat (cons :format
"%v"
878 (regexp :tag
"File Type")
879 (string :tag
"Header String")))
882 (defcustom vc-comment-alist
883 '((nroff-mode ".\\\"" ""))
884 "*Special comment delimiters for generating VC headers.
885 Add an entry in this list if you need to override the normal `comment-start'
886 and `comment-end' variables. This will only be necessary if the mode language
887 is sensitive to blank lines."
888 :type
'(repeat (list :format
"%v"
890 (string :tag
"Comment Start")
891 (string :tag
"Comment End")))
894 (defcustom vc-checkout-carefully
(= (user-uid) 0)
895 "*Non-nil means be extra-careful in checkout.
896 Verify that the file really is not locked
897 and that its contents match what the master file says."
900 (make-obsolete-variable 'vc-checkout-carefully
901 "the corresponding checks are always done now."
905 ;; Variables users don't need to see
907 (defvar vc-disable-async-diff nil
908 "VC sets this to t locally to disable some async diff operations.
909 Backends that offer asynchronous diffs should respect this variable
910 in their implementation of vc-BACKEND-diff.")
912 ;; File property caching
914 (defun vc-clear-context ()
915 "Clear all cached file properties."
917 (fillarray vc-file-prop-obarray
0))
919 (defmacro with-vc-properties
(files form settings
)
920 "Execute FORM, then maybe set per-file properties for FILES.
921 SETTINGS is an association list of property/value pairs. After
922 executing FORM, set those properties from SETTINGS that have not yet
923 been updated to their corresponding values."
925 `(let ((vc-touched-properties (list t
)))
927 (dolist (file ,files
)
928 (dolist (setting ,settings
)
929 (let ((property (car setting
)))
930 (unless (memq property vc-touched-properties
)
931 (put (intern file vc-file-prop-obarray
)
932 property
(cdr setting
))))))))
934 ;;; Code for deducing what fileset and backend to assume
936 (defun vc-responsible-backend (file &optional register
)
937 "Return the name of a backend system that is responsible for FILE.
938 The optional argument REGISTER means that a backend suitable for
939 registration should be found.
941 If REGISTER is nil, then if FILE is already registered, return the
942 backend of FILE. If FILE is not registered, or a directory, then the
943 first backend in `vc-handled-backends' that declares itself
944 responsible for FILE is returned. If no backend declares itself
945 responsible, return the first backend.
947 If REGISTER is non-nil, return the first responsible backend under
948 which FILE is not yet registered. If there is no such backend, return
949 the first backend under which FILE is not yet registered, but could
951 (when (not vc-handled-backends
)
952 (error "No handled backends"))
953 (or (and (not (file-directory-p file
)) (not register
) (vc-backend file
))
955 ;; First try: find a responsible backend. If this is for registration,
956 ;; it must be a backend under which FILE is not yet registered.
957 (dolist (backend vc-handled-backends
)
958 (and (or (not register
)
959 (not (vc-call-backend backend
'registered file
)))
960 (vc-call-backend backend
'responsible-p file
)
961 (throw 'found backend
)))
962 ;; no responsible backend
964 ;; if this is not for registration, the first backend must do
965 (car vc-handled-backends
)
966 ;; for registration, we need to find a new backend that
967 ;; could register FILE
968 (dolist (backend vc-handled-backends
)
969 (and (not (vc-call-backend backend
'registered file
))
970 (vc-call-backend backend
'could-register file
)
971 (throw 'found backend
)))
972 (error "No backend that could register")))))
974 (defun vc-expand-dirs (file-or-dir-list)
975 "Expands directories in a file list specification.
976 Within directories, only files already under version control are noticed."
977 (let ((flattened '()))
978 (dolist (node file-or-dir-list
)
979 (if (file-directory-p node
)
981 node
(lambda (f) (when (vc-backend f
) (push f flattened
)))))
982 (push node flattened
))
983 (nreverse flattened
)))
985 (defun vc-derived-from-dir-mode (&optional buffer
)
986 "Are we in a VC-directory buffer, or do we have one as an ancestor?"
987 (let ((buffer (or buffer
(current-buffer))))
988 (cond ((derived-mode-p 'vc-dir-mode
) t
)
989 (vc-parent-buffer (vc-derived-from-dir-mode vc-parent-buffer
))
992 (defun vc-deduce-fileset (&optional observer
)
993 "Deduce a set of files and a backend to which to apply an operation and
994 the common state of the fileset. Return (BACKEND . FILESET)."
995 (let* ((selection (vc-dispatcher-selection-set observer
))
996 (raw (car selection
)) ;; Selection as user made it
997 (cooked (cdr selection
)) ;; Files only
998 ;; FIXME: Store the backend in a buffer-local variable.
999 (backend (if (vc-derived-from-dir-mode (current-buffer))
1000 (vc-responsible-backend default-directory
)
1001 (assert (and (= 1 (length raw
))
1002 (not (file-directory-p (car raw
)))))
1003 (vc-backend (car cooked
)))))
1004 (cons backend selection
)))
1006 (defun vc-ensure-vc-buffer ()
1007 "Make sure that the current buffer visits a version-controlled file."
1009 ((vc-dispatcher-browsing)
1010 (set-buffer (find-file-noselect (vc-dir-current-file))))
1012 (while (and vc-parent-buffer
1013 (buffer-live-p vc-parent-buffer
)
1014 ;; Avoid infinite looping when vc-parent-buffer and
1015 ;; current buffer are the same buffer.
1016 (not (eq vc-parent-buffer
(current-buffer))))
1017 (set-buffer vc-parent-buffer
))
1018 (if (not buffer-file-name
)
1019 (error "Buffer %s is not associated with a file" (buffer-name))
1020 (unless (vc-backend buffer-file-name
)
1021 (error "File %s is not under version control" buffer-file-name
))))))
1023 ;;; Support for the C-x v v command.
1024 ;; This is where all the single-file-oriented code from before the fileset
1027 (defsubst vc-editable-p
(file)
1028 "Return non-nil if FILE can be edited."
1029 (let ((backend (vc-backend file
)))
1031 (or (eq (vc-checkout-model backend
(list file
)) 'implicit
)
1032 (memq (vc-state file
) '(edited needs-merge conflict
))))))
1034 (defun vc-compatible-state (p q
)
1035 "Controls which states can be in the same commit."
1038 (and (member p
'(edited added removed
)) (member q
'(edited added removed
)))))
1040 ;; Here's the major entry point.
1043 (defun vc-next-action (verbose)
1044 "Do the next logical version control operation on the current fileset.
1045 This requires that all files in the fileset be in the same state.
1047 For locking systems:
1048 If every file is not already registered, this registers each for version
1050 If every file is registered and not locked by anyone, this checks out
1051 a writable and locked file of each ready for editing.
1052 If every file is checked out and locked by the calling user, this
1053 first checks to see if each file has changed since checkout. If not,
1054 it performs a revert on that file.
1055 If every file has been changed, this pops up a buffer for entry
1056 of a log message; when the message has been entered, it checks in the
1057 resulting changes along with the log message as change commentary. If
1058 the variable `vc-keep-workfiles' is non-nil (which is its default), a
1059 read-only copy of each changed file is left in place afterwards.
1060 If the affected file is registered and locked by someone else, you are
1061 given the option to steal the lock(s).
1063 For merging systems:
1064 If every file is not already registered, this registers each one for version
1065 control. This does an add, but not a commit.
1066 If every file is added but not committed, each one is committed.
1067 If every working file is changed, but the corresponding repository file is
1068 unchanged, this pops up a buffer for entry of a log message; when the
1069 message has been entered, it checks in the resulting changes along
1070 with the logmessage as change commentary. A writable file is retained.
1071 If the repository file is changed, you are asked if you want to
1072 merge in the changes into your working copy."
1074 (let* ((vc-fileset (vc-deduce-fileset))
1075 (backend (car vc-fileset
))
1076 (files (cadr vc-fileset
))
1077 (fileset-only-files (cddr vc-fileset
))
1078 ;; FIXME: We used to call `vc-recompute-state' here.
1079 (state (vc-state (car fileset-only-files
)))
1080 ;; The backend should check that the checkout-model is consistent
1081 ;; among all the `files'.
1082 (model (vc-checkout-model backend files
))
1085 ;; Check that all files are in a consistent state, since we use that
1086 ;; state to decide which operation to perform.
1087 (dolist (file (cdr fileset-only-files
))
1088 (unless (vc-compatible-state (vc-state file
) state
)
1089 (error "%s:%s clashes with %s:%s"
1090 file
(vc-state file
) (car fileset-only-files
) state
)))
1092 ;; Do the right thing
1094 ((eq state
'missing
)
1095 (error "Fileset files are missing, so cannot be operated on."))
1096 ((eq state
'ignored
)
1097 (error "Fileset files are ignored by the version-control system."))
1098 ((eq state
'unregistered
)
1099 (mapc (lambda (arg) (vc-register nil arg
)) files
))
1100 ;; Files are up-to-date, or need a merge and user specified a revision
1101 ((or (eq state
'up-to-date
) (and verbose
(eq state
'needs-update
)))
1104 ;; go to a different revision
1105 (setq revision
(read-string "Branch, revision, or backend to move to: "))
1106 (let ((vsym (intern-soft (upcase revision
))))
1107 (if (member vsym vc-handled-backends
)
1108 (dolist (file files
) (vc-transfer-file file vsym
))
1109 (dolist (file files
)
1110 (vc-checkout file
(eq model
'implicit
) revision
)))))
1111 ((not (eq model
'implicit
))
1112 ;; check the files out
1113 (dolist (file files
) (vc-checkout file t
)))
1116 (message "Fileset is up-to-date"))))
1117 ;; Files have local changes
1118 ((vc-compatible-state state
'edited
)
1119 (let ((ready-for-commit files
))
1120 ;; If files are edited but read-only, give user a chance to correct
1121 (dolist (file files
)
1122 (unless (file-writable-p file
)
1123 ;; Make the file+buffer read-write.
1124 (unless (y-or-n-p (format "%s is edited but read-only; make it writable and continue?" file
))
1126 (set-file-modes file
(logior (file-modes file
) 128))
1127 (let ((visited (get-file-buffer file
)))
1129 (with-current-buffer visited
1130 (toggle-read-only -
1))))))
1131 ;; Allow user to revert files with no changes
1133 (dolist (file files
)
1134 (let ((visited (get-file-buffer file
)))
1135 ;; For files with locking, if the file does not contain
1136 ;; any changes, just let go of the lock, i.e. revert.
1137 (when (and (not (eq model
'implicit
))
1138 (vc-workfile-unchanged-p file
)
1139 ;; If buffer is modified, that means the user just
1140 ;; said no to saving it; in that case, don't revert,
1141 ;; because the user might intend to save after
1142 ;; finishing the log entry and committing.
1143 (not (and visited
(buffer-modified-p))))
1144 (vc-revert-file file
)
1145 (delete file ready-for-commit
)))))
1146 ;; Remaining files need to be committed
1147 (if (not ready-for-commit
)
1148 (message "No files remain to be committed")
1150 (vc-checkin ready-for-commit
)
1152 (setq revision
(read-string "New revision or backend: "))
1153 (let ((vsym (intern (upcase revision
))))
1154 (if (member vsym vc-handled-backends
)
1155 (dolist (file files
) (vc-transfer-file file vsym
))
1156 (vc-checkin ready-for-commit revision
))))))))
1157 ;; locked by somebody else (locking VCSes only)
1159 ;; In the old days, we computed the revision once and used it on
1160 ;; the single file. Then, for the 2007-2008 fileset rewrite, we
1161 ;; computed the revision once (incorrectly, using a free var) and
1162 ;; used it on all files. To fix the free var bug, we can either
1163 ;; use `(car files)' or do what we do here: distribute the
1164 ;; revision computation among `files'. Although this may be
1165 ;; tedious for those backends where a "revision" is a trans-file
1166 ;; concept, it is nonetheless correct for both those and (more
1167 ;; importantly) for those where "revision" is a per-file concept.
1168 ;; If the intersection of the former group and "locking VCSes" is
1169 ;; non-empty [I vaguely doubt it --ttn], we can reinstate the
1170 ;; pre-computation approach of yore.
1171 (dolist (file files
)
1174 (read-string (format "%s revision to steal: " file
))
1175 (vc-working-revision file
))
1178 ((eq state
'conflict
)
1179 ;; FIXME: Is it really the UI we want to provide?
1180 ;; In my experience, the conflicted files should be marked as resolved
1181 ;; one-by-one when saving the file after resolving the conflicts.
1182 ;; I.e. stating explicitly that the conflicts are resolved is done
1184 (vc-mark-resolved backend files
))
1186 ((eq state
'needs-update
)
1187 (dolist (file files
)
1188 (if (yes-or-no-p (format
1189 "%s is not up-to-date. Get latest revision? "
1190 (file-name-nondirectory file
)))
1191 (vc-checkout file
(eq model
'implicit
) t
)
1192 (when (and (not (eq model
'implicit
))
1193 (yes-or-no-p "Lock this revision? "))
1194 (vc-checkout file t
)))))
1196 ((eq state
'needs-merge
)
1197 (dolist (file files
)
1198 (when (yes-or-no-p (format
1199 "%s is not up-to-date. Merge in changes now? "
1200 (file-name-nondirectory file
)))
1201 (vc-maybe-resolve-conflicts
1202 file
(vc-call-backend backend
'merge-news file
)))))
1205 ((eq state
'unlocked-changes
)
1206 (dolist (file files
)
1207 (when (not (equal buffer-file-name file
))
1208 (find-file-other-window file
))
1209 (if (save-window-excursion
1210 (vc-diff-internal nil
1211 (cons (car vc-fileset
) (cons (cadr vc-fileset
) (list file
)))
1212 (vc-working-revision file
) nil
)
1213 (goto-char (point-min))
1214 (let ((inhibit-read-only t
))
1216 (format "Changes to %s since last lock:\n\n" file
)))
1218 (yes-or-no-p (concat "File has unlocked changes. "
1219 "Claim lock retaining changes? ")))
1220 (progn (vc-call-backend backend
'steal-lock file
)
1221 (clear-visited-file-modtime)
1222 ;; Must clear any headers here because they wouldn't
1223 ;; show that the file is locked now.
1224 (vc-clear-headers file
)
1225 (write-file buffer-file-name
)
1226 (vc-mode-line file
))
1227 (if (not (yes-or-no-p
1228 "Revert to checked-in revision, instead? "))
1229 (error "Checkout aborted")
1230 (vc-revert-buffer-internal t t
)
1231 (vc-checkout file t
)))))
1232 ;; Unknown fileset state
1234 (error "Fileset is in an unknown state %s" state
)))))
1236 (defun vc-create-repo (backend)
1237 "Create an empty repository in the current directory."
1243 "Create repository for: "
1244 (mapcar (lambda (b) (list (downcase (symbol-name b
)))) vc-handled-backends
)
1246 (vc-call-backend backend
'create-repo
))
1249 (defun vc-register (&optional set-revision fname comment
)
1250 "Register into a version control system.
1251 If FNAME is given register that file, otherwise register the current file.
1252 With prefix argument SET-REVISION, allow user to specify initial revision
1253 level. If COMMENT is present, use that as an initial comment.
1255 The version control system to use is found by cycling through the list
1256 `vc-handled-backends'. The first backend in that list which declares
1257 itself responsible for the file (usually because other files in that
1258 directory are already registered under that backend) will be used to
1259 register the file. If no backend declares itself responsible, the
1260 first backend that could register the file is used."
1262 (when (and (null fname
) (null buffer-file-name
)) (error "No visited file"))
1264 (let ((bname (if fname
(get-file-buffer fname
) (current-buffer))))
1265 (unless fname
(setq fname buffer-file-name
))
1266 (when (vc-backend fname
)
1267 (if (vc-registered fname
)
1268 (error "This file is already registered")
1269 (unless (y-or-n-p "Previous master file has vanished. Make a new one? ")
1270 (error "Aborted"))))
1271 ;; Watch out for new buffers of size 0: the corresponding file
1272 ;; does not exist yet, even though buffer-modified-p is nil.
1274 (with-current-buffer bname
1275 (when (and (not (buffer-modified-p))
1276 (zerop (buffer-size))
1277 (not (file-exists-p buffer-file-name
)))
1278 (set-buffer-modified-p t
))
1280 (vc-start-logentry (list fname
)
1282 (read-string (format "Initial revision level for %s: "
1284 (vc-call-backend (vc-responsible-backend fname
)
1286 (or comment
(not vc-initial-comment
))
1288 "Enter initial comment."
1289 (lambda (files rev comment
)
1290 (dolist (file files
)
1291 (message "Registering %s... " file
)
1292 (let ((backend (vc-responsible-backend file t
)))
1293 (vc-file-clearprops file
)
1294 (vc-call-backend backend
'register
(list file
) rev comment
)
1295 (vc-file-setprop file
'vc-backend backend
)
1296 (unless vc-make-backup-files
1297 (make-local-variable 'backup-inhibited
)
1298 (setq backup-inhibited t
)))
1299 (message "Registering %s... done" file
))))))
1301 (defun vc-register-with (backend)
1302 "Register the current file with a specified back end."
1303 (interactive "SBackend: ")
1304 (when (not (member backend vc-handled-backends
))
1305 (error "Unknown back end."))
1306 (let ((vc-handled-backends (list backend
)))
1307 (call-interactively 'vc-register
)))
1309 (defun vc-checkout (file &optional writable rev
)
1310 "Retrieve a copy of the revision REV of FILE.
1311 If WRITABLE is non-nil, make sure the retrieved file is writable.
1312 REV defaults to the latest revision.
1314 After check-out, runs the normal hook `vc-checkout-hook'."
1317 (vc-call make-version-backups-p file
)
1318 (vc-up-to-date-p file
)
1319 (vc-make-version-backup file
))
1320 (let ((backend (vc-backend file
)))
1321 (with-vc-properties (list file
)
1323 (vc-call-backend backend
'checkout file writable rev
)
1325 ;; Maybe the backend is not installed ;-(
1327 (let ((buf (get-file-buffer file
)))
1328 (when buf
(with-current-buffer buf
(toggle-read-only -
1)))))
1329 (signal (car err
) (cdr err
))))
1330 `((vc-state .
,(if (or (eq (vc-checkout-model backend
(list file
)) 'implicit
)
1332 (if (vc-call-backend backend
'latest-on-branch-p file
)
1336 (vc-checkout-time .
,(nth 5 (file-attributes file
))))))
1337 (vc-resynch-buffer file t t
)
1338 (run-hooks 'vc-checkout-hook
))
1340 (defun vc-mark-resolved (backend files
)
1343 (vc-call-backend backend
'mark-resolved files
)
1344 ;; XXX: Is this TRTD? Might not be.
1345 `((vc-state . edited
))))
1347 (defun vc-steal-lock (file rev owner
)
1348 "Steal the lock on FILE."
1349 (let (file-description)
1351 (setq file-description
(format "%s:%s" file rev
))
1352 (setq file-description file
))
1353 (when (not (yes-or-no-p (format "Steal the lock on %s from %s? "
1354 file-description owner
)))
1355 (error "Steal canceled"))
1356 (message "Stealing lock on %s..." file
)
1359 (vc-call steal-lock file rev
)
1360 `((vc-state . edited
)))
1361 (vc-resynch-buffer file t t
)
1362 (message "Stealing lock on %s...done" file
)
1363 ;; Write mail after actually stealing, because if the stealing
1364 ;; goes wrong, we don't want to send any mail.
1365 (compose-mail owner
(format "Stolen lock on %s" file-description
))
1366 (setq default-directory
(expand-file-name "~/"))
1367 (goto-char (point-max))
1369 (format "I stole the lock on %s, " file-description
)
1370 (current-time-string)
1372 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
1374 (defun vc-checkin (files &optional rev comment initial-contents
)
1376 The optional argument REV may be a string specifying the new revision
1377 level (if nil increment the current level). COMMENT is a comment
1378 string; if omitted, a buffer is popped up to accept a comment. If
1379 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents
1380 of the log entry buffer.
1382 If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided
1383 that the version control system supports this mode of operation.
1385 Runs the normal hooks `vc-before-checkin-hook' and `vc-checkin-hook'."
1386 (when vc-before-checkin-hook
1387 (run-hooks 'vc-before-checkin-hook
))
1389 files rev comment initial-contents
1390 "Enter a change comment."
1391 (lambda (files rev comment
)
1392 (message "Checking in %s..." (vc-delistify files
))
1393 ;; "This log message intentionally left almost blank".
1394 ;; RCS 5.7 gripes about white-space-only comments too.
1395 (or (and comment
(string-match "[^\t\n ]" comment
))
1396 (setq comment
"*** empty log message ***"))
1399 ;; We used to change buffers to get local value of vc-checkin-switches,
1400 ;; but 'the' local buffer is not a well-defined concept for filesets.
1402 (vc-call checkin files rev comment
)
1403 (mapc 'vc-delete-automatic-version-backups files
))
1404 `((vc-state . up-to-date
)
1405 (vc-checkout-time .
,(nth 5 (file-attributes file
)))
1406 (vc-working-revision . nil
)))
1407 (message "Checking in %s...done" (vc-delistify files
)))
1410 ;;; Additional entry points for examining version histories
1412 ;; (defun vc-default-diff-tree (backend dir rev1 rev2)
1413 ;; "List differences for all registered files at and below DIR.
1414 ;; The meaning of REV1 and REV2 is the same as for `vc-revision-diff'."
1415 ;; ;; This implementation does an explicit tree walk, and calls
1416 ;; ;; vc-BACKEND-diff directly for each file. An optimization
1417 ;; ;; would be to use `vc-diff-internal', so that diffs can be local,
1418 ;; ;; and to call it only for files that are actually changed.
1419 ;; ;; However, this is expensive for some backends, and so it is left
1420 ;; ;; to backend-specific implementations.
1421 ;; (setq default-directory dir)
1422 ;; (vc-file-tree-walk
1423 ;; default-directory
1426 ;; `(let ((coding-system-for-read (vc-coding-system-for-diff ',f)))
1427 ;; (message "Looking at %s" ',f)
1428 ;; (vc-call-backend ',(vc-backend f)
1429 ;; 'diff (list ',f) ',rev1 ',rev2))))))
1431 (defun vc-coding-system-for-diff (file)
1432 "Return the coding system for reading diff output for FILE."
1433 (or coding-system-for-read
1434 ;; if we already have this file open,
1435 ;; use the buffer's coding system
1436 (let ((buf (find-buffer-visiting file
)))
1437 (when buf
(with-current-buffer buf
1438 buffer-file-coding-system
)))
1439 ;; otherwise, try to find one based on the file name
1440 (car (find-operation-coding-system 'insert-file-contents file
))
1441 ;; and a final fallback
1444 (defun vc-switches (backend op
)
1447 (let ((sym (vc-make-backend-sym
1448 backend
(intern (concat (symbol-name op
)
1450 (when (boundp sym
) (symbol-value sym
))))
1451 (let ((sym (intern (format "vc-%s-switches" (symbol-name op
)))))
1452 (when (boundp sym
) (symbol-value sym
)))
1454 ((eq op
'diff
) diff-switches
)))))
1455 (if (stringp switches
) (list switches
)
1456 ;; If not a list, return nil.
1457 ;; This is so we can set vc-diff-switches to t to override
1458 ;; any switches in diff-switches.
1459 (when (listp switches
) switches
))))
1461 ;; Old def for compatibility with Emacs-21.[123].
1462 (defmacro vc-diff-switches-list
(backend) `(vc-switches ',backend
'diff
))
1463 (make-obsolete 'vc-diff-switches-list
'vc-switches
"22.1")
1465 (defun vc-diff-finish (buffer messages
)
1466 ;; The empty sync output case has already been handled, so the only
1467 ;; possibility of an empty output is for an async process.
1468 (when (buffer-live-p buffer
)
1469 (let ((window (get-buffer-window buffer t
))
1470 (emptyp (zerop (buffer-size buffer
))))
1471 (with-current-buffer buffer
1472 (and messages emptyp
1473 (let ((inhibit-read-only t
))
1474 (insert (cdr messages
) ".\n")
1475 (message "%s" (cdr messages
))))
1476 (goto-char (point-min))
1478 (shrink-window-if-larger-than-buffer window
)))
1479 (when (and messages
(not emptyp
))
1480 (message "%sdone" (car messages
))))))
1482 (defvar vc-diff-added-files nil
1483 "If non-nil, diff added files by comparing them to /dev/null.")
1485 (defun vc-diff-internal (async vc-fileset rev1 rev2
&optional verbose
)
1486 "Report diffs between two revisions of a fileset.
1487 Diff output goes to the *vc-diff* buffer. The function
1488 returns t if the buffer had changes, nil otherwise."
1489 (let* ((files (cadr vc-fileset
))
1490 (messages (cons (format "Finding changes in %s..."
1491 (vc-delistify files
))
1492 (format "No changes between %s and %s"
1493 (or rev1
"working revision")
1494 (or rev2
"workfile"))))
1495 ;; Set coding system based on the first file. It's a kluge,
1496 ;; but the only way to set it for each file included would
1497 ;; be to call the back end separately for each file.
1498 (coding-system-for-read
1499 (if files
(vc-coding-system-for-diff (car files
)) 'undecided
)))
1500 (vc-setup-buffer "*vc-diff*")
1501 (message "%s" (car messages
))
1502 ;; Many backends don't handle well the case of a file that has been
1503 ;; added but not yet committed to the repo (notably CVS and Subversion).
1504 ;; Do that work here so the backends don't have to futz with it. --ESR
1506 ;; Actually most backends (including CVS) have options to control the
1507 ;; behavior since which one is better depends on the user and on the
1508 ;; situation). Worse yet: this code does not handle the case where
1509 ;; `file' is a directory which contains added files.
1510 ;; I made it conditional on vc-diff-added-files but it should probably
1511 ;; just be removed (or copied/moved to specific backends). --Stef.
1512 (when vc-diff-added-files
1513 (let ((filtered '()))
1514 (dolist (file files
)
1515 (if (or (file-directory-p file
)
1516 (not (string= (vc-working-revision file
) "0")))
1517 (push file filtered
)
1518 ;; This file is added but not yet committed;
1519 ;; there is no master file to diff against.
1521 (error "No revisions of %s exist" file
)
1522 ;; We regard this as "changed".
1523 ;; Diff it against /dev/null.
1524 (apply 'vc-do-command
"*vc-diff*"
1526 (append (vc-switches nil
'diff
) '("/dev/null"))))))
1527 (setq files
(nreverse filtered
))))
1528 (let ((vc-disable-async-diff (not async
)))
1529 (vc-call-backend (car vc-fileset
) 'diff files rev1 rev2
"*vc-diff*"))
1530 (set-buffer "*vc-diff*")
1531 (if (and (zerop (buffer-size))
1532 (not (get-buffer-process (current-buffer))))
1533 ;; Treat this case specially so as not to pop the buffer.
1535 (message "%s" (cdr messages
))
1538 ;; Make the *vc-diff* buffer read only, the diff-mode key
1539 ;; bindings are nicer for read only buffers. pcl-cvs does the
1541 (setq buffer-read-only t
)
1542 (vc-exec-after `(vc-diff-finish ,(current-buffer) ',(when verbose
1544 ;; Display the buffer, but at the end because it can change point.
1545 (pop-to-buffer (current-buffer))
1546 ;; In the async case, we return t even if there are no differences
1547 ;; because we don't know that yet.
1551 (defun vc-version-diff (files rev1 rev2
)
1552 "Report diffs between revisions of the fileset in the repository history."
1554 (let* ((vc-fileset (vc-deduce-fileset t
))
1555 (files (cadr vc-fileset
))
1556 (backend (car vc-fileset
))
1559 (vc-call-backend backend
'revision-completion-table files
))
1563 ;; someday we may be able to do revision completion on non-singleton
1564 ;; filesets, but not yet.
1565 ((/= (length files
) 1)
1567 ;; if it's a directory, don't supply any revision default
1568 ((file-directory-p first
)
1570 ;; if the file is not up-to-date, use working revision as older revision
1571 ((not (vc-up-to-date-p first
))
1572 (setq rev1-default
(vc-working-revision first
)))
1573 ;; if the file is not locked, use last and previous revisions as defaults
1575 (setq rev1-default
(vc-call-backend backend
'previous-revision first
1576 (vc-working-revision first
)))
1577 (when (string= rev1-default
"") (setq rev1-default nil
))
1578 (setq rev2-default
(vc-working-revision first
))))
1579 ;; construct argument list
1580 (let* ((rev1-prompt (if rev1-default
1581 (concat "Older revision (default "
1583 "Older revision: "))
1584 (rev2-prompt (concat "Newer revision (default "
1585 (or rev2-default
"current source") "): "))
1586 (rev1 (if completion-table
1587 (completing-read rev1-prompt completion-table
1588 nil nil nil nil rev1-default
)
1589 (read-string rev1-prompt nil nil rev1-default
)))
1590 (rev2 (if completion-table
1591 (completing-read rev2-prompt completion-table
1592 nil nil nil nil rev2-default
)
1593 (read-string rev2-prompt nil nil rev2-default
))))
1594 (when (string= rev1
"") (setq rev1 nil
))
1595 (when (string= rev2
"") (setq rev2 nil
))
1596 (list files rev1 rev2
))))
1597 ;; All that was just so we could do argument completion!
1598 (when (and (not rev1
) rev2
)
1599 (error "Not a valid revision range."))
1600 ;; Yes, it's painful to call (vc-deduce-fileset) again. Alas, the
1601 ;; placement rules for (interactive) don't actually leave us a choice.
1602 (vc-diff-internal t
(vc-deduce-fileset) rev1 rev2
(interactive-p)))
1604 ;; (defun vc-contains-version-controlled-file (dir)
1605 ;; "Return t if DIR contains a version-controlled file, nil otherwise."
1607 ;; (mapc (lambda (f) (and (not (file-directory-p f)) (vc-backend f) (throw 'found 't))) (directory-files dir))
1611 (defun vc-diff (historic &optional not-urgent
)
1612 "Display diffs between file revisions.
1613 Normally this compares the currently selected fileset with their
1614 working revisions. With a prefix argument HISTORIC, it reads two revision
1615 designators specifying which revisions to compare.
1617 The optional argument NOT-URGENT non-nil means it is ok to say no to
1619 (interactive (list current-prefix-arg t
))
1621 (call-interactively 'vc-version-diff
)
1622 (when buffer-file-name
(vc-buffer-sync not-urgent
))
1623 (vc-diff-internal t
(vc-deduce-fileset) nil nil
(interactive-p))))
1626 (defun vc-revision-other-window (rev)
1627 "Visit revision REV of the current file in another window.
1628 If the current file is named `F', the revision is named `F.~REV~'.
1629 If `F.~REV~' already exists, use it instead of checking it out again."
1631 (save-current-buffer
1632 (vc-ensure-vc-buffer)
1633 (let ((completion-table
1634 (vc-call revision-completion-table buffer-file-name
))
1635 (prompt "Revision to visit (default is working revision): "))
1637 (if completion-table
1638 (completing-read prompt completion-table
)
1639 (read-string prompt
))))))
1640 (vc-ensure-vc-buffer)
1641 (let* ((file buffer-file-name
)
1642 (revision (if (string-equal rev
"")
1643 (vc-working-revision file
)
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
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
))))
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
))
1679 ;; Header-insertion code
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'."
1687 (vc-ensure-vc-buffer)
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
)
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
)
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.
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."
1729 files rev oldcomment t
1730 "Enter a replacement change comment."
1731 (lambda (files rev comment
)
1733 ;; Less of a kluge than it looks like; log-view mode only passes
1734 ;; this function a singleton list. Arguments left in this form in
1735 ;; case the more general operation ever becomes meaningful.
1736 (vc-responsible-backend (car files
))
1737 'modify-change-comment files rev comment
))))
1741 "Merge changes between two revisions into the current buffer's file.
1742 This asks for two revisions to merge from in the minibuffer. If the
1743 first revision is a branch number, then merge all changes from that
1744 branch. If the first revision is empty, merge news, i.e. recent changes
1745 from the current branch.
1747 See Info node `Merging'."
1749 (vc-ensure-vc-buffer)
1751 (let* ((file buffer-file-name
)
1752 (backend (vc-backend file
))
1753 (state (vc-state file
))
1754 first-revision second-revision status
)
1756 ((stringp state
) ;; Locking VCses only
1757 (error "File is locked by %s" state
))
1758 ((not (vc-editable-p file
))
1760 "File must be checked out for merging. Check out now? ")
1761 (vc-checkout file t
)
1762 (error "Merge aborted"))))
1763 (setq first-revision
1764 (read-string (concat "Branch or revision to merge from "
1765 "(default news on current branch): ")))
1766 (if (string= first-revision
"")
1767 (setq status
(vc-call-backend backend
'merge-news file
))
1768 (if (not (vc-find-backend-function backend
'merge
))
1769 (error "Sorry, merging is not implemented for %s" backend
)
1770 (if (not (vc-branch-p first-revision
))
1771 (setq second-revision
1772 (read-string "Second revision: "
1773 (concat (vc-branch-part first-revision
) ".")))
1774 ;; We want to merge an entire branch. Set revisions
1775 ;; accordingly, so that vc-BACKEND-merge understands us.
1776 (setq second-revision first-revision
)
1777 ;; first-revision must be the starting point of the branch
1778 (setq first-revision
(vc-branch-part first-revision
)))
1779 (setq status
(vc-call-backend backend
'merge file
1780 first-revision second-revision
))))
1781 (vc-maybe-resolve-conflicts file status
"WORKFILE" "MERGE SOURCE")))
1783 (defun vc-maybe-resolve-conflicts (file status
&optional name-A name-B
)
1784 (vc-resynch-buffer file t
(not (buffer-modified-p)))
1785 (if (zerop status
) (message "Merge successful")
1787 (message "File contains conflicts.")))
1790 (defalias 'vc-resolve-conflicts
'smerge-ediff
)
1792 ;; VC status implementation
1794 (defun vc-default-status-extra-headers (backend dir
)
1795 ;; Be loud by default to remind people to add coded to display
1796 ;; backend specific headers.
1797 ;; XXX: change this to return nil before the release.
1798 "Extra : Add backend specific headers here")
1800 (defun vc-dir-headers (backend dir
)
1801 "Display the headers in the *VC status* buffer.
1802 It calls the `status-extra-headers' backend method to display backend
1805 (propertize "VC backend : " 'face
'font-lock-type-face
)
1806 (propertize (format "%s\n" backend
) 'face
'font-lock-variable-name-face
)
1807 (propertize "Working dir: " 'face
'font-lock-type-face
)
1808 (propertize (format "%s\n" dir
) 'face
'font-lock-variable-name-face
)
1809 (vc-call-backend backend
'status-extra-headers dir
)
1812 (defun vc-default-status-printer (backend fileentry
)
1813 "Pretty print FILEENTRY."
1814 ;; If you change the layout here, change vc-dir-move-to-goal-column.
1816 (if (vc-dir-fileinfo->directory fileentry
)
1818 (vc-dir-fileinfo->state fileentry
))))
1821 (format "%c" (if (vc-dir-fileinfo->marked fileentry
) ?
* ?
))
1822 'face
'font-lock-type-face
)
1825 (format "%-20s" state
)
1826 'face
(cond ((eq state
'up-to-date
) 'font-lock-builtin-face
)
1827 ((memq state
'(missing conflict
)) 'font-lock-warning-face
)
1828 (t 'font-lock-variable-name-face
))
1829 'mouse-face
'highlight
)
1832 (format "%s" (vc-dir-fileinfo->name fileentry
))
1833 'face
'font-lock-function-name-face
1834 'mouse-face
'highlight
))))
1836 (defun vc-default-extra-status-menu (backend)
1839 ;; This is used to that VC backends could add backend specific menu
1840 ;; items to vc-dir-menu-map.
1841 (defun vc-dir-menu-map-filter (orig-binding)
1842 (when (and (symbolp orig-binding
) (fboundp orig-binding
))
1843 (setq orig-binding
(indirect-function orig-binding
)))
1845 (vc-call-backend (vc-responsible-backend default-directory
)
1846 'extra-status-menu
)))
1847 (if (null ext-binding
)
1849 (append orig-binding
1853 (defun vc-dir-refresh-files (files default-state
)
1854 "Refresh some files in the VC status buffer."
1855 (let ((backend (vc-responsible-backend default-directory
))
1856 (status-buffer (current-buffer))
1857 (def-dir default-directory
))
1858 (vc-set-mode-line-busy-indicator)
1859 ;; Call the `dir-status-file' backend function.
1860 ;; `dir-status-file' is supposed to be asynchronous.
1861 ;; It should compute the results, and then call the function
1862 ;; passed as an argument in order to update the vc-dir buffer
1863 ;; with the results.
1864 (unless (buffer-live-p vc-dir-process-buffer
)
1865 (setq vc-dir-process-buffer
1866 (generate-new-buffer (format " *VC-%s* tmp status" backend
))))
1867 (lexical-let ((buffer (current-buffer)))
1868 (with-current-buffer vc-dir-process-buffer
1872 backend
'dir-status-files def-dir files default-state
1873 (lambda (entries &optional more-to-come
)
1874 ;; ENTRIES is a list of (FILE VC_STATE EXTRA) items.
1875 ;; If MORE-TO-COME is true, then more updates will come from
1876 ;; the asynchronous process.
1877 (with-current-buffer buffer
1878 (vc-dir-update entries buffer
)
1879 (unless more-to-come
1880 (setq mode-line-process nil
)
1881 ;; Remove the ones that haven't been updated at all.
1882 ;; Those not-updated are those whose state is nil because the
1883 ;; file/dir doesn't exist and isn't versioned.
1884 (ewoc-filter vc-ewoc
1886 (not (vc-dir-fileinfo->needs-update info
))))))))))))
1888 (defun vc-dir-refresh ()
1889 "Refresh the contents of the VC status buffer.
1890 Throw an error if another update process is in progress."
1893 (error "Another update process is in progress, cannot run two at a time")
1894 (let ((backend (vc-responsible-backend default-directory
))
1895 (status-buffer (current-buffer))
1896 (def-dir default-directory
))
1897 (vc-set-mode-line-busy-indicator)
1898 ;; Call the `dir-status' backend function.
1899 ;; `dir-status' is supposed to be asynchronous.
1900 ;; It should compute the results, and then call the function
1901 ;; passed as an argument in order to update the vc-dir buffer
1902 ;; with the results.
1904 ;; Create a buffer that can be used by `dir-status' and call
1905 ;; `dir-status' with this buffer as the current buffer. Use
1906 ;; `vc-dir-process-buffer' to remember this buffer, so that
1907 ;; it can be used later to kill the update process in case it
1909 (unless (buffer-live-p vc-dir-process-buffer
)
1910 (setq vc-dir-process-buffer
1911 (generate-new-buffer (format " *VC-%s* tmp status" backend
))))
1912 ;; set the needs-update flag on all entries
1913 (ewoc-map (lambda (info) (setf (vc-dir-fileinfo->needs-update info
) t
) nil
)
1915 (lexical-let ((buffer (current-buffer)))
1916 (with-current-buffer vc-dir-process-buffer
1920 backend
'dir-status def-dir
1921 (lambda (entries &optional more-to-come
)
1922 ;; ENTRIES is a list of (FILE VC_STATE EXTRA) items.
1923 ;; If MORE-TO-COME is true, then more updates will come from
1924 ;; the asynchronous process.
1925 (with-current-buffer buffer
1926 (vc-dir-update entries buffer
)
1927 (unless more-to-come
1930 vc-ewoc
'vc-dir-fileinfo-
>needs-update
)))
1932 (vc-dir-refresh-files
1933 (mapcar 'vc-dir-fileinfo-
>name remaining
)
1935 (setq mode-line-process nil
))))))))))))
1937 (defun vc-dir-show-fileentry (file)
1938 "Insert an entry for a specific file into the current VC status listing.
1939 This is typically used if the file is up-to-date (or has been added
1940 outside of VC) and one wants to do some operation on it."
1941 (interactive "fShow file: ")
1942 (vc-dir-update (list (list (file-relative-name file
) (vc-state file
))) (current-buffer)))
1944 (defun vc-dir-hide-up-to-date ()
1945 "Hide up-to-date items from display."
1949 (lambda (crt) (not (eq (vc-dir-fileinfo->state crt
) 'up-to-date
)))))
1951 (defun vc-dir-register ()
1952 "Register the marked files, or the current file if no marks."
1954 ;; FIXME: Just pass the fileset to vc-register.
1955 (mapc (lambda (arg) (vc-register nil arg
))
1956 (or (vc-dir-marked-files) (list (vc-dir-current-file)))))
1958 (defun vc-default-status-fileinfo-extra (backend file
)
1959 "Default absence of extra information returned for a file."
1962 ;; FIXME: Replace these with a more efficient dispatch
1964 (defun vc-generic-status-printer (fileentry)
1965 (let* ((file (vc-dir-fileinfo->name fileentry
))
1966 (backend (vc-responsible-backend (expand-file-name file
))))
1967 (vc-call-backend backend
'status-printer fileentry
)))
1969 (defun vc-generic-state (file)
1970 (let ((backend (vc-responsible-backend (expand-file-name file
))))
1971 (vc-call-backend backend
'state file
)))
1973 (defun vc-generic-status-fileinfo-extra (file)
1974 (let ((backend (vc-responsible-backend (expand-file-name file
))))
1975 (vc-call-backend backend
'status-fileinfo-extra file
)))
1977 (defun vc-generic-dir-headers (dir)
1978 (let ((backend (vc-responsible-backend dir
)))
1979 (vc-dir-headers backend dir
)))
1981 (defun vc-make-backend-object (file-or-dir)
1982 "Create the backend capability object needed by vc-dispatcher."
1983 (vc-create-client-object
1985 (let ((backend (vc-responsible-backend file-or-dir
)))
1986 (vc-dir-headers backend file-or-dir
))
1987 #'vc-generic-status-printer
1989 #'vc-generic-status-fileinfo-extra
1994 "Show the VC status for DIR."
1995 (interactive "DVC status for directory: ")
1996 (pop-to-buffer (vc-dir-prepare-status-buffer dir
))
1997 (if (and (derived-mode-p 'vc-dir-mode
) (boundp 'client-object
))
1999 ;; Otherwise, initialize a new view using the dispatcher layer
2001 ;; Build a capability object and hand it to the dispatcher initializer
2002 (vc-dir-mode (vc-make-backend-object dir
))
2003 ;; FIXME: Make a derived-mode instead.
2004 ;; Add VC-specific keybindings
2005 (let ((map (current-local-map)))
2006 (define-key map
"v" 'vc-diff
) ;; C-x v v
2007 (define-key map
"=" 'vc-diff
) ;; C-x v =
2008 (define-key map
"i" 'vc-dir-register
) ;; C-x v i
2009 (define-key map
"+" 'vc-update
) ;; C-x v +
2010 (define-key map
"l" 'vc-print-log
) ;; C-x v l
2011 ;; More confusing than helpful, probably
2012 ;(define-key map "R" 'vc-revert) ;; u is taken by dispatcher unmark.
2013 ;(define-key map "A" 'vc-annotate) ;; g is taken by dispatcher refresh
2014 (define-key map
"x" 'vc-dir-hide-up-to-date
))
2016 ;; FIXME: Needs to alter a buffer-local map, otherwise clients may clash
2017 (let ((map vc-dir-menu-map
))
2019 (define-key map
[sepvcdet] '("--"))
2020 (define-key map [remup]
2021 '(menu-item "Hide up-to-date" vc-dir-hide-up-to-date
2022 :help "Hide up-to-date items from display"))
2023 ;; FIXME: This needs a key binding. And maybe a better name
2024 ;; ("Insert" like PCL-CVS uses does not sound that great either)...
2025 (define-key map [ins]
2026 '(menu-item "Show File" vc-dir-show-fileentry
2027 :help "Show a file in the VC status listing even though it might be up to date"))
2028 (define-key map [annotate]
2029 '(menu-item "Annotate" vc-annotate
2030 :help "Display the edit history of the current file using colors"))
2031 (define-key map [diff]
2032 '(menu-item "Compare with Base Version" vc-diff
2033 :help "Compare file set with the base version"))
2034 (define-key map [log]
2035 '(menu-item "Show history" vc-print-log
2036 :help "List the change log of the current file set in a window"))
2038 (define-key map [sepvccmd] '("--"))
2039 (define-key map [update]
2040 '(menu-item "Update to latest version" vc-update
2041 :help "Update the current fileset's files to their tip revisions"))
2042 (define-key map [revert]
2043 '(menu-item "Revert to base version" vc-revert
2044 :help "Revert working copies of the selected fileset to their repository contents."))
2045 (define-key map [next-action]
2046 ;; FIXME: This really really really needs a better name!
2047 ;; And a key binding too.
2048 '(menu-item "Check In/Out" vc-next-action
2049 :help "Do the next logical version control operation on the current fileset"))
2050 (define-key map [register]
2051 '(menu-item "Register" vc-dir-register
2052 :help "Register file set into the version control system"))
2055 ;; Named-configuration entry points
2057 (defun vc-snapshot-precondition (dir)
2058 "Scan the tree below DIR, looking for files not up-to-date.
2059 If any file is not up-to-date, return the name of the first such file.
2060 \(This means, neither snapshot creation nor retrieval is allowed.\)
2061 If one or more of the files are currently visited, return `visited'.
2062 Otherwise, return nil."
2064 (catch 'vc-locked-example
2068 (if (not (vc-up-to-date-p f)) (throw 'vc-locked-example f)
2069 (when (get-file-buffer f) (setq status 'visited)))))
2073 (defun vc-create-snapshot (dir name branchp)
2074 "Descending recursively from DIR, make a snapshot called NAME.
2075 For each registered file, the working revision becomes part of
2076 the named configuration. If the prefix argument BRANCHP is
2077 given, the snapshot is made as a new branch and the files are
2078 checked out in that new branch."
2080 (list (read-file-name "Directory: " default-directory default-directory t)
2081 (read-string "New snapshot name: ")
2082 current-prefix-arg))
2083 (message "Making %s... " (if branchp "branch" "snapshot"))
2084 (when (file-directory-p dir) (setq dir (file-name-as-directory dir)))
2085 (vc-call-backend (vc-responsible-backend dir)
2086 'create-snapshot dir name branchp)
2087 (message "Making %s... done" (if branchp "branch" "snapshot")))
2090 (defun vc-retrieve-snapshot (dir name)
2091 "Descending recursively from DIR, retrieve the snapshot called NAME.
2092 If NAME is empty, it refers to the latest revisions.
2093 If locking is used for the files in DIR, then there must not be any
2094 locked files at or below DIR (but if NAME is empty, locked files are
2095 allowed and simply skipped)."
2097 (list (read-file-name "Directory: " default-directory default-directory t)
2098 (read-string "Snapshot name to retrieve (default latest revisions): ")))
2099 (let ((update (yes-or-no-p "Update any affected buffers? "))
2100 (msg (if (or (not name) (string= name ""))
2101 (format "Updating %s... " (abbreviate-file-name dir))
2102 (format "Retrieving snapshot into %s... "
2103 (abbreviate-file-name dir)))))
2105 (vc-call-backend (vc-responsible-backend dir)
2106 'retrieve-snapshot dir name update)
2107 (message "%s" (concat msg "done"))))
2109 ;; Miscellaneous other entry points
2112 (defun vc-print-log (&optional working-revision)
2113 "List the change log of the current fileset in a window.
2114 If WORKING-REVISION is non-nil, leave the point at that revision."
2116 (let* ((vc-fileset (vc-deduce-fileset t))
2117 (backend (car vc-fileset))
2118 (files (cadr vc-fileset))
2119 (working-revision (or working-revision (vc-working-revision (car files)))))
2120 ;; Don't switch to the output buffer before running the command,
2121 ;; so that any buffer-local settings in the vc-controlled
2122 ;; buffer can be accessed by the command.
2123 (vc-call-backend backend 'print-log files "*vc-change-log*")
2124 (pop-to-buffer "*vc-change-log*")
2126 `(let ((inhibit-read-only t))
2127 (vc-call-backend ',backend 'log-view-mode)
2128 (goto-char (point-max)) (forward-line -1)
2129 (while (looking-at "=*\n")
2130 (delete-char (- (match-end 0) (match-beginning 0)))
2132 (goto-char (point-min))
2133 (when (looking-at "[\b\t\n\v\f\r ]+")
2134 (delete-char (- (match-end 0) (match-beginning 0))))
2135 (shrink-window-if-larger-than-buffer)
2136 ;; move point to the log entry for the working revision
2137 (vc-call-backend ',backend 'show-log-entry ',working-revision)
2138 (setq vc-sentinel-movepoint (point))
2139 (set-buffer-modified-p nil)))))
2143 "Revert working copies of the selected fileset to their repository contents.
2144 This asks for confirmation if the buffer contents are not identical
2145 to the working revision (except for keyword expansion)."
2147 (let* ((vc-fileset (vc-deduce-fileset))
2148 (files (cadr vc-fileset)))
2149 ;; If any of the files is visited by the current buffer, make
2150 ;; sure buffer is saved. If the user says `no', abort since
2151 ;; we cannot show the changes and ask for confirmation to
2153 (when (or (not files) (memq (buffer-file-name) files))
2154 (vc-buffer-sync nil))
2155 (dolist (file files)
2156 (let ((buf (get-file-buffer file)))
2157 (when (and buf (buffer-modified-p buf))
2158 (error "Please kill or save all modified buffers before reverting.")))
2159 (when (vc-up-to-date-p file)
2160 (unless (yes-or-no-p (format "%s seems up-to-date. Revert anyway? " file))
2161 (error "Revert canceled"))))
2162 (when (vc-diff-internal vc-allow-async-revert vc-fileset nil nil)
2163 (unless (yes-or-no-p (format "Discard changes in %s? " (vc-delistify files)))
2164 (error "Revert canceled"))
2165 (delete-windows-on "*vc-diff*")
2166 (kill-buffer "*vc-diff*"))
2167 (dolist (file files)
2168 (message "Reverting %s..." (vc-delistify files))
2169 (vc-revert-file file)
2170 (message "Reverting %s...done" (vc-delistify files)))))
2173 (defun vc-rollback ()
2174 "Roll back (remove) the most recent changeset committed to the repository.
2175 This may be either a file-level or a repository-level operation,
2176 depending on the underlying version-control system."
2178 (let* ((vc-fileset (vc-deduce-fileset))
2179 (backend (car vc-fileset))
2180 (files (cadr vc-fileset))
2181 (granularity (vc-call-backend backend 'revision-granularity)))
2182 (unless (vc-find-backend-function backend 'rollback)
2183 (error "Rollback is not supported in %s" backend))
2184 (when (and (not (eq granularity 'repository)) (/= (length files) 1))
2185 (error "Rollback requires a singleton fileset or repository versioning"))
2186 ;; FIXME: latest-on-branch-p should take the fileset.
2187 (when (not (vc-call-backend backend 'latest-on-branch-p (car files)))
2188 (error "Rollback is only possible at the tip revision."))
2189 ;; If any of the files is visited by the current buffer, make
2190 ;; sure buffer is saved. If the user says `no', abort since
2191 ;; we cannot show the changes and ask for confirmation to
2193 (when (or (not files) (memq (buffer-file-name) files))
2194 (vc-buffer-sync nil))
2195 (dolist (file files)
2196 (when (buffer-modified-p (get-file-buffer file))
2197 (error "Please kill or save all modified buffers before rollback."))
2198 (when (not (vc-up-to-date-p file))
2199 (error "Please revert all modified workfiles before rollback.")))
2200 ;; Accumulate changes associated with the fileset
2201 (vc-setup-buffer "*vc-diff*")
2203 (message "Finding changes...")
2204 (let* ((tip (vc-working-revision (car files)))
2205 ;; FIXME: `previous-revision' should take the fileset.
2206 (previous (vc-call-backend backend 'previous-revision
2208 (vc-diff-internal nil vc-fileset previous tip))
2210 (unless (yes-or-no-p "Discard these revisions? ")
2211 (error "Rollback canceled"))
2212 (delete-windows-on "*vc-diff*")
2213 (kill-buffer"*vc-diff*")
2214 ;; Do the actual reversions
2215 (message "Rolling back %s..." (vc-delistify files))
2218 (vc-call-backend backend 'rollback files)
2219 `((vc-state . ,'up-to-date)
2220 (vc-checkout-time . , (nth 5 (file-attributes file)))
2221 (vc-working-revision . nil)))
2222 (dolist (f files) (vc-resynch-buffer f t t))
2223 (message "Rolling back %s...done" (vc-delistify files))))
2226 (define-obsolete-function-alias 'vc-revert-buffer 'vc-revert "23.1")
2230 "Update the current fileset's files to their tip revisions.
2231 For each one that contains no changes, and is not locked, then this simply
2232 replaces the work file with the latest revision on its branch. If the file
2233 contains changes, and the backend supports merging news, then any recent
2234 changes from the current branch are merged into the working file."
2236 (let* ((vc-fileset (vc-deduce-fileset))
2237 (backend (car vc-fileset))
2238 (files (cadr vc-fileset)))
2239 (dolist (file files)
2240 (when (let ((buf (get-file-buffer file)))
2241 (and buf (buffer-modified-p buf)))
2242 (error "Please kill or save all modified buffers before updating."))
2243 (if (vc-up-to-date-p file)
2244 (vc-checkout file nil t)
2245 (if (eq (vc-checkout-model backend (list file)) 'locking)
2246 (if (eq (vc-state file) 'edited)
2248 (substitute-command-keys
2249 "File is locked--type \\[vc-revert] to discard changes"))
2250 (error "Unexpected file state (%s) -- type %s"
2252 (substitute-command-keys
2253 "\\[vc-next-action] to correct")))
2254 (vc-maybe-resolve-conflicts
2255 file (vc-call-backend backend 'merge-news file)))))))
2257 (defun vc-version-backup-file (file &optional rev)
2258 "Return name of backup file for revision REV of FILE.
2259 If version backups should be used for FILE, and there exists
2260 such a backup for REV or the working revision of file, return
2261 its name; otherwise return nil."
2262 (when (vc-call make-version-backups-p file)
2263 (let ((backup-file (vc-version-backup-file-name file rev)))
2264 (if (file-exists-p backup-file)
2266 ;; there is no automatic backup, but maybe the user made one manually
2267 (setq backup-file (vc-version-backup-file-name file rev 'manual))
2268 (when (file-exists-p backup-file)
2271 (defun vc-revert-file (file)
2272 "Revert FILE back to the repository working revision it was based on."
2275 (let ((backup-file (vc-version-backup-file file)))
2277 (copy-file backup-file file 'ok-if-already-exists 'keep-date)
2278 (vc-delete-automatic-version-backups file))
2279 (vc-call revert file backup-file))
2280 `((vc-state . up-to-date)
2281 (vc-checkout-time . ,(nth 5 (file-attributes file)))))
2282 (vc-resynch-buffer file t t))
2285 (defun vc-switch-backend (file backend)
2286 "Make BACKEND the current version control system for FILE.
2287 FILE must already be registered in BACKEND. The change is not
2288 permanent, only for the current session. This function only changes
2289 VC's perspective on FILE, it does not register or unregister it.
2290 By default, this command cycles through the registered backends.
2291 To get a prompt, use a prefix argument."
2294 (or buffer-file-name
2295 (error "There is no version-controlled file in this buffer"))
2296 (let ((backend (vc-backend buffer-file-name))
2299 (error "File %s is not under version control" buffer-file-name))
2300 ;; Find the registered backends.
2301 (dolist (backend vc-handled-backends)
2302 (when (vc-call-backend backend 'registered buffer-file-name)
2303 (push backend backends)))
2304 ;; Find the next backend.
2305 (let ((def (car (delq backend (append (memq backend backends) backends))))
2306 (others (delete backend backends)))
2308 ((null others) (error "No other backend to switch to"))
2313 (format "Switch to backend [%s]: " def)
2314 (mapcar (lambda (b) (list (downcase (symbol-name b)))) backends)
2315 nil t nil nil (downcase (symbol-name def))))))
2317 (unless (eq backend (vc-backend file))
2318 (vc-file-clearprops file)
2319 (vc-file-setprop file 'vc-backend backend)
2320 ;; Force recomputation of the state
2321 (unless (vc-call-backend backend 'registered file)
2322 (vc-file-clearprops file)
2323 (error "%s is not registered in %s" file backend))
2324 (vc-mode-line file)))
2327 (defun vc-transfer-file (file new-backend)
2328 "Transfer FILE to another version control system NEW-BACKEND.
2329 If NEW-BACKEND has a higher precedence than FILE's current backend
2330 \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in
2331 NEW-BACKEND, using the revision number from the current backend as the
2332 base level. If NEW-BACKEND has a lower precedence than the current
2333 backend, then commit all changes that were made under the current
2334 backend to NEW-BACKEND, and unregister FILE from the current backend.
2335 \(If FILE is not yet registered under NEW-BACKEND, register it.)"
2336 (let* ((old-backend (vc-backend file))
2337 (edited (memq (vc-state file) '(edited needs-merge)))
2338 (registered (vc-call-backend new-backend 'registered file))
2340 (and registered ; Never move if not registered in new-backend yet.
2341 ;; move if new-backend comes later in vc-handled-backends
2342 (or (memq new-backend (memq old-backend vc-handled-backends))
2343 (y-or-n-p "Final transfer? "))))
2345 (when (eq old-backend new-backend)
2346 (error "%s is the current backend of %s" new-backend file))
2348 (set-file-modes file (logior (file-modes file) 128))
2349 ;; `registered' might have switched under us.
2350 (vc-switch-backend file old-backend)
2351 (let* ((rev (vc-working-revision file))
2352 (modified-file (and edited (make-temp-file file)))
2353 (unmodified-file (and modified-file (vc-version-backup-file file))))
2354 ;; Go back to the base unmodified file.
2358 (copy-file file modified-file 'ok-if-already-exists)
2359 ;; If we have a local copy of the unmodified file, handle that
2360 ;; here and not in vc-revert-file because we don't want to
2361 ;; delete that copy -- it is still useful for OLD-BACKEND.
2363 (copy-file unmodified-file file
2364 'ok-if-already-exists 'keep-date)
2365 (when (y-or-n-p "Get base revision from master? ")
2366 (vc-revert-file file))))
2367 (vc-call-backend new-backend 'receive-file file rev))
2369 (vc-switch-backend file new-backend)
2370 (unless (eq (vc-checkout-model new-backend (list file)) 'implicit)
2371 (vc-checkout file t nil))
2372 (rename-file modified-file file 'ok-if-already-exists)
2373 (vc-file-setprop file 'vc-checkout-time nil)))))
2375 (vc-switch-backend file old-backend)
2376 (setq comment (vc-call-backend old-backend 'comment-history file))
2377 (vc-call-backend old-backend 'unregister file))
2378 (vc-switch-backend file new-backend)
2379 (when (or move edited)
2380 (vc-file-setprop file 'vc-state 'edited)
2382 (vc-checkin file nil comment (stringp comment)))))
2384 (defun vc-rename-master (oldmaster newfile templates)
2385 "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES."
2386 (let* ((dir (file-name-directory (expand-file-name oldmaster)))
2387 (newdir (or (file-name-directory newfile) ""))
2388 (newbase (file-name-nondirectory newfile))
2390 ;; List of potential master files for `newfile'
2392 (lambda (s) (vc-possible-master s newdir newbase))
2394 (when (or (file-symlink-p oldmaster)
2395 (file-symlink-p (file-name-directory oldmaster)))
2396 (error "This is unsafe in the presence of symbolic links"))
2400 ;; If possible, keep the master file in the same directory.
2402 (when (and f (string= (file-name-directory (expand-file-name f)) dir))
2404 ;; If not, just use the first possible place.
2406 (and f (or (not (setq dir (file-name-directory f)))
2407 (file-directory-p dir))
2409 (error "New file lacks a version control directory")))))
2411 (defun vc-delete-file (file)
2412 "Delete file and mark it as such in the version control system."
2413 (interactive "fVC delete file: ")
2414 (setq file (expand-file-name file))
2415 (let ((buf (get-file-buffer file))
2416 (backend (vc-backend file)))
2418 (error "File %s is not under version control"
2419 (file-name-nondirectory file)))
2420 (unless (vc-find-backend-function backend 'delete-file)
2421 (error "Deleting files under %s is not supported in VC" backend))
2422 (when (and buf (buffer-modified-p buf))
2423 (error "Please save or undo your changes before deleting %s" file))
2424 (let ((state (vc-state file)))
2425 (when (eq state 'edited)
2426 (error "Please commit or undo your changes before deleting %s" file))
2427 (when (eq state 'conflict)
2428 (error "Please resolve the conflicts before deleting %s" file)))
2429 (unless (y-or-n-p (format "Really want to delete %s? "
2430 (file-name-nondirectory file)))
2432 (unless (or (file-directory-p file) (null make-backup-files)
2433 (not (file-exists-p file)))
2434 (with-current-buffer (or buf (find-file-noselect file))
2435 (let ((backup-inhibited nil))
2437 ;; If we didn't have a buffer visiting the file before this
2438 ;; command, kill the buffer created by the above
2439 ;; `find-file-noselect' call.
2440 (unless buf (kill-buffer (current-buffer)))))
2441 (vc-call-backend backend 'delete-file file)
2442 ;; If the backend hasn't deleted the file itself, let's do it for him.
2443 (when (file-exists-p file) (delete-file file))
2444 ;; Forget what VC knew about the file.
2445 (vc-file-clearprops file)
2446 (vc-resynch-buffer file buf t)))
2449 (defun vc-rename-file (old new)
2450 "Rename file OLD to NEW, and rename its master file likewise."
2451 (interactive "fVC rename file: \nFRename to: ")
2452 (let ((oldbuf (get-file-buffer old)))
2453 (when (and oldbuf (buffer-modified-p oldbuf))
2454 (error "Please save files before moving them"))
2455 (when (get-file-buffer new)
2456 (error "Already editing new file name"))
2457 (when (file-exists-p new)
2458 (error "New file already exists"))
2459 (let ((state (vc-state old)))
2460 (unless (memq state '(up-to-date edited))
2461 (error "Please %s files before moving them"
2462 (if (stringp state) "check in" "update"))))
2463 (vc-call rename-file old new)
2464 (vc-file-clearprops old)
2465 ;; Move the actual file (unless the backend did it already)
2466 (when (file-exists-p old) (rename-file old new))
2467 ;; ?? Renaming a file might change its contents due to keyword expansion.
2468 ;; We should really check out a new copy if the old copy was precisely equal
2469 ;; to some checked-in revision. However, testing for this is tricky....
2471 (with-current-buffer oldbuf
2472 (let ((buffer-read-only buffer-read-only))
2473 (set-visited-file-name new))
2476 (set-buffer-modified-p nil)))))
2479 (defun vc-update-change-log (&rest args)
2480 "Find change log file and add entries from recent version control logs.
2481 Normally, find log entries for all registered files in the default
2484 With prefix arg of \\[universal-argument], only find log entries for the current buffer's file.
2486 With any numeric prefix arg, find log entries for all currently visited
2487 files that are under version control. This puts all the entries in the
2488 log for the default directory, which may not be appropriate.
2490 From a program, any ARGS are assumed to be filenames for which
2491 log entries should be gathered."
2493 (cond ((consp current-prefix-arg) ;C-u
2494 (list buffer-file-name))
2495 (current-prefix-arg ;Numeric argument.
2497 (buffers (buffer-list))
2500 (setq file (buffer-file-name (car buffers)))
2501 (and file (vc-backend file)
2502 (setq files (cons file files)))
2503 (setq buffers (cdr buffers)))
2506 ;; Don't supply any filenames to backend; this means
2507 ;; it should find all relevant files relative to
2508 ;; the default-directory.
2510 (vc-call-backend (vc-responsible-backend default-directory)
2511 'update-changelog args))
2513 ;;; The default back end. Assumes RCS-like revision numbering.
2515 (defun vc-default-revision-granularity ()
2516 (error "Your backend will not work with this version of VC mode."))
2518 ;; functions that operate on RCS revision numbers. This code should
2519 ;; also be moved into the backends. It stays for now, however, since
2520 ;; it is used in code below.
2522 (defun vc-trunk-p (rev)
2523 "Return t if REV is a revision on the trunk."
2524 (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev))))
2526 (defun vc-branch-p (rev)
2527 "Return t if REV is a branch revision."
2528 (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev))))
2531 (defun vc-branch-part (rev)
2532 "Return the branch part of a revision number REV."
2533 (let ((index (string-match "\\.[0-9]+\\'" rev)))
2535 (substring rev 0 index))))
2537 (defun vc-minor-part (rev)
2538 "Return the minor revision number of a revision number REV."
2539 (string-match "[0-9]+\\'" rev)
2540 (substring rev (match-beginning 0) (match-end 0)))
2542 (defun vc-default-previous-revision (backend file rev)
2543 "Return the revision number immediately preceding REV for FILE,
2544 or nil if there is no previous revision. This default
2545 implementation works for MAJOR.MINOR-style revision numbers as
2546 used by RCS and CVS."
2547 (let ((branch (vc-branch-part rev))
2548 (minor-num (string-to-number (vc-minor-part rev))))
2551 ;; revision does probably not start a branch or release
2552 (concat branch "." (number-to-string (1- minor-num)))
2553 (if (vc-trunk-p rev)
2554 ;; we are at the beginning of the trunk --
2555 ;; don't know anything to return here
2557 ;; we are at the beginning of a branch --
2558 ;; return revision of starting point
2559 (vc-branch-part branch))))))
2561 (defun vc-default-next-revision (backend file rev)
2562 "Return the revision number immediately following REV for FILE,
2563 or nil if there is no next revision. This default implementation
2564 works for MAJOR.MINOR-style revision numbers as used by RCS
2566 (when (not (string= rev (vc-working-revision file)))
2567 (let ((branch (vc-branch-part rev))
2568 (minor-num (string-to-number (vc-minor-part rev))))
2569 (concat branch "." (number-to-string (1+ minor-num))))))
2571 (defun vc-default-responsible-p (backend file)
2572 "Indicate whether BACKEND is reponsible for FILE.
2573 The default is to return nil always."
2576 (defun vc-default-could-register (backend file)
2577 "Return non-nil if BACKEND could be used to register FILE.
2578 The default implementation returns t for all files."
2581 (defun vc-default-latest-on-branch-p (backend file)
2582 "Return non-nil if FILE is the latest on its branch.
2583 This default implementation always returns non-nil, which means that
2584 editing non-current revisions is not supported by default."
2587 (defun vc-default-init-revision (backend) vc-default-init-revision)
2589 (defalias 'vc-cvs-update-changelog 'vc-update-changelog-rcs2log)
2590 (defalias 'vc-rcs-update-changelog 'vc-update-changelog-rcs2log)
2591 ;; FIXME: This should probably be moved to vc-rcs.el and replaced in
2592 ;; vc-cvs.el by code using cvs2cl.
2593 (defun vc-update-changelog-rcs2log (files)
2594 "Default implementation of update-changelog.
2595 Uses `rcs2log' which only works for RCS and CVS."
2596 ;; FIXME: We (c|sh)ould add support for cvs2cl
2597 (let ((odefault default-directory)
2598 (changelog (find-change-log))
2599 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
2600 (tempfile (make-temp-file
2601 (expand-file-name "vc"
2602 (or small-temporary-file-directory
2603 temporary-file-directory))))
2604 (login-name (or user-login-name
2605 (format "uid%d" (number-to-string (user-uid)))))
2606 (full-name (or add-log-full-name
2609 (format "uid%d" (number-to-string (user-uid)))))
2610 (mailing-address (or add-log-mailing-address
2611 user-mail-address)))
2612 (find-file-other-window changelog)
2613 (barf-if-buffer-read-only)
2616 (goto-char (point-min))
2618 (message "Computing change log entries...")
2619 (message "Computing change log entries... %s"
2622 (setq default-directory odefault)
2623 (if (eq 0 (apply 'call-process
2624 (expand-file-name "rcs2log"
2626 nil (list t tempfile) nil
2628 "-u" (concat login-name
2630 "\t" mailing-address)
2634 (expand-file-name f odefault)))
2637 (pop-to-buffer (get-buffer-create "*vc*"))
2639 (insert-file-contents tempfile)
2641 (setq default-directory (file-name-directory changelog))
2642 (delete-file tempfile)))))
2644 (defun vc-default-find-revision (backend file rev buffer)
2645 "Provide the new `find-revision' op based on the old `checkout' op.
2646 This is only for compatibility with old backends. They should be updated
2647 to provide the `find-revision' operation instead."
2648 (let ((tmpfile (make-temp-file (expand-file-name file))))
2651 (vc-call-backend backend 'checkout file nil rev tmpfile)
2652 (with-current-buffer buffer
2653 (insert-file-contents-literally tmpfile)))
2654 (delete-file tmpfile))))
2656 (defun vc-default-prettify-state-info (backend file)
2657 (let* ((state (vc-state file))
2660 ((stringp state) (concat "(" state ")"))
2661 ((eq state 'edited) "(modified)")
2662 ((eq state 'needs-merge) "(merge)")
2663 ((eq state 'needs-update) "(update)")
2664 ((eq state 'added) "(added)")
2665 ((eq state 'removed) "(removed)")
2666 ((eq state 'ignored) "(ignored)")
2667 ((eq state 'unregistered) "?")
2668 ((eq state 'unlocked-changes) "(stale)")
2669 ((not state) "(unknown)")))
2671 (get-file-buffer file))
2673 (if (and buffer (buffer-modified-p buffer)) "+" "")))
2674 (concat statestring modflag)))
2676 (defun vc-default-rename-file (backend old new)
2678 (add-name-to-file old new)
2679 (error (rename-file old new)))
2680 (vc-delete-file old)
2681 (with-current-buffer (find-file-noselect new)
2684 (defalias 'vc-default-check-headers 'ignore)
2686 (defun vc-default-log-view-mode (backend) (log-view-mode))
2688 (defun vc-default-show-log-entry (backend rev)
2690 (log-view-goto-rev rev)))
2692 (defun vc-default-comment-history (backend file)
2693 "Return a string with all log entries stored in BACKEND for FILE."
2694 (when (vc-find-backend-function backend 'print-log)
2695 (with-current-buffer "*vc*"
2696 (vc-call-backend backend 'print-log (list file))
2699 (defun vc-default-receive-file (backend file rev)
2700 "Let BACKEND receive FILE from another version control system."
2701 (vc-call-backend backend 'register file rev ""))
2703 (defun vc-default-create-snapshot (backend dir name branchp)
2705 (error "VC backend %s does not support module branches" backend))
2706 (let ((result (vc-snapshot-precondition dir)))
2707 (if (stringp result)
2708 (error "File %s is not up-to-date" result)
2712 (vc-call-backend backend 'assign-name f name))))))
2714 (defun vc-default-retrieve-snapshot (backend dir name update)
2715 (if (string= name "")
2722 (vc-call-backend backend 'checkout f nil "")
2723 (when update (vc-resynch-buffer f t t)))))))
2724 (let ((result (vc-snapshot-precondition dir)))
2725 (if (stringp result)
2726 (error "File %s is locked" result)
2727 (setq update (and (eq result 'visited) update))
2730 (lambda (f) (vc-error-occurred
2731 (vc-call-backend backend 'checkout f nil name)
2732 (when update (vc-resynch-buffer f t t)))))))))
2734 (defun vc-default-revert (backend file contents-done)
2735 (unless contents-done
2736 (let ((rev (vc-working-revision file))
2737 (file-buffer (or (get-file-buffer file) (current-buffer))))
2738 (message "Checking out %s..." file)
2740 (backup-name (car (find-backup-file-name file))))
2742 (copy-file file backup-name 'ok-if-already-exists 'keep-date)
2743 (unless (file-writable-p file)
2744 (set-file-modes file (logior (file-modes file) 128))))
2746 (let ((coding-system-for-read 'no-conversion)
2747 (coding-system-for-write 'no-conversion))
2748 (with-temp-file file
2749 (let ((outbuf (current-buffer)))
2750 ;; Change buffer to get local value of vc-checkout-switches.
2751 (with-current-buffer file-buffer
2752 (let ((default-directory (file-name-directory file)))
2753 (vc-call-backend backend 'find-revision
2754 file rev outbuf)))))
2758 (rename-file backup-name file 'ok-if-already-exists)
2759 (and (not vc-make-backup-files) (delete-file backup-name))))))
2760 (message "Checking out %s...done" file))))
2762 (defalias 'vc-default-revision-completion-table 'ignore)
2764 (defun vc-default-dir-status-files (backend dir files default-state update-function)
2765 (funcall update-function
2766 (mapcar (lambda (file) (list file default-state)) files)))
2768 (defun vc-check-headers ()
2769 "Check if the current file has any headers in it."
2771 (vc-call-backend (vc-backend buffer-file-name) 'check-headers))
2773 ;;; Annotate functionality
2775 ;; Declare globally instead of additional parameter to
2776 ;; temp-buffer-show-function (not possible to pass more than one
2777 ;; parameter). The use of annotate-ratio is deprecated in favor of
2778 ;; annotate-mode, which replaces it with the more sensible "span-to
2779 ;; days", along with autoscaling support.
2780 (defvar vc-annotate-ratio nil "Global variable.")
2782 ;; internal buffer-local variables
2783 (defvar vc-annotate-backend nil)
2784 (defvar vc-annotate-parent-file nil)
2785 (defvar vc-annotate-parent-rev nil)
2786 (defvar vc-annotate-parent-display-mode nil)
2788 (defconst vc-annotate-font-lock-keywords
2789 ;; The fontification is done by vc-annotate-lines instead of font-lock.
2790 '((vc-annotate-lines)))
2792 (define-derived-mode vc-annotate-mode fundamental-mode "Annotate"
2793 "Major mode for output buffers of the `vc-annotate' command.
2795 You can use the mode-specific menu to alter the time-span of the used
2796 colors. See variable `vc-annotate-menu-elements' for customizing the
2798 ;; Frob buffer-invisibility-spec so that if it is originally a naked t,
2799 ;; it will become a list, to avoid initial annotations being invisible.
2800 (add-to-invisibility-spec 'foo)
2801 (remove-from-invisibility-spec 'foo)
2802 (set (make-local-variable 'truncate-lines) t)
2803 (set (make-local-variable 'font-lock-defaults)
2804 '(vc-annotate-font-lock-keywords t))
2807 (defun vc-annotate-toggle-annotation-visibility ()
2808 "Toggle whether or not the annotation is visible."
2810 (funcall (if (memq 'vc-annotate-annotation buffer-invisibility-spec)
2811 'remove-from-invisibility-spec
2812 'add-to-invisibility-spec)
2813 'vc-annotate-annotation)
2814 (force-window-update (current-buffer)))
2816 (defun vc-annotate-display-default (ratio)
2817 "Display the output of \\[vc-annotate] using the default color range.
2818 The color range is given by `vc-annotate-color-map', scaled by RATIO.
2819 The current time is used as the offset."
2820 (interactive (progn (kill-local-variable 'vc-annotate-color-map) '(1.0)))
2821 (message "Redisplaying annotation...")
2822 (vc-annotate-display ratio)
2823 (message "Redisplaying annotation...done"))
2825 (defun vc-annotate-oldest-in-map (color-map)
2826 "Return the oldest time in the COLOR-MAP."
2827 ;; Since entries should be sorted, we can just use the last one.
2828 (caar (last color-map)))
2830 (defun vc-annotate-get-time-set-line-props ()
2832 (date (vc-call-backend vc-annotate-backend 'annotate-time))
2833 (inhibit-read-only t))
2834 (assert (>= (point) bol))
2835 (put-text-property bol (point) 'invisible 'vc-annotate-annotation)
2838 (defun vc-annotate-display-autoscale (&optional full)
2839 "Highlight the output of \\[vc-annotate] using an autoscaled color map.
2840 Autoscaling means that the map is scaled from the current time to the
2841 oldest annotation in the buffer, or, with prefix argument FULL, to
2842 cover the range from the oldest annotation to the newest."
2845 (oldest 999999.) ;Any CVS users at the founding of Rome?
2846 (current (vc-annotate-convert-time (current-time)))
2848 (message "Redisplaying annotation...")
2849 ;; Run through this file and find the oldest and newest dates annotated.
2851 (goto-char (point-min))
2853 (when (setq date (vc-annotate-get-time-set-line-props))
2854 (when (> date newest)
2856 (when (< date oldest)
2857 (setq oldest date)))
2859 (vc-annotate-display
2860 (/ (- (if full newest current) oldest)
2861 (vc-annotate-oldest-in-map vc-annotate-color-map))
2863 (message "Redisplaying annotation...done \(%s\)"
2865 (format "Spanned from %.1f to %.1f days old"
2868 (format "Spanned to %.1f days old" (- current oldest))))))
2870 ;; Menu -- Using easymenu.el
2871 (easy-menu-define vc-annotate-mode-menu vc-annotate-mode-map
2872 "VC Annotate Display Menu"
2874 ["By Color Map Range" (unless (null vc-annotate-display-mode)
2875 (setq vc-annotate-display-mode nil)
2876 (vc-annotate-display-select))
2877 :style toggle :selected (null vc-annotate-display-mode)]
2878 ,@(let ((oldest-in-map (vc-annotate-oldest-in-map vc-annotate-color-map)))
2879 (mapcar (lambda (element)
2880 (let ((days (* element oldest-in-map)))
2881 `[,(format "Span %.1f days" days)
2882 (vc-annotate-display-select nil ,days)
2883 :style toggle :selected
2884 (eql vc-annotate-display-mode ,days) ]))
2885 vc-annotate-menu-elements))
2887 (vc-annotate-display-select
2888 nil (float (string-to-number (read-string "Span how many days? "))))]
2891 (unless (eq vc-annotate-display-mode 'scale)
2892 (vc-annotate-display-select nil 'scale))
2894 "Use an autoscaled color map from the oldest annotation to the current time"
2895 :style toggle :selected
2896 (eq vc-annotate-display-mode 'scale)]
2897 ["Span Oldest->Newest"
2898 (unless (eq vc-annotate-display-mode 'fullscale)
2899 (vc-annotate-display-select nil 'fullscale))
2901 "Use an autoscaled color map from the oldest to the newest annotation"
2902 :style toggle :selected
2903 (eq vc-annotate-display-mode 'fullscale)]
2905 ["Toggle annotation visibility" vc-annotate-toggle-annotation-visibility
2907 "Toggle whether the annotation is visible or not"]
2908 ["Annotate previous revision" vc-annotate-prev-revision
2909 :help "Visit the annotation of the revision previous to this one"]
2910 ["Annotate next revision" vc-annotate-next-revision
2911 :help "Visit the annotation of the revision after this one"]
2912 ["Annotate revision at line" vc-annotate-revision-at-line
2914 "Visit the annotation of the revision identified in the current line"]
2915 ["Annotate revision previous to line" vc-annotate-revision-previous-to-line
2916 :help "Visit the annotation of the revision before the revision at line"]
2917 ["Annotate latest revision" vc-annotate-working-revision
2918 :help "Visit the annotation of the working revision of this file"]
2919 ["Show log of revision at line" vc-annotate-show-log-revision-at-line
2920 :help "Visit the log of the revision at line"]
2921 ["Show diff of revision at line" vc-annotate-show-diff-revision-at-line
2923 "Visit the diff of the revision at line from its previous revision"]
2924 ["Visit revision at line" vc-annotate-find-revision-at-line
2925 :help "Visit the revision identified in the current line"]))
2927 (defun vc-annotate-display-select (&optional buffer mode)
2928 "Highlight the output of \\[vc-annotate].
2929 By default, the current buffer is highlighted, unless overridden by
2930 BUFFER. `vc-annotate-display-mode' specifies the highlighting mode to
2931 use; you may override this using the second optional arg MODE."
2933 (when mode (setq vc-annotate-display-mode mode))
2934 (pop-to-buffer (or buffer (current-buffer)))
2935 (cond ((null vc-annotate-display-mode)
2936 ;; The ratio is global, thus relative to the global color-map.
2937 (kill-local-variable 'vc-annotate-color-map)
2938 (vc-annotate-display-default (or vc-annotate-ratio 1.0)))
2939 ;; One of the auto-scaling modes
2940 ((eq vc-annotate-display-mode 'scale)
2941 (vc-exec-after `(vc-annotate-display-autoscale)))
2942 ((eq vc-annotate-display-mode 'fullscale)
2943 (vc-exec-after `(vc-annotate-display-autoscale t)))
2944 ((numberp vc-annotate-display-mode) ; A fixed number of days lookback
2945 (vc-annotate-display-default
2946 (/ vc-annotate-display-mode
2947 (vc-annotate-oldest-in-map vc-annotate-color-map))))
2948 (t (error "No such display mode: %s"
2949 vc-annotate-display-mode))))
2952 (defun vc-annotate (file rev &optional display-mode buf move-point-to)
2953 "Display the edit history of the current file using colors.
2955 This command creates a buffer that shows, for each line of the current
2956 file, when it was last edited and by whom. Additionally, colors are
2957 used to show the age of each line--blue means oldest, red means
2958 youngest, and intermediate colors indicate intermediate ages. By
2959 default, the time scale stretches back one year into the past;
2960 everything that is older than that is shown in blue.
2962 With a prefix argument, this command asks two questions in the
2963 minibuffer. First, you may enter a revision number; then the buffer
2964 displays and annotates that revision instead of the working revision
2965 \(type RET in the minibuffer to leave that default unchanged). Then,
2966 you are prompted for the time span in days which the color range
2967 should cover. For example, a time span of 20 days means that changes
2968 over the past 20 days are shown in red to blue, according to their
2969 age, and everything that is older than that is shown in blue.
2971 If MOVE-POINT-TO is given, move the point to that line.
2973 Customization variables:
2975 `vc-annotate-menu-elements' customizes the menu elements of the
2976 mode-specific menu. `vc-annotate-color-map' and
2977 `vc-annotate-very-old-color' define the mapping of time to colors.
2978 `vc-annotate-background' specifies the background color."
2980 (save-current-buffer
2981 (vc-ensure-vc-buffer)
2982 (list buffer-file-name
2983 (let ((def (vc-working-revision buffer-file-name)))
2984 (if (null current-prefix-arg) def
2986 (format "Annotate from revision (default %s): " def)
2988 (if (null current-prefix-arg)
2989 vc-annotate-display-mode
2990 (float (string-to-number
2991 (read-string "Annotate span days (default 20): "
2993 (vc-ensure-vc-buffer)
2994 (setq vc-annotate-display-mode display-mode) ;Not sure why. --Stef
2995 (let* ((temp-buffer-name (format "*Annotate %s (rev %s)*" (buffer-name) rev))
2996 (temp-buffer-show-function 'vc-annotate-display-select)
2997 ;; If BUF is specified, we presume the caller maintains current line,
2998 ;; so we don't need to do it here. This implementation may give
2999 ;; strange results occasionally in the case of REV != WORKFILE-REV.
3000 (current-line (or move-point-to (unless buf (line-number-at-pos)))))
3001 (message "Annotating...")
3002 ;; If BUF is specified it tells in which buffer we should put the
3003 ;; annotations. This is used when switching annotations to another
3004 ;; revision, so we should update the buffer's name.
3005 (when buf (with-current-buffer buf
3006 (rename-buffer temp-buffer-name t)
3007 ;; In case it had to be uniquified.
3008 (setq temp-buffer-name (buffer-name))))
3009 (with-output-to-temp-buffer temp-buffer-name
3010 (let ((backend (vc-backend file)))
3011 (vc-call-backend backend 'annotate-command file
3012 (get-buffer temp-buffer-name) rev)
3013 ;; we must setup the mode first, and then set our local
3014 ;; variables before the show-function is called at the exit of
3015 ;; with-output-to-temp-buffer
3016 (with-current-buffer temp-buffer-name
3017 (unless (equal major-mode 'vc-annotate-mode)
3019 (set (make-local-variable 'vc-annotate-backend) backend)
3020 (set (make-local-variable 'vc-annotate-parent-file) file)
3021 (set (make-local-variable 'vc-annotate-parent-rev) rev)
3022 (set (make-local-variable 'vc-annotate-parent-display-mode)
3025 (with-current-buffer temp-buffer-name
3028 ;; Ideally, we'd rather not move point if the user has already
3029 ;; moved it elsewhere, but really point here is not the position
3030 ;; of the user's cursor :-(
3031 (when ,current-line ;(and (bobp))
3032 (goto-line ,current-line)
3033 (setq vc-sentinel-movepoint (point)))
3034 (unless (active-minibuffer-window)
3035 (message "Annotating... done")))))))
3037 (defun vc-annotate-prev-revision (prefix)
3038 "Visit the annotation of the revision previous to this one.
3040 With a numeric prefix argument, annotate the revision that many
3041 revisions previous."
3043 (vc-annotate-warp-revision (- 0 prefix)))
3045 (defun vc-annotate-next-revision (prefix)
3046 "Visit the annotation of the revision after this one.
3048 With a numeric prefix argument, annotate the revision that many
3051 (vc-annotate-warp-revision prefix))
3053 (defun vc-annotate-working-revision ()
3054 "Visit the annotation of the working revision of this file."
3056 (if (not (equal major-mode 'vc-annotate-mode))
3057 (message "Cannot be invoked outside of a vc annotate buffer")
3058 (let ((warp-rev (vc-working-revision vc-annotate-parent-file)))
3059 (if (equal warp-rev vc-annotate-parent-rev)
3060 (message "Already at revision %s" warp-rev)
3061 (vc-annotate-warp-revision warp-rev)))))
3063 (defun vc-annotate-extract-revision-at-line ()
3064 "Extract the revision number of the current line."
3065 ;; This function must be invoked from a buffer in vc-annotate-mode
3066 (vc-call-backend vc-annotate-backend 'annotate-extract-revision-at-line))
3068 (defun vc-annotate-revision-at-line ()
3069 "Visit the annotation of the revision identified in the current line."
3071 (if (not (equal major-mode 'vc-annotate-mode))
3072 (message "Cannot be invoked outside of a vc annotate buffer")
3073 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
3074 (if (not rev-at-line)
3075 (message "Cannot extract revision number from the current line")
3076 (if (equal rev-at-line vc-annotate-parent-rev)
3077 (message "Already at revision %s" rev-at-line)
3078 (vc-annotate-warp-revision rev-at-line))))))
3080 (defun vc-annotate-find-revision-at-line ()
3081 "Visit the revision identified in the current line."
3083 (if (not (equal major-mode 'vc-annotate-mode))
3084 (message "Cannot be invoked outside of a vc annotate buffer")
3085 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
3086 (if (not rev-at-line)
3087 (message "Cannot extract revision number from the current line")
3088 (vc-revision-other-window rev-at-line)))))
3090 (defun vc-annotate-revision-previous-to-line ()
3091 "Visit the annotation of the revision before the revision at line."
3093 (if (not (equal major-mode 'vc-annotate-mode))
3094 (message "Cannot be invoked outside of a vc annotate buffer")
3095 (let ((rev-at-line (vc-annotate-extract-revision-at-line))
3097 (if (not rev-at-line)
3098 (message "Cannot extract revision number from the current line")
3100 (vc-call-backend vc-annotate-backend 'previous-revision
3101 vc-annotate-parent-file rev-at-line))
3102 (vc-annotate-warp-revision prev-rev)))))
3104 (defun vc-annotate-show-log-revision-at-line ()
3105 "Visit the log of the revision at line."
3107 (if (not (equal major-mode 'vc-annotate-mode))
3108 (message "Cannot be invoked outside of a vc annotate buffer")
3109 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
3110 (if (not rev-at-line)
3111 (message "Cannot extract revision number from the current line")
3112 (vc-print-log rev-at-line)))))
3114 (defun vc-annotate-show-diff-revision-at-line ()
3115 "Visit the diff of the revision at line from its previous revision."
3117 (if (not (equal major-mode 'vc-annotate-mode))
3118 (message "Cannot be invoked outside of a vc annotate buffer")
3119 (let ((rev-at-line (vc-annotate-extract-revision-at-line))
3121 (if (not rev-at-line)
3122 (message "Cannot extract revision number from the current line")
3124 (vc-call-backend vc-annotate-backend 'previous-revision
3125 vc-annotate-parent-file rev-at-line))
3127 (message "Cannot diff from any revision prior to %s" rev-at-line)
3128 (save-window-excursion
3131 (cons vc-annotate-backend (list vc-annotate-parent-file))
3132 prev-rev rev-at-line))
3133 (switch-to-buffer "*vc-diff*"))))))
3135 (defun vc-annotate-warp-revision (revspec)
3136 "Annotate the revision described by REVSPEC.
3138 If REVSPEC is a positive integer, warp that many revisions
3139 forward, if possible, otherwise echo a warning message. If
3140 REVSPEC is a negative integer, warp that many revisions backward,
3141 if possible, otherwise echo a warning message. If REVSPEC is a
3142 string, then it describes a revision number, so warp to that
3144 (if (not (equal major-mode 'vc-annotate-mode))
3145 (message "Cannot be invoked outside of a vc annotate buffer")
3146 (let* ((buf (current-buffer))
3147 (oldline (line-number-at-pos))
3148 (revspeccopy revspec)
3151 ((and (integerp revspec) (> revspec 0))
3152 (setq newrev vc-annotate-parent-rev)
3153 (while (and (> revspec 0) newrev)
3154 (setq newrev (vc-call-backend vc-annotate-backend 'next-revision
3155 vc-annotate-parent-file newrev))
3156 (setq revspec (1- revspec)))
3158 (message "Cannot increment %d revisions from revision %s"
3159 revspeccopy vc-annotate-parent-rev)))
3160 ((and (integerp revspec) (< revspec 0))
3161 (setq newrev vc-annotate-parent-rev)
3162 (while (and (< revspec 0) newrev)
3163 (setq newrev (vc-call-backend vc-annotate-backend 'previous-revision
3164 vc-annotate-parent-file newrev))
3165 (setq revspec (1+ revspec)))
3167 (message "Cannot decrement %d revisions from revision %s"
3168 (- 0 revspeccopy) vc-annotate-parent-rev)))
3169 ((stringp revspec) (setq newrev revspec))
3170 (t (error "Invalid argument to vc-annotate-warp-revision")))
3172 (vc-annotate vc-annotate-parent-file newrev
3173 vc-annotate-parent-display-mode
3175 ;; Pass the current line so that vc-annotate will
3176 ;; place the point in the line.
3177 (min oldline (progn (goto-char (point-max))
3179 (line-number-at-pos))))))))
3181 (defun vc-annotate-compcar (threshold a-list)
3182 "Test successive cons cells of A-LIST against THRESHOLD.
3183 Return the first cons cell with a car that is not less than THRESHOLD,
3184 nil if no such cell exists."
3186 (tmp-cons (car a-list)))
3187 (while (and tmp-cons (< (car tmp-cons) threshold))
3188 (setq tmp-cons (car (nthcdr i a-list)))
3190 tmp-cons)) ; Return the appropriate value
3192 (defun vc-annotate-convert-time (time)
3193 "Convert a time value to a floating-point number of days.
3194 The argument TIME is a list as returned by `current-time' or
3195 `encode-time', only the first two elements of that list are considered."
3196 (/ (+ (* (float (car time)) (lsh 1 16)) (cadr time)) 24 3600))
3198 (defun vc-annotate-difference (&optional offset)
3199 "Return the time span in days to the next annotation.
3200 This calls the backend function annotate-time, and returns the
3201 difference in days between the time returned and the current time,
3202 or OFFSET if present."
3203 (let ((next-time (vc-annotate-get-time-set-line-props)))
3206 (vc-call-backend vc-annotate-backend 'annotate-current-time))
3209 (defun vc-default-annotate-current-time (backend)
3210 "Return the current time, encoded as fractional days."
3211 (vc-annotate-convert-time (current-time)))
3213 (defvar vc-annotate-offset nil)
3215 (defun vc-annotate-display (ratio &optional offset)
3216 "Highlight `vc-annotate' output in the current buffer.
3217 RATIO, is the expansion that should be applied to `vc-annotate-color-map'.
3218 The annotations are relative to the current time, unless overridden by OFFSET."
3219 (when (/= ratio 1.0)
3220 (set (make-local-variable 'vc-annotate-color-map)
3221 (mapcar (lambda (elem) (cons (* (car elem) ratio) (cdr elem)))
3222 vc-annotate-color-map)))
3223 (set (make-local-variable 'vc-annotate-offset) offset)
3226 (defun vc-annotate-lines (limit)
3227 (while (< (point) limit)
3228 (let ((difference (vc-annotate-difference vc-annotate-offset))
3230 (end (progn (forward-line 1) (point))))
3232 (let* ((color (or (vc-annotate-compcar difference vc-annotate-color-map)
3233 (cons nil vc-annotate-very-old-color)))
3234 ;; substring from index 1 to remove any leading `#' in the name
3235 (face-name (concat "vc-annotate-face-"
3237 (substring (cdr color) 0 1) "#")
3238 (substring (cdr color) 1)
3240 ;; Make the face if not done.
3241 (face (or (intern-soft face-name)
3242 (let ((tmp-face (make-face (intern face-name))))
3243 (set-face-foreground tmp-face (cdr color))
3244 (when vc-annotate-background
3245 (set-face-background tmp-face
3246 vc-annotate-background))
3247 tmp-face)))) ; Return the face
3248 (put-text-property start end 'face face)))))
3249 ;; Pretend to font-lock there were no matches.
3253 ;; These things should probably be generally available
3255 (defun vc-file-tree-walk (dirname func &rest args)
3256 "Walk recursively through DIRNAME.
3257 Invoke FUNC f ARGS on each VC-managed file f underneath it."
3258 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
3259 (message "Traversing directory %s...done" dirname))
3261 (defun vc-file-tree-walk-internal (file func args)
3262 (if (not (file-directory-p file))
3263 (when (vc-backend file) (apply func file args))
3264 (message "Traversing directory %s..." (abbreviate-file-name file))
3265 (let ((dir (file-name-as-directory file)))
3268 (string-equal f ".")
3269 (string-equal f "..")
3270 (member f vc-directory-exclusion-list)
3271 (let ((dirf (expand-file-name f dir)))
3273 (file-symlink-p dirf) ;; Avoid possible loops.
3274 (vc-file-tree-walk-internal dirf func args)))))
3275 (directory-files dir)))))
3279 ;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
3281 ;; These may be useful to anyone who has to debug or extend the package.
3282 ;; (Note that this information corresponds to versions 5.x. Some of it
3283 ;; might have been invalidated by the additions to support branching
3284 ;; and RCS keyword lookup. AS, 1995/03/24)
3286 ;; A fundamental problem in VC is that there are time windows between
3287 ;; vc-next-action's computations of the file's version-control state and
3288 ;; the actions that change it. This is a window open to lossage in a
3289 ;; multi-user environment; someone else could nip in and change the state
3290 ;; of the master during it.
3292 ;; The performance problem is that rlog/prs calls are very expensive; we want
3293 ;; to avoid them as much as possible.
3297 ;; The performance problem, it turns out, simplifies in practice to the
3298 ;; problem of making vc-state fast. The two other functions that call
3299 ;; prs/rlog will not be so commonly used that the slowdown is a problem; one
3300 ;; makes snapshots, the other deletes the calling user's last change in the
3303 ;; The race condition implies that we have to either (a) lock the master
3304 ;; during the entire execution of vc-next-action, or (b) detect and
3305 ;; recover from errors resulting from dispatch on an out-of-date state.
3307 ;; Alternative (a) appears to be infeasible. The problem is that we can't
3308 ;; guarantee that the lock will ever be removed. Suppose a user starts a
3309 ;; checkin, the change message buffer pops up, and the user, having wandered
3310 ;; off to do something else, simply forgets about it?
3312 ;; Alternative (b), on the other hand, works well with a cheap way to speed up
3313 ;; vc-state. Usually, if a file is registered, we can read its locked/
3314 ;; unlocked state and its current owner from its permissions.
3316 ;; This shortcut will fail if someone has manually changed the workfile's
3317 ;; permissions; also if developers are munging the workfile in several
3318 ;; directories, with symlinks to a master (in this latter case, the
3319 ;; permissions shortcut will fail to detect a lock asserted from another
3322 ;; Note that these cases correspond exactly to the errors which could happen
3323 ;; because of a competing checkin/checkout race in between two instances of
3326 ;; For VC's purposes, a workfile/master pair may have the following states:
3328 ;; A. Unregistered. There is a workfile, there is no master.
3330 ;; B. Registered and not locked by anyone.
3332 ;; C. Locked by calling user and unchanged.
3334 ;; D. Locked by the calling user and changed.
3336 ;; E. Locked by someone other than the calling user.
3338 ;; This makes for 25 states and 20 error conditions. Here's the matrix:
3340 ;; VC's idea of state
3342 ;; V Actual state RCS action SCCS action Effect
3344 ;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
3345 ;; B 5 . 6 7 8 co -l get -e checkout
3346 ;; C 9 10 . 11 12 co -u unget; get revert
3347 ;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
3348 ;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
3350 ;; All commands take the master file name as a last argument (not shown).
3352 ;; In the discussion below, a "self-race" is a pathological situation in
3353 ;; which VC operations are being attempted simultaneously by two or more
3354 ;; Emacsen running under the same username.
3356 ;; The vc-next-action code has the following windows:
3359 ;; Between the check for existence of a master file and the call to
3360 ;; admin/checkin in vc-buffer-admin (apparent state A). This window may
3361 ;; never close if the initial-comment feature is on.
3364 ;; Between the call to vc-workfile-unchanged-p in and the immediately
3365 ;; following revert (apparent state C).
3368 ;; Between the call to vc-workfile-unchanged-p in and the following
3369 ;; checkin (apparent state D). This window may never close.
3372 ;; Between the unlock and the immediately following checkout during a
3373 ;; revert operation (apparent state C). Included in window Q.
3376 ;; Between vc-state and the following checkout (apparent state B).
3379 ;; Between vc-state and the following revert (apparent state C).
3380 ;; Includes windows Q and S.
3383 ;; Between vc-state and the following checkin (apparent state
3384 ;; D). This window may never be closed if the user fails to complete the
3385 ;; checkin message. Includes window R.
3388 ;; Between vc-state and the following steal-lock (apparent
3389 ;; state E). This window may never close if the user fails to complete
3390 ;; the steal-lock message. Includes window X.
3393 ;; Between the unlock and the immediately following re-lock during a
3394 ;; steal-lock operation (apparent state E). This window may never close
3395 ;; if the user fails to complete the steal-lock message.
3399 ;; Apparent state A ---
3401 ;; 1. File looked unregistered but is actually registered and not locked.
3403 ;; Potential cause: someone else's admin during window P, with
3404 ;; caller's admin happening before their checkout.
3406 ;; RCS: Prior to version 5.6.4, ci fails with message
3407 ;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
3408 ;; ci -i option and the message is "<file>,v: already exists".
3409 ;; SCCS: admin will fail with error (ad19).
3411 ;; We can let these errors be passed up to the user.
3413 ;; 2. File looked unregistered but is actually locked by caller, unchanged.
3415 ;; Potential cause: self-race during window P.
3417 ;; RCS: Prior to version 5.6.4, reverts the file to the last saved
3418 ;; version and unlocks it. From 5.6.4 onwards, VC uses the new
3419 ;; ci -i option, failing with message "<file>,v: already exists".
3420 ;; SCCS: will fail with error (ad19).
3422 ;; Either of these consequences is acceptable.
3424 ;; 3. File looked unregistered but is actually locked by caller, changed.
3426 ;; Potential cause: self-race during window P.
3428 ;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
3429 ;; a delta with a null change comment (the -t- switch will be
3430 ;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
3431 ;; failing with message "<file>,v: already exists".
3432 ;; SCCS: will fail with error (ad19).
3434 ;; 4. File looked unregistered but is locked by someone else.
3436 ;; Potential cause: someone else's admin during window P, with
3437 ;; caller's admin happening *after* their checkout.
3439 ;; RCS: Prior to version 5.6.4, ci fails with a
3440 ;; "no lock set by <user>" message. From 5.6.4 onwards,
3441 ;; VC uses the new ci -i option, failing with message
3442 ;; "<file>,v: already exists".
3443 ;; SCCS: will fail with error (ad19).
3445 ;; We can let these errors be passed up to the user.
3447 ;; Apparent state B ---
3449 ;; 5. File looked registered and not locked, but is actually unregistered.
3451 ;; Potential cause: master file got nuked during window P.
3453 ;; RCS: will fail with "RCS/<file>: No such file or directory"
3454 ;; SCCS: will fail with error ut4.
3456 ;; We can let these errors be passed up to the user.
3458 ;; 6. File looked registered and not locked, but is actually locked by the
3459 ;; calling user and unchanged.
3461 ;; Potential cause: self-race during window T.
3463 ;; RCS: in the same directory as the previous workfile, co -l will fail
3464 ;; with "co error: writable foo exists; checkout aborted". In any other
3465 ;; directory, checkout will succeed.
3466 ;; SCCS: will fail with ge17.
3468 ;; Either of these consequences is acceptable.
3470 ;; 7. File looked registered and not locked, but is actually locked by the
3471 ;; calling user and changed.
3475 ;; 8. File looked registered and not locked, but is actually locked by another
3478 ;; Potential cause: someone else checks it out during window T.
3480 ;; RCS: co error: revision 1.3 already locked by <user>
3481 ;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
3483 ;; We can let these errors be passed up to the user.
3485 ;; Apparent state C ---
3487 ;; 9. File looks locked by calling user and unchanged, but is unregistered.
3491 ;; 10. File looks locked by calling user and unchanged, but is actually not
3494 ;; Potential cause: a self-race in window U, or by the revert's
3495 ;; landing during window X of some other user's steal-lock or window S
3496 ;; of another user's revert.
3498 ;; RCS: succeeds, refreshing the file from the identical version in
3500 ;; SCCS: fails with error ut4 (p file nonexistent).
3502 ;; Either of these consequences is acceptable.
3504 ;; 11. File is locked by calling user. It looks unchanged, but is actually
3507 ;; Potential cause: the file would have to be touched by a self-race
3510 ;; The revert will succeed, removing whatever changes came with
3511 ;; the touch. It is theoretically possible that work could be lost.
3513 ;; 12. File looks like it's locked by the calling user and unchanged, but
3514 ;; it's actually locked by someone else.
3516 ;; Potential cause: a steal-lock in window V.
3518 ;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
3519 ;; SCCS: fails with error un2
3521 ;; We can pass these errors up to the user.
3523 ;; Apparent state D ---
3525 ;; 13. File looks like it's locked by the calling user and changed, but it's
3526 ;; actually unregistered.
3528 ;; Potential cause: master file got nuked during window P.
3530 ;; RCS: Prior to version 5.6.4, checks in the user's version as an
3531 ;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
3532 ;; option, failing with message "no such file or directory".
3533 ;; SCCS: will fail with error ut4.
3535 ;; This case is kind of nasty. Under RCS prior to version 5.6.4,
3536 ;; VC may fail to detect the loss of previous version information.
3538 ;; 14. File looks like it's locked by the calling user and changed, but it's
3539 ;; actually unlocked.
3541 ;; Potential cause: self-race in window V, or the checkin happening
3542 ;; during the window X of someone else's steal-lock or window S of
3543 ;; someone else's revert.
3545 ;; RCS: ci will fail with "no lock set by <user>".
3546 ;; SCCS: delta will fail with error ut4.
3548 ;; 15. File looks like it's locked by the calling user and changed, but it's
3549 ;; actually locked by the calling user and unchanged.
3551 ;; Potential cause: another self-race --- a whole checkin/checkout
3552 ;; sequence by the calling user would have to land in window R.
3554 ;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
3555 ;; RCS: reverts to the file state as of the second user's checkin, leaving
3556 ;; the file unlocked.
3558 ;; It is theoretically possible that work could be lost under RCS.
3560 ;; 16. File looks like it's locked by the calling user and changed, but it's
3561 ;; actually locked by a different user.
3563 ;; RCS: ci error: no lock set by <user>
3564 ;; SCCS: unget will fail with error un2
3566 ;; We can pass these errors up to the user.
3568 ;; Apparent state E ---
3570 ;; 17. File looks like it's locked by some other user, but it's actually
3575 ;; 18. File looks like it's locked by some other user, but it's actually
3578 ;; Potential cause: someone released a lock during window W.
3580 ;; RCS: The calling user will get the lock on the file.
3581 ;; SCCS: unget -n will fail with cm4.
3583 ;; Either of these consequences will be OK.
3585 ;; 19. File looks like it's locked by some other user, but it's actually
3586 ;; locked by the calling user and unchanged.
3588 ;; Potential cause: the other user relinquishing a lock followed by
3589 ;; a self-race, both in window W.
3591 ;; Under both RCS and SCCS, both unlock and lock will succeed, making
3592 ;; the sequence a no-op.
3594 ;; 20. File looks like it's locked by some other user, but it's actually
3595 ;; locked by the calling user and changed.
3601 ;; In order of decreasing severity:
3603 ;; Cases 11 and 15 are the only ones that potentially lose work.
3604 ;; They would require a self-race for this to happen.
3606 ;; Case 13 in RCS loses information about previous deltas, retaining
3607 ;; only the information in the current workfile. This can only happen
3608 ;; if the master file gets nuked in window P.
3610 ;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
3611 ;; no change comment in the master. This would require a self-race in
3612 ;; window P or R respectively.
3614 ;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
3616 ;; Unfortunately, it appears to me that no recovery is possible in these
3617 ;; cases. They don't yield error messages, so there's no way to tell that
3618 ;; a race condition has occurred.
3620 ;; All other cases don't change either the workfile or the master, and
3621 ;; trigger command errors which the user will see.
3623 ;; Thus, there is no explicit recovery code.
3625 ;; arch-tag: ca82c1de-3091-4e26-af92-460abc6213a6