Merge from emacs--rel--22
[bpt/emacs.git] / lisp / vc.el
1 ;;; vc.el --- drive a version-control system from within Emacs
2
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
4 ;; 2001, 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5
6 ;; Author: FSF (see below for full credits)
7 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
8 ;; Keywords: tools
9
10 ;; $Id$
11
12 ;; This file is part of GNU Emacs.
13
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 3, or (at your option)
17 ;; any later version.
18
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
23
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27 ;; Boston, MA 02110-1301, USA.
28
29 ;;; Credits:
30
31 ;; VC was initially designed and implemented by Eric S. Raymond
32 ;; <esr@snark.thyrsus.com>. Over the years, many people have
33 ;; 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>
44
45 ;;; Commentary:
46
47 ;; This mode is fully documented in the Emacs user's manual.
48 ;;
49 ;; Supported version-control systems presently include CVS, RCS, GNU
50 ;; Arch, Subversion, Bzr, Mercurial, Meta-CVS, and SCCS (or its free
51 ;; replacement, CSSC).
52 ;;
53 ;; Some features will not work with old RCS versions. Where
54 ;; appropriate, VC finds out which version you have, and allows or
55 ;; disallows those features (stealing locks, for example, works only
56 ;; from 5.6.2 onwards).
57 ;; Even initial checkins will fail if your RCS version is so old that ci
58 ;; doesn't understand -t-; this has been known to happen to people running
59 ;; NExTSTEP 3.0.
60 ;;
61 ;; You can support the RCS -x option by customizing vc-rcs-master-templates.
62 ;;
63 ;; Proper function of the SCCS diff commands requires the shellscript vcdiff
64 ;; to be installed somewhere on Emacs's path for executables.
65 ;;
66 ;; If your site uses the ChangeLog convention supported by Emacs, the
67 ;; function log-edit-comment-to-change-log could prove a useful checkin hook,
68 ;; although you might prefer to use C-c C-a (i.e. log-edit-insert-changelog)
69 ;; from the commit buffer instead or to set `log-edit-setup-invert'.
70 ;;
71 ;; The vc code maintains some internal state in order to reduce expensive
72 ;; version-control operations to a minimum. Some names are only computed
73 ;; once. If you perform version control operations with the backend while
74 ;; vc's back is turned, or move/rename master files while vc is running,
75 ;; vc may get seriously confused. Don't do these things!
76 ;;
77 ;; Developer's notes on some concurrency issues are included at the end of
78 ;; the file.
79 ;;
80 ;; ADDING SUPPORT FOR OTHER BACKENDS
81 ;;
82 ;; VC can use arbitrary version control systems as a backend. To add
83 ;; support for a new backend named SYS, write a library vc-sys.el that
84 ;; contains functions of the form `vc-sys-...' (note that SYS is in lower
85 ;; case for the function and library names). VC will use that library if
86 ;; you put the symbol SYS somewhere into the list of
87 ;; `vc-handled-backends'. Then, for example, if `vc-sys-registered'
88 ;; returns non-nil for a file, all SYS-specific versions of VC commands
89 ;; will be available for that file.
90 ;;
91 ;; VC keeps some per-file information in the form of properties (see
92 ;; vc-file-set/getprop in vc-hooks.el). The backend-specific functions
93 ;; do not generally need to be aware of these properties. For example,
94 ;; `vc-sys-workfile-version' should compute the workfile version and
95 ;; return it; it should not look it up in the property, and it needn't
96 ;; store it there either. However, if a backend-specific function does
97 ;; store a value in a property, that value takes precedence over any
98 ;; value that the generic code might want to set (check for uses of
99 ;; the macro `with-vc-properties' in vc.el).
100 ;;
101 ;; In the list of functions below, each identifier needs to be prepended
102 ;; with `vc-sys-'. Some of the functions are mandatory (marked with a
103 ;; `*'), others are optional (`-').
104 ;;
105 ;; BACKEND PROPERTIES
106 ;;
107 ;; * revision-granularity
108 ;;
109 ;; Takes no arguments. Returns either 'file or 'repository.
110 ;;
111 ;; STATE-QUERYING FUNCTIONS
112 ;;
113 ;; * registered (file)
114 ;;
115 ;; Return non-nil if FILE is registered in this backend. Both this
116 ;; function as well as `state' should be careful to fail gracefully
117 ;; in the event that the backend executable is absent. It is
118 ;; preferable that this function's body is autoloaded, that way only
119 ;; calling vc-registered does not cause the backend to be loaded
120 ;; (all the vc-FOO-registered functions are called to try to find
121 ;; the controlling backend for FILE.
122 ;;
123 ;; * state (file)
124 ;;
125 ;; Return the current version control state of FILE. For a list of
126 ;; possible values, see `vc-state'. This function should do a full and
127 ;; reliable state computation; it is usually called immediately after
128 ;; C-x v v. If you want to use a faster heuristic when visiting a
129 ;; file, put that into `state-heuristic' below.
130 ;;
131 ;; - state-heuristic (file)
132 ;;
133 ;; If provided, this function is used to estimate the version control
134 ;; state of FILE at visiting time. It should be considerably faster
135 ;; than the implementation of `state'. For a list of possible values,
136 ;; see the doc string of `vc-state'.
137 ;;
138 ;; - dir-state (dir)
139 ;;
140 ;; If provided, this function is used to find the version control state
141 ;; of all files in DIR in a fast way. The function should not return
142 ;; anything, but rather store the files' states into the corresponding
143 ;; `vc-state' properties.
144 ;;
145 ;; * workfile-version (file)
146 ;;
147 ;; Return the current workfile version of FILE.
148 ;;
149 ;; - latest-on-branch-p (file)
150 ;;
151 ;; Return non-nil if the current workfile version of FILE is the latest
152 ;; on its branch. The default implementation always returns t, which
153 ;; means that working with non-current versions is not supported by
154 ;; default.
155 ;;
156 ;; * checkout-model (file)
157 ;;
158 ;; Indicate whether FILE needs to be "checked out" before it can be
159 ;; edited. See `vc-checkout-model' for a list of possible values.
160 ;;
161 ;; - workfile-unchanged-p (file)
162 ;;
163 ;; Return non-nil if FILE is unchanged from its current workfile
164 ;; version. This function should do a brief comparison of FILE's
165 ;; contents with those of the master version. If the backend does not
166 ;; have such a brief-comparison feature, the default implementation of
167 ;; this function can be used, which delegates to a full
168 ;; vc-BACKEND-diff. (Note that vc-BACKEND-diff must not run
169 ;; asynchronously in this case, see variable `vc-disable-async-diff'.)
170 ;;
171 ;; - mode-line-string (file)
172 ;;
173 ;; If provided, this function should return the VC-specific mode
174 ;; line string for FILE. The returned string should have a
175 ;; `help-echo' property which is the text to be displayed as a
176 ;; tooltip when the mouse hovers over the VC entry on the mode-line.
177 ;; The default implementation deals well with all states that
178 ;; `vc-state' can return.
179 ;;
180 ;; - dired-state-info (file)
181 ;;
182 ;; Translate the `vc-state' property of FILE into a string that can be
183 ;; used in a vc-dired buffer. The default implementation deals well
184 ;; with all states that `vc-state' can return.
185 ;;
186 ;; STATE-CHANGING FUNCTIONS
187 ;;
188 ;; * create-repo ()
189 ;;
190 ;; Create an empty repository in the current directory and initialize
191 ;; it so VC mode can add files to it. For file-oriented systems, this
192 ;; need do no more than create a subdirectory with the right name.
193 ;;
194 ;; * register (files &optional rev comment)
195 ;;
196 ;; Register FILES in this backend. Optionally, an initial revision REV
197 ;; and an initial description of the file, COMMENT, may be specified,
198 ;; but it is not guaranteed that the backend will do anything with this.
199 ;; The implementation should pass the value of vc-register-switches
200 ;; to the backend command. (Note: in older versions of VC, this
201 ;; command took a single file argument and not a list.)
202 ;;
203 ;; - init-version (file)
204 ;;
205 ;; The initial version to use when registering FILE if one is not
206 ;; specified by the user. If not provided, the variable
207 ;; vc-default-init-version is used instead.
208 ;;
209 ;; - responsible-p (file)
210 ;;
211 ;; Return non-nil if this backend considers itself "responsible" for
212 ;; FILE, which can also be a directory. This function is used to find
213 ;; out what backend to use for registration of new files and for things
214 ;; like change log generation. The default implementation always
215 ;; returns nil.
216 ;;
217 ;; - could-register (file)
218 ;;
219 ;; Return non-nil if FILE could be registered under this backend. The
220 ;; default implementation always returns t.
221 ;;
222 ;; - receive-file (file rev)
223 ;;
224 ;; Let this backend "receive" a file that is already registered under
225 ;; another backend. The default implementation simply calls `register'
226 ;; for FILE, but it can be overridden to do something more specific,
227 ;; e.g. keep revision numbers consistent or choose editing modes for
228 ;; FILE that resemble those of the other backend.
229 ;;
230 ;; - unregister (file)
231 ;;
232 ;; Unregister FILE from this backend. This is only needed if this
233 ;; backend may be used as a "more local" backend for temporary editing.
234 ;;
235 ;; * checkin (files rev comment)
236 ;;
237 ;; Commit changes in FILES to this backend. If REV is non-nil, that
238 ;; should become the new revision number (not all backends do
239 ;; anything with it). COMMENT is used as a check-in comment. The
240 ;; implementation should pass the value of vc-checkin-switches to
241 ;; the backend command. (Note: in older versions of VC, this
242 ;; command took a single file argument and not a list.)
243 ;;
244 ;; * find-version (file rev buffer)
245 ;;
246 ;; Fetch revision REV of file FILE and put it into BUFFER.
247 ;; If REV is the empty string, fetch the head of the trunk.
248 ;; The implementation should pass the value of vc-checkout-switches
249 ;; to the backend command.
250 ;;
251 ;; * checkout (file &optional editable rev)
252 ;;
253 ;; Check out revision REV of FILE into the working area. If EDITABLE
254 ;; is non-nil, FILE should be writable by the user and if locking is
255 ;; used for FILE, a lock should also be set. If REV is non-nil, that
256 ;; is the revision to check out (default is current workfile version).
257 ;; If REV is t, that means to check out the head of the current branch;
258 ;; if it is the empty string, check out the head of the trunk.
259 ;; The implementation should pass the value of vc-checkout-switches
260 ;; to the backend command.
261 ;;
262 ;; * revert (file &optional contents-done)
263 ;;
264 ;; Revert FILE back to the current workfile version. If optional
265 ;; arg CONTENTS-DONE is non-nil, then the contents of FILE have
266 ;; already been reverted from a version backup, and this function
267 ;; only needs to update the status of FILE within the backend.
268 ;;
269 ;; - rollback (files)
270 ;;
271 ;; Remove the tip version of each of FILES from the repository. If
272 ;; this function is not provided, trying to cancel a version is
273 ;; caught as an error. (Most backends don't provide it.) (Also
274 ;; note that older versions of this backend command were called
275 ;; 'cancel-version' and took a single file arg, not a list of
276 ;; files.)
277 ;;
278 ;; - merge (file rev1 rev2)
279 ;;
280 ;; Merge the changes between REV1 and REV2 into the current working file.
281 ;;
282 ;; - merge-news (file)
283 ;;
284 ;; Merge recent changes from the current branch into FILE.
285 ;;
286 ;; - steal-lock (file &optional version)
287 ;;
288 ;; Steal any lock on the current workfile version of FILE, or on
289 ;; VERSION if that is provided. This function is only needed if
290 ;; locking is used for files under this backend, and if files can
291 ;; indeed be locked by other users.
292 ;;
293 ;; HISTORY FUNCTIONS
294 ;;
295 ;; * print-log (files &optional buffer)
296 ;;
297 ;; Insert the revision log for FILES into BUFFER, or the *vc* buffer
298 ;; if BUFFER is nil. (Note: older versions of this function expected
299 ;; only a single file argument.)
300 ;;
301 ;; - log-view-mode ()
302 ;;
303 ;; Mode to use for the output of print-log. This defaults to
304 ;; `log-view-mode' and is expected to be changed (if at all) to a derived
305 ;; mode of `log-view-mode'.
306 ;;
307 ;; - show-log-entry (version)
308 ;;
309 ;; If provided, search the log entry for VERSION in the current buffer,
310 ;; and make sure it is displayed in the buffer's window. The default
311 ;; implementation of this function works for RCS-style logs.
312 ;;
313 ;; - wash-log (file)
314 ;;
315 ;; Remove all non-comment information from the output of print-log. The
316 ;; default implementation of this function works for RCS-style logs.
317 ;;
318 ;; - logentry-check ()
319 ;;
320 ;; If defined, this function is run to find out whether the user
321 ;; entered a valid log entry for check-in. The log entry is in the
322 ;; current buffer, and if it is not a valid one, the function should
323 ;; throw an error.
324 ;;
325 ;; - comment-history (file)
326 ;;
327 ;; Return a string containing all log entries that were made for FILE.
328 ;; This is used for transferring a file from one backend to another,
329 ;; retaining comment information. The default implementation of this
330 ;; function does this by calling print-log and then wash-log, and
331 ;; returning the resulting buffer contents as a string.
332 ;;
333 ;; - update-changelog (files)
334 ;;
335 ;; Using recent log entries, create ChangeLog entries for FILES, or for
336 ;; all files at or below the default-directory if FILES is nil. The
337 ;; default implementation runs rcs2log, which handles RCS- and
338 ;; CVS-style logs.
339 ;;
340 ;; * diff (file &optional rev1 rev2 buffer)
341 ;;
342 ;; Insert the diff for FILE into BUFFER, or the *vc-diff* buffer if
343 ;; BUFFER is nil. If REV1 and REV2 are non-nil, report differences
344 ;; from REV1 to REV2. If REV1 is nil, use the current workfile
345 ;; version (as found in the repository) as the older version; if
346 ;; REV2 is nil, use the current workfile contents as the newer
347 ;; version. This function should pass the value of (vc-switches
348 ;; BACKEND 'diff) to the backend command. It should return a status
349 ;; of either 0 (no differences found), or 1 (either non-empty diff
350 ;; or the diff is run asynchronously).
351 ;;
352 ;; - revision-completion-table (file)
353 ;;
354 ;; Return a completion table for existing revisions of FILE.
355 ;; The default is to not use any completion table.
356 ;;
357 ;; - diff-tree (dir &optional rev1 rev2)
358 ;;
359 ;; Insert the diff for all files at and below DIR into the *vc-diff*
360 ;; buffer. The meaning of REV1 and REV2 is the same as for
361 ;; vc-BACKEND-diff. The default implementation does an explicit tree
362 ;; walk, calling vc-BACKEND-diff for each individual file.
363 ;;
364 ;; - annotate-command (file buf &optional rev)
365 ;;
366 ;; If this function is provided, it should produce an annotated display
367 ;; of FILE in BUF, relative to version REV. Annotation means each line
368 ;; of FILE displayed is prefixed with version information associated with
369 ;; its addition (deleted lines leave no history) and that the text of the
370 ;; file is fontified according to age.
371 ;;
372 ;; - annotate-time ()
373 ;;
374 ;; Only required if `annotate-command' is defined for the backend.
375 ;; Return the time of the next line of annotation at or after point,
376 ;; as a floating point fractional number of days. The helper
377 ;; function `vc-annotate-convert-time' may be useful for converting
378 ;; multi-part times as returned by `current-time' and `encode-time'
379 ;; to this format. Return nil if no more lines of annotation appear
380 ;; in the buffer. You can safely assume that point is placed at the
381 ;; beginning of each line, starting at `point-min'. The buffer that
382 ;; point is placed in is the Annotate output, as defined by the
383 ;; relevant backend. This function also affects how much of the line
384 ;; is fontified; where it leaves point is where fontification begins.
385 ;;
386 ;; - annotate-current-time ()
387 ;;
388 ;; Only required if `annotate-command' is defined for the backend,
389 ;; AND you'd like the current time considered to be anything besides
390 ;; (vs-annotate-convert-time (current-time)) -- i.e. the current
391 ;; time with hours, minutes, and seconds included. Probably safe to
392 ;; ignore. Return the current-time, in units of fractional days.
393 ;;
394 ;; - annotate-extract-revision-at-line ()
395 ;;
396 ;; Only required if `annotate-command' is defined for the backend.
397 ;; Invoked from a buffer in vc-annotate-mode, return the revision
398 ;; corresponding to the current line, or nil if there is no revision
399 ;; corresponding to the current line.
400 ;;
401 ;; SNAPSHOT SYSTEM
402 ;;
403 ;; - create-snapshot (dir name branchp)
404 ;;
405 ;; Take a snapshot of the current state of files under DIR and name it
406 ;; NAME. This should make sure that files are up-to-date before
407 ;; proceeding with the action. DIR can also be a file and if BRANCHP
408 ;; is specified, NAME should be created as a branch and DIR should be
409 ;; checked out under this new branch. The default implementation does
410 ;; not support branches but does a sanity check, a tree traversal and
411 ;; for each file calls `assign-name'.
412 ;;
413 ;; - assign-name (file name)
414 ;;
415 ;; Give name NAME to the current version of FILE, assuming it is
416 ;; up-to-date. Only used by the default version of `create-snapshot'.
417 ;;
418 ;; - retrieve-snapshot (dir name update)
419 ;;
420 ;; Retrieve a named snapshot of all registered files at or below DIR.
421 ;; If UPDATE is non-nil, then update buffers of any files in the
422 ;; snapshot that are currently visited. The default implementation
423 ;; does a sanity check whether there aren't any uncommitted changes at
424 ;; or below DIR, and then performs a tree walk, using the `checkout'
425 ;; function to retrieve the corresponding versions.
426 ;;
427 ;; MISCELLANEOUS
428 ;;
429 ;; - make-version-backups-p (file)
430 ;;
431 ;; Return non-nil if unmodified repository versions of FILE should be
432 ;; backed up locally. If this is done, VC can perform `diff' and
433 ;; `revert' operations itself, without calling the backend system. The
434 ;; default implementation always returns nil.
435 ;;
436 ;; - repository-hostname (dirname)
437 ;;
438 ;; Return the hostname that the backend will have to contact
439 ;; in order to operate on a file in DIRNAME. If the return value
440 ;; is nil, it means that the repository is local.
441 ;; This function is used in `vc-stay-local-p' which backends can use
442 ;; for their convenience.
443 ;;
444 ;; - previous-version (file rev)
445 ;;
446 ;; Return the version number that precedes REV for FILE, or nil if no such
447 ;; version exists.
448 ;;
449 ;; - next-version (file rev)
450 ;;
451 ;; Return the version number that follows REV for FILE, or nil if no such
452 ;; version exists.
453 ;;
454 ;; - check-headers ()
455 ;;
456 ;; Return non-nil if the current buffer contains any version headers.
457 ;;
458 ;; - clear-headers ()
459 ;;
460 ;; In the current buffer, reset all version headers to their unexpanded
461 ;; form. This function should be provided if the state-querying code
462 ;; for this backend uses the version headers to determine the state of
463 ;; a file. This function will then be called whenever VC changes the
464 ;; version control state in such a way that the headers would give
465 ;; wrong information.
466 ;;
467 ;; - delete-file (file)
468 ;;
469 ;; Delete FILE and mark it as deleted in the repository. If this
470 ;; function is not provided, the command `vc-delete-file' will
471 ;; signal an error.
472 ;;
473 ;; - rename-file (old new)
474 ;;
475 ;; Rename file OLD to NEW, both in the working area and in the
476 ;; repository. If this function is not provided, the renaming
477 ;; will be done by (vc-delete-file old) and (vc-register new).
478 ;;
479 ;; - find-file-hook ()
480 ;;
481 ;; Operation called in current buffer when opening a file. This can
482 ;; be used by the backend to setup some local variables it might need.
483 ;
484 ;; - find-file-not-found-hook ()
485 ;;
486 ;; Operation called in current buffer when opening a non-existing file.
487 ;; By default, this asks the user if she wants to check out the file.
488
489 ;;; Code:
490
491 (require 'vc-hooks)
492 (require 'ring)
493 (eval-when-compile
494 (require 'cl)
495 (require 'compile)
496 (require 'dired) ; for dired-map-over-marks macro
497 (require 'dired-aux)) ; for dired-kill-{line,tree}
498
499 (if (not (assoc 'vc-parent-buffer minor-mode-alist))
500 (setq minor-mode-alist
501 (cons '(vc-parent-buffer vc-parent-buffer-name)
502 minor-mode-alist)))
503
504 ;; General customization
505
506 (defgroup vc nil
507 "Version-control system in Emacs."
508 :group 'tools)
509
510 (defcustom vc-suppress-confirm nil
511 "If non-nil, treat user as expert; suppress yes-no prompts on some things."
512 :type 'boolean
513 :group 'vc)
514
515 (defcustom vc-delete-logbuf-window t
516 "If non-nil, delete the *VC-log* buffer and window after each logical action.
517 If nil, bury that buffer instead.
518 This is most useful if you have multiple windows on a frame and would like to
519 preserve the setting."
520 :type 'boolean
521 :group 'vc)
522
523 (defcustom vc-initial-comment nil
524 "If non-nil, prompt for initial comment when a file is registered."
525 :type 'boolean
526 :group 'vc)
527
528 (defcustom vc-default-init-version "1.1"
529 "A string used as the default version number when a new file is registered.
530 This can be overridden by giving a prefix argument to \\[vc-register]. This
531 can also be overridden by a particular VC backend."
532 :type 'string
533 :group 'vc
534 :version "20.3")
535
536 (defcustom vc-command-messages nil
537 "If non-nil, display run messages from back-end commands."
538 :type 'boolean
539 :group 'vc)
540
541 (defcustom vc-checkin-switches nil
542 "A string or list of strings specifying extra switches for checkin.
543 These are passed to the checkin program by \\[vc-checkin]."
544 :type '(choice (const :tag "None" nil)
545 (string :tag "Argument String")
546 (repeat :tag "Argument List"
547 :value ("")
548 string))
549 :group 'vc)
550
551 (defcustom vc-checkout-switches nil
552 "A string or list of strings specifying extra switches for checkout.
553 These are passed to the checkout program by \\[vc-checkout]."
554 :type '(choice (const :tag "None" nil)
555 (string :tag "Argument String")
556 (repeat :tag "Argument List"
557 :value ("")
558 string))
559 :group 'vc)
560
561 (defcustom vc-register-switches nil
562 "A string or list of strings; extra switches for registering a file.
563 These are passed to the checkin program by \\[vc-register]."
564 :type '(choice (const :tag "None" nil)
565 (string :tag "Argument String")
566 (repeat :tag "Argument List"
567 :value ("")
568 string))
569 :group 'vc)
570
571 (defcustom vc-dired-listing-switches "-al"
572 "Switches passed to `ls' for vc-dired. MUST contain the `l' option."
573 :type 'string
574 :group 'vc
575 :version "21.1")
576
577 (defcustom vc-dired-recurse t
578 "If non-nil, show directory trees recursively in VC Dired."
579 :type 'boolean
580 :group 'vc
581 :version "20.3")
582
583 (defcustom vc-dired-terse-display t
584 "If non-nil, show only locked files in VC Dired."
585 :type 'boolean
586 :group 'vc
587 :version "20.3")
588
589 (defcustom vc-directory-exclusion-list '("SCCS" "RCS" "CVS" "MCVS" ".svn"
590 ".git" ".hg" ".bzr" "{arch}")
591 "List of directory names to be ignored when walking directory trees."
592 :type '(repeat string)
593 :group 'vc)
594
595 (defcustom vc-diff-switches nil
596 "A string or list of strings specifying switches for diff under VC.
597 When running diff under a given BACKEND, VC concatenates the values of
598 `diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to
599 get the switches for that command. Thus, `vc-diff-switches' should
600 contain switches that are specific to version control, but not
601 specific to any particular backend."
602 :type '(choice (const :tag "None" nil)
603 (string :tag "Argument String")
604 (repeat :tag "Argument List"
605 :value ("")
606 string))
607 :group 'vc
608 :version "21.1")
609
610 (defcustom vc-diff-knows-L nil
611 "*Indicates whether diff understands the -L option.
612 The value is either `yes', `no', or nil. If it is nil, VC tries
613 to use -L and sets this variable to remember whether it worked."
614 :type '(choice (const :tag "Work out" nil) (const yes) (const no))
615 :group 'vc)
616
617 (defcustom vc-allow-async-revert nil
618 "Specifies whether the diff during \\[vc-revert] may be asynchronous.
619 Enabling this option means that you can confirm a revert operation even
620 if the local changes in the file have not been found and displayed yet."
621 :type '(choice (const :tag "No" nil)
622 (const :tag "Yes" t))
623 :group 'vc
624 :version "22.1")
625
626 ;;;###autoload
627 (defcustom vc-checkout-hook nil
628 "Normal hook (list of functions) run after checking out a file.
629 See `run-hooks'."
630 :type 'hook
631 :group 'vc
632 :version "21.1")
633
634 (defcustom vc-annotate-display-mode 'fullscale
635 "Which mode to color the output of \\[vc-annotate] with by default."
636 :type '(choice (const :tag "By Color Map Range" nil)
637 (const :tag "Scale to Oldest" scale)
638 (const :tag "Scale Oldest->Newest" fullscale)
639 (number :tag "Specify Fractional Number of Days"
640 :value "20.5"))
641 :group 'vc)
642
643 ;;;###autoload
644 (defcustom vc-checkin-hook nil
645 "Normal hook (list of functions) run after a checkin is done.
646 See also `log-edit-done-hook'."
647 :type 'hook
648 :options '(log-edit-comment-to-change-log)
649 :group 'vc)
650
651 ;;;###autoload
652 (defcustom vc-before-checkin-hook nil
653 "Normal hook (list of functions) run before a file is checked in.
654 See `run-hooks'."
655 :type 'hook
656 :group 'vc)
657
658 (defcustom vc-logentry-check-hook nil
659 "Normal hook run by `vc-backend-logentry-check'.
660 Use this to impose your own rules on the entry in addition to any the
661 version control backend imposes itself."
662 :type 'hook
663 :group 'vc)
664
665 ;; Annotate customization
666 (defcustom vc-annotate-color-map
667 (if (and (tty-display-color-p) (<= (display-color-cells) 8))
668 ;; A custom sorted TTY colormap
669 (let* ((colors
670 (sort
671 (delq nil
672 (mapcar (lambda (x)
673 (if (not (or
674 (string-equal (car x) "white")
675 (string-equal (car x) "black") ))
676 (car x)))
677 (tty-color-alist)))
678 (lambda (a b)
679 (cond
680 ((or (string-equal a "red") (string-equal b "blue")) t)
681 ((or (string-equal b "red") (string-equal a "blue")) nil)
682 ((string-equal a "yellow") t)
683 ((string-equal b "yellow") nil)
684 ((string-equal a "cyan") t)
685 ((string-equal b "cyan") nil)
686 ((string-equal a "green") t)
687 ((string-equal b "green") nil)
688 ((string-equal a "magenta") t)
689 ((string-equal b "magenta") nil)
690 (t (string< a b))))))
691 (date 20.)
692 (delta (/ (- 360. date) (1- (length colors)))))
693 (mapcar (lambda (x)
694 (prog1
695 (cons date x)
696 (setq date (+ date delta)))) colors))
697 ;; Normal colormap: hue stepped from 0-240deg, value=1., saturation=0.75
698 '(( 20. . "#FF3F3F")
699 ( 40. . "#FF6C3F")
700 ( 60. . "#FF993F")
701 ( 80. . "#FFC63F")
702 (100. . "#FFF33F")
703 (120. . "#DDFF3F")
704 (140. . "#B0FF3F")
705 (160. . "#83FF3F")
706 (180. . "#56FF3F")
707 (200. . "#3FFF56")
708 (220. . "#3FFF83")
709 (240. . "#3FFFB0")
710 (260. . "#3FFFDD")
711 (280. . "#3FF3FF")
712 (300. . "#3FC6FF")
713 (320. . "#3F99FF")
714 (340. . "#3F6CFF")
715 (360. . "#3F3FFF")))
716 "Association list of age versus color, for \\[vc-annotate].
717 Ages are given in units of fractional days. Default is eighteen
718 steps using a twenty day increment, from red to blue. For TTY
719 displays with 8 or fewer colors, the default is red to blue with
720 all other colors between (excluding black and white)."
721 :type 'alist
722 :group 'vc)
723
724 (defcustom vc-annotate-very-old-color "#3F3FFF"
725 "Color for lines older than the current color range in \\[vc-annotate]]."
726 :type 'string
727 :group 'vc)
728
729 (defcustom vc-annotate-background "black"
730 "Background color for \\[vc-annotate].
731 Default color is used if nil."
732 :type 'string
733 :group 'vc)
734
735 (defcustom vc-annotate-menu-elements '(2 0.5 0.1 0.01)
736 "Menu elements for the mode-specific menu of VC-Annotate mode.
737 List of factors, used to expand/compress the time scale. See `vc-annotate'."
738 :type '(repeat number)
739 :group 'vc)
740
741 (defvar vc-annotate-mode-map
742 (let ((m (make-sparse-keymap)))
743 (define-key m "A" 'vc-annotate-revision-previous-to-line)
744 (define-key m "D" 'vc-annotate-show-diff-revision-at-line)
745 (define-key m "J" 'vc-annotate-revision-at-line)
746 (define-key m "L" 'vc-annotate-show-log-revision-at-line)
747 (define-key m "N" 'vc-annotate-next-version)
748 (define-key m "P" 'vc-annotate-prev-version)
749 (define-key m "W" 'vc-annotate-workfile-version)
750 m)
751 "Local keymap used for VC-Annotate mode.")
752
753 ;; Header-insertion hair
754
755 (defcustom vc-static-header-alist
756 '(("\\.c\\'" .
757 "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
758 "*Associate static header string templates with file types.
759 A \%s in the template is replaced with the first string associated with
760 the file's version control type in `vc-header-alist'."
761 :type '(repeat (cons :format "%v"
762 (regexp :tag "File Type")
763 (string :tag "Header String")))
764 :group 'vc)
765
766 (defcustom vc-comment-alist
767 '((nroff-mode ".\\\"" ""))
768 "*Special comment delimiters for generating VC headers.
769 Add an entry in this list if you need to override the normal `comment-start'
770 and `comment-end' variables. This will only be necessary if the mode language
771 is sensitive to blank lines."
772 :type '(repeat (list :format "%v"
773 (symbol :tag "Mode")
774 (string :tag "Comment Start")
775 (string :tag "Comment End")))
776 :group 'vc)
777
778 (defcustom vc-checkout-carefully (= (user-uid) 0)
779 "*Non-nil means be extra-careful in checkout.
780 Verify that the file really is not locked
781 and that its contents match what the master file says."
782 :type 'boolean
783 :group 'vc)
784 (make-obsolete-variable 'vc-checkout-carefully
785 "the corresponding checks are always done now."
786 "21.1")
787
788 \f
789 ;; Variables the user doesn't need to know about.
790 (defvar vc-log-operation nil)
791 (defvar vc-log-after-operation-hook nil)
792
793 ;; In a log entry buffer, this is a local variable
794 ;; that points to the buffer for which it was made
795 ;; (either a file, or a VC dired buffer).
796 (defvar vc-parent-buffer nil)
797 (put 'vc-parent-buffer 'permanent-local t)
798 (defvar vc-parent-buffer-name nil)
799 (put 'vc-parent-buffer-name 'permanent-local t)
800
801 (defvar vc-disable-async-diff nil
802 "VC sets this to t locally to disable some async diff operations.
803 Backends that offer asynchronous diffs should respect this variable
804 in their implementation of vc-BACKEND-diff.")
805
806 (defvar vc-log-file)
807 (defvar vc-log-version)
808
809 (defvar vc-dired-mode nil)
810 (make-variable-buffer-local 'vc-dired-mode)
811
812 ;; functions that operate on RCS revision numbers. This code should
813 ;; also be moved into the backends. It stays for now, however, since
814 ;; it is used in code below.
815 ;;;###autoload
816 (defun vc-trunk-p (rev)
817 "Return t if REV is a revision on the trunk."
818 (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev))))
819
820 (defun vc-branch-p (rev)
821 "Return t if REV is a branch revision."
822 (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev))))
823
824 ;;;###autoload
825 (defun vc-branch-part (rev)
826 "Return the branch part of a revision number REV."
827 (let ((index (string-match "\\.[0-9]+\\'" rev)))
828 (if index
829 (substring rev 0 index))))
830
831 (defun vc-minor-part (rev)
832 "Return the minor version number of a revision number REV."
833 (string-match "[0-9]+\\'" rev)
834 (substring rev (match-beginning 0) (match-end 0)))
835
836 (defun vc-default-previous-version (backend file rev)
837 "Return the version number immediately preceding REV for FILE,
838 or nil if there is no previous version. This default
839 implementation works for MAJOR.MINOR-style version numbers as
840 used by RCS and CVS."
841 (let ((branch (vc-branch-part rev))
842 (minor-num (string-to-number (vc-minor-part rev))))
843 (when branch
844 (if (> minor-num 1)
845 ;; version does probably not start a branch or release
846 (concat branch "." (number-to-string (1- minor-num)))
847 (if (vc-trunk-p rev)
848 ;; we are at the beginning of the trunk --
849 ;; don't know anything to return here
850 nil
851 ;; we are at the beginning of a branch --
852 ;; return version of starting point
853 (vc-branch-part branch))))))
854
855 (defun vc-default-next-version (backend file rev)
856 "Return the version number immediately following REV for FILE,
857 or nil if there is no next version. This default implementation
858 works for MAJOR.MINOR-style version numbers as used by RCS
859 and CVS."
860 (when (not (string= rev (vc-workfile-version file)))
861 (let ((branch (vc-branch-part rev))
862 (minor-num (string-to-number (vc-minor-part rev))))
863 (concat branch "." (number-to-string (1+ minor-num))))))
864
865 ;; File property caching
866
867 (defun vc-clear-context ()
868 "Clear all cached file properties."
869 (interactive)
870 (fillarray vc-file-prop-obarray 0))
871
872 (defmacro with-vc-properties (file form settings)
873 "Execute FORM, then maybe set per-file properties for FILE.
874 SETTINGS is an association list of property/value pairs. After
875 executing FORM, set those properties from SETTINGS that have not yet
876 been updated to their corresponding values."
877 (declare (debug t))
878 `(let ((vc-touched-properties (list t)))
879 ,form
880 (mapcar (lambda (setting)
881 (let ((property (car setting)))
882 (unless (memq property vc-touched-properties)
883 (put (intern ,file vc-file-prop-obarray)
884 property (cdr setting)))))
885 ,settings)))
886
887 ;; Random helper functions
888
889 (defsubst vc-editable-p (file)
890 "Return non-nil if FILE can be edited."
891 (or (eq (vc-checkout-model file) 'implicit)
892 (memq (vc-state file) '(edited needs-merge))))
893
894 ;; Two macros for elisp programming
895 ;;;###autoload
896 (defmacro with-vc-file (file comment &rest body)
897 "Check out a writable copy of FILE if necessary, then execute BODY.
898 Check in FILE with COMMENT (a string) after BODY has been executed.
899 FILE is passed through `expand-file-name'; BODY executed within
900 `save-excursion'. If FILE is not under version control, or locked by
901 somebody else, signal error."
902 (declare (debug t) (indent 2))
903 (let ((filevar (make-symbol "file")))
904 `(let ((,filevar (expand-file-name ,file)))
905 (or (vc-backend ,filevar)
906 (error "File not under version control: `%s'" file))
907 (unless (vc-editable-p ,filevar)
908 (let ((state (vc-state ,filevar)))
909 (if (stringp state)
910 (error "`%s' is locking `%s'" state ,filevar)
911 (vc-checkout ,filevar t))))
912 (save-excursion
913 ,@body)
914 (vc-checkin ,filevar nil ,comment))))
915
916 ;;;###autoload
917 (defmacro edit-vc-file (file comment &rest body)
918 "Edit FILE under version control, executing body.
919 Checkin with COMMENT after executing BODY.
920 This macro uses `with-vc-file', passing args to it.
921 However, before executing BODY, find FILE, and after BODY, save buffer."
922 (declare (debug t) (indent 2))
923 (let ((filevar (make-symbol "file")))
924 `(let ((,filevar (expand-file-name ,file)))
925 (with-vc-file
926 ,filevar ,comment
927 (set-buffer (find-file-noselect ,filevar))
928 ,@body
929 (save-buffer)))))
930
931 (defun vc-ensure-vc-buffer ()
932 "Make sure that the current buffer visits a version-controlled file."
933 (if vc-dired-mode
934 (set-buffer (find-file-noselect (dired-get-filename)))
935 (while vc-parent-buffer
936 (set-buffer vc-parent-buffer))
937 (if (not buffer-file-name)
938 (error "Buffer %s is not associated with a file" (buffer-name))
939 (if (not (vc-backend buffer-file-name))
940 (error "File %s is not under version control" buffer-file-name)))))
941
942 (defun vc-process-filter (p s)
943 "An alternative output filter for async process P.
944 One difference with the default filter is that this inserts S after markers.
945 Another is that undo information is not kept."
946 (with-current-buffer (process-buffer p)
947 (save-excursion
948 (let ((buffer-undo-list t)
949 (inhibit-read-only t))
950 (goto-char (process-mark p))
951 (insert s)
952 (set-marker (process-mark p) (point))))))
953
954 (defun vc-setup-buffer (&optional buf)
955 "Prepare BUF for executing a VC command and make it current.
956 BUF defaults to \"*vc*\", can be a string and will be created if necessary."
957 (unless buf (setq buf "*vc*"))
958 (let ((camefrom (current-buffer))
959 (olddir default-directory))
960 (set-buffer (get-buffer-create buf))
961 (kill-all-local-variables)
962 (set (make-local-variable 'vc-parent-buffer) camefrom)
963 (set (make-local-variable 'vc-parent-buffer-name)
964 (concat " from " (buffer-name camefrom)))
965 (setq default-directory olddir)
966 (let ((buffer-undo-list t)
967 (inhibit-read-only t))
968 (erase-buffer))))
969
970 (defun vc-exec-after (code)
971 "Eval CODE when the current buffer's process is done.
972 If the current buffer has no process, just evaluate CODE.
973 Else, add CODE to the process' sentinel."
974 (let ((proc (get-buffer-process (current-buffer))))
975 (cond
976 ;; If there's no background process, just execute the code.
977 ;; We used to explicitly call delete-process on exited processes,
978 ;; but this led to timing problems causing process output to be
979 ;; lost. Terminated processes get deleted automatically
980 ;; anyway. -- cyd
981 ((or (null proc) (eq (process-status proc) 'exit))
982 ;; Make sure we've read the process's output before going further.
983 (if proc (accept-process-output proc))
984 (eval code))
985 ;; If a process is running, add CODE to the sentinel
986 ((eq (process-status proc) 'run)
987 (let ((sentinel (process-sentinel proc)))
988 (set-process-sentinel proc
989 `(lambda (p s)
990 (with-current-buffer ',(current-buffer)
991 (save-excursion
992 (goto-char (process-mark p))
993 ,@(append (cdr (cdr (car ;Strip off (save-exc (goto-char...)
994 (cdr (cdr ;Strip off (with-current-buffer buf
995 (car (cdr (cdr ;Strip off (lambda (p s)
996 sentinel))))))))
997 (list `(vc-exec-after ',code)))))))))
998 (t (error "Unexpected process state"))))
999 nil)
1000
1001 (defvar vc-post-command-functions nil
1002 "Hook run at the end of `vc-do-command'.
1003 Each function is called inside the buffer in which the command was run
1004 and is passed 3 arguments: the COMMAND, the FILE and the FLAGS.")
1005
1006 (defun vc-delistify (filelist)
1007 "Smash a FILELIST into a file list string suitable for info messages."
1008 (if (not filelist) "." (mapconcat 'identity filelist " ")))
1009
1010 (defvar w32-quote-process-args)
1011 ;;;###autoload
1012 (defun vc-do-command (buffer okstatus command file-or-list &rest flags)
1013 "Execute a VC command, notifying user and checking for errors.
1014 Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil or the
1015 current buffer if BUFFER is t. If the destination buffer is not
1016 already current, set it up properly and erase it. The command is
1017 considered successful if its exit status does not exceed OKSTATUS (if
1018 OKSTATUS is nil, that means to ignore error status, if it is `async', that
1019 means not to wait for termination of the subprocess; if it is t it means to
1020 ignore all execution errors). FILE-OR-LIST is the name of a working file;
1021 it may be a list of files or be nil (to execute commands that don't expect
1022 a file name or set of files). If an optional list of FLAGS is present,
1023 that is inserted into the command line before the filename."
1024 ;; FIXME: file-relative-name can return a bogus result because
1025 ;; it doesn't look at the actual file-system to see if symlinks
1026 ;; come into play.
1027 (let* ((files
1028 (mapcar (lambda (f) (file-relative-name (expand-file-name f)))
1029 (if (listp file-or-list) file-or-list (list file-or-list))))
1030 (full-command
1031 (concat command " " (vc-delistify flags) " " (vc-delistify files))))
1032 (if vc-command-messages
1033 (message "Running %s..." full-command))
1034 (save-current-buffer
1035 (unless (or (eq buffer t)
1036 (and (stringp buffer)
1037 (string= (buffer-name) buffer))
1038 (eq buffer (current-buffer)))
1039 (vc-setup-buffer buffer))
1040 (let ((squeezed (remq nil flags))
1041 (inhibit-read-only t)
1042 (status 0))
1043 (when files
1044 (setq squeezed (nconc squeezed files)))
1045 (let ((exec-path (append vc-path exec-path))
1046 ;; Add vc-path to PATH for the execution of this command.
1047 (process-environment
1048 (cons (concat "PATH=" (getenv "PATH")
1049 path-separator
1050 (mapconcat 'identity vc-path path-separator))
1051 process-environment))
1052 (w32-quote-process-args t))
1053 (if (and (eq okstatus 'async) (file-remote-p default-directory))
1054 ;; start-process does not support remote execution
1055 (setq okstatus nil))
1056 (if (eq okstatus 'async)
1057 (let ((proc
1058 (let ((process-connection-type nil))
1059 (apply 'start-process command (current-buffer) command
1060 squeezed))))
1061 (unless (active-minibuffer-window)
1062 (message "Running %s in the background..." full-command))
1063 ;;(set-process-sentinel proc (lambda (p msg) (delete-process p)))
1064 (set-process-filter proc 'vc-process-filter)
1065 (vc-exec-after
1066 `(unless (active-minibuffer-window)
1067 (message "Running %s in the background... done" ',full-command))))
1068 (let ((buffer-undo-list t))
1069 (setq status (apply 'process-file command nil t nil squeezed)))
1070 (when (and (not (eq t okstatus))
1071 (or (not (integerp status))
1072 (and okstatus (< okstatus status))))
1073 (pop-to-buffer (current-buffer))
1074 (goto-char (point-min))
1075 (shrink-window-if-larger-than-buffer)
1076 (error "Running %s...FAILED (%s)" full-command
1077 (if (integerp status) (format "status %d" status) status))))
1078 (if vc-command-messages
1079 (message "Running %s...OK" full-command)))
1080 (vc-exec-after
1081 `(run-hook-with-args 'vc-post-command-functions ',command ',file-or-list ',flags))
1082 status))))
1083
1084 (defun vc-position-context (posn)
1085 "Save a bit of the text around POSN in the current buffer.
1086 Used to help us find the corresponding position again later
1087 if markers are destroyed or corrupted."
1088 ;; A lot of this was shamelessly lifted from Sebastian Kremer's
1089 ;; rcs.el mode.
1090 (list posn
1091 (buffer-size)
1092 (buffer-substring posn
1093 (min (point-max) (+ posn 100)))))
1094
1095 (defun vc-find-position-by-context (context)
1096 "Return the position of CONTEXT in the current buffer.
1097 If CONTEXT cannot be found, return nil."
1098 (let ((context-string (nth 2 context)))
1099 (if (equal "" context-string)
1100 (point-max)
1101 (save-excursion
1102 (let ((diff (- (nth 1 context) (buffer-size))))
1103 (if (< diff 0) (setq diff (- diff)))
1104 (goto-char (nth 0 context))
1105 (if (or (search-forward context-string nil t)
1106 ;; Can't use search-backward since the match may continue
1107 ;; after point.
1108 (progn (goto-char (- (point) diff (length context-string)))
1109 ;; goto-char doesn't signal an error at
1110 ;; beginning of buffer like backward-char would
1111 (search-forward context-string nil t)))
1112 ;; to beginning of OSTRING
1113 (- (point) (length context-string))))))))
1114
1115 (defun vc-context-matches-p (posn context)
1116 "Return t if POSN matches CONTEXT, nil otherwise."
1117 (let* ((context-string (nth 2 context))
1118 (len (length context-string))
1119 (end (+ posn len)))
1120 (if (> end (1+ (buffer-size)))
1121 nil
1122 (string= context-string (buffer-substring posn end)))))
1123
1124 (defun vc-buffer-context ()
1125 "Return a list (POINT-CONTEXT MARK-CONTEXT REPARSE).
1126 Used by `vc-restore-buffer-context' to later restore the context."
1127 (let ((point-context (vc-position-context (point)))
1128 ;; Use mark-marker to avoid confusion in transient-mark-mode.
1129 (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer))
1130 (vc-position-context (mark-marker))))
1131 ;; Make the right thing happen in transient-mark-mode.
1132 (mark-active nil)
1133 ;; The new compilation code does not use compilation-error-list any
1134 ;; more, so the code below is now ineffective and might as well
1135 ;; be disabled. -- Stef
1136 ;; ;; We may want to reparse the compilation buffer after revert
1137 ;; (reparse (and (boundp 'compilation-error-list) ;compile loaded
1138 ;; ;; Construct a list; each elt is nil or a buffer
1139 ;; ;; iff that buffer is a compilation output buffer
1140 ;; ;; that contains markers into the current buffer.
1141 ;; (save-current-buffer
1142 ;; (mapcar (lambda (buffer)
1143 ;; (set-buffer buffer)
1144 ;; (let ((errors (or
1145 ;; compilation-old-error-list
1146 ;; compilation-error-list))
1147 ;; (buffer-error-marked-p nil))
1148 ;; (while (and (consp errors)
1149 ;; (not buffer-error-marked-p))
1150 ;; (and (markerp (cdr (car errors)))
1151 ;; (eq buffer
1152 ;; (marker-buffer
1153 ;; (cdr (car errors))))
1154 ;; (setq buffer-error-marked-p t))
1155 ;; (setq errors (cdr errors)))
1156 ;; (if buffer-error-marked-p buffer)))
1157 ;; (buffer-list)))))
1158 (reparse nil))
1159 (list point-context mark-context reparse)))
1160
1161 (defun vc-restore-buffer-context (context)
1162 "Restore point/mark, and reparse any affected compilation buffers.
1163 CONTEXT is that which `vc-buffer-context' returns."
1164 (let ((point-context (nth 0 context))
1165 (mark-context (nth 1 context))
1166 (reparse (nth 2 context)))
1167 ;; The new compilation code does not use compilation-error-list any
1168 ;; more, so the code below is now ineffective and might as well
1169 ;; be disabled. -- Stef
1170 ;; ;; Reparse affected compilation buffers.
1171 ;; (while reparse
1172 ;; (if (car reparse)
1173 ;; (with-current-buffer (car reparse)
1174 ;; (let ((compilation-last-buffer (current-buffer)) ;select buffer
1175 ;; ;; Record the position in the compilation buffer of
1176 ;; ;; the last error next-error went to.
1177 ;; (error-pos (marker-position
1178 ;; (car (car-safe compilation-error-list)))))
1179 ;; ;; Reparse the error messages as far as they were parsed before.
1180 ;; (compile-reinitialize-errors '(4) compilation-parsing-end)
1181 ;; ;; Move the pointer up to find the error we were at before
1182 ;; ;; reparsing. Now next-error should properly go to the next one.
1183 ;; (while (and compilation-error-list
1184 ;; (/= error-pos (car (car compilation-error-list))))
1185 ;; (setq compilation-error-list (cdr compilation-error-list))))))
1186 ;; (setq reparse (cdr reparse)))
1187
1188 ;; if necessary, restore point and mark
1189 (if (not (vc-context-matches-p (point) point-context))
1190 (let ((new-point (vc-find-position-by-context point-context)))
1191 (if new-point (goto-char new-point))))
1192 (and mark-active
1193 mark-context
1194 (not (vc-context-matches-p (mark) mark-context))
1195 (let ((new-mark (vc-find-position-by-context mark-context)))
1196 (if new-mark (set-mark new-mark))))))
1197
1198 (defun vc-revert-buffer1 (&optional arg no-confirm)
1199 "Revert buffer, keeping point and mark where user expects them.
1200 Try to be clever in the face of changes due to expanded version control
1201 key words. This is important for typeahead to work as expected.
1202 ARG and NO-CONFIRM are passed on to `revert-buffer'."
1203 (interactive "P")
1204 (widen)
1205 (let ((context (vc-buffer-context)))
1206 ;; Use save-excursion here, because it may be able to restore point
1207 ;; and mark properly even in cases where vc-restore-buffer-context
1208 ;; would fail. However, save-excursion might also get it wrong --
1209 ;; in this case, vc-restore-buffer-context gives it a second try.
1210 (save-excursion
1211 ;; t means don't call normal-mode;
1212 ;; that's to preserve various minor modes.
1213 (revert-buffer arg no-confirm t))
1214 (vc-restore-buffer-context context)))
1215
1216
1217 (defun vc-buffer-sync (&optional not-urgent)
1218 "Make sure the current buffer and its working file are in sync.
1219 NOT-URGENT means it is ok to continue if the user says not to save."
1220 (if (buffer-modified-p)
1221 (if (or vc-suppress-confirm
1222 (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
1223 (save-buffer)
1224 (unless not-urgent
1225 (error "Aborted")))))
1226
1227 (defun vc-default-latest-on-branch-p (backend file)
1228 "Return non-nil if FILE is the latest on its branch.
1229 This default implementation always returns non-nil, which means that
1230 editing non-current versions is not supported by default."
1231 t)
1232
1233 (defun vc-next-action-on-file (file verbose &optional comment)
1234 "Do The Right Thing for a given FILE under version control.
1235 If COMMENT is specified, it will be used as an admin or checkin comment.
1236 If VERBOSE is non-nil, query the user rather than using default parameters."
1237 (let ((visited (get-file-buffer file))
1238 state version)
1239 (when visited
1240 (if vc-dired-mode
1241 (switch-to-buffer-other-window visited)
1242 (set-buffer visited))
1243 ;; Check relation of buffer and file, and make sure
1244 ;; user knows what he's doing. First, finding the file
1245 ;; will check whether the file on disk is newer.
1246 ;; Ignore buffer-read-only during this test, and
1247 ;; preserve find-file-literally.
1248 (let ((buffer-read-only (not (file-writable-p file))))
1249 (find-file-noselect file nil find-file-literally))
1250 (if (not (verify-visited-file-modtime (current-buffer)))
1251 (if (yes-or-no-p "Replace file on disk with buffer contents? ")
1252 (write-file buffer-file-name)
1253 (error "Aborted"))
1254 ;; Now, check if we have unsaved changes.
1255 (vc-buffer-sync t)
1256 (if (buffer-modified-p)
1257 (or (y-or-n-p "Operate on disk file, keeping modified buffer? ")
1258 (error "Aborted")))))
1259
1260 ;; Do the right thing
1261 (if (not (vc-registered file))
1262 (vc-register verbose comment)
1263 (vc-recompute-state file)
1264 (if visited (vc-mode-line file))
1265 (setq state (vc-state file))
1266 (cond
1267 ;; up-to-date
1268 ((or (eq state 'up-to-date)
1269 (and verbose (eq state 'needs-patch)))
1270 (cond
1271 (verbose
1272 ;; go to a different version
1273 (setq version
1274 (read-string "Branch, version, or backend to move to: "))
1275 (let ((vsym (intern-soft (upcase version))))
1276 (if (member vsym vc-handled-backends)
1277 (vc-transfer-file file vsym)
1278 (vc-checkout file (eq (vc-checkout-model file) 'implicit)
1279 version))))
1280 ((not (eq (vc-checkout-model file) 'implicit))
1281 ;; check the file out
1282 (vc-checkout file t))
1283 (t
1284 ;; do nothing
1285 (message "%s is up-to-date" file))))
1286
1287 ;; Abnormal: edited but read-only
1288 ((and visited (eq state 'edited)
1289 buffer-read-only (not (file-writable-p file)))
1290 ;; Make the file+buffer read-write. If the user really wanted to
1291 ;; commit, he'll get a chance to do that next time around, anyway.
1292 (message "File is edited but read-only; making it writable")
1293 (set-file-modes buffer-file-name
1294 (logior (file-modes buffer-file-name) 128))
1295 (toggle-read-only -1))
1296
1297 ;; edited
1298 ((eq state 'edited)
1299 (cond
1300 ;; For files with locking, if the file does not contain
1301 ;; any changes, just let go of the lock, i.e. revert.
1302 ((and (not (eq (vc-checkout-model file) 'implicit))
1303 (vc-workfile-unchanged-p file)
1304 ;; If buffer is modified, that means the user just
1305 ;; said no to saving it; in that case, don't revert,
1306 ;; because the user might intend to save after
1307 ;; finishing the log entry.
1308 (not (and visited (buffer-modified-p))))
1309 ;; DO NOT revert the file without asking the user!
1310 (if (not visited) (find-file-other-window file))
1311 (if (yes-or-no-p "Revert to master version? ")
1312 (vc-revert)))
1313 (t ;; normal action
1314 (if (not verbose)
1315 (vc-checkin file nil comment)
1316 (setq version (read-string "New version or backend: "))
1317 (let ((vsym (intern (upcase version))))
1318 (if (member vsym vc-handled-backends)
1319 (vc-transfer-file file vsym)
1320 (vc-checkin file version comment)))))))
1321
1322 ;; locked by somebody else
1323 ((stringp state)
1324 (if comment
1325 (error "Sorry, you can't steal the lock on %s this way"
1326 (file-name-nondirectory file)))
1327 (vc-steal-lock file
1328 (if verbose (read-string "Version to steal: ")
1329 (vc-workfile-version file))
1330 state))
1331
1332 ;; needs-patch
1333 ((eq state 'needs-patch)
1334 (if (yes-or-no-p (format
1335 "%s is not up-to-date. Get latest version? "
1336 (file-name-nondirectory file)))
1337 (vc-checkout file (eq (vc-checkout-model file) 'implicit) t)
1338 (if (and (not (eq (vc-checkout-model file) 'implicit))
1339 (yes-or-no-p "Lock this version? "))
1340 (vc-checkout file t)
1341 (error "Aborted"))))
1342
1343 ;; needs-merge
1344 ((eq state 'needs-merge)
1345 (if (yes-or-no-p (format
1346 "%s is not up-to-date. Merge in changes now? "
1347 (file-name-nondirectory file)))
1348 (vc-maybe-resolve-conflicts file (vc-call merge-news file))
1349 (error "Aborted")))
1350
1351 ;; unlocked-changes
1352 ((eq state 'unlocked-changes)
1353 (if (not visited) (find-file-other-window file))
1354 (if (save-window-excursion
1355 (vc-version-diff file (vc-workfile-version file) nil)
1356 (goto-char (point-min))
1357 (let ((inhibit-read-only t))
1358 (insert
1359 (format "Changes to %s since last lock:\n\n" file)))
1360 (not (beep))
1361 (yes-or-no-p (concat "File has unlocked changes. "
1362 "Claim lock retaining changes? ")))
1363 (progn (vc-call steal-lock file)
1364 (clear-visited-file-modtime)
1365 ;; Must clear any headers here because they wouldn't
1366 ;; show that the file is locked now.
1367 (vc-clear-headers file)
1368 (write-file buffer-file-name)
1369 (vc-mode-line file))
1370 (if (not (yes-or-no-p
1371 "Revert to checked-in version, instead? "))
1372 (error "Checkout aborted")
1373 (vc-revert-buffer1 t t)
1374 (vc-checkout file t))))))))
1375
1376 (defvar vc-dired-window-configuration)
1377
1378 (defun vc-next-action-dired (file rev comment)
1379 "Call `vc-next-action-on-file' on all the marked files.
1380 Ignores FILE and REV, but passes on COMMENT."
1381 (let ((dired-buffer (current-buffer)))
1382 (dired-map-over-marks
1383 (let ((file (dired-get-filename)))
1384 (message "Processing %s..." file)
1385 (vc-next-action-on-file file nil comment)
1386 (set-buffer dired-buffer)
1387 (set-window-configuration vc-dired-window-configuration)
1388 (message "Processing %s...done" file))
1389 nil t))
1390 (dired-move-to-filename))
1391
1392 ;; Here's the major entry point.
1393
1394 ;;;###autoload
1395 (defun vc-next-action (verbose)
1396 "Do the next logical version control operation on the current file.
1397
1398 If you call this from within a VC dired buffer with no files marked,
1399 it will operate on the file in the current line.
1400
1401 If you call this from within a VC dired buffer, and one or more
1402 files are marked, it will accept a log message and then operate on
1403 each one. The log message will be used as a comment for any register
1404 or checkin operations, but ignored when doing checkouts. Attempted
1405 lock steals will raise an error.
1406
1407 A prefix argument lets you specify the version number to use.
1408
1409 For RCS and SCCS files:
1410 If the file is not already registered, this registers it for version
1411 control.
1412 If the file is registered and not locked by anyone, this checks out
1413 a writable and locked file ready for editing.
1414 If the file is checked out and locked by the calling user, this
1415 first checks to see if the file has changed since checkout. If not,
1416 it performs a revert.
1417 If the file has been changed, this pops up a buffer for entry
1418 of a log message; when the message has been entered, it checks in the
1419 resulting changes along with the log message as change commentary. If
1420 the variable `vc-keep-workfiles' is non-nil (which is its default), a
1421 read-only copy of the changed file is left in place afterwards.
1422 If the file is registered and locked by someone else, you are given
1423 the option to steal the lock.
1424
1425 For CVS files:
1426 If the file is not already registered, this registers it for version
1427 control. This does a \"cvs add\", but no \"cvs commit\".
1428 If the file is added but not committed, it is committed.
1429 If your working file is changed, but the repository file is
1430 unchanged, this pops up a buffer for entry of a log message; when the
1431 message has been entered, it checks in the resulting changes along
1432 with the logmessage as change commentary. A writable file is retained.
1433 If the repository file is changed, you are asked if you want to
1434 merge in the changes into your working copy."
1435
1436 (interactive "P")
1437 (catch 'nogo
1438 (if vc-dired-mode
1439 (let ((files (dired-get-marked-files)))
1440 (set (make-local-variable 'vc-dired-window-configuration)
1441 (current-window-configuration))
1442 (if (string= ""
1443 (mapconcat
1444 (lambda (f)
1445 (if (not (vc-up-to-date-p f)) "@" ""))
1446 files ""))
1447 (vc-next-action-dired nil nil "dummy")
1448 (vc-start-entry nil nil nil nil
1449 "Enter a change comment for the marked files."
1450 'vc-next-action-dired))
1451 (throw 'nogo nil)))
1452 (while vc-parent-buffer
1453 (pop-to-buffer vc-parent-buffer))
1454 (if buffer-file-name
1455 (vc-next-action-on-file buffer-file-name verbose)
1456 (error "Buffer %s is not associated with a file" (buffer-name)))))
1457
1458 ;; These functions help the vc-next-action entry point
1459
1460 (defun vc-default-init-version (backend) vc-default-init-version)
1461
1462 ;;;###autoload
1463 (defun vc-register (&optional set-version comment)
1464 "Register the current file into a version control system.
1465 With prefix argument SET-VERSION, allow user to specify initial version
1466 level. If COMMENT is present, use that as an initial comment.
1467
1468 The version control system to use is found by cycling through the list
1469 `vc-handled-backends'. The first backend in that list which declares
1470 itself responsible for the file (usually because other files in that
1471 directory are already registered under that backend) will be used to
1472 register the file. If no backend declares itself responsible, the
1473 first backend that could register the file is used."
1474 (interactive "P")
1475 (unless buffer-file-name (error "No visited file"))
1476 (when (vc-backend buffer-file-name)
1477 (if (vc-registered buffer-file-name)
1478 (error "This file is already registered")
1479 (unless (y-or-n-p "Previous master file has vanished. Make a new one? ")
1480 (error "Aborted"))))
1481 ;; Watch out for new buffers of size 0: the corresponding file
1482 ;; does not exist yet, even though buffer-modified-p is nil.
1483 (if (and (not (buffer-modified-p))
1484 (zerop (buffer-size))
1485 (not (file-exists-p buffer-file-name)))
1486 (set-buffer-modified-p t))
1487 (vc-buffer-sync)
1488
1489 (vc-start-entry buffer-file-name
1490 (if set-version
1491 (read-string (format "Initial version level for %s: "
1492 (buffer-name)))
1493 (vc-call-backend (vc-responsible-backend buffer-file-name)
1494 'init-version))
1495 (or comment (not vc-initial-comment))
1496 nil
1497 "Enter initial comment."
1498 (lambda (file rev comment)
1499 (message "Registering %s... " file)
1500 (let ((backend (vc-responsible-backend file t)))
1501 (vc-file-clearprops file)
1502 (vc-call-backend backend 'register (list file) rev comment)
1503 (vc-file-setprop file 'vc-backend backend)
1504 (unless vc-make-backup-files
1505 (make-local-variable 'backup-inhibited)
1506 (setq backup-inhibited t)))
1507 (message "Registering %s... done" file))))
1508
1509
1510 (defun vc-responsible-backend (file &optional register)
1511 "Return the name of a backend system that is responsible for FILE.
1512 The optional argument REGISTER means that a backend suitable for
1513 registration should be found.
1514
1515 If REGISTER is nil, then if FILE is already registered, return the
1516 backend of FILE. If FILE is not registered, or a directory, then the
1517 first backend in `vc-handled-backends' that declares itself
1518 responsible for FILE is returned. If no backend declares itself
1519 responsible, return the first backend.
1520
1521 If REGISTER is non-nil, return the first responsible backend under
1522 which FILE is not yet registered. If there is no such backend, return
1523 the first backend under which FILE is not yet registered, but could
1524 be registered."
1525 (if (not vc-handled-backends)
1526 (error "No handled backends"))
1527 (or (and (not (file-directory-p file)) (not register) (vc-backend file))
1528 (catch 'found
1529 ;; First try: find a responsible backend. If this is for registration,
1530 ;; it must be a backend under which FILE is not yet registered.
1531 (dolist (backend vc-handled-backends)
1532 (and (or (not register)
1533 (not (vc-call-backend backend 'registered file)))
1534 (vc-call-backend backend 'responsible-p file)
1535 (throw 'found backend)))
1536 ;; no responsible backend
1537 (if (not register)
1538 ;; if this is not for registration, the first backend must do
1539 (car vc-handled-backends)
1540 ;; for registration, we need to find a new backend that
1541 ;; could register FILE
1542 (dolist (backend vc-handled-backends)
1543 (and (not (vc-call-backend backend 'registered file))
1544 (vc-call-backend backend 'could-register file)
1545 (throw 'found backend)))
1546 (error "No backend that could register")))))
1547
1548 (defun vc-default-responsible-p (backend file)
1549 "Indicate whether BACKEND is reponsible for FILE.
1550 The default is to return nil always."
1551 nil)
1552
1553 (defun vc-default-could-register (backend file)
1554 "Return non-nil if BACKEND could be used to register FILE.
1555 The default implementation returns t for all files."
1556 t)
1557
1558 (defun vc-expand-dirs (file-or-dir-list)
1559 "Expands directories in a file list specification.
1560 Only files already under version control are noticed."
1561 ;; FIXME: Kill this function.
1562 (let ((flattened '()))
1563 (dolist (node file-or-dir-list)
1564 (vc-file-tree-walk
1565 node (lambda (f) (if (vc-backend f) (push f flattened)))))
1566 (nreverse flattened)))
1567
1568 (defun vc-resynch-window (file &optional keep noquery)
1569 "If FILE is in the current buffer, either revert or unvisit it.
1570 The choice between revert (to see expanded keywords) and unvisit depends on
1571 `vc-keep-workfiles'. NOQUERY if non-nil inhibits confirmation for
1572 reverting. NOQUERY should be t *only* if it is known the only
1573 difference between the buffer and the file is due to version control
1574 rather than user editing!"
1575 (and (string= buffer-file-name file)
1576 (if keep
1577 (progn
1578 (vc-revert-buffer1 t noquery)
1579 ;; TODO: Adjusting view mode might no longer be necessary
1580 ;; after RMS change to files.el of 1999-08-08. Investigate
1581 ;; this when we install the new VC.
1582 (and view-read-only
1583 (if (file-writable-p file)
1584 (and view-mode
1585 (let ((view-old-buffer-read-only nil))
1586 (view-mode-exit)))
1587 (and (not view-mode)
1588 (not (eq (get major-mode 'mode-class) 'special))
1589 (view-mode-enter))))
1590 (vc-mode-line buffer-file-name))
1591 (kill-buffer (current-buffer)))))
1592
1593 (defun vc-resynch-buffer (file &optional keep noquery)
1594 "If FILE is currently visited, resynch its buffer."
1595 (if (string= buffer-file-name file)
1596 (vc-resynch-window file keep noquery)
1597 (let ((buffer (get-file-buffer file)))
1598 (if buffer
1599 (with-current-buffer buffer
1600 (vc-resynch-window file keep noquery)))))
1601 (vc-dired-resynch-file file))
1602
1603 (defun vc-start-entry (file rev comment initial-contents msg action &optional after-hook)
1604 "Accept a comment for an operation on FILE revision REV.
1605 If COMMENT is nil, pop up a VC-log buffer, emit MSG, and set the
1606 action on close to ACTION. If COMMENT is a string and
1607 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial
1608 contents of the log entry buffer. If COMMENT is a string and
1609 INITIAL-CONTENTS is nil, do action immediately as if the user had
1610 entered COMMENT. If COMMENT is t, also do action immediately with an
1611 empty comment. Remember the file's buffer in `vc-parent-buffer'
1612 \(current one if no file). AFTER-HOOK specifies the local value
1613 for vc-log-operation-hook."
1614 (let ((parent (or (and file (get-file-buffer file)) (current-buffer))))
1615 (if vc-before-checkin-hook
1616 (if file
1617 (with-current-buffer parent
1618 (run-hooks 'vc-before-checkin-hook))
1619 (run-hooks 'vc-before-checkin-hook)))
1620 (if (and comment (not initial-contents))
1621 (set-buffer (get-buffer-create "*VC-log*"))
1622 (pop-to-buffer (get-buffer-create "*VC-log*")))
1623 (set (make-local-variable 'vc-parent-buffer) parent)
1624 (set (make-local-variable 'vc-parent-buffer-name)
1625 (concat " from " (buffer-name vc-parent-buffer)))
1626 (if file (vc-mode-line file))
1627 (vc-log-edit file)
1628 (make-local-variable 'vc-log-after-operation-hook)
1629 (if after-hook
1630 (setq vc-log-after-operation-hook after-hook))
1631 (setq vc-log-operation action)
1632 (setq vc-log-version rev)
1633 (when comment
1634 (erase-buffer)
1635 (when (stringp comment) (insert comment)))
1636 (if (or (not comment) initial-contents)
1637 (message "%s Type C-c C-c when done" msg)
1638 (vc-finish-logentry (eq comment t)))))
1639
1640 (defun vc-checkout (file &optional writable rev)
1641 "Retrieve a copy of the revision REV of FILE.
1642 If WRITABLE is non-nil, make sure the retrieved file is writable.
1643 REV defaults to the latest revision.
1644
1645 After check-out, runs the normal hook `vc-checkout-hook'."
1646 (and writable
1647 (not rev)
1648 (vc-call make-version-backups-p file)
1649 (vc-up-to-date-p file)
1650 (vc-make-version-backup file))
1651 (with-vc-properties
1652 file
1653 (condition-case err
1654 (vc-call checkout file writable rev)
1655 (file-error
1656 ;; Maybe the backend is not installed ;-(
1657 (when writable
1658 (let ((buf (get-file-buffer file)))
1659 (when buf (with-current-buffer buf (toggle-read-only -1)))))
1660 (signal (car err) (cdr err))))
1661 `((vc-state . ,(if (or (eq (vc-checkout-model file) 'implicit)
1662 (not writable))
1663 (if (vc-call latest-on-branch-p file)
1664 'up-to-date
1665 'needs-patch)
1666 'edited))
1667 (vc-checkout-time . ,(nth 5 (file-attributes file)))))
1668 (vc-resynch-buffer file t t)
1669 (run-hooks 'vc-checkout-hook))
1670
1671 (defun vc-steal-lock (file rev owner)
1672 "Steal the lock on FILE."
1673 (let (file-description)
1674 (if rev
1675 (setq file-description (format "%s:%s" file rev))
1676 (setq file-description file))
1677 (if (not (yes-or-no-p (format "Steal the lock on %s from %s? "
1678 file-description owner)))
1679 (error "Steal canceled"))
1680 (message "Stealing lock on %s..." file)
1681 (with-vc-properties
1682 file
1683 (vc-call steal-lock file rev)
1684 `((vc-state . edited)))
1685 (vc-resynch-buffer file t t)
1686 (message "Stealing lock on %s...done" file)
1687 ;; Write mail after actually stealing, because if the stealing
1688 ;; goes wrong, we don't want to send any mail.
1689 (compose-mail owner (format "Stolen lock on %s" file-description))
1690 (setq default-directory (expand-file-name "~/"))
1691 (goto-char (point-max))
1692 (insert
1693 (format "I stole the lock on %s, " file-description)
1694 (current-time-string)
1695 ".\n")
1696 (message "Please explain why you stole the lock. Type C-c C-c when done.")))
1697
1698 (defun vc-checkin (file &optional rev comment initial-contents)
1699 "Check in FILE.
1700 The optional argument REV may be a string specifying the new version
1701 level (if nil increment the current level). COMMENT is a comment
1702 string; if omitted, a buffer is popped up to accept a comment. If
1703 INITIAL-CONTENTS is non-nil, then COMMENT is used as the initial contents
1704 of the log entry buffer.
1705
1706 If `vc-keep-workfiles' is nil, FILE is deleted afterwards, provided
1707 that the version control system supports this mode of operation.
1708
1709 Runs the normal hook `vc-checkin-hook'."
1710 (vc-start-entry
1711 file rev comment initial-contents
1712 "Enter a change comment."
1713 (lambda (file rev comment)
1714 (message "Checking in %s..." file)
1715 ;; "This log message intentionally left almost blank".
1716 ;; RCS 5.7 gripes about white-space-only comments too.
1717 (or (and comment (string-match "[^\t\n ]" comment))
1718 (setq comment "*** empty log message ***"))
1719 (with-vc-properties
1720 file
1721 ;; Change buffers to get local value of vc-checkin-switches.
1722 (with-current-buffer (or (get-file-buffer file) (current-buffer))
1723 (progn
1724 (vc-call checkin (list file) rev comment)
1725 (vc-delete-automatic-version-backups file)))
1726 `((vc-state . up-to-date)
1727 (vc-checkout-time . ,(nth 5 (file-attributes file)))
1728 (vc-workfile-version . nil)))
1729 (message "Checking in %s...done" file))
1730 'vc-checkin-hook))
1731
1732 (defun vc-finish-logentry (&optional nocomment)
1733 "Complete the operation implied by the current log entry.
1734 Use the contents of the current buffer as a check-in or registration
1735 comment. If the optional arg NOCOMMENT is non-nil, then don't check
1736 the buffer contents as a comment."
1737 (interactive)
1738 ;; Check and record the comment, if any.
1739 (unless nocomment
1740 ;; Comment too long?
1741 (vc-call-backend (or (and vc-log-file (vc-backend vc-log-file))
1742 (vc-responsible-backend default-directory))
1743 'logentry-check)
1744 (run-hooks 'vc-logentry-check-hook))
1745 ;; Sync parent buffer in case the user modified it while editing the comment.
1746 ;; But not if it is a vc-dired buffer.
1747 (with-current-buffer vc-parent-buffer
1748 (or vc-dired-mode (vc-buffer-sync)))
1749 (if (not vc-log-operation) (error "No log operation is pending"))
1750 ;; save the parameters held in buffer-local variables
1751 (let ((log-operation vc-log-operation)
1752 (log-file vc-log-file)
1753 (log-version vc-log-version)
1754 (log-entry (buffer-string))
1755 (after-hook vc-log-after-operation-hook)
1756 (tmp-vc-parent-buffer vc-parent-buffer))
1757 (pop-to-buffer vc-parent-buffer)
1758 ;; OK, do it to it
1759 (save-excursion
1760 (funcall log-operation
1761 log-file
1762 log-version
1763 log-entry))
1764 ;; Remove checkin window (after the checkin so that if that fails
1765 ;; we don't zap the *VC-log* buffer and the typing therein).
1766 (let ((logbuf (get-buffer "*VC-log*")))
1767 (cond ((and logbuf vc-delete-logbuf-window)
1768 (delete-windows-on logbuf (selected-frame))
1769 ;; Kill buffer and delete any other dedicated windows/frames.
1770 (kill-buffer logbuf))
1771 (logbuf (pop-to-buffer "*VC-log*")
1772 (bury-buffer)
1773 (pop-to-buffer tmp-vc-parent-buffer))))
1774 ;; Now make sure we see the expanded headers
1775 (if log-file
1776 (vc-resynch-buffer log-file vc-keep-workfiles t))
1777 (if vc-dired-mode
1778 (dired-move-to-filename))
1779 (run-hooks after-hook 'vc-finish-logentry-hook)))
1780
1781 ;; Code for access to the comment ring
1782
1783 ;; Additional entry points for examining version histories
1784
1785 ;;;###autoload
1786 (defun vc-diff (historic &optional not-urgent)
1787 "Display diffs between file versions.
1788 Normally this compares the current file and buffer with the most
1789 recent checked in version of that file. This uses no arguments. With
1790 a prefix argument HISTORIC, it reads the file name to use and two
1791 version designators specifying which versions to compare. The
1792 optional argument NOT-URGENT non-nil means it is ok to say no to
1793 saving the buffer."
1794 (interactive (list current-prefix-arg t))
1795 (if historic
1796 (call-interactively 'vc-version-diff)
1797 (vc-ensure-vc-buffer)
1798 (let ((file buffer-file-name))
1799 (vc-buffer-sync not-urgent)
1800 (if (vc-workfile-unchanged-p buffer-file-name)
1801 (message "No changes to %s since latest version" file)
1802 (vc-version-diff file nil nil)))))
1803
1804 (defun vc-default-revision-completion-table (backend file) nil)
1805
1806 (defun vc-version-diff (file rev1 rev2)
1807 "List the differences between FILE's versions REV1 and REV2.
1808 If REV1 is empty or nil it means to use the current workfile version;
1809 REV2 empty or nil means the current file contents. FILE may also be
1810 a directory, in that case, generate diffs between the correponding
1811 versions of all registered files in or below it."
1812 (interactive
1813 (let* ((file (expand-file-name
1814 (read-file-name (if buffer-file-name
1815 "File or dir to diff (default visited file): "
1816 "File or dir to diff: ")
1817 default-directory buffer-file-name t)))
1818 (rev1-default nil) (rev2-default nil)
1819 (completion-table (vc-call revision-completion-table file)))
1820 ;; compute default versions based on the file state
1821 (cond
1822 ;; if it's a directory, don't supply any version default
1823 ((file-directory-p file)
1824 nil)
1825 ;; if the file is not up-to-date, use current version as older version
1826 ((not (vc-up-to-date-p file))
1827 (setq rev1-default (vc-workfile-version file)))
1828 ;; if the file is not locked, use last and previous version as default
1829 (t
1830 (setq rev1-default (vc-call previous-version file
1831 (vc-workfile-version file)))
1832 (if (string= rev1-default "") (setq rev1-default nil))
1833 (setq rev2-default (vc-workfile-version file))))
1834 ;; construct argument list
1835 (let* ((rev1-prompt (if rev1-default
1836 (concat "Older version (default "
1837 rev1-default "): ")
1838 "Older version: "))
1839 (rev2-prompt (concat "Newer version (default "
1840 (or rev2-default "current source") "): "))
1841 (rev1 (if completion-table
1842 (completing-read rev1-prompt completion-table
1843 nil nil nil nil rev1-default)
1844 (read-string rev1-prompt nil nil rev1-default)))
1845 (rev2 (if completion-table
1846 (completing-read rev2-prompt completion-table
1847 nil nil nil nil rev2-default)
1848 (read-string rev2-prompt nil nil rev2-default))))
1849 (list file rev1 rev2))))
1850 (if (file-directory-p file)
1851 ;; recursive directory diff
1852 (progn
1853 (vc-setup-buffer "*vc-diff*")
1854 (if (string-equal rev1 "") (setq rev1 nil))
1855 (if (string-equal rev2 "") (setq rev2 nil))
1856 (let ((inhibit-read-only t))
1857 (insert "Diffs between "
1858 (or rev1 "last version checked in")
1859 " and "
1860 (or rev2 "current workfile(s)")
1861 ":\n\n"))
1862 (let ((dir (file-name-as-directory file)))
1863 (vc-call-backend (vc-responsible-backend dir)
1864 'diff-tree dir rev1 rev2))
1865 (vc-exec-after `(let ((inhibit-read-only t))
1866 (insert "\nEnd of diffs.\n"))))
1867 ;; Single file diff. It is important that the vc-controlled buffer
1868 ;; is still current at this time, because any local settings in that
1869 ;; buffer should affect the diff command.
1870 (vc-diff-internal file rev1 rev2))
1871 (set-buffer "*vc-diff*")
1872 (if (and (zerop (buffer-size))
1873 (not (get-buffer-process (current-buffer))))
1874 (progn
1875 (if rev1
1876 (if rev2
1877 (message "No changes to %s between %s and %s" file rev1 rev2)
1878 (message "No changes to %s since %s" file rev1))
1879 (message "No changes to %s since latest version" file))
1880 nil)
1881 (pop-to-buffer (current-buffer))
1882 ;; Gnus-5.8.5 sets up an autoload for diff-mode, even if it's
1883 ;; not available. Work around that.
1884 (if (require 'diff-mode nil t) (diff-mode))
1885 (vc-exec-after '(let ((inhibit-read-only t))
1886 (if (eq (buffer-size) 0)
1887 (insert "No differences found.\n"))
1888 (goto-char (point-min))
1889 (shrink-window-if-larger-than-buffer)))
1890 t))
1891
1892 (defun vc-diff-label (file file-rev rev)
1893 (concat (file-relative-name file)
1894 (format-time-string "\t%d %b %Y %T %z\t"
1895 (nth 5 (file-attributes file-rev)))
1896 rev))
1897
1898 (defun vc-diff-internal (file rev1 rev2)
1899 "Run diff to compare FILE's revisions REV1 and REV2.
1900 Diff output goes to the *vc-diff* buffer. The exit status of the diff
1901 command is returned.
1902
1903 This function takes care to set up a proper coding system for diff output.
1904 If both revisions are available as local files, then it also does not
1905 actually call the backend, but performs a local diff."
1906 (if (or (not rev1) (string-equal rev1 ""))
1907 (setq rev1 (vc-workfile-version file)))
1908 (if (string-equal rev2 "")
1909 (setq rev2 nil))
1910 (let ((file-rev1 (vc-version-backup-file file rev1))
1911 (file-rev2 (if (not rev2)
1912 file
1913 (vc-version-backup-file file rev2)))
1914 (coding-system-for-read (vc-coding-system-for-diff file)))
1915 (if (and file-rev1 file-rev2)
1916 (let ((status
1917 (if (eq vc-diff-knows-L 'no)
1918 (apply 'vc-do-command "*vc-diff*" 1 "diff" nil
1919 (append (vc-switches nil 'diff)
1920 (list (file-relative-name file-rev1)
1921 (file-relative-name file-rev2))))
1922 (apply 'vc-do-command "*vc-diff*" 2 "diff" nil
1923 (append (vc-switches nil 'diff)
1924 ;; Provide explicit labels like RCS or
1925 ;; CVS would do so diff-mode refers to
1926 ;; `file' rather than to `file-rev1'
1927 ;; when trying to find/apply/undo
1928 ;; hunks.
1929 (list "-L" (vc-diff-label file file-rev1 rev1)
1930 "-L" (vc-diff-label file file-rev2 rev2)
1931 (file-relative-name file-rev1)
1932 (file-relative-name file-rev2)))))))
1933 (if (eq status 2)
1934 (if (not vc-diff-knows-L)
1935 (setq vc-diff-knows-L 'no
1936 status (apply 'vc-do-command "*vc-diff*" 1 "diff" nil
1937 (append
1938 (vc-switches nil 'diff)
1939 (list (file-relative-name file-rev1)
1940 (file-relative-name file-rev2)))))
1941 (error "diff failed"))
1942 (if (not vc-diff-knows-L) (setq vc-diff-knows-L 'yes)))
1943 status)
1944 (vc-call diff (list file) rev1 rev2 "*vc-diff*"))))
1945
1946 (defun vc-switches (backend op)
1947 (let ((switches
1948 (or (if backend
1949 (let ((sym (vc-make-backend-sym
1950 backend (intern (concat (symbol-name op)
1951 "-switches")))))
1952 (if (boundp sym) (symbol-value sym))))
1953 (let ((sym (intern (format "vc-%s-switches" (symbol-name op)))))
1954 (if (boundp sym) (symbol-value sym)))
1955 (cond
1956 ((eq op 'diff) diff-switches)))))
1957 (if (stringp switches) (list switches)
1958 ;; If not a list, return nil.
1959 ;; This is so we can set vc-diff-switches to t to override
1960 ;; any switches in diff-switches.
1961 (if (listp switches) switches))))
1962
1963 ;; Old def for compatibility with Emacs-21.[123].
1964 (defmacro vc-diff-switches-list (backend) `(vc-switches ',backend 'diff))
1965 (make-obsolete 'vc-diff-switches-list 'vc-switches "22.1")
1966
1967 (defun vc-default-diff-tree (backend dir rev1 rev2)
1968 "List differences for all registered files at and below DIR.
1969 The meaning of REV1 and REV2 is the same as for `vc-version-diff'."
1970 ;; This implementation does an explicit tree walk, and calls
1971 ;; vc-BACKEND-diff directly for each file. An optimization
1972 ;; would be to use `vc-diff-internal', so that diffs can be local,
1973 ;; and to call it only for files that are actually changed.
1974 ;; However, this is expensive for some backends, and so it is left
1975 ;; to backend-specific implementations.
1976 (setq default-directory dir)
1977 (vc-file-tree-walk
1978 default-directory
1979 (lambda (f)
1980 (vc-exec-after
1981 `(let ((coding-system-for-read (vc-coding-system-for-diff ',f)))
1982 (message "Looking at %s" ',f)
1983 (vc-call-backend ',(vc-backend f)
1984 'diff ',f ',rev1 ',rev2))))))
1985
1986 (defun vc-coding-system-for-diff (file)
1987 "Return the coding system for reading diff output for FILE."
1988 (or coding-system-for-read
1989 ;; if we already have this file open,
1990 ;; use the buffer's coding system
1991 (let ((buf (find-buffer-visiting file)))
1992 (if buf (with-current-buffer buf
1993 buffer-file-coding-system)))
1994 ;; otherwise, try to find one based on the file name
1995 (car (find-operation-coding-system 'insert-file-contents file))
1996 ;; and a final fallback
1997 'undecided))
1998
1999 ;;;###autoload
2000 (defun vc-version-other-window (rev)
2001 "Visit version REV of the current file in another window.
2002 If the current file is named `F', the version is named `F.~REV~'.
2003 If `F.~REV~' already exists, use it instead of checking it out again."
2004 (interactive
2005 (save-current-buffer
2006 (vc-ensure-vc-buffer)
2007 (let ((completion-table
2008 (vc-call revision-completion-table buffer-file-name))
2009 (prompt "Version to visit (default is workfile version): "))
2010 (list
2011 (if completion-table
2012 (completing-read prompt completion-table)
2013 (read-string prompt))))))
2014 (vc-ensure-vc-buffer)
2015 (let* ((file buffer-file-name)
2016 (version (if (string-equal rev "")
2017 (vc-workfile-version file)
2018 rev)))
2019 (switch-to-buffer-other-window (vc-find-version file version))))
2020
2021 (defun vc-find-version (file version)
2022 "Read VERSION of FILE into a buffer and return the buffer."
2023 (let ((automatic-backup (vc-version-backup-file-name file version))
2024 (filebuf (or (get-file-buffer file) (current-buffer)))
2025 (filename (vc-version-backup-file-name file version 'manual)))
2026 (unless (file-exists-p filename)
2027 (if (file-exists-p automatic-backup)
2028 (rename-file automatic-backup filename nil)
2029 (message "Checking out %s..." filename)
2030 (with-current-buffer filebuf
2031 (let ((failed t))
2032 (unwind-protect
2033 (let ((coding-system-for-read 'no-conversion)
2034 (coding-system-for-write 'no-conversion))
2035 (with-temp-file filename
2036 (let ((outbuf (current-buffer)))
2037 ;; Change buffer to get local value of
2038 ;; vc-checkout-switches.
2039 (with-current-buffer filebuf
2040 (vc-call find-version file version outbuf))))
2041 (setq failed nil))
2042 (if (and failed (file-exists-p filename))
2043 (delete-file filename))))
2044 (vc-mode-line file))
2045 (message "Checking out %s...done" filename)))
2046 (find-file-noselect filename)))
2047
2048 (defun vc-default-find-version (backend file rev buffer)
2049 "Provide the new `find-version' op based on the old `checkout' op.
2050 This is only for compatibility with old backends. They should be updated
2051 to provide the `find-version' operation instead."
2052 (let ((tmpfile (make-temp-file (expand-file-name file))))
2053 (unwind-protect
2054 (progn
2055 (vc-call-backend backend 'checkout file nil rev tmpfile)
2056 (with-current-buffer buffer
2057 (insert-file-contents-literally tmpfile)))
2058 (delete-file tmpfile))))
2059
2060 ;; Header-insertion code
2061
2062 ;;;###autoload
2063 (defun vc-insert-headers ()
2064 "Insert headers into a file for use with a version control system.
2065 Headers desired are inserted at point, and are pulled from
2066 the variable `vc-BACKEND-header'."
2067 (interactive)
2068 (vc-ensure-vc-buffer)
2069 (save-excursion
2070 (save-restriction
2071 (widen)
2072 (if (or (not (vc-check-headers))
2073 (y-or-n-p "Version headers already exist. Insert another set? "))
2074 (let* ((delims (cdr (assq major-mode vc-comment-alist)))
2075 (comment-start-vc (or (car delims) comment-start "#"))
2076 (comment-end-vc (or (car (cdr delims)) comment-end ""))
2077 (hdsym (vc-make-backend-sym (vc-backend buffer-file-name)
2078 'header))
2079 (hdstrings (and (boundp hdsym) (symbol-value hdsym))))
2080 (dolist (s hdstrings)
2081 (insert comment-start-vc "\t" s "\t"
2082 comment-end-vc "\n"))
2083 (if vc-static-header-alist
2084 (dolist (f vc-static-header-alist)
2085 (if (string-match (car f) buffer-file-name)
2086 (insert (format (cdr f) (car hdstrings)))))))))))
2087
2088 (defun vc-clear-headers (&optional file)
2089 "Clear all version headers in the current buffer (or FILE).
2090 The headers are reset to their non-expanded form."
2091 (let* ((filename (or file buffer-file-name))
2092 (visited (find-buffer-visiting filename))
2093 (backend (vc-backend filename)))
2094 (when (vc-find-backend-function backend 'clear-headers)
2095 (if visited
2096 (let ((context (vc-buffer-context)))
2097 ;; save-excursion may be able to relocate point and mark
2098 ;; properly. If it fails, vc-restore-buffer-context
2099 ;; will give it a second try.
2100 (save-excursion
2101 (vc-call-backend backend 'clear-headers))
2102 (vc-restore-buffer-context context))
2103 (set-buffer (find-file-noselect filename))
2104 (vc-call-backend backend 'clear-headers)
2105 (kill-buffer filename)))))
2106
2107 ;;;###autoload
2108 (defun vc-merge ()
2109 "Merge changes between two versions into the current buffer's file.
2110 This asks for two versions to merge from in the minibuffer. If the
2111 first version is a branch number, then merge all changes from that
2112 branch. If the first version is empty, merge news, i.e. recent changes
2113 from the current branch.
2114
2115 See Info node `Merging'."
2116 (interactive)
2117 (vc-ensure-vc-buffer)
2118 (vc-buffer-sync)
2119 (let* ((file buffer-file-name)
2120 (backend (vc-backend file))
2121 (state (vc-state file))
2122 first-version second-version status)
2123 (cond
2124 ((stringp state)
2125 (error "File is locked by %s" state))
2126 ((not (vc-editable-p file))
2127 (if (y-or-n-p
2128 "File must be checked out for merging. Check out now? ")
2129 (vc-checkout file t)
2130 (error "Merge aborted"))))
2131 (setq first-version
2132 (read-string (concat "Branch or version to merge from "
2133 "(default news on current branch): ")))
2134 (if (string= first-version "")
2135 (if (not (vc-find-backend-function backend 'merge-news))
2136 (error "Sorry, merging news is not implemented for %s" backend)
2137 (setq status (vc-call merge-news file)))
2138 (if (not (vc-find-backend-function backend 'merge))
2139 (error "Sorry, merging is not implemented for %s" backend)
2140 (if (not (vc-branch-p first-version))
2141 (setq second-version
2142 (read-string "Second version: "
2143 (concat (vc-branch-part first-version) ".")))
2144 ;; We want to merge an entire branch. Set versions
2145 ;; accordingly, so that vc-BACKEND-merge understands us.
2146 (setq second-version first-version)
2147 ;; first-version must be the starting point of the branch
2148 (setq first-version (vc-branch-part first-version)))
2149 (setq status (vc-call merge file first-version second-version))))
2150 (vc-maybe-resolve-conflicts file status "WORKFILE" "MERGE SOURCE")))
2151
2152 (defun vc-maybe-resolve-conflicts (file status &optional name-A name-B)
2153 (vc-resynch-buffer file t (not (buffer-modified-p)))
2154 (if (zerop status) (message "Merge successful")
2155 (smerge-mode 1)
2156 (message "File contains conflicts.")))
2157
2158 ;;;###autoload
2159 (defalias 'vc-resolve-conflicts 'smerge-ediff)
2160
2161 ;; The VC directory major mode. Coopt Dired for this.
2162 ;; All VC commands get mapped into logical equivalents.
2163
2164 (defvar vc-dired-switches)
2165 (defvar vc-dired-terse-mode)
2166
2167 (defvar vc-dired-mode-map
2168 (let ((map (make-sparse-keymap))
2169 (vmap (make-sparse-keymap)))
2170 (define-key map "\C-xv" vmap)
2171 (define-key map "v" vmap)
2172 (set-keymap-parent vmap vc-prefix-map)
2173 (define-key vmap "t" 'vc-dired-toggle-terse-mode)
2174 map))
2175
2176 (define-derived-mode vc-dired-mode dired-mode "Dired under "
2177 "The major mode used in VC directory buffers.
2178
2179 It works like Dired, but lists only files under version control, with
2180 the current VC state of each file being indicated in the place of the
2181 file's link count, owner, group and size. Subdirectories are also
2182 listed, and you may insert them into the buffer as desired, like in
2183 Dired.
2184
2185 All Dired commands operate normally, with the exception of `v', which
2186 is redefined as the version control prefix, so that you can type
2187 `vl', `v=' etc. to invoke `vc-print-log', `vc-diff', and the like on
2188 the file named in the current Dired buffer line. `vv' invokes
2189 `vc-next-action' on this file, or on all files currently marked.
2190 There is a special command, `*l', to mark all files currently locked."
2191 ;; define-derived-mode does it for us in Emacs-21, but not in Emacs-20.
2192 ;; We do it here because dired might not be loaded yet
2193 ;; when vc-dired-mode-map is initialized.
2194 (set-keymap-parent vc-dired-mode-map dired-mode-map)
2195 (add-hook 'dired-after-readin-hook 'vc-dired-hook nil t)
2196 ;; The following is slightly modified from files.el,
2197 ;; because file lines look a bit different in vc-dired-mode
2198 ;; (the column before the date does not end in a digit).
2199 ;; albinus: It should be done in the original declaration. Problem
2200 ;; is the optional empty state-info; otherwise ")" would be good
2201 ;; enough as delimeter.
2202 (set (make-local-variable 'directory-listing-before-filename-regexp)
2203 (let* ((l "\\([A-Za-z]\\|[^\0-\177]\\)")
2204 ;; In some locales, month abbreviations are as short as 2 letters,
2205 ;; and they can be followed by ".".
2206 (month (concat l l "+\\.?"))
2207 (s " ")
2208 (yyyy "[0-9][0-9][0-9][0-9]")
2209 (dd "[ 0-3][0-9]")
2210 (HH:MM "[ 0-2][0-9]:[0-5][0-9]")
2211 (seconds "[0-6][0-9]\\([.,][0-9]+\\)?")
2212 (zone "[-+][0-2][0-9][0-5][0-9]")
2213 (iso-mm-dd "[01][0-9]-[0-3][0-9]")
2214 (iso-time (concat HH:MM "\\(:" seconds "\\( ?" zone "\\)?\\)?"))
2215 (iso (concat "\\(\\(" yyyy "-\\)?" iso-mm-dd "[ T]" iso-time
2216 "\\|" yyyy "-" iso-mm-dd "\\)"))
2217 (western (concat "\\(" month s "+" dd "\\|" dd "\\.?" s month "\\)"
2218 s "+"
2219 "\\(" HH:MM "\\|" yyyy "\\)"))
2220 (western-comma (concat month s "+" dd "," s "+" yyyy))
2221 ;; Japanese MS-Windows ls-lisp has one-digit months, and
2222 ;; omits the Kanji characters after month and day-of-month.
2223 (mm "[ 0-1]?[0-9]")
2224 (japanese
2225 (concat mm l "?" s dd l "?" s "+"
2226 "\\(" HH:MM "\\|" yyyy l "?" "\\)")))
2227 ;; the .* below ensures that we find the last match on a line
2228 (concat ".*" s
2229 "\\(" western "\\|" western-comma "\\|" japanese "\\|" iso "\\)"
2230 s "+")))
2231 (and (boundp 'vc-dired-switches)
2232 vc-dired-switches
2233 (set (make-local-variable 'dired-actual-switches)
2234 vc-dired-switches))
2235 (set (make-local-variable 'vc-dired-terse-mode) vc-dired-terse-display)
2236 (let ((backend-name (symbol-name (vc-responsible-backend
2237 default-directory))))
2238 (setq mode-name (concat mode-name backend-name))
2239 ;; Add menu after `vc-dired-mode-map' has `dired-mode-map' as the parent.
2240 (let ((vc-dire-menu-map (copy-keymap vc-menu-map)))
2241 (define-key-after (lookup-key vc-dired-mode-map [menu-bar]) [vc]
2242 (cons backend-name vc-dire-menu-map) 'subdir)))
2243 (setq vc-dired-mode t))
2244
2245 (defun vc-dired-toggle-terse-mode ()
2246 "Toggle terse display in VC Dired."
2247 (interactive)
2248 (if (not vc-dired-mode)
2249 nil
2250 (setq vc-dired-terse-mode (not vc-dired-terse-mode))
2251 (if vc-dired-terse-mode
2252 (vc-dired-hook)
2253 (revert-buffer))))
2254
2255 (defun vc-dired-mark-locked ()
2256 "Mark all files currently locked."
2257 (interactive)
2258 (dired-mark-if (let ((f (dired-get-filename nil t)))
2259 (and f
2260 (not (file-directory-p f))
2261 (not (vc-up-to-date-p f))))
2262 "locked file"))
2263
2264 (define-key vc-dired-mode-map "*l" 'vc-dired-mark-locked)
2265
2266 (defun vc-default-dired-state-info (backend file)
2267 (let ((state (vc-state file)))
2268 (cond
2269 ((stringp state) (concat "(" state ")"))
2270 ((eq state 'edited) (concat "(" (vc-user-login-name file) ")"))
2271 ((eq state 'needs-merge) "(merge)")
2272 ((eq state 'needs-patch) "(patch)")
2273 ((eq state 'unlocked-changes) "(stale)"))))
2274
2275 (defun vc-dired-reformat-line (vc-info)
2276 "Reformat a directory-listing line.
2277 Replace various columns with version control information, VC-INFO.
2278 This code, like dired, assumes UNIX -l format."
2279 (beginning-of-line)
2280 (when (re-search-forward
2281 ;; Match link count, owner, group, size. Group may be missing,
2282 ;; and only the size is present in OS/2 -l format.
2283 "^..[drwxlts-]+ \\( *[0-9]+\\( [^ ]+ +\\([^ ]+ +\\)?[0-9]+\\)?\\) "
2284 (line-end-position) t)
2285 (replace-match (substring (concat vc-info " ") 0 10)
2286 t t nil 1)))
2287
2288 (defun vc-dired-hook ()
2289 "Reformat the listing according to version control.
2290 Called by dired after any portion of a vc-dired buffer has been read in."
2291 (message "Getting version information... ")
2292 (let (subdir filename (inhibit-read-only t))
2293 (goto-char (point-min))
2294 (while (not (eobp))
2295 (cond
2296 ;; subdir header line
2297 ((setq subdir (dired-get-subdir))
2298 ;; if the backend supports it, get the state
2299 ;; of all files in this directory at once
2300 (let ((backend (vc-responsible-backend subdir)))
2301 ;; check `backend' can really handle `subdir'.
2302 (if (and (vc-call-backend backend 'responsible-p subdir)
2303 (vc-find-backend-function backend 'dir-state))
2304 (vc-call-backend backend 'dir-state subdir)))
2305 (forward-line 1)
2306 ;; erase (but don't remove) the "total" line
2307 (delete-region (point) (line-end-position))
2308 (beginning-of-line)
2309 (forward-line 1))
2310 ;; file line
2311 ((setq filename (dired-get-filename nil t))
2312 (cond
2313 ;; subdir
2314 ((file-directory-p filename)
2315 (cond
2316 ((member (file-name-nondirectory filename)
2317 vc-directory-exclusion-list)
2318 (let ((pos (point)))
2319 (dired-kill-tree filename)
2320 (goto-char pos)
2321 (dired-kill-line)))
2322 (vc-dired-terse-mode
2323 ;; Don't show directories in terse mode. Don't use
2324 ;; dired-kill-line to remove it, because in recursive listings,
2325 ;; that would remove the directory contents as well.
2326 (delete-region (line-beginning-position)
2327 (progn (forward-line 1) (point))))
2328 ((string-match "\\`\\.\\.?\\'" (file-name-nondirectory filename))
2329 (dired-kill-line))
2330 (t
2331 (vc-dired-reformat-line nil)
2332 (forward-line 1))))
2333 ;; ordinary file
2334 ((and (vc-backend filename)
2335 (not (and vc-dired-terse-mode
2336 (vc-up-to-date-p filename))))
2337 (vc-dired-reformat-line (vc-call dired-state-info filename))
2338 (forward-line 1))
2339 (t
2340 (dired-kill-line))))
2341 ;; any other line
2342 (t (forward-line 1))))
2343 (vc-dired-purge))
2344 (message "Getting version information... done")
2345 (save-restriction
2346 (widen)
2347 (cond ((eq (count-lines (point-min) (point-max)) 1)
2348 (goto-char (point-min))
2349 (message "No files locked under %s" default-directory)))))
2350
2351 (defun vc-dired-purge ()
2352 "Remove empty subdirs."
2353 (goto-char (point-min))
2354 (while (dired-get-subdir)
2355 (forward-line 2)
2356 (if (dired-get-filename nil t)
2357 (if (not (dired-next-subdir 1 t))
2358 (goto-char (point-max)))
2359 (forward-line -2)
2360 (if (not (string= (dired-current-directory) default-directory))
2361 (dired-do-kill-lines t "")
2362 ;; We cannot remove the top level directory.
2363 ;; Just make it look a little nicer.
2364 (forward-line 1)
2365 (or (eobp) (kill-line))
2366 (if (not (dired-next-subdir 1 t))
2367 (goto-char (point-max))))))
2368 (goto-char (point-min)))
2369
2370 (defun vc-dired-buffers-for-dir (dir)
2371 "Return a list of all vc-dired buffers that currently display DIR."
2372 (let (result)
2373 ;; Check whether dired is loaded.
2374 (when (fboundp 'dired-buffers-for-dir)
2375 (mapcar (lambda (buffer)
2376 (with-current-buffer buffer
2377 (if vc-dired-mode
2378 (setq result (append result (list buffer))))))
2379 (dired-buffers-for-dir dir)))
2380 result))
2381
2382 (defun vc-dired-resynch-file (file)
2383 "Update the entries for FILE in any VC Dired buffers that list it."
2384 (let ((buffers (vc-dired-buffers-for-dir (file-name-directory file))))
2385 (when buffers
2386 (mapcar (lambda (buffer)
2387 (with-current-buffer buffer
2388 (if (dired-goto-file file)
2389 ;; bind vc-dired-terse-mode to nil so that
2390 ;; files won't vanish when they are checked in
2391 (let ((vc-dired-terse-mode nil))
2392 (dired-do-redisplay 1)))))
2393 buffers))))
2394
2395 ;;;###autoload
2396 (defun vc-directory (dir read-switches)
2397 "Create a buffer in VC Dired Mode for directory DIR.
2398
2399 See Info node `VC Dired Mode'.
2400
2401 With prefix arg READ-SWITCHES, specify a value to override
2402 `dired-listing-switches' when generating the listing."
2403 (interactive "DDired under VC (directory): \nP")
2404 (let ((vc-dired-switches (concat vc-dired-listing-switches
2405 (if vc-dired-recurse "R" ""))))
2406 (if (eq (string-match tramp-file-name-regexp dir) 0)
2407 (error "Sorry, vc-directory does not work over Tramp"))
2408 (if read-switches
2409 (setq vc-dired-switches
2410 (read-string "Dired listing switches: "
2411 vc-dired-switches)))
2412 (require 'dired)
2413 (require 'dired-aux)
2414 (switch-to-buffer
2415 (dired-internal-noselect (expand-file-name (file-name-as-directory dir))
2416 vc-dired-switches
2417 'vc-dired-mode))))
2418
2419
2420 ;; Named-configuration entry points
2421
2422 (defun vc-snapshot-precondition (dir)
2423 "Scan the tree below DIR, looking for files not up-to-date.
2424 If any file is not up-to-date, return the name of the first such file.
2425 \(This means, neither snapshot creation nor retrieval is allowed.\)
2426 If one or more of the files are currently visited, return `visited'.
2427 Otherwise, return nil."
2428 (let ((status nil))
2429 (catch 'vc-locked-example
2430 (vc-file-tree-walk
2431 dir
2432 (lambda (f)
2433 (if (not (vc-up-to-date-p f)) (throw 'vc-locked-example f)
2434 (if (get-file-buffer f) (setq status 'visited)))))
2435 status)))
2436
2437 ;;;###autoload
2438 (defun vc-create-snapshot (dir name branchp)
2439 "Descending recursively from DIR, make a snapshot called NAME.
2440 For each registered file, the version level of its latest version
2441 becomes part of the named configuration. If the prefix argument
2442 BRANCHP is given, the snapshot is made as a new branch and the files
2443 are checked out in that new branch."
2444 (interactive
2445 (list (read-file-name "Directory: " default-directory default-directory t)
2446 (read-string "New snapshot name: ")
2447 current-prefix-arg))
2448 (message "Making %s... " (if branchp "branch" "snapshot"))
2449 (if (file-directory-p dir) (setq dir (file-name-as-directory dir)))
2450 (vc-call-backend (vc-responsible-backend dir)
2451 'create-snapshot dir name branchp)
2452 (message "Making %s... done" (if branchp "branch" "snapshot")))
2453
2454 (defun vc-default-create-snapshot (backend dir name branchp)
2455 (when branchp
2456 (error "VC backend %s does not support module branches" backend))
2457 (let ((result (vc-snapshot-precondition dir)))
2458 (if (stringp result)
2459 (error "File %s is not up-to-date" result)
2460 (vc-file-tree-walk
2461 dir
2462 (lambda (f)
2463 (vc-call assign-name f name))))))
2464
2465 ;;;###autoload
2466 (defun vc-retrieve-snapshot (dir name)
2467 "Descending recursively from DIR, retrieve the snapshot called NAME.
2468 If NAME is empty, it refers to the latest versions.
2469 If locking is used for the files in DIR, then there must not be any
2470 locked files at or below DIR (but if NAME is empty, locked files are
2471 allowed and simply skipped)."
2472 (interactive
2473 (list (read-file-name "Directory: " default-directory default-directory t)
2474 (read-string "Snapshot name to retrieve (default latest versions): ")))
2475 (let ((update (yes-or-no-p "Update any affected buffers? "))
2476 (msg (if (or (not name) (string= name ""))
2477 (format "Updating %s... " (abbreviate-file-name dir))
2478 (format "Retrieving snapshot into %s... "
2479 (abbreviate-file-name dir)))))
2480 (message "%s" msg)
2481 (vc-call-backend (vc-responsible-backend dir)
2482 'retrieve-snapshot dir name update)
2483 (message "%s" (concat msg "done"))))
2484
2485 (defun vc-default-retrieve-snapshot (backend dir name update)
2486 (if (string= name "")
2487 (progn
2488 (vc-file-tree-walk
2489 dir
2490 (lambda (f) (and
2491 (vc-up-to-date-p f)
2492 (vc-error-occurred
2493 (vc-call checkout f nil "")
2494 (if update (vc-resynch-buffer f t t)))))))
2495 (let ((result (vc-snapshot-precondition dir)))
2496 (if (stringp result)
2497 (error "File %s is locked" result)
2498 (setq update (and (eq result 'visited) update))
2499 (vc-file-tree-walk
2500 dir
2501 (lambda (f) (vc-error-occurred
2502 (vc-call checkout f nil name)
2503 (if update (vc-resynch-buffer f t t)))))))))
2504
2505 ;; Miscellaneous other entry points
2506
2507 ;;;###autoload
2508 (defun vc-print-log (&optional focus-rev)
2509 "List the change log of the current buffer in a window.
2510 If FOCUS-REV is non-nil, leave the point at that revision."
2511 (interactive)
2512 (vc-ensure-vc-buffer)
2513 (let ((file buffer-file-name))
2514 (or focus-rev (setq focus-rev (vc-workfile-version file)))
2515 ;; Don't switch to the output buffer before running the command,
2516 ;; so that any buffer-local settings in the vc-controlled
2517 ;; buffer can be accessed by the command.
2518 (condition-case err
2519 (progn
2520 (vc-call print-log (list file) "*vc-change-log*")
2521 (set-buffer "*vc-change-log*"))
2522 (wrong-number-of-arguments
2523 ;; If this error came from the above call to print-log, try again
2524 ;; without the optional buffer argument (for backward compatibility).
2525 ;; Otherwise, resignal.
2526 (if (or (not (eq (cadr err)
2527 (indirect-function
2528 (vc-find-backend-function (vc-backend file)
2529 'print-log))))
2530 (not (eq (caddr err) 2)))
2531 (signal (car err) (cdr err))
2532 ;; for backward compatibility
2533 (vc-call print-log (list file))
2534 (set-buffer "*vc*"))))
2535 (pop-to-buffer (current-buffer))
2536 (vc-exec-after
2537 `(let ((inhibit-read-only t))
2538 (vc-call-backend ',(vc-backend file) 'log-view-mode)
2539 (goto-char (point-max)) (forward-line -1)
2540 (while (looking-at "=*\n")
2541 (delete-char (- (match-end 0) (match-beginning 0)))
2542 (forward-line -1))
2543 (goto-char (point-min))
2544 (if (looking-at "[\b\t\n\v\f\r ]+")
2545 (delete-char (- (match-end 0) (match-beginning 0))))
2546 ;; (shrink-window-if-larger-than-buffer)
2547 ;; move point to the log entry for the current version
2548 (vc-call-backend ',(vc-backend file)
2549 'show-log-entry
2550 ',focus-rev)
2551 (set-buffer-modified-p nil)))))
2552
2553 (defun vc-default-log-view-mode (backend) (log-view-mode))
2554 (defun vc-default-show-log-entry (backend rev)
2555 (with-no-warnings
2556 (log-view-goto-rev rev)))
2557
2558 (defun vc-default-comment-history (backend file)
2559 "Return a string with all log entries stored in BACKEND for FILE."
2560 (if (vc-find-backend-function backend 'print-log)
2561 (with-current-buffer "*vc*"
2562 (vc-call print-log (list file))
2563 (vc-call wash-log file)
2564 (buffer-string))))
2565
2566 (defun vc-default-wash-log (backend file)
2567 "Remove all non-comment information from log output.
2568 This default implementation works for RCS logs; backends should override
2569 it if their logs are not in RCS format."
2570 (let ((separator (concat "^-+\nrevision [0-9.]+\ndate: .*\n"
2571 "\\(branches: .*;\n\\)?"
2572 "\\(\\*\\*\\* empty log message \\*\\*\\*\n\\)?")))
2573 (goto-char (point-max)) (forward-line -1)
2574 (while (looking-at "=*\n")
2575 (delete-char (- (match-end 0) (match-beginning 0)))
2576 (forward-line -1))
2577 (goto-char (point-min))
2578 (if (looking-at "[\b\t\n\v\f\r ]+")
2579 (delete-char (- (match-end 0) (match-beginning 0))))
2580 (goto-char (point-min))
2581 (re-search-forward separator nil t)
2582 (delete-region (point-min) (point))
2583 (while (re-search-forward separator nil t)
2584 (delete-region (match-beginning 0) (match-end 0)))))
2585
2586 ;;;###autoload
2587 (defun vc-revert ()
2588 "Revert the current buffer's file to the version it was based on.
2589 This asks for confirmation if the buffer contents are not identical
2590 to that version. This function does not automatically pick up newer
2591 changes found in the master file; use \\[universal-argument] \\[vc-next-action] to do so."
2592 (interactive)
2593 (vc-ensure-vc-buffer)
2594 ;; Make sure buffer is saved. If the user says `no', abort since
2595 ;; we cannot show the changes and ask for confirmation to discard them.
2596 (vc-buffer-sync nil)
2597 (let ((file buffer-file-name)
2598 ;; This operation should always ask for confirmation.
2599 (vc-suppress-confirm nil)
2600 (obuf (current-buffer))
2601 status)
2602 (if (vc-up-to-date-p file)
2603 (unless (yes-or-no-p "File seems up-to-date. Revert anyway? ")
2604 (error "Revert canceled")))
2605 (unless (vc-workfile-unchanged-p file)
2606 (message "Finding changes...")
2607 ;; vc-diff selects the new window, which is not what we want:
2608 ;; if the new window is on another frame, that'd require the user
2609 ;; moving her mouse to answer the yes-or-no-p question.
2610 (let* ((vc-disable-async-diff (not vc-allow-async-revert))
2611 (win (save-selected-window
2612 (setq status (vc-diff nil t)) (selected-window))))
2613 (vc-exec-after `(message nil))
2614 (when status
2615 (unwind-protect
2616 (unless (yes-or-no-p "Discard changes? ")
2617 (error "Revert canceled"))
2618 (select-window win)
2619 (if (one-window-p t)
2620 (if (window-dedicated-p (selected-window))
2621 (make-frame-invisible))
2622 (delete-window))))))
2623 (set-buffer obuf)
2624 ;; Do the reverting
2625 (message "Reverting %s..." file)
2626 (vc-revert-file file)
2627 (message "Reverting %s...done" file)))
2628
2629 ;;;###autoload
2630 (defun vc-update ()
2631 "Update the current buffer's file to the latest version on its branch.
2632 If the file contains no changes, and is not locked, then this simply replaces
2633 the working file with the latest version on its branch. If the file contains
2634 changes, and the backend supports merging news, then any recent changes from
2635 the current branch are merged into the working file."
2636 (interactive)
2637 (vc-ensure-vc-buffer)
2638 (vc-buffer-sync nil)
2639 (let ((file buffer-file-name))
2640 (if (vc-up-to-date-p file)
2641 (vc-checkout file nil "")
2642 (if (eq (vc-checkout-model file) 'locking)
2643 (if (eq (vc-state file) 'edited)
2644 (error
2645 (substitute-command-keys
2646 "File is locked--type \\[vc-revert] to discard changes"))
2647 (error
2648 (substitute-command-keys
2649 "Unexpected file state (%s)--type \\[vc-next-action] to correct")
2650 (vc-state file)))
2651 (if (not (vc-find-backend-function (vc-backend file) 'merge-news))
2652 (error "Sorry, merging news is not implemented for %s"
2653 (vc-backend file))
2654 (vc-call merge-news file)
2655 (vc-resynch-window file t t))))))
2656
2657 (defun vc-version-backup-file (file &optional rev)
2658 "Return name of backup file for revision REV of FILE.
2659 If version backups should be used for FILE, and there exists
2660 such a backup for REV or the current workfile version of file,
2661 return its name; otherwise return nil."
2662 (when (vc-call make-version-backups-p file)
2663 (let ((backup-file (vc-version-backup-file-name file rev)))
2664 (if (file-exists-p backup-file)
2665 backup-file
2666 ;; there is no automatic backup, but maybe the user made one manually
2667 (setq backup-file (vc-version-backup-file-name file rev 'manual))
2668 (if (file-exists-p backup-file)
2669 backup-file)))))
2670
2671 (defun vc-default-revert (backend file contents-done)
2672 (unless contents-done
2673 (let ((rev (vc-workfile-version file))
2674 (file-buffer (or (get-file-buffer file) (current-buffer))))
2675 (message "Checking out %s..." file)
2676 (let ((failed t)
2677 (backup-name (car (find-backup-file-name file))))
2678 (when backup-name
2679 (copy-file file backup-name 'ok-if-already-exists 'keep-date)
2680 (unless (file-writable-p file)
2681 (set-file-modes file (logior (file-modes file) 128))))
2682 (unwind-protect
2683 (let ((coding-system-for-read 'no-conversion)
2684 (coding-system-for-write 'no-conversion))
2685 (with-temp-file file
2686 (let ((outbuf (current-buffer)))
2687 ;; Change buffer to get local value of vc-checkout-switches.
2688 (with-current-buffer file-buffer
2689 (let ((default-directory (file-name-directory file)))
2690 (vc-call find-version file rev outbuf)))))
2691 (setq failed nil))
2692 (when backup-name
2693 (if failed
2694 (rename-file backup-name file 'ok-if-already-exists)
2695 (and (not vc-make-backup-files) (delete-file backup-name))))))
2696 (message "Checking out %s...done" file))))
2697
2698 (defun vc-revert-file (file)
2699 "Revert FILE back to the version it was based on."
2700 (with-vc-properties
2701 file
2702 (let ((backup-file (vc-version-backup-file file)))
2703 (when backup-file
2704 (copy-file backup-file file 'ok-if-already-exists 'keep-date)
2705 (vc-delete-automatic-version-backups file))
2706 (vc-call revert file backup-file))
2707 `((vc-state . up-to-date)
2708 (vc-checkout-time . ,(nth 5 (file-attributes file)))))
2709 (vc-resynch-buffer file t t))
2710
2711 ;;;###autoload
2712 (defun vc-rollback ()
2713 "Get rid of most recently checked in version of this file."
2714 (interactive "P")
2715 (vc-ensure-vc-buffer)
2716 (let* ((file buffer-file-name)
2717 (backend (vc-backend file))
2718 (target (vc-workfile-version file)))
2719 (cond
2720 ((not (vc-find-backend-function backend 'rollback))
2721 (error "Sorry, canceling versions is not supported under %s" backend))
2722 ((not (vc-call latest-on-branch-p file))
2723 (error "This is not the latest version; VC cannot cancel it"))
2724 ((not (vc-up-to-date-p file))
2725 (error "%s" (substitute-command-keys "File is not up to date; use \\[vc-revert] to discard changes"))))
2726 (if (null (yes-or-no-p (format "Remove version %s from master? " target)))
2727 (error "Aborted")
2728 (setq norevert (or norevert (not
2729 (yes-or-no-p "Revert buffer to most recent remaining version? "))))
2730
2731 (message "Removing last change from %s..." file)
2732 (with-vc-properties
2733 file
2734 (vc-call rollback (list file))
2735 `((vc-state . ,(if norevert 'edited 'up-to-date))
2736 (vc-checkout-time . ,(if norevert
2737 0
2738 (nth 5 (file-attributes file))))
2739 (vc-workfile-version . nil)))
2740 (message "Removing last change from %s...done" file)
2741
2742 (cond
2743 (norevert ;; clear version headers and mark the buffer modified
2744 (set-visited-file-name file)
2745 (when (not vc-make-backup-files)
2746 ;; inhibit backup for this buffer
2747 (make-local-variable 'backup-inhibited)
2748 (setq backup-inhibited t))
2749 (setq buffer-read-only nil)
2750 (vc-clear-headers)
2751 (vc-mode-line file)
2752 (vc-dired-resynch-file file))
2753 (t ;; revert buffer to file on disk
2754 (vc-resynch-buffer file t t)))
2755 (message "Version %s has been removed from the master" target))))
2756
2757 ;;;###autoload
2758 (defun vc-switch-backend (file backend)
2759 "Make BACKEND the current version control system for FILE.
2760 FILE must already be registered in BACKEND. The change is not
2761 permanent, only for the current session. This function only changes
2762 VC's perspective on FILE, it does not register or unregister it.
2763 By default, this command cycles through the registered backends.
2764 To get a prompt, use a prefix argument."
2765 (interactive
2766 (list
2767 (or buffer-file-name
2768 (error "There is no version-controlled file in this buffer"))
2769 (let ((backend (vc-backend buffer-file-name))
2770 (backends nil))
2771 (unwind-protect
2772 (progn
2773 (unless backend
2774 (error "File %s is not under version control" buffer-file-name))
2775 ;; Find the registered backends.
2776 (dolist (backend vc-handled-backends)
2777 (when (vc-call-backend backend 'registered buffer-file-name)
2778 (push backend backends)))
2779 ;; Find the next backend.
2780 (let ((def (car (delq backend
2781 (append (memq backend backends) backends))))
2782 (others (delete backend backends)))
2783 (cond
2784 ((null others) (error "No other backend to switch to"))
2785 (current-prefix-arg
2786 (intern
2787 (upcase
2788 (completing-read
2789 (format "Switch to backend [%s]: " def)
2790 (mapcar (lambda (b) (list (downcase (symbol-name b)))) backends)
2791 nil t nil nil (downcase (symbol-name def))))))
2792 (t def))))
2793 ;; Calling the `registered' method can mess up the file
2794 ;; properties, so we want to revert them to what they were.
2795 (if (and backend (delete backend backends))
2796 (vc-call-backend backend 'registered buffer-file-name))))))
2797 (unless (eq backend (vc-backend file))
2798 (vc-file-clearprops file)
2799 (vc-file-setprop file 'vc-backend backend)
2800 ;; Force recomputation of the state
2801 (unless (vc-call-backend backend 'registered file)
2802 (vc-file-clearprops file)
2803 (error "%s is not registered in %s" file backend))
2804 (vc-mode-line file)))
2805
2806 ;;;###autoload
2807 (defun vc-transfer-file (file new-backend)
2808 "Transfer FILE to another version control system NEW-BACKEND.
2809 If NEW-BACKEND has a higher precedence than FILE's current backend
2810 \(i.e. it comes earlier in `vc-handled-backends'), then register FILE in
2811 NEW-BACKEND, using the version number from the current backend as the
2812 base level. If NEW-BACKEND has a lower precedence than the current
2813 backend, then commit all changes that were made under the current
2814 backend to NEW-BACKEND, and unregister FILE from the current backend.
2815 \(If FILE is not yet registered under NEW-BACKEND, register it.)"
2816 (let* ((old-backend (vc-backend file))
2817 (edited (memq (vc-state file) '(edited needs-merge)))
2818 (registered (vc-call-backend new-backend 'registered file))
2819 (move
2820 (and registered ; Never move if not registered in new-backend yet.
2821 ;; move if new-backend comes later in vc-handled-backends
2822 (or (memq new-backend (memq old-backend vc-handled-backends))
2823 (y-or-n-p "Final transfer? "))))
2824 (comment nil))
2825 (if (eq old-backend new-backend)
2826 (error "%s is the current backend of %s" new-backend file))
2827 (if registered
2828 (set-file-modes file (logior (file-modes file) 128))
2829 ;; `registered' might have switched under us.
2830 (vc-switch-backend file old-backend)
2831 (let* ((rev (vc-workfile-version file))
2832 (modified-file (and edited (make-temp-file file)))
2833 (unmodified-file (and modified-file (vc-version-backup-file file))))
2834 ;; Go back to the base unmodified file.
2835 (unwind-protect
2836 (progn
2837 (when modified-file
2838 (copy-file file modified-file 'ok-if-already-exists)
2839 ;; If we have a local copy of the unmodified file, handle that
2840 ;; here and not in vc-revert-file because we don't want to
2841 ;; delete that copy -- it is still useful for OLD-BACKEND.
2842 (if unmodified-file
2843 (copy-file unmodified-file file
2844 'ok-if-already-exists 'keep-date)
2845 (if (y-or-n-p "Get base version from master? ")
2846 (vc-revert-file file))))
2847 (vc-call-backend new-backend 'receive-file file rev))
2848 (when modified-file
2849 (vc-switch-backend file new-backend)
2850 (unless (eq (vc-checkout-model file) 'implicit)
2851 (vc-checkout file t nil))
2852 (rename-file modified-file file 'ok-if-already-exists)
2853 (vc-file-setprop file 'vc-checkout-time nil)))))
2854 (when move
2855 (vc-switch-backend file old-backend)
2856 (setq comment (vc-call comment-history file))
2857 (vc-call unregister file))
2858 (vc-switch-backend file new-backend)
2859 (when (or move edited)
2860 (vc-file-setprop file 'vc-state 'edited)
2861 (vc-mode-line file)
2862 (vc-checkin file nil comment (stringp comment)))))
2863
2864 (defun vc-default-unregister (backend file)
2865 "Default implementation of `vc-unregister', signals an error."
2866 (error "Unregistering files is not supported for %s" backend))
2867
2868 (defun vc-default-receive-file (backend file rev)
2869 "Let BACKEND receive FILE from another version control system."
2870 (vc-call-backend backend 'register file rev ""))
2871
2872 (defun vc-rename-master (oldmaster newfile templates)
2873 "Rename OLDMASTER to be the master file for NEWFILE based on TEMPLATES."
2874 (let* ((dir (file-name-directory (expand-file-name oldmaster)))
2875 (newdir (or (file-name-directory newfile) ""))
2876 (newbase (file-name-nondirectory newfile))
2877 (masters
2878 ;; List of potential master files for `newfile'
2879 (mapcar
2880 (lambda (s) (vc-possible-master s newdir newbase))
2881 templates)))
2882 (if (or (file-symlink-p oldmaster)
2883 (file-symlink-p (file-name-directory oldmaster)))
2884 (error "This is unsafe in the presence of symbolic links"))
2885 (rename-file
2886 oldmaster
2887 (catch 'found
2888 ;; If possible, keep the master file in the same directory.
2889 (dolist (f masters)
2890 (if (and f (string= (file-name-directory (expand-file-name f)) dir))
2891 (throw 'found f)))
2892 ;; If not, just use the first possible place.
2893 (dolist (f masters)
2894 (and f (or (not (setq dir (file-name-directory f)))
2895 (file-directory-p dir))
2896 (throw 'found f)))
2897 (error "New file lacks a version control directory")))))
2898
2899 (defun vc-delete-file (file)
2900 "Delete file and mark it as such in the version control system."
2901 (interactive "fVC delete file: ")
2902 (let ((buf (get-file-buffer file))
2903 (backend (vc-backend file)))
2904 (unless backend
2905 (error "File %s is not under version control"
2906 (file-name-nondirectory file)))
2907 (unless (vc-find-backend-function backend 'delete-file)
2908 (error "Deleting files under %s is not supported in VC" backend))
2909 (if (and buf (buffer-modified-p buf))
2910 (error "Please save files before deleting them"))
2911 (unless (y-or-n-p (format "Really want to delete %s? "
2912 (file-name-nondirectory file)))
2913 (error "Abort!"))
2914 (unless (or (file-directory-p file) (null make-backup-files))
2915 (with-current-buffer (or buf (find-file-noselect file))
2916 (let ((backup-inhibited nil))
2917 (backup-buffer))))
2918 (vc-call delete-file file)
2919 ;; If the backend hasn't deleted the file itself, let's do it for him.
2920 (if (file-exists-p file) (delete-file file))))
2921
2922 (defun vc-default-rename-file (backend old new)
2923 (condition-case nil
2924 (add-name-to-file old new)
2925 (error (rename-file old new)))
2926 (vc-delete-file old)
2927 (with-current-buffer (find-file-noselect new)
2928 (vc-register)))
2929
2930 ;;;###autoload
2931 (defun vc-rename-file (old new)
2932 "Rename file OLD to NEW, and rename its master file likewise."
2933 (interactive "fVC rename file: \nFRename to: ")
2934 (let ((oldbuf (get-file-buffer old)))
2935 (if (and oldbuf (buffer-modified-p oldbuf))
2936 (error "Please save files before moving them"))
2937 (if (get-file-buffer new)
2938 (error "Already editing new file name"))
2939 (if (file-exists-p new)
2940 (error "New file already exists"))
2941 (let ((state (vc-state old)))
2942 (unless (memq state '(up-to-date edited))
2943 (error "Please %s files before moving them"
2944 (if (stringp state) "check in" "update"))))
2945 (vc-call rename-file old new)
2946 (vc-file-clearprops old)
2947 ;; Move the actual file (unless the backend did it already)
2948 (if (file-exists-p old) (rename-file old new))
2949 ;; ?? Renaming a file might change its contents due to keyword expansion.
2950 ;; We should really check out a new copy if the old copy was precisely equal
2951 ;; to some checked in version. However, testing for this is tricky....
2952 (if oldbuf
2953 (with-current-buffer oldbuf
2954 (let ((buffer-read-only buffer-read-only))
2955 (set-visited-file-name new))
2956 (vc-backend new)
2957 (vc-mode-line new)
2958 (set-buffer-modified-p nil)))))
2959
2960 ;;;###autoload
2961 (defun vc-update-change-log (&rest args)
2962 "Find change log file and add entries from recent version control logs.
2963 Normally, find log entries for all registered files in the default
2964 directory.
2965
2966 With prefix arg of \\[universal-argument], only find log entries for the current buffer's file.
2967
2968 With any numeric prefix arg, find log entries for all currently visited
2969 files that are under version control. This puts all the entries in the
2970 log for the default directory, which may not be appropriate.
2971
2972 From a program, any ARGS are assumed to be filenames for which
2973 log entries should be gathered."
2974 (interactive
2975 (cond ((consp current-prefix-arg) ;C-u
2976 (list buffer-file-name))
2977 (current-prefix-arg ;Numeric argument.
2978 (let ((files nil)
2979 (buffers (buffer-list))
2980 file)
2981 (while buffers
2982 (setq file (buffer-file-name (car buffers)))
2983 (and file (vc-backend file)
2984 (setq files (cons file files)))
2985 (setq buffers (cdr buffers)))
2986 files))
2987 (t
2988 ;; Don't supply any filenames to backend; this means
2989 ;; it should find all relevant files relative to
2990 ;; the default-directory.
2991 nil)))
2992 (dolist (file (or args (list default-directory)))
2993 (if (eq (string-match tramp-file-name-regexp file) 0)
2994 (error "Sorry, vc-update-change-log does not work over Tramp")))
2995 (vc-call-backend (vc-responsible-backend default-directory)
2996 'update-changelog args))
2997
2998 (defalias 'vc-cvs-update-changelog 'vc-update-changelog-rcs2log)
2999 (defalias 'vc-rcs-update-changelog 'vc-update-changelog-rcs2log)
3000 ;; FIXME: This should probably be moved to vc-rcs.el and replaced in
3001 ;; vc-cvs.el by code using cvs2cl.
3002 (defun vc-update-changelog-rcs2log (files)
3003 "Default implementation of update-changelog.
3004 Uses `rcs2log' which only works for RCS and CVS."
3005 ;; FIXME: We (c|sh)ould add support for cvs2cl
3006 (let ((odefault default-directory)
3007 (changelog (find-change-log))
3008 ;; Presumably not portable to non-Unixy systems, along with rcs2log:
3009 (tempfile (make-temp-file
3010 (expand-file-name "vc"
3011 (or small-temporary-file-directory
3012 temporary-file-directory))))
3013 (login-name (or user-login-name
3014 (format "uid%d" (number-to-string (user-uid)))))
3015 (full-name (or add-log-full-name
3016 (user-full-name)
3017 (user-login-name)
3018 (format "uid%d" (number-to-string (user-uid)))))
3019 (mailing-address (or add-log-mailing-address
3020 user-mail-address)))
3021 (find-file-other-window changelog)
3022 (barf-if-buffer-read-only)
3023 (vc-buffer-sync)
3024 (undo-boundary)
3025 (goto-char (point-min))
3026 (push-mark)
3027 (message "Computing change log entries...")
3028 (message "Computing change log entries... %s"
3029 (unwind-protect
3030 (progn
3031 (setq default-directory odefault)
3032 (if (eq 0 (apply 'call-process
3033 (expand-file-name "rcs2log"
3034 exec-directory)
3035 nil (list t tempfile) nil
3036 "-c" changelog
3037 "-u" (concat login-name
3038 "\t" full-name
3039 "\t" mailing-address)
3040 (mapcar
3041 (lambda (f)
3042 (file-relative-name
3043 (expand-file-name f odefault)))
3044 files)))
3045 "done"
3046 (pop-to-buffer (get-buffer-create "*vc*"))
3047 (erase-buffer)
3048 (insert-file-contents tempfile)
3049 "failed"))
3050 (setq default-directory (file-name-directory changelog))
3051 (delete-file tempfile)))))
3052
3053 ;; Annotate functionality
3054
3055 ;; Declare globally instead of additional parameter to
3056 ;; temp-buffer-show-function (not possible to pass more than one
3057 ;; parameter). The use of annotate-ratio is deprecated in favor of
3058 ;; annotate-mode, which replaces it with the more sensible "span-to
3059 ;; days", along with autoscaling support.
3060 (defvar vc-annotate-ratio nil "Global variable.")
3061
3062 ;; internal buffer-local variables
3063 (defvar vc-annotate-backend nil)
3064 (defvar vc-annotate-parent-file nil)
3065 (defvar vc-annotate-parent-rev nil)
3066 (defvar vc-annotate-parent-display-mode nil)
3067
3068 (defconst vc-annotate-font-lock-keywords
3069 ;; The fontification is done by vc-annotate-lines instead of font-lock.
3070 '((vc-annotate-lines)))
3071
3072 (define-derived-mode vc-annotate-mode fundamental-mode "Annotate"
3073 "Major mode for output buffers of the `vc-annotate' command.
3074
3075 You can use the mode-specific menu to alter the time-span of the used
3076 colors. See variable `vc-annotate-menu-elements' for customizing the
3077 menu items."
3078 (set (make-local-variable 'truncate-lines) t)
3079 (set (make-local-variable 'font-lock-defaults)
3080 '(vc-annotate-font-lock-keywords t))
3081 (view-mode 1))
3082
3083 (defun vc-annotate-display-default (ratio)
3084 "Display the output of \\[vc-annotate] using the default color range.
3085 The color range is given by `vc-annotate-color-map', scaled by RATIO.
3086 The current time is used as the offset."
3087 (interactive (progn (kill-local-variable 'vc-annotate-color-map) '(1.0)))
3088 (message "Redisplaying annotation...")
3089 (vc-annotate-display ratio)
3090 (message "Redisplaying annotation...done"))
3091
3092 (defun vc-annotate-oldest-in-map (color-map)
3093 "Return the oldest time in the COLOR-MAP."
3094 ;; Since entries should be sorted, we can just use the last one.
3095 (caar (last color-map)))
3096
3097 (defun vc-annotate-display-autoscale (&optional full)
3098 "Highlight the output of \\[vc-annotate] using an autoscaled color map.
3099 Autoscaling means that the map is scaled from the current time to the
3100 oldest annotation in the buffer, or, with prefix argument FULL, to
3101 cover the range from the oldest annotation to the newest."
3102 (interactive "P")
3103 (let ((newest 0.0)
3104 (oldest 999999.) ;Any CVS users at the founding of Rome?
3105 (current (vc-annotate-convert-time (current-time)))
3106 date)
3107 (message "Redisplaying annotation...")
3108 ;; Run through this file and find the oldest and newest dates annotated.
3109 (save-excursion
3110 (goto-char (point-min))
3111 (while (not (eobp))
3112 (when (setq date (vc-call-backend vc-annotate-backend 'annotate-time))
3113 (if (> date newest)
3114 (setq newest date))
3115 (if (< date oldest)
3116 (setq oldest date)))
3117 (forward-line 1)))
3118 (vc-annotate-display
3119 (/ (- (if full newest current) oldest)
3120 (vc-annotate-oldest-in-map vc-annotate-color-map))
3121 (if full newest))
3122 (message "Redisplaying annotation...done \(%s\)"
3123 (if full
3124 (format "Spanned from %.1f to %.1f days old"
3125 (- current oldest)
3126 (- current newest))
3127 (format "Spanned to %.1f days old" (- current oldest))))))
3128
3129 ;; Menu -- Using easymenu.el
3130 (easy-menu-define vc-annotate-mode-menu vc-annotate-mode-map
3131 "VC Annotate Display Menu"
3132 `("VC-Annotate"
3133 ["By Color Map Range" (unless (null vc-annotate-display-mode)
3134 (setq vc-annotate-display-mode nil)
3135 (vc-annotate-display-select))
3136 :style toggle :selected (null vc-annotate-display-mode)]
3137 ,@(let ((oldest-in-map (vc-annotate-oldest-in-map vc-annotate-color-map)))
3138 (mapcar (lambda (element)
3139 (let ((days (* element oldest-in-map)))
3140 `[,(format "Span %.1f days" days)
3141 (vc-annotate-display-select nil ,days)
3142 :style toggle :selected
3143 (eql vc-annotate-display-mode ,days) ]))
3144 vc-annotate-menu-elements))
3145 ["Span ..."
3146 (vc-annotate-display-select
3147 nil (float (string-to-number (read-string "Span how many days? "))))]
3148 "--"
3149 ["Span to Oldest"
3150 (unless (eq vc-annotate-display-mode 'scale)
3151 (vc-annotate-display-select nil 'scale))
3152 :style toggle :selected
3153 (eq vc-annotate-display-mode 'scale)]
3154 ["Span Oldest->Newest"
3155 (unless (eq vc-annotate-display-mode 'fullscale)
3156 (vc-annotate-display-select nil 'fullscale))
3157 :style toggle :selected
3158 (eq vc-annotate-display-mode 'fullscale)]
3159 "--"
3160 ["Annotate previous revision" vc-annotate-prev-version]
3161 ["Annotate next revision" vc-annotate-next-version]
3162 ["Annotate revision at line" vc-annotate-revision-at-line]
3163 ["Annotate revision previous to line" vc-annotate-revision-previous-to-line]
3164 ["Annotate latest revision" vc-annotate-workfile-version]
3165 ["Show log of revision at line" vc-annotate-show-log-revision-at-line]
3166 ["Show diff of revision at line" vc-annotate-show-diff-revision-at-line]))
3167
3168 (defun vc-annotate-display-select (&optional buffer mode)
3169 "Highlight the output of \\[vc-annotate].
3170 By default, the current buffer is highlighted, unless overridden by
3171 BUFFER. `vc-annotate-display-mode' specifies the highlighting mode to
3172 use; you may override this using the second optional arg MODE."
3173 (interactive)
3174 (if mode (setq vc-annotate-display-mode mode))
3175 (pop-to-buffer (or buffer (current-buffer)))
3176 (cond ((null vc-annotate-display-mode)
3177 ;; The ratio is global, thus relative to the global color-map.
3178 (kill-local-variable 'vc-annotate-color-map)
3179 (vc-annotate-display-default (or vc-annotate-ratio 1.0)))
3180 ;; One of the auto-scaling modes
3181 ((eq vc-annotate-display-mode 'scale)
3182 (vc-exec-after `(vc-annotate-display-autoscale)))
3183 ((eq vc-annotate-display-mode 'fullscale)
3184 (vc-exec-after `(vc-annotate-display-autoscale t)))
3185 ((numberp vc-annotate-display-mode) ; A fixed number of days lookback
3186 (vc-annotate-display-default
3187 (/ vc-annotate-display-mode
3188 (vc-annotate-oldest-in-map vc-annotate-color-map))))
3189 (t (error "No such display mode: %s"
3190 vc-annotate-display-mode))))
3191
3192 ;;;###autoload
3193 (defun vc-annotate (file rev &optional display-mode buf)
3194 "Display the edit history of the current file using colors.
3195
3196 This command creates a buffer that shows, for each line of the current
3197 file, when it was last edited and by whom. Additionally, colors are
3198 used to show the age of each line--blue means oldest, red means
3199 youngest, and intermediate colors indicate intermediate ages. By
3200 default, the time scale stretches back one year into the past;
3201 everything that is older than that is shown in blue.
3202
3203 With a prefix argument, this command asks two questions in the
3204 minibuffer. First, you may enter a version number; then the buffer
3205 displays and annotates that version instead of the current version
3206 \(type RET in the minibuffer to leave that default unchanged). Then,
3207 you are prompted for the time span in days which the color range
3208 should cover. For example, a time span of 20 days means that changes
3209 over the past 20 days are shown in red to blue, according to their
3210 age, and everything that is older than that is shown in blue.
3211
3212 Customization variables:
3213
3214 `vc-annotate-menu-elements' customizes the menu elements of the
3215 mode-specific menu. `vc-annotate-color-map' and
3216 `vc-annotate-very-old-color' defines the mapping of time to
3217 colors. `vc-annotate-background' specifies the background color."
3218 (interactive
3219 (save-current-buffer
3220 (vc-ensure-vc-buffer)
3221 (list buffer-file-name
3222 (let ((def (vc-workfile-version buffer-file-name)))
3223 (if (null current-prefix-arg) def
3224 (read-string
3225 (format "Annotate from version (default %s): " def)
3226 nil nil def)))
3227 (if (null current-prefix-arg)
3228 vc-annotate-display-mode
3229 (float (string-to-number
3230 (read-string "Annotate span days (default 20): "
3231 nil nil "20")))))))
3232 (vc-ensure-vc-buffer)
3233 (setq vc-annotate-display-mode display-mode) ;Not sure why. --Stef
3234 (let* ((temp-buffer-name (format "*Annotate %s (rev %s)*" (buffer-name) rev))
3235 (temp-buffer-show-function 'vc-annotate-display-select)
3236 ;; If BUF is specified, we presume the caller maintains current line,
3237 ;; so we don't need to do it here. This implementation may give
3238 ;; strange results occasionally in the case of REV != WORKFILE-REV.
3239 (current-line (unless buf (line-number-at-pos))))
3240 (message "Annotating...")
3241 ;; If BUF is specified it tells in which buffer we should put the
3242 ;; annotations. This is used when switching annotations to another
3243 ;; revision, so we should update the buffer's name.
3244 (if buf (with-current-buffer buf
3245 (rename-buffer temp-buffer-name t)
3246 ;; In case it had to be uniquified.
3247 (setq temp-buffer-name (buffer-name))))
3248 (with-output-to-temp-buffer temp-buffer-name
3249 (vc-call annotate-command file (get-buffer temp-buffer-name) rev)
3250 ;; we must setup the mode first, and then set our local
3251 ;; variables before the show-function is called at the exit of
3252 ;; with-output-to-temp-buffer
3253 (with-current-buffer temp-buffer-name
3254 (if (not (equal major-mode 'vc-annotate-mode))
3255 (vc-annotate-mode))
3256 (set (make-local-variable 'vc-annotate-backend) (vc-backend file))
3257 (set (make-local-variable 'vc-annotate-parent-file) file)
3258 (set (make-local-variable 'vc-annotate-parent-rev) rev)
3259 (set (make-local-variable 'vc-annotate-parent-display-mode)
3260 display-mode)))
3261
3262 (vc-exec-after
3263 `(progn
3264 (when ,current-line
3265 (goto-line ,current-line ,temp-buffer-name))
3266 (unless (active-minibuffer-window)
3267 (message "Annotating... done"))))))
3268
3269 (defun vc-annotate-prev-version (prefix)
3270 "Visit the annotation of the version previous to this one.
3271
3272 With a numeric prefix argument, annotate the version that many
3273 versions previous."
3274 (interactive "p")
3275 (vc-annotate-warp-version (- 0 prefix)))
3276
3277 (defun vc-annotate-next-version (prefix)
3278 "Visit the annotation of the version after this one.
3279
3280 With a numeric prefix argument, annotate the version that many
3281 versions after."
3282 (interactive "p")
3283 (vc-annotate-warp-version prefix))
3284
3285 (defun vc-annotate-workfile-version ()
3286 "Visit the annotation of the workfile version of this file."
3287 (interactive)
3288 (if (not (equal major-mode 'vc-annotate-mode))
3289 (message "Cannot be invoked outside of a vc annotate buffer")
3290 (let ((warp-rev (vc-workfile-version vc-annotate-parent-file)))
3291 (if (equal warp-rev vc-annotate-parent-rev)
3292 (message "Already at version %s" warp-rev)
3293 (vc-annotate-warp-version warp-rev)))))
3294
3295 (defun vc-annotate-extract-revision-at-line ()
3296 "Extract the revision number of the current line."
3297 ;; This function must be invoked from a buffer in vc-annotate-mode
3298 (vc-call-backend vc-annotate-backend 'annotate-extract-revision-at-line))
3299
3300 (defun vc-annotate-revision-at-line ()
3301 "Visit the annotation of the version identified in the current line."
3302 (interactive)
3303 (if (not (equal major-mode 'vc-annotate-mode))
3304 (message "Cannot be invoked outside of a vc annotate buffer")
3305 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
3306 (if (not rev-at-line)
3307 (message "Cannot extract revision number from the current line")
3308 (if (equal rev-at-line vc-annotate-parent-rev)
3309 (message "Already at version %s" rev-at-line)
3310 (vc-annotate-warp-version rev-at-line))))))
3311
3312 (defun vc-annotate-revision-previous-to-line ()
3313 "Visit the annotation of the version before the version at line."
3314 (interactive)
3315 (if (not (equal major-mode 'vc-annotate-mode))
3316 (message "Cannot be invoked outside of a vc annotate buffer")
3317 (let ((rev-at-line (vc-annotate-extract-revision-at-line))
3318 (prev-rev nil))
3319 (if (not rev-at-line)
3320 (message "Cannot extract revision number from the current line")
3321 (setq prev-rev
3322 (vc-call previous-version vc-annotate-parent-file rev-at-line))
3323 (vc-annotate-warp-version prev-rev)))))
3324
3325 (defun vc-annotate-show-log-revision-at-line ()
3326 "Visit the log of the version at line."
3327 (interactive)
3328 (if (not (equal major-mode 'vc-annotate-mode))
3329 (message "Cannot be invoked outside of a vc annotate buffer")
3330 (let ((rev-at-line (vc-annotate-extract-revision-at-line)))
3331 (if (not rev-at-line)
3332 (message "Cannot extract revision number from the current line")
3333 (vc-print-log rev-at-line)))))
3334
3335 (defun vc-annotate-show-diff-revision-at-line ()
3336 "Visit the diff of the version at line from its previous version."
3337 (interactive)
3338 (if (not (equal major-mode 'vc-annotate-mode))
3339 (message "Cannot be invoked outside of a vc annotate buffer")
3340 (let ((rev-at-line (vc-annotate-extract-revision-at-line))
3341 (prev-rev nil))
3342 (if (not rev-at-line)
3343 (message "Cannot extract revision number from the current line")
3344 (setq prev-rev
3345 (vc-call previous-version vc-annotate-parent-file rev-at-line))
3346 (if (not prev-rev)
3347 (message "Cannot diff from any version prior to %s" rev-at-line)
3348 (save-window-excursion
3349 (vc-version-diff vc-annotate-parent-file prev-rev rev-at-line))
3350 (switch-to-buffer "*vc-diff*"))))))
3351
3352 (defun vc-annotate-warp-version (revspec)
3353 "Annotate the version described by REVSPEC.
3354
3355 If REVSPEC is a positive integer, warp that many versions
3356 forward, if possible, otherwise echo a warning message. If
3357 REVSPEC is a negative integer, warp that many versions backward,
3358 if possible, otherwise echo a warning message. If REVSPEC is a
3359 string, then it describes a revision number, so warp to that
3360 revision."
3361 (if (not (equal major-mode 'vc-annotate-mode))
3362 (message "Cannot be invoked outside of a vc annotate buffer")
3363 (let* ((buf (current-buffer))
3364 (oldline (line-number-at-pos))
3365 (revspeccopy revspec)
3366 (newrev nil))
3367 (cond
3368 ((and (integerp revspec) (> revspec 0))
3369 (setq newrev vc-annotate-parent-rev)
3370 (while (and (> revspec 0) newrev)
3371 (setq newrev (vc-call next-version
3372 vc-annotate-parent-file newrev))
3373 (setq revspec (1- revspec)))
3374 (if (not newrev)
3375 (message "Cannot increment %d versions from version %s"
3376 revspeccopy vc-annotate-parent-rev)))
3377 ((and (integerp revspec) (< revspec 0))
3378 (setq newrev vc-annotate-parent-rev)
3379 (while (and (< revspec 0) newrev)
3380 (setq newrev (vc-call previous-version
3381 vc-annotate-parent-file newrev))
3382 (setq revspec (1+ revspec)))
3383 (if (not newrev)
3384 (message "Cannot decrement %d versions from version %s"
3385 (- 0 revspeccopy) vc-annotate-parent-rev)))
3386 ((stringp revspec) (setq newrev revspec))
3387 (t (error "Invalid argument to vc-annotate-warp-version")))
3388 (when newrev
3389 (vc-annotate vc-annotate-parent-file newrev
3390 vc-annotate-parent-display-mode
3391 buf)
3392 (goto-line (min oldline (progn (goto-char (point-max))
3393 (previous-line)
3394 (line-number-at-pos))) buf)))))
3395
3396 (defun vc-annotate-compcar (threshold a-list)
3397 "Test successive cons cells of A-LIST against THRESHOLD.
3398 Return the first cons cell with a car that is not less than THRESHOLD,
3399 nil if no such cell exists."
3400 (let ((i 1)
3401 (tmp-cons (car a-list)))
3402 (while (and tmp-cons (< (car tmp-cons) threshold))
3403 (setq tmp-cons (car (nthcdr i a-list)))
3404 (setq i (+ i 1)))
3405 tmp-cons)) ; Return the appropriate value
3406
3407 (defun vc-annotate-convert-time (time)
3408 "Convert a time value to a floating-point number of days.
3409 The argument TIME is a list as returned by `current-time' or
3410 `encode-time', only the first two elements of that list are considered."
3411 (/ (+ (* (float (car time)) (lsh 1 16)) (cadr time)) 24 3600))
3412
3413 (defun vc-annotate-difference (&optional offset)
3414 "Return the time span in days to the next annotation.
3415 This calls the backend function annotate-time, and returns the
3416 difference in days between the time returned and the current time,
3417 or OFFSET if present."
3418 (let ((next-time (vc-call-backend vc-annotate-backend 'annotate-time)))
3419 (if next-time
3420 (- (or offset
3421 (vc-call-backend vc-annotate-backend 'annotate-current-time))
3422 next-time))))
3423
3424 (defun vc-default-annotate-current-time (backend)
3425 "Return the current time, encoded as fractional days."
3426 (vc-annotate-convert-time (current-time)))
3427
3428 (defvar vc-annotate-offset nil)
3429
3430 (defun vc-annotate-display (ratio &optional offset)
3431 "Highlight `vc-annotate' output in the current buffer.
3432 RATIO, is the expansion that should be applied to `vc-annotate-color-map'.
3433 The annotations are relative to the current time, unless overridden by OFFSET."
3434 (if (/= ratio 1.0)
3435 (set (make-local-variable 'vc-annotate-color-map)
3436 (mapcar (lambda (elem) (cons (* (car elem) ratio) (cdr elem)))
3437 vc-annotate-color-map)))
3438 (set (make-local-variable 'vc-annotate-offset) offset)
3439 (font-lock-mode 1))
3440
3441 (defun vc-annotate-lines (limit)
3442 (while (< (point) limit)
3443 (let ((difference (vc-annotate-difference vc-annotate-offset))
3444 (start (point))
3445 (end (progn (forward-line 1) (point))))
3446 (when difference
3447 (let* ((color (or (vc-annotate-compcar difference vc-annotate-color-map)
3448 (cons nil vc-annotate-very-old-color)))
3449 ;; substring from index 1 to remove any leading `#' in the name
3450 (face-name (concat "vc-annotate-face-"
3451 (if (string-equal
3452 (substring (cdr color) 0 1) "#")
3453 (substring (cdr color) 1)
3454 (cdr color))))
3455 ;; Make the face if not done.
3456 (face (or (intern-soft face-name)
3457 (let ((tmp-face (make-face (intern face-name))))
3458 (set-face-foreground tmp-face (cdr color))
3459 (if vc-annotate-background
3460 (set-face-background tmp-face
3461 vc-annotate-background))
3462 tmp-face)))) ; Return the face
3463 (put-text-property start end 'face face)))))
3464 ;; Pretend to font-lock there were no matches.
3465 nil)
3466 \f
3467 ;; Collect back-end-dependent stuff here
3468
3469 (defalias 'vc-default-logentry-check 'ignore)
3470
3471 (defun vc-check-headers ()
3472 "Check if the current file has any headers in it."
3473 (interactive)
3474 (vc-call-backend (vc-backend buffer-file-name) 'check-headers))
3475
3476 (defun vc-default-check-headers (backend)
3477 "Default implementation of check-headers; always returns nil."
3478 nil)
3479
3480 ;; Back-end-dependent stuff ends here.
3481
3482 ;; Set up key bindings for use while editing log messages
3483
3484 (defun vc-log-edit (file)
3485 "Set up `log-edit' for use with VC on FILE."
3486 (setq default-directory
3487 (if file (file-name-directory file)
3488 (with-current-buffer vc-parent-buffer default-directory)))
3489 (log-edit 'vc-finish-logentry nil
3490 (if file `(lambda () ',(list (file-name-nondirectory file)))
3491 ;; If FILE is nil, we were called from vc-dired.
3492 (lambda ()
3493 (with-current-buffer vc-parent-buffer
3494 (dired-get-marked-files t)))))
3495 (set (make-local-variable 'vc-log-file) file)
3496 (make-local-variable 'vc-log-version)
3497 (set-buffer-modified-p nil)
3498 (setq buffer-file-name nil))
3499
3500 ;; These things should probably be generally available
3501
3502 (defun vc-file-tree-walk (dirname func &rest args)
3503 "Walk recursively through DIRNAME.
3504 Invoke FUNC f ARGS on each VC-managed file f underneath it."
3505 ;; FIXME: Kill this function.
3506 (vc-file-tree-walk-internal (expand-file-name dirname) func args)
3507 (message "Traversing directory %s...done" dirname))
3508
3509 (defun vc-file-tree-walk-internal (file func args)
3510 (if (not (file-directory-p file))
3511 (if (vc-backend file) (apply func file args))
3512 (message "Traversing directory %s..." (abbreviate-file-name file))
3513 (let ((dir (file-name-as-directory file)))
3514 (mapcar
3515 (lambda (f) (or
3516 (string-equal f ".")
3517 (string-equal f "..")
3518 (member f vc-directory-exclusion-list)
3519 (let ((dirf (expand-file-name f dir)))
3520 (or
3521 (file-symlink-p dirf) ;; Avoid possible loops.
3522 (vc-file-tree-walk-internal dirf func args)))))
3523 (directory-files dir)))))
3524
3525 (provide 'vc)
3526
3527 ;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE
3528 ;;
3529 ;; These may be useful to anyone who has to debug or extend the package.
3530 ;; (Note that this information corresponds to versions 5.x. Some of it
3531 ;; might have been invalidated by the additions to support branching
3532 ;; and RCS keyword lookup. AS, 1995/03/24)
3533 ;;
3534 ;; A fundamental problem in VC is that there are time windows between
3535 ;; vc-next-action's computations of the file's version-control state and
3536 ;; the actions that change it. This is a window open to lossage in a
3537 ;; multi-user environment; someone else could nip in and change the state
3538 ;; of the master during it.
3539 ;;
3540 ;; The performance problem is that rlog/prs calls are very expensive; we want
3541 ;; to avoid them as much as possible.
3542 ;;
3543 ;; ANALYSIS:
3544 ;;
3545 ;; The performance problem, it turns out, simplifies in practice to the
3546 ;; problem of making vc-state fast. The two other functions that call
3547 ;; prs/rlog will not be so commonly used that the slowdown is a problem; one
3548 ;; makes snapshots, the other deletes the calling user's last change in the
3549 ;; master.
3550 ;;
3551 ;; The race condition implies that we have to either (a) lock the master
3552 ;; during the entire execution of vc-next-action, or (b) detect and
3553 ;; recover from errors resulting from dispatch on an out-of-date state.
3554 ;;
3555 ;; Alternative (a) appears to be infeasible. The problem is that we can't
3556 ;; guarantee that the lock will ever be removed. Suppose a user starts a
3557 ;; checkin, the change message buffer pops up, and the user, having wandered
3558 ;; off to do something else, simply forgets about it?
3559 ;;
3560 ;; Alternative (b), on the other hand, works well with a cheap way to speed up
3561 ;; vc-state. Usually, if a file is registered, we can read its locked/
3562 ;; unlocked state and its current owner from its permissions.
3563 ;;
3564 ;; This shortcut will fail if someone has manually changed the workfile's
3565 ;; permissions; also if developers are munging the workfile in several
3566 ;; directories, with symlinks to a master (in this latter case, the
3567 ;; permissions shortcut will fail to detect a lock asserted from another
3568 ;; directory).
3569 ;;
3570 ;; Note that these cases correspond exactly to the errors which could happen
3571 ;; because of a competing checkin/checkout race in between two instances of
3572 ;; vc-next-action.
3573 ;;
3574 ;; For VC's purposes, a workfile/master pair may have the following states:
3575 ;;
3576 ;; A. Unregistered. There is a workfile, there is no master.
3577 ;;
3578 ;; B. Registered and not locked by anyone.
3579 ;;
3580 ;; C. Locked by calling user and unchanged.
3581 ;;
3582 ;; D. Locked by the calling user and changed.
3583 ;;
3584 ;; E. Locked by someone other than the calling user.
3585 ;;
3586 ;; This makes for 25 states and 20 error conditions. Here's the matrix:
3587 ;;
3588 ;; VC's idea of state
3589 ;; |
3590 ;; V Actual state RCS action SCCS action Effect
3591 ;; A B C D E
3592 ;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin
3593 ;; B 5 . 6 7 8 co -l get -e checkout
3594 ;; C 9 10 . 11 12 co -u unget; get revert
3595 ;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin
3596 ;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock
3597 ;;
3598 ;; All commands take the master file name as a last argument (not shown).
3599 ;;
3600 ;; In the discussion below, a "self-race" is a pathological situation in
3601 ;; which VC operations are being attempted simultaneously by two or more
3602 ;; Emacsen running under the same username.
3603 ;;
3604 ;; The vc-next-action code has the following windows:
3605 ;;
3606 ;; Window P:
3607 ;; Between the check for existence of a master file and the call to
3608 ;; admin/checkin in vc-buffer-admin (apparent state A). This window may
3609 ;; never close if the initial-comment feature is on.
3610 ;;
3611 ;; Window Q:
3612 ;; Between the call to vc-workfile-unchanged-p in and the immediately
3613 ;; following revert (apparent state C).
3614 ;;
3615 ;; Window R:
3616 ;; Between the call to vc-workfile-unchanged-p in and the following
3617 ;; checkin (apparent state D). This window may never close.
3618 ;;
3619 ;; Window S:
3620 ;; Between the unlock and the immediately following checkout during a
3621 ;; revert operation (apparent state C). Included in window Q.
3622 ;;
3623 ;; Window T:
3624 ;; Between vc-state and the following checkout (apparent state B).
3625 ;;
3626 ;; Window U:
3627 ;; Between vc-state and the following revert (apparent state C).
3628 ;; Includes windows Q and S.
3629 ;;
3630 ;; Window V:
3631 ;; Between vc-state and the following checkin (apparent state
3632 ;; D). This window may never be closed if the user fails to complete the
3633 ;; checkin message. Includes window R.
3634 ;;
3635 ;; Window W:
3636 ;; Between vc-state and the following steal-lock (apparent
3637 ;; state E). This window may never close if the user fails to complete
3638 ;; the steal-lock message. Includes window X.
3639 ;;
3640 ;; Window X:
3641 ;; Between the unlock and the immediately following re-lock during a
3642 ;; steal-lock operation (apparent state E). This window may never close
3643 ;; if the user fails to complete the steal-lock message.
3644 ;;
3645 ;; Errors:
3646 ;;
3647 ;; Apparent state A ---
3648 ;;
3649 ;; 1. File looked unregistered but is actually registered and not locked.
3650 ;;
3651 ;; Potential cause: someone else's admin during window P, with
3652 ;; caller's admin happening before their checkout.
3653 ;;
3654 ;; RCS: Prior to version 5.6.4, ci fails with message
3655 ;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new
3656 ;; ci -i option and the message is "<file>,v: already exists".
3657 ;; SCCS: admin will fail with error (ad19).
3658 ;;
3659 ;; We can let these errors be passed up to the user.
3660 ;;
3661 ;; 2. File looked unregistered but is actually locked by caller, unchanged.
3662 ;;
3663 ;; Potential cause: self-race during window P.
3664 ;;
3665 ;; RCS: Prior to version 5.6.4, reverts the file to the last saved
3666 ;; version and unlocks it. From 5.6.4 onwards, VC uses the new
3667 ;; ci -i option, failing with message "<file>,v: already exists".
3668 ;; SCCS: will fail with error (ad19).
3669 ;;
3670 ;; Either of these consequences is acceptable.
3671 ;;
3672 ;; 3. File looked unregistered but is actually locked by caller, changed.
3673 ;;
3674 ;; Potential cause: self-race during window P.
3675 ;;
3676 ;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as
3677 ;; a delta with a null change comment (the -t- switch will be
3678 ;; ignored). From 5.6.4 onwards, VC uses the new ci -i option,
3679 ;; failing with message "<file>,v: already exists".
3680 ;; SCCS: will fail with error (ad19).
3681 ;;
3682 ;; 4. File looked unregistered but is locked by someone else.
3683 ;;;
3684 ;; Potential cause: someone else's admin during window P, with
3685 ;; caller's admin happening *after* their checkout.
3686 ;;
3687 ;; RCS: Prior to version 5.6.4, ci fails with a
3688 ;; "no lock set by <user>" message. From 5.6.4 onwards,
3689 ;; VC uses the new ci -i option, failing with message
3690 ;; "<file>,v: already exists".
3691 ;; SCCS: will fail with error (ad19).
3692 ;;
3693 ;; We can let these errors be passed up to the user.
3694 ;;
3695 ;; Apparent state B ---
3696 ;;
3697 ;; 5. File looked registered and not locked, but is actually unregistered.
3698 ;;
3699 ;; Potential cause: master file got nuked during window P.
3700 ;;
3701 ;; RCS: will fail with "RCS/<file>: No such file or directory"
3702 ;; SCCS: will fail with error ut4.
3703 ;;
3704 ;; We can let these errors be passed up to the user.
3705 ;;
3706 ;; 6. File looked registered and not locked, but is actually locked by the
3707 ;; calling user and unchanged.
3708 ;;
3709 ;; Potential cause: self-race during window T.
3710 ;;
3711 ;; RCS: in the same directory as the previous workfile, co -l will fail
3712 ;; with "co error: writable foo exists; checkout aborted". In any other
3713 ;; directory, checkout will succeed.
3714 ;; SCCS: will fail with ge17.
3715 ;;
3716 ;; Either of these consequences is acceptable.
3717 ;;
3718 ;; 7. File looked registered and not locked, but is actually locked by the
3719 ;; calling user and changed.
3720 ;;
3721 ;; As case 6.
3722 ;;
3723 ;; 8. File looked registered and not locked, but is actually locked by another
3724 ;; user.
3725 ;;
3726 ;; Potential cause: someone else checks it out during window T.
3727 ;;
3728 ;; RCS: co error: revision 1.3 already locked by <user>
3729 ;; SCCS: fails with ge4 (in directory) or ut7 (outside it).
3730 ;;
3731 ;; We can let these errors be passed up to the user.
3732 ;;
3733 ;; Apparent state C ---
3734 ;;
3735 ;; 9. File looks locked by calling user and unchanged, but is unregistered.
3736 ;;
3737 ;; As case 5.
3738 ;;
3739 ;; 10. File looks locked by calling user and unchanged, but is actually not
3740 ;; locked.
3741 ;;
3742 ;; Potential cause: a self-race in window U, or by the revert's
3743 ;; landing during window X of some other user's steal-lock or window S
3744 ;; of another user's revert.
3745 ;;
3746 ;; RCS: succeeds, refreshing the file from the identical version in
3747 ;; the master.
3748 ;; SCCS: fails with error ut4 (p file nonexistent).
3749 ;;
3750 ;; Either of these consequences is acceptable.
3751 ;;
3752 ;; 11. File is locked by calling user. It looks unchanged, but is actually
3753 ;; changed.
3754 ;;
3755 ;; Potential cause: the file would have to be touched by a self-race
3756 ;; during window Q.
3757 ;;
3758 ;; The revert will succeed, removing whatever changes came with
3759 ;; the touch. It is theoretically possible that work could be lost.
3760 ;;
3761 ;; 12. File looks like it's locked by the calling user and unchanged, but
3762 ;; it's actually locked by someone else.
3763 ;;
3764 ;; Potential cause: a steal-lock in window V.
3765 ;;
3766 ;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u
3767 ;; SCCS: fails with error un2
3768 ;;
3769 ;; We can pass these errors up to the user.
3770 ;;
3771 ;; Apparent state D ---
3772 ;;
3773 ;; 13. File looks like it's locked by the calling user and changed, but it's
3774 ;; actually unregistered.
3775 ;;
3776 ;; Potential cause: master file got nuked during window P.
3777 ;;
3778 ;; RCS: Prior to version 5.6.4, checks in the user's version as an
3779 ;; initial delta. From 5.6.4 onwards, VC uses the new ci -j
3780 ;; option, failing with message "no such file or directory".
3781 ;; SCCS: will fail with error ut4.
3782 ;;
3783 ;; This case is kind of nasty. Under RCS prior to version 5.6.4,
3784 ;; VC may fail to detect the loss of previous version information.
3785 ;;
3786 ;; 14. File looks like it's locked by the calling user and changed, but it's
3787 ;; actually unlocked.
3788 ;;
3789 ;; Potential cause: self-race in window V, or the checkin happening
3790 ;; during the window X of someone else's steal-lock or window S of
3791 ;; someone else's revert.
3792 ;;
3793 ;; RCS: ci will fail with "no lock set by <user>".
3794 ;; SCCS: delta will fail with error ut4.
3795 ;;
3796 ;; 15. File looks like it's locked by the calling user and changed, but it's
3797 ;; actually locked by the calling user and unchanged.
3798 ;;
3799 ;; Potential cause: another self-race --- a whole checkin/checkout
3800 ;; sequence by the calling user would have to land in window R.
3801 ;;
3802 ;; SCCS: checks in a redundant delta and leaves the file unlocked as usual.
3803 ;; RCS: reverts to the file state as of the second user's checkin, leaving
3804 ;; the file unlocked.
3805 ;;
3806 ;; It is theoretically possible that work could be lost under RCS.
3807 ;;
3808 ;; 16. File looks like it's locked by the calling user and changed, but it's
3809 ;; actually locked by a different user.
3810 ;;
3811 ;; RCS: ci error: no lock set by <user>
3812 ;; SCCS: unget will fail with error un2
3813 ;;
3814 ;; We can pass these errors up to the user.
3815 ;;
3816 ;; Apparent state E ---
3817 ;;
3818 ;; 17. File looks like it's locked by some other user, but it's actually
3819 ;; unregistered.
3820 ;;
3821 ;; As case 13.
3822 ;;
3823 ;; 18. File looks like it's locked by some other user, but it's actually
3824 ;; unlocked.
3825 ;;
3826 ;; Potential cause: someone released a lock during window W.
3827 ;;
3828 ;; RCS: The calling user will get the lock on the file.
3829 ;; SCCS: unget -n will fail with cm4.
3830 ;;
3831 ;; Either of these consequences will be OK.
3832 ;;
3833 ;; 19. File looks like it's locked by some other user, but it's actually
3834 ;; locked by the calling user and unchanged.
3835 ;;
3836 ;; Potential cause: the other user relinquishing a lock followed by
3837 ;; a self-race, both in window W.
3838 ;;
3839 ;; Under both RCS and SCCS, both unlock and lock will succeed, making
3840 ;; the sequence a no-op.
3841 ;;
3842 ;; 20. File looks like it's locked by some other user, but it's actually
3843 ;; locked by the calling user and changed.
3844 ;;
3845 ;; As case 19.
3846 ;;
3847 ;; PROBLEM CASES:
3848 ;;
3849 ;; In order of decreasing severity:
3850 ;;
3851 ;; Cases 11 and 15 are the only ones that potentially lose work.
3852 ;; They would require a self-race for this to happen.
3853 ;;
3854 ;; Case 13 in RCS loses information about previous deltas, retaining
3855 ;; only the information in the current workfile. This can only happen
3856 ;; if the master file gets nuked in window P.
3857 ;;
3858 ;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with
3859 ;; no change comment in the master. This would require a self-race in
3860 ;; window P or R respectively.
3861 ;;
3862 ;; Cases 2, 10, 19 and 20 do extra work, but make no changes.
3863 ;;
3864 ;; Unfortunately, it appears to me that no recovery is possible in these
3865 ;; cases. They don't yield error messages, so there's no way to tell that
3866 ;; a race condition has occurred.
3867 ;;
3868 ;; All other cases don't change either the workfile or the master, and
3869 ;; trigger command errors which the user will see.
3870 ;;
3871 ;; Thus, there is no explicit recovery code.
3872
3873 ;; arch-tag: ca82c1de-3091-4e26-af92-460abc6213a6
3874 ;;; vc.el ends here