vc.el 124 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.292 2000/11/20 14:01:35 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
;;;;;;;;;;;;;;;;; Backend-specific functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
77 78 79 80 81 82 83
;; For each operation FUN, the backend should provide a function 
;; vc-BACKEND-FUN.  Operations marked with a `-' instead of a `*' 
;; are optional.

;;;
;;; State-querying functions
;;;
84 85 86 87 88 89

;; * registered (file)
;; * state (file)
;; - state-heuristic (file)
;;     The default behavior delegates to `state'.
;; - dir-state (dir)
90 91
;; * workfile-version (file)
;; * latest-on-branch-p (file)
92
;; * checkout-model (file)
93 94 95 96 97 98
;; - 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.
99
;; - mode-line-string (file)
100 101 102 103 104 105
;; - dired-state-info (file)

;;; 
;;; State-changing functions
;;;

106
;; * register (file rev comment)
107
;; - responsible-p (file)
108 109
;;     Should also work if FILE is a directory (ends with a slash).
;; - could-register (file)
110 111 112
;; - receive-file (file rev)
;; - unregister (file backend)
;; * checkin (file rev comment)
113 114 115 116 117
;; * 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.
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
;; * revert (file)
;; - cancel-version (file writable)
;; - merge (file rev1 rev2)
;; - merge-news (file)
;;     Only needed if state `needs-merge' is possible.
;; - steal-lock (file &optional version)
;;     Only required if files can be locked by somebody else.

;;;
;;; History functions
;;;

;; * print-log (file)
;;     Insert the revision log of FILE into the current buffer.
;; - show-log-entry (version)
;; - wash-log (file)
;;     Remove all non-comment information from the output of print-log
135
;; - logentry-check ()
136 137 138 139
;; - comment-history (file)
;; - update-changelog (files)
;;     Find changelog entries for FILES, or for all files at or below
;;     the default-directory if FILES is nil.
140 141 142 143 144 145
;; * 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).
146 147 148 149 150 151 152 153
;; - annotate-command (file buf rev)
;; - annotate-difference (pos)
;;     Only required if `annotate-command' is defined for the backend.

;;;
;;; Snapshot system
;;;

154
;; - create-snapshot (dir name branchp)
155 156 157 158 159 160 161
;;     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'.
162 163 164 165 166
;; * 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.
167
;;     If UPDATE is non-nil, then update buffers of any files in the snapshot
168
;;     that are currently visited.
169 170 171 172 173 174 175 176

;;;
;;; Miscellaneous
;;;

;; - make-version-backups-p (file)
;; - check-headers ()
;; - clear-headers ()
177
;; - rename-file (old new)
178 179 180


;;;;;;;;;;;;;;; End of backend-specific functions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;
181

Eric S. Raymond's avatar
Eric S. Raymond committed
182
(require 'vc-hooks)
183
(require 'ring)
184
(eval-when-compile
185
  (require 'cl)
186 187 188
  (require 'compile)
  (require 'dired)      ; for dired-map-over-marks macro
  (require 'dired-aux))	; for dired-kill-{line,tree}
189 190 191 192 193

(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
194 195 196

;; General customization

197 198 199 200 201 202 203 204 205
(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)

206 207 208 209 210 211 212 213
(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)

214 215 216 217 218
(defcustom vc-initial-comment nil
  "*If non-nil, prompt for initial comment when a file is registered."
  :type 'boolean
  :group 'vc)

219 220
(defcustom vc-default-init-version "1.1"
  "*A string used as the default version number when a new file is registered.
221
This can be overridden by giving a prefix argument to \\[vc-register]."
222
  :type 'string
Dan Nicolaescu's avatar
Dan Nicolaescu committed
223 224
  :group 'vc
  :version "20.3")
225

226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
(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)

261 262 263 264
(defcustom vc-dired-listing-switches "-al"
  "*Switches passed to `ls' for vc-dired.  MUST contain the `l' option."
  :type 'string
  :group 'vc
265
  :version "21.1")
266

267 268 269 270 271 272 273 274 275 276 277 278
(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")

279 280 281 282
(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)
283

284 285 286
(defconst vc-maximum-comment-ring-size 32
  "Maximum number of saved comments in the comment ring.")

287 288
;;; This is duplicated in diff.el.
(defvar diff-switches "-c"
289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
  "*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)
312

313
;; Annotate customization
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
(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."
335
  :type 'alist
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
  :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'."
352
  :type '(repeat number)
353 354
  :group 'vc)

355 356 357
;; vc-annotate functionality (CVS only).
(defvar vc-annotate-mode nil
  "Variable indicating if VC-Annotate mode is active.")
358

359 360 361 362 363
(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.")
364

365 366
(defvar vc-annotate-mode-menu nil
  "Local keymap used for VC-Annotate mode's menu bar menu.")
367

Eric S. Raymond's avatar
Eric S. Raymond committed
368 369
;; Header-insertion hair

370
(defcustom vc-static-header-alist
Eric S. Raymond's avatar
Eric S. Raymond committed
371 372
  '(("\\.c$" .
     "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n"))
373 374
  "*Associate static header string templates with file types.
A \%s in the template is replaced with the first string associated with
375
the file's version control type in `vc-header-alist'."
376 377 378 379
  :type '(repeat (cons :format "%v"
		       (regexp :tag "File Type")
		       (string :tag "Header String")))
  :group 'vc)
380

381
(defcustom vc-comment-alist
Eric S. Raymond's avatar
Eric S. Raymond committed
382 383
  '((nroff-mode ".\\\"" ""))
  "*Special comment delimiters to be used in generating vc headers only.
384 385
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
386 387 388 389 390 391
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
392

393
;; Default is to be extra careful for super-user.
394 395
;; TODO: This variable is no longer used; the corresponding checks
;;       are always done now.  If that turns out to be fast enough,
396
;;       the variable can be obsoleted.
397
(defcustom vc-checkout-carefully (= (user-uid) 0)
398 399
  "*Non-nil means be extra-careful in checkout.
Verify that the file really is not locked
400 401 402
and that its contents match what the master file says."
  :type 'boolean
  :group 'vc)
403

404 405 406 407 408 409

;;; The main keymap

(defvar vc-prefix-map
  (let ((map (make-sparse-keymap)))
    (define-key map "a" 'vc-update-change-log)
410
    (define-key map "b" 'vc-switch-backend)
411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
    (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)
426

427 428 429 430 431 432 433 434 435 436 437
;; 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)
438

439

Eric S. Raymond's avatar
Eric S. Raymond committed
440 441
;; Variables the user doesn't need to know about.
(defvar vc-log-operation nil)
442
(defvar vc-log-after-operation-hook nil)
443
(defvar vc-annotate-buffers nil
444 445
  "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
446 447 448
;; 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).
449
(defvar vc-parent-buffer nil)
450
(put 'vc-parent-buffer 'permanent-local t)
451
(defvar vc-parent-buffer-name nil)
452
(put 'vc-parent-buffer-name 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
453

454 455 456
(defvar vc-log-file)
(defvar vc-log-version)

457
(defvar vc-dired-mode nil)
458 459
(make-variable-buffer-local 'vc-dired-mode)

460
(defvar vc-comment-ring (make-ring vc-maximum-comment-ring-size))
461
(defvar vc-comment-ring-index nil)
462
(defvar vc-last-comment-match "")
463

464 465 466
;;; 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.
467
(defun vc-trunk-p (rev)
468
  "Return t if REV is a revision on the trunk."
469 470
  (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev))))

471
(defun vc-branch-p (rev)
472
  "Return t if REV is a branch revision."
473 474
  (not (eq nil (string-match "\\`[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*\\'" rev))))

475
(defun vc-branch-part (rev)
476
  "Return the branch part of a revision number REV."
477 478
  (substring rev 0 (string-match "\\.[0-9]+\\'" rev)))

479
(defun vc-minor-part (rev)
480
  "Return the minor version number of a revision number REV."
481 482 483 484
  (string-match "[0-9]+\\'" rev)
  (substring rev (match-beginning 0) (match-end 0)))

(defun vc-previous-version (rev)
485
  "Guess the version number immediately preceding REV."
486 487 488 489 490 491 492 493 494 495 496 497 498
  (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
499 500
;; File property caching

501 502 503 504 505 506
(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.
507
  (setq vc-comment-ring (make-ring vc-maximum-comment-ring-size)))
508

509
(defmacro with-vc-properties (file form settings)
510 511 512 513
  "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)."
514 515 516 517
  `(let ((vc-touched-properties (list t))
	 (filename ,file))
     ,form
     (mapcar (lambda (setting)
518
	       (let ((property (car setting)))
519
		 (unless (memq property vc-touched-properties)
520
		   (put (intern filename vc-file-prop-obarray)
521
			property (cdr setting)))))
522 523
	     ,settings)))

Eric S. Raymond's avatar
Eric S. Raymond committed
524 525
;; Random helper functions

526 527
(defsubst vc-editable-p (file)
  (or (eq (vc-checkout-model file) 'implicit)
528
      (memq (vc-state file) '(edited needs-merge))))
529

530 531 532
;;; Two macros for elisp programming
;;;###autoload
(defmacro with-vc-file (file comment &rest body)
533 534 535 536
  "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
537 538
somebody else, signal error."
  `(let ((file (expand-file-name ,file)))
539
     (or (vc-backend file)
540
	 (error (format "File not under version control: `%s'" file)))
541 542 543 544
     (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))))
545 546 547
     (save-excursion
       ,@body)
     (vc-checkin file nil ,comment)))
548
(put 'with-vc-file 'indent-function 1)
549 550 551

;;;###autoload
(defmacro edit-vc-file (file comment &rest body)
552 553
  "Edit FILE under version control, executing body.
Checkin with COMMENT after executing BODY.
554 555 556 557
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
558
    (set-buffer (find-file-noselect ,file))
559 560
    ,@body
    (save-buffer)))
561
(put 'edit-vc-file 'indent-function 1)
562

563
(defun vc-ensure-vc-buffer ()
564
  "Make sure that the current buffer visits a version-controlled file."
565 566 567 568 569 570 571 572
  (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))))))
573

Eric S. Raymond's avatar
Eric S. Raymond committed
574
(defvar vc-binary-assoc nil)
575 576 577 578
(defvar vc-binary-suffixes
  (if (memq system-type '(ms-dos windows-nt))
      '(".exe" ".com" ".bat" ".cmd" ".btm" "")
    '("")))
579 580

(defun vc-process-filter (p s)
581
  "An alternative output filter for async process P.
582 583 584 585 586 587 588 589 590
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)
591
  "Prepare BUF for executing a VC command and make it the current buffer.
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
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))
624
	       ,@(append (cdr (cdr (cdr ;strip off `with-current-buffer buf
625 626 627 628 629 630 631 632 633 634 635 636 637
                                        ;             (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)
638
  "Execute a version control command, notifying user and checking for errors.
639 640
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
641
command is considered successful if its exit status does not exceed
642 643
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
644
the name of the working file (may also be nil, to execute commands
645
that don't expect a file name).  If an optional list of FLAGS is present,
646
that is inserted into the command line before the filename."
647
  (and file (setq file (expand-file-name file)))
Eric S. Raymond's avatar
Eric S. Raymond committed
648
  (if vc-command-messages
649
      (message "Running %s on %s..." command file))
650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671
  (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)))
672 673
              (unless (active-minibuffer-window)
                (message "Running %s in the background..." command))
674 675 676
	      ;;(set-process-sentinel proc (lambda (p msg) (delete-process p)))
	      (set-process-filter proc 'vc-process-filter)
	      (vc-exec-after
677 678
	       `(unless (active-minibuffer-window)
                  (message "Running %s in the background... done" ',command))))
679 680 681 682 683 684 685 686 687 688 689 690
	  (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
691

692
(defun vc-position-context (posn)
693 694 695
  "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."
696 697
  ;; A lot of this was shamelessly lifted from Sebastian Kremer's
  ;; rcs.el mode.
698 699 700 701 702 703
  (list posn
	(buffer-size)
	(buffer-substring posn
			  (min (point-max) (+ posn 100)))))

(defun vc-find-position-by-context (context)
704
  "Return the position of CONTEXT in the current buffer, or nil if not found."
705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721
  (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))))))))

722
(defun vc-context-matches-p (posn context)
723
  "Return t if POSN matches CONTEXT, nil otherwise."
724 725 726 727 728 729 730
  (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)))))

731
(defun vc-buffer-context ()
732 733
  "Return a list (POINT-CONTEXT MARK-CONTEXT REPARSE).
Used by `vc-restore-buffer-context' to later restore the context."
734
  (let ((point-context (vc-position-context (point)))
735 736 737 738
	;; 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.
739 740 741 742 743 744 745 746
	(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
747
			  (mapcar (lambda (buffer)
748 749 750 751 752
				    (set-buffer buffer)
				    (let ((errors (or
						   compilation-old-error-list
						   compilation-error-list))
					  (buffer-error-marked-p nil))
753
				      (while (and (consp errors)
754
						  (not buffer-error-marked-p))
755
					(and (markerp (cdr (car errors)))
756 757
					     (eq buffer
						 (marker-buffer
758
						  (cdr (car errors))))
759
					     (setq buffer-error-marked-p t))
760
					(setq errors (cdr errors)))
761
				      (if buffer-error-marked-p buffer)))
762
				  (buffer-list)))))))
763 764 765
    (list point-context mark-context reparse)))

(defun vc-restore-buffer-context (context)
766
  "Restore point/mark, and reparse any affected compilation buffers.
767
CONTEXT is that which `vc-buffer-context' returns."
768 769 770
  (let ((point-context (nth 0 context))
	(mark-context (nth 1 context))
	(reparse (nth 2 context)))
771 772 773
    ;; Reparse affected compilation buffers.
    (while reparse
      (if (car reparse)
774
	  (with-current-buffer (car reparse)
775 776 777 778 779 780 781 782 783 784
	    (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
785
			  (/= error-pos (car (car compilation-error-list))))
786 787
		(setq compilation-error-list (cdr compilation-error-list))))))
      (setq reparse (cdr reparse)))
788

789 790 791 792
    ;; 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))))
793 794 795 796 797
    (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))))))
798

799
(defun vc-revert-buffer1 (&optional arg no-confirm)
800 801 802 803
  "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'."
804 805 806
  (interactive "P")
  (widen)
  (let ((context (vc-buffer-context)))
807 808
    ;; Use save-excursion here, because it may be able to restore point
    ;; and mark properly even in cases where vc-restore-buffer-context
809
    ;; would fail.  However, save-excursion might also get it wrong --
810 811
    ;; in this case, vc-restore-buffer-context gives it a second try.
    (save-excursion
812
      ;; t means don't call normal-mode;
813 814
      ;; that's to preserve various minor modes.
      (revert-buffer arg no-confirm t))
815 816
    (vc-restore-buffer-context context)))

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

818
(defun vc-buffer-sync (&optional not-urgent)
819
  "Make sure the current buffer and its working file are in sync.
820
NOT-URGENT means it is ok to continue if the user says not to save."
821
  (if (buffer-modified-p)
822 823 824
      (if (or vc-suppress-confirm
	      (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name))))
	  (save-buffer)
825
	(unless not-urgent
826 827
	  (error "Aborted")))))

André Spiegel's avatar
André Spiegel committed
828 829 830 831 832 833 834 835 836 837 838 839 840 841
(defun vc-workfile-unchanged-p (file)
  "Has FILE changed since last checkout?"
  (let ((checkout-time (vc-file-getprop file 'vc-checkout-time))
        (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))))

(defun vc-default-workfile-unchanged-p (file)
  "Default check whether FILE is unchanged: diff against master version."
  (zerop (vc-call diff file (vc-workfile-version file))))

842 843 844 845 846
(defun vc-default-latest-on-branch-p (file)
  "Default check whether the current workfile version of FILE is the 
latest on its branch."
  t)

847 848 849 850 851
(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)))
852

853 854 855 856 857 858 859 860 861 862 863 864
(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)
865
	(set-buffer (find-file-noselect file)))
866 867 868 869 870 871 872 873 874
      (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")))))
875

876
    ;; Do the right thing
877
    (if (not (vc-registered file))
878 879
	(vc-register verbose comment)
      (vc-recompute-state file)
880
      (if visited (vc-mode-line file))
881 882 883 884 885 886 887 888
      (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
889
	  (setq version
890
		(read-string "Branch, version, or backend to move to: "))
891
	  (let ((vsym (intern-soft (upcase version))))
892 893
	    (if (member vsym vc-handled-backends)
		(vc-transfer-file file vsym)
894
	      (vc-checkout file (eq (vc-checkout-model file) 'implicit)
895
			   version))))
896 897 898 899 900 901
	 ((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))))
902

903 904 905 906 907 908 909 910
       ;; 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))
911

912 913
       ;; edited
       ((eq state 'edited)
914
	(cond
915 916 917 918 919 920 921 922 923 924 925 926 927 928
	 ;; 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
929 930 931 932 933 934 935
	  (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)))))))
936

937 938 939 940 941 942 943 944 945
       ;; 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))
946

947 948
       ;; needs-patch
       ((eq state 'needs-patch)
949
	(if (yes-or-no-p (format
950 951 952 953 954 955 956
			  "%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"))))
957

958 959
       ;; needs-merge
       ((eq state 'needs-merge)
960
	(if (yes-or-no-p (format
961 962 963 964
			  "%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")))
965

966 967 968 969 970 971
       ;; 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))
972 973 974
	      (let ((inhibit-read-only t))
		(insert-string
		 (format "Changes to %s since last lock:\n\n" file)))
975 976 977 978 979 980 981 982 983 984 985 986 987
	      (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))))))))
988

989 990
(defvar vc-dired-window-configuration)

991
(defun vc-next-action-dired (file rev comment)
992 993
  "Call `vc-next-action-on-file' on all the marked files.
Ignores FILE and REV, but passes on COMMENT."
994
  (let ((dired-buffer (current-buffer))
995
	(dired-dir default-directory))
996
    (dired-map-over-marks
997
     (let ((file (dired-get-filename)))
998
       (message "Processing %s..." file)
999 1000
       (vc-next-action-on-file file nil comment)
       (set-buffer dired-buffer)
1001
       (set-window-configuration vc-dired-window-configuration)
1002
       (message "Processing %s...done" file))
1003 1004
    nil t))
  (dired-move-to-filename))
1005

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

Jim Blandy's avatar
Jim Blandy committed
1008
;;;###autoload
Eric S. Raymond's avatar
Eric S. Raymond committed
1009 1010
(defun vc-next-action (verbose)
  "Do the next logical checkin or checkout operation on the current file.
1011 1012

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

If you call this from within a VC dired buffer, and one or more
1016 1017 1018 1019
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.
1020 1021

A prefix argument lets you specify the version number to use.
1022 1023

For RCS and SCCS files:
Eric S. Raymond's avatar
Eric S. Raymond committed
1024
   If the file is not already registered, this registers it for version
1025
control.
Eric S. Raymond's avatar
Eric S. Raymond committed
1026
   If the file is registered and not locked by anyone, this checks out
1027
a writable and locked file ready for editing.
Eric S. Raymond's avatar
Eric S. Raymond committed
1028 1029 1030
   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.
1031 1032
   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
1033
resulting changes along with the log message as change commentary.  If
1034
the variable `vc-keep-workfiles' is non-nil (which is its default), a
Eric S. Raymond's avatar
Eric S. Raymond committed
1035 1036
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
1037
the option to steal the lock.