vc-hooks.el 33.6 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

;; We need a notion of per-file properties because the version
83 84 85 86
;; 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
87

88 89 90
(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
91 92 93
(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.")

94 95 96
(defvar vc-buffer-backend t)
(make-variable-buffer-local 'vc-buffer-backend)

Eric S. Raymond's avatar
Eric S. Raymond committed
97 98 99 100 101 102 103 104
(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))

105 106 107
(defun vc-file-clearprops (file)
  ;; clear all properties of a given file
  (setplist (intern file vc-file-prop-obarray) nil))
108

109 110
;;; Functions that determine property values, by examining the 
;;; working file, the master file, or log program output
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 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163

(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)
  )

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
(defun vc-insert-file (file &optional limit blocksize)
  ;; Insert the contents of FILE into the current buffer.
  ;; Optional argument LIMIT is a regexp. If present,
  ;; the file is inserted in chunks of size BLOCKSIZE
  ;; (default 8 kByte), until the first occurence of
  ;; LIMIT is found. The function returns nil if FILE 
  ;; doesn't exist.
  (cond ((file-exists-p file)
	 (cond (limit
		(if (not blocksize) (setq blocksize 8192))
		(let (found s)
		  (while (not found)
		    (setq s (buffer-size))
		    (goto-char (1+ s))
		    (setq found 
			  (or (zerop (car (cdr 
			      (insert-file-contents file nil s 
			       (+ s blocksize)))))
			      (progn (beginning-of-line)
				     (re-search-forward limit nil t)))))))
	       (t (insert-file-contents file)))
	 (set-buffer-modified-p nil)
	 (auto-save-mode nil)
	 t)
	(t nil)))

(defun vc-parse-locks (file locks)
  ;; Parse RCS or SCCS locks.
  ;; The result is a list of the form ((VERSION USER) (VERSION USER) ...),
  ;; which is returned and stored into the property `vc-master-locks'.
  (if (not locks) 
      (vc-file-setprop file 'vc-master-locks 'none)
    (let ((found t) (index 0) master-locks version user)
      (cond ((eq (vc-backend file) 'SCCS)
	     (while (string-match "^\\([0-9.]+\\) [0-9.]+ \\([^ ]+\\) .*\n?"
				   locks index)
	       (setq version (substring locks 
					(match-beginning 1) (match-end 1)))
	       (setq user (substring locks 
				     (match-beginning 2) (match-end 2)))
	       (setq master-locks (append master-locks 
					  (list (cons version user))))
	       (setq index (match-end 0))))
	    ((eq (vc-backend file) 'RCS)
	     (while (string-match "[ \t\n]*\\([^:]+\\):\\([0-9.]+\\)"
				  locks index)
	       (setq version (substring locks 
					(match-beginning 2) (match-end 2)))
	       (setq user (substring locks 
				     (match-beginning 1) (match-end 1)))
	       (setq master-locks (append master-locks 
					  (list (cons version user))))
	       (setq index (match-end 0)))))
      (vc-file-setprop file 'vc-master-locks (or master-locks 'none)))))

(defun vc-fetch-master-properties (file)
  ;; Fetch those properties of FILE that are stored in the master file.
221 222 223 224
  ;; For an RCS file, we don't get vc-latest-version vc-your-latest-version
  ;; here because that is slow.
  ;; That gets done if/when the functions vc-latest-version
  ;; and vc-your-latest-version get called.
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
  (save-excursion
    (cond
     ((eq (vc-backend file) 'SCCS)
      (set-buffer (get-buffer-create "*vc-info*"))
      (if (vc-insert-file (vc-lock-file file))
	  (progn (vc-parse-locks file (buffer-string))
		 (erase-buffer))
	(vc-file-setprop file 'vc-master-locks 'none))
      (vc-insert-file (vc-name file) "^\001e")
      (vc-parse-buffer 
       (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)
      (set-buffer (get-buffer-create "*vc-info*"))
243
      (vc-insert-file (vc-name file) "^locks")
244 245 246
      (vc-parse-buffer 
       (list '("^head[ \t\n]+\\([^;]+\\);" 1)
	     '("^branch[ \t\n]+\\([^;]+\\);" 1)
247
	     '("^locks\\([^;]+\\);" 1))
248 249 250
       file
       '(vc-head-version
	 vc-default-branch
251
	 vc-master-locks))
252 253 254 255 256 257 258 259 260 261 262 263 264
      ;; determine vc-top-version: it is either the head version, 
      ;; or the tip of the default branch
      (let ((default-branch (vc-file-getprop file 'vc-default-branch)))
	(cond 
	 ;; no default branch
	 ((or (not default-branch) (string= "" default-branch))
	  (vc-file-setprop file 'vc-top-version 
			   (vc-file-getprop file 'vc-head-version)))
	 ;; default branch is actually a revision
	 ((string-match "^[0-9]+\\.[0-9]+\\(\\.[0-9]+\\.[0-9]+\\)*$" 
			default-branch)
	  (vc-file-setprop file 'vc-top-version default-branch))
	 ;; else, search for the tip of the default branch
265 266 267
	 (t (erase-buffer)
	    (vc-insert-file (vc-name file) "^desc")
	    (vc-parse-buffer (list (list 
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
	       (concat "^\\(" 
		       (regexp-quote default-branch)
		       "\\.[0-9]+\\)\ndate[ \t]+\\([0-9.]+\\);") 1 2))
			 file '(vc-top-version)))))
      ;; translate the locks
      (vc-parse-locks file (vc-file-getprop file 'vc-master-locks)))

     ((eq (vc-backend file) 'CVS)
      ;; don't switch to the *vc-info* buffer before running the
      ;; command, because that would change its default directory
      (save-excursion (set-buffer (get-buffer-create "*vc-info*"))
		      (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")
			   ":" (mapconcat 'identity vc-path ":"))
		   process-environment)))
	(apply 'call-process "cvs" nil "*vc-info*" nil 
	       (list "status" (file-name-nondirectory file))))
      (set-buffer (get-buffer "*vc-info*"))
      (set-buffer-modified-p nil)
      (auto-save-mode nil)
      (vc-parse-buffer     
       ;; 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)
295
	 ("^File: [^ \t]+[ \t]+Status: \\(.*\\)" 1))
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310
       file
       '(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))))))
    (kill-buffer (current-buffer))))
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326

;;; 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) 
327
	(not (get-file-buffer file))) nil)
328 329 330 331 332 333
   ((save-excursion
      (set-buffer (get-file-buffer file))
      (goto-char (point-min))
      (cond  
       ;; search for $Id or $Header
       ;; -------------------------
334 335 336 337 338
       ((or (and (search-forward "$Id: " nil t)
		 (looking-at "[^ ]+ \\([0-9.]+\\) "))
	    (and (progn (goto-char (point-min))
			(search-forward "$Headers: " nil t))
		 (looking-at "[^ ]+ \\([0-9.]+\\) ")))
339
	;; if found, store the revision number ...
340 341
	(let ((rev (buffer-substring (match-beginning 1)
				     (match-end 1))))
342 343 344 345 346 347 348 349 350 351
	  ;; ... 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)
352
		(vc-file-setprop file 'vc-locking-user 'none)
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
		'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)))
		'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)))
		     'rev-and-lock)
		    ((looking-at " *\\$") 
		     (vc-file-setprop file 'vc-workfile-version rev)
385
		     (vc-file-setprop file 'vc-locking-user 'none)
386 387 388
		     'rev-and-lock)
		    (t 
		     (vc-file-setprop file 'vc-workfile-version rev)
389
		     (vc-file-setprop file 'vc-locking-user 'none)
390 391 392 393 394 395 396
		     'rev-and-lock))
	    (vc-file-setprop file 'vc-workfile-version rev)
	    'rev)))
       ;; else: nothing found
       ;; -------------------
       (t nil))))))

397 398 399 400 401 402 403 404 405
;;; 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.)

;;; properties indicating the backend 
;;; being used for FILE
406 407 408 409 410 411 412 413 414

(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)))))

415 416 417 418 419 420 421 422
(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)))))))
423

424 425 426 427 428 429 430 431 432
(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))))))))
433

434
;;; properties indicating the locking state
435 436 437 438 439

(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))
440
	(t (vc-fetch-master-properties file)
441 442
	   (vc-file-getprop file 'vc-cvs-status))))

443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
(defun vc-master-locks (file)
  ;; Return the lock entries in the master of FILE.
  ;; Return 'none if there are no such entries, and a list
  ;; of the form ((VERSION USER) (VERSION USER) ...) otherwise.
  (cond ((vc-file-getprop file 'vc-master-locks))
	(t (vc-fetch-master-properties file)
	   (vc-file-getprop file 'vc-master-locks))))

(defun vc-master-locking-user (file)
  ;; Return the master file's idea of who is locking 
  ;; the current workfile version of FILE.  
  ;; Return 'none if it is not locked.
  (let ((master-locks (vc-master-locks file)) lock)
    (if (eq master-locks 'none) 'none
      ;; search for a lock on the current workfile version
      (setq lock (assoc (vc-workfile-version file) master-locks))
      (cond (lock (cdr lock))
	    ('none)))))

462
(defun vc-locking-user (file)
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
  ;; 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.  It is only looked up if it is currently nil.
  ;; Note that, for a file that is not locked, the actual property value
  ;; is 'none, to distinguish it from an unknown locking state.  That value
  ;; is converted to nil by this function, and returned to the caller.
  (let ((locking-user (vc-file-getprop file 'vc-locking-user)))
    (if locking-user
	;; if we already know the property, return it
	(if (eq locking-user 'none) nil locking-user)

      ;; otherwise, infer the property...
      (cond
       ;; in the CVS case, check the status
       ((eq (vc-backend file) 'CVS)
	(if (eq (vc-cvs-status file) 'up-to-date)
	    (vc-file-setprop file 'vc-locking-user 'none)
	  ;; 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)))))

       ;; RCS case: attempt a header search. If this feature is
       ;; disabled, vc-consult-rcs-headers always returns nil.
       ((and (eq (vc-backend file) 'RCS)
	     (eq (vc-consult-rcs-headers file) 'rev-and-lock)))

       ;; if the file permissions are not trusted,
       ;; use the information from the master file
       ((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-master-locking-user file)))

     ;; Otherwise: Use the file permissions. (But if it turns out that the
     ;; file is not owned by the user, use the master 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 somewhat expensive 
     ;; `vc-fetch-master-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.
     (t
      (let ((attributes (file-attributes file)))
	(cond ((string-match ".r-..-..-." (nth 8 attributes))
	       (vc-file-setprop file 'vc-locking-user 'none))
	      ((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-master-locking-user file))))
	)))
      ;; recursively call the function again,
      ;; to convert a possible 'none value
      (vc-locking-user file))))

;;; properties to store current and recent version numbers
545 546 547

(defun vc-latest-version (file)
  ;; Return version level of the latest version of FILE
548
  (cond ((vc-file-getprop file 'vc-latest-version))
549
	(t (vc-fetch-properties file)
550
	   (vc-file-getprop file 'vc-latest-version))))
551 552 553

(defun vc-your-latest-version (file)
  ;; Return version level of the latest version of FILE checked in by you
554
  (cond ((vc-file-getprop file 'vc-your-latest-version))
555
	(t (vc-fetch-properties file)
556
	   (vc-file-getprop file 'vc-your-latest-version))))
557

558
(defun vc-top-version (file)
559 560 561 562
  ;; 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.
563 564 565
  (cond ((vc-file-getprop file 'vc-top-version))
	(t (vc-fetch-master-properties file)
	   (vc-file-getprop file 'vc-top-version))))
566

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589
(defun vc-fetch-properties (file)
  ;; Fetch vc-latest-version and vc-your-latest-version
  ;; if that wasn't already done.
  (vc-backend-dispatch
   file
   ;; SCCS
   (vc-fetch-master-properties file)
   ;; RCS
   (progn
     (set-buffer (get-buffer-create "*vc-info*"))
     (vc-insert-file (vc-name file) "^desc")
     (vc-parse-buffer 
      (list '("^\\([0-9]+\\.[0-9.]+\\)\ndate[ \t]+\\([0-9.]+\\);" 1 2)
	    (list (concat "^\\([0-9]+\\.[0-9.]+\\)\n"
			  "date[ \t]+\\([0-9.]+\\);[ \t]+"
			  "author[ \t]+"
			  (regexp-quote (user-login-name)) ";") 1 2))
      file
      '(vc-latest-version vc-your-latest-version)))
   ;; CVS
   (vc-fetch-master-properties file)
   ))

590 591 592 593
(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, 
594
  ;; vc-top-version is taken.
595 596 597 598 599 600 601 602
  ;; 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)
603
	   (let ((rev (cond ((vc-top-version file))
604 605 606 607 608 609 610 611 612
			    ((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)))))
613

Eric S. Raymond's avatar
Eric S. Raymond committed
614 615 616
;;; actual version-control code starts here

(defun vc-registered (file)
617 618
  (let (handler handlers)
    (if (boundp 'file-name-handler-alist)
619
	(setq handler (find-file-name-handler file 'vc-registered)))
620 621 622 623 624 625 626 627
    (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
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643
	      (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))))))))
644 645
	   vc-master-templates)
	  nil)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
646

Richard M. Stallman's avatar
Richard M. Stallman committed
647 648 649 650 651
(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
652
  ;; checks for this condition.  This function returns nil if 
Richard M. Stallman's avatar
Richard M. Stallman committed
653 654 655
  ;; DIRNAME/BASENAME is not handled by CVS.
  (if (and (file-directory-p (concat dirname "CVS/"))
	   (file-readable-p (concat dirname "CVS/Entries")))
656
      (let ((bufs nil) (fold case-fold-search))
Richard M. Stallman's avatar
Richard M. Stallman committed
657 658 659 660 661 662
	(unwind-protect
	    (save-excursion
	      (setq bufs (list
			  (find-file-noselect (concat dirname "CVS/Entries"))))
	      (set-buffer (car bufs))
	      (goto-char (point-min))
663 664 665
	      ;; make sure the file name is searched 
	      ;; case-sensitively
	      (setq case-fold-search nil)
Richard M. Stallman's avatar
Richard M. Stallman committed
666 667 668 669
	      (cond
	       ((re-search-forward
		 (concat "^/" (regexp-quote basename) "/\\([^/]*\\)/")
		 nil t)
670
		(setq case-fold-search fold)  ;; restore the old value
Richard M. Stallman's avatar
Richard M. Stallman committed
671 672 673
		;; We found it.  Store away version number, now
		;; that we are anyhow so close to finding it.
		(vc-file-setprop (concat dirname basename) 
674
				 'vc-workfile-version
Richard M. Stallman's avatar
Richard M. Stallman committed
675 676 677 678 679 680 681 682 683 684 685 686
				 (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")))
687 688 689
		  (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
690 691
	  (mapcar (function kill-buffer) bufs)))))

692 693 694
(defun vc-buffer-backend ()
  "Return the version-control type of the visited file, or nil if none."
  (if (eq vc-buffer-backend t)
695
      (setq vc-buffer-backend (vc-backend (buffer-file-name)))
696 697
    vc-buffer-backend))

698
(defun vc-toggle-read-only (&optional verbose)
699 700 701
  "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
702
of the buffer.  With prefix argument, ask for version number."
703
  (interactive "P")
704
  (if (vc-backend (buffer-file-name))
705
      (vc-next-action verbose)
Eric S. Raymond's avatar
Eric S. Raymond committed
706
    (toggle-read-only)))
707
(define-key global-map "\C-x\C-q" 'vc-toggle-read-only)
Eric S. Raymond's avatar
Eric S. Raymond committed
708 709

(defun vc-mode-line (file &optional label)
Eric S. Raymond's avatar
Eric S. Raymond committed
710
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
711
The value is set in the current buffer, which should be the buffer
712 713
visiting FILE.  Second optional arg LABEL is put in place of version
control system name."
714
  (interactive (list buffer-file-name nil))
715 716
  (let ((vc-type (vc-backend file))
	(vc-status-string (and vc-display-status (vc-status file))))
717
    (setq vc-mode
718 719 720 721 722 723 724 725 726 727
	  (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)))
728 729 730 731 732 733 734 735 736 737
    ;; 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)
738
	 (let ((link-type (vc-backend (file-symlink-p file))))
739 740 741 742 743 744 745
	   (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
746

747
(defun vc-status (file)
748
  ;; Return string for placement in modeline by `vc-mode-line'.
749
  ;; Format:
750
  ;;
751 752 753 754
  ;;   "-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
755
  ;;
756 757 758 759 760 761 762 763 764 765 766
  ;; 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)
	   " @@")
767 768 769 770 771
	  ((not locker)
	   (concat "-" rev))
	  ((if (stringp locker)
	       (string= locker (user-login-name))
	     (= locker (user-uid)))
772 773 774
	   (concat ":" rev))
	  (t 
	   (concat ":" locker ":" rev)))))
775

Eric S. Raymond's avatar
Eric S. Raymond committed
776 777
;;; install a call to the above as a find-file hook
(defun vc-find-file-hook ()
778 779
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
780 781 782 783
  (cond 
   (buffer-file-name
    (vc-file-clearprops buffer-file-name)
    (cond
784
     ((vc-backend buffer-file-name)
785 786 787 788 789 790
      (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
791

792
(add-hook 'find-file-hooks 'vc-find-file-hook)
Eric S. Raymond's avatar
Eric S. Raymond committed
793 794 795 796 797

;;; 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."
798
  (if (vc-backend buffer-file-name)
799
      (save-excursion
Eric S. Raymond's avatar
Eric S. Raymond committed
800
	(require 'vc)
801
	(setq default-directory (file-name-directory (buffer-file-name)))
Eric S. Raymond's avatar
Eric S. Raymond committed
802 803
	(not (vc-error-occurred (vc-checkout buffer-file-name))))))

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

806 807 808 809 810 811 812 813 814
;; 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
815
;;; Now arrange for bindings and autoloading of the main package.
Eric S. Raymond's avatar
Eric S. Raymond committed
816 817
;;; 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
818 819 820 821 822 823 824 825

(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)
826
      (define-key vc-prefix-map "d" 'vc-directory)
Eric S. Raymond's avatar
Eric S. Raymond committed
827 828 829 830 831 832 833
      (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)
834
      (define-key vc-prefix-map "=" 'vc-diff)
835 836
      (define-key vc-prefix-map "~" 'vc-version-other-window)))

837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864
(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
865
       '(eq (vc-buffer-backend) 'RCS))
866 867 868 869 870 871
  (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))
872
  (put 'vc-register 'menu-enable '(and buffer-file-name (not vc-mode)))
873
  )
Eric S. Raymond's avatar
Eric S. Raymond committed
874 875 876 877

(provide 'vc-hooks)

;;; vc-hooks.el ends here