vc-hooks.el 30.7 KB
Newer Older
1
;;; vc-hooks.el --- resident support for version-control
Eric S. Raymond's avatar
Eric S. Raymond committed
2

3
;; Copyright (C) 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4 5

;; Author: Eric S. Raymond <esr@snark.thyrsus.com>
6 7 8
;; Modified by:
;;   Per Cederqvist <ceder@lysator.liu.se>
;;   Andre Spiegel <spiegel@berlin.informatik.uni-stuttgart.de>
Eric S. Raymond's avatar
Eric S. Raymond committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

;; 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
;; along with GNU Emacs; see the file COPYING.  If not, write to
;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.

;;; Commentary:

28 29 30
;; This is the always-loaded portion of VC.
;; It takes care VC-related activities that are done when you visit a file,
;; so that vc.el itself is loaded only when you use a VC command.
Eric S. Raymond's avatar
Eric S. Raymond committed
31 32 33 34
;; See the commentary of vc.el.

;;; Code:

35 36 37 38 39 40 41 42 43 44 45 46
;; Customization Variables (the rest is in vc.el)

(defvar vc-default-back-end nil
  "*Back-end actually used by this interface; may be SCCS or RCS.
The value is only computed when needed to avoid an expensive search.")

(defvar vc-path
  (if (file-directory-p "/usr/sccs")
      '("/usr/sccs")
    nil)
  "*List of extra directories to search for version control commands.")

Eric S. Raymond's avatar
Eric S. Raymond committed
47 48
(defvar vc-master-templates
  '(("%sRCS/%s,v" . RCS) ("%s%s,v" . RCS) ("%sRCS/%s" . RCS)
Richard M. Stallman's avatar
Richard M. Stallman committed
49 50
    ("%sSCCS/s.%s" . SCCS) ("%ss.%s". SCCS)
    vc-find-cvs-master)
Eric S. Raymond's avatar
Eric S. Raymond committed
51 52 53 54 55
  "*Where to look for version-control master files.
The first pair corresponding to a given back end is used as a template
when creating new masters.")

(defvar vc-make-backup-files nil
56
  "*If non-nil, backups of registered files are made as with other files.
57
If nil (the default), files covered by version control don't get backups.")
Eric S. Raymond's avatar
Eric S. Raymond committed
58

59 60
(defvar vc-display-status t
  "*If non-nil, display revision number and lock status in modeline.
61 62
Otherwise, not displayed.")

63 64 65 66 67 68 69 70 71 72 73
(defvar vc-consult-headers t
  "*Identify work files by searching for version headers.")

(defvar vc-mistrust-permissions nil
  "*Don't assume that permissions and ownership track version-control status.")

(defvar vc-keep-workfiles t
  "*If non-nil, don't delete working files after registering changes.
If the back-end is CVS, workfiles are always kept, regardless of the
value of this flag.")

Eric S. Raymond's avatar
Eric S. Raymond committed
74
;; Tell Emacs about this new kind of minor mode
Eric S. Raymond's avatar
Eric S. Raymond committed
75 76
(if (not (assoc 'vc-mode minor-mode-alist))
    (setq minor-mode-alist (cons '(vc-mode vc-mode)
Eric S. Raymond's avatar
Eric S. Raymond committed
77 78
				 minor-mode-alist)))

Eric S. Raymond's avatar
Eric S. Raymond committed
79
(make-variable-buffer-local 'vc-mode)
80
(put 'vc-mode 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
81

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99

;; branch identification

(defun vc-occurrences (object sequence)
  ;; return the number of occurences of OBJECT in SEQUENCE
  ;; (is it really true that Emacs Lisp doesn't provide such a function?)
  (let ((len (length sequence)) (index 0) (occ 0))
    (while (< index len)
      (if (eq object (elt sequence index))
	  (setq occ (1+ occ)))
      (setq index (1+ index)))
    occ))

(defun vc-branch-p (rev)
  ;; return t if REV is the branch part of a revision, 
  ;; i.e. a revision without a minor number
  (eq 0 (% (vc-occurrences ?. rev) 2)))

Eric S. Raymond's avatar
Eric S. Raymond committed
100
;; We need a notion of per-file properties because the version
101 102 103 104
;; control state of a file is expensive to derive --- we compute
;; them when the file is initially found, keep them up to date 
;; during any subsequent VC operations, and forget them when
;; the buffer is killed.
Eric S. Raymond's avatar
Eric S. Raymond committed
105

106 107 108
(defmacro vc-error-occurred (&rest body)
  (list 'condition-case nil (cons 'progn (append body '(nil))) '(error t)))

Eric S. Raymond's avatar
Eric S. Raymond committed
109 110 111
(defvar vc-file-prop-obarray [0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0]
  "Obarray for per-file properties.")

112 113 114
(defvar vc-buffer-backend t)
(make-variable-buffer-local 'vc-buffer-backend)

Eric S. Raymond's avatar
Eric S. Raymond committed
115 116 117 118 119 120 121 122
(defun vc-file-setprop (file property value)
  ;; set per-file property
  (put (intern file vc-file-prop-obarray) property value))

(defun vc-file-getprop (file property)
  ;; get per-file property
  (get (intern file vc-file-prop-obarray) property))

123 124 125
(defun vc-file-clearprops (file)
  ;; clear all properties of a given file
  (setplist (intern file vc-file-prop-obarray) nil))
126

127
;; basic properties 
128

129 130 131 132 133 134 135 136
(defun vc-name (file)
  "Return the master name of a file, nil if it is not registered."
  (or (vc-file-getprop file 'vc-name)
      (let ((name-and-type (vc-registered file)))
	(if name-and-type
	    (progn
	      (vc-file-setprop file 'vc-backend (cdr name-and-type))
	      (vc-file-setprop file 'vc-name (car name-and-type)))))))
137

138 139 140 141 142 143 144 145 146
(defun vc-backend (file)
  "Return the version-control type of a file, nil if it is not registered."
  (and file
       (or (vc-file-getprop file 'vc-backend)
	   (let ((name-and-type (vc-registered file)))
	     (if name-and-type
		 (progn
		   (vc-file-setprop file 'vc-name (car name-and-type))
		   (vc-file-setprop file 'vc-backend (cdr name-and-type))))))))
147

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 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 233 234 235 236 237 238 239
;; Functions for querying the master and lock files.

(defun vc-match-substring (bn)
  (buffer-substring (match-beginning bn) (match-end bn)))

(defun vc-lock-file (file)
  ;; Generate lock file name corresponding to FILE
  (let ((master (vc-name file)))
    (and
     master
     (string-match "\\(.*/\\)s\\.\\(.*\\)" master)
     (concat
      (substring master (match-beginning 1) (match-end 1))
      "p."
      (substring master (match-beginning 2) (match-end 2))))))

(defun vc-parse-buffer (patterns &optional file properties)
  ;; Use PATTERNS to parse information out of the current buffer.
  ;; Each element of PATTERNS is a list of 2 to 3 elements. The first element
  ;; is the pattern to be matched, and the second (an integer) is the 
  ;; number of the subexpression that should be returned. If there's
  ;; a third element (also the number of a subexpression), that 
  ;; subexpression is assumed to be a date field and we want the most
  ;; recent entry matching the template.
  ;; If FILE and PROPERTIES are given, the latter must be a list of
  ;; properties of the same length as PATTERNS; each property is assigned 
  ;; the corresponding value.
  (mapcar (function (lambda (p)
	    (goto-char (point-min))
	    (cond 
	     ((eq (length p) 2)  ;; search for first entry
	      (let ((value nil))
		(if (re-search-forward (car p) nil t)
		    (setq value (vc-match-substring (elt p 1))))
		(if file
		    (progn (vc-file-setprop file (car properties) value)
			   (setq properties (cdr properties))))
		value))
	     ((eq (length p) 3)  ;; search for latest entry
	      (let ((latest-date "") (latest-val))
		(while (re-search-forward (car p) nil t)
		  (let ((date (vc-match-substring (elt p 2))))
		    (if (string< latest-date date)
			(progn
			  (setq latest-date date)
			  (setq latest-val
				(vc-match-substring (elt p 1)))))))
		(if file
		    (progn (vc-file-setprop file (car properties) latest-val)
			   (setq properties (cdr properties))))
		latest-val)))))
	  patterns)
  )

(defun vc-master-info (file fields &optional rfile properties)
  ;; Search for information in a master file.
  (if (and file (file-exists-p file))
      (save-excursion
	(let ((buf))
	  (setq buf (create-file-buffer file))
	  (set-buffer buf))
	(erase-buffer)
	(insert-file-contents file)
	(set-buffer-modified-p nil)
	(auto-save-mode nil)
	(prog1
	    (vc-parse-buffer fields rfile properties)
	  (kill-buffer (current-buffer)))
	)
    (if rfile
	(mapcar
	 (function (lambda (p) (vc-file-setprop rfile p nil)))
	 properties))
    )
  )

(defun vc-log-info (command file flags patterns &optional properties)
  ;; Search for information in log program output.
  ;; If there is a string `\X' in any of the PATTERNS, replace
  ;; it with a regexp to search for a branch revision.
  (if (and file (file-exists-p file))
      (save-excursion
	;; Run the command (not using vc-do-command, as that is
        ;; only available within vc.el)
	;; Don't switch to the *vc* buffer before running the command
	;; because that would change its default-directory.
	(save-excursion (set-buffer (get-buffer-create "*vc*"))
			(erase-buffer))
	(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")
240 241
			     path-separator
			     (mapconcat 'identity vc-path path-separator))
242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573
		     process-environment)))
	  (apply 'call-process command nil "*vc*" nil 
		 (append flags (list (file-name-nondirectory file)))))
	(set-buffer (get-buffer "*vc*"))
	(set-buffer-modified-p nil)
	;; in the RCS case, insert branch version into
        ;; any patterns that contain \X
	(if (eq (vc-backend file) 'RCS)
	    (let ((branch 
		   (car (vc-parse-buffer 
			 '(("^branch:[ \t]+\\([0-9.]+\\)$" 1))))))
	      (setq patterns
		(mapcar 
		 (function 
  		  (lambda (p)
 		    (if (string-match "\\\\X" (car p))
			(if branch
			    (cond ((vc-branch-p branch)
				   (cons 
				    (concat 
				     (substring (car p) 0 (match-beginning 0))
				     (regexp-quote branch)
				     "\\.[0-9]+"
				     (substring (car p) (match-end 0)))
				    (cdr p)))
				  (t
				   (cons
				    (concat 
				     (substring (car p) 0 (match-beginning 0))
				     (regexp-quote branch)
				     (substring (car p) (match-end 0)))
				    (cdr p))))
			  ;; if there is no current branch, 
			  ;; return a completely different regexp, 
			  ;; which searches for the *head*
			  '("^head:[ \t]+\\([0-9.]+\\)$" 1))
		      p)))
		 patterns))))
	(prog1
	    (vc-parse-buffer patterns file properties)
	  (kill-buffer (current-buffer))
	  )
	)
    (if file
	(mapcar
	 (function (lambda (p) (vc-file-setprop file p nil)))
	 properties))
    )
  )

;;; Functions that determine property values, by examining the 
;;; working file, the master file, or log program output

(defun vc-consult-rcs-headers (file)
  ;; Search for RCS headers in FILE, and set properties
  ;; accordingly.  This function can be disabled by setting
  ;; vc-consult-headers to nil.  
  ;; Returns: nil            if no headers were found 
  ;;                         (or if the feature is disabled,
  ;;                         or if there is currently no buffer 
  ;;                         visiting FILE)
  ;;          'rev           if a workfile revision was found
  ;;          'rev-and-lock  if revision and lock info was found 
  (cond 
   ((or (not vc-consult-headers) 
	(not (get-file-buffer file)) nil))
   ((save-excursion
      (set-buffer (get-file-buffer file))
      (goto-char (point-min))
      (cond  
       ;; search for $Id or $Header
       ;; -------------------------
       ((re-search-forward "\\$\\(Id\\|Header\\): [^ ]+ \\([0-9.]+\\) "
			   nil t)
	;; if found, store the revision number ...
	(let ((rev (buffer-substring (match-beginning 2)
				     (match-end 2))))
	  ;; ... and check for the locking state
	  (if (re-search-forward 
	       (concat "\\=[0-9]+/[0-9]+/[0-9]+ "    ; date
		          "[0-9]+:[0-9]+:[0-9]+ "    ; time
		          "[^ ]+ [^ ]+ ")            ; author & state
	       nil t)
	      (cond 
	       ;; unlocked revision
	       ((looking-at "\\$")
		(vc-file-setprop file 'vc-workfile-version rev)
		(vc-file-setprop file 'vc-locking-user nil)
		(vc-file-setprop file 'vc-locked-version nil)
		'rev-and-lock)
	       ;; revision is locked by some user
	       ((looking-at "\\([^ ]+\\) \\$")
		(vc-file-setprop file 'vc-workfile-version rev)
		(vc-file-setprop file 'vc-locking-user 
				 (buffer-substring (match-beginning 1)
						   (match-end 1)))
		(vc-file-setprop file 'vc-locked-version rev) 
		'rev-and-lock)
	       ;; everything else: false
	       (nil))
	    ;; unexpected information in
	    ;; keyword string --> quit
	    nil)))
       ;; search for $Revision
       ;; --------------------
       ((re-search-forward (concat "\\$" 
				   "Revision: \\([0-9.]+\\) \\$")
			   nil t)
	;; if found, store the revision number ...
	(let ((rev (buffer-substring (match-beginning 1)
				     (match-end 1))))
	  ;; and see if there's any lock information
	  (goto-char (point-min))
	  (if (re-search-forward (concat "\\$" "Locker:") nil t)
	      (cond ((looking-at " \\([^ ]+\\) \\$")
		     (vc-file-setprop file 'vc-workfile-version rev)
		     (vc-file-setprop file 'vc-locking-user
				      (buffer-substring (match-beginning 1)
							(match-end 1)))
		     (vc-file-setprop file 'vc-locked-version rev)
		     'rev-and-lock)
		    ((looking-at " *\\$") 
		     (vc-file-setprop file 'vc-workfile-version rev)
		     (vc-file-setprop file 'vc-locking-user nil)
		     (vc-file-setprop file 'vc-locked-version nil)
		     'rev-and-lock)
		    (t 
		     (vc-file-setprop file 'vc-workfile-version rev)
		     'rev-and-lock))
	    (vc-file-setprop file 'vc-workfile-version rev)
	    'rev)))
       ;; else: nothing found
       ;; -------------------
       (t nil))))))

(defun vc-fetch-properties (file)
  ;; Re-fetch some properties associated with the given file.
  (cond 
   ((eq (vc-backend file) 'SCCS)
    (progn
      (vc-master-info (vc-lock-file file)
		      (list
		       '("^[^ ]+ [^ ]+ \\([^ ]+\\)" 1)
		       '("^\\([^ ]+\\)" 1))
		      file
		      '(vc-locking-user vc-locked-version))
      (vc-master-info (vc-name file)
		      (list
		       '("^\001d D \\([^ ]+\\)" 1)
		       (list (concat "^\001d D \\([^ ]+\\) .* " 
				     (regexp-quote (user-login-name)) " ")
			     1)
		       )
		      file
		      '(vc-latest-version vc-your-latest-version))
      ))
   ((eq (vc-backend file) 'RCS)
    (vc-log-info "rlog" file nil
		 (list
		  '("^locks: strict\n\t\\([^:]+\\)" 1)
		  '("^locks: strict\n\t[^:]+: \\(.+\\)" 1)
		  '("^revision[\t ]+\\([0-9.]+\\)\\(\n\\|[ \t].*\n\\)date: \\([ /0-9:]+\\);" 1 3)
		  (list 
		   (concat
		    "^revision[\t ]+\\([0-9.]+\\)\\(\n\\|[ \t].*\n\\)date: \\([ /0-9:]+\\); *author: "
		    (regexp-quote (user-login-name))
		    ";") 1 3)
		  ;; special regexp to search for branch revision:
		  ;; \X will be replaced by vc-log-info (see there)
		  '("^revision[\t ]+\\(\\X\\)\\(\n\\|[ \t].*\n\\)date: \\([ /0-9:]+\\);" 1 3))

		 '(vc-locking-user 
		   vc-locked-version
		   vc-latest-version 
		   vc-your-latest-version
		   vc-branch-version)))
   ((eq (vc-backend file) 'CVS)
    (vc-log-info "cvs" file '("status")
    ;; CVS 1.3 says "RCS Version:", other releases "RCS Revision:",
    ;; and CVS 1.4a1 says "Repository revision:".
    '(("\\(RCS Version\\|RCS Revision\\|Repository revision\\):[\t ]+\\([0-9.]+\\)" 2)
      ("^File: [^ \t]+[ \t]+Status: \\(.*\\)" 1))
    '(vc-latest-version vc-cvs-status))
    ;; Translate those status values that are needed into symbols.
    ;; Any other value is converted to nil.
    (let ((status (vc-file-getprop file 'vc-cvs-status)))
      (cond ((string-match "Up-to-date" status)
	     (vc-file-setprop file 'vc-cvs-status 'up-to-date)
	     (vc-file-setprop file 'vc-checkout-time 
			      (nth 5 (file-attributes file))))
	    ((string-match "Locally Modified" status)
	     (vc-file-setprop file 'vc-cvs-status 'locally-modified))
	    ((string-match "Needs Merge" status)
	     (vc-file-setprop file 'vc-cvs-status 'needs-merge))
	    (t (vc-file-setprop file 'vc-cvs-status nil))))
   )))

(defun vc-backend-subdirectory-name (&optional file)
  ;; Where the master and lock files for the current directory are kept
  (symbol-name
   (or
    (and file (vc-backend file))
    vc-default-back-end
    (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS)))))


;;; Access functions to file properties
;;; (Properties should be _set_ using vc-file-setprop, but
;;; _retrieved_ only through these functions, which decide
;;; if the property is already known or not. A property should
;;; only be retrieved by vc-file-getprop if there is no 
;;; access function.)

;; functions vc-name and vc-backend come earlier above, 
;; because they are needed by vc-log-info etc.

(defun vc-cvs-status (file)
  ;; Return the cvs status of FILE
  ;; (Status field in output of "cvs status")
  (cond ((vc-file-getprop file 'vc-cvs-status))
	(t (vc-fetch-properties file)
	   (vc-file-getprop file 'vc-cvs-status))))

(defun vc-locking-user (file)
  "Return the name of the person currently holding a lock on FILE.
Return nil if there is no such person.
Under CVS, a file is considered locked if it has been modified since it
was checked out.  Under CVS, this will sometimes return the uid of
the owner of the file (as a number) instead of a string."
  ;; The property is cached. If it is non-nil, it is simply returned.
  ;; The other routines clear it when the locking state changes.
  (setq file (expand-file-name file));; ??? Work around bug in 19.0.4
  (cond
   ((vc-file-getprop file 'vc-locking-user))
   ((eq (vc-backend file) 'CVS)
    (if (eq (vc-cvs-status file) 'up-to-date)
	nil
      ;; The expression below should return the username of the owner
      ;; of the file.  It doesn't.  It returns the username if it is
      ;; you, or otherwise the UID of the owner of the file.  The
      ;; return value from this function is only used by
      ;; vc-dired-reformat-line, and it does the proper thing if a UID
      ;; is returned.
      ;; 
      ;; The *proper* way to fix this would be to implement a built-in
      ;; function in Emacs, say, (username UID), that returns the
      ;; username of a given UID.
      ;;
      ;; The result of this hack is that vc-directory will print the
      ;; name of the owner of the file for any files that are
      ;; modified.
      (let ((uid (nth 2 (file-attributes file))))
	(if (= uid (user-uid))
	    (vc-file-setprop file 'vc-locking-user (user-login-name))
	  (vc-file-setprop file 'vc-locking-user uid)))))
   (t
    (if (and (eq (vc-backend file) 'RCS)
	     (eq (vc-consult-rcs-headers file) 'rev-and-lock))
	(vc-file-getprop file 'vc-locking-user)
      (if (or (not vc-keep-workfiles)
	      (eq vc-mistrust-permissions 't)
	      (and vc-mistrust-permissions
		   (funcall vc-mistrust-permissions 
			    (vc-backend-subdirectory-name file))))
	  (vc-file-setprop file 'vc-locking-user (vc-true-locking-user file))
	;; This implementation assumes that any file which is under version
	;; control and has -rw-r--r-- is locked by its owner.  This is true
	;; for both RCS and SCCS, which keep unlocked files at -r--r--r--.
	;; We have to be careful not to exclude files with execute bits on;
	;; scripts can be under version control too.  Also, we must ignore
	;; the group-read and other-read bits, since paranoid users turn them off.
	;; This hack wins because calls to the very expensive vc-fetch-properties
	;; function only have to be made if (a) the file is locked by someone
	;; other than the current user, or (b) some untoward manipulation
	;; behind vc's back has changed the owner or the `group' or `other'
	;; write bits.
	(let ((attributes (file-attributes file)))
	  (cond ((string-match ".r-..-..-." (nth 8 attributes))
		 nil)
		((and (= (nth 2 attributes) (user-uid))
		      (string-match ".rw..-..-." (nth 8 attributes)))
		 (vc-file-setprop file 'vc-locking-user (user-login-name)))
		(t
		 (vc-file-setprop file 'vc-locking-user 
				  (vc-true-locking-user file))))))))))

(defun vc-true-locking-user (file)
  ;; The slow but reliable version
  (vc-fetch-properties file)
  (vc-file-getprop file 'vc-locking-user))

(defun vc-latest-version (file)
  ;; Return version level of the latest version of FILE
  (vc-fetch-properties file)
  (vc-file-getprop file 'vc-latest-version))

(defun vc-your-latest-version (file)
  ;; Return version level of the latest version of FILE checked in by you
  (vc-fetch-properties file)
  (vc-file-getprop file 'vc-your-latest-version))

(defun vc-branch-version (file)
  ;; Return version level of the highest revision on the default branch
  ;; If there is no default branch, return the highest version number
  ;; on the trunk.
  ;; This property is defined for RCS only.
  (vc-fetch-properties file)
  (vc-file-getprop file 'vc-branch-version))

(defun vc-workfile-version (file)
  ;; Return version level of the current workfile FILE
  ;; This is attempted by first looking at the RCS keywords.
  ;; If there are no keywords in the working file, 
  ;; vc-branch-version is taken.
  ;; Note that this property is cached, that is, it is only 
  ;; looked up if it is nil.
  ;; For SCCS, this property is equivalent to vc-latest-version.
  (cond ((vc-file-getprop file 'vc-workfile-version))
	((eq (vc-backend file) 'SCCS) (vc-latest-version file))
	((eq (vc-backend file) 'RCS)
	 (if (vc-consult-rcs-headers file)
	     (vc-file-getprop file 'vc-workfile-version)
	   (let ((rev (cond ((vc-branch-version file))
			    ((vc-latest-version file)))))
	     (vc-file-setprop file 'vc-workfile-version rev)
	     rev)))
	((eq (vc-backend file) 'CVS)
	 (if (vc-consult-rcs-headers file)   ;; CVS
	     (vc-file-getprop file 'vc-workfile-version)
	   (vc-find-cvs-master (file-name-directory file)
			       (file-name-nondirectory file))
	   (vc-file-getprop file 'vc-workfile-version)))))
574

Eric S. Raymond's avatar
Eric S. Raymond committed
575 576 577
;;; actual version-control code starts here

(defun vc-registered (file)
578 579
  (let (handler handlers)
    (if (boundp 'file-name-handler-alist)
580
	(setq handler (find-file-name-handler file 'vc-registered)))
581 582 583 584 585 586 587 588
    (if handler
	(funcall handler 'vc-registered file)
      ;; Search for a master corresponding to the given file
      (let ((dirname (or (file-name-directory file) ""))
	    (basename (file-name-nondirectory file)))
	(catch 'found
	  (mapcar
	   (function (lambda (s)
Richard M. Stallman's avatar
Richard M. Stallman committed
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604
	      (if (atom s)
		  (funcall s dirname basename)
		(let ((trial (format (car s) dirname basename)))
		  (if (and (file-exists-p trial)
			   ;; Make sure the file we found with name
			   ;; TRIAL is not the source file itself.
			   ;; That can happen with RCS-style names
			   ;; if the file name is truncated
			   ;; (e.g. to 14 chars).  See if either
			   ;; directory or attributes differ.
			   (or (not (string= dirname
					     (file-name-directory trial)))
			       (not (equal
				     (file-attributes file)
				     (file-attributes trial)))))
		      (throw 'found (cons trial (cdr s))))))))
605 606
	   vc-master-templates)
	  nil)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
607

Richard M. Stallman's avatar
Richard M. Stallman committed
608 609 610 611 612
(defun vc-find-cvs-master (dirname basename)
  ;; Check if DIRNAME/BASENAME is handled by CVS.
  ;; If it is, do a (throw 'found (cons MASTER 'CVS)).
  ;; Note: If the file is ``cvs add''ed but not yet ``cvs commit''ed 
  ;; the MASTER will not actually exist yet.  The other parts of VC
613
  ;; checks for this condition.  This function returns nil if 
Richard M. Stallman's avatar
Richard M. Stallman committed
614 615 616
  ;; DIRNAME/BASENAME is not handled by CVS.
  (if (and (file-directory-p (concat dirname "CVS/"))
	   (file-readable-p (concat dirname "CVS/Entries")))
617
      (let ((bufs nil) (fold case-fold-search))
Richard M. Stallman's avatar
Richard M. Stallman committed
618 619 620 621 622 623
	(unwind-protect
	    (save-excursion
	      (setq bufs (list
			  (find-file-noselect (concat dirname "CVS/Entries"))))
	      (set-buffer (car bufs))
	      (goto-char (point-min))
624 625 626
	      ;; make sure the file name is searched 
	      ;; case-sensitively
	      (setq case-fold-search nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
627 628 629 630
	      (cond
	       ((re-search-forward
		 (concat "^/" (regexp-quote basename) "/\\([^/]*\\)/")
		 nil t)
631
		(setq case-fold-search fold)  ;; restore the old value
Richard M. Stallman's avatar
Richard M. Stallman committed
632 633 634
		;; We found it.  Store away version number, now
		;; that we are anyhow so close to finding it.
		(vc-file-setprop (concat dirname basename) 
635
				 'vc-workfile-version
Richard M. Stallman's avatar
Richard M. Stallman committed
636 637 638 639 640 641 642 643 644 645 646 647
				 (buffer-substring (match-beginning 1)
						   (match-end 1)))
		(setq bufs (cons (find-file-noselect 
				  (concat dirname "CVS/Repository"))
				 bufs))
		(set-buffer (car bufs))
		(let ((master
		       (concat (file-name-as-directory 
				(buffer-substring (point-min)
						  (1- (point-max))))
			       basename
			       ",v")))
648 649 650
		  (throw 'found (cons master 'CVS))))
	       (t (setq case-fold-search fold)  ;; restore the old value
		  nil)))
Richard M. Stallman's avatar
Richard M. Stallman committed
651 652
	  (mapcar (function kill-buffer) bufs)))))

653 654 655
(defun vc-buffer-backend ()
  "Return the version-control type of the visited file, or nil if none."
  (if (eq vc-buffer-backend t)
656
      (setq vc-buffer-backend (vc-backend (buffer-file-name)))
657 658
    vc-buffer-backend))

659
(defun vc-toggle-read-only (&optional verbose)
660 661 662
  "Change read-only status of current buffer, perhaps via version control.
If the buffer is visiting a file registered with version control,
then check the file in or out.  Otherwise, just change the read-only flag
663
of the buffer.  With prefix argument, ask for version number."
664
  (interactive "P")
665
  (if (vc-backend (buffer-file-name))
666
      (vc-next-action verbose)
Eric S. Raymond's avatar
Eric S. Raymond committed
667
    (toggle-read-only)))
668
(define-key global-map "\C-x\C-q" 'vc-toggle-read-only)
Eric S. Raymond's avatar
Eric S. Raymond committed
669 670

(defun vc-mode-line (file &optional label)
Eric S. Raymond's avatar
Eric S. Raymond committed
671
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
672
The value is set in the current buffer, which should be the buffer
673 674
visiting FILE.  Second optional arg LABEL is put in place of version
control system name."
675
  (interactive (list buffer-file-name nil))
676 677
  (let ((vc-type (vc-backend file))
	(vc-status-string (and vc-display-status (vc-status file))))
678
    (setq vc-mode
679 680 681 682 683 684 685 686 687 688
	  (concat " " (or label (symbol-name vc-type)) vc-status-string))
    ;; Make the buffer read-only if the file is not locked
    ;; (or unchanged, in the CVS case).
    ;; Determine this by looking at the mode string, 
    ;; so that no further external status query is necessary
    (if vc-status-string
	(if (eq (elt vc-status-string 0) ?-)
	    (setq buffer-read-only t))
      (if (not (vc-locking-user file))
	  (setq buffer-read-only t)))
689 690 691 692 693 694 695 696 697 698
    ;; Even root shouldn't modify a registered file without
    ;; locking it first.
    (and vc-type
	 (not buffer-read-only)
	 (zerop (user-uid))
	 (require 'vc)
	 (not (equal (user-login-name) (vc-locking-user file)))
	 (setq buffer-read-only t))
    (and (null vc-type)
	 (file-symlink-p file)
699
	 (let ((link-type (vc-backend (file-symlink-p file))))
700 701 702 703 704 705 706
	   (if link-type
	       (message
		"Warning: symbolic link to %s-controlled source file"
		link-type))))
    (force-mode-line-update)
    ;;(set-buffer-modified-p (buffer-modified-p)) ;;use this if Emacs 18
    vc-type))
Eric S. Raymond's avatar
Eric S. Raymond committed
707

708
(defun vc-status (file)
709
  ;; Return string for placement in modeline by `vc-mode-line'.
710
  ;; Format:
711
  ;;
712 713 714 715
  ;;   "-REV"        if the revision is not locked
  ;;   ":REV"        if the revision is locked by the user
  ;;   ":LOCKER:REV" if the revision is locked by somebody else
  ;;   " @@"         for a CVS file that is added, but not yet committed
Richard M. Stallman's avatar
Richard M. Stallman committed
716
  ;;
717 718 719 720 721 722 723 724 725 726 727
  ;; In the CVS case, a "locked" working file is a 
  ;; working file that is modified with respect to the master.
  ;; The file is "locked" from the moment when the user makes 
  ;; the buffer writable.
  ;; 
  ;; This function assumes that the file is registered.

  (let ((locker (vc-locking-user file))
	(rev (vc-workfile-version file)))
    (cond ((string= "0" rev)
	   " @@")
728 729 730 731 732
	  ((not locker)
	   (concat "-" rev))
	  ((if (stringp locker)
	       (string= locker (user-login-name))
	     (= locker (user-uid)))
733 734 735
	   (concat ":" rev))
	  (t 
	   (concat ":" locker ":" rev)))))
736

Eric S. Raymond's avatar
Eric S. Raymond committed
737 738
;;; install a call to the above as a find-file hook
(defun vc-find-file-hook ()
739 740
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
741 742 743 744
  (cond 
   (buffer-file-name
    (vc-file-clearprops buffer-file-name)
    (cond
745
     ((vc-backend buffer-file-name)
746 747 748 749 750 751
      (vc-mode-line buffer-file-name)
      (cond ((not vc-make-backup-files)
	     ;; Use this variable, not make-backup-files,
	     ;; because this is for things that depend on the file name.
	     (make-local-variable 'backup-inhibited)
	     (setq backup-inhibited t))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
752

753
(add-hook 'find-file-hooks 'vc-find-file-hook)
Eric S. Raymond's avatar
Eric S. Raymond committed
754 755 756 757 758

;;; more hooks, this time for file-not-found
(defun vc-file-not-found-hook ()
  "When file is not found, try to check it out from RCS or SCCS.
Returns t if checkout was successful, nil otherwise."
759
  (if (vc-backend buffer-file-name)
760
      (save-excursion
Eric S. Raymond's avatar
Eric S. Raymond committed
761 762 763
	(require 'vc)
	(not (vc-error-occurred (vc-checkout buffer-file-name))))))

764
(add-hook 'find-file-not-found-hooks 'vc-file-not-found-hook)
Eric S. Raymond's avatar
Eric S. Raymond committed
765

766 767 768 769 770 771 772 773 774
;; Discard info about a file when we kill its buffer.
(defun vc-kill-buffer-hook ()
  (if (stringp (buffer-file-name))
      (progn
	(vc-file-clearprops (buffer-file-name))
	(kill-local-variable 'vc-buffer-backend))))

;;;(add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)

Eric S. Raymond's avatar
Eric S. Raymond committed
775
;;; Now arrange for bindings and autoloading of the main package.
Eric S. Raymond's avatar
Eric S. Raymond committed
776 777
;;; Bindings for this have to go in the global map, as we'll often
;;; want to call them from random buffers.
Eric S. Raymond's avatar
Eric S. Raymond committed
778 779 780 781 782 783 784 785

(setq vc-prefix-map (lookup-key global-map "\C-xv"))
(if (not (keymapp vc-prefix-map))
    (progn
      (setq vc-prefix-map (make-sparse-keymap))
      (define-key global-map "\C-xv" vc-prefix-map)
      (define-key vc-prefix-map "a" 'vc-update-change-log)
      (define-key vc-prefix-map "c" 'vc-cancel-version)
786
      (define-key vc-prefix-map "d" 'vc-directory)
Eric S. Raymond's avatar
Eric S. Raymond committed
787 788 789 790 791 792 793
      (define-key vc-prefix-map "h" 'vc-insert-headers)
      (define-key vc-prefix-map "i" 'vc-register)
      (define-key vc-prefix-map "l" 'vc-print-log)
      (define-key vc-prefix-map "r" 'vc-retrieve-snapshot)
      (define-key vc-prefix-map "s" 'vc-create-snapshot)
      (define-key vc-prefix-map "u" 'vc-revert-buffer)
      (define-key vc-prefix-map "v" 'vc-next-action)
794
      (define-key vc-prefix-map "=" 'vc-diff)
795 796
      (define-key vc-prefix-map "~" 'vc-version-other-window)))

797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
(if (not (boundp 'vc-menu-map))
    ;; Don't do the menu bindings if menu-bar.el wasn't loaded to defvar
    ;; vc-menu-map.
    ()
  ;;(define-key vc-menu-map [show-files]
  ;;  '("Show Files under VC" . (vc-directory t)))
  (define-key vc-menu-map [vc-directory] '("Show Locked Files" . vc-directory))
  (define-key vc-menu-map [separator1] '("----"))
  (define-key vc-menu-map [vc-rename-file] '("Rename File" . vc-rename-file))
  (define-key vc-menu-map [vc-version-other-window]
    '("Show Other Version" . vc-version-other-window))
  (define-key vc-menu-map [vc-diff] '("Compare with Last Version" . vc-diff))
  (define-key vc-menu-map [vc-update-change-log]
    '("Update ChangeLog" . vc-update-change-log))
  (define-key vc-menu-map [vc-print-log] '("Show History" . vc-print-log))
  (define-key vc-menu-map [separator2] '("----"))
  (define-key vc-menu-map [undo] '("Undo Last Check-In" . vc-cancel-version))
  (define-key vc-menu-map [vc-revert-buffer]
    '("Revert to Last Version" . vc-revert-buffer))
  (define-key vc-menu-map [vc-insert-header]
    '("Insert Header" . vc-insert-headers))
  (define-key vc-menu-map [vc-menu-check-in] '("Check In" . vc-next-action))
  (define-key vc-menu-map [vc-check-out] '("Check Out" . vc-toggle-read-only))
  (define-key vc-menu-map [vc-register] '("Register" . vc-register))
  (put 'vc-rename-file 'menu-enable 'vc-mode)
  (put 'vc-version-other-window 'menu-enable 'vc-mode)
  (put 'vc-diff 'menu-enable 'vc-mode)
  (put 'vc-update-change-log 'menu-enable
825
       '(eq (vc-buffer-backend) 'RCS))
826 827 828 829 830 831 832 833
  (put 'vc-print-log 'menu-enable 'vc-mode)
  (put 'vc-cancel-version 'menu-enable 'vc-mode)
  (put 'vc-revert-buffer 'menu-enable 'vc-mode)
  (put 'vc-insert-headers 'menu-enable 'vc-mode)
  (put 'vc-next-action 'menu-enable '(and vc-mode (not buffer-read-only)))
  (put 'vc-toggle-read-only 'menu-enable '(and vc-mode buffer-read-only))
  (put 'vc-register 'menu-enable '(not vc-mode))
  )
Eric S. Raymond's avatar
Eric S. Raymond committed
834 835 836 837

(provide 'vc-hooks)

;;; vc-hooks.el ends here