vc.el 145 KB
Newer Older
1
;;; vc.el --- drive a version-control system from within Emacs
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3 4
;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998, 2000,
;;   2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
5

6 7
;; Author:     FSF (see below for full credits)
;; Maintainer: Andre Spiegel <spiegel@gnu.org>
Gerd Moellmann's avatar
Gerd Moellmann committed
8
;; Keywords: tools
Eric S. Raymond's avatar
Eric S. Raymond committed
9

10
;; $Id$
11

Eric S. Raymond's avatar
Eric S. Raymond committed
12 13 14 15 16 17 18 19 20 21 22 23 24
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
26 27
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Eric S. Raymond's avatar
Eric S. Raymond committed
28

29 30 31 32 33 34 35 36 37
;;; Credits:

;; VC was initially designed and implemented by Eric S. Raymond
;; <esr@snark.thyrsus.com>.  Over the years, many people have
;; contributed substantial amounts of work to VC.  These include:
;;   Per Cederqvist <ceder@lysator.liu.se>
;;   Paul Eggert <eggert@twinsun.com>
;;   Sebastian Kremer <sk@thp.uni-koeln.de>
;;   Martin Lorentzson <martinl@gnu.org>
Dave Love's avatar
Dave Love committed
38
;;   Dave Love <fx@gnu.org>
39
;;   Stefan Monnier <monnier@cs.yale.edu>
André Spiegel's avatar
André Spiegel committed
40
;;   J.D. Smith <jdsmith@alum.mit.edu>
41 42
;;   Andre Spiegel <spiegel@gnu.org>
;;   Richard Stallman <rms@gnu.org>
André Spiegel's avatar
André Spiegel committed
43
;;   Thien-Thi Nguyen <ttn@gnu.org>
44

Eric S. Raymond's avatar
Eric S. Raymond committed
45 46
;;; Commentary:

47 48
;; This mode is fully documented in the Emacs user's manual.
;;
49 50
;; Supported version-control systems presently include CVS, RCS, GNU Arch,
;; Subversion, Meta-CVS, and SCCS (or its free replacement, CSSC).
51 52 53
;;
;; Some features will not work with old RCS versions.  Where
;; 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 57
;; Even initial checkins will fail if your RCS version is so old that ci
;; doesn't understand -t-; this has been known to happen to people running
58
;; NExTSTEP 3.0.
Eric S. Raymond's avatar
Eric S. Raymond committed
59
;;
60
;; You can support the RCS -x option by customizing vc-rcs-master-templates.
Eric S. Raymond's avatar
Eric S. Raymond committed
61 62 63 64
;;
;; Proper function of the SCCS diff commands requires the shellscript vcdiff
;; to be installed somewhere on Emacs's path for executables.
;;
65
;; If your site uses the ChangeLog convention supported by Emacs, the
66 67 68
;; function log-edit-comment-to-change-log could prove a useful checkin hook,
;; although you might prefer to use C-c C-a (i.e. log-edit-insert-changelog)
;; from the commit buffer instead or to set `log-edit-setup-invert'.
69
;;
Eric S. Raymond's avatar
Eric S. Raymond committed
70 71
;; The vc code maintains some internal state in order to reduce expensive
;; version-control operations to a minimum.  Some names are only computed
72
;; once.  If you perform version control operations with the backend while
Eric S. Raymond's avatar
Eric S. Raymond committed
73 74 75 76 77
;; vc's back is turned, or move/rename master files while vc is running,
;; vc may get seriously confused.  Don't do these things!
;;
;; Developer's notes on some concurrency issues are included at the end of
;; the file.
78
;;
79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
;; ADDING SUPPORT FOR OTHER BACKENDS
;;
;; VC can use arbitrary version control systems as a backend.  To add
;; support for a new backend named SYS, write a library vc-sys.el that
;; contains functions of the form `vc-sys-...' (note that SYS is in lower
;; case for the function and library names).  VC will use that library if
;; you put the symbol SYS somewhere into the list of
;; `vc-handled-backends'.  Then, for example, if `vc-sys-registered'
;; returns non-nil for a file, all SYS-specific versions of VC commands
;; will be available for that file.
;;
;; VC keeps some per-file information in the form of properties (see
;; vc-file-set/getprop in vc-hooks.el).  The backend-specific functions
;; do not generally need to be aware of these properties.  For example,
;; `vc-sys-workfile-version' should compute the workfile version and
;; return it; it should not look it up in the property, and it needn't
;; store it there either.  However, if a backend-specific function does
;; 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 99 100 101 102 103 104 105
;; the macro `with-vc-properties' in vc.el).
;;
;; In the list of functions below, each identifier needs to be prepended
;; with `vc-sys-'.  Some of the functions are mandatory (marked with a
;; `*'), others are optional (`-').
;;
;; STATE-QUERYING FUNCTIONS
;;
106
;; * registered (file)
107 108 109
;;
;;   Return non-nil if FILE is registered in this backend.
;;
110
;; * state (file)
111 112 113 114 115 116 117
;;
;;   Return the current version control state of FILE.  For a list of
;;   possible values, see `vc-state'.  This function should do a full and
;;   reliable state computation; it is usually called immediately after
;;   C-x v v.  If you want to use a faster heuristic when visiting a
;;   file, put that into `state-heuristic' below.
;;
118
;; - state-heuristic (file)
119 120 121 122 123 124
;;
;;   If provided, this function is used to estimate the version control
;;   state of FILE at visiting time.  It should be considerably faster
;;   than the implementation of `state'.  For a list of possible values,
;;   see the doc string of `vc-state'.
;;
125
;; - dir-state (dir)
126 127 128 129 130 131
;;
;;   If provided, this function is used to find the version control state
;;   of all files in DIR in a fast way.  The function should not return
;;   anything, but rather store the files' states into the corresponding
;;   `vc-state' properties.
;;
132
;; * workfile-version (file)
133 134 135 136 137 138 139 140 141 142
;;
;;   Return the current workfile version of FILE.
;;
;; - latest-on-branch-p (file)
;;
;;   Return non-nil if the current workfile version of FILE is the latest
;;   on its branch.  The default implementation always returns t, which
;;   means that working with non-current versions is not supported by
;;   default.
;;
143
;; * checkout-model (file)
144 145 146 147
;;
;;   Indicate whether FILE needs to be "checked out" before it can be
;;   edited.  See `vc-checkout-model' for a list of possible values.
;;
148
;; - workfile-unchanged-p (file)
149 150 151 152 153 154
;;
;;   Return non-nil if FILE is unchanged from its current workfile
;;   version.  This function should do a brief comparison of FILE's
;;   contents with those of the master version.  If the backend does not
;;   have such a brief-comparison feature, the default implementation of
;;   this function can be used, which delegates to a full
155
;;   vc-BACKEND-diff.  (Note that vc-BACKEND-diff must not run
156
;;   asynchronously in this case, see variable `vc-disable-async-diff'.)
157
;;
158
;; - mode-line-string (file)
159 160 161 162 163
;;
;;   If provided, this function should return the VC-specific mode line
;;   string for FILE.  The default implementation deals well with all
;;   states that `vc-state' can return.
;;
164
;; - dired-state-info (file)
165 166 167 168 169 170 171 172 173 174 175
;;
;;   Translate the `vc-state' property of FILE into a string that can be
;;   used in a vc-dired buffer.  The default implementation deals well
;;   with all states that `vc-state' can return.
;;
;; STATE-CHANGING FUNCTIONS
;;
;; * register (file &optional rev comment)
;;
;;   Register FILE in this backend.  Optionally, an initial revision REV
;;   and an initial description of the file, COMMENT, may be specified.
176 177
;;   The implementation should pass the value of vc-register-switches
;;   to the backend command.
178
;;
179 180 181 182 183 184
;; - init-version (file)
;;
;;   The initial version to use when registering FILE if one is not
;;   specified by the user.  If not provided, the variable
;;   vc-default-init-version is used instead.
;;
185
;; - responsible-p (file)
186 187 188 189 190 191 192
;;
;;   Return non-nil if this backend considers itself "responsible" for
;;   FILE, which can also be a directory.  This function is used to find
;;   out what backend to use for registration of new files and for things
;;   like change log generation.  The default implementation always
;;   returns nil.
;;
193
;; - could-register (file)
194 195 196 197
;;
;;   Return non-nil if FILE could be registered under this backend.  The
;;   default implementation always returns t.
;;
198
;; - receive-file (file rev)
199 200 201 202 203 204 205 206 207 208 209 210
;;
;;   Let this backend "receive" a file that is already registered under
;;   another backend.  The default implementation simply calls `register'
;;   for FILE, but it can be overridden to do something more specific,
;;   e.g. keep revision numbers consistent or choose editing modes for
;;   FILE that resemble those of the other backend.
;;
;; - unregister (file)
;;
;;   Unregister FILE from this backend.  This is only needed if this
;;   backend may be used as a "more local" backend for temporary editing.
;;
211
;; * checkin (file rev comment)
212 213 214
;;
;;   Commit changes in FILE to this backend.  If REV is non-nil, that
;;   should become the new revision number.  COMMENT is used as a
215 216
;;   check-in comment.  The implementation should pass the value of
;;   vc-checkin-switches to the backend command.
217
;;
218 219 220 221 222 223 224 225
;; * find-version (file rev buffer)
;;
;;   Fetch revision REV of file FILE and put it into BUFFER.
;;   If REV is the empty string, fetch the head of the trunk.
;;   The implementation should pass the value of vc-checkout-switches
;;   to the backend command.
;;
;; * checkout (file &optional editable rev)
226 227 228 229
;;
;;   Check out revision REV of FILE into the working area.  If EDITABLE
;;   is non-nil, FILE should be writable by the user and if locking is
;;   used for FILE, a lock should also be set.  If REV is non-nil, that
230 231 232 233
;;   is the revision to check out (default is current workfile version).
;;   If REV is t, that means to check out the head of the current branch;
;;   if it is the empty string, check out the head of the trunk.
;;   The implementation should pass the value of vc-checkout-switches
234
;;   to the backend command.
235
;;
236
;; * revert (file &optional contents-done)
237
;;
238 239 240 241
;;   Revert FILE back to the current workfile version.  If optional
;;   arg CONTENTS-DONE is non-nil, then the contents of FILE have
;;   already been reverted from a version backup, and this function
;;   only needs to update the status of FILE within the backend.
242 243 244 245 246 247 248 249 250
;;
;; - cancel-version (file editable)
;;
;;   Cancel the current workfile version of FILE, i.e. remove it from the
;;   master.  EDITABLE non-nil means that FILE should be writable
;;   afterwards, and if locking is used for FILE, then a lock should also
;;   be set.  If this function is not provided, trying to cancel a
;;   version is caught as an error.
;;
251
;; - merge (file rev1 rev2)
252 253 254
;;
;;   Merge the changes between REV1 and REV2 into the current working file.
;;
255
;; - merge-news (file)
256 257 258
;;
;;   Merge recent changes from the current branch into FILE.
;;
259
;; - steal-lock (file &optional version)
260 261 262 263 264 265 266 267
;;
;;   Steal any lock on the current workfile version of FILE, or on
;;   VERSION if that is provided.  This function is only needed if
;;   locking is used for files under this backend, and if files can
;;   indeed be locked by other users.
;;
;; HISTORY FUNCTIONS
;;
268
;; * print-log (file &optional buffer)
269
;;
270 271
;;   Insert the revision log of FILE into BUFFER, or the *vc* buffer
;;   if BUFFER is nil.
272
;;
273
;; - show-log-entry (version)
274 275 276 277 278
;;
;;   If provided, search the log entry for VERSION in the current buffer,
;;   and make sure it is displayed in the buffer's window.  The default
;;   implementation of this function works for RCS-style logs.
;;
279
;; - wash-log (file)
280 281 282 283
;;
;;   Remove all non-comment information from the output of print-log.  The
;;   default implementation of this function works for RCS-style logs.
;;
284
;; - logentry-check ()
285 286 287 288 289 290
;;
;;   If defined, this function is run to find out whether the user
;;   entered a valid log entry for check-in.  The log entry is in the
;;   current buffer, and if it is not a valid one, the function should
;;   throw an error.
;;
291
;; - comment-history (file)
292 293 294 295 296 297 298
;;
;;   Return a string containing all log entries that were made for FILE.
;;   This is used for transferring a file from one backend to another,
;;   retaining comment information.  The default implementation of this
;;   function does this by calling print-log and then wash-log, and
;;   returning the resulting buffer contents as a string.
;;
299
;; - update-changelog (files)
300 301 302 303 304 305
;;
;;   Using recent log entries, create ChangeLog entries for FILES, or for
;;   all files at or below the default-directory if FILES is nil.  The
;;   default implementation runs rcs2log, which handles RCS- and
;;   CVS-style logs.
;;
306
;; * diff (file &optional rev1 rev2 buffer)
307
;;
308 309 310 311 312 313 314 315 316
;;   Insert the diff for FILE into BUFFER, or the *vc-diff* buffer if
;;   BUFFER is nil.  If REV1 and REV2 are non-nil, report differences
;;   from REV1 to REV2.  If REV1 is nil, use the current workfile
;;   version (as found in the repository) as the older version; if
;;   REV2 is nil, use the current workfile contents as the newer
;;   version.  This function should pass the value of (vc-switches
;;   BACKEND 'diff) to the backend command.  It should return a status
;;   of either 0 (no differences found), or 1 (either non-empty diff
;;   or the diff is run asynchronously).
317
;;
318
;; - diff-tree (dir &optional rev1 rev2)
319 320
;;
;;   Insert the diff for all files at and below DIR into the *vc-diff*
321
;;   buffer.  The meaning of REV1 and REV2 is the same as for
322 323 324
;;   vc-BACKEND-diff.  The default implementation does an explicit tree
;;   walk, calling vc-BACKEND-diff for each individual file.
;;
325
;; - annotate-command (file buf &optional rev)
326
;;
327 328 329 330 331
;;   If this function is provided, it should produce an annotated display
;;   of FILE in BUF, relative to version REV.  Annotation means each line
;;   of FILE displayed is prefixed with version information associated with
;;   its addition (deleted lines leave no history) and that the text of the
;;   file is fontified according to age.
332
;;
333
;; - annotate-time ()
334 335
;;
;;   Only required if `annotate-command' is defined for the backend.
336 337 338 339
;;   Return the time of the next line of annotation at or after point,
;;   as a floating point fractional number of days.  The helper
;;   function `vc-annotate-convert-time' may be useful for converting
;;   multi-part times as returned by `current-time' and `encode-time'
Pavel Janík's avatar
Pavel Janík committed
340
;;   to this format.  Return nil if no more lines of annotation appear
341 342 343
;;   in the buffer.  You can safely assume that point is placed at the
;;   beginning of each line, starting at `point-min'.  The buffer that
;;   point is placed in is the Annotate output, as defined by the
344 345
;;   relevant backend.  This function also affects how much of the line
;;   is fontified; where it leaves point is where fontification begins.
346 347 348 349 350 351 352 353
;;
;; - annotate-current-time ()
;;
;;   Only required if `annotate-command' is defined for the backend,
;;   AND you'd like the current time considered to be anything besides
;;   (vs-annotate-convert-time (current-time)) -- i.e. the current
;;   time with hours, minutes, and seconds included.  Probably safe to
;;   ignore.  Return the current-time, in units of fractional days.
354
;;
355 356 357 358 359 360 361
;; - annotate-extract-revision-at-line ()
;;
;;   Only required if `annotate-command' is defined for the backend.
;;   Invoked from a buffer in vc-annotate-mode, return the revision
;;   corresponding to the current line, or nil if there is no revision
;;   corresponding to the current line.
;;
362 363
;; SNAPSHOT SYSTEM
;;
364
;; - create-snapshot (dir name branchp)
365 366 367 368 369 370 371 372 373 374 375 376 377 378
;;
;;   Take a snapshot of the current state of files under DIR and name it
;;   NAME.  This should make sure that files are up-to-date before
;;   proceeding with the action.  DIR can also be a file and if BRANCHP
;;   is specified, NAME should be created as a branch and DIR should be
;;   checked out under this new branch.  The default implementation does
;;   not support branches but does a sanity check, a tree traversal and
;;   for each file calls `assign-name'.
;;
;; - assign-name (file name)
;;
;;   Give name NAME to the current version of FILE, assuming it is
;;   up-to-date.  Only used by the default version of `create-snapshot'.
;;
379
;; - retrieve-snapshot (dir name update)
380 381 382 383 384 385 386 387 388 389
;;
;;   Retrieve a named snapshot of all registered files at or below DIR.
;;   If UPDATE is non-nil, then update buffers of any files in the
;;   snapshot that are currently visited.  The default implementation
;;   does a sanity check whether there aren't any uncommitted changes at
;;   or below DIR, and then performs a tree walk, using the `checkout'
;;   function to retrieve the corresponding versions.
;;
;; MISCELLANEOUS
;;
390
;; - make-version-backups-p (file)
391 392 393 394 395 396
;;
;;   Return non-nil if unmodified repository versions of FILE should be
;;   backed up locally.  If this is done, VC can perform `diff' and
;;   `revert' operations itself, without calling the backend system.  The
;;   default implementation always returns nil.
;;
397 398 399 400
;; - repository-hostname (dirname)
;;
;;   Return the hostname that the backend will have to contact
;;   in order to operate on a file in DIRNAME.  If the return value
401
;;   is nil, it means that the repository is local.
402 403 404
;;   This function is used in `vc-stay-local-p' which backends can use
;;   for their convenience.
;;
405 406
;; - previous-version (file rev)
;;
407 408 409 410 411 412 413
;;   Return the version number that precedes REV for FILE, or nil if no such
;;   version exists.
;;
;; - next-version (file rev)
;;
;;   Return the version number that follows REV for FILE, or nil if no such
;;   version exists.
414
;;
415
;; - check-headers ()
416 417 418
;;
;;   Return non-nil if the current buffer contains any version headers.
;;
419
;; - clear-headers ()
420 421 422 423 424 425 426 427
;;
;;   In the current buffer, reset all version headers to their unexpanded
;;   form.  This function should be provided if the state-querying code
;;   for this backend uses the version headers to determine the state of
;;   a file.  This function will then be called whenever VC changes the
;;   version control state in such a way that the headers would give
;;   wrong information.
;;
428 429 430 431 432 433
;; - delete-file (file)
;;
;;   Delete FILE and mark it as deleted in the repository.  If this
;;   function is not provided, the command `vc-delete-file' will
;;   signal an error.
;;
434
;; - rename-file (old new)
435 436
;;
;;   Rename file OLD to NEW, both in the working area and in the
437 438
;;   repository.  If this function is not provided, the renaming
;;   will be done by (vc-delete-file old) and (vc-register new).
Luc Teirlinck's avatar
Luc Teirlinck committed
439
;;
440 441
;; - find-file-hook ()
;;
442
;;   Operation called in current buffer when opening a file.  This can
443
;;   be used by the backend to setup some local variables it might need.
444 445 446 447 448
;
;; - find-file-not-found-hook ()
;;
;;   Operation called in current buffer when opening a non-existing file.
;;   By default, this asks the user if she wants to check out the file.
449

450
;;; Code:
451

Eric S. Raymond's avatar
Eric S. Raymond committed
452
(require 'vc-hooks)
453
(require 'ring)
454
(eval-when-compile
455
  (require 'cl)
456 457 458
  (require 'compile)
  (require 'dired)      ; for dired-map-over-marks macro
  (require 'dired-aux))	; for dired-kill-{line,tree}
459 460 461 462 463

(if (not (assoc 'vc-parent-buffer minor-mode-alist))
    (setq minor-mode-alist
	  (cons '(vc-parent-buffer vc-parent-buffer-name)
		minor-mode-alist)))
Eric S. Raymond's avatar
Eric S. Raymond committed
464 465 466

;; General customization

467 468 469 470 471
(defgroup vc nil
  "Version-control system in Emacs."
  :group 'tools)

(defcustom vc-suppress-confirm nil
472
  "If non-nil, treat user as expert; suppress yes-no prompts on some things."
473 474 475
  :type 'boolean
  :group 'vc)

476
(defcustom vc-delete-logbuf-window t
477
  "If non-nil, delete the *VC-log* buffer and window after each logical action.
478 479 480 481 482 483
If nil, bury that buffer instead.
This is most useful if you have multiple windows on a frame and would like to
preserve the setting."
  :type 'boolean
  :group 'vc)

484
(defcustom vc-initial-comment nil
485
  "If non-nil, prompt for initial comment when a file is registered."
486 487 488
  :type 'boolean
  :group 'vc)

489
(defcustom vc-default-init-version "1.1"
490
  "A string used as the default version number when a new file is registered.
491 492
This can be overridden by giving a prefix argument to \\[vc-register].  This
can also be overridden by a particular VC backend."
493
  :type 'string
Dan Nicolaescu's avatar
Dan Nicolaescu committed
494 495
  :group 'vc
  :version "20.3")
496

497
(defcustom vc-command-messages nil
498
  "If non-nil, display run messages from back-end commands."
499 500 501 502
  :type 'boolean
  :group 'vc)

(defcustom vc-checkin-switches nil
503
  "A string or list of strings specifying extra switches for checkin.
504 505 506 507 508 509 510 511 512
These are passed to the checkin program by \\[vc-checkin]."
  :type '(choice (const :tag "None" nil)
		 (string :tag "Argument String")
		 (repeat :tag "Argument List"
			 :value ("")
			 string))
  :group 'vc)

(defcustom vc-checkout-switches nil
513
  "A string or list of strings specifying extra switches for checkout.
514 515 516 517 518 519 520 521 522
These are passed to the checkout program by \\[vc-checkout]."
  :type '(choice (const :tag "None" nil)
		 (string :tag "Argument String")
		 (repeat :tag "Argument List"
			 :value ("")
			 string))
  :group 'vc)

(defcustom vc-register-switches nil
523
  "A string or list of strings; extra switches for registering a file.
524 525 526 527 528 529 530 531
These are passed to the checkin program by \\[vc-register]."
  :type '(choice (const :tag "None" nil)
		 (string :tag "Argument String")
		 (repeat :tag "Argument List"
			 :value ("")
			 string))
  :group 'vc)

532
(defcustom vc-dired-listing-switches "-al"
533
  "Switches passed to `ls' for vc-dired.  MUST contain the `l' option."
534 535
  :type 'string
  :group 'vc
536
  :version "21.1")
537

538
(defcustom vc-dired-recurse t
539
  "If non-nil, show directory trees recursively in VC Dired."
540 541 542 543 544
  :type 'boolean
  :group 'vc
  :version "20.3")

(defcustom vc-dired-terse-display t
545
  "If non-nil, show only locked files in VC Dired."
546 547 548 549
  :type 'boolean
  :group 'vc
  :version "20.3")

550
(defcustom vc-directory-exclusion-list '("SCCS" "RCS" "CVS" "MCVS" ".svn" "{arch}")
551
  "List of directory names to be ignored when walking directory trees."
552 553
  :type '(repeat string)
  :group 'vc)
554

555
(defcustom vc-diff-switches nil
556
  "A string or list of strings specifying switches for diff under VC.
557 558 559 560 561
When running diff under a given BACKEND, VC concatenates the values of
`diff-switches', `vc-diff-switches', and `vc-BACKEND-diff-switches' to
get the switches for that command.  Thus, `vc-diff-switches' should
contain switches that are specific to version control, but not
specific to any particular backend."
562 563 564 565 566 567 568 569
  :type '(choice (const :tag "None" nil)
		 (string :tag "Argument String")
		 (repeat :tag "Argument List"
			 :value ("")
			 string))
  :group 'vc
  :version "21.1")

570
(defcustom vc-allow-async-revert nil
571
  "Specifies whether the diff during \\[vc-revert-buffer] may be asynchronous.
572 573 574 575 576
Enabling this option means that you can confirm a revert operation even
if the local changes in the file have not been found and displayed yet."
  :type '(choice (const :tag "No" nil)
                 (const :tag "Yes" t))
  :group 'vc
577
  :version "22.1")
578

André Spiegel's avatar
André Spiegel committed
579 580
;;;###autoload
(defcustom vc-checkout-hook nil
581
  "Normal hook (list of functions) run after checking out a file.
André Spiegel's avatar
André Spiegel committed
582 583 584 585 586
See `run-hooks'."
  :type 'hook
  :group 'vc
  :version "21.1")

587
(defcustom vc-annotate-display-mode nil
André Spiegel's avatar
André Spiegel committed
588
  "Which mode to color the output of \\[vc-annotate] with by default."
589 590 591 592 593 594 595
  :type '(choice (const :tag "Default" nil)
		 (const :tag "Scale to Oldest" scale)
		 (const :tag "Scale Oldest->Newest" fullscale)
		 (number :tag "Specify Fractional Number of Days"
			 :value "20.5"))
  :group 'vc)

596 597
;;;###autoload
(defcustom vc-checkin-hook nil
598
  "Normal hook (list of functions) run after a checkin is done.
599
See also `log-edit-done-hook'."
600
  :type 'hook
601
  :options '(log-edit-comment-to-change-log)
602 603 604 605
  :group 'vc)

;;;###autoload
(defcustom vc-before-checkin-hook nil
606
  "Normal hook (list of functions) run before a file is checked in.
607 608 609 610 611
See `run-hooks'."
  :type 'hook
  :group 'vc)

(defcustom vc-logentry-check-hook nil
612
  "Normal hook run by `vc-backend-logentry-check'.
613 614 615 616
Use this to impose your own rules on the entry in addition to any the
version control backend imposes itself."
  :type 'hook
  :group 'vc)
617

618
;; Annotate customization
619
(defcustom vc-annotate-color-map
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636
  '(( 20. . "#FFCC00")
    ( 40. . "#FF6666")
    ( 60. . "#FF6600")
    ( 80. . "#FF3300")
    (100. . "#FF00FF")
    (120. . "#FF0000")
    (140. . "#CCCC00")
    (160. . "#CC00CC")
    (180. . "#BC8F8F")
    (200. . "#99CC00")
    (220. . "#999900")
    (240. . "#7AC5CD")
    (260. . "#66CC00")
    (280. . "#33CC33")
    (300. . "#00CCFF")
    (320. . "#00CC99")
    (340. . "#0099FF"))
637
  "Association list of age versus color, for \\[vc-annotate].
638 639
Ages are given in units of fractional days.  Default is eighteen steps
using a twenty day increment."
640
  :type 'alist
641 642 643
  :group 'vc)

(defcustom vc-annotate-very-old-color "#0046FF"
644
  "Color for lines older than the current color range in \\[vc-annotate]]."
645 646 647 648
  :type 'string
  :group 'vc)

(defcustom vc-annotate-background "black"
649
  "Background color for \\[vc-annotate].
650 651 652 653 654
Default color is used if nil."
  :type 'string
  :group 'vc)

(defcustom vc-annotate-menu-elements '(2 0.5 0.1 0.01)
655
  "Menu elements for the mode-specific menu of VC-Annotate mode.
656
List of factors, used to expand/compress the time scale.  See `vc-annotate'."
657
  :type '(repeat number)
658 659
  :group 'vc)

660 661 662
(defvar vc-annotate-mode-map
  (let ((m (make-sparse-keymap)))
    (define-key m [menu-bar] (make-sparse-keymap "VC-Annotate"))
663 664 665 666 667 668 669
    (define-key m "A" 'vc-annotate-revision-previous-to-line)
    (define-key m "D" 'vc-annotate-show-diff-revision-at-line)
    (define-key m "J" 'vc-annotate-revision-at-line)
    (define-key m "L" 'vc-annotate-show-log-revision-at-line)
    (define-key m "N" 'vc-annotate-next-version)
    (define-key m "P" 'vc-annotate-prev-version)
    (define-key m "W" 'vc-annotate-workfile-version)
670 671
    m)
  "Local keymap used for VC-Annotate mode.")
672

673 674
(defvar vc-annotate-mode-menu nil
  "Local keymap used for VC-Annotate mode's menu bar menu.")
675

Eric S. Raymond's avatar
Eric S. Raymond committed
676 677
;; Header-insertion hair

678
(defcustom vc-static-header-alist
679
  '(("\\.c\\'" .
Eric S. Raymond's avatar
Eric S. Raymond committed
680
     "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
681 682
  "*Associate static header string templates with file types.
A \%s in the template is replaced with the first string associated with
683
the file's version control type in `vc-header-alist'."
684 685 686 687
  :type '(repeat (cons :format "%v"
		       (regexp :tag "File Type")
		       (string :tag "Header String")))
  :group 'vc)
688

689
(defcustom vc-comment-alist
Eric S. Raymond's avatar
Eric S. Raymond committed
690
  '((nroff-mode ".\\\"" ""))
André Spiegel's avatar
André Spiegel committed
691
  "*Special comment delimiters for generating VC headers.
692 693
Add an entry in this list if you need to override the normal `comment-start'
and `comment-end' variables.  This will only be necessary if the mode language
694 695 696 697 698 699
is sensitive to blank lines."
  :type '(repeat (list :format "%v"
		       (symbol :tag "Mode")
		       (string :tag "Comment Start")
		       (string :tag "Comment End")))
  :group 'vc)
Eric S. Raymond's avatar
Eric S. Raymond committed
700

701
(defcustom vc-checkout-carefully (= (user-uid) 0)
702
  "*Non-nil means be extra-careful in checkout.
703
Verify that the file really is not locked
704 705 706
and that its contents match what the master file says."
  :type 'boolean
  :group 'vc)
707 708 709
(make-obsolete-variable 'vc-checkout-carefully
                        "the corresponding checks are always done now."
                        "21.1")
710

711

Eric S. Raymond's avatar
Eric S. Raymond committed
712 713
;; Variables the user doesn't need to know about.
(defvar vc-log-operation nil)
714
(defvar vc-log-after-operation-hook nil)
715

Richard M. Stallman's avatar
Richard M. Stallman committed
716 717 718
;; In a log entry buffer, this is a local variable
;; that points to the buffer for which it was made
;; (either a file, or a VC dired buffer).
719
(defvar vc-parent-buffer nil)
720
(put 'vc-parent-buffer 'permanent-local t)
721
(defvar vc-parent-buffer-name nil)
722
(put 'vc-parent-buffer-name 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
723

724 725 726 727 728
(defvar vc-disable-async-diff nil
  "VC sets this to t locally to disable some async diff operations.
Backends that offer asynchronous diffs should respect this variable
in their implementation of vc-BACKEND-diff.")

729 730 731
(defvar vc-log-file)
(defvar vc-log-version)

732
(defvar vc-dired-mode nil)
733 734
(make-variable-buffer-local 'vc-dired-mode)

735 736 737
;; functions that operate on RCS revision numbers.  This code should
;; also be moved into the backends.  It stays for now, however, since
;; it is used in code below.
738
;;;###autoload
739
(defun vc-trunk-p (rev)
740
  "Return t if REV is a revision on the trunk."
741 742
  (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev))))

743
(defun vc-branch-p (rev)
744
  "Return t if REV is a branch revision."
745 746
  (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev))))

747
;;;###autoload
748
(defun vc-branch-part (rev)
749
  "Return the branch part of a revision number REV."
750 751 752
  (let ((index (string-match "\\.[0-9]+\\'" rev)))
    (if index
        (substring rev 0 index))))
753

754
(defun vc-minor-part (rev)
755
  "Return the minor version number of a revision number REV."
756 757 758
  (string-match "[0-9]+\\'" rev)
  (substring rev (match-beginning 0) (match-end 0)))

759
(defun vc-default-previous-version (backend file rev)
760 761
  "Return the version number immediately preceding REV for FILE,
or nil if there is no previous version.  This default
762
implementation works for MAJOR.MINOR-style version numbers as
763
used by RCS and CVS."
764 765
  (let ((branch (vc-branch-part rev))
        (minor-num (string-to-number (vc-minor-part rev))))
766 767 768 769 770 771 772 773 774 775 776
    (when branch
      (if (> minor-num 1)
          ;; version does probably not start a branch or release
          (concat branch "." (number-to-string (1- minor-num)))
        (if (vc-trunk-p rev)
            ;; we are at the beginning of the trunk --
            ;; don't know anything to return here
            nil
          ;; we are at the beginning of a branch --
          ;; return version of starting point
          (vc-branch-part branch))))))
777

778 779 780
(defun vc-default-next-version (backend file rev)
  "Return the version number immediately following REV for FILE,
or nil if there is no next version.  This default implementation
781
works for MAJOR.MINOR-style version numbers as used by RCS
782 783 784 785 786 787
and CVS."
  (when (not (string= rev (vc-workfile-version file)))
    (let ((branch (vc-branch-part rev))
	  (minor-num (string-to-number (vc-minor-part rev))))
      (concat branch "." (number-to-string (1+ minor-num))))))

Eric S. Raymond's avatar
Eric S. Raymond committed
788 789
;; File property caching

790
(defun vc-clear-context ()
791
  "Clear all cached file properties."
792
  (interactive)
793
  (fillarray vc-file-prop-obarray 0))
794

795
(defmacro with-vc-properties (file form settings)
André Spiegel's avatar
André Spiegel committed
796 797 798 799
  "Execute FORM, then maybe set per-file properties for FILE.
SETTINGS is an association list of property/value pairs.  After
executing FORM, set those properties from SETTINGS that have not yet
been updated to their corresponding values."
800
  (declare (debug t))
801
  `(let ((vc-touched-properties (list t)))
802 803
     ,form
     (mapcar (lambda (setting)
804
	       (let ((property (car setting)))
805
		 (unless (memq property vc-touched-properties)
806
		   (put (intern ,file vc-file-prop-obarray)
807
			property (cdr setting)))))
808 809
	     ,settings)))

Eric S. Raymond's avatar
Eric S. Raymond committed
810 811
;; Random helper functions

812
(defsubst vc-editable-p (file)
André Spiegel's avatar
André Spiegel committed
813
  "Return non-nil if FILE can be edited."
814
  (or (eq (vc-checkout-model file) 'implicit)
815
      (memq (vc-state file) '(edited needs-merge))))
816

817
;; Two macros for elisp programming
818 819
;;;###autoload
(defmacro with-vc-file (file comment &rest body)
André Spiegel's avatar
André Spiegel committed
820
  "Check out a writable copy of FILE if necessary, then execute BODY.
821 822 823
Check in FILE with COMMENT (a string) after BODY has been executed.
FILE is passed through `expand-file-name'; BODY executed within
`save-excursion'.  If FILE is not under version control, or locked by
824
somebody else, signal error."
825
  (declare (debug t) (indent 2))
826 827 828
  (let ((filevar (make-symbol "file")))
    `(let ((,filevar (expand-file-name ,file)))
       (or (vc-backend ,filevar)
829
           (error "File not under version control: `%s'" file))
830 831
       (unless (vc-editable-p ,filevar)
         (let ((state (vc-state ,filevar)))
832
           (if (stringp state)
833
               (error "`%s' is locking `%s'" state ,filevar)
834 835 836 837 838
             (vc-checkout ,filevar t))))
       (save-excursion
         ,@body)
       (vc-checkin ,filevar nil ,comment))))

839 840
;;;###autoload
(defmacro edit-vc-file (file comment &rest body)
841 842
  "Edit FILE under version control, executing body.
Checkin with COMMENT after executing BODY.
843 844
This macro uses `with-vc-file', passing args to it.
However, before executing BODY, find FILE, and after BODY, save buffer."
845
  (declare (debug t) (indent 2))
846 847 848 849 850 851 852 853
  (let ((filevar (make-symbol "file")))
    `(let ((,filevar (expand-file-name ,file)))
       (with-vc-file
        ,filevar ,comment
        (set-buffer (find-file-noselect ,filevar))
        ,@body
        (save-buffer)))))

854
(defun vc-ensure-vc-buffer ()
855
  "Make sure that the current buffer visits a version-controlled file."
856 857 858 859
  (if vc-dired-mode
      (set-buffer (find-file-noselect (dired-get-filename)))
    (while vc-parent-buffer
      (pop-to-buffer vc-parent-buffer))
860
    (if (not buffer-file-name)
861
	(error "Buffer %s is not associated with a file" (buffer-name))
862 863
      (if (not (vc-backend buffer-file-name))
	  (error "File %s is not under version control" buffer-file-name)))))
864

865
(defun vc-process-filter (p s)
866
  "An alternative output filter for async process P.
867 868 869 870 871 872 873 874 875
The only difference with the default filter is to insert S after markers."
  (with-current-buffer (process-buffer p)
    (save-excursion
      (let ((inhibit-read-only t))
	(goto-char (process-mark p))
	(insert s)
	(set-marker (process-mark p) (point))))))

(defun vc-setup-buffer (&optional buf)
André Spiegel's avatar
André Spiegel committed
876
  "Prepare BUF for executing a VC command and make it current.
877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908
BUF defaults to \"*vc*\", can be a string and will be created if necessary."
  (unless buf (setq buf "*vc*"))
  (let ((camefrom (current-buffer))
	(olddir default-directory))
    (set-buffer (get-buffer-create buf))
    (kill-all-local-variables)
    (set (make-local-variable 'vc-parent-buffer) camefrom)
    (set (make-local-variable 'vc-parent-buffer-name)
	 (concat " from " (buffer-name camefrom)))
    (setq default-directory olddir)
    (let ((inhibit-read-only t))
      (erase-buffer))))

(defun vc-exec-after (code)
  "Eval CODE when the current buffer's process is done.
If the current buffer has no process, just evaluate CODE.
Else, add CODE to the process' sentinel."
  (let ((proc (get-buffer-process (current-buffer))))
    (cond
     ;; If there's no background process, just execute the code.
     ((null proc) (eval code))
     ;; If the background process has exited, reap it and try again
     ((eq (process-status proc) 'exit)
      (delete-process proc)
      (vc-exec-after code))
     ;; If a process is running, add CODE to the sentinel
     ((eq (process-status proc) 'run)
      (let ((sentinel (process-sentinel proc)))
	(set-process-sentinel proc
	  `(lambda (p s)
	     (with-current-buffer ',(current-buffer)
	       (goto-char (process-mark p))
909
	       ,@(append (cdr (cdr (cdr ;strip off `with-current-buffer buf
910 911 912 913 914 915 916 917 918 919
                                        ;             (goto-char...)'
			   (car (cdr (cdr ;strip off `lambda (p s)'
			    sentinel))))))
			 (list `(vc-exec-after ',code))))))))
     (t (error "Unexpected process state"))))
  nil)

(defvar vc-post-command-functions nil
  "Hook run at the end of `vc-do-command'.
Each function is called inside the buffer in which the command was run
André Spiegel's avatar
André Spiegel committed
920
and is passed 3 arguments: the COMMAND, the FILE and the FLAGS.")
921

922
(defvar w32-quote-process-args)
Stefan Monnier's avatar
Stefan Monnier committed
923
;;;###autoload
924
(defun vc-do-command (buffer okstatus command file &rest flags)
André Spiegel's avatar
André Spiegel committed
925
  "Execute a VC command, notifying user and checking for errors.
926 927 928 929
Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil or the
current buffer if BUFFER is t.  If the destination buffer is not
already current, set it up properly and erase it.  The command is
considered successful if its exit status does not exceed OKSTATUS (if
930
OKSTATUS is nil, that means to ignore error status, if it is `async', that
931 932
means not to wait for termination of the subprocess; if it is t it means to
ignore all execution errors).  FILE is the
933 934
name of the working file (may also be nil, to execute commands that
don't expect a file name).  If an optional list of FLAGS is present,
935
that is inserted into the command line before the filename."
936
  (and file (setq file (expand-file-name file)))
Eric S. Raymond's avatar
Eric S. Raymond committed
937
  (if vc-command-messages
938
      (message "Running %s on %s..." command file))
939
  (save-current-buffer
940 941 942 943 944
    (unless (or (eq buffer t)
                (and (stringp buffer)
                     (string= (buffer-name) buffer))
                (eq buffer (current-buffer)))
      (vc-setup-buffer buffer))
945
    (let ((squeezed (remq nil flags))
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960
	  (inhibit-read-only t)
	  (status 0))
      (when file
	;; FIXME: file-relative-name can return a bogus result because
	;; it doesn't look at the actual file-system to see if symlinks
	;; come into play.
	(setq squeezed (append squeezed (list (file-relative-name file)))))
      (let ((exec-path (append vc-path exec-path))
	    ;; Add vc-path to PATH for the execution of this command.
	    (process-environment
	     (cons (concat "PATH=" (getenv "PATH")
			   path-separator
			   (mapconcat 'identity vc-path path-separator))
		   process-environment))
	    (w32-quote-process-args t))
961 962 963
	(if (and (eq okstatus 'async) (file-remote-p default-directory))
	    ;; start-process does not support remote execution
	    (setq okstatus nil))
964
	(if (eq okstatus 'async)
965 966 967 968
	    (let ((proc
		   (let ((process-connection-type nil))
		     (apply 'start-process command (current-buffer) command
			    squeezed))))