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