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, or (at your option)
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; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; VC was initially designed and implemented by Eric S. Raymond
31 ;; <esr@thyrsus.com> in 1992. Over the years, many other people have
32 ;; contributed substantial amounts of work to VC. These include:
34 ;; Per Cederqvist <ceder@lysator.liu.se>
35 ;; Paul Eggert <eggert@twinsun.com>
36 ;; Sebastian Kremer <sk@thp.uni-koeln.de>
37 ;; Martin Lorentzson <martinl@gnu.org>
38 ;; Dave Love <fx@gnu.org>
39 ;; Stefan Monnier <monnier@cs.yale.edu>
40 ;; J.D. Smith <jdsmith@alum.mit.edu>
41 ;; Andre Spiegel <spiegel@gnu.org>
42 ;; Richard Stallman <rms@gnu.org>
43 ;; Thien-Thi Nguyen <ttn@gnu.org>
45 ;; In July 2007 ESR returned and redesigned the mode to cope better
46 ;; with modern version-control systems that do commits by fileset
47 ;; rather than per individual file.
49 ;; Features in the new version:
50 ;; * Key commands (vc-next-action = C-x v v, vc-print-log = C-x v l, vc-revert
51 ;; = C-x v u, vc-rollback = C-x v c, vc-diff = C-x v =, vc-update = C-x v +)
52 ;; now operate on filesets rather than individual files.
53 ;; * The fileset for a command is either (a) all marked files in VC-dired
54 ;; mode, (b) the currently visited file if it's under version control,
55 ;; or (c) the current directory if the visited buffer is not under
56 ;; version control and a wildcarding-enable flag has been set.
58 ;; If you maintain a client of the mode or customize it in your .emacs,
59 ;; note that some backend functions which formerly took single file arguments
60 ;; now take a list of files. These include: register, checkin, print-log,
61 ;; rollback, and diff.
65 ;; This mode is fully documented in the Emacs user's manual.
67 ;; Supported version-control systems presently include CVS, RCS, GNU
68 ;; Arch, Subversion, Bzr, Git, Mercurial, Meta-CVS, Monotone and SCCS
69 ;; (or its free replacement, CSSC).
71 ;; Some features will not work with old RCS versions. Where
72 ;; appropriate, VC finds out which version you have, and allows or
73 ;; disallows those features (stealing locks, for example, works only
74 ;; from 5.6.2 onwards).
75 ;; Even initial checkins will fail if your RCS version is so old that ci
76 ;; doesn't understand -t-; this has been known to happen to people running
79 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
81 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
82 ;; to be installed somewhere on Emacs's path for executables.
84 ;; If your site uses the ChangeLog convention supported by Emacs, the
85 ;; function `log-edit-comment-to-change-log' could prove a useful checkin hook,
86 ;; although you might prefer to use C-c C-a (i.e. `log-edit-insert-changelog')
87 ;; from the commit buffer instead or to set `log-edit-setup-invert'.
89 ;; The vc code maintains some internal state in order to reduce expensive
90 ;; version-control operations to a minimum. Some names are only computed
91 ;; once. If you perform version control operations with the backend while
92 ;; vc's back is turned, or move/rename master files while vc is running,
93 ;; vc may get seriously confused. Don't do these things!
95 ;; Developer's notes on some concurrency issues are included at the end of
98 ;; ADDING SUPPORT FOR OTHER BACKENDS
100 ;; VC can use arbitrary version control systems as a backend. To add
101 ;; support for a new backend named SYS, write a library vc-sys.el that
102 ;; contains functions of the form `vc-sys-...' (note that SYS is in lower
103 ;; case for the function and library names). VC will use that library if
104 ;; you put the symbol SYS somewhere into the list of
105 ;; `vc-handled-backends'. Then, for example, if `vc-sys-registered'
106 ;; returns non-nil for a file, all SYS-specific versions of VC commands
107 ;; will be available for that file.
109 ;; VC keeps some per-file information in the form of properties (see
110 ;; vc-file-set/getprop in vc-hooks.el). The backend-specific functions
111 ;; do not generally need to be aware of these properties. For example,
112 ;; `vc-sys-working-revision' should compute the working revision and
113 ;; return it; it should not look it up in the property, and it needn't
114 ;; store it there either. However, if a backend-specific function does
115 ;; store a value in a property, that value takes precedence over any
116 ;; value that the generic code might want to set (check for uses of
117 ;; the macro `with-vc-properties' in vc.el).
119 ;; In the list of functions below, each identifier needs to be prepended
120 ;; with `vc-sys-'. Some of the functions are mandatory (marked with a
121 ;; `*'), others are optional (`-').
123 ;; BACKEND PROPERTIES
125 ;; * revision-granularity
127 ;; Takes no arguments. Returns either 'file or 'repository. Backends
128 ;; that return 'file have per-file revision numbering; backends
129 ;; that return 'repository have per-repository revision numbering,
130 ;; so a revision level implicitly identifies a changeset
132 ;; STATE-QUERYING FUNCTIONS
134 ;; * registered (file)
136 ;; Return non-nil if FILE is registered in this backend. Both this
137 ;; function as well as `state' should be careful to fail gracefully
138 ;; in the event that the backend executable is absent. It is
139 ;; preferable that this function's body is autoloaded, that way only
140 ;; calling vc-registered does not cause the backend to be loaded
141 ;; (all the vc-FOO-registered functions are called to try to find
142 ;; the controlling backend for FILE.
146 ;; Return the current version control state of FILE. For a list of
147 ;; possible values, see `vc-state'. This function should do a full and
148 ;; reliable state computation; it is usually called immediately after
149 ;; C-x v v. If you want to use a faster heuristic when visiting a
150 ;; file, put that into `state-heuristic' below.
152 ;; - state-heuristic (file)
154 ;; If provided, this function is used to estimate the version control
155 ;; state of FILE at visiting time. It should be considerably faster
156 ;; than the implementation of `state'. For a list of possible values,
157 ;; see the doc string of `vc-state'.
161 ;; If provided, this function is used to find the version control
162 ;; state of as many files as possible in DIR, and all subdirectories
163 ;; of DIR, in a fast way; it is used to avoid expensive indivitual
164 ;; vc-state calls. The function should not return anything, but
165 ;; rather store the files' states into the corresponding properties.
166 ;; Two properties are required: `vc-backend' and `vc-state'. (Note:
167 ;; in older versions this method was not required to recurse into
170 ;; - dir-status (dir update-function status-buffer)
172 ;; Produce RESULT: a list of conses of the form (file . vc-state)
173 ;; for the files in DIR. If a command needs to be run to compute
174 ;; this list, it should be run asynchronously. When RESULT is
175 ;; computed, it should be passed back by doing:
176 ;; (funcall UPDATE-FUNCTION RESULT STATUS-BUFFER)
177 ;; Return the buffer used for the asynchronous call. This buffer
178 ;; is used to kill the status update process on demand.
179 ;; This function is used by vc-status, a replacement for vc-dired.
180 ;; vc-status is still under development, and is NOT feature
181 ;; complete. As such, the requirements for this function might
183 ;; This is a replacement for dir-state.
185 ;; * working-revision (file)
187 ;; Return the working revision of FILE. This is the revision fetched
188 ;; by the last checkout or upate, not necessarily the same thing as the
189 ;; head or tip revision. Should return "0" for a file added but not yet
192 ;; - latest-on-branch-p (file)
194 ;; Return non-nil if the working revision of FILE is the latest revision
195 ;; on its branch (many VCSes call this the 'tip' or 'head' revision).
196 ;; The default implementation always returns t, which means that
197 ;; working with non-current revisions is not supported by default.
199 ;; * checkout-model (file)
201 ;; Indicate whether FILE needs to be "checked out" before it can be
202 ;; edited. See `vc-checkout-model' for a list of possible values.
204 ;; - workfile-unchanged-p (file)
206 ;; Return non-nil if FILE is unchanged from the working revision.
207 ;; This function should do a brief comparison of FILE's contents
208 ;; with those of the repository master of the working revision. If
209 ;; the backend does not have such a brief-comparison feature, the
210 ;; default implementation of this function can be used, which
211 ;; delegates to a full vc-BACKEND-diff. (Note that vc-BACKEND-diff
212 ;; must not run asynchronously in this case, see variable
213 ;; `vc-disable-async-diff'.)
215 ;; - mode-line-string (file)
217 ;; If provided, this function should return the VC-specific mode
218 ;; line string for FILE. The returned string should have a
219 ;; `help-echo' property which is the text to be displayed as a
220 ;; tooltip when the mouse hovers over the VC entry on the mode-line.
221 ;; The default implementation deals well with all states that
222 ;; `vc-state' can return.
224 ;; - dired-state-info (file)
226 ;; Translate the `vc-state' property of FILE into a string that can be
227 ;; used in a vc-dired buffer. The default implementation deals well
228 ;; with all states that `vc-state' can return.
230 ;; STATE-CHANGING FUNCTIONS
232 ;; * create-repo (backend)
234 ;; Create an empty repository in the current directory and initialize
235 ;; it so VC mode can add files to it. For file-oriented systems, this
236 ;; need do no more than create a subdirectory with the right name.
238 ;; * register (files &optional rev comment)
240 ;; Register FILES in this backend. Optionally, an initial revision REV
241 ;; and an initial description of the file, COMMENT, may be specified,
242 ;; but it is not guaranteed that the backend will do anything with this.
243 ;; The implementation should pass the value of vc-register-switches
244 ;; to the backend command. (Note: in older versions of VC, this
245 ;; command took a single file argument and not a list.)
247 ;; - init-revision (file)
249 ;; The initial revision to use when registering FILE if one is not
250 ;; specified by the user. If not provided, the variable
251 ;; vc-default-init-revision is used instead.
253 ;; - responsible-p (file)
255 ;; Return non-nil if this backend considers itself "responsible" for
256 ;; FILE, which can also be a directory. This function is used to find
257 ;; out what backend to use for registration of new files and for things
258 ;; like change log generation. The default implementation always
261 ;; - could-register (file)
263 ;; Return non-nil if FILE could be registered under this backend. The
264 ;; default implementation always returns t.
266 ;; - receive-file (file rev)
268 ;; Let this backend "receive" a file that is already registered under
269 ;; another backend. The default implementation simply calls `register'
270 ;; for FILE, but it can be overridden to do something more specific,
271 ;; e.g. keep revision numbers consistent or choose editing modes for
272 ;; FILE that resemble those of the other backend.
274 ;; - unregister (file)
276 ;; Unregister FILE from this backend. This is only needed if this
277 ;; backend may be used as a "more local" backend for temporary editing.
279 ;; * checkin (files rev comment)
281 ;; Commit changes in FILES to this backend. If REV is non-nil, that
282 ;; should become the new revision number (not all backends do
283 ;; anything with it). COMMENT is used as a check-in comment. The
284 ;; implementation should pass the value of vc-checkin-switches to
285 ;; the backend command. (Note: in older versions of VC, this
286 ;; command took a single file argument and not a list.)
288 ;; * find-revision (file rev buffer)
290 ;; Fetch revision REV of file FILE and put it into BUFFER.
291 ;; If REV is the empty string, fetch the head of the trunk.
292 ;; The implementation should pass the value of vc-checkout-switches
293 ;; to the backend command.
295 ;; * checkout (file &optional editable rev)
297 ;; Check out revision REV of FILE into the working area. If EDITABLE
298 ;; is non-nil, FILE should be writable by the user and if locking is
299 ;; used for FILE, a lock should also be set. If REV is non-nil, that
300 ;; is the revision to check out (default is the working revision).
301 ;; If REV is t, that means to check out the head of the current branch;
302 ;; if it is the empty string, check out the head of the trunk.
303 ;; The implementation should pass the value of vc-checkout-switches
304 ;; to the backend command.
306 ;; * revert (file &optional contents-done)
308 ;; Revert FILE back to the working revision. If optional
309 ;; arg CONTENTS-DONE is non-nil, then the contents of FILE have
310 ;; already been reverted from a version backup, and this function
311 ;; only needs to update the status of FILE within the backend.
313 ;; - rollback (files)
315 ;; Remove the tip revision of each of FILES from the repository. If
316 ;; this function is not provided, trying to cancel a revision is
317 ;; caught as an error. (Most backends don't provide it.) (Also
318 ;; note that older versions of this backend command were called
319 ;; 'cancel-version' and took a single file arg, not a list of
322 ;; - merge (file rev1 rev2)
324 ;; Merge the changes between REV1 and REV2 into the current working file.
326 ;; - merge-news (file)
328 ;; Merge recent changes from the current branch into FILE.
330 ;; - steal-lock (file &optional revision)
332 ;; Steal any lock on the working revision of FILE, or on REVISION if
333 ;; that is provided. This function is only needed if locking is
334 ;; used for files under this backend, and if files can indeed be
335 ;; locked by other users.
337 ;; - modify-change-comment (files rev comment)
339 ;; Modify the change comments associated with the files at the
340 ;; given revision. This is optional, many backends do not support it.
344 ;; * print-log (files &optional buffer)
346 ;; Insert the revision log for FILES into BUFFER, or the *vc* buffer
347 ;; if BUFFER is nil. (Note: older versions of this function expected
348 ;; only a single file argument.)
350 ;; - log-view-mode ()
352 ;; Mode to use for the output of print-log. This defaults to
353 ;; `log-view-mode' and is expected to be changed (if at all) to a derived
354 ;; mode of `log-view-mode'.
356 ;; - show-log-entry (revision)
358 ;; If provided, search the log entry for REVISION in the current buffer,
359 ;; and make sure it is displayed in the buffer's window. The default
360 ;; implementation of this function works for RCS-style logs.
364 ;; Remove all non-comment information from the output of print-log.
366 ;; - logentry-check ()
368 ;; If defined, this function is run to find out whether the user
369 ;; entered a valid log entry for check-in. The log entry is in the
370 ;; current buffer, and if it is not a valid one, the function should
373 ;; - comment-history (file)
375 ;; Return a string containing all log entries that were made for FILE.
376 ;; This is used for transferring a file from one backend to another,
377 ;; retaining comment information. The default implementation of this
378 ;; function does this by calling print-log and then wash-log, and
379 ;; returning the resulting buffer contents as a string.
381 ;; - update-changelog (files)
383 ;; Using recent log entries, create ChangeLog entries for FILES, or for
384 ;; all files at or below the default-directory if FILES is nil. The
385 ;; default implementation runs rcs2log, which handles RCS- and
388 ;; * diff (files &optional rev1 rev2 buffer)
390 ;; Insert the diff for FILE into BUFFER, or the *vc-diff* buffer if
391 ;; BUFFER is nil. If REV1 and REV2 are non-nil, report differences
392 ;; from REV1 to REV2. If REV1 is nil, use the working revision (as
393 ;; found in the repository) as the older revision; if REV2 is nil,
394 ;; use the current working-copy contents as the newer revision. This
395 ;; function should pass the value of (vc-switches BACKEND 'diff) to
396 ;; the backend command. It should return a status of either 0 (no
397 ;; differences found), or 1 (either non-empty diff or the diff is
398 ;; run asynchronously).
400 ;; - revision-completion-table (files)
402 ;; Return a completion table for existing revisions of FILES.
403 ;; The default is to not use any completion table.
405 ;; - annotate-command (file buf &optional rev)
407 ;; If this function is provided, it should produce an annotated display
408 ;; of FILE in BUF, relative to revision REV. Annotation means each line
409 ;; of FILE displayed is prefixed with version information associated with
410 ;; its addition (deleted lines leave no history) and that the text of the
411 ;; file is fontified according to age.
413 ;; - annotate-time ()
415 ;; Only required if `annotate-command' is defined for the backend.
416 ;; Return the time of the next line of annotation at or after point,
417 ;; as a floating point fractional number of days. The helper
418 ;; function `vc-annotate-convert-time' may be useful for converting
419 ;; multi-part times as returned by `current-time' and `encode-time'
420 ;; to this format. Return nil if no more lines of annotation appear
421 ;; in the buffer. You can safely assume that point is placed at the
422 ;; beginning of each line, starting at `point-min'. The buffer that
423 ;; point is placed in is the Annotate output, as defined by the
424 ;; relevant backend. This function also affects how much of the line
425 ;; is fontified; where it leaves point is where fontification begins.
427 ;; - annotate-current-time ()
429 ;; Only required if `annotate-command' is defined for the backend,
430 ;; AND you'd like the current time considered to be anything besides
431 ;; (vc-annotate-convert-time (current-time)) -- i.e. the current
432 ;; time with hours, minutes, and seconds included. Probably safe to
433 ;; ignore. Return the current-time, in units of fractional days.
435 ;; - annotate-extract-revision-at-line ()
437 ;; Only required if `annotate-command' is defined for the backend.
438 ;; Invoked from a buffer in vc-annotate-mode, return the revision
439 ;; corresponding to the current line, or nil if there is no revision
440 ;; corresponding to the current line.
444 ;; - create-snapshot (dir name branchp)
446 ;; Take a snapshot of the current state of files under DIR and name it
447 ;; NAME. This should make sure that files are up-to-date before
448 ;; proceeding with the action. DIR can also be a file and if BRANCHP
449 ;; is specified, NAME should be created as a branch and DIR should be
450 ;; checked out under this new branch. The default implementation does
451 ;; not support branches but does a sanity check, a tree traversal and
452 ;; for each file calls `assign-name'.
454 ;; - assign-name (file name)
456 ;; Give name NAME to the working revision of FILE, assuming it is
457 ;; up-to-date. Only used by the default version of `create-snapshot'.
459 ;; - retrieve-snapshot (dir name update)
461 ;; Retrieve a named snapshot of all registered files at or below DIR.
462 ;; If UPDATE is non-nil, then update buffers of any files in the
463 ;; snapshot that are currently visited. The default implementation
464 ;; does a sanity check whether there aren't any uncommitted changes at
465 ;; or below DIR, and then performs a tree walk, using the `checkout'
466 ;; function to retrieve the corresponding revisions.
472 ;; Return DIR's "root" directory, that is, a parent directory of
473 ;; DIR for which the same backend as used for DIR applies. If no
474 ;; such parent exists, this function should return DIR.
476 ;; - make-version-backups-p (file)
478 ;; Return non-nil if unmodified repository revisions of FILE should be
479 ;; backed up locally. If this is done, VC can perform `diff' and
480 ;; `revert' operations itself, without calling the backend system. The
481 ;; default implementation always returns nil.
483 ;; - repository-hostname (dirname)
485 ;; Return the hostname that the backend will have to contact
486 ;; in order to operate on a file in DIRNAME. If the return value
487 ;; is nil, it means that the repository is local.
488 ;; This function is used in `vc-stay-local-p' which backends can use
489 ;; for their convenience.
491 ;; - previous-revision (file rev)
493 ;; Return the revision number that precedes REV for FILE, or nil if no such
496 ;; - next-revision (file rev)
498 ;; Return the revision number that follows REV for FILE, or nil if no such
501 ;; - check-headers ()
503 ;; Return non-nil if the current buffer contains any version headers.
505 ;; - clear-headers ()
507 ;; In the current buffer, reset all version headers to their unexpanded
508 ;; form. This function should be provided if the state-querying code
509 ;; for this backend uses the version headers to determine the state of
510 ;; a file. This function will then be called whenever VC changes the
511 ;; version control state in such a way that the headers would give
512 ;; wrong information.
514 ;; - delete-file (file)
516 ;; Delete FILE and mark it as deleted in the repository. If this
517 ;; function is not provided, the command `vc-delete-file' will
520 ;; - rename-file (old new)
522 ;; Rename file OLD to NEW, both in the working area and in the
523 ;; repository. If this function is not provided, the renaming
524 ;; will be done by (vc-delete-file old) and (vc-register new).
526 ;; - find-file-hook ()
528 ;; Operation called in current buffer when opening a file. This can
529 ;; be used by the backend to setup some local variables it might need.
531 ;; - find-file-not-found-hook ()
533 ;; Operation called in current buffer when opening a non-existing file.
534 ;; By default, this asks the user if she wants to check out the file.
538 ;; Return a menu keymap, the items in the keymap will appear at the
539 ;; end of the Version Control menu. The goal is to allow backends
540 ;; to specify extra menu items that appear in the VC menu. This way
541 ;; you can provide menu entries for functionality that is specific
542 ;; to your backend and which does not map to any of the VC generic
545 ;; - extra-status-menu ()
547 ;; Return a menu keymap, the items in the keymap will appear at the
548 ;; end of the VC Status menu. The goal is to allow backends to
549 ;; specify extra menu items that appear in the VC Status menu. This
550 ;; makes it possible to provide menu entries for functionality that
551 ;; is specific to a backend and which does not map to any of the VC
556 ;; - vc-update/vc-merge should deal with VC systems that don't
557 ;; update/merge on a file basis, but on a whole repository basis.
559 ;; - the backend sometimes knows when a file it opens has been marked
560 ;; by the VCS as having a "conflict". Find a way to pass this info -
561 ;; to VC so that it can turn on smerge-mode when opening such a
564 ;; - the *VC-log* buffer needs font-locking.
566 ;; - make it easier to write logs, maybe C-x 4 a should add to the log
567 ;; buffer if there's one instead of the ChangeLog.
569 ;; - make vc-state for all backends return 'unregistered instead of
570 ;; nil for unregistered files, then update vc-next-action.
572 ;; - add a generic mechanism for remembering the current branch names,
573 ;; display the branch name in the mode-line. Replace
574 ;; vc-cvs-sticky-tag with that.
576 ;; - vc-register should register a fileset at a time. The backends
577 ;; already support this, only the front-end needs to be change to
578 ;; handle multiple files at a time.
580 ;; - add a mechanism to for ignoring files.
582 ;; - deal with push/pull operations.
584 ;; - decide if vc-status should replace vc-dired.
586 ;; - vc-status needs mouse bindings and some color bling.
588 ;; - vc-status-header should be made backend specific.
590 ;; - vc-status needs to show missing files. It probably needs to have
591 ;; another state for those files. The user might want to restore
592 ;; them, or remove them from the VCS. C-x v v might also need
595 ;; - vc-status toolbar needs more icons.
597 ;; - vc-status: refresh should not completely wipe out the current
598 ;; contents of the vc-status buffer.
600 ;; - vc-diff, vc-annotate, etc. need to deal better with unregistered
601 ;; files. Now that unregistered and ignored files are shown in
602 ;; vc-dired/vc-status, it is possible that these commands are called
603 ;; for unregistered/ignored files.
605 ;; - "snapshots" should be renamed to "branches", and thoroughly reworked.
607 ;; - do not default to RCS anymore when the current directory is not
608 ;; controlled by any VCS and the user does C-x v v
620 (require 'dired
) ; for dired-map-over-marks macro
621 (require 'dired-aux
)) ; for dired-kill-{line,tree}
623 (if (not (assoc 'vc-parent-buffer minor-mode-alist
))
624 (setq minor-mode-alist
625 (cons '(vc-parent-buffer vc-parent-buffer-name
)
628 ;; General customization
631 "Version-control system in Emacs."
634 (defcustom vc-suppress-confirm nil
635 "If non-nil, treat user as expert; suppress yes-no prompts on some things."
639 (defcustom vc-delete-logbuf-window t
640 "If non-nil, delete the *VC-log* buffer and window after each logical action.
641 If nil, bury that buffer instead.
642 This is most useful if you have multiple windows on a frame and would like to
643 preserve the setting."
647 (defcustom vc-initial-comment nil
648 "If non-nil, prompt for initial comment when a file is registered."
652 (defcustom vc-default-init-revision
"1.1"
653 "A string used as the default revision number when a new file is registered.
654 This can be overridden by giving a prefix argument to \\[vc-register]. This
655 can also be overridden by a particular VC backend."
660 (defcustom vc-command-messages nil
661 "If non-nil, display run messages from back-end commands."
665 (defcustom vc-checkin-switches nil
666 "A string or list of strings specifying extra switches for checkin.
667 These are passed to the checkin program by \\[vc-checkin]."
668 :type
'(choice (const :tag
"None" nil
)
669 (string :tag
"Argument String")
670 (repeat :tag
"Argument List"
675 (defcustom vc-checkout-switches nil
676 "A string or list of strings specifying extra switches for checkout.
677 These are passed to the checkout program by \\[vc-checkout]."
678 :type
'(choice (const :tag
"None" nil
)
679 (string :tag
"Argument String")
680 (repeat :tag
"Argument List"
685 (defcustom vc-register-switches nil
686 "A string or list of strings; extra switches for registering a file.
687 These are passed to the checkin program by \\[vc-register]."
688 :type
'(choice (const :tag
"None" nil
)
689 (string :tag
"Argument String")
690 (repeat :tag
"Argument List"
695 (defcustom vc-dired-listing-switches
"-al"
696 "Switches passed to `ls' for vc-dired. MUST contain the `l' option."
701 (defcustom vc-dired-recurse t
702 "If non-nil, show directory trees recursively in VC Dired."
707 (defcustom vc-dired-terse-display t
708 "If non-nil, show only locked or locally modified files in VC Dired."
713 (defcustom vc-diff-switches nil
714 "A string or list of strings specifying switches for diff under VC.
715 When running diff under a given BACKEND, VC concatenates the values of
716 `diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to
717 get the switches for that command. Thus, `vc-diff-switches' should
718 contain switches that are specific to version control, but not
719 specific to any particular backend."
720 :type
'(choice (const :tag
"None" nil
)
721 (string :tag
"Argument String")
722 (repeat :tag
"Argument List"
728 (defcustom vc-diff-knows-L nil
729 "*Indicates whether diff understands the -L option.
730 The value is either `yes', `no', or nil. If it is nil, VC tries
731 to use -L and sets this variable to remember whether it worked."
732 :type
'(choice (const :tag
"Work out" nil
) (const yes
) (const no
))
735 (defcustom vc-allow-async-revert nil
736 "Specifies whether the diff during \\[vc-revert] may be asynchronous.
737 Enabling this option means that you can confirm a revert operation even
738 if the local changes in the file have not been found and displayed yet."
739 :type
'(choice (const :tag
"No" nil
)
740 (const :tag
"Yes" t
))
745 (defcustom vc-checkout-hook nil
746 "Normal hook (list of functions) run after checking out a file.
752 (defcustom vc-annotate-display-mode
'fullscale
753 "Which mode to color the output of \\[vc-annotate] with by default."
754 :type
'(choice (const :tag
"By Color Map Range" nil
)
755 (const :tag
"Scale to Oldest" scale
)
756 (const :tag
"Scale Oldest->Newest" fullscale
)
757 (number :tag
"Specify Fractional Number of Days"
762 (defcustom vc-checkin-hook nil
763 "Normal hook (list of functions) run after commit or file checkin.
764 See also `log-edit-done-hook'."
766 :options
'(log-edit-comment-to-change-log)
770 (defcustom vc-before-checkin-hook nil
771 "Normal hook (list of functions) run before a commit or a file checkin.
776 (defcustom vc-logentry-check-hook nil
777 "Normal hook run by `vc-backend-logentry-check'.
778 Use this to impose your own rules on the entry in addition to any the
779 version control backend imposes itself."
783 ;; Annotate customization
784 (defcustom vc-annotate-color-map
785 (if (and (tty-display-color-p) (<= (display-color-cells) 8))
786 ;; A custom sorted TTY colormap
792 (string-equal (car x
) "white")
793 (string-equal (car x
) "black") ))
798 ((or (string-equal a
"red") (string-equal b
"blue")) t
)
799 ((or (string-equal b
"red") (string-equal a
"blue")) nil
)
800 ((string-equal a
"yellow") t
)
801 ((string-equal b
"yellow") nil
)
802 ((string-equal a
"cyan") t
)
803 ((string-equal b
"cyan") nil
)
804 ((string-equal a
"green") t
)
805 ((string-equal b
"green") nil
)
806 ((string-equal a
"magenta") t
)
807 ((string-equal b
"magenta") nil
)
808 (t (string< a b
))))))
810 (delta (/ (- 360. date
) (1- (length colors
)))))
814 (setq date
(+ date delta
)))) colors
))
815 ;; Normal colormap: hue stepped from 0-240deg, value=1., saturation=0.75
834 "Association list of age versus color, for \\[vc-annotate].
835 Ages are given in units of fractional days. Default is eighteen
836 steps using a twenty day increment, from red to blue. For TTY
837 displays with 8 or fewer colors, the default is red to blue with
838 all other colors between (excluding black and white)."
842 (defcustom vc-annotate-very-old-color
"#3F3FFF"
843 "Color for lines older than the current color range in \\[vc-annotate]]."
847 (defcustom vc-annotate-background
"black"
848 "Background color for \\[vc-annotate].
849 Default color is used if nil."
850 :type
'(choice (const :tag
"Default background" nil
) (color))
853 (defcustom vc-annotate-menu-elements
'(2 0.5 0.1 0.01)
854 "Menu elements for the mode-specific menu of VC-Annotate mode.
855 List of factors, used to expand/compress the time scale. See `vc-annotate'."
856 :type
'(repeat number
)
859 (defvar vc-annotate-mode-map
860 (let ((m (make-sparse-keymap)))
861 (define-key m
"A" 'vc-annotate-revision-previous-to-line
)
862 (define-key m
"D" 'vc-annotate-show-diff-revision-at-line
)
863 (define-key m
"f" 'vc-annotate-find-revision-at-line
)
864 (define-key m
"J" 'vc-annotate-revision-at-line
)
865 (define-key m
"L" 'vc-annotate-show-log-revision-at-line
)
866 (define-key m
"N" 'vc-annotate-next-revision
)
867 (define-key m
"P" 'vc-annotate-prev-revision
)
868 (define-key m
"W" 'vc-annotate-working-revision
)
869 (define-key m
"V" 'vc-annotate-toggle-annotation-visibility
)
871 "Local keymap used for VC-Annotate mode.")
873 ;; Header-insertion hair
875 (defcustom vc-static-header-alist
877 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
878 "*Associate static header string templates with file types.
879 A \%s in the template is replaced with the first string associated with
880 the file's version control type in `vc-header-alist'."
881 :type
'(repeat (cons :format
"%v"
882 (regexp :tag
"File Type")
883 (string :tag
"Header String")))
886 (defcustom vc-comment-alist
887 '((nroff-mode ".\\\"" ""))
888 "*Special comment delimiters for generating VC headers.
889 Add an entry in this list if you need to override the normal `comment-start'
890 and `comment-end' variables. This will only be necessary if the mode language
891 is sensitive to blank lines."
892 :type
'(repeat (list :format
"%v"
894 (string :tag
"Comment Start")
895 (string :tag
"Comment End")))
898 (defcustom vc-checkout-carefully
(= (user-uid) 0)
899 "*Non-nil means be extra-careful in checkout.
900 Verify that the file really is not locked
901 and that its contents match what the master file says."
904 (make-obsolete-variable 'vc-checkout-carefully
905 "the corresponding checks are always done now."
909 ;; Variables the user doesn't need to know about.
910 (defvar vc-log-operation nil
)
911 (defvar vc-log-after-operation-hook nil
)
913 ;; In a log entry buffer, this is a local variable
914 ;; that points to the buffer for which it was made
915 ;; (either a file, or a VC dired buffer).
916 (defvar vc-parent-buffer nil
)
917 (put 'vc-parent-buffer
'permanent-local t
)
918 (defvar vc-parent-buffer-name nil
)
919 (put 'vc-parent-buffer-name
'permanent-local t
)
921 (defvar vc-disable-async-diff nil
922 "VC sets this to t locally to disable some async diff operations.
923 Backends that offer asynchronous diffs should respect this variable
924 in their implementation of vc-BACKEND-diff.")
926 (defvar vc-log-fileset
)
927 (defvar vc-log-revision
)
929 (defvar vc-dired-mode nil
)
930 (make-variable-buffer-local 'vc-dired-mode
)
932 ;; File property caching
934 (defun vc-clear-context ()
935 "Clear all cached file properties."
937 (fillarray vc-file-prop-obarray
0))
939 (defmacro with-vc-properties
(files form settings
)
940 "Execute FORM, then maybe set per-file properties for FILES.
941 SETTINGS is an association list of property/value pairs. After
942 executing FORM, set those properties from SETTINGS that have not yet
943 been updated to their corresponding values."
945 `(let ((vc-touched-properties (list t
)))
947 (dolist (file ,files
)
948 (dolist (setting ,settings
)
949 (let ((property (car setting
)))
950 (unless (memq property vc-touched-properties
)
951 (put (intern file vc-file-prop-obarray
)
952 property
(cdr setting
))))))))
954 ;; Two macros for elisp programming
957 (defmacro with-vc-file
(file comment
&rest body
)
958 "Check out a writable copy of FILE if necessary, then execute BODY.
959 Check in FILE with COMMENT (a string) after BODY has been executed.
960 FILE is passed through `expand-file-name'; BODY executed within
961 `save-excursion'. If FILE is not under version control, or you are
962 using a locking version-control system and the file is locked by
963 somebody else, signal error."
964 (declare (debug t
) (indent 2))
965 (let ((filevar (make-symbol "file")))
966 `(let ((,filevar
(expand-file-name ,file
)))
967 (or (vc-backend ,filevar
)
968 (error "File not under version control: `%s'" file
))
969 (unless (vc-editable-p ,filevar
)
970 (let ((state (vc-state ,filevar
)))
972 (error "`%s' is locking `%s'" state
,filevar
)
973 (vc-checkout ,filevar t
))))
976 (vc-checkin (list ,filevar
) nil
,comment
))))
979 (defmacro edit-vc-file
(file comment
&rest body
)
980 "Edit FILE under version control, executing body.
981 Checkin with COMMENT after executing BODY.
982 This macro uses `with-vc-file', passing args to it.
983 However, before executing BODY, find FILE, and after BODY, save buffer."
984 (declare (debug t
) (indent 2))
985 (let ((filevar (make-symbol "file")))
986 `(let ((,filevar
(expand-file-name ,file
)))
989 (set-buffer (find-file-noselect ,filevar
))
993 ;; Common command execution logic to be used by backends
995 (defun vc-process-filter (p s
)
996 "An alternative output filter for async process P.
997 One difference with the default filter is that this inserts S after markers.
998 Another is that undo information is not kept."
999 (let ((buffer (process-buffer p
)))
1000 (when (buffer-live-p buffer
)
1001 (with-current-buffer buffer
1003 (let ((buffer-undo-list t
)
1004 (inhibit-read-only t
))
1005 (goto-char (process-mark p
))
1007 (set-marker (process-mark p
) (point))))))))
1009 (defun vc-setup-buffer (&optional buf
)
1010 "Prepare BUF for executing a VC command and make it current.
1011 BUF defaults to \"*vc*\", can be a string and will be created if necessary."
1012 (unless buf
(setq buf
"*vc*"))
1013 (let ((camefrom (current-buffer))
1014 (olddir default-directory
))
1015 (set-buffer (get-buffer-create buf
))
1016 (kill-all-local-variables)
1017 (set (make-local-variable 'vc-parent-buffer
) camefrom
)
1018 (set (make-local-variable 'vc-parent-buffer-name
)
1019 (concat " from " (buffer-name camefrom
)))
1020 (setq default-directory olddir
)
1021 (let ((buffer-undo-list t
)
1022 (inhibit-read-only t
))
1025 (defvar vc-sentinel-movepoint
) ;Dynamically scoped.
1027 (defun vc-process-sentinel (p s
)
1028 (let ((previous (process-get p
'vc-previous-sentinel
))
1029 (buf (process-buffer p
)))
1030 ;; Impatient users sometime kill "slow" buffers; check liveness
1031 ;; to avoid "error in process sentinel: Selecting deleted buffer".
1032 (when (buffer-live-p buf
)
1033 (if previous
(funcall previous p s
))
1034 (with-current-buffer buf
1035 (setq mode-line-process
1036 (let ((status (process-status p
)))
1037 ;; Leave mode-line uncluttered, normally.
1038 ;; (Let known any weirdness in-form-ally. ;-) --ttn
1039 (unless (eq 'exit status
)
1040 (format " (%s)" status
))))
1041 (let (vc-sentinel-movepoint)
1042 ;; Normally, we want async code such as sentinels to not move point.
1044 (goto-char (process-mark p
))
1045 (let ((cmds (process-get p
'vc-sentinel-commands
)))
1046 (process-put p
'vc-sentinel-commands nil
)
1048 ;; Each sentinel may move point and the next one should be run
1049 ;; at that new point. We could get the same result by having
1050 ;; each sentinel read&set process-mark, but since `cmd' needs
1051 ;; to work both for async and sync processes, this would be
1052 ;; difficult to achieve.
1053 (vc-exec-after cmd
))))
1054 ;; But sometimes the sentinels really want to move point.
1055 (if vc-sentinel-movepoint
1056 (let ((win (get-buffer-window (current-buffer) 0)))
1058 (goto-char vc-sentinel-movepoint
)
1059 (with-selected-window win
1060 (goto-char vc-sentinel-movepoint
))))))))))
1062 (defun vc-set-mode-line-busy-indicator ()
1063 (setq mode-line-process
1064 (concat " " (propertize "[waiting...]"
1065 'face
'mode-line-emphasis
1067 "A VC command is in progress in this buffer"))))
1069 (defun vc-exec-after (code)
1070 "Eval CODE when the current buffer's process is done.
1071 If the current buffer has no process, just evaluate CODE.
1072 Else, add CODE to the process' sentinel."
1073 (let ((proc (get-buffer-process (current-buffer))))
1075 ;; If there's no background process, just execute the code.
1076 ;; We used to explicitly call delete-process on exited processes,
1077 ;; but this led to timing problems causing process output to be
1078 ;; lost. Terminated processes get deleted automatically
1080 ((or (null proc
) (eq (process-status proc
) 'exit
))
1081 ;; Make sure we've read the process's output before going further.
1082 (if proc
(accept-process-output proc
))
1084 ;; If a process is running, add CODE to the sentinel
1085 ((eq (process-status proc
) 'run
)
1086 (vc-set-mode-line-busy-indicator)
1087 (let ((previous (process-sentinel proc
)))
1088 (unless (eq previous
'vc-process-sentinel
)
1089 (process-put proc
'vc-previous-sentinel previous
))
1090 (set-process-sentinel proc
'vc-process-sentinel
))
1091 (process-put proc
'vc-sentinel-commands
1092 ;; We keep the code fragments in the order given
1093 ;; so that vc-diff-finish's message shows up in
1094 ;; the presence of non-nil vc-command-messages.
1095 (append (process-get proc
'vc-sentinel-commands
)
1097 (t (error "Unexpected process state"))))
1100 (defvar vc-post-command-functions nil
1101 "Hook run at the end of `vc-do-command'.
1102 Each function is called inside the buffer in which the command was run
1103 and is passed 3 arguments: the COMMAND, the FILES and the FLAGS.")
1105 (defvar w32-quote-process-args
)
1107 (defun vc-delistify (filelist)
1108 "Smash a FILELIST into a file list string suitable for info messages."
1109 ;; FIXME what about file names with spaces?
1110 (if (not filelist
) "." (mapconcat 'identity filelist
" ")))
1113 (defun vc-do-command (buffer okstatus command file-or-list
&rest flags
)
1114 "Execute a VC command, notifying user and checking for errors.
1115 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil or the
1116 current buffer if BUFFER is t. If the destination buffer is not
1117 already current, set it up properly and erase it. The command is
1118 considered successful if its exit status does not exceed OKSTATUS (if
1119 OKSTATUS is nil, that means to ignore error status, if it is `async', that
1120 means not to wait for termination of the subprocess; if it is t it means to
1121 ignore all execution errors). FILE-OR-LIST is the name of a working file;
1122 it may be a list of files or be nil (to execute commands that don't expect
1123 a file name or set of files). If an optional list of FLAGS is present,
1124 that is inserted into the command line before the filename."
1125 ;; FIXME: file-relative-name can return a bogus result because
1126 ;; it doesn't look at the actual file-system to see if symlinks
1129 (mapcar (lambda (f) (file-relative-name (expand-file-name f
)))
1130 (if (listp file-or-list
) file-or-list
(list file-or-list
))))
1132 ;; What we're doing here is preparing a version of the command
1133 ;; for display in a debug-progess message. If it's fewer than
1134 ;; 20 characters display the entire command (without trailing
1135 ;; newline). Otherwise display the first 20 followed by an ellipsis.
1136 (concat (if (string= (substring command -
1) "\n")
1137 (substring command
0 -
1)
1140 (vc-delistify (mapcar (lambda (s) (if (> (length s
) 20) (concat (substring s
0 2) "...") s
)) flags
))
1141 " " (vc-delistify files
))))
1142 (save-current-buffer
1143 (unless (or (eq buffer t
)
1144 (and (stringp buffer
)
1145 (string= (buffer-name) buffer
))
1146 (eq buffer
(current-buffer)))
1147 (vc-setup-buffer buffer
))
1148 ;; If there's some previous async process still running, just kill it.
1149 (let ((oldproc (get-buffer-process (current-buffer))))
1150 ;; If we wanted to wait for oldproc to finish before doing
1151 ;; something, we'd have used vc-eval-after.
1152 ;; Use `delete-process' rather than `kill-process' because we don't
1153 ;; want any of its output to appear from now on.
1154 (if oldproc
(delete-process oldproc
)))
1155 (let ((squeezed (remq nil flags
))
1156 (inhibit-read-only t
)
1159 (setq squeezed
(nconc squeezed files
)))
1160 (let ((exec-path (append vc-path exec-path
))
1161 ;; Add vc-path to PATH for the execution of this command.
1162 (process-environment
1163 (cons (concat "PATH=" (getenv "PATH")
1165 (mapconcat 'identity vc-path path-separator
))
1166 process-environment
))
1167 (w32-quote-process-args t
))
1168 (if (and (eq okstatus
'async
) (file-remote-p default-directory
))
1169 ;; start-process does not support remote execution
1170 (setq okstatus nil
))
1171 (if (eq okstatus
'async
)
1172 ;; Run asynchronously.
1174 (let ((process-connection-type nil
))
1175 (apply 'start-file-process command
(current-buffer)
1176 command squeezed
))))
1177 (if vc-command-messages
1178 (message "Running %s in background..." full-command
))
1179 ;;(set-process-sentinel proc (lambda (p msg) (delete-process p)))
1180 (set-process-filter proc
'vc-process-filter
)
1182 `(if vc-command-messages
1183 (message "Running %s in background... done" ',full-command
))))
1185 (if vc-command-messages
1186 (message "Running %s in foreground..." full-command
))
1187 (let ((buffer-undo-list t
))
1188 (setq status
(apply 'process-file command nil t nil squeezed
)))
1189 (when (and (not (eq t okstatus
))
1190 (or (not (integerp status
))
1191 (and okstatus
(< okstatus status
))))
1192 (pop-to-buffer (current-buffer))
1193 (goto-char (point-min))
1194 (shrink-window-if-larger-than-buffer)
1195 (error "Running %s...FAILED (%s)" full-command
1196 (if (integerp status
) (format "status %d" status
) status
))))
1197 ;; We're done. But don't emit a status message if running
1198 ;; asychronously, it would just mislead.
1199 (if (and vc-command-messages
(not (eq okstatus
'async
)))
1200 (message "Running %s...OK = %d" full-command status
)))
1202 `(run-hook-with-args 'vc-post-command-functions
1203 ',command
',file-or-list
',flags
))
1206 (defun vc-position-context (posn)
1207 "Save a bit of the text around POSN in the current buffer.
1208 Used to help us find the corresponding position again later
1209 if markers are destroyed or corrupted."
1210 ;; A lot of this was shamelessly lifted from Sebastian Kremer's
1214 (buffer-substring posn
1215 (min (point-max) (+ posn
100)))))
1217 (defun vc-find-position-by-context (context)
1218 "Return the position of CONTEXT in the current buffer.
1219 If CONTEXT cannot be found, return nil."
1220 (let ((context-string (nth 2 context
)))
1221 (if (equal "" context-string
)
1224 (let ((diff (- (nth 1 context
) (buffer-size))))
1225 (if (< diff
0) (setq diff
(- diff
)))
1226 (goto-char (nth 0 context
))
1227 (if (or (search-forward context-string nil t
)
1228 ;; Can't use search-backward since the match may continue
1230 (progn (goto-char (- (point) diff
(length context-string
)))
1231 ;; goto-char doesn't signal an error at
1232 ;; beginning of buffer like backward-char would
1233 (search-forward context-string nil t
)))
1234 ;; to beginning of OSTRING
1235 (- (point) (length context-string
))))))))
1237 (defun vc-context-matches-p (posn context
)
1238 "Return t if POSN matches CONTEXT, nil otherwise."
1239 (let* ((context-string (nth 2 context
))
1240 (len (length context-string
))
1242 (if (> end
(1+ (buffer-size)))
1244 (string= context-string
(buffer-substring posn end
)))))
1246 (defun vc-buffer-context ()
1247 "Return a list (POINT-CONTEXT MARK-CONTEXT REPARSE).
1248 Used by `vc-restore-buffer-context' to later restore the context."
1249 (let ((point-context (vc-position-context (point)))
1250 ;; Use mark-marker to avoid confusion in transient-mark-mode.
1251 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
1252 (vc-position-context (mark-marker))))
1253 ;; Make the right thing happen in transient-mark-mode.
1255 ;; The new compilation code does not use compilation-error-list any
1256 ;; more, so the code below is now ineffective and might as well
1257 ;; be disabled. -- Stef
1258 ;; ;; We may want to reparse the compilation buffer after revert
1259 ;; (reparse (and (boundp 'compilation-error-list) ;compile loaded
1260 ;; ;; Construct a list; each elt is nil or a buffer
1261 ;; ;; if that buffer is a compilation output buffer
1262 ;; ;; that contains markers into the current buffer.
1263 ;; (save-current-buffer
1264 ;; (mapcar (lambda (buffer)
1265 ;; (set-buffer buffer)
1266 ;; (let ((errors (or
1267 ;; compilation-old-error-list
1268 ;; compilation-error-list))
1269 ;; (buffer-error-marked-p nil))
1270 ;; (while (and (consp errors)
1271 ;; (not buffer-error-marked-p))
1272 ;; (and (markerp (cdr (car errors)))
1275 ;; (cdr (car errors))))
1276 ;; (setq buffer-error-marked-p t))
1277 ;; (setq errors (cdr errors)))
1278 ;; (if buffer-error-marked-p buffer)))
1279 ;; (buffer-list)))))
1281 (list point-context mark-context reparse
)))
1283 (defun vc-restore-buffer-context (context)
1284 "Restore point/mark, and reparse any affected compilation buffers.
1285 CONTEXT is that which `vc-buffer-context' returns."
1286 (let ((point-context (nth 0 context
))
1287 (mark-context (nth 1 context
))
1288 ;; (reparse (nth 2 context))
1290 ;; The new compilation code does not use compilation-error-list any
1291 ;; more, so the code below is now ineffective and might as well
1292 ;; be disabled. -- Stef
1293 ;; ;; Reparse affected compilation buffers.
1295 ;; (if (car reparse)
1296 ;; (with-current-buffer (car reparse)
1297 ;; (let ((compilation-last-buffer (current-buffer)) ;select buffer
1298 ;; ;; Record the position in the compilation buffer of
1299 ;; ;; the last error next-error went to.
1300 ;; (error-pos (marker-position
1301 ;; (car (car-safe compilation-error-list)))))
1302 ;; ;; Reparse the error messages as far as they were parsed before.
1303 ;; (compile-reinitialize-errors '(4) compilation-parsing-end)
1304 ;; ;; Move the pointer up to find the error we were at before
1305 ;; ;; reparsing. Now next-error should properly go to the next one.
1306 ;; (while (and compilation-error-list
1307 ;; (/= error-pos (car (car compilation-error-list))))
1308 ;; (setq compilation-error-list (cdr compilation-error-list))))))
1309 ;; (setq reparse (cdr reparse)))
1311 ;; if necessary, restore point and mark
1312 (if (not (vc-context-matches-p (point) point-context
))
1313 (let ((new-point (vc-find-position-by-context point-context
)))
1314 (if new-point
(goto-char new-point
))))
1317 (not (vc-context-matches-p (mark) mark-context
))
1318 (let ((new-mark (vc-find-position-by-context mark-context
)))
1319 (if new-mark
(set-mark new-mark
))))))
1321 ;;; Code for deducing what fileset and backend to assume
1323 (defun vc-responsible-backend (file &optional register
)
1324 "Return the name of a backend system that is responsible for FILE.
1325 The optional argument REGISTER means that a backend suitable for
1326 registration should be found.
1328 If REGISTER is nil, then if FILE is already registered, return the
1329 backend of FILE. If FILE is not registered, or a directory, then the
1330 first backend in `vc-handled-backends' that declares itself
1331 responsible for FILE is returned. If no backend declares itself
1332 responsible, return the first backend.
1334 If REGISTER is non-nil, return the first responsible backend under
1335 which FILE is not yet registered. If there is no such backend, return
1336 the first backend under which FILE is not yet registered, but could
1338 (if (not vc-handled-backends
)
1339 (error "No handled backends"))
1340 (or (and (not (file-directory-p file
)) (not register
) (vc-backend file
))
1342 ;; First try: find a responsible backend. If this is for registration,
1343 ;; it must be a backend under which FILE is not yet registered.
1344 (dolist (backend vc-handled-backends
)
1345 (and (or (not register
)
1346 (not (vc-call-backend backend
'registered file
)))
1347 (vc-call-backend backend
'responsible-p file
)
1348 (throw 'found backend
)))
1349 ;; no responsible backend
1351 ;; if this is not for registration, the first backend must do
1352 (car vc-handled-backends
)
1353 ;; for registration, we need to find a new backend that
1354 ;; could register FILE
1355 (dolist (backend vc-handled-backends
)
1356 (and (not (vc-call-backend backend
'registered file
))
1357 (vc-call-backend backend
'could-register file
)
1358 (throw 'found backend
)))
1359 (error "No backend that could register")))))
1361 (defun vc-expand-dirs (file-or-dir-list)
1362 "Expands directories in a file list specification.
1363 Only files already under version control are noticed."
1364 ;; FIXME: Kill this function.
1365 (let ((flattened '()))
1366 (dolist (node file-or-dir-list
)
1368 node
(lambda (f) (if (vc-backend f
) (push f flattened
)))))
1369 (nreverse flattened
)))
1371 (defun vc-deduce-fileset (&optional allow-directory-wildcard allow-unregistered
)
1372 "Deduce a set of files and a backend to which to apply an operation.
1374 If we're in VC-dired mode, the fileset is the list of marked files.
1375 Otherwise, if we're looking at a buffer visiting a version-controlled file,
1376 the fileset is a singleton containing this file.
1377 If neither of these things is true, but ALLOW-DIRECTORY-WILDCARD is on
1378 and we're in a dired buffer, select the current directory.
1379 If none of these conditions is met, but ALLOW_UNREGISTERED is in and the
1380 visited file is not registered, return a singletin fileset containing it.
1381 Otherwise, throw an error."
1382 (cond (vc-dired-mode
1383 (let ((marked (dired-map-over-marks (dired-get-filename) nil
)))
1385 (error "No files have been selected."))
1386 ;; All members of the fileset must have the same backend
1387 (let ((firstbackend (vc-backend (car marked
))))
1388 (dolist (f (cdr marked
))
1389 (unless (eq (vc-backend f
) firstbackend
)
1390 (error "All members of a fileset must be under the same version-control system."))))
1392 ((eq major-mode
'vc-status-mode
)
1393 (let ((marked (vc-status-marked-files)))
1396 (list (vc-status-current-file)))))
1397 ((vc-backend buffer-file-name
)
1398 (list buffer-file-name
))
1399 ((and vc-parent-buffer
(or (buffer-file-name vc-parent-buffer
)
1400 (with-current-buffer vc-parent-buffer
1401 (or vc-dired-mode
(eq major-mode
'vc-status-mode
)))))
1403 (set-buffer vc-parent-buffer
)
1404 (vc-deduce-fileset)))
1405 ;; This is guarded by an enabling arg so users won't potentially
1406 ;; shoot themselves in the foot by modifying a fileset they can't
1407 ;; verify by eyeball. Allow it for nondestructive commands like
1408 ;; making diffs, or possibly for destructive ones that have
1409 ;; confirmation prompts.
1410 ((and allow-directory-wildcard
1411 ;; I think this is a misfeature. For now, I'll leave it in, but
1412 ;; I'll disable it anywhere else than in dired buffers. --Stef
1413 (and (derived-mode-p 'dired-mode
)
1414 (equal buffer-file-name nil
)
1415 (equal list-buffers-directory default-directory
)))
1417 (message "All version-controlled files below %s selected."
1419 (list default-directory
)))
1420 ((and allow-unregistered
(not (vc-registered buffer-file-name
)))
1421 (list buffer-file-name
))
1422 (t (error "No fileset is available here."))))
1424 (defun vc-ensure-vc-buffer ()
1425 "Make sure that the current buffer visits a version-controlled file."
1428 (set-buffer (find-file-noselect (dired-get-filename))))
1429 ((eq major-mode
'vc-status-mode
)
1430 (set-buffer (find-file-noselect (vc-status-current-file))))
1432 (while (and vc-parent-buffer
1433 (buffer-live-p vc-parent-buffer
)
1434 ;; Avoid infinite looping when vc-parent-buffer and
1435 ;; current buffer are the same buffer.
1436 (not (eq vc-parent-buffer
(current-buffer))))
1437 (set-buffer vc-parent-buffer
))
1438 (if (not buffer-file-name
)
1439 (error "Buffer %s is not associated with a file" (buffer-name))
1440 (if (not (vc-backend buffer-file-name
))
1441 (error "File %s is not under version control" buffer-file-name
))))))
1443 ;;; Support for the C-x v v command. This is where all the single-file-oriented
1444 ;;; code from before the fileset rewrite lives.
1446 (defsubst vc-editable-p
(file)
1447 "Return non-nil if FILE can be edited."
1448 (or (eq (vc-checkout-model file
) 'implicit
)
1449 (memq (vc-state file
) '(edited needs-merge
))))
1451 (defun vc-revert-buffer-internal (&optional arg no-confirm
)
1452 "Revert buffer, keeping point and mark where user expects them.
1453 Try to be clever in the face of changes due to expanded version-control
1454 key words. This is important for typeahead to work as expected.
1455 ARG and NO-CONFIRM are passed on to `revert-buffer'."
1458 (let ((context (vc-buffer-context)))
1459 ;; Use save-excursion here, because it may be able to restore point
1460 ;; and mark properly even in cases where vc-restore-buffer-context
1461 ;; would fail. However, save-excursion might also get it wrong --
1462 ;; in this case, vc-restore-buffer-context gives it a second try.
1464 ;; t means don't call normal-mode;
1465 ;; that's to preserve various minor modes.
1466 (revert-buffer arg no-confirm t
))
1467 (vc-restore-buffer-context context
)))
1469 (defun vc-buffer-sync (&optional not-urgent
)
1470 "Make sure the current buffer and its working file are in sync.
1471 NOT-URGENT means it is ok to continue if the user says not to save."
1472 (if (buffer-modified-p)
1473 (if (or vc-suppress-confirm
1474 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
1477 (error "Aborted")))))
1479 (defvar vc-dired-window-configuration
)
1481 (defun vc-compatible-state (p q
)
1482 "Controls which states can be in the same commit."
1485 (and (member p
'(edited added removed
)) (member q
'(edited added removed
)))))
1487 ;; Here's the major entry point.
1490 (defun vc-next-action (verbose)
1491 "Do the next logical version control operation on the current fileset.
1492 This requires that all files in the fileset be in the same state.
1494 For locking systems:
1495 If every file is not already registered, this registers each for version
1497 If every file is registered and not locked by anyone, this checks out
1498 a writable and locked file of each ready for editing.
1499 If every file is checked out and locked by the calling user, this
1500 first checks to see if each file has changed since checkout. If not,
1501 it performs a revert on that file.
1502 If every file has been changed, this pops up a buffer for entry
1503 of a log message; when the message has been entered, it checks in the
1504 resulting changes along with the log message as change commentary. If
1505 the variable `vc-keep-workfiles' is non-nil (which is its default), a
1506 read-only copy of each changed file is left in place afterwards.
1507 If the affected file is registered and locked by someone else, you are
1508 given the option to steal the lock(s).
1510 For merging systems:
1511 If every file is not already registered, this registers each one for version
1512 control. This does an add, but not a commit.
1513 If every file is added but not committed, each one is committed.
1514 If every working file is changed, but the corresponding repository file is
1515 unchanged, this pops up a buffer for entry of a log message; when the
1516 message has been entered, it checks in the resulting changes along
1517 with the logmessage as change commentary. A writable file is retained.
1518 If the repository file is changed, you are asked if you want to
1519 merge in the changes into your working copy."
1521 (let* ((files (vc-deduce-fileset nil t
))
1522 (state (vc-state (car files
)))
1523 (model (vc-checkout-model (car files
)))
1525 ;; Verify that the fileset is homogenous
1526 (dolist (file (cdr files
))
1527 (unless (vc-compatible-state (vc-state file
) state
)
1528 (error "Fileset is in a mixed-up state"))
1529 (unless (eq (vc-checkout-model file
) model
)
1530 (error "Fileset has mixed checkout models")))
1531 ;; Check for buffers in the fileset not matching the on-disk contents.
1532 (dolist (file files
)
1533 (let ((visited (get-file-buffer file
)))
1535 (if (or vc-dired-mode
(eq major-mode
'vc-status-mode
))
1536 (switch-to-buffer-other-window visited
)
1537 (set-buffer visited
))
1538 ;; Check relation of buffer and file, and make sure
1539 ;; user knows what he's doing. First, finding the file
1540 ;; will check whether the file on disk is newer.
1541 ;; Ignore buffer-read-only during this test, and
1542 ;; preserve find-file-literally.
1543 (let ((buffer-read-only (not (file-writable-p file
))))
1544 (find-file-noselect file nil find-file-literally
))
1545 (if (not (verify-visited-file-modtime (current-buffer)))
1546 (if (yes-or-no-p (format "Replace %s on disk with buffer contents? " file
))
1547 (write-file buffer-file-name
)
1549 ;; Now, check if we have unsaved changes.
1551 (when (buffer-modified-p)
1552 (or (y-or-n-p (message "Use %s on disk, keeping modified buffer? " file
))
1553 (error "Aborted")))))))
1554 ;; Do the right thing
1556 ;; Files aren't registered
1557 ((or (not state
) ;; RCS uses nil for unregistered files.
1558 (eq state
'unregistered
)
1559 (eq state
'ignored
))
1560 (mapc 'vc-register files
))
1561 ;; Files are up-to-date, or need a merge and user specified a revision
1562 ((or (eq state
'up-to-date
) (and verbose
(eq state
'needs-patch
)))
1565 ;; go to a different revision
1566 (setq revision
(read-string "Branch, revision, or backend to move to: "))
1567 (let ((vsym (intern-soft (upcase revision
))))
1568 (if (member vsym vc-handled-backends
)
1569 (dolist (file files
) (vc-transfer-file file vsym
))
1570 (dolist (file files
)
1571 (vc-checkout file
(eq model
'implicit
) revision
)))))
1572 ((not (eq model
'implicit
))
1573 ;; check the files out
1574 (dolist (file files
) (vc-checkout file t
)))
1577 (message "Fileset is up-to-date"))))
1578 ;; Files have local changes
1579 ((vc-compatible-state state
'edited
)
1580 (let ((ready-for-commit files
))
1581 ;; If files are edited but read-only, give user a chance to correct
1582 (dolist (file files
)
1583 (unless (file-writable-p file
)
1584 ;; Make the file+buffer read-write.
1585 (unless (y-or-n-p (format "%s is edited but read-only; make it writable and continue?" file
))
1587 (set-file-modes file
(logior (file-modes file
) 128))
1588 (let ((visited (get-file-buffer file
)))
1590 (with-current-buffer visited
1591 (toggle-read-only -
1))))))
1592 ;; Allow user to revert files with no changes
1594 (dolist (file files
)
1595 (let ((visited (get-file-buffer file
)))
1596 ;; For files with locking, if the file does not contain
1597 ;; any changes, just let go of the lock, i.e. revert.
1598 (when (and (not (eq model
'implicit
))
1599 (vc-workfile-unchanged-p file
)
1600 ;; If buffer is modified, that means the user just
1601 ;; said no to saving it; in that case, don't revert,
1602 ;; because the user might intend to save after
1603 ;; finishing the log entry and committing.
1604 (not (and visited
(buffer-modified-p))))
1605 (vc-revert-file file
)
1606 (delete file ready-for-commit
)))))
1607 ;; Remaining files need to be committed
1608 (if (not ready-for-commit
)
1609 (message "No files remain to be committed")
1611 (vc-checkin ready-for-commit
)
1613 (setq revision
(read-string "New revision or backend: "))
1614 (let ((vsym (intern (upcase revision
))))
1615 (if (member vsym vc-handled-backends
)
1616 (dolist (file files
) (vc-transfer-file file vsym
))
1617 (vc-checkin ready-for-commit revision
))))))))
1618 ;; locked by somebody else (locking VCSes only)
1620 ;; In the old days, we computed the revision once and used it on
1621 ;; the single file. Then, for the 2007-2008 fileset rewrite, we
1622 ;; computed the revision once (incorrectly, using a free var) and
1623 ;; used it on all files. To fix the free var bug, we can either
1624 ;; use `(car files)' or do what we do here: distribute the
1625 ;; revision computation among `files'. Although this may be
1626 ;; tedious for those backends where a "revision" is a trans-file
1627 ;; concept, it is nonetheless correct for both those and (more
1628 ;; importantly) for those where "revision" is a per-file concept.
1629 ;; If the intersection of the former group and "locking VCSes" is
1630 ;; non-empty [I vaguely doubt it --ttn], we can reinstate the
1631 ;; pre-computation approach of yore.
1632 (dolist (file files
)
1635 (read-string (format "%s revision to steal: " file
))
1636 (vc-working-revision file
))
1639 ((eq state
'needs-patch
)
1640 (dolist (file files
)
1641 (if (yes-or-no-p (format
1642 "%s is not up-to-date. Get latest revision? "
1643 (file-name-nondirectory file
)))
1644 (vc-checkout file
(eq model
'implicit
) t
)
1645 (when (and (not (eq model
'implicit
))
1646 (yes-or-no-p "Lock this revision? "))
1647 (vc-checkout file t
)))))
1649 ((eq state
'needs-merge
)
1650 (dolist (file files
)
1651 (when (yes-or-no-p (format
1652 "%s is not up-to-date. Merge in changes now? "
1653 (file-name-nondirectory file
)))
1654 (vc-maybe-resolve-conflicts file
(vc-call merge-news file
)))))
1657 ((eq state
'unlocked-changes
)
1658 (dolist (file files
)
1659 (if (not (equal buffer-file-name file
))
1660 (find-file-other-window file
))
1661 (if (save-window-excursion
1662 (vc-diff-internal nil
(list file
) (vc-working-revision file
) nil
)
1663 (goto-char (point-min))
1664 (let ((inhibit-read-only t
))
1666 (format "Changes to %s since last lock:\n\n" file
)))
1668 (yes-or-no-p (concat "File has unlocked changes. "
1669 "Claim lock retaining changes? ")))
1670 (progn (vc-call steal-lock file
)
1671 (clear-visited-file-modtime)
1672 ;; Must clear any headers here because they wouldn't
1673 ;; show that the file is locked now.
1674 (vc-clear-headers file
)
1675 (write-file buffer-file-name
)
1676 (vc-mode-line file
))
1677 (if (not (yes-or-no-p
1678 "Revert to checked-in revision, instead? "))
1679 (error "Checkout aborted")
1680 (vc-revert-buffer-internal t t
)
1681 (vc-checkout file t
))))))))
1683 (defun vc-create-repo (backend)
1684 "Create an empty repository in the current directory."
1690 "Create repository for: "
1691 (mapcar (lambda (b) (list (downcase (symbol-name b
)))) vc-handled-backends
)
1693 (vc-call-backend backend
'create-repo
))
1696 (defun vc-register (&optional fname set-revision comment
)
1697 "Register into a version control system.
1698 If FNAME is given register that file, otherwise register the current file.
1699 With prefix argument SET-REVISION, allow user to specify initial revision
1700 level. If COMMENT is present, use that as an initial comment.
1702 The version control system to use is found by cycling through the list
1703 `vc-handled-backends'. The first backend in that list which declares
1704 itself responsible for the file (usually because other files in that
1705 directory are already registered under that backend) will be used to
1706 register the file. If no backend declares itself responsible, the
1707 first backend that could register the file is used."
1709 (when (and (null fname
) (null buffer-file-name
)) (error "No visited file"))
1711 (let ((bname (if fname
(get-file-buffer fname
) (current-buffer))))
1712 (unless fname
(setq fname buffer-file-name
))
1713 (when (vc-backend fname
)
1714 (if (vc-registered fname
)
1715 (error "This file is already registered")
1716 (unless (y-or-n-p "Previous master file has vanished. Make a new one? ")
1717 (error "Aborted"))))
1718 ;; Watch out for new buffers of size 0: the corresponding file
1719 ;; does not exist yet, even though buffer-modified-p is nil.
1721 (with-current-buffer bname
1722 (if (and (not (buffer-modified-p))
1723 (zerop (buffer-size))
1724 (not (file-exists-p buffer-file-name
)))
1725 (set-buffer-modified-p t
))
1727 (vc-start-entry (list fname
)
1729 (read-string (format "Initial revision level for %s: "
1731 (vc-call-backend (vc-responsible-backend fname
)
1733 (or comment
(not vc-initial-comment
))
1735 "Enter initial comment."
1736 (lambda (files rev comment
)
1737 (dolist (file files
)
1738 (message "Registering %s... " file
)
1739 (let ((backend (vc-responsible-backend file t
)))
1740 (vc-file-clearprops file
)
1741 (vc-call-backend backend
'register
(list file
) rev comment
)
1742 (vc-file-setprop file
'vc-backend backend
)
1743 (unless vc-make-backup-files
1744 (make-local-variable 'backup-inhibited
)
1745 (setq backup-inhibited t
)))
1746 (message "Registering %s... done" file
))))))
1748 (defun vc-register-with (backend)
1749 "Register the current file with a specified back end."
1750 (interactive "SBackend: ")
1751 (if (not (member backend vc-handled-backends
))
1752 (error "Unknown back end."))
1753 (let ((vc-handled-backends (list backend
)))
1754 (call-interactively 'vc-register
)))
1756 (declare-function view-mode-exit
"view" (&optional return-to-alist exit-action all-win
))
1758 (defun vc-resynch-window (file &optional keep noquery
)
1759 "If FILE is in the current buffer, either revert or unvisit it.
1760 The choice between revert (to see expanded keywords) and unvisit depends on
1761 `vc-keep-workfiles'. NOQUERY if non-nil inhibits confirmation for
1762 reverting. NOQUERY should be t *only* if it is known the only
1763 difference between the buffer and the file is due to version control
1764 rather than user editing!"
1765 (and (string= buffer-file-name file
)
1768 (vc-revert-buffer-internal t noquery
)
1769 ;; TODO: Adjusting view mode might no longer be necessary
1770 ;; after RMS change to files.el of 1999-08-08. Investigate
1771 ;; this when we install the new VC.
1773 (if (file-writable-p file
)
1775 (let ((view-old-buffer-read-only nil
))
1777 (and (not view-mode
)
1778 (not (eq (get major-mode
'mode-class
) 'special
))
1779 (view-mode-enter))))
1780 (vc-mode-line buffer-file-name
))
1781 (kill-buffer (current-buffer)))))
1783 (defun vc-resynch-buffer (file &optional keep noquery
)
1784 "If FILE is currently visited, resynch its buffer."
1785 (if (string= buffer-file-name file
)
1786 (vc-resynch-window file keep noquery
)
1787 (let ((buffer (get-file-buffer file
)))
1789 (with-current-buffer buffer
1790 (vc-resynch-window file keep noquery
)))))
1791 (vc-dired-resynch-file file
)
1792 (when (memq 'vc-status-mark-buffer-changed after-save-hook
)
1793 (let ((buffer (get-file-buffer file
)))
1794 (vc-status-mark-buffer-changed file
))))
1797 (defun vc-start-entry (files rev comment initial-contents msg action
&optional after-hook
)
1798 "Accept a comment for an operation on FILES revision REV.
1799 If COMMENT is nil, pop up a VC-log buffer, emit MSG, and set the
1800 action on close to ACTION. If COMMENT is a string and
1801 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial
1802 contents of the log entry buffer. If COMMENT is a string and
1803 INITIAL-CONTENTS is nil, do action immediately as if the user had
1804 entered COMMENT. If COMMENT is t, also do action immediately with an
1805 empty comment. Remember the file's buffer in `vc-parent-buffer'
1806 \(current one if no file). AFTER-HOOK specifies the local value
1807 for `vc-log-after-operation-hook'."
1809 (if (or (eq major-mode
'vc-dired-mode
) (eq major-mode
'vc-status-mode
))
1810 ;; If we are called from VC dired, the parent buffer is
1811 ;; the current buffer.
1813 (if (and files
(equal (length files
) 1))
1814 (get-file-buffer (car files
))
1815 (current-buffer)))))
1816 (when vc-before-checkin-hook
1818 (with-current-buffer parent
1819 (run-hooks 'vc-before-checkin-hook
))
1820 (run-hooks 'vc-before-checkin-hook
)))
1821 (if (and comment
(not initial-contents
))
1822 (set-buffer (get-buffer-create "*VC-log*"))
1823 (pop-to-buffer (get-buffer-create "*VC-log*")))
1824 (set (make-local-variable 'vc-parent-buffer
) parent
)
1825 (set (make-local-variable 'vc-parent-buffer-name
)
1826 (concat " from " (buffer-name vc-parent-buffer
)))
1827 ;;(if file (vc-mode-line file))
1829 (make-local-variable 'vc-log-after-operation-hook
)
1831 (setq vc-log-after-operation-hook after-hook
))
1832 (setq vc-log-operation action
)
1833 (setq vc-log-revision rev
)
1836 (when (stringp comment
) (insert comment
)))
1837 (if (or (not comment
) initial-contents
)
1838 (message "%s Type C-c C-c when done" msg
)
1839 (vc-finish-logentry (eq comment t
)))))
1841 (defun vc-checkout (file &optional writable rev
)
1842 "Retrieve a copy of the revision REV of FILE.
1843 If WRITABLE is non-nil, make sure the retrieved file is writable.
1844 REV defaults to the latest revision.
1846 After check-out, runs the normal hook `vc-checkout-hook'."
1849 (vc-call make-version-backups-p file
)
1850 (vc-up-to-date-p file
)
1851 (vc-make-version-backup file
))
1855 (vc-call checkout file writable rev
)
1857 ;; Maybe the backend is not installed ;-(
1859 (let ((buf (get-file-buffer file
)))
1860 (when buf
(with-current-buffer buf
(toggle-read-only -
1)))))
1861 (signal (car err
) (cdr err
))))
1862 `((vc-state .
,(if (or (eq (vc-checkout-model file
) 'implicit
)
1864 (if (vc-call latest-on-branch-p file
)
1868 (vc-checkout-time .
,(nth 5 (file-attributes file
)))))
1869 (vc-resynch-buffer file t t
)
1870 (run-hooks 'vc-checkout-hook
))
1872 (defun vc-steal-lock (file rev owner
)
1873 "Steal the lock on FILE."
1874 (let (file-description)
1876 (setq file-description
(format "%s:%s" file rev
))
1877 (setq file-description file
))
1878 (if (not (yes-or-no-p (format "Steal the lock on %s from %s? "
1879 file-description owner
)))
1880 (error "Steal canceled"))
1881 (message "Stealing lock on %s..." file
)
1884 (vc-call steal-lock file rev
)
1885 `((vc-state . edited
)))
1886 (vc-resynch-buffer file t t
)
1887 (message "Stealing lock on %s...done" file
)
1888 ;; Write mail after actually stealing, because if the stealing
1889 ;; goes wrong, we don't want to send any mail.
1890 (compose-mail owner
(format "Stolen lock on %s" file-description
))
1891 (setq default-directory
(expand-file-name "~/"))
1892 (goto-char (point-max))
1894 (format "I stole the lock on %s, " file-description
)
1895 (current-time-string)
1897 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
1899 (defun vc-checkin (files &optional rev comment initial-contents
)
1901 The optional argument REV may be a string specifying the new revision
1902 level (if nil increment the current level). COMMENT is a comment
1903 string; if omitted, a buffer is popped up to accept a comment. If
1904 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents
1905 of the log entry buffer.
1907 If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided
1908 that the version control system supports this mode of operation.
1910 Runs the normal hook `vc-checkin-hook'."
1912 files rev comment initial-contents
1913 "Enter a change comment."
1914 (lambda (files rev comment
)
1915 (message "Checking in %s..." (vc-delistify files
))
1916 ;; "This log message intentionally left almost blank".
1917 ;; RCS 5.7 gripes about white-space-only comments too.
1918 (or (and comment
(string-match "[^\t\n ]" comment
))
1919 (setq comment
"*** empty log message ***"))
1922 ;; We used to change buffers to get local value of vc-checkin-switches,
1923 ;; but 'the' local buffer is not a well-defined concept for filesets.
1925 (vc-call checkin files rev comment
)
1926 (mapc 'vc-delete-automatic-version-backups files
))
1927 `((vc-state . up-to-date
)
1928 (vc-checkout-time .
,(nth 5 (file-attributes file
)))
1929 (vc-working-revision . nil
)))
1930 (message "Checking in %s...done" (vc-delistify files
)))
1933 (defun vc-finish-logentry (&optional nocomment
)
1934 "Complete the operation implied by the current log entry.
1935 Use the contents of the current buffer as a check-in or registration
1936 comment. If the optional arg NOCOMMENT is non-nil, then don't check
1937 the buffer contents as a comment."
1939 ;; Check and record the comment, if any.
1941 ;; Comment too long?
1942 (vc-call-backend (or (if vc-log-fileset
(vc-backend vc-log-fileset
))
1943 (vc-responsible-backend default-directory
))
1945 (run-hooks 'vc-logentry-check-hook
))
1946 ;; Sync parent buffer in case the user modified it while editing the comment.
1947 ;; But not if it is a vc-dired buffer.
1948 (with-current-buffer vc-parent-buffer
1949 (or vc-dired-mode
(eq major-mode
'vc-status-mode
) (vc-buffer-sync)))
1950 (if (not vc-log-operation
)
1951 (error "No log operation is pending"))
1952 ;; save the parameters held in buffer-local variables
1953 (let ((log-operation vc-log-operation
)
1954 (log-fileset vc-log-fileset
)
1955 (log-revision vc-log-revision
)
1956 (log-entry (buffer-string))
1957 (after-hook vc-log-after-operation-hook
)
1958 (tmp-vc-parent-buffer vc-parent-buffer
))
1959 (pop-to-buffer vc-parent-buffer
)
1962 (funcall log-operation
1966 ;; Remove checkin window (after the checkin so that if that fails
1967 ;; we don't zap the *VC-log* buffer and the typing therein).
1968 (let ((logbuf (get-buffer "*VC-log*")))
1969 (cond ((and logbuf vc-delete-logbuf-window
)
1970 (delete-windows-on logbuf
(selected-frame))
1971 ;; Kill buffer and delete any other dedicated windows/frames.
1972 (kill-buffer logbuf
))
1973 (logbuf (pop-to-buffer "*VC-log*")
1975 (pop-to-buffer tmp-vc-parent-buffer
))))
1976 ;; Now make sure we see the expanded headers
1979 (lambda (file) (vc-resynch-buffer file vc-keep-workfiles t
))
1981 (if (or vc-dired-mode
(eq major-mode
'vc-status-mode
))
1982 (dired-move-to-filename))
1983 (run-hooks after-hook
'vc-finish-logentry-hook
)))
1985 ;;; Additional entry points for examining version histories
1987 ;; (defun vc-default-diff-tree (backend dir rev1 rev2)
1988 ;; "List differences for all registered files at and below DIR.
1989 ;; The meaning of REV1 and REV2 is the same as for `vc-revision-diff'."
1990 ;; ;; This implementation does an explicit tree walk, and calls
1991 ;; ;; vc-BACKEND-diff directly for each file. An optimization
1992 ;; ;; would be to use `vc-diff-internal', so that diffs can be local,
1993 ;; ;; and to call it only for files that are actually changed.
1994 ;; ;; However, this is expensive for some backends, and so it is left
1995 ;; ;; to backend-specific implementations.
1996 ;; (setq default-directory dir)
1997 ;; (vc-file-tree-walk
1998 ;; default-directory
2001 ;; `(let ((coding-system-for-read (vc-coding-system-for-diff ',f)))
2002 ;; (message "Looking at %s" ',f)
2003 ;; (vc-call-backend ',(vc-backend f)
2004 ;; 'diff (list ',f) ',rev1 ',rev2))))))
2006 (defun vc-coding-system-for-diff (file)
2007 "Return the coding system for reading diff output for FILE."
2008 (or coding-system-for-read
2009 ;; if we already have this file open,
2010 ;; use the buffer's coding system
2011 (let ((buf (find-buffer-visiting file
)))
2012 (if buf
(with-current-buffer buf
2013 buffer-file-coding-system
)))
2014 ;; otherwise, try to find one based on the file name
2015 (car (find-operation-coding-system 'insert-file-contents file
))
2016 ;; and a final fallback
2019 (defun vc-switches (backend op
)
2022 (let ((sym (vc-make-backend-sym
2023 backend
(intern (concat (symbol-name op
)
2025 (if (boundp sym
) (symbol-value sym
))))
2026 (let ((sym (intern (format "vc-%s-switches" (symbol-name op
)))))
2027 (if (boundp sym
) (symbol-value sym
)))
2029 ((eq op
'diff
) diff-switches
)))))
2030 (if (stringp switches
) (list switches
)
2031 ;; If not a list, return nil.
2032 ;; This is so we can set vc-diff-switches to t to override
2033 ;; any switches in diff-switches.
2034 (if (listp switches
) switches
))))
2036 ;; Old def for compatibility with Emacs-21.[123].
2037 (defmacro vc-diff-switches-list
(backend) `(vc-switches ',backend
'diff
))
2038 (make-obsolete 'vc-diff-switches-list
'vc-switches
"22.1")
2040 (defun vc-diff-finish (buffer messages
)
2041 ;; The empty sync output case has already been handled, so the only
2042 ;; possibility of an empty output is for an async process.
2043 (when (buffer-live-p buffer
)
2044 (let ((window (get-buffer-window buffer t
))
2045 (emptyp (zerop (buffer-size buffer
))))
2046 (with-current-buffer buffer
2047 (and messages emptyp
2048 (let ((inhibit-read-only t
))
2049 (insert (cdr messages
) ".\n")
2050 (message "%s" (cdr messages
))))
2051 (goto-char (point-min))
2053 (shrink-window-if-larger-than-buffer window
)))
2054 (when (and messages
(not emptyp
))
2055 (message "%sdone" (car messages
))))))
2057 (defvar vc-diff-added-files nil
2058 "If non-nil, diff added files by comparing them to /dev/null.")
2060 (defun vc-diff-internal (async files rev1 rev2
&optional verbose
)
2061 "Report diffs between two revisions of a fileset.
2062 Diff output goes to the *vc-diff* buffer. The function
2063 returns t if the buffer had changes, nil otherwise."
2064 (let* ((messages (cons (format "Finding changes in %s..."
2065 (vc-delistify files
))
2066 (format "No changes between %s and %s"
2067 (or rev1
"working revision")
2068 (or rev2
"workfile"))))
2069 ;; Set coding system based on the first file. It's a kluge,
2070 ;; but the only way to set it for each file included would
2071 ;; be to call the back end separately for each file.
2072 (coding-system-for-read
2073 (if files
(vc-coding-system-for-diff (car files
)) 'undecided
)))
2074 (vc-setup-buffer "*vc-diff*")
2075 (message "%s" (car messages
))
2076 ;; Many backends don't handle well the case of a file that has been
2077 ;; added but not yet committed to the repo (notably CVS and Subversion).
2078 ;; Do that work here so the backends don't have to futz with it. --ESR
2080 ;; Actually most backends (including CVS) have options to control the
2081 ;; behavior since which one is better depends on the user and on the
2082 ;; situation). Worse yet: this code does not handle the case where
2083 ;; `file' is a directory which contains added files.
2084 ;; I made it conditional on vc-diff-added-files but it should probably
2085 ;; just be removed (or copied/moved to specific backends). --Stef.
2086 (when vc-diff-added-files
2087 (let ((filtered '()))
2088 (dolist (file files
)
2089 (if (or (file-directory-p file
)
2090 (not (string= (vc-working-revision file
) "0")))
2091 (push file filtered
)
2092 ;; This file is added but not yet committed;
2093 ;; there is no master file to diff against.
2095 (error "No revisions of %s exist" file
)
2096 ;; We regard this as "changed".
2097 ;; Diff it against /dev/null.
2098 (apply 'vc-do-command
"*vc-diff*"
2100 (append (vc-switches nil
'diff
) '("/dev/null"))))))
2101 (setq files
(nreverse filtered
))))
2102 (let ((vc-disable-async-diff (not async
)))
2103 (vc-call diff files rev1 rev2
"*vc-diff*"))
2104 (set-buffer "*vc-diff*")
2105 (if (and (zerop (buffer-size))
2106 (not (get-buffer-process (current-buffer))))
2107 ;; Treat this case specially so as not to pop the buffer.
2109 (message "%s" (cdr messages
))
2112 ;; Make the *vc-diff* buffer read only, the diff-mode key
2113 ;; bindings are nicer for read only buffers. pcl-cvs does the
2115 (setq buffer-read-only t
)
2116 (vc-exec-after `(vc-diff-finish ,(current-buffer) ',(when verbose
2118 ;; Display the buffer, but at the end because it can change point.
2119 (pop-to-buffer (current-buffer))
2120 ;; In the async case, we return t even if there are no differences
2121 ;; because we don't know that yet.
2125 (defun vc-version-diff (files rev1 rev2
)
2126 "Report diffs between revisions of the fileset in the repository history."
2128 (let* ((files (vc-deduce-fileset t
))
2131 (vc-call revision-completion-table files
))
2135 ;; someday we may be able to do revision completion on non-singleton
2136 ;; filesets, but not yet.
2137 ((/= (length files
) 1)
2139 ;; if it's a directory, don't supply any revision default
2140 ((file-directory-p first
)
2142 ;; if the file is not up-to-date, use working revision as older revision
2143 ((not (vc-up-to-date-p first
))
2144 (setq rev1-default
(vc-working-revision first
)))
2145 ;; if the file is not locked, use last and previous revisions as defaults
2147 (setq rev1-default
(vc-call previous-revision first
2148 (vc-working-revision first
)))
2149 (if (string= rev1-default
"") (setq rev1-default nil
))
2150 (setq rev2-default
(vc-working-revision first
))))
2151 ;; construct argument list
2152 (let* ((rev1-prompt (if rev1-default
2153 (concat "Older revision (default "
2155 "Older revision: "))
2156 (rev2-prompt (concat "Newer revision (default "
2157 (or rev2-default
"current source") "): "))
2158 (rev1 (if completion-table
2159 (completing-read rev1-prompt completion-table
2160 nil nil nil nil rev1-default
)
2161 (read-string rev1-prompt nil nil rev1-default
)))
2162 (rev2 (if completion-table
2163 (completing-read rev2-prompt completion-table
2164 nil nil nil nil rev2-default
)
2165 (read-string rev2-prompt nil nil rev2-default
))))
2166 (if (string= rev1
"") (setq rev1 nil
))
2167 (if (string= rev2
"") (setq rev2 nil
))
2168 (list files rev1 rev2
))))
2169 (if (and (not rev1
) rev2
)
2170 (error "Not a valid revision range."))
2171 (vc-diff-internal t files rev1 rev2
(interactive-p)))
2173 ;; (defun vc-contains-version-controlled-file (dir)
2174 ;; "Return t if DIR contains a version-controlled file, nil otherwise."
2176 ;; (mapc (lambda (f) (and (not (file-directory-p f)) (vc-backend f) (throw 'found 't))) (directory-files dir))
2180 (defun vc-diff (historic &optional not-urgent
)
2181 "Display diffs between file revisions.
2182 Normally this compares the currently selected fileset with their
2183 working revisions. With a prefix argument HISTORIC, it reads two revision
2184 designators specifying which revisions to compare.
2186 If no current fileset is available (that is, we are not in
2187 VC-Dired mode and the visited file of the current buffer is not
2188 under version control) and we're in a Dired buffer, use
2189 the current directory.
2190 The optional argument NOT-URGENT non-nil means it is ok to say no to
2192 (interactive (list current-prefix-arg t
))
2194 (call-interactively 'vc-version-diff
)
2195 (let* ((files (vc-deduce-fileset t
)))
2196 (if buffer-file-name
(vc-buffer-sync not-urgent
))
2197 (vc-diff-internal t files nil nil
(interactive-p)))))
2201 (defun vc-revision-other-window (rev)
2202 "Visit revision REV of the current file in another window.
2203 If the current file is named `F', the revision is named `F.~REV~'.
2204 If `F.~REV~' already exists, use it instead of checking it out again."
2206 (save-current-buffer
2207 (vc-ensure-vc-buffer)
2208 (let ((completion-table
2209 (vc-call revision-completion-table buffer-file-name
))
2210 (prompt "Revision to visit (default is working revision): "))
2212 (if completion-table
2213 (completing-read prompt completion-table
)
2214 (read-string prompt
))))))
2215 (vc-ensure-vc-buffer)
2216 (let* ((file buffer-file-name
)
2217 (revision (if (string-equal rev
"")
2218 (vc-working-revision file
)
2220 (switch-to-buffer-other-window (vc-find-revision file revision
))))
2222 (defun vc-find-revision (file revision
)
2223 "Read REVISION of FILE into a buffer and return the buffer."
2224 (let ((automatic-backup (vc-version-backup-file-name file revision
))
2225 (filebuf (or (get-file-buffer file
) (current-buffer)))
2226 (filename (vc-version-backup-file-name file revision
'manual
)))
2227 (unless (file-exists-p filename
)
2228 (if (file-exists-p automatic-backup
)
2229 (rename-file automatic-backup filename nil
)
2230 (message "Checking out %s..." filename
)
2231 (with-current-buffer filebuf
2234 (let ((coding-system-for-read 'no-conversion
)
2235 (coding-system-for-write 'no-conversion
))
2236 (with-temp-file filename
2237 (let ((outbuf (current-buffer)))
2238 ;; Change buffer to get local value of
2239 ;; vc-checkout-switches.
2240 (with-current-buffer filebuf
2241 (vc-call find-revision file revision outbuf
))))
2243 (when (and failed
(file-exists-p filename
))
2244 (delete-file filename
))))
2245 (vc-mode-line file
))
2246 (message "Checking out %s...done" filename
)))
2247 (let ((result-buf (find-file-noselect filename
)))
2248 (with-current-buffer result-buf
2249 ;; Set the parent buffer so that things like
2250 ;; C-x v g, C-x v l, ... etc work.
2251 (set (make-local-variable 'vc-parent-buffer
) filebuf
))
2254 ;; Header-insertion code
2257 (defun vc-insert-headers ()
2258 "Insert headers into a file for use with a version control system.
2259 Headers desired are inserted at point, and are pulled from
2260 the variable `vc-BACKEND-header'."
2262 (vc-ensure-vc-buffer)
2266 (if (or (not (vc-check-headers))
2267 (y-or-n-p "Version headers already exist. Insert another set? "))
2268 (let* ((delims (cdr (assq major-mode vc-comment-alist
)))
2269 (comment-start-vc (or (car delims
) comment-start
"#"))
2270 (comment-end-vc (or (car (cdr delims
)) comment-end
""))
2271 (hdsym (vc-make-backend-sym (vc-backend buffer-file-name
)
2273 (hdstrings (and (boundp hdsym
) (symbol-value hdsym
))))
2274 (dolist (s hdstrings
)
2275 (insert comment-start-vc
"\t" s
"\t"
2276 comment-end-vc
"\n"))
2277 (if vc-static-header-alist
2278 (dolist (f vc-static-header-alist
)
2279 (if (string-match (car f
) buffer-file-name
)
2280 (insert (format (cdr f
) (car hdstrings
)))))))))))
2282 (defun vc-clear-headers (&optional file
)
2283 "Clear all version headers in the current buffer (or FILE).
2284 The headers are reset to their non-expanded form."
2285 (let* ((filename (or file buffer-file-name
))
2286 (visited (find-buffer-visiting filename
))
2287 (backend (vc-backend filename
)))
2288 (when (vc-find-backend-function backend
'clear-headers
)
2290 (let ((context (vc-buffer-context)))
2291 ;; save-excursion may be able to relocate point and mark
2292 ;; properly. If it fails, vc-restore-buffer-context
2293 ;; will give it a second try.
2295 (vc-call-backend backend
'clear-headers
))
2296 (vc-restore-buffer-context context
))
2297 (set-buffer (find-file-noselect filename
))
2298 (vc-call-backend backend
'clear-headers
)
2299 (kill-buffer filename
)))))
2301 (defun vc-modify-change-comment (files rev oldcomment
)
2302 "Edit the comment associated with the given files and revision."
2304 files rev oldcomment t
2305 "Enter a replacement change comment."
2306 (lambda (files rev comment
)
2308 ;; Less of a kluge than it looks like; log-view mode only passes
2309 ;; this function a singleton list. Arguments left in this form in
2310 ;; case the more general operation ever becomes meaningful.
2311 (vc-responsible-backend (car files
))
2312 'modify-change-comment files rev comment
))))
2316 "Merge changes between two revisions into the current buffer's file.
2317 This asks for two revisions to merge from in the minibuffer. If the
2318 first revision is a branch number, then merge all changes from that
2319 branch. If the first revision is empty, merge news, i.e. recent changes
2320 from the current branch.
2322 See Info node `Merging'."
2324 (vc-ensure-vc-buffer)
2326 (let* ((file buffer-file-name
)
2327 (backend (vc-backend file
))
2328 (state (vc-state file
))
2329 first-revision second-revision status
)
2331 ((stringp state
) ;; Locking VCses only
2332 (error "File is locked by %s" state
))
2333 ((not (vc-editable-p file
))
2335 "File must be checked out for merging. Check out now? ")
2336 (vc-checkout file t
)
2337 (error "Merge aborted"))))
2338 (setq first-revision
2339 (read-string (concat "Branch or revision to merge from "
2340 "(default news on current branch): ")))
2341 (if (string= first-revision
"")
2342 (if (not (vc-find-backend-function backend
'merge-news
))
2343 (error "Sorry, merging news is not implemented for %s" backend
)
2344 (setq status
(vc-call merge-news file
)))
2345 (if (not (vc-find-backend-function backend
'merge
))
2346 (error "Sorry, merging is not implemented for %s" backend
)
2347 (if (not (vc-branch-p first-revision
))
2348 (setq second-revision
2349 (read-string "Second revision: "
2350 (concat (vc-branch-part first-revision
) ".")))
2351 ;; We want to merge an entire branch. Set revisions
2352 ;; accordingly, so that vc-BACKEND-merge understands us.
2353 (setq second-revision first-revision
)
2354 ;; first-revision must be the starting point of the branch
2355 (setq first-revision
(vc-branch-part first-revision
)))
2356 (setq status
(vc-call merge file first-revision second-revision
))))
2357 (vc-maybe-resolve-conflicts file status
"WORKFILE" "MERGE SOURCE")))
2359 (defun vc-maybe-resolve-conflicts (file status
&optional name-A name-B
)
2360 (vc-resynch-buffer file t
(not (buffer-modified-p)))
2361 (if (zerop status
) (message "Merge successful")
2363 (message "File contains conflicts.")))
2366 (defalias 'vc-resolve-conflicts
'smerge-ediff
)
2368 ;; The VC directory major mode. Coopt Dired for this.
2369 ;; All VC commands get mapped into logical equivalents.
2371 (defvar vc-dired-switches
)
2372 (defvar vc-dired-terse-mode
)
2374 (defvar vc-dired-mode-map
2375 (let ((map (make-sparse-keymap))
2376 (vmap (make-sparse-keymap)))
2377 (define-key map
"\C-xv" vmap
)
2378 (define-key map
"v" vmap
)
2379 (set-keymap-parent vmap vc-prefix-map
)
2380 (define-key vmap
"t" 'vc-dired-toggle-terse-mode
)
2383 (define-derived-mode vc-dired-mode dired-mode
"Dired under "
2384 "The major mode used in VC directory buffers.
2386 It works like Dired, but lists only files under version control, with
2387 the current VC state of each file being indicated in the place of the
2388 file's link count, owner, group and size. Subdirectories are also
2389 listed, and you may insert them into the buffer as desired, like in
2392 All Dired commands operate normally, with the exception of `v', which
2393 is redefined as the version control prefix, so that you can type
2394 `vl', `v=' etc. to invoke `vc-print-log', `vc-diff', and the like on
2395 the file named in the current Dired buffer line. `vv' invokes
2396 `vc-next-action' on this file, or on all files currently marked.
2397 There is a special command, `*l', to mark all files currently locked."
2398 ;; define-derived-mode does it for us in Emacs-21, but not in Emacs-20.
2399 ;; We do it here because dired might not be loaded yet
2400 ;; when vc-dired-mode-map is initialized.
2401 (set-keymap-parent vc-dired-mode-map dired-mode-map
)
2402 (add-hook 'dired-after-readin-hook
'vc-dired-hook nil t
)
2403 ;; The following is slightly modified from files.el,
2404 ;; because file lines look a bit different in vc-dired-mode
2405 ;; (the column before the date does not end in a digit).
2406 ;; albinus: It should be done in the original declaration. Problem
2407 ;; is the optional empty state-info; otherwise ")" would be good
2408 ;; enough as delimeter.
2409 (set (make-local-variable 'directory-listing-before-filename-regexp
)
2410 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
2411 ;; In some locales, month abbreviations are as short as 2 letters,
2412 ;; and they can be followed by ".".
2413 (month (concat l l
"+\\.?"))
2415 (yyyy "[0-9][0-9][0-9][0-9]")
2417 (HH:MM
"[ 0-2][0-9]:[0-5][0-9]")
2418 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
2419 (zone "[-+][0-2][0-9][0-5][0-9]")
2420 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
2421 (iso-time (concat HH
:MM
"\\(:" seconds
"\\( ?" zone
"\\)?\\)?"))
2422 (iso (concat "\\(\\(" yyyy
"-\\)?" iso-mm-dd
"[ T]" iso-time
2423 "\\|" yyyy
"-" iso-mm-dd
"\\)"))
2424 (western (concat "\\(" month s
"+" dd
"\\|" dd
"\\.?" s month
"\\)"
2426 "\\(" HH
:MM
"\\|" yyyy
"\\)"))
2427 (western-comma (concat month s
"+" dd
"," s
"+" yyyy
))
2428 ;; Japanese MS-Windows ls-lisp has one-digit months, and
2429 ;; omits the Kanji characters after month and day-of-month.
2432 (concat mm l
"?" s dd l
"?" s
"+"
2433 "\\(" HH
:MM
"\\|" yyyy l
"?" "\\)")))
2434 ;; the .* below ensures that we find the last match on a line
2436 "\\(" western
"\\|" western-comma
"\\|" japanese
"\\|" iso
"\\)"
2438 (and (boundp 'vc-dired-switches
)
2440 (set (make-local-variable 'dired-actual-switches
)
2442 (set (make-local-variable 'vc-dired-terse-mode
) vc-dired-terse-display
)
2443 (let ((backend-name (symbol-name (vc-responsible-backend
2444 default-directory
))))
2445 (setq mode-name
(concat mode-name backend-name
))
2446 ;; Add menu after `vc-dired-mode-map' has `dired-mode-map' as the parent.
2447 (let ((vc-dire-menu-map (copy-keymap vc-menu-map
)))
2448 (define-key-after (lookup-key vc-dired-mode-map
[menu-bar
]) [vc]
2449 (cons backend-name vc-dire-menu-map) 'subdir)))
2450 (setq vc-dired-mode t))
2452 (defun vc-dired-toggle-terse-mode ()
2453 "Toggle terse display in VC Dired."
2455 (if (not vc-dired-mode)
2457 (setq vc-dired-terse-mode (not vc-dired-terse-mode))
2458 (if vc-dired-terse-mode
2462 (defun vc-dired-mark-locked ()
2463 "Mark all files currently locked."
2465 (dired-mark-if (let ((f (dired-get-filename nil t)))
2467 (not (file-directory-p f))
2468 (not (vc-up-to-date-p f))))
2471 (define-key vc-dired-mode-map "*l" 'vc-dired-mark-locked)
2473 (defun vc-dired-reformat-line (vc-info)
2474 "Reformat a directory-listing line.
2475 Replace various columns with version control information, VC-INFO.
2476 This code, like dired, assumes UNIX -l format."
2478 (when (re-search-forward
2479 ;; Match link count, owner, group, size. Group may be missing,
2480 ;; and only the size is present in OS/2 -l format.
2481 "^..[drwxlts-]+ \\( *[0-9]+\\( [^ ]+ +\\([^ ]+ +\\)?[0-9]+\\)?\\) "
2482 (line-end-position) t)
2483 (replace-match (substring (concat vc-info " ") 0 10)
2486 (defun vc-dired-ignorable-p (filename)
2487 "Should FILENAME be ignored in VC-Dired listings?"
2489 ;; Ignore anything that wouldn't be found by completion (.o, .la, etc.)
2490 (dolist (ignorable completion-ignored-extensions)
2491 (let ((ext (substring filename
2492 (- (length filename)
2493 (length ignorable)))))
2494 (if (string= ignorable ext) (throw t t))))
2495 ;; Ignore Makefiles derived from something else
2496 (when (string= (file-name-nondirectory filename) "Makefile")
2497 (let* ((dir (file-name-directory filename))
2498 (peers (directory-files (or dir default-directory))))
2499 (if (or (member "Makefile.in" peers) (member "Makefile.am" peers))
2503 (defun vc-dired-hook ()
2504 "Reformat the listing according to version control.
2505 Called by dired after any portion of a vc-dired buffer has been read in."
2506 (message "Getting version information... ")
2507 ;; if the backend supports it, get the state
2508 ;; of all files in this directory at once
2509 (let ((backend (vc-responsible-backend default-directory)))
2510 ;; check `backend' can really handle `default-directory'.
2511 (if (and (vc-call-backend backend 'responsible-p default-directory)
2512 (vc-find-backend-function backend 'dir-state))
2513 (vc-call-backend backend 'dir-state default-directory)))
2515 (inhibit-read-only t)
2516 (buffer-undo-list t))
2517 (goto-char (point-min))
2520 ;; subdir header line
2523 ;; erase (but don't remove) the "total" line
2524 (delete-region (point) (line-end-position))
2528 ((setq filename (dired-get-filename nil t))
2531 ((file-directory-p filename)
2533 ((member (file-name-nondirectory filename)
2534 vc-directory-exclusion-list)
2535 (let ((pos (point)))
2536 (dired-kill-tree filename)
2539 (vc-dired-terse-mode
2540 ;; Don't show directories in terse mode. Don't use
2541 ;; dired-kill-line to remove it, because in recursive listings,
2542 ;; that would remove the directory contents as well.
2543 (delete-region (line-beginning-position)
2544 (progn (forward-line 1) (point))))
2545 ((string-match "\\`\\.\\.?\\'" (file-name-nondirectory filename))
2548 (vc-dired-reformat-line nil)
2550 ;; Try to head off calling the expensive state query -
2551 ;; ignore object files, TeX intermediate files, and so forth.
2552 ((vc-dired-ignorable-p filename)
2554 ;; Ordinary file -- call the (possibly expensive) state query
2556 ;; First case: unregistered or unknown. (Unknown shouldn't happen here)
2557 ((member (vc-state filename) '(nil unregistered))
2558 (if vc-dired-terse-mode
2560 (vc-dired-reformat-line "?")
2562 ;; Either we're in non-terse mode or it's out of date
2563 ((not (and vc-dired-terse-mode (vc-up-to-date-p filename)))
2564 (vc-dired-reformat-line (vc-call dired-state-info filename))
2566 ;; Remaining cases are under version control but uninteresting
2568 (dired-kill-line))))
2570 (t (forward-line 1))))
2572 (message "Getting version information... done")
2575 (cond ((eq (count-lines (point-min) (point-max)) 1)
2576 (goto-char (point-min))
2577 (message "No changes pending under %s" default-directory)))))
2579 (defun vc-dired-purge ()
2580 "Remove empty subdirs."
2581 (goto-char (point-min))
2582 (while (dired-get-subdir)
2584 (if (dired-get-filename nil t)
2585 (if (not (dired-next-subdir 1 t))
2586 (goto-char (point-max)))
2588 (if (not (string= (dired-current-directory) default-directory))
2589 (dired-do-kill-lines t "")
2590 ;; We cannot remove the top level directory.
2591 ;; Just make it look a little nicer.
2593 (or (eobp) (kill-line))
2594 (if (not (dired-next-subdir 1 t))
2595 (goto-char (point-max))))))
2596 (goto-char (point-min)))
2598 (defun vc-dired-buffers-for-dir (dir)
2599 "Return a list of all vc-dired buffers that currently display DIR."
2601 ;; Check whether dired is loaded.
2602 (when (fboundp 'dired-buffers-for-dir)
2603 (dolist (buffer (dired-buffers-for-dir dir))
2604 (with-current-buffer buffer
2606 (push buffer result)))))
2609 (defun vc-dired-resynch-file (file)
2610 "Update the entries for FILE in any VC Dired buffers that list it."
2611 (let ((buffers (vc-dired-buffers-for-dir (file-name-directory file))))
2613 (mapcar (lambda (buffer)
2614 (with-current-buffer buffer
2615 (if (dired-goto-file file)
2616 ;; bind vc-dired-terse-mode to nil so that
2617 ;; files won't vanish when they are checked in
2618 (let ((vc-dired-terse-mode nil))
2619 (dired-do-redisplay 1)))))
2623 (defun vc-directory (dir read-switches)
2624 "Create a buffer in VC Dired Mode for directory DIR.
2626 See Info node `VC Dired Mode'.
2628 With prefix arg READ-SWITCHES, specify a value to override
2629 `dired-listing-switches' when generating the listing."
2630 (interactive "DDired under VC (directory): \nP")
2631 (let ((vc-dired-switches (concat vc-dired-listing-switches
2632 (if vc-dired-recurse "R" ""))))
2634 (setq vc-dired-switches
2635 (read-string "Dired listing switches: "
2636 vc-dired-switches)))
2638 (require 'dired-aux)
2640 (dired-internal-noselect (expand-file-name (file-name-as-directory dir))
2644 ;;; Experimental code for the vc-dired replacement
2647 (defstruct (vc-status-fileinfo
2649 (:constructor vc-status-create-fileinfo (state name &optional marked))
2650 (:conc-name vc-status-fileinfo->))
2655 (defvar vc-status nil)
2657 (defun vc-status-headers (backend dir)
2659 (format "VC backend : %s\n" backend)
2660 "Repository : The repository goes here\n"
2661 (format "Working dir: %s\n" dir)))
2663 (defun vc-status-printer (fileentry)
2664 "Pretty print FILEENTRY."
2665 ;; If you change the layout here, change vc-status-move-to-goal-column.
2666 (let ((state (vc-status-fileinfo->state fileentry)))
2669 (format "%c" (if (vc-status-fileinfo->marked fileentry) ?* ? ))
2670 'face 'font-lock-type-face)
2673 (format "%-20s" state)
2674 'face (cond ((eq state 'up-to-date) 'font-lock-builtin-face)
2675 ((eq state 'missing) 'font-lock-warning-face)
2676 (t 'font-lock-variable-name-face))
2677 'mouse-face 'highlight)
2680 (format "%s" (vc-status-fileinfo->name fileentry))
2681 'face 'font-lock-function-name-face
2682 'mouse-face 'highlight))))
2684 (defun vc-status-move-to-goal-column ()
2686 ;; Must be in sync with vc-status-printer.
2689 (defun vc-status-prepare-status-buffer (dir &optional create-new)
2690 "Find a *vc-status* buffer showing DIR, or create a new one."
2691 (setq dir (expand-file-name dir))
2692 (let* ((bname "*vc-status*")
2693 ;; Look for another *vc-status* buffer visiting the same directory.
2694 (buf (save-excursion
2696 (dolist (buffer (buffer-list))
2698 (when (and (eq major-mode 'vc-status-mode)
2699 (string= (expand-file-name default-directory) dir))
2700 (return buffer)))))))
2703 ;; Create a new *vc-status* buffer.
2704 (with-current-buffer (create-file-buffer bname)
2706 (vc-setup-buffer (current-buffer))
2707 (current-buffer)))))
2710 (defun vc-status (dir)
2711 "Show the VC status for DIR."
2712 (interactive "DVC status for directory: ")
2713 (switch-to-buffer (vc-status-prepare-status-buffer dir))
2714 (if (eq major-mode 'vc-status-mode)
2718 (defvar vc-status-menu-map
2719 (let ((map (make-sparse-keymap "VC-status")))
2720 (define-key map [quit]
2721 '(menu-item "Quit" bury-buffer
2723 (define-key map [kill]
2724 '(menu-item "Kill Update Command" vc-status-kill-dir-status-process
2725 :enable vc-status-process-buffer
2726 :help "Kill the command that updates VC status buffer"))
2727 (define-key map [refresh]
2728 '(menu-item "Refresh" vc-status-refresh
2729 :enable (not vc-status-process-buffer)
2730 :help "Refresh the contents of the VC status buffer"))
2731 (define-key map [remup]
2732 '(menu-item "Hide up-to-date" vc-status-hide-up-to-date
2733 :help "Hide up-to-date items from display"))
2735 (define-key map [separator-vc-commands] '("--"))
2736 (define-key map [annotate]
2737 '(menu-item "Annotate" vc-annotate
2738 :help "Display the edit history of the current file using colors"))
2739 (define-key map [diff]
2740 '(menu-item "Compare with Base Version" vc-diff
2741 :help "Compare file set with the base version"))
2742 (define-key map [register]
2743 '(menu-item "Register" vc-status-register
2744 :help "Register file set into the version control system"))
2745 ;; vc-print-log uses the current buffer, not a file.
2746 ;; (define-key map [log]
2747 ;; '(menu-item "Show history" vc-status-print-log
2748 ;; :help "List the change log of the current file set in a window"))
2751 (define-key map [separator-movement] '("--"))
2752 (define-key map [next-line]
2753 '(menu-item "Next line" vc-status-next-line
2754 :help "Go to the next line" :keys "n"))
2755 (define-key map [previous-line]
2756 '(menu-item "Previous line" vc-status-previous-line
2757 :help "Go to the previous line"))
2759 (define-key map [separator-marking] '("--"))
2760 (define-key map [unmark-all]
2761 '(menu-item "Unmark All" vc-status-unmark-all-files
2762 :help "Unmark all files that are in the same state as the current file\
2763 \nWith prefix argument unmark all files"))
2764 (define-key map [unmark-previous]
2765 '(menu-item "Unmark previous " vc-status-unmark-file-up
2766 :help "Move to the previous line and unmark the file"))
2768 (define-key map [mark-all]
2769 '(menu-item "Mark All" vc-status-mark-all-files
2770 :help "Mark all files that are in the same state as the current file\
2771 \nWith prefix argument mark all files"))
2772 (define-key map [unmark]
2773 '(menu-item "Unmark" vc-status-unmark
2774 :help "Unmark the current file or all files in the region"))
2776 (define-key map [mark]
2777 '(menu-item "Mark" vc-status-mark
2778 :help "Mark the current file or all files in the region"))
2780 (define-key map [separator-open] '("--"))
2781 (define-key map [open-other]
2782 '(menu-item "Open in other window" vc-status-find-file-other-window
2783 :help "Find the file on the current line, in another window"))
2784 (define-key map [open]
2785 '(menu-item "Open file" vc-status-find-file
2786 :help "Find the file on the current line"))
2788 "Menu for VC status")
2790 (defalias 'vc-status-menu-map vc-status-menu-map)
2792 (defvar vc-status-mode-map
2793 (let ((map (make-keymap)))
2794 (suppress-keymap map)
2796 (define-key map "m" 'vc-status-mark)
2797 (define-key map "M" 'vc-status-mark-all-files)
2798 (define-key map "u" 'vc-status-unmark)
2799 (define-key map "\C-?" 'vc-status-unmark-file-up)
2800 (define-key map "\M-\C-?" 'vc-status-unmark-all-files)
2802 (define-key map "n" 'vc-status-next-line)
2803 (define-key map " " 'vc-status-next-line)
2804 (define-key map "\t" 'vc-status-next-line)
2805 (define-key map "p" 'vc-status-previous-line)
2806 (define-key map [backtab] 'vc-status-previous-line)
2808 (define-key map "=" 'vc-diff)
2809 (define-key map "a" 'vc-status-register)
2810 ;; Can't be "g" (as in vc map), so "A" for "Annotate".
2811 (define-key map "A" 'vc-annotate)
2812 ;; vc-print-log uses the current buffer, not a file.
2813 ;; (define-key map "l" 'vc-status-print-log)
2815 (define-key map "f" 'vc-status-find-file)
2816 (define-key map "\C-m" 'vc-status-find-file)
2817 (define-key map "o" 'vc-status-find-file-other-window)
2818 (define-key map "x" 'vc-status-hide-up-to-date)
2819 (define-key map "q" 'bury-buffer)
2820 (define-key map "g" 'vc-status-refresh)
2821 (define-key map "\C-c\C-c" 'vc-status-kill-dir-status-process)
2822 ;; Not working yet. Functions like vc-status-find-file need to
2823 ;; find the file from the mouse position, not `point'.
2824 ;; (define-key map [(down-mouse-3)] 'vc-status-menu)
2826 ;; Hook up the menu.
2827 (define-key map [menu-bar vc-status-mode]
2829 ;; This is used to that VC backends could add backend specific
2830 ;; menu items to vc-status-menu-map.
2831 "VC Status" vc-status-menu-map :filter vc-status-menu-map-filter))
2833 "Keymap for VC status")
2835 (defun vc-default-extra-status-menu (backend)
2838 (defun vc-status-menu-map-filter (orig-binding)
2839 (when (and (symbolp orig-binding) (fboundp orig-binding))
2840 (setq orig-binding (indirect-function orig-binding)))
2842 (vc-call-backend (vc-responsible-backend default-directory)
2843 'extra-status-menu)))
2844 (if (null ext-binding)
2846 (append orig-binding
2850 (defun vc-status-menu (e)
2851 "Popup the VC status menu."
2853 (popup-menu vc-status-menu-map e))
2855 (defvar vc-status-tool-bar-map
2856 (let ((map (make-sparse-keymap)))
2857 (tool-bar-local-item-from-menu 'vc-status-find-file "open"
2858 map vc-status-mode-map)
2859 (tool-bar-local-item "bookmark_add"
2860 'vc-status-toggle-mark 'vc-status-toggle-mark map
2861 :help "Toggle mark on current item")
2862 (tool-bar-local-item-from-menu 'vc-status-previous-line "left-arrow"
2863 map vc-status-mode-map
2865 (tool-bar-local-item-from-menu 'vc-status-next-line "right-arrow"
2866 map vc-status-mode-map
2868 (tool-bar-local-item-from-menu 'vc-status-refresh "refresh"
2869 map vc-status-mode-map)
2870 (tool-bar-local-item-from-menu 'nonincremental-search-forward
2872 (tool-bar-local-item-from-menu 'vc-status-kill-dir-status-process "cancel"
2873 map vc-status-mode-map)
2874 (tool-bar-local-item-from-menu 'bury-buffer "exit"
2875 map vc-status-mode-map)
2878 (defvar vc-status-process-buffer nil
2879 "The buffer used for the asynchronous call that computes the VC status.")
2881 (defvar vc-status-crt-marked nil
2882 "The list of marked files before `vc-status-refresh'.")
2884 (defun vc-status-mode ()
2885 "Major mode for VC status.
2886 \\{vc-status-mode-map}"
2887 (setq mode-name "*VC Status*")
2888 (setq major-mode 'vc-status-mode)
2889 (setq buffer-read-only t)
2890 (set (make-local-variable 'vc-status-crt-marked) nil)
2891 (use-local-map vc-status-mode-map)
2892 (set (make-local-variable 'tool-bar-map) vc-status-tool-bar-map)
2893 (let ((buffer-read-only nil)
2894 (backend (vc-responsible-backend default-directory))
2897 (set (make-local-variable 'vc-status-process-buffer) nil)
2898 (set (make-local-variable 'vc-status)
2899 (ewoc-create #'vc-status-printer
2900 (vc-status-headers backend default-directory)))
2901 (add-hook 'after-save-hook 'vc-status-mark-buffer-changed)
2902 (vc-status-refresh)))
2904 (put 'vc-status-mode 'mode-class 'special)
2906 (defun vc-update-vc-status-buffer (entries buffer)
2907 (with-current-buffer buffer
2909 ;; Insert the entries we got into the ewoc.
2910 (dolist (entry entries)
2911 (ewoc-enter-last vc-status
2912 (vc-status-create-fileinfo (cdr entry) (car entry))))
2913 ;; If we had marked items before the refresh, try mark them here.
2914 ;; XXX: there should be a better way to do this...
2915 (when vc-status-crt-marked
2918 (when (member (vc-status-fileinfo->name arg) vc-status-crt-marked)
2919 (setf (vc-status-fileinfo->marked arg) t)))
2921 (ewoc-goto-node vc-status (ewoc-nth vc-status 0)))
2922 (setq vc-status-process-buffer nil)
2923 ;; We are done, turn off the mode-line "in progress" message.
2924 (setq mode-line-process nil)))
2926 (defun vc-status-add-entry (entry buffer)
2927 ;; Add one ENTRY to the vc-status buffer BUFFER.
2928 ;; This will be used to automatically add files with the "modified"
2929 ;; state when saving them.
2931 ;; ENTRY is (FILENAME . STATE)
2932 (with-current-buffer buffer
2933 (let ((crt (ewoc-nth vc-status 0))
2934 (fname (car entry)))
2935 ;; First try to see if there's already an entry with that name
2937 (while (and crt (not (string= (vc-status-fileinfo->name
2938 (ewoc-data crt)) fname)))
2939 (setq crt (ewoc-next vc-status crt)))
2942 ;; Found the file, just update the status.
2943 (setf (vc-status-fileinfo->state (ewoc-data crt)) (cdr entry))
2944 (ewoc-invalidate vc-status crt))
2945 ;; Could not find the file, insert a new entry.
2947 vc-status (vc-status-create-fileinfo (cdr entry) (car entry)))))))
2949 (defun vc-status-refresh ()
2950 "Refresh the contents of the VC status buffer.
2951 Throw an error if another update process is in progress."
2953 (if vc-status-process-buffer
2954 (error "Another update process is in progress, cannot run two at a time")
2955 ;; This is not very efficient; ewoc could use a new function here.
2956 ;; We clear the ewoc, but remember the marked files so that we can
2957 ;; mark them after the refresh is done.
2958 (setq vc-status-crt-marked
2961 (vc-status-fileinfo->name elem))
2964 (lambda (crt) (vc-status-fileinfo->marked crt)))))
2965 (ewoc-filter vc-status (lambda (node) nil))
2967 (let ((backend (vc-responsible-backend default-directory)))
2968 (vc-set-mode-line-busy-indicator)
2969 ;; Call the dir-status backend function. dir-status is supposed to
2970 ;; be asynchronous. It should compute the results and call the
2971 ;; function passed as a an arg to update the vc-status buffer with
2973 (setq vc-status-process-buffer
2975 backend 'dir-status default-directory
2976 #'vc-update-vc-status-buffer (current-buffer))))))
2978 (defun vc-status-kill-dir-status-process ()
2979 "Kill the temporary buffer and associated process."
2981 (when (and (bufferp vc-status-process-buffer)
2982 (buffer-live-p vc-status-process-buffer))
2983 (let ((proc (get-buffer-process vc-status-process-buffer)))
2984 (when proc (delete-process proc))
2985 (setq vc-status-process-buffer nil)
2986 (setq mode-line-process nil))))
2988 (defun vc-status-next-line (arg)
2989 "Go to the next line.
2990 If a prefix argument is given, move by that many lines."
2992 (ewoc-goto-next vc-status arg)
2993 (vc-status-move-to-goal-column))
2995 (defun vc-status-previous-line (arg)
2996 "Go to the previous line.
2997 If a prefix argument is given, move by that many lines."
2999 (ewoc-goto-prev vc-status arg)
3000 (vc-status-move-to-goal-column))
3002 (defun vc-status-mark-unmark (mark-unmark-function)
3004 (let ((firstl (line-number-at-pos (region-beginning)))
3005 (lastl (line-number-at-pos (region-end))))
3007 (goto-char (region-beginning))
3008 (while (<= (line-number-at-pos) lastl)
3009 (funcall mark-unmark-function))))
3010 (funcall mark-unmark-function)))
3012 (defun vc-status-mark-file ()
3013 ;; Mark the current file and move to the next line.
3014 (let* ((crt (ewoc-locate vc-status))
3015 (file (ewoc-data crt)))
3016 (setf (vc-status-fileinfo->marked file) t)
3017 (ewoc-invalidate vc-status crt)
3018 (vc-status-next-line 1)))
3020 (defun vc-status-mark ()
3021 "Mark the current file or all files in the region.
3022 If the region is active, mark all the files in the region.
3023 Otherwise mark the file on the current line and move to the next
3026 (vc-status-mark-unmark 'vc-status-mark-file))
3029 ;; XXX: Should this take the region into consideration?
3030 (defun vc-status-mark-all-files (arg)
3031 "Mark all files with the same state as the current one.
3032 With a prefix argument mark all files.
3034 The VC commands operate on files that are on the same state.
3035 This command is intended to make it easy to select all files that
3036 share the same state."
3041 (unless (vc-status-fileinfo->marked filearg)
3042 (setf (vc-status-fileinfo->marked filearg) t)
3045 (let* ((crt (ewoc-locate vc-status))
3046 (crt-state (vc-status-fileinfo->state (ewoc-data crt))))
3049 (when (and (not (vc-status-fileinfo->marked filearg))
3050 (eq (vc-status-fileinfo->state filearg) crt-state))
3051 (setf (vc-status-fileinfo->marked filearg) t)
3055 (defun vc-status-unmark-file ()
3056 ;; Unmark the current file and move to the next line.
3057 (let* ((crt (ewoc-locate vc-status))
3058 (file (ewoc-data crt)))
3059 (setf (vc-status-fileinfo->marked file) nil)
3060 (ewoc-invalidate vc-status crt)
3061 (vc-status-next-line 1)))
3063 (defun vc-status-unmark ()
3064 "Unmark the current file or all files in the region.
3065 If the region is active, unmark all the files in the region.
3066 Otherwise mark the file on the current line and move to the next
3069 (vc-status-mark-unmark 'vc-status-unmark-file))
3071 (defun vc-status-unmark-file-up ()
3072 "Move to the previous line and unmark the file."
3074 ;; If we're on the first line, we won't move up, but we will still
3075 ;; remove the mark. This seems a bit odd but it is what buffer-menu
3077 (let* ((prev (ewoc-goto-prev vc-status 1))
3078 (file (ewoc-data prev)))
3079 (setf (vc-status-fileinfo->marked file) nil)
3080 (ewoc-invalidate vc-status prev)
3081 (vc-status-move-to-goal-column)))
3083 (defun vc-status-unmark-all-files (arg)
3084 "Unmark all files with the same state as the current one.
3085 With a prefix argument mark all files.
3087 The VC commands operate on files that are on the same state.
3088 This command is intended to make it easy to deselect all files
3089 that share the same state."
3094 (when (vc-status-fileinfo->marked filearg)
3095 (setf (vc-status-fileinfo->marked filearg) nil)
3098 (let* ((crt (ewoc-locate vc-status))
3099 (crt-state (vc-status-fileinfo->state (ewoc-data crt))))
3102 (when (and (vc-status-fileinfo->marked filearg)
3103 (eq (vc-status-fileinfo->state filearg) crt-state))
3104 (setf (vc-status-fileinfo->marked filearg) nil)
3108 (defun vc-status-toggle-mark-file ()
3109 (let* ((crt (ewoc-locate vc-status))
3110 (file (ewoc-data crt)))
3111 (if (vc-status-fileinfo->marked file)
3112 (vc-status-unmark-file)
3113 (vc-status-mark-file))))
3115 (defun vc-status-toggle-mark ()
3117 (vc-status-mark-unmark 'vc-status-toggle-mark-file))
3119 (defun vc-status-register ()
3120 "Register the marked files, or the current file if no marks."
3122 (let ((files (or (vc-status-marked-files)
3123 (list (vc-status-current-file)))))
3124 (dolist (file files)
3125 (vc-register file))))
3127 (defun vc-status-find-file ()
3128 "Find the file on the current line."
3130 (find-file (vc-status-current-file)))
3132 (defun vc-status-find-file-other-window ()
3133 "Find the file on the current line, in another window."
3135 (find-file-other-window (vc-status-current-file)))
3137 (defun vc-status-current-file ()
3138 (let ((node (ewoc-locate vc-status)))
3140 (error "No file available."))
3141 (expand-file-name (vc-status-fileinfo->name (ewoc-data node)))))
3143 (defun vc-status-marked-files ()
3144 "Return the list of marked files"
3147 (expand-file-name (vc-status-fileinfo->name elem)))
3150 (lambda (crt) (vc-status-fileinfo->marked crt)))))
3152 (defun vc-status-hide-up-to-date ()
3153 "Hide up-to-date items from display."
3157 (lambda (crt) (not (eq (vc-status-fileinfo->state crt) 'up-to-date)))))
3159 (defun vc-status-mark-buffer-changed (&optional fname)
3160 (let* ((file (or fname (expand-file-name buffer-file-name)))
3161 (state (and (vc-backend file) (vc-state file)))
3162 (found-vc-status-buf nil))
3164 (dolist (status-buf (buffer-list))
3165 (set-buffer status-buf)
3166 ;; look for a vc-status buffer that might show this file.
3167 (when (eq major-mode 'vc-status-mode)
3168 (setq found-vc-status-buf t)
3169 (let ((ddir (expand-file-name default-directory)))
3170 ;; This test is cvs-string-prefix-p
3171 (when (eq t (compare-strings file nil (length ddir) ddir nil nil))
3172 (let* ((file-short (substring file (length ddir)))
3173 (entry (cons file-short (if state state 'unregistered))))
3174 (vc-status-add-entry entry status-buf))))))
3175 ;; We didn't find any vc-status buffers, remove the hook, it is
3177 (unless found-vc-status-buf (remove-hook 'after-save-hook 'vc-status-mark-buffer-changed)))))
3179 ;;; End experimental code.
3181 ;; Named-configuration entry points
3183 (defun vc-snapshot-precondition (dir)
3184 "Scan the tree below DIR, looking for files not up-to-date.
3185 If any file is not up-to-date, return the name of the first such file.
3186 \(This means, neither snapshot creation nor retrieval is allowed.\)
3187 If one or more of the files are currently visited, return `visited'.
3188 Otherwise, return nil."
3190 (catch 'vc-locked-example
3194 (if (not (vc-up-to-date-p f)) (throw 'vc-locked-example f)
3195 (if (get-file-buffer f) (setq status 'visited)))))
3199 (defun vc-create-snapshot (dir name branchp)
3200 "Descending recursively from DIR, make a snapshot called NAME.
3201 For each registered file, the working revision becomes part of
3202 the named configuration. If the prefix argument BRANCHP is
3203 given, the snapshot is made as a new branch and the files are
3204 checked out in that new branch."
3206 (list (read-file-name "Directory: " default-directory default-directory t)
3207 (read-string "New snapshot name: ")
3208 current-prefix-arg))
3209 (message "Making %s... " (if branchp "branch" "snapshot"))
3210 (if (file-directory-p dir) (setq dir (file-name-as-directory dir)))
3211 (vc-call-backend (vc-responsible-backend dir)
3212 'create-snapshot dir name branchp)
3213 (message "Making %s... done" (if branchp "branch" "snapshot")))
3216 (defun vc-retrieve-snapshot (dir name)
3217 "Descending recursively from DIR, retrieve the snapshot called NAME.
3218 If NAME is empty, it refers to the latest revisions.
3219 If locking is used for the files in DIR, then there must not be any
3220 locked files at or below DIR (but if NAME is empty, locked files are
3221 allowed and simply skipped)."
3223 (list (read-file-name "Directory: " default-directory default-directory t)
3224 (read-string "Snapshot name to retrieve (default latest revisions): ")))
3225 (let ((update (yes-or-no-p "Update any affected buffers? "))
3226 (msg (if (or (not name) (string= name ""))
3227 (format "Updating %s... " (abbreviate-file-name dir))
3228 (format "Retrieving snapshot into %s... "
3229 (abbreviate-file-name dir)))))
3231 (vc-call-backend (vc-responsible-backend dir)
3232 'retrieve-snapshot dir name update)
3233 (message "%s" (concat msg "done"))))
3235 ;; Miscellaneous other entry points
3238 (defun vc-print-log (&optional working-revision)
3239 "List the change log of the current fileset in a window.
3240 If WORKING-REVISION is non-nil, leave the point at that revision."
3242 (let* ((files (vc-deduce-fileset))
3243 (backend (vc-backend files))
3244 (working-revision (or working-revision (vc-working-revision (car files)))))
3245 ;; Don't switch to the output buffer before running the command,
3246 ;; so that any buffer-local settings in the vc-controlled
3247 ;; buffer can be accessed by the command.
3248 (vc-call-backend backend 'print-log files "*vc-change-log*")
3249 (pop-to-buffer "*vc-change-log*")
3251 `(let ((inhibit-read-only t))
3252 (vc-call-backend ',backend 'log-view-mode)
3253 (goto-char (point-max)) (forward-line -1)
3254 (while (looking-at "=*\n")
3255 (delete-char (- (match-end 0) (match-beginning 0)))
3257 (goto-char (point-min))
3258 (if (looking-at "[\b\t\n\v\f\r ]+")
3259 (delete-char (- (match-end 0) (match-beginning 0))))
3260 (shrink-window-if-larger-than-buffer)
3261 ;; move point to the log entry for the working revision
3262 (vc-call-backend ',backend 'show-log-entry ',working-revision)
3263 (setq vc-sentinel-movepoint (point))
3264 (set-buffer-modified-p nil)))))
3268 "Revert working copies of the selected fileset to their repository contents.
3269 This asks for confirmation if the buffer contents are not identical
3270 to the working revision (except for keyword expansion)."
3272 (let* ((files (vc-deduce-fileset)))
3273 ;; If any of the files is visited by the current buffer, make
3274 ;; sure buffer is saved. If the user says `no', abort since
3275 ;; we cannot show the changes and ask for confirmation to
3277 (if (or (not files) (memq (buffer-file-name) files))
3278 (vc-buffer-sync nil))
3279 (dolist (file files)
3280 (let ((buf (get-file-buffer file)))
3281 (if (and buf (buffer-modified-p buf))
3282 (error "Please kill or save all modified buffers before reverting.")))
3283 (if (vc-up-to-date-p file)
3284 (unless (yes-or-no-p (format "%s seems up-to-date. Revert anyway? " file))
3285 (error "Revert canceled"))))
3286 (if (vc-diff-internal vc-allow-async-revert files nil nil)
3288 (unless (yes-or-no-p (format "Discard changes in %s? " (vc-delistify files)))
3289 (error "Revert canceled"))
3290 (delete-windows-on "*vc-diff*")
3291 (kill-buffer "*vc-diff*")))
3292 (dolist (file files)
3294 (message "Reverting %s..." (vc-delistify files))
3295 (vc-revert-file file)
3296 (message "Reverting %s...done" (vc-delistify files))))))
3299 (defun vc-rollback ()
3300 "Roll back (remove) the most recent changeset committed to the repository.
3301 This may be either a file-level or a repository-level operation,
3302 depending on the underlying version-control system."
3304 (let* ((files (vc-deduce-fileset))
3305 (backend (vc-backend files))
3306 (granularity (vc-call-backend backend 'revision-granularity)))
3307 (unless (vc-find-backend-function backend 'rollback)
3308 (error "Rollback is not supported in %s" backend))
3309 (if (and (not (eq granularity 'repository)) (/= (length files) 1))
3310 (error "Rollback requires a singleton fileset or repository versioning"))
3311 (if (not (vc-call latest-on-branch-p (car files)))
3312 (error "Rollback is only possible at the tip revision."))
3313 ;; If any of the files is visited by the current buffer, make
3314 ;; sure buffer is saved. If the user says `no', abort since
3315 ;; we cannot show the changes and ask for confirmation to
3317 (if (or (not files) (memq (buffer-file-name) files))
3318 (vc-buffer-sync nil))
3319 (dolist (file files)
3320 (if (buffer-modified-p (get-file-buffer file))
3321 (error "Please kill or save all modified buffers before rollback."))
3322 (if (not (vc-up-to-date-p file))
3323 (error "Please revert all modified workfiles before rollback.")))
3324 ;; Accumulate changes associated with the fileset
3325 (vc-setup-buffer "*vc-diff*")
3327 (message "Finding changes...")
3328 (let* ((tip (vc-working-revision (car files)))
3329 (previous (vc-call previous-revision (car files) tip)))
3330 (vc-diff-internal nil files previous tip))
3332 (unless (yes-or-no-p "Discard these revisions? ")
3333 (error "Rollback canceled"))
3334 (delete-windows-on "*vc-diff*")
3335 (kill-buffer"*vc-diff*")
3336 ;; Do the actual reversions
3337 (message "Rolling back %s..." (vc-delistify files))
3340 (vc-call-backend backend 'rollback files)
3341 `((vc-state . ,'up-to-date)
3342 (vc-checkout-time . , (nth 5 (file-attributes file)))
3343 (vc-working-revision . nil)))
3344 (dolist (f files) (vc-resynch-buffer f t t))
3345 (message "Rolling back %s...done" (vc-delistify files))))
3348 (define-obsolete-function-alias 'vc-revert-buffer 'vc-revert "23.1")
3352 "Update the current fileset's files to their tip revisions.
3353 For each one that contains no changes, and is not locked, then this simply
3354 replaces the work file with the latest revision on its branch. If the file
3355 contains changes, and the backend supports merging news, then any recent
3356 changes from the current branch are merged into the working file."
3358 (dolist (file (vc-deduce-fileset))
3359 (if (buffer-modified-p (get-file-buffer file))
3360 (error "Please kill or save all modified buffers before updating."))
3361 (if (vc-up-to-date-p file)
3362 (vc-checkout file nil t)
3363 (if (eq (vc-checkout-model file) 'locking)
3364 (if (eq (vc-state file) 'edited)
3366 (substitute-command-keys
3367 "File is locked--type \\[vc-revert] to discard changes"))
3368 (error "Unexpected file state (%s) -- type %s"
3370 (substitute-command-keys
3371 "\\[vc-next-action] to correct")))
3372 (if (not (vc-find-backend-function (vc-backend file) 'merge-news))
3373 (error "Sorry, merging news is not implemented for %s"
3375 (vc-maybe-resolve-conflicts file (vc-call merge-news file)))))))
3377 (defun vc-version-backup-file (file &optional rev)
3378 "Return name of backup file for revision REV of FILE.
3379 If version backups should be used for FILE, and there exists
3380 such a backup for REV or the working revision of file, return
3381 its name; otherwise return nil."
3382 (when (vc-call make-version-backups-p file)
3383 (let ((backup-file (vc-version-backup-file-name file rev)))
3384 (if (file-exists-p backup-file)
3386 ;; there is no automatic backup, but maybe the user made one manually
3387 (setq backup-file (vc-version-backup-file-name file rev 'manual))
3388 (if (file-exists-p backup-file)
3391 (defun vc-revert-file (file)
3392 "Revert FILE back to the repository working revision it was based on."
3395 (let ((backup-file (vc-version-backup-file file)))
3397 (copy-file backup-file file 'ok-if-already-exists 'keep-date)
3398 (vc-delete-automatic-version-backups file))
3399 (vc-call revert file backup-file))
3400 `((vc-state . up-to-date)
3401 (vc-checkout-time . ,(nth 5 (file-attributes file)))))
3402 (vc-resynch-buffer file t t))
3405 (defun vc-switch-backend (file backend)
3406 "Make BACKEND the current version control system for FILE.
3407 FILE must already be registered in BACKEND. The change is not
3408 permanent, only for the current session. This function only changes
3409 VC's perspective on FILE, it does not register or unregister it.
3410 By default, this command cycles through the registered backends.
3411 To get a prompt, use a prefix argument."
3414 (or buffer-file-name
3415 (error "There is no version-controlled file in this buffer"))
3416 (let ((backend (vc-backend buffer-file-name))
3419 (error "File %s is not under version control" buffer-file-name))
3420 ;; Find the registered backends.
3421 (dolist (backend vc-handled-backends)
3422 (when (vc-call-backend backend 'registered buffer-file-name)
3423 (push backend backends)))
3424 ;; Find the next backend.
3425 (let ((def (car (delq backend (append (memq backend backends) backends))))
3426 (others (delete backend backends)))
3428 ((null others) (error "No other backend to switch to"))
3433 (format "Switch to backend [%s]: " def)
3434 (mapcar (lambda (b) (list (downcase (symbol-name b)))) backends)
3435 nil t nil nil (downcase (symbol-name def))))))
3437 (unless (eq backend (vc-backend file))
3438 (vc-file-clearprops file)
3439 (vc-file-setprop file 'vc-backend backend)
3440 ;; Force recomputation of the state
3441 (unless (vc-call-backend backend 'registered file)
3442 (vc-file-clearprops file)
3443 (error "%s is not registered in %s" file backend))
3444 (vc-mode-line file)))
3447 (defun vc-transfer-file (file new-backend)
3448 "Transfer FILE to another version control system NEW-BACKEND.
3449 If NEW-BACKEND has a higher precedence than FILE's current backend
3450 \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in
3451 NEW-BACKEND, using the revision number from the current backend as the
3452 base level. If NEW-BACKEND has a lower precedence than the current
3453 backend, then commit all changes that were made under the current
3454 backend to NEW-BACKEND, and unregister FILE from the current backend.
3455 \(If FILE is not yet registered under NEW-BACKEND, register it.)"
3456 (let* ((old-backend (vc-backend file))
3457 (edited (memq (vc-state file) '(edited needs-merge)))
3458 (registered (vc-call-backend new-backend 'registered file))
3460 (and registered ; Never move if not registered in new-backend yet.
3461 ;; move if new-backend comes later in vc-handled-backends
3462 (or (memq new-backend (memq old-backend vc-handled-backends))
3463 (y-or-n-p "Final transfer? "))))
3465 (if (eq old-backend new-backend)
3466 (error "%s is the current backend of %s" new-backend file))
3468 (set-file-modes file (logior (file-modes file) 128))
3469 ;; `registered' might have switched under us.
3470 (vc-switch-backend file old-backend)
3471 (let* ((rev (vc-working-revision file))
3472 (modified-file (and edited (make-temp-file file)))
3473 (unmodified-file (and modified-file (vc-version-backup-file file))))
3474 ;; Go back to the base unmodified file.
3478 (copy-file file modified-file 'ok-if-already-exists)
3479 ;; If we have a local copy of the unmodified file, handle that
3480 ;; here and not in vc-revert-file because we don't want to
3481 ;; delete that copy -- it is still useful for OLD-BACKEND.
3483 (copy-file unmodified-file file
3484 'ok-if-already-exists 'keep-date)
3485 (if (y-or-n-p "Get base revision from master? ")
3486 (vc-revert-file file))))
3487 (vc-call-backend new-backend 'receive-file file rev))
3489 (vc-switch-backend file new-backend)
3490 (unless (eq (vc-checkout-model file) 'implicit)
3491 (vc-checkout file t nil))
3492 (rename-file modified-file file 'ok-if-already-exists)
3493 (vc-file-setprop file 'vc-checkout-time nil)))))
3495 (vc-switch-backend file old-backend)
3496 (setq comment (vc-call comment-history file))
3497 (vc-call unregister file))
3498 (vc-switch-backend file new-backend)
3499 (when (or move edited)
3500 (vc-file-setprop file 'vc-state 'edited)
3502 (vc-checkin file nil comment (stringp comment)))))
3504 (defun vc-rename-master (oldmaster newfile templates)
3505 "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES."
3506 (let* ((dir (file-name-directory (expand-file-name oldmaster)))
3507 (newdir (or (file-name-directory newfile) ""))
3508 (newbase (file-name-nondirectory newfile))
3510 ;; List of potential master files for `newfile'
3512 (lambda (s) (vc-possible-master s newdir newbase))
3514 (if (or (file-symlink-p oldmaster)
3515 (file-symlink-p (file-name-directory oldmaster)))
3516 (error "This is unsafe in the presence of symbolic links"))
3520 ;; If possible, keep the master file in the same directory.
3522 (if (and f (string= (file-name-directory (expand-file-name f)) dir))
3524 ;; If not, just use the first possible place.
3526 (and f (or (not (setq dir (file-name-directory f)))
3527 (file-directory-p dir))
3529 (error "New file lacks a version control directory")))))
3531 (defun vc-delete-file (file)
3532 "Delete file and mark it as such in the version control system."
3533 (interactive "fVC delete file: ")
3534 (setq file (expand-file-name file))
3535 (let ((buf (get-file-buffer file))
3536 (backend (vc-backend file)))
3538 (error "File %s is not under version control"
3539 (file-name-nondirectory file)))
3540 (unless (vc-find-backend-function backend 'delete-file)
3541 (error "Deleting files under %s is not supported in VC" backend))
3542 (if (and buf (buffer-modified-p buf))
3543 (error "Please save files before deleting them"))
3544 (unless (y-or-n-p (format "Really want to delete %s? "
3545 (file-name-nondirectory file)))
3547 (unless (or (file-directory-p file) (null make-backup-files))
3548 (with-current-buffer (or buf (find-file-noselect file))
3549 (let ((backup-inhibited nil))
3551 ;; If we didn't have a buffer visiting the file before this
3552 ;; command, kill the buffer created by the above
3553 ;; `find-file-noselect' call.
3554 (unless buf (kill-buffer (current-buffer)))))
3555 (vc-call delete-file file)
3556 ;; If the backend hasn't deleted the file itself, let's do it for him.
3557 (if (file-exists-p file) (delete-file file))
3558 ;; Forget what VC knew about the file.
3559 (vc-file-clearprops file)
3560 (vc-resynch-buffer file buf t)))
3563 (defun vc-rename-file (old new)
3564 "Rename file OLD to NEW, and rename its master file likewise."
3565 (interactive "fVC rename file: \nFRename to: ")
3566 (let ((oldbuf (get-file-buffer old)))
3567 (if (and oldbuf (buffer-modified-p oldbuf))
3568 (error "Please save files before moving them"))
3569 (if (get-file-buffer new)
3570 (error "Already editing new file name"))
3571 (if (file-exists-p new)
3572 (error "New file already exists"))
3573 (let ((state (vc-state old)))
3574 (unless (memq state '(up-to-date edited))
3575 (error "Please %s files before moving them"
3576 (if (stringp state) "check in" "update"))))
3577 (vc-call rename-file old new)
3578 (vc-file-clearprops old)
3579 ;; Move the actual file (unless the backend did it already)
3580 (if (file-exists-p old) (rename-file old new))
3581 ;; ?? Renaming a file might change its contents due to keyword expansion.
3582 ;; We should really check out a new copy if the old copy was precisely equal
3583 ;; to some checked-in revision. However, testing for this is tricky....
3585 (with-current-buffer oldbuf
3586 (let ((buffer-read-only buffer-read-only))
3587 (set-visited-file-name new))
3590 (set-buffer-modified-p nil)))))
3593 (defun vc-update-change-log (&rest args)
3594 "Find change log file and add entries from recent version control logs.
3595 Normally, find log entries for all registered files in the default
3598 With prefix arg of \\[universal-argument], only find log entries for the current buffer's file.
3600 With any numeric prefix arg, find log entries for all currently visited
3601 files that are under version control. This puts all the entries in the
3602 log for the default directory, which may not be appropriate.
3604 From a program, any ARGS are assumed to be filenames for which
3605 log entries should be gathered."
3607 (cond ((consp current-prefix-arg) ;C-u
3608 (list buffer-file-name))
3609 (current-prefix-arg ;Numeric argument.
3611 (buffers (buffer-list))
3614 (setq file (buffer-file-name (car buffers)))
3615 (and file (vc-backend file)
3616 (setq files (cons file files)))
3617 (setq buffers (cdr buffers)))
3620 ;; Don't supply any filenames to backend; this means
3621 ;; it should find all relevant files relative to
3622 ;; the default-directory.
3624 (vc-call-backend (vc-responsible-backend default-directory)
3625 'update-changelog args))
3627 ;;; The default back end. Assumes RCS-like revision numbering.
3629 (defun vc-default-revision-granularity ()
3630 (error "Your backend will not work with this version of VC mode."))
3632 ;; functions that operate on RCS revision numbers. This code should
3633 ;; also be moved into the backends. It stays for now, however, since
3634 ;; it is used in code below.
3636 (defun vc-trunk-p (rev)
3637 "Return t if REV is a revision on the trunk."
3638 (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev))))
3640 (defun vc-branch-p (rev)
3641 "Return t if REV is a branch revision."
3642 (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev))))
3645 (defun vc-branch-part (rev)
3646 "Return the branch part of a revision number REV."
3647 (let ((index (string-match "\\.[0-9]+\\'" rev)))
3649 (substring rev 0 index))))
3651 (defun vc-minor-part (rev)
3652 "Return the minor revision number of a revision number REV."
3653 (string-match "[0-9]+\\'" rev)
3654 (substring rev (match-beginning 0) (match-end 0)))
3656 (defun vc-default-previous-revision (backend file rev)
3657 "Return the revision number immediately preceding REV for FILE,
3658 or nil if there is no previous revision. This default
3659 implementation works for MAJOR.MINOR-style revision numbers as
3660 used by RCS and CVS."
3661 (let ((branch (vc-branch-part rev))
3662 (minor-num (string-to-number (vc-minor-part rev))))
3665 ;; revision does probably not start a branch or release
3666 (concat branch "." (number-to-string (1- minor-num)))
3667 (if (vc-trunk-p rev)
3668 ;; we are at the beginning of the trunk --
3669 ;; don't know anything to return here
3671 ;; we are at the beginning of a branch --
3672 ;; return revision of starting point
3673 (vc-branch-part branch))))))
3675 (defun vc-default-next-revision (backend file rev)
3676 "Return the revision number immediately following REV for FILE,
3677 or nil if there is no next revision. This default implementation
3678 works for MAJOR.MINOR-style revision numbers as used by RCS
3680 (when (not (string= rev (vc-working-revision file)))
3681 (let ((branch (vc-branch-part rev))
3682 (minor-num (string-to-number (vc-minor-part rev))))
3683 (concat branch "." (number-to-string (1+ minor-num))))))
3685 (defun vc-default-responsible-p (backend file)
3686 "Indicate whether BACKEND is reponsible for FILE.
3687 The default is to return nil always."
3690 (defun vc-default-could-register (backend file)
3691 "Return non-nil if BACKEND could be used to register FILE.
3692 The default implementation returns t for all files."
3695 (defun vc-default-latest-on-branch-p (backend file)
3696 "Return non-nil if FILE is the latest on its branch.
3697 This default implementation always returns non-nil, which means that
3698 editing non-current revisions is not supported by default."
3701 (defun vc-default-init-revision (backend) vc-default-init-revision)
3703 (defalias 'vc-cvs-update-changelog 'vc-update-changelog-rcs2log)
3704 (defalias 'vc-rcs-update-changelog 'vc-update-changelog-rcs2log)
3705 ;; FIXME: This should probably be moved to vc-rcs.el and replaced in
3706 ;; vc-cvs.el by code using cvs2cl.
3707 (defun vc-update-changelog-rcs2log (files)
3708 "Default implementation of update-changelog.
3709 Uses `rcs2log' which only works for RCS and CVS."
3710 ;; FIXME: We (c|sh)ould add support for cvs2cl
3711 (let ((odefault default-directory)
3712 (changelog (find-change-log))
3713 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
3714 (tempfile (make-temp-file
3715 (expand-file-name "vc"
3716 (or small-temporary-file-directory
3717 temporary-file-directory))))
3718 (login-name (or user-login-name
3719 (format "uid%d" (number-to-string (user-uid)))))
3720 (full-name (or add-log-full-name
3723 (format "uid%d" (number-to-string (user-uid)))))
3724 (mailing-address (or add-log-mailing-address
3725 user-mail-address)))
3726 (find-file-other-window changelog)
3727 (barf-if-buffer-read-only)
3730 (goto-char (point-min))
3732 (message "Computing change log entries...")
3733 (message "Computing change log entries... %s"
3736 (setq default-directory odefault)
3737 (if (eq 0 (apply 'call-process
3738 (expand-file-name "rcs2log"
3740 nil (list t tempfile) nil
3742 "-u" (concat login-name
3744 "\t" mailing-address)
3748 (expand-file-name f odefault)))
3751 (pop-to-buffer (get-buffer-create "*vc*"))
3753 (insert-file-contents tempfile)
3755 (setq default-directory (file-name-directory changelog))
3756 (delete-file tempfile)))))
3758 (defun vc-default-find-revision (backend file rev buffer)
3759 "Provide the new `find-revision' op based on the old `checkout' op.
3760 This is only for compatibility with old backends. They should be updated
3761 to provide the `find-revision' operation instead."
3762 (let ((tmpfile (make-temp-file (expand-file-name file))))
3765 (vc-call-backend backend 'checkout file nil rev tmpfile)
3766 (with-current-buffer buffer
3767 (insert-file-contents-literally tmpfile)))
3768 (delete-file tmpfile))))
3770 (defun vc-default-dired-state-info (backend file)
3771 (let* ((state (vc-state file))
3774 ((stringp state) (concat "(" state ")"))
3775 ((eq state 'edited) "(modified)")
3776 ((eq state 'needs-merge) "(merge)")
3777 ((eq state 'needs-patch) "(patch)")
3778 ((eq state 'added) "(added)")
3779 ((eq state 'removed) "(removed)")
3780 ((eq state 'ignored) "(ignored)") ;; dired-hook filters this out
3781 ((eq state 'unregistered) "?")
3782 ((eq state 'unlocked-changes) "(stale)")
3783 ((not state) "(unknown)")))
3785 (get-file-buffer file))
3787 (if (and buffer (buffer-modified-p buffer)) "+" "")))
3788 (concat statestring modflag)))
3790 (defun vc-default-rename-file (backend old new)
3792 (add-name-to-file old new)
3793 (error (rename-file old new)))
3794 (vc-delete-file old)
3795 (with-current-buffer (find-file-noselect new)
3798 (defalias 'vc-default-logentry-check 'ignore)
3799 (defalias 'vc-default-check-headers 'ignore)
3801 (defun vc-default-log-view-mode (backend) (log-view-mode))
3803 (defun vc-default-show-log-entry (backend rev)
3805 (log-view-goto-rev rev)))
3807 (defun vc-default-comment-history (backend file)
3808 "Return a string with all log entries stored in BACKEND for FILE."
3809 (if (vc-find-backend-function backend 'print-log)
3810 (with-current-buffer "*vc*"
3811 (vc-call print-log (list file))
3812 (vc-call-backend backend 'wash-log)
3815 (defun vc-default-receive-file (backend file rev)
3816 "Let BACKEND receive FILE from another version control system."
3817 (vc-call-backend backend 'register file rev ""))
3819 (defun vc-default-create-snapshot (backend dir name branchp)
3821 (error "VC backend %s does not support module branches" backend))
3822 (let ((result (vc-snapshot-precondition dir)))
3823 (if (stringp result)
3824 (error "File %s is not up-to-date" result)
3828 (vc-call assign-name f name))))))
3830 (defun vc-default-retrieve-snapshot (backend dir name update)
3831 (if (string= name "")
3838 (vc-call checkout f nil "")
3839 (if update (vc-resynch-buffer f t t)))))))
3840 (let ((result (vc-snapshot-precondition dir)))
3841 (if (stringp result)
3842 (error "File %s is locked" result)
3843 (setq update (and (eq result 'visited) update))
3846 (lambda (f) (vc-error-occurred
3847 (vc-call checkout f nil name)
3848 (if update (vc-resynch-buffer f t t)))))))))
3850 (defun vc-default-revert (backend file contents-done)
3851 (unless contents-done
3852 (let ((rev (vc-working-revision file))
3853 (file-buffer (or (get-file-buffer file) (current-buffer))))
3854 (message "Checking out %s..." file)
3856 (backup-name (car (find-backup-file-name file))))
3858 (copy-file file backup-name 'ok-if-already-exists 'keep-date)
3859 (unless (file-writable-p file)
3860 (set-file-modes file (logior (file-modes file) 128))))
3862 (let ((coding-system-for-read 'no-conversion)
3863 (coding-system-for-write 'no-conversion))
3864 (with-temp-file file
3865 (let ((outbuf (current-buffer)))
3866 ;; Change buffer to get local value of vc-checkout-switches.
3867 (with-current-buffer file-buffer
3868 (let ((default-directory (file-name-directory file)))
3869 (vc-call find-revision file rev outbuf)))))
3873 (rename-file backup-name file 'ok-if-already-exists)
3874 (and (not vc-make-backup-files) (delete-file backup-name))))))
3875 (message "Checking out %s...done" file))))
3877 (defalias 'vc-default-revision-completion-table 'ignore)
3879 (defun vc-check-headers ()
3880 "Check if the current file has any headers in it."
3882 (vc-call-backend (vc-backend buffer-file-name) 'check-headers))
3884 ;;; Annotate functionality
3886 ;; Declare globally instead of additional parameter to
3887 ;; temp-buffer-show-function (not possible to pass more than one
3888 ;; parameter). The use of annotate-ratio is deprecated in favor of
3889 ;; annotate-mode, which replaces it with the more sensible "span-to
3890 ;; days", along with autoscaling support.
3891 (defvar vc-annotate-ratio nil "Global variable.")
3893 ;; internal buffer-local variables
3894 (defvar vc-annotate-backend nil)
3895 (defvar vc-annotate-parent-file nil)
3896 (defvar vc-annotate-parent-rev nil)
3897 (defvar vc-annotate-parent-display-mode nil)
3899 (defconst vc-annotate-font-lock-keywords
3900 ;; The fontification is done by vc-annotate-lines instead of font-lock.
3901 '((vc-annotate-lines)))
3903 (define-derived-mode vc-annotate-mode fundamental-mode "Annotate"
3904 "Major mode for output buffers of the `vc-annotate' command.
3906 You can use the mode-specific menu to alter the time-span of the used
3907 colors. See variable `vc-annotate-menu-elements' for customizing the
3909 ;; Frob buffer-invisibility-spec so that if it is originally a naked t,
3910 ;; it will become a list, to avoid initial annotations being invisible.
3911 (add-to-invisibility-spec 'foo)
3912 (remove-from-invisibility-spec 'foo)
3913 (set (make-local-variable 'truncate-lines) t)
3914 (set (make-local-variable 'font-lock-defaults)
3915 '(vc-annotate-font-lock-keywords t))
3918 (defun vc-annotate-toggle-annotation-visibility ()
3919 "Toggle whether or not the annotation is visible."
3921 (funcall (if (memq 'vc-annotate-annotation buffer-invisibility-spec)
3922 'remove-from-invisibility-spec
3923 'add-to-invisibility-spec)
3924 'vc-annotate-annotation)
3925 (force-window-update (current-buffer)))
3927 (defun vc-annotate-display-default (ratio)
3928 "Display the output of \\[vc-annotate] using the default color range.
3929 The color range is given by `vc-annotate-color-map', scaled by RATIO.
3930 The current time is used as the offset."
3931 (interactive (progn (kill-local-variable 'vc-annotate-color-map) '(1.0)))
3932 (message "Redisplaying annotation...")
3933 (vc-annotate-display ratio)
3934 (message "Redisplaying annotation...done"))
3936 (defun vc-annotate-oldest-in-map (color-map)
3937 "Return the oldest time in the COLOR-MAP."
3938 ;; Since entries should be sorted, we can just use the last one.
3939 (caar (last color-map)))
3941 (defun vc-annotate-get-time-set-line-props ()
3943 (date (vc-call-backend vc-annotate-backend 'annotate-time))
3944 (inhibit-read-only t))
3945 (assert (>= (point) bol))
3946 (put-text-property bol (point) 'invisible 'vc-annotate-annotation)
3949 (defun vc-annotate-display-autoscale (&optional full)
3950 "Highlight the output of \\[vc-annotate] using an autoscaled color map.
3951 Autoscaling means that the map is scaled from the current time to the
3952 oldest annotation in the buffer, or, with prefix argument FULL, to
3953 cover the range from the oldest annotation to the newest."
3956 (oldest 999999.) ;Any CVS users at the founding of Rome?
3957 (current (vc-annotate-convert-time (current-time)))
3959 (message "Redisplaying annotation...")
3960 ;; Run through this file and find the oldest and newest dates annotated.
3962 (goto-char (point-min))
3964 (when (setq date (vc-annotate-get-time-set-line-props))
3968 (setq oldest date)))
3970 (vc-annotate-display
3971 (/ (- (if full newest current) oldest)
3972 (vc-annotate-oldest-in-map vc-annotate-color-map))
3974 (message "Redisplaying annotation...done \(%s\)"
3976 (format "Spanned from %.1f to %.1f days old"
3979 (format "Spanned to %.1f days old" (- current oldest))))))
3981 ;; Menu -- Using easymenu.el
3982 (easy-menu-define vc-annotate-mode-menu vc-annotate-mode-map
3983 "VC Annotate Display Menu"
3985 ["By Color Map Range" (unless (null vc-annotate-display-mode)
3986 (setq vc-annotate-display-mode nil)
3987 (vc-annotate-display-select))
3988 :style toggle :selected (null vc-annotate-display-mode)]
3989 ,@(let ((oldest-in-map (vc-annotate-oldest-in-map vc-annotate-color-map)))
3990 (mapcar (lambda (element)
3991 (let ((days (* element oldest-in-map)))
3992 `[,(format "Span %.1f days" days)
3993 (vc-annotate-display-select nil ,days)
3994 :style toggle :selected
3995 (eql vc-annotate-display-mode ,days) ]))
3996 vc-annotate-menu-elements))
3998 (vc-annotate-display-select
3999 nil (float (string-to-number (read-string "Span how many days? "))))]
4002 (unless (eq vc-annotate-display-mode 'scale)
4003 (vc-annotate-display-select nil 'scale))
4005 "Use an autoscaled color map from the oldest annotation to the current time"
4006 :style toggle :selected
4007 (eq vc-annotate-display-mode 'scale)]
4008 ["Span Oldest->Newest"
4009 (unless (eq vc-annotate-display-mode 'fullscale)
4010 (vc-annotate-display-select nil 'fullscale))
4012 "Use an autoscaled color map from the oldest to the newest annotation"
4013 :style toggle :selected
4014 (eq vc-annotate-display-mode 'fullscale)]
4016 ["Toggle annotation visibility" vc-annotate-toggle-annotation-visibility
4018 "Toggle whether the annotation is visible or not"]
4019 ["Annotate previous revision" vc-annotate-prev-revision
4020 :help "Visit the annotation of the revision previous to this one"]
4021 ["Annotate next revision" vc-annotate-next-revision
4022 :help "Visit the annotation of the revision after this one"]
4023 ["Annotate revision at line" vc-annotate-revision-at-line
4025 "Visit the annotation of the revision identified in the current line"]
4026 ["Annotate revision previous to line" vc-annotate-revision-previous-to-line
4027 :help "Visit the annotation of the revision before the revision at line"]
4028 ["Annotate latest revision" vc-annotate-working-revision
4029 :help "Visit the annotation of the working revision of this file"]
4030 ["Show log of revision at line" vc-annotate-show-log-revision-at-line
4031 :help "Visit the log of the revision at line"]
4032 ["Show diff of revision at line" vc-annotate-show-diff-revision-at-line
4034 "Visit the diff of the revision at line from its previous revision"]
4035 ["Visit revision at line" vc-annotate-find-revision-at-line
4036 :help "Visit the revision identified in the current line"]))
4038 (defun vc-annotate-display-select (&optional buffer mode)
4039 "Highlight the output of \\[vc-annotate].
4040 By default, the current buffer is highlighted, unless overridden by
4041 BUFFER. `vc-annotate-display-mode' specifies the highlighting mode to
4042 use; you may override this using the second optional arg MODE."
4044 (if mode (setq vc-annotate-display-mode mode))
4045 (pop-to-buffer (or buffer (current-buffer)))
4046 (cond ((null vc-annotate-display-mode)
4047 ;; The ratio is global, thus relative to the global color-map.
4048 (kill-local-variable 'vc-annotate-color-map)
4049 (vc-annotate-display-default (or vc-annotate-ratio 1.0)))
4050 ;; One of the auto-scaling modes
4051 ((eq vc-annotate-display-mode 'scale)
4052 (vc-exec-after `(vc-annotate-display-autoscale)))
4053 ((eq vc-annotate-display-mode 'fullscale)
4054 (vc-exec-after `(vc-annotate-display-autoscale t)))
4055 ((numberp vc-annotate-display-mode) ; A fixed number of days lookback
4056 (vc-annotate-display-default
4057 (/ vc-annotate-display-mode
4058 (vc-annotate-oldest-in-map vc-annotate-color-map))))
4059 (t (error "No such display mode: %s"
4060 vc-annotate-display-mode))))
4063 (defun vc-annotate (file rev &optional display-mode buf move-point-to)
4064 "Display the edit history of the current file using colors.
4066 This command creates a buffer that shows, for each line of the current
4067 file, when it was last edited and by whom. Additionally, colors are
4068 used to show the age of each line--blue means oldest, red means
4069 youngest, and intermediate colors indicate intermediate ages. By
4070 default, the time scale stretches back one year into the past;
4071 everything that is older than that is shown in blue.
4073 With a prefix argument, this command asks two questions in the
4074 minibuffer. First, you may enter a revision number; then the buffer
4075 displays and annotates that revision instead of the working revision
4076 \(type RET in the minibuffer to leave that default unchanged). Then,
4077 you are prompted for the time span in days which the color range
4078 should cover. For example, a time span of 20 days means that changes
4079 over the past 20 days are shown in red to blue, according to their
4080 age, and everything that is older than that is shown in blue.
4082 If MOVE-POINT-TO is given, move the point to that line.
4084 Customization variables:
4086 `vc-annotate-menu-elements' customizes the menu elements of the
4087 mode-specific menu. `vc-annotate-color-map' and
4088 `vc-annotate-very-old-color' define the mapping of time to colors.
4089 `vc-annotate-background' specifies the background color."
4091 (save-current-buffer
4092 (vc-ensure-vc-buffer)
4093 (list buffer-file-name
4094 (let ((def (vc-working-revision buffer-file-name)))
4095 (if (null current-prefix-arg) def
4097 (format "Annotate from revision (default %s): " def)
4099 (if (null current-prefix-arg)
4100 vc-annotate-display-mode
4101 (float (string-to-number
4102 (read-string "Annotate span days (default 20): "
4104 (vc-ensure-vc-buffer)
4105 (setq vc-annotate-display-mode display-mode) ;Not sure why. --Stef
4106 (let* ((temp-buffer-name (format "*Annotate %s (rev %s)*" (buffer-name) rev))
4107 (temp-buffer-show-function 'vc-annotate-display-select)
4108 ;; If BUF is specified, we presume the caller maintains current line,
4109 ;; so we don't need to do it here. This implementation may give
4110 ;; strange results occasionally in the case of REV != WORKFILE-REV.
4111 (current-line (or move-point-to (unless buf (line-number-at-pos)))))
4112 (message "Annotating...")
4113 ;; If BUF is specified it tells in which buffer we should put the
4114 ;; annotations. This is used when switching annotations to another
4115 ;; revision, so we should update the buffer's name.
4116 (if buf (with-current-buffer buf
4117 (rename-buffer temp-buffer-name t)
4118 ;; In case it had to be uniquified.
4119 (setq temp-buffer-name (buffer-name))))
4120 (with-output-to-temp-buffer temp-buffer-name
4121 (vc-call annotate-command file (get-buffer temp-buffer-name) rev)
4122 ;; we must setup the mode first, and then set our local
4123 ;; variables before the show-function is called at the exit of
4124 ;; with-output-to-temp-buffer
4125 (with-current-buffer temp-buffer-name
4126 (if (not (equal major-mode 'vc-annotate-mode))
4128 (set (make-local-variable 'vc-annotate-backend) (vc-backend file))
4129 (set (make-local-variable 'vc-annotate-parent-file) file)
4130 (set (make-local-variable 'vc-annotate-parent-rev) rev)
4131 (set (make-local-variable 'vc-annotate-parent-display-mode)
4134 (with-current-buffer temp-buffer-name
4137 ;; Ideally, we'd rather not move point if the user has already
4138 ;; moved it elsewhere, but really point here is not the position
4139 ;; of the user's cursor :-(
4140 (when ,current-line ;(and (bobp))
4141 (goto-line ,current-line)
4142 (setq vc-sentinel-movepoint (point)))
4143 (unless (active-minibuffer-window)
4144 (message "Annotating... done")))))))
4146 (defun vc-annotate-prev-revision (prefix)
4147 "Visit the annotation of the revision previous to this one.
4149 With a numeric prefix argument, annotate the revision that many
4150 revisions previous."
4152 (vc-annotate-warp-revision (- 0 prefix)))
4154 (defun vc-annotate-next-revision (prefix)
4155 "Visit the annotation of the revision after this one.
4157 With a numeric prefix argument, annotate the revision that many
4160 (vc-annotate-warp-revision prefix))
4162 (defun vc-annotate-working-revision ()
4163 "Visit the annotation of the working revision of this file."
4165 (if (not (equal major-mode 'vc-annotate-mode))
4166 (message "Cannot be invoked outside of a vc annotate buffer")
4167 (let ((warp-rev (vc-working-revision vc-annotate-parent-file)))
4168 (if (equal warp-rev vc-annotate-parent-rev)
4169 (message "Already at revision %s" warp-rev)
4170 (vc-annotate-warp-revision warp-rev)))))
4172 (defun vc-annotate-extract-revision-at-line ()
4173 "Extract the revision number of the current line."
4174 ;; This function must be invoked from a buffer in vc-annotate-mode
4175 (vc-call-backend vc-annotate-backend 'annotate-extract-revision-at-line))
4177 (defun vc-annotate-revision-at-line ()
4178 "Visit the annotation of the revision identified in the current line."
4180 (if (not (equal major-mode 'vc-annotate-mode))
4181 (message "Cannot be invoked outside of a vc annotate buffer")
4182 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
4183 (if (not rev-at-line)
4184 (message "Cannot extract revision number from the current line")
4185 (if (equal rev-at-line vc-annotate-parent-rev)
4186 (message "Already at revision %s" rev-at-line)
4187 (vc-annotate-warp-revision rev-at-line))))))
4189 (defun vc-annotate-find-revision-at-line ()
4190 "Visit the revision identified in the current line."
4192 (if (not (equal major-mode 'vc-annotate-mode))
4193 (message "Cannot be invoked outside of a vc annotate buffer")
4194 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
4195 (if (not rev-at-line)
4196 (message "Cannot extract revision number from the current line")
4197 (vc-revision-other-window rev-at-line)))))
4199 (defun vc-annotate-revision-previous-to-line ()
4200 "Visit the annotation of the revision before the revision at line."
4202 (if (not (equal major-mode 'vc-annotate-mode))
4203 (message "Cannot be invoked outside of a vc annotate buffer")
4204 (let ((rev-at-line (vc-annotate-extract-revision-at-line))
4206 (if (not rev-at-line)
4207 (message "Cannot extract revision number from the current line")
4209 (vc-call previous-revision vc-annotate-parent-file rev-at-line))
4210 (vc-annotate-warp-revision prev-rev)))))
4212 (defun vc-annotate-show-log-revision-at-line ()
4213 "Visit the log of the revision at line."
4215 (if (not (equal major-mode 'vc-annotate-mode))
4216 (message "Cannot be invoked outside of a vc annotate buffer")
4217 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
4218 (if (not rev-at-line)
4219 (message "Cannot extract revision number from the current line")
4220 (vc-print-log rev-at-line)))))
4222 (defun vc-annotate-show-diff-revision-at-line ()
4223 "Visit the diff of the revision at line from its previous revision."
4225 (if (not (equal major-mode 'vc-annotate-mode))
4226 (message "Cannot be invoked outside of a vc annotate buffer")
4227 (let ((rev-at-line (vc-annotate-extract-revision-at-line))
4229 (if (not rev-at-line)
4230 (message "Cannot extract revision number from the current line")
4232 (vc-call previous-revision vc-annotate-parent-file rev-at-line))
4234 (message "Cannot diff from any revision prior to %s" rev-at-line)
4235 (save-window-excursion
4236 (vc-diff-internal nil (list vc-annotate-parent-file)
4237 prev-rev rev-at-line))
4238 (switch-to-buffer "*vc-diff*"))))))
4240 (defun vc-annotate-warp-revision (revspec)
4241 "Annotate the revision described by REVSPEC.
4243 If REVSPEC is a positive integer, warp that many revisions
4244 forward, if possible, otherwise echo a warning message. If
4245 REVSPEC is a negative integer, warp that many revisions backward,
4246 if possible, otherwise echo a warning message. If REVSPEC is a
4247 string, then it describes a revision number, so warp to that
4249 (if (not (equal major-mode 'vc-annotate-mode))
4250 (message "Cannot be invoked outside of a vc annotate buffer")
4251 (let* ((buf (current-buffer))
4252 (oldline (line-number-at-pos))
4253 (revspeccopy revspec)
4256 ((and (integerp revspec) (> revspec 0))
4257 (setq newrev vc-annotate-parent-rev)
4258 (while (and (> revspec 0) newrev)
4259 (setq newrev (vc-call next-revision
4260 vc-annotate-parent-file newrev))
4261 (setq revspec (1- revspec)))
4263 (message "Cannot increment %d revisions from revision %s"
4264 revspeccopy vc-annotate-parent-rev)))
4265 ((and (integerp revspec) (< revspec 0))
4266 (setq newrev vc-annotate-parent-rev)
4267 (while (and (< revspec 0) newrev)
4268 (setq newrev (vc-call previous-revision
4269 vc-annotate-parent-file newrev))
4270 (setq revspec (1+ revspec)))
4272 (message "Cannot decrement %d revisions from revision %s"
4273 (- 0 revspeccopy) vc-annotate-parent-rev)))
4274 ((stringp revspec) (setq newrev revspec))
4275 (t (error "Invalid argument to vc-annotate-warp-revision")))
4277 (vc-annotate vc-annotate-parent-file newrev
4278 vc-annotate-parent-display-mode
4280 ;; Pass the current line so that vc-annotate will
4281 ;; place the point in the line.
4282 (min oldline (progn (goto-char (point-max))
4284 (line-number-at-pos))))))))
4286 (defun vc-annotate-compcar (threshold a-list)
4287 "Test successive cons cells of A-LIST against THRESHOLD.
4288 Return the first cons cell with a car that is not less than THRESHOLD,
4289 nil if no such cell exists."
4291 (tmp-cons (car a-list)))
4292 (while (and tmp-cons (< (car tmp-cons) threshold))
4293 (setq tmp-cons (car (nthcdr i a-list)))
4295 tmp-cons)) ; Return the appropriate value
4297 (defun vc-annotate-convert-time (time)
4298 "Convert a time value to a floating-point number of days.
4299 The argument TIME is a list as returned by `current-time' or
4300 `encode-time', only the first two elements of that list are considered."
4301 (/ (+ (* (float (car time)) (lsh 1 16)) (cadr time)) 24 3600))
4303 (defun vc-annotate-difference (&optional offset)
4304 "Return the time span in days to the next annotation.
4305 This calls the backend function annotate-time, and returns the
4306 difference in days between the time returned and the current time,
4307 or OFFSET if present."
4308 (let ((next-time (vc-annotate-get-time-set-line-props)))
4311 (vc-call-backend vc-annotate-backend 'annotate-current-time))
4314 (defun vc-default-annotate-current-time (backend)
4315 "Return the current time, encoded as fractional days."
4316 (vc-annotate-convert-time (current-time)))
4318 (defvar vc-annotate-offset nil)
4320 (defun vc-annotate-display (ratio &optional offset)
4321 "Highlight `vc-annotate' output in the current buffer.
4322 RATIO, is the expansion that should be applied to `vc-annotate-color-map'.
4323 The annotations are relative to the current time, unless overridden by OFFSET."
4325 (set (make-local-variable 'vc-annotate-color-map)
4326 (mapcar (lambda (elem) (cons (* (car elem) ratio) (cdr elem)))
4327 vc-annotate-color-map)))
4328 (set (make-local-variable 'vc-annotate-offset) offset)
4331 (defun vc-annotate-lines (limit)
4332 (while (< (point) limit)
4333 (let ((difference (vc-annotate-difference vc-annotate-offset))
4335 (end (progn (forward-line 1) (point))))
4337 (let* ((color (or (vc-annotate-compcar difference vc-annotate-color-map)
4338 (cons nil vc-annotate-very-old-color)))
4339 ;; substring from index 1 to remove any leading `#' in the name
4340 (face-name (concat "vc-annotate-face-"
4342 (substring (cdr color) 0 1) "#")
4343 (substring (cdr color) 1)
4345 ;; Make the face if not done.
4346 (face (or (intern-soft face-name)
4347 (let ((tmp-face (make-face (intern face-name))))
4348 (set-face-foreground tmp-face (cdr color))
4349 (if vc-annotate-background
4350 (set-face-background tmp-face
4351 vc-annotate-background))
4352 tmp-face)))) ; Return the face
4353 (put-text-property start end 'face face)))))
4354 ;; Pretend to font-lock there were no matches.
4358 ;; Set up key bindings for use while editing log messages
4360 (defun vc-log-edit (fileset)
4361 "Set up `log-edit' for use with VC on FILE."
4362 (setq default-directory
4363 (with-current-buffer vc-parent-buffer default-directory))
4364 (log-edit 'vc-finish-logentry
4366 `((log-edit-listfun . (lambda () ',fileset))
4367 (log-edit-diff-function . (lambda () (vc-diff nil)))))
4368 (set (make-local-variable 'vc-log-fileset) fileset)
4369 (make-local-variable 'vc-log-revision)
4370 (set-buffer-modified-p nil)
4371 (setq buffer-file-name nil))
4373 ;; These things should probably be generally available
4375 (defun vc-file-tree-walk (dirname func &rest args)
4376 "Walk recursively through DIRNAME.
4377 Invoke FUNC f ARGS on each VC-managed file f underneath it."
4378 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
4379 (message "Traversing directory %s...done" dirname))
4381 (defun vc-file-tree-walk-internal (file func args)
4382 (if (not (file-directory-p file))
4383 (if (vc-backend file) (apply func file args))
4384 (message "Traversing directory %s..." (abbreviate-file-name file))
4385 (let ((dir (file-name-as-directory file)))
4388 (string-equal f ".")
4389 (string-equal f "..")
4390 (member f vc-directory-exclusion-list)
4391 (let ((dirf (expand-file-name f dir)))
4393 (file-symlink-p dirf) ;; Avoid possible loops.
4394 (vc-file-tree-walk-internal dirf func args)))))
4395 (directory-files dir)))))
4399 ;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
4401 ;; These may be useful to anyone who has to debug or extend the package.
4402 ;; (Note that this information corresponds to versions 5.x. Some of it
4403 ;; might have been invalidated by the additions to support branching
4404 ;; and RCS keyword lookup. AS, 1995/03/24)
4406 ;; A fundamental problem in VC is that there are time windows between
4407 ;; vc-next-action's computations of the file's version-control state and
4408 ;; the actions that change it. This is a window open to lossage in a
4409 ;; multi-user environment; someone else could nip in and change the state
4410 ;; of the master during it.
4412 ;; The performance problem is that rlog/prs calls are very expensive; we want
4413 ;; to avoid them as much as possible.
4417 ;; The performance problem, it turns out, simplifies in practice to the
4418 ;; problem of making vc-state fast. The two other functions that call
4419 ;; prs/rlog will not be so commonly used that the slowdown is a problem; one
4420 ;; makes snapshots, the other deletes the calling user's last change in the
4423 ;; The race condition implies that we have to either (a) lock the master
4424 ;; during the entire execution of vc-next-action, or (b) detect and
4425 ;; recover from errors resulting from dispatch on an out-of-date state.
4427 ;; Alternative (a) appears to be infeasible. The problem is that we can't
4428 ;; guarantee that the lock will ever be removed. Suppose a user starts a
4429 ;; checkin, the change message buffer pops up, and the user, having wandered
4430 ;; off to do something else, simply forgets about it?
4432 ;; Alternative (b), on the other hand, works well with a cheap way to speed up
4433 ;; vc-state. Usually, if a file is registered, we can read its locked/
4434 ;; unlocked state and its current owner from its permissions.
4436 ;; This shortcut will fail if someone has manually changed the workfile's
4437 ;; permissions; also if developers are munging the workfile in several
4438 ;; directories, with symlinks to a master (in this latter case, the
4439 ;; permissions shortcut will fail to detect a lock asserted from another
4442 ;; Note that these cases correspond exactly to the errors which could happen
4443 ;; because of a competing checkin/checkout race in between two instances of
4446 ;; For VC's purposes, a workfile/master pair may have the following states:
4448 ;; A. Unregistered. There is a workfile, there is no master.
4450 ;; B. Registered and not locked by anyone.
4452 ;; C. Locked by calling user and unchanged.
4454 ;; D. Locked by the calling user and changed.
4456 ;; E. Locked by someone other than the calling user.
4458 ;; This makes for 25 states and 20 error conditions. Here's the matrix:
4460 ;; VC's idea of state
4462 ;; V Actual state RCS action SCCS action Effect
4464 ;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
4465 ;; B 5 . 6 7 8 co -l get -e checkout
4466 ;; C 9 10 . 11 12 co -u unget; get revert
4467 ;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
4468 ;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
4470 ;; All commands take the master file name as a last argument (not shown).
4472 ;; In the discussion below, a "self-race" is a pathological situation in
4473 ;; which VC operations are being attempted simultaneously by two or more
4474 ;; Emacsen running under the same username.
4476 ;; The vc-next-action code has the following windows:
4479 ;; Between the check for existence of a master file and the call to
4480 ;; admin/checkin in vc-buffer-admin (apparent state A). This window may
4481 ;; never close if the initial-comment feature is on.
4484 ;; Between the call to vc-workfile-unchanged-p in and the immediately
4485 ;; following revert (apparent state C).
4488 ;; Between the call to vc-workfile-unchanged-p in and the following
4489 ;; checkin (apparent state D). This window may never close.
4492 ;; Between the unlock and the immediately following checkout during a
4493 ;; revert operation (apparent state C). Included in window Q.
4496 ;; Between vc-state and the following checkout (apparent state B).
4499 ;; Between vc-state and the following revert (apparent state C).
4500 ;; Includes windows Q and S.
4503 ;; Between vc-state and the following checkin (apparent state
4504 ;; D). This window may never be closed if the user fails to complete the
4505 ;; checkin message. Includes window R.
4508 ;; Between vc-state and the following steal-lock (apparent
4509 ;; state E). This window may never close if the user fails to complete
4510 ;; the steal-lock message. Includes window X.
4513 ;; Between the unlock and the immediately following re-lock during a
4514 ;; steal-lock operation (apparent state E). This window may never close
4515 ;; if the user fails to complete the steal-lock message.
4519 ;; Apparent state A ---
4521 ;; 1. File looked unregistered but is actually registered and not locked.
4523 ;; Potential cause: someone else's admin during window P, with
4524 ;; caller's admin happening before their checkout.
4526 ;; RCS: Prior to version 5.6.4, ci fails with message
4527 ;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
4528 ;; ci -i option and the message is "<file>,v: already exists".
4529 ;; SCCS: admin will fail with error (ad19).
4531 ;; We can let these errors be passed up to the user.
4533 ;; 2. File looked unregistered but is actually locked by caller, unchanged.
4535 ;; Potential cause: self-race during window P.
4537 ;; RCS: Prior to version 5.6.4, reverts the file to the last saved
4538 ;; version and unlocks it. From 5.6.4 onwards, VC uses the new
4539 ;; ci -i option, failing with message "<file>,v: already exists".
4540 ;; SCCS: will fail with error (ad19).
4542 ;; Either of these consequences is acceptable.
4544 ;; 3. File looked unregistered but is actually locked by caller, changed.
4546 ;; Potential cause: self-race during window P.
4548 ;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
4549 ;; a delta with a null change comment (the -t- switch will be
4550 ;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
4551 ;; failing with message "<file>,v: already exists".
4552 ;; SCCS: will fail with error (ad19).
4554 ;; 4. File looked unregistered but is locked by someone else.
4556 ;; Potential cause: someone else's admin during window P, with
4557 ;; caller's admin happening *after* their checkout.
4559 ;; RCS: Prior to version 5.6.4, ci fails with a
4560 ;; "no lock set by <user>" message. From 5.6.4 onwards,
4561 ;; VC uses the new ci -i option, failing with message
4562 ;; "<file>,v: already exists".
4563 ;; SCCS: will fail with error (ad19).
4565 ;; We can let these errors be passed up to the user.
4567 ;; Apparent state B ---
4569 ;; 5. File looked registered and not locked, but is actually unregistered.
4571 ;; Potential cause: master file got nuked during window P.
4573 ;; RCS: will fail with "RCS/<file>: No such file or directory"
4574 ;; SCCS: will fail with error ut4.
4576 ;; We can let these errors be passed up to the user.
4578 ;; 6. File looked registered and not locked, but is actually locked by the
4579 ;; calling user and unchanged.
4581 ;; Potential cause: self-race during window T.
4583 ;; RCS: in the same directory as the previous workfile, co -l will fail
4584 ;; with "co error: writable foo exists; checkout aborted". In any other
4585 ;; directory, checkout will succeed.
4586 ;; SCCS: will fail with ge17.
4588 ;; Either of these consequences is acceptable.
4590 ;; 7. File looked registered and not locked, but is actually locked by the
4591 ;; calling user and changed.
4595 ;; 8. File looked registered and not locked, but is actually locked by another
4598 ;; Potential cause: someone else checks it out during window T.
4600 ;; RCS: co error: revision 1.3 already locked by <user>
4601 ;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
4603 ;; We can let these errors be passed up to the user.
4605 ;; Apparent state C ---
4607 ;; 9. File looks locked by calling user and unchanged, but is unregistered.
4611 ;; 10. File looks locked by calling user and unchanged, but is actually not
4614 ;; Potential cause: a self-race in window U, or by the revert's
4615 ;; landing during window X of some other user's steal-lock or window S
4616 ;; of another user's revert.
4618 ;; RCS: succeeds, refreshing the file from the identical version in
4620 ;; SCCS: fails with error ut4 (p file nonexistent).
4622 ;; Either of these consequences is acceptable.
4624 ;; 11. File is locked by calling user. It looks unchanged, but is actually
4627 ;; Potential cause: the file would have to be touched by a self-race
4630 ;; The revert will succeed, removing whatever changes came with
4631 ;; the touch. It is theoretically possible that work could be lost.
4633 ;; 12. File looks like it's locked by the calling user and unchanged, but
4634 ;; it's actually locked by someone else.
4636 ;; Potential cause: a steal-lock in window V.
4638 ;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
4639 ;; SCCS: fails with error un2
4641 ;; We can pass these errors up to the user.
4643 ;; Apparent state D ---
4645 ;; 13. File looks like it's locked by the calling user and changed, but it's
4646 ;; actually unregistered.
4648 ;; Potential cause: master file got nuked during window P.
4650 ;; RCS: Prior to version 5.6.4, checks in the user's version as an
4651 ;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
4652 ;; option, failing with message "no such file or directory".
4653 ;; SCCS: will fail with error ut4.
4655 ;; This case is kind of nasty. Under RCS prior to version 5.6.4,
4656 ;; VC may fail to detect the loss of previous version information.
4658 ;; 14. File looks like it's locked by the calling user and changed, but it's
4659 ;; actually unlocked.
4661 ;; Potential cause: self-race in window V, or the checkin happening
4662 ;; during the window X of someone else's steal-lock or window S of
4663 ;; someone else's revert.
4665 ;; RCS: ci will fail with "no lock set by <user>".
4666 ;; SCCS: delta will fail with error ut4.
4668 ;; 15. File looks like it's locked by the calling user and changed, but it's
4669 ;; actually locked by the calling user and unchanged.
4671 ;; Potential cause: another self-race --- a whole checkin/checkout
4672 ;; sequence by the calling user would have to land in window R.
4674 ;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
4675 ;; RCS: reverts to the file state as of the second user's checkin, leaving
4676 ;; the file unlocked.
4678 ;; It is theoretically possible that work could be lost under RCS.
4680 ;; 16. File looks like it's locked by the calling user and changed, but it's
4681 ;; actually locked by a different user.
4683 ;; RCS: ci error: no lock set by <user>
4684 ;; SCCS: unget will fail with error un2
4686 ;; We can pass these errors up to the user.
4688 ;; Apparent state E ---
4690 ;; 17. File looks like it's locked by some other user, but it's actually
4695 ;; 18. File looks like it's locked by some other user, but it's actually
4698 ;; Potential cause: someone released a lock during window W.
4700 ;; RCS: The calling user will get the lock on the file.
4701 ;; SCCS: unget -n will fail with cm4.
4703 ;; Either of these consequences will be OK.
4705 ;; 19. File looks like it's locked by some other user, but it's actually
4706 ;; locked by the calling user and unchanged.
4708 ;; Potential cause: the other user relinquishing a lock followed by
4709 ;; a self-race, both in window W.
4711 ;; Under both RCS and SCCS, both unlock and lock will succeed, making
4712 ;; the sequence a no-op.
4714 ;; 20. File looks like it's locked by some other user, but it's actually
4715 ;; locked by the calling user and changed.
4721 ;; In order of decreasing severity:
4723 ;; Cases 11 and 15 are the only ones that potentially lose work.
4724 ;; They would require a self-race for this to happen.
4726 ;; Case 13 in RCS loses information about previous deltas, retaining
4727 ;; only the information in the current workfile. This can only happen
4728 ;; if the master file gets nuked in window P.
4730 ;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
4731 ;; no change comment in the master. This would require a self-race in
4732 ;; window P or R respectively.
4734 ;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
4736 ;; Unfortunately, it appears to me that no recovery is possible in these
4737 ;; cases. They don't yield error messages, so there's no way to tell that
4738 ;; a race condition has occurred.
4740 ;; All other cases don't change either the workfile or the master, and
4741 ;; trigger command errors which the user will see.
4743 ;; Thus, there is no explicit recovery code.
4745 ;; arch-tag: ca82c1de-3091-4e26-af92-460abc6213a6