vc.el 123 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
;; Copyright (C) 1992,93,94,95,96,97,98,2000  Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

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

8
;; $Id: vc.el,v 1.286 2000/11/16 13:39:10 spiegel Exp $
9

Eric S. Raymond's avatar
Eric S. Raymond committed
10 11 12 13 14 15 16 17 18 19 20 21 22
;; 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
23 24 25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Eric S. Raymond's avatar
Eric S. Raymond committed
26

27 28 29 30 31 32 33 34 35
;;; 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
36
;;   Dave Love <fx@gnu.org>
37 38 39 40 41
;;   Stefan Monnier <monnier@cs.yale.edu>
;;   Andre Spiegel <spiegel@gnu.org>
;;   Richard Stallman <rms@gnu.org>
;;   ttn@netcom.com

Eric S. Raymond's avatar
Eric S. Raymond committed
42 43
;;; Commentary:

44 45
;; This mode is fully documented in the Emacs user's manual.
;;
46
;; Supported version-control systems presently include SCCS, RCS, and CVS.
47 48 49
;;
;; Some features will not work with old RCS versions.  Where
;; appropriate, VC finds out which version you have, and allows or
50
;; disallows those features (stealing locks, for example, works only
51
;; from 5.6.2 onwards).
52 53
;; 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
54
;; NExTSTEP 3.0.
Eric S. Raymond's avatar
Eric S. Raymond committed
55
;;
56
;; You can support the RCS -x option by customizing vc-rcs-master-templates.
Eric S. Raymond's avatar
Eric S. Raymond committed
57 58 59 60
;;
;; Proper function of the SCCS diff commands requires the shellscript vcdiff
;; to be installed somewhere on Emacs's path for executables.
;;
61
;; If your site uses the ChangeLog convention supported by Emacs, the
62
;; function vc-comment-to-change-log should prove a useful checkin hook.
63
;;
Eric S. Raymond's avatar
Eric S. Raymond committed
64 65
;; The vc code maintains some internal state in order to reduce expensive
;; version-control operations to a minimum.  Some names are only computed
66
;; once.  If you perform version control operations with RCS/SCCS/CVS while
Eric S. Raymond's avatar
Eric S. Raymond committed
67 68 69 70 71 72 73 74
;; 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.

;;; Code:

75 76 77
;;;;;;;;;;;;;;;;; Backend-specific functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;; for each operation FUN, the backend should provide a function vc-BACKEND-FUN.
78
;; Operations marked with a `-' instead of a `*' are optional.
79 80 81 82 83 84 85 86 87 88

;; * registered (file)
;; * state (file)
;; - state-heuristic (file)
;;     The default behavior delegates to `state'.
;; - dir-state (dir)
;; * checkout-model (file)
;; - mode-line-string (file)
;; * workfile-version (file)
;; * revert (file)
89 90 91 92 93
;; - merge-news (file)
;;     Only needed if state `needs-merge' is possible.
;; - merge (file rev1 rev2)
;; - steal-lock (file &optional version)
;;     Only required if files can be locked by somebody else.
94
;; * register (file rev comment)
95
;; * unregister (file backend)
96
;; - receive-file (file rev)
97
;; - responsible-p (file)
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
;;     Should also work if FILE is a directory (ends with a slash).
;; - could-register (file)
;; * checkout (file writable &optional rev destfile)
;;     Checkout revision REV of FILE into DESTFILE.
;;     DESTFILE defaults to FILE.
;;     The file should be made writable if WRITABLE is non-nil.
;;     REV can be nil (BASE) or "" (HEAD) or any other revision.
;; * checkin (file rev comment)
;; - logentry-check ()
;; * diff (file &optional rev1 rev2)
;;     Insert the diff for FILE into the current buffer.
;;     REV1 should default to workfile-version.
;;     REV2 should default to the current workfile
;;     Return a status of either 0 (i.e. no diff) or 1 (i.e. either non-empty
;;     diff or the diff is run asynchronously).
;; - workfile-unchanged-p (file)
;;     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 vc-BACKEND-diff.
;; - clear-headers ()
;; * check-headers ()
;; - dired-state-info (file)
;; - create-snapshot (dir name branchp)
;;     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 behavior 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'.
;; - retrieve-snapshot (dir name update)
;;     Retrieve a named snapshot of all registered files at or below DIR.
136
;;     If UPDATE is non-nil, then update buffers of any files in the snapshot
137 138 139 140
;;     that are currently visited.
;; * print-log (file)
;;     Insert the revision log of FILE into the current buffer.
;; - show-log-entry (version)
141 142
;; - wash-log (file)
;;     Remove all non-comment information from the output of print-log
143
;; - comment-history (file)
144 145 146 147
;; - update-changelog (files)
;;     Find changelog entries for FILES, or for all files at or below
;;     the default-directory if FILES is nil.
;; * latest-on-branch-p (file)
148 149
;; - cancel-version (file writable)
;; - rename-file (old new)
150
;; - annotate-command (file buf rev)
151 152
;; - annotate-difference (pos)
;;     Only required if `annotate-command' is defined for the backend.
153

Eric S. Raymond's avatar
Eric S. Raymond committed
154
(require 'vc-hooks)
155
(require 'ring)
156
(eval-when-compile
157
  (require 'cl)
158 159 160
  (require 'compile)
  (require 'dired)      ; for dired-map-over-marks macro
  (require 'dired-aux))	; for dired-kill-{line,tree}
161 162 163 164 165

(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
166 167 168

;; General customization

169 170 171 172 173 174 175 176 177
(defgroup vc nil
  "Version-control system in Emacs."
  :group 'tools)

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

178 179 180 181 182 183 184 185
(defcustom vc-delete-logbuf-window t
  "*If non-nil, delete the *VC-log* buffer and window after each logical action.
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)

186 187 188 189 190
(defcustom vc-initial-comment nil
  "*If non-nil, prompt for initial comment when a file is registered."
  :type 'boolean
  :group 'vc)

191 192
(defcustom vc-default-init-version "1.1"
  "*A string used as the default version number when a new file is registered.
193
This can be overridden by giving a prefix argument to \\[vc-register]."
194
  :type 'string
Dan Nicolaescu's avatar
Dan Nicolaescu committed
195 196
  :group 'vc
  :version "20.3")
197

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
(defcustom vc-command-messages nil
  "*If non-nil, display run messages from back-end commands."
  :type 'boolean
  :group 'vc)

(defcustom vc-checkin-switches nil
  "*A string or list of strings specifying extra switches for checkin.
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
  "*A string or list of strings specifying extra switches for checkout.
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
  "*A string or list of strings; extra switches for registering a file.
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)

233 234 235 236
(defcustom vc-dired-listing-switches "-al"
  "*Switches passed to `ls' for vc-dired.  MUST contain the `l' option."
  :type 'string
  :group 'vc
237
  :version "21.1")
238

239 240 241 242 243 244 245 246 247 248 249 250
(defcustom vc-dired-recurse t
  "*If non-nil, show directory trees recursively in VC Dired."
  :type 'boolean
  :group 'vc
  :version "20.3")

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

251 252 253 254
(defcustom vc-directory-exclusion-list '("SCCS" "RCS" "CVS")
  "*List of directory names to be ignored while recursively walking file trees."
  :type '(repeat string)
  :group 'vc)
255

256 257 258
(defconst vc-maximum-comment-ring-size 32
  "Maximum number of saved comments in the comment ring.")

259 260
;;; This is duplicated in diff.el.
(defvar diff-switches "-c"
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283
  "*A string or list of strings specifying switches to be passed to diff.")

;;;###autoload
(defcustom vc-checkin-hook nil
  "*Normal hook (list of functions) run after a checkin is done.
See `run-hooks'."
  :type 'hook
  :options '(vc-comment-to-change-log)
  :group 'vc)

;;;###autoload
(defcustom vc-before-checkin-hook nil
  "*Normal hook (list of functions) run before a file gets checked in.
See `run-hooks'."
  :type 'hook
  :group 'vc)

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

285
;; Annotate customization
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
(defcustom vc-annotate-color-map
  '(( 26.3672 . "#FF0000")
    ( 52.7344 . "#FF3800")
    ( 79.1016 . "#FF7000")
    (105.4688 . "#FFA800")
    (131.8359 . "#FFE000")
    (158.2031 . "#E7FF00")
    (184.5703 . "#AFFF00")
    (210.9375 . "#77FF00")
    (237.3047 . "#3FFF00")
    (263.6719 . "#07FF00")
    (290.0391 . "#00FF31")
    (316.4063 . "#00FF69")
    (342.7734 . "#00FFA1")
    (369.1406 . "#00FFD9")
    (395.5078 . "#00EEFF")
    (421.8750 . "#00B6FF")
    (448.2422 . "#007EFF"))
  "*Association list of age versus color, for \\[vc-annotate].
Ages are given in units of 2**-16 seconds.
Default is eighteen steps using a twenty day increment."
307
  :type 'alist
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
  :group 'vc)

(defcustom vc-annotate-very-old-color "#0046FF"
  "*Color for lines older than CAR of last cons in `vc-annotate-color-map'."
  :type 'string
  :group 'vc)

(defcustom vc-annotate-background "black"
  "*Background color for \\[vc-annotate].
Default color is used if nil."
  :type 'string
  :group 'vc)

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

327 328 329
;; vc-annotate functionality (CVS only).
(defvar vc-annotate-mode nil
  "Variable indicating if VC-Annotate mode is active.")
330

331 332 333 334 335
(defvar vc-annotate-mode-map
  (let ((m (make-sparse-keymap)))
    (define-key m [menu-bar] (make-sparse-keymap "VC-Annotate"))
    m)
  "Local keymap used for VC-Annotate mode.")
336

337 338
(defvar vc-annotate-mode-menu nil
  "Local keymap used for VC-Annotate mode's menu bar menu.")
339

Eric S. Raymond's avatar
Eric S. Raymond committed
340 341
;; Header-insertion hair

342
(defcustom vc-static-header-alist
Eric S. Raymond's avatar
Eric S. Raymond committed
343 344
  '(("\\.c$" .
     "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
345 346
  "*Associate static header string templates with file types.
A \%s in the template is replaced with the first string associated with
347
the file's version control type in `vc-header-alist'."
348 349 350 351
  :type '(repeat (cons :format "%v"
		       (regexp :tag "File Type")
		       (string :tag "Header String")))
  :group 'vc)
352

353
(defcustom vc-comment-alist
Eric S. Raymond's avatar
Eric S. Raymond committed
354 355
  '((nroff-mode ".\\\"" ""))
  "*Special comment delimiters to be used in generating vc headers only.
356 357
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
358 359 360 361 362 363
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
364

365
;; Default is to be extra careful for super-user.
366 367
;; TODO: This variable is no longer used; the corresponding checks
;;       are always done now.  If that turns out to be fast enough,
368
;;       the variable can be obsoleted.
369
(defcustom vc-checkout-carefully (= (user-uid) 0)
370 371
  "*Non-nil means be extra-careful in checkout.
Verify that the file really is not locked
372 373 374
and that its contents match what the master file says."
  :type 'boolean
  :group 'vc)
375

376 377 378 379 380 381

;;; The main keymap

(defvar vc-prefix-map
  (let ((map (make-sparse-keymap)))
    (define-key map "a" 'vc-update-change-log)
382
    (define-key map "b" 'vc-switch-backend)
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397
    (define-key map "c" 'vc-cancel-version)
    (define-key map "d" 'vc-directory)
    (define-key map "g" 'vc-annotate)
    (define-key map "h" 'vc-insert-headers)
    (define-key map "i" 'vc-register)
    (define-key map "l" 'vc-print-log)
    (define-key map "m" 'vc-merge)
    (define-key map "r" 'vc-retrieve-snapshot)
    (define-key map "s" 'vc-create-snapshot)
    (define-key map "u" 'vc-revert-buffer)
    (define-key map "v" 'vc-next-action)
    (define-key map "=" 'vc-diff)
    (define-key map "~" 'vc-version-other-window)
    map))
(fset 'vc-prefix-map vc-prefix-map)
398

399 400 401 402 403 404 405 406 407 408 409
;; Initialization code, to be done just once at load-time
(defvar vc-log-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map "\M-n" 'vc-next-comment)
    (define-key map "\M-p" 'vc-previous-comment)
    (define-key map "\M-r" 'vc-comment-search-reverse)
    (define-key map "\M-s" 'vc-comment-search-forward)
    (define-key map "\C-c\C-c" 'vc-finish-logentry)
    map))
;; Compatibility with old name.  Should we bother ?
(defvar vc-log-entry-mode vc-log-mode-map)
410

411

Eric S. Raymond's avatar
Eric S. Raymond committed
412 413
;; Variables the user doesn't need to know about.
(defvar vc-log-operation nil)
414
(defvar vc-log-after-operation-hook nil)
415
(defvar vc-annotate-buffers nil
416 417
  "Alist of current \"Annotate\" buffers and their corresponding backends.
The keys are \(BUFFER . BACKEND\).  See also `vc-annotate-get-backend'.")
Richard M. Stallman's avatar
Richard M. Stallman committed
418 419 420
;; 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).
421
(defvar vc-parent-buffer nil)
422
(put 'vc-parent-buffer 'permanent-local t)
423
(defvar vc-parent-buffer-name nil)
424
(put 'vc-parent-buffer-name 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
425

426 427 428
(defvar vc-log-file)
(defvar vc-log-version)

429
(defvar vc-dired-mode nil)
430 431
(make-variable-buffer-local 'vc-dired-mode)

432
(defvar vc-comment-ring (make-ring vc-maximum-comment-ring-size))
433
(defvar vc-comment-ring-index nil)
434
(defvar vc-last-comment-match "")
435

436 437 438
;;; 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.
439
(defun vc-trunk-p (rev)
440
  "Return t if REV is a revision on the trunk."
441 442
  (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev))))

443
(defun vc-branch-p (rev)
444
  "Return t if REV is a branch revision."
445 446
  (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev))))

447
(defun vc-branch-part (rev)
448
  "Return the branch part of a revision number REV."
449 450
  (substring rev 0 (string-match "\\.[0-9]+\\'" rev)))

451
(defun vc-minor-part (rev)
452
  "Return the minor version number of a revision number REV."
453 454 455 456
  (string-match "[0-9]+\\'" rev)
  (substring rev (match-beginning 0) (match-end 0)))

(defun vc-previous-version (rev)
457
  "Guess the version number immediately preceding REV."
458 459 460 461 462 463 464 465 466 467 468 469 470
  (let ((branch (vc-branch-part rev))
        (minor-num (string-to-number (vc-minor-part rev))))
    (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
          ""
        ;; we are at the beginning of a branch --
        ;; return version of starting point
        (vc-branch-part branch)))))

Eric S. Raymond's avatar
Eric S. Raymond committed
471 472
;; File property caching

473 474 475 476 477 478
(defun vc-clear-context ()
  "Clear all cached file properties and the comment ring."
  (interactive)
  (fillarray vc-file-prop-obarray nil)
  ;; Note: there is potential for minor lossage here if there is an open
  ;; log buffer with a nonzero local value of vc-comment-ring-index.
479
  (setq vc-comment-ring (make-ring vc-maximum-comment-ring-size)))
480

481
(defmacro with-vc-properties (file form settings)
482 483 484 485
  "Execute FORM, then set per-file properties for FILE,
but only those that have not been set during the execution of FORM.
SETTINGS is a list of two-element lists, each of which has the
  form (PROPERTY . VALUE)."
486 487 488 489
  `(let ((vc-touched-properties (list t))
	 (filename ,file))
     ,form
     (mapcar (lambda (setting)
490
	       (let ((property (car setting)))
491
		 (unless (memq property vc-touched-properties)
492
		   (put (intern filename vc-file-prop-obarray)
493
			property (cdr setting)))))
494 495
	     ,settings)))

Eric S. Raymond's avatar
Eric S. Raymond committed
496 497
;; Random helper functions

498 499
(defsubst vc-editable-p (file)
  (or (eq (vc-checkout-model file) 'implicit)
500
      (memq (vc-state file) '(edited needs-merge))))
501

502 503 504
;;; Two macros for elisp programming
;;;###autoload
(defmacro with-vc-file (file comment &rest body)
505 506 507 508
  "Check out a writable copy of FILE if necessary and execute the body.
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
509 510
somebody else, signal error."
  `(let ((file (expand-file-name ,file)))
511
     (or (vc-backend file)
512
	 (error (format "File not under version control: `%s'" file)))
513 514 515 516
     (unless (vc-editable-p file)
       (let ((state (vc-state file)))
	 (if (stringp state) (error (format "`%s' is locking `%s'" state file))
	   (vc-checkout file t))))
517 518 519
     (save-excursion
       ,@body)
     (vc-checkin file nil ,comment)))
520
(put 'with-vc-file 'indent-function 1)
521 522 523

;;;###autoload
(defmacro edit-vc-file (file comment &rest body)
524 525
  "Edit FILE under version control, executing body.
Checkin with COMMENT after executing BODY.
526 527 528 529
This macro uses `with-vc-file', passing args to it.
However, before executing BODY, find FILE, and after BODY, save buffer."
  `(with-vc-file
    ,file ,comment
530
    (set-buffer (find-file-noselect ,file))
531 532
    ,@body
    (save-buffer)))
533
(put 'edit-vc-file 'indent-function 1)
534

535
(defun vc-ensure-vc-buffer ()
536
  "Make sure that the current buffer visits a version-controlled file."
537 538 539 540 541 542 543 544
  (if vc-dired-mode
      (set-buffer (find-file-noselect (dired-get-filename)))
    (while vc-parent-buffer
      (pop-to-buffer vc-parent-buffer))
    (if (not (buffer-file-name))
	(error "Buffer %s is not associated with a file" (buffer-name))
      (if (not (vc-backend (buffer-file-name)))
	  (error "File %s is not under version control" (buffer-file-name))))))
545

Eric S. Raymond's avatar
Eric S. Raymond committed
546
(defvar vc-binary-assoc nil)
547 548 549 550
(defvar vc-binary-suffixes
  (if (memq system-type '(ms-dos windows-nt))
      '(".exe" ".com" ".bat" ".cmd" ".btm" "")
    '("")))
551 552

(defun vc-process-filter (p s)
553
  "An alternative output filter for async process P.
554 555 556 557 558 559 560 561 562
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)
563
  "Prepare BUF for executing a VC command and make it the current buffer.
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
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))
596
	       ,@(append (cdr (cdr (cdr ;strip off `with-current-buffer buf
597 598 599 600 601 602 603 604 605 606 607 608 609
                                        ;             (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
and is passed 3 argument: the COMMAND, the FILE and the FLAGS.")

(defun vc-do-command (buffer okstatus command file &rest flags)
610
  "Execute a version control command, notifying user and checking for errors.
611 612
Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil or the current
buffer (which is assumed to be properly setup) if BUFFER is t.  The
613
command is considered successful if its exit status does not exceed
614 615
OKSTATUS (if OKSTATUS is nil, that means to ignore errors, if it is 'async,
that means not to wait for termination of the subprocess).  FILE is
616
the name of the working file (may also be nil, to execute commands
617
that don't expect a file name).  If an optional list of FLAGS is present,
618
that is inserted into the command line before the filename."
619
  (and file (setq file (expand-file-name file)))
Eric S. Raymond's avatar
Eric S. Raymond committed
620
  (if vc-command-messages
621
      (message "Running %s on %s..." command file))
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
  (save-current-buffer
    (unless (eq buffer t) (vc-setup-buffer buffer))
    (let ((squeezed nil)
	  (inhibit-read-only t)
	  (status 0))
      (setq squeezed (delq nil (copy-sequence flags)))
      (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))
	(if (eq okstatus 'async)
	    (let ((proc (apply 'start-process command (current-buffer) command
			       squeezed)))
	      (message "Running %s in the background..." command)
	      ;;(set-process-sentinel proc (lambda (p msg) (delete-process p)))
	      (set-process-filter proc 'vc-process-filter)
	      (vc-exec-after
	       `(message "Running %s in the background... done" ',command)))
	  (setq status (apply 'call-process command nil t nil squeezed))
	  (when (or (not (integerp status)) (and okstatus (< okstatus status)))
	    (pop-to-buffer (current-buffer))
	    (goto-char (point-min))
	    (shrink-window-if-larger-than-buffer)
	    (error "Running %s...FAILED (%s)" command
		   (if (integerp status) (format "status %d" status) status))))
	(if vc-command-messages
	    (message "Running %s...OK" command)))
      (vc-exec-after
       `(run-hook-with-args 'vc-post-command-functions ',command ',file ',flags))
      status)))
Eric S. Raymond's avatar
Eric S. Raymond committed
661

662
(defun vc-position-context (posn)
663 664 665
  "Save a bit of the text around POSN in the current buffer.
Used to help us find the corresponding position again later
if markers are destroyed or corrupted."
666 667
  ;; A lot of this was shamelessly lifted from Sebastian Kremer's
  ;; rcs.el mode.
668 669 670 671 672 673
  (list posn
	(buffer-size)
	(buffer-substring posn
			  (min (point-max) (+ posn 100)))))

(defun vc-find-position-by-context (context)
674
  "Return the position of CONTEXT in the current buffer, or nil if not found."
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691
  (let ((context-string (nth 2 context)))
    (if (equal "" context-string)
	(point-max)
      (save-excursion
	(let ((diff (- (nth 1 context) (buffer-size))))
	  (if (< diff 0) (setq diff (- diff)))
	  (goto-char (nth 0 context))
	  (if (or (search-forward context-string nil t)
		  ;; Can't use search-backward since the match may continue
		  ;; after point.
		  (progn (goto-char (- (point) diff (length context-string)))
			 ;; goto-char doesn't signal an error at
			 ;; beginning of buffer like backward-char would
			 (search-forward context-string nil t)))
	      ;; to beginning of OSTRING
	      (- (point) (length context-string))))))))

692
(defun vc-context-matches-p (posn context)
693
  "Return t if POSN matches CONTEXT, nil otherwise."
694 695 696 697 698 699 700
  (let* ((context-string (nth 2 context))
	 (len (length context-string))
	 (end (+ posn len)))
    (if (> end (1+ (buffer-size)))
	nil
      (string= context-string (buffer-substring posn end)))))

701
(defun vc-buffer-context ()
702 703
  "Return a list (POINT-CONTEXT MARK-CONTEXT REPARSE).
Used by `vc-restore-buffer-context' to later restore the context."
704
  (let ((point-context (vc-position-context (point)))
705 706 707 708
	;; Use mark-marker to avoid confusion in transient-mark-mode.
	(mark-context  (if (eq (marker-buffer (mark-marker)) (current-buffer))
			   (vc-position-context (mark-marker))))
	;; Make the right thing happen in transient-mark-mode.
709 710 711 712 713 714 715 716
	(mark-active nil)
	;; We may want to reparse the compilation buffer after revert
	(reparse (and (boundp 'compilation-error-list) ;compile loaded
		      (let ((curbuf (current-buffer)))
			;; Construct a list; each elt is nil or a buffer
			;; iff that buffer is a compilation output buffer
			;; that contains markers into the current buffer.
			(save-excursion
717
			  (mapcar (lambda (buffer)
718 719 720 721 722
				    (set-buffer buffer)
				    (let ((errors (or
						   compilation-old-error-list
						   compilation-error-list))
					  (buffer-error-marked-p nil))
723
				      (while (and (consp errors)
724
						  (not buffer-error-marked-p))
725
					(and (markerp (cdr (car errors)))
726 727
					     (eq buffer
						 (marker-buffer
728
						  (cdr (car errors))))
729
					     (setq buffer-error-marked-p t))
730
					(setq errors (cdr errors)))
731
				      (if buffer-error-marked-p buffer)))
732
				  (buffer-list)))))))
733 734 735
    (list point-context mark-context reparse)))

(defun vc-restore-buffer-context (context)
736
  "Restore point/mark, and reparse any affected compilation buffers.
737
CONTEXT is that which `vc-buffer-context' returns."
738 739 740
  (let ((point-context (nth 0 context))
	(mark-context (nth 1 context))
	(reparse (nth 2 context)))
741 742 743
    ;; Reparse affected compilation buffers.
    (while reparse
      (if (car reparse)
744
	  (with-current-buffer (car reparse)
745 746 747 748 749 750 751 752 753 754
	    (let ((compilation-last-buffer (current-buffer)) ;select buffer
		  ;; Record the position in the compilation buffer of
		  ;; the last error next-error went to.
		  (error-pos (marker-position
			      (car (car-safe compilation-error-list)))))
	      ;; Reparse the error messages as far as they were parsed before.
	      (compile-reinitialize-errors '(4) compilation-parsing-end)
	      ;; Move the pointer up to find the error we were at before
	      ;; reparsing.  Now next-error should properly go to the next one.
	      (while (and compilation-error-list
755
			  (/= error-pos (car (car compilation-error-list))))
756 757
		(setq compilation-error-list (cdr compilation-error-list))))))
      (setq reparse (cdr reparse)))
758

759 760 761 762
    ;; if necessary, restore point and mark
    (if (not (vc-context-matches-p (point) point-context))
	(let ((new-point (vc-find-position-by-context point-context)))
	  (if new-point (goto-char new-point))))
763 764 765 766 767
    (and mark-active
         mark-context
         (not (vc-context-matches-p (mark) mark-context))
         (let ((new-mark (vc-find-position-by-context mark-context)))
           (if new-mark (set-mark new-mark))))))
768

769
(defun vc-revert-buffer1 (&optional arg no-confirm)
770 771 772 773
  "Revert buffer, trying to keep point and mark where user expects them.
Tries to be clever in the face of changes due to expanded version control
key words.  This is important for typeahead to work as expected.
ARG and NO-CONFIRM are passed on to `revert-buffer'."
774 775 776
  (interactive "P")
  (widen)
  (let ((context (vc-buffer-context)))
777 778
    ;; Use save-excursion here, because it may be able to restore point
    ;; and mark properly even in cases where vc-restore-buffer-context
779
    ;; would fail.  However, save-excursion might also get it wrong --
780 781
    ;; in this case, vc-restore-buffer-context gives it a second try.
    (save-excursion
782
      ;; t means don't call normal-mode;
783 784
      ;; that's to preserve various minor modes.
      (revert-buffer arg no-confirm t))
785 786
    (vc-restore-buffer-context context)))

Eric S. Raymond's avatar
Eric S. Raymond committed
787

788
(defun vc-buffer-sync (&optional not-urgent)
789
  "Make sure the current buffer and its working file are in sync.
790
NOT-URGENT means it is ok to continue if the user says not to save."
791
  (if (buffer-modified-p)
792 793 794
      (if (or vc-suppress-confirm
	      (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
	  (save-buffer)
795
	(unless not-urgent
796 797
	  (error "Aborted")))))

798
(defun vc-workfile-unchanged-p (file)
799
  "Has FILE changed since last checkout?"
Eric S. Raymond's avatar
Eric S. Raymond committed
800
  (let ((checkout-time (vc-file-getprop file 'vc-checkout-time))
801 802 803 804 805 806
        (lastmod (nth 5 (file-attributes file))))
    (if checkout-time
        (equal checkout-time lastmod)
      (let ((unchanged (vc-call workfile-unchanged-p file)))
        (vc-file-setprop file 'vc-checkout-time (if unchanged lastmod 0))
        unchanged))))
807

808
(defun vc-default-workfile-unchanged-p (file)
809
  "Default check whether FILE is unchanged: diff against master version."
810
  (zerop (vc-call diff file (vc-workfile-version file))))
Eric S. Raymond's avatar
Eric S. Raymond committed
811

812 813 814 815 816
(defun vc-recompute-state (file)
  "Force a recomputation of the version control state of FILE.
The state is computed using the exact, and possibly expensive
function `vc-BACKEND-state', not the heuristic."
  (vc-file-setprop file 'vc-state (vc-call state file)))
817

818 819 820 821 822 823 824 825 826 827 828 829
(defun vc-next-action-on-file (file verbose &optional comment)
  "Do The Right Thing for a given version-controlled FILE.
If COMMENT is specified, it will be used as an admin or checkin comment.
If VERBOSE is non-nil, query the user rather than using default parameters."
  (let ((visited (get-file-buffer file))
	state version)
    (when visited
      ;; Check relation of buffer and file, and make sure
      ;; user knows what he's doing.  First, finding the file
      ;; will check whether the file on disk is newer.
      (if vc-dired-mode
	  (find-file-other-window file)
830
	(set-buffer (find-file-noselect file)))
831 832 833 834 835 836 837 838 839
      (if (not (verify-visited-file-modtime (current-buffer)))
	  (if (yes-or-no-p "Replace file on disk with buffer contents? ")
	      (write-file (buffer-file-name))
	    (error "Aborted"))
	;; Now, check if we have unsaved changes.
	(vc-buffer-sync t)
	(if (buffer-modified-p)
	    (or (y-or-n-p "Operate on disk file, keeping modified buffer? ")
		(error "Aborted")))))
840

841
    ;; Do the right thing
842
    (if (not (vc-registered file))
843 844
	(vc-register verbose comment)
      (vc-recompute-state file)
845
      (if visited (vc-mode-line file))
846 847 848 849 850 851 852 853
      (setq state (vc-state file))
      (cond
       ;; up-to-date
       ((or (eq state 'up-to-date)
	    (and verbose (eq state 'needs-patch)))
	(cond
	 (verbose
	  ;; go to a different version
854
	  (setq version
855
		(read-string "Branch, version, or backend to move to: "))
856
	  (let ((vsym (intern-soft (upcase version))))
857 858
	    (if (member vsym vc-handled-backends)
		(vc-transfer-file file vsym)
859
	      (vc-checkout file (eq (vc-checkout-model file) 'implicit)
860
			   version))))
861 862 863 864 865 866
	 ((not (eq (vc-checkout-model file) 'implicit))
	  ;; check the file out
	  (vc-checkout file t))
	 (t
	  ;; do nothing
	  (message "%s is up-to-date" file))))
867

868 869 870 871 872 873 874 875
       ;; Abnormal: edited but read-only
       ((and visited (eq state 'edited) buffer-read-only)
	;; Make the file+buffer read-write.  If the user really wanted to
	;; commit, he'll get a chance to do that next time around, anyway.
	(message "File is edited but read-only; making it writable")
	(set-file-modes buffer-file-name
			(logior (file-modes buffer-file-name) 128))
	(toggle-read-only -1))
876

877 878
       ;; edited
       ((eq state 'edited)
879
	(cond
880 881 882 883 884 885 886 887 888 889 890 891 892 893
	 ;; For files with locking, if the file does not contain
	 ;; any changes, just let go of the lock, i.e. revert.
	 ((and (not (eq (vc-checkout-model file) 'implicit))
	       (vc-workfile-unchanged-p file)
	       ;; If buffer is modified, that means the user just
	       ;; said no to saving it; in that case, don't revert,
	       ;; because the user might intend to save after
	       ;; finishing the log entry.
	       (not (and visited (buffer-modified-p))))
	  ;; DO NOT revert the file without asking the user!
	  (if (not visited) (find-file-other-window file))
	  (if (yes-or-no-p "Revert to master version? ")
	      (vc-revert-buffer)))
	 (t ;; normal action
894 895 896 897 898 899 900
	  (if (not verbose)
	      (vc-checkin file nil comment)
	    (setq version (read-string "New version or backend: "))
	    (let ((vsym (intern (upcase version))))
	      (if (member vsym vc-handled-backends)
		  (vc-transfer-file file vsym)
		(vc-checkin file version comment)))))))
901

902 903 904 905 906 907 908 909 910
       ;; locked by somebody else
       ((stringp state)
	(if comment
	    (error "Sorry, you can't steal the lock on %s this way"
		   (file-name-nondirectory file)))
	(vc-steal-lock file
                       (if verbose (read-string "Version to steal: ")
                         (vc-workfile-version file))
		       state))
911

912 913
       ;; needs-patch
       ((eq state 'needs-patch)
914
	(if (yes-or-no-p (format
915 916 917 918 919 920 921
			  "%s is not up-to-date.  Get latest version? "
			  (file-name-nondirectory file)))
	    (vc-checkout file (eq (vc-checkout-model file) 'implicit) "")
	  (if (and (not (eq (vc-checkout-model file) 'implicit))
		   (yes-or-no-p "Lock this version? "))
	      (vc-checkout file t)
	    (error "Aborted"))))
922

923 924
       ;; needs-merge
       ((eq state 'needs-merge)
925
	(if (yes-or-no-p (format
926 927 928 929
			  "%s is not up-to-date.  Merge in changes now? "
			  (file-name-nondirectory file)))
	    (vc-maybe-resolve-conflicts file (vc-call merge-news file))
	  (error "Aborted")))
930

931 932 933 934 935 936
       ;; unlocked-changes
       ((eq state 'unlocked-changes)
	(if (not visited) (find-file-other-window file))
	(if (save-window-excursion
	      (vc-version-diff file (vc-workfile-version file) nil)
	      (goto-char (point-min))
937 938 939
	      (let ((inhibit-read-only t))
		(insert-string
		 (format "Changes to %s since last lock:\n\n" file)))
940 941 942 943 944 945 946 947 948 949 950 951 952
	      (not (beep))
	      (yes-or-no-p (concat "File has unlocked changes.  "
				   "Claim lock retaining changes? ")))
	    (progn (vc-call steal-lock file)
		   ;; Must clear any headers here because they wouldn't
		   ;; show that the file is locked now.
		   (vc-clear-headers file)
		   (vc-mode-line file))
	  (if (not (yes-or-no-p
		    "Revert to checked-in version, instead? "))
	      (error "Checkout aborted")
	    (vc-revert-buffer1 t t)
	    (vc-checkout file t))))))))
953

954 955
(defvar vc-dired-window-configuration)

956
(defun vc-next-action-dired (file rev comment)
957 958
  "Call `vc-next-action-on-file' on all the marked files.
Ignores FILE and REV, but passes on COMMENT."
959
  (let ((dired-buffer (current-buffer))
960
	(dired-dir default-directory))
961
    (dired-map-over-marks
962
     (let ((file (dired-get-filename)))
963
       (message "Processing %s..." file)
964 965
       (vc-next-action-on-file file nil comment)
       (set-buffer dired-buffer)
966
       (set-window-configuration vc-dired-window-configuration)
967
       (message "Processing %s...done" file))
968 969
    nil t))
  (dired-move-to-filename))
970

Jim Blandy's avatar
Jim Blandy committed
971
;; Here's the major entry point.
Eric S. Raymond's avatar
Eric S. Raymond committed
972

Jim Blandy's avatar
Jim Blandy committed
973
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
974 975
(defun vc-next-action (verbose)
  "Do the next logical checkin or checkout operation on the current file.
976 977

If you call this from within a VC dired buffer with no files marked,
978
it will operate on the file in the current line.
979 980

If you call this from within a VC dired buffer, and one or more
981 982 983 984
files are marked, it will accept a log message and then operate on
each one.  The log message will be used as a comment for any register
or checkin operations, but ignored when doing checkouts.  Attempted
lock steals will raise an error.
985 986

A prefix argument lets you specify the version number to use.
987 988

For RCS and SCCS files:
Eric S. Raymond's avatar
Eric S. Raymond committed
989
   If the file is not already registered, this registers it for version
990
control.
Eric S. Raymond's avatar
Eric S. Raymond committed
991
   If the file is registered and not locked by anyone, this checks out
992
a writable and locked file ready for editing.
Eric S. Raymond's avatar
Eric S. Raymond committed
993 994 995
   If the file is checked out and locked by the calling user, this
first checks to see if the file has changed since checkout.  If not,
it performs a revert.
996 997
   If the file has been changed, this pops up a buffer for entry
of a log message; when the message has been entered, it checks in the
Eric S. Raymond's avatar
Eric S. Raymond committed
998
resulting changes along with the log message as change commentary.  If
999
the variable `vc-keep-workfiles' is non-nil (which is its default), a
Eric S. Raymond's avatar
Eric S. Raymond committed
1000 1001
read-only copy of the changed file is left in place afterwards.
   If the file is registered and locked by someone else, you are given
1002
the option to steal the lock.
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012

For CVS files:
   If the file is not already registered, this registers it for version
control.  This does a \"cvs add\", but no \"cvs commit\".
   If the file is added but not committed, it is committed.
   If your working file is changed, but the repository file is
unchanged, this pops up a buffer for entry of a log message; when the
message has been entered, it checks in the resulting changes along
with the logmessage as change commentary.  A writable file is retained.
   If the repository file is changed, you are asked if you want to
1013
merge in the changes into your working copy."
1014

Eric S. Raymond's avatar
Eric S. Raymond committed
1015
  (interactive "P")
1016 1017 1018
  (catch 'nogo
    (if vc-dired-mode
	(let ((files (dired-get-marked-files)))
1019 1020
          (set (make-local-variable 'vc-dired-window-configuration)
               (current-window-configuration))
1021
	  (if (string= ""
1022
		 (mapconcat
1023 1024
	             (lambda (f)