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

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

5 6
;; Author:     Eric S. Raymond <esr@snark.thyrsus.com>
;; Maintainer: Andre Spiegel <spiegel@inf.fu-berlin.de>
Eric S. Raymond's avatar
Eric S. Raymond committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20

;; 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
21 22 23
;; 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
24 25 26

;;; Commentary:

27 28 29
;; 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
30 31 32 33
;; See the commentary of vc.el.

;;; Code:

34 35
;; Customization Variables (the rest is in vc.el)

Karl Heuer's avatar
Karl Heuer committed
36
(defcustom vc-default-back-end nil
37
  "*Back-end actually used by this interface; may be SCCS or RCS.
Karl Heuer's avatar
Karl Heuer committed
38 39 40
The value is only computed when needed to avoid an expensive search."
  :type '(choice (const nil) (const RCS) (const SCCS))
  :group 'vc)
41

Karl Heuer's avatar
Karl Heuer committed
42
(defcustom vc-handle-cvs t
43
  "*If non-nil, use VC for files managed with CVS.
Karl Heuer's avatar
Karl Heuer committed
44 45 46
If it is nil, don't use VC for those files."
  :type 'boolean
  :group 'vc)
47

Karl Heuer's avatar
Karl Heuer committed
48
(defcustom vc-rcsdiff-knows-brief nil
49 50
  "*Indicates whether rcsdiff understands the --brief option.
The value is either `yes', `no', or nil.  If it is nil, VC tries
Karl Heuer's avatar
Karl Heuer committed
51 52 53
to use --brief and sets this variable to remember whether it worked."
  :type '(choice (const nil) (const yes) (const no))
  :group 'vc)
54

Karl Heuer's avatar
Karl Heuer committed
55
(defcustom vc-path
56 57 58
  (if (file-directory-p "/usr/sccs")
      '("/usr/sccs")
    nil)
Karl Heuer's avatar
Karl Heuer committed
59 60 61
  "*List of extra directories to search for version control commands."
  :type '(repeat directory)
  :group 'vc)
62

Karl Heuer's avatar
Karl Heuer committed
63 64

(defcustom vc-master-templates
Eric S. Raymond's avatar
Eric S. Raymond committed
65
  '(("%sRCS/%s,v" . RCS) ("%s%s,v" . RCS) ("%sRCS/%s" . RCS)
Richard M. Stallman's avatar
Richard M. Stallman committed
66 67
    ("%sSCCS/s.%s" . SCCS) ("%ss.%s". SCCS)
    vc-find-cvs-master)
Eric S. Raymond's avatar
Eric S. Raymond committed
68 69
  "*Where to look for version-control master files.
The first pair corresponding to a given back end is used as a template
70
when creating new masters.
Karl Heuer's avatar
Karl Heuer committed
71 72 73
Setting this variable to nil turns off use of VC entirely."
  :type '(repeat sexp)
  :group 'vc)
Eric S. Raymond's avatar
Eric S. Raymond committed
74

Karl Heuer's avatar
Karl Heuer committed
75
(defcustom vc-make-backup-files nil
76
  "*If non-nil, backups of registered files are made as with other files.
Karl Heuer's avatar
Karl Heuer committed
77 78 79
If nil (the default), files covered by version control don't get backups."
  :type 'boolean
  :group 'vc)
Eric S. Raymond's avatar
Eric S. Raymond committed
80

Karl Heuer's avatar
Karl Heuer committed
81
(defcustom vc-follow-symlinks 'ask
82 83 84 85 86 87 88
  "*Indicates what to do if you visit a symbolic link to a file
that is under version control.  Editing such a file through the
link bypasses the version control system, which is dangerous and
probably not what you want.  
  If this variable is t, VC follows the link and visits the real file,
telling you about it in the echo area.  If it is `ask', VC asks for
confirmation whether it should follow the link.  If nil, the link is
Karl Heuer's avatar
Karl Heuer committed
89 90 91
visited and a warning displayed."
  :type '(choice (const ask) (const nil) (const t))
  :group 'vc)
92

Karl Heuer's avatar
Karl Heuer committed
93
(defcustom vc-display-status t
94
  "*If non-nil, display revision number and lock status in modeline.
Karl Heuer's avatar
Karl Heuer committed
95 96 97 98
Otherwise, not displayed."
  :type 'boolean
  :group 'vc)

99

Karl Heuer's avatar
Karl Heuer committed
100 101 102 103
(defcustom vc-consult-headers t
  "*If non-nil, identify work files by searching for version headers."
  :type 'boolean
  :group 'vc)
104

Karl Heuer's avatar
Karl Heuer committed
105
(defcustom vc-keep-workfiles t
106 107
  "*If non-nil, don't delete working files after registering changes.
If the back-end is CVS, workfiles are always kept, regardless of the
Karl Heuer's avatar
Karl Heuer committed
108 109 110
value of this flag."
  :type 'boolean
  :group 'vc)
111

Karl Heuer's avatar
Karl Heuer committed
112
(defcustom vc-mistrust-permissions nil
113 114
  "*If non-nil, don't assume that permissions and ownership track 
version-control status.  If nil, do rely on the permissions.
Karl Heuer's avatar
Karl Heuer committed
115 116 117
See also variable `vc-consult-headers'."
  :type 'boolean
  :group 'vc)
118 119 120 121 122 123 124 125

(defun vc-mistrust-permissions (file)
  ;; Access function to the above.
  (or (eq vc-mistrust-permissions 't)
      (and vc-mistrust-permissions
	   (funcall vc-mistrust-permissions 
		    (vc-backend-subdirectory-name file)))))

Eric S. Raymond's avatar
Eric S. Raymond committed
126
;; Tell Emacs about this new kind of minor mode
Eric S. Raymond's avatar
Eric S. Raymond committed
127 128
(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
129 130
				 minor-mode-alist)))

Eric S. Raymond's avatar
Eric S. Raymond committed
131
(make-variable-buffer-local 'vc-mode)
132
(put 'vc-mode 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
133 134

;; We need a notion of per-file properties because the version
135 136 137 138
;; 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
139

140 141 142
(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
143 144 145
(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.")

146 147 148
(defvar vc-buffer-backend t)
(make-variable-buffer-local 'vc-buffer-backend)

Eric S. Raymond's avatar
Eric S. Raymond committed
149 150 151 152 153 154 155 156
(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))

157 158 159
(defun vc-file-clearprops (file)
  ;; clear all properties of a given file
  (setplist (intern file vc-file-prop-obarray) nil))
160

161 162
;;; Functions that determine property values, by examining the 
;;; working file, the master file, or log program output
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

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

216 217 218 219
(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
Karl Heuer's avatar
Karl Heuer committed
220
  ;; (default 8 kByte), until the first occurrence of
221 222
  ;; LIMIT is found. The function returns nil if FILE 
  ;; doesn't exist.
223
  (erase-buffer)
224 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 261 262 263 264 265 266 267 268
  (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))))
269 270 271 272
	       (setq index (match-end 0)))
	     (if (string-match ";[ \t\n]+strict;" locks index)
		 (vc-file-setprop file 'vc-checkout-model 'manual)
	       (vc-file-setprop file 'vc-checkout-model 'implicit))))
273 274
      (vc-file-setprop file 'vc-master-locks (or master-locks 'none)))))

275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
(defun vc-simple-command (okstatus command file &rest args)
  ;; Simple version of vc-do-command, for use in vc-hooks only.
  ;; 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)) exec-status
	;; 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)))
    (setq exec-status 
	  (apply 'call-process command nil "*vc-info*" nil 
		 (append args (list file))))
    (cond ((> exec-status okstatus)
	   (switch-to-buffer (get-file-buffer file))
	   (shrink-window-if-larger-than-buffer
	    (display-buffer "*vc-info*"))
	   (error "Couldn't find version control information")))
    exec-status))

298 299
(defun vc-fetch-master-properties (file)
  ;; Fetch those properties of FILE that are stored in the master file.
300 301 302 303
  ;; 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.
304 305 306 307 308
  (save-excursion
    (cond
     ((eq (vc-backend file) 'SCCS)
      (set-buffer (get-buffer-create "*vc-info*"))
      (if (vc-insert-file (vc-lock-file file))
309
	  (vc-parse-locks file (buffer-string))
310 311 312 313 314
	(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 \\([^ ]+\\) .* " 
315
			   (regexp-quote (vc-user-login-name)) " ") 1))
316 317 318 319 320
       file
       '(vc-latest-version vc-your-latest-version)))

     ((eq (vc-backend file) 'RCS)
      (set-buffer (get-buffer-create "*vc-info*"))
321
      (vc-insert-file (vc-name file) "^[0-9]")
322 323 324
      (vc-parse-buffer 
       (list '("^head[ \t\n]+\\([^;]+\\);" 1)
	     '("^branch[ \t\n]+\\([^;]+\\);" 1)
325
	     '("^locks[ \t\n]*\\([^;]*;\\([ \t\n]*strict;\\)?\\)" 1))
326 327 328
       file
       '(vc-head-version
	 vc-default-branch
329
	 vc-master-locks))
330 331 332
      ;; determine vc-master-workfile-version: it is either the head
      ;; of the trunk, the head of the default branch, or the 
      ;; "default branch" itself, if that is a full revision number.
333 334 335 336
      (let ((default-branch (vc-file-getprop file 'vc-default-branch)))
	(cond 
	 ;; no default branch
	 ((or (not default-branch) (string= "" default-branch))
337
	  (vc-file-setprop file 'vc-master-workfile-version 
338 339 340 341
			   (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)
342 343
	  (vc-file-setprop file 'vc-master-workfile-version default-branch))
	 ;; else, search for the head of the default branch
344
	 (t (vc-insert-file (vc-name file) "^desc")
345
	    (vc-parse-buffer (list (list 
346 347 348
	       (concat "^\\(" 
		       (regexp-quote default-branch)
		       "\\.[0-9]+\\)\ndate[ \t]+\\([0-9.]+\\);") 1 2))
349
			 file '(vc-master-workfile-version)))))
350 351 352 353
      ;; translate the locks
      (vc-parse-locks file (vc-file-getprop file 'vc-master-locks)))

     ((eq (vc-backend file) 'CVS)
354
      (save-excursion
355 356 357 358 359
        ;; Call "cvs status" in the right directory, passing only the
        ;; nondirectory part of the file name -- otherwise CVS might 
        ;; silently give a wrong result.
        (let ((default-directory (file-name-directory file)))
          (vc-simple-command 0 "cvs" (file-name-nondirectory file) "status"))
360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376
	(set-buffer (get-buffer "*vc-info*"))
	(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)
	   ("^File: [^ \t]+[ \t]+Status: \\(.*\\)" 1))
	 file
	 '(vc-latest-version vc-cvs-status))
	;; Translate those status values that we understand 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))))
	  ((vc-file-setprop file 'vc-cvs-status
377 378 379
	    (cond 
	     ((string-match "Locally Modified"    status) 'locally-modified)
	     ((string-match "Needs Merge"         status) 'needs-merge)
380 381
	     ((string-match "Needs \\(Checkout\\|Patch\\)" status) 
                                                          'needs-checkout)
382 383
	     ((string-match "Unresolved Conflict" status) 'unresolved-conflict)
	     ((string-match "Locally Added"       status) 'locally-added)
384
	     ((string-match "New file!"           status) 'locally-added)
385
	     (t 'unknown)
386
	     ))))))))
387 388
    (if (get-buffer "*vc-info*")
	(kill-buffer (get-buffer "*vc-info*")))))
389 390 391 392 393 394 395 396 397 398 399 400 401 402

;;; 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 
403
  (cond
404
   ((or (not vc-consult-headers) 
405
	(not (get-file-buffer file))) nil)
406 407
   ((let (status version locking-user)
     (save-excursion
408 409 410 411 412
      (set-buffer (get-file-buffer file))
      (goto-char (point-min))
      (cond  
       ;; search for $Id or $Header
       ;; -------------------------
413 414 415
       ((or (and (search-forward "$Id: " nil t)
		 (looking-at "[^ ]+ \\([0-9.]+\\) "))
	    (and (progn (goto-char (point-min))
416
			(search-forward "$Header: " nil t))
417
		 (looking-at "[^ ]+ \\([0-9.]+\\) ")))
418
	(goto-char (match-end 0))
419
	;; if found, store the revision number ...
420 421
	(setq version (buffer-substring-no-properties (match-beginning 1)
						      (match-end 1)))
422 423 424 425 426 427 428
	;; ... and check for the locking state
	(cond 
	 ((looking-at
	   (concat "[0-9]+[/-][01][0-9][/-][0-3][0-9] "             ; date
	    "[0-2][0-9]:[0-5][0-9]+:[0-6][0-9]+\\([+-][0-9:]+\\)? " ; time
	           "[^ ]+ [^ ]+ "))                       ; author & state
	  (goto-char (match-end 0)) ; [0-6] in regexp handles leap seconds
429
	  (cond 
430 431 432 433 434 435 436
	   ;; unlocked revision
	   ((looking-at "\\$")
	    (setq locking-user 'none)
	    (setq status 'rev-and-lock))
	   ;; revision is locked by some user
	   ((looking-at "\\([^ ]+\\) \\$")
	    (setq locking-user
437 438
		  (buffer-substring-no-properties (match-beginning 1)
						  (match-end 1)))
439 440 441 442 443 444
	    (setq status 'rev-and-lock))
	   ;; everything else: false
	   (nil)))
	 ;; unexpected information in
	 ;; keyword string --> quit
	 (nil)))
445 446 447 448 449 450
       ;; search for $Revision
       ;; --------------------
       ((re-search-forward (concat "\\$" 
				   "Revision: \\([0-9.]+\\) \\$")
			   nil t)
	;; if found, store the revision number ...
451 452
	(setq version (buffer-substring-no-properties (match-beginning 1)
						      (match-end 1)))
453 454 455 456
	;; and see if there's any lock information
	(goto-char (point-min))
	(if (re-search-forward (concat "\\$" "Locker:") nil t)
	    (cond ((looking-at " \\([^ ]+\\) \\$")
457 458 459
		   (setq locking-user (buffer-substring-no-properties
				       (match-beginning 1)
				       (match-end 1)))
460 461 462 463 464 465 466 467
		   (setq status 'rev-and-lock))
		  ((looking-at " *\\$") 
		   (setq locking-user 'none)
		   (setq status 'rev-and-lock))
		  (t 
		   (setq locking-user 'none)
		   (setq status 'rev-and-lock)))
	  (setq status 'rev)))
468 469
       ;; else: nothing found
       ;; -------------------
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484
       (t nil)))
     (if status (vc-file-setprop file 'vc-workfile-version version))
     (and (eq status 'rev-and-lock)
	  (eq (vc-backend file) 'RCS)
	  (vc-file-setprop file 'vc-locking-user locking-user)
	  ;; If the file has headers, we don't want to query the master file,
	  ;; because that would eliminate all the performance gain the headers
	  ;; brought us.  We therefore use a heuristic for the checkout model 
	  ;; now:  If we trust the file permissions, and the file is not 
          ;; locked, then if the file is read-only the checkout model is 
	  ;; `manual', otherwise `implicit'.
	  (not (vc-mistrust-permissions file))
	  (not (vc-locking-user file))
	  (if (string-match ".r-..-..-." (nth 8 (file-attributes file)))
	      (vc-file-setprop file 'vc-checkout-model 'manual)
485 486
	    (vc-file-setprop file 'vc-checkout-model 'implicit)))
     status))))
487

488 489 490 491 492 493 494 495 496
;;; 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
497 498 499 500 501 502 503 504 505

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

506
(defun vc-name (file)
507 508
  "Return the master name of a file, nil if it is not registered.
For CVS, the full name of CVS/Entries is returned."
509 510 511 512 513 514
  (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)))))))
515

516 517 518 519 520 521 522 523 524
(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))))))))
525

526 527
(defun vc-checkout-model (file)
  ;; Return `manual' if the user has to type C-x C-q to check out FILE.
528 529 530 531 532 533 534 535 536 537 538 539 540
  ;; Return `implicit' if the file can be modified without locking it first.
  (or
   (vc-file-getprop file 'vc-checkout-model)
   (cond 
    ((eq (vc-backend file) 'SCCS)
     (vc-file-setprop file 'vc-checkout-model 'manual))
    ((eq (vc-backend file) 'RCS) 
     (vc-consult-rcs-headers file)
     (or (vc-file-getprop file 'vc-checkout-model)
	 (progn (vc-fetch-master-properties file)
		(vc-file-getprop file 'vc-checkout-model))))
    ((eq (vc-backend file) 'CVS)
     (vc-file-setprop file 'vc-checkout-model
541 542 543 544 545 546 547 548 549 550
      (cond
       ((getenv "CVSREAD") 'manual)
       ;; If the file is not writeable, this is probably because the
       ;; file is being "watched" by other developers.  Use "manual"
       ;; checkout in this case.  (If vc-mistrust-permissions was t,
       ;; we actually shouldn't trust this, but there is no other way
       ;; to learn this from CVS at the moment (version 1.9).)
       ((string-match "r-..-..-." (nth 8 (file-attributes file)))
        'manual)
       (t 'implicit)))))))
551

552
;;; properties indicating the locking state
553 554 555 556 557

(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))
558
	(t (vc-fetch-master-properties file)
559 560
	   (vc-file-getprop file 'vc-cvs-status))))

561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579
(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)))))

580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599
(defun vc-lock-from-permissions (file)
  ;; If the permissions can be trusted for this file, determine the
  ;; locking state from them.  Returns (user-login-name), `none', or nil.
   ;;   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.
  (let ((attributes (file-attributes file)))
    (if (not (vc-mistrust-permissions 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)))
600
	       (vc-file-setprop file 'vc-locking-user (vc-user-login-name)))
601 602
	      (nil)))))

603 604 605 606 607 608 609 610 611 612
(defun vc-user-login-name (&optional uid)
  ;; Return the name under which the user is logged in, as a string.
  ;; (With optional argument UID, return the name of that user.)
  ;; This function does the same as `user-login-name', but unlike
  ;; that, it never returns nil.  If a UID cannot be resolved, that
  ;; UID is returned as a string.
  (or (user-login-name uid)
      (and uid (number-to-string uid))
      (number-to-string (user-uid))))

613
(defun vc-file-owner (file)
614
  ;; Return who owns FILE (user name, as a string).
615
  (vc-user-login-name (nth 2 (file-attributes file))))
616 617 618

(defun vc-rcs-lock-from-diff (file)
  ;; Diff the file against the master version.  If differences are found,
619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634
  ;; mark the file locked.  This is only used for RCS with non-strict
  ;; locking.  (If "rcsdiff" doesn't understand --brief, we do a double-take
  ;; and remember the fact for the future.)
  (let* ((version (concat "-r" (vc-workfile-version file)))
         (status (if (eq vc-rcsdiff-knows-brief 'no)
                     (vc-simple-command 1 "rcsdiff" file version)
                   (vc-simple-command 2 "rcsdiff" file "--brief" version))))
    (if (eq status 2)
        (if (not vc-rcsdiff-knows-brief)
            (setq vc-rcsdiff-knows-brief 'no
                  status (vc-simple-command 1 "rcsdiff" file version))
          (error "rcsdiff failed."))
      (if (not vc-rcsdiff-knows-brief) (setq vc-rcsdiff-knows-brief 'yes)))
    (if (zerop status)
        (vc-file-setprop file 'vc-locking-user 'none)
      (vc-file-setprop file 'vc-locking-user (vc-file-owner file)))))
635

636
(defun vc-locking-user (file)
637
  ;; Return the name of the person currently holding a lock on FILE.
638
  ;; Return nil if there is no such person.
639
  ;;   Under CVS, a file is considered locked if it has been modified since
640
  ;; it was checked out.
641 642
  ;;   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
643
  ;; is `none', to distinguish it from an unknown locking state.  That value
644 645 646 647 648 649 650 651 652
  ;; 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
       ((eq (vc-backend file) 'CVS)
653 654
	(or (and (eq (vc-checkout-model file) 'manual)
		 (vc-lock-from-permissions file))
655 656 657
	    (and (equal (vc-file-getprop file 'vc-checkout-time)
			(nth 5 (file-attributes file)))
		 (vc-file-setprop file 'vc-locking-user 'none))
658
	    (vc-file-setprop file 'vc-locking-user (vc-file-owner file))))
659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691

       ((eq (vc-backend file) 'RCS)
	(let (p-lock)

	  ;; Check for RCS headers first
	  (or (eq (vc-consult-rcs-headers file) 'rev-and-lock)

	      ;; If there are no headers, try to learn it 
	      ;; from the permissions.
	      (and (setq p-lock (vc-lock-from-permissions file))
		   (if (eq p-lock 'none)

		       ;; If the permissions say "not locked", we know
		       ;; that the checkout model must be `manual'.
		       (vc-file-setprop file 'vc-checkout-model 'manual)

		     ;; If the permissions say "locked", we can only trust
		     ;; this *if* the checkout model is `manual'.
		     (eq (vc-checkout-model file) 'manual)))

	      ;; Otherwise, use lock information from the master file.
	      (vc-file-setprop file 'vc-locking-user
			       (vc-master-locking-user file)))

	  ;; Finally, if the file is not explicitly locked
	  ;; it might still be locked implicitly.
	  (and (eq (vc-file-getprop file 'vc-locking-user) 'none)
	       (eq (vc-checkout-model file) 'implicit)
	       (vc-rcs-lock-from-diff file))))

      ((eq (vc-backend file) 'SCCS)
       (or (vc-lock-from-permissions file)
	   (vc-file-setprop file 'vc-locking-user 
692
			    (vc-master-locking-user file)))))
693 694 695
  
      ;; convert a possible 'none value
      (setq locking-user (vc-file-getprop file 'vc-locking-user))
696
      (if (eq locking-user 'none) nil locking-user))))
697 698

;;; properties to store current and recent version numbers
699 700 701

(defun vc-latest-version (file)
  ;; Return version level of the latest version of FILE
702
  (cond ((vc-file-getprop file 'vc-latest-version))
703
	(t (vc-fetch-properties file)
704
	   (vc-file-getprop file 'vc-latest-version))))
705 706 707

(defun vc-your-latest-version (file)
  ;; Return version level of the latest version of FILE checked in by you
708
  (cond ((vc-file-getprop file 'vc-your-latest-version))
709
	(t (vc-fetch-properties file)
710
	   (vc-file-getprop file 'vc-your-latest-version))))
711

712 713
(defun vc-master-workfile-version (file)
  ;; Return the master file's idea of what is the current workfile version.
714
  ;; This property is defined for RCS only.
715
  (cond ((vc-file-getprop file 'vc-master-workfile-version))
716
	(t (vc-fetch-master-properties file)
717
	   (vc-file-getprop file 'vc-master-workfile-version))))
718

719 720 721
(defun vc-fetch-properties (file)
  ;; Fetch vc-latest-version and vc-your-latest-version
  ;; if that wasn't already done.
722 723
  (cond
   ((eq (vc-backend file) 'RCS)
724 725 726 727 728 729 730 731
    (save-excursion
      (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]+"
732
			   (regexp-quote (vc-user-login-name)) ";") 1 2))
733
       file
734 735 736
       '(vc-latest-version vc-your-latest-version))
      (if (get-buffer "*vc-info*")
	  (kill-buffer (get-buffer "*vc-info*")))))
737
   (t (vc-fetch-master-properties file))
738 739
   ))

740 741 742 743
(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, 
744
  ;; vc-master-workfile-version is taken.
745 746 747 748 749 750 751 752
  ;; 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)
753
	   (let ((rev (cond ((vc-master-workfile-version file))
754 755 756 757 758 759
			    ((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)
760 761 762
	   (catch 'found
	     (vc-find-cvs-master (file-name-directory file)
				 (file-name-nondirectory file)))
763
	   (vc-file-getprop file 'vc-workfile-version)))))
764

Eric S. Raymond's avatar
Eric S. Raymond committed
765 766 767
;;; actual version-control code starts here

(defun vc-registered (file)
768 769
  (let (handler handlers)
    (if (boundp 'file-name-handler-alist)
770
	(setq handler (find-file-name-handler file 'vc-registered)))
771 772 773 774 775 776 777 778
    (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
779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794
	      (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))))))))
795 796
	   vc-master-templates)
	  nil)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
797

Richard M. Stallman's avatar
Richard M. Stallman committed
798 799 800
(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)).
801 802 803 804
  ;; Note: This function throws the name of CVS/Entries
  ;; NOT that of the RCS master file (because we wouldn't be able
  ;; to access it under remote CVS).
  ;; The function returns nil if DIRNAME/BASENAME is not handled by CVS.
805 806
  (if (and vc-handle-cvs
	   (file-directory-p (concat dirname "CVS/"))
807
	   (file-readable-p (concat dirname "CVS/Entries")))
808 809 810 811 812
      (let ((file (concat dirname basename))
            ;; make sure that the file name is searched 
            ;; case-sensitively
            (case-fold-search nil)
            buffer)
Richard M. Stallman's avatar
Richard M. Stallman committed
813 814
	(unwind-protect
	    (save-excursion
815 816
	      (setq buffer (set-buffer (get-buffer-create "*vc-info*")))
	      (vc-insert-file (concat dirname "CVS/Entries"))
Richard M. Stallman's avatar
Richard M. Stallman committed
817 818
	      (goto-char (point-min))
	      (cond
819 820 821 822 823 824
	       ;; entry for a "locally added" file (not yet committed)
	       ((re-search-forward
		 (concat "^/" (regexp-quote basename) "/0/") nil t)
		(vc-file-setprop file 'vc-checkout-time 0)
		(vc-file-setprop file 'vc-workfile-version "0")
		(throw 'found (cons (concat dirname "CVS/Entries") 'CVS)))
825
	       ;; normal entry
Richard M. Stallman's avatar
Richard M. Stallman committed
826
	       ((re-search-forward
827
		 (concat "^/" (regexp-quote basename) 
828 829 830 831 832 833 834 835 836 837
                         ;; revision
                         "/\\([^/]*\\)" 
                         ;; timestamp
                         "/[A-Z][a-z][a-z]"       ;; week day (irrelevant)
                         " \\([A-Z][a-z][a-z]\\)" ;; month name
                         " *\\([0-9]*\\)"         ;; day of month
                         " \\([0-9]*\\):\\([0-9]*\\):\\([0-9]*\\)"  ;; hms
                         " \\([0-9]*\\)"          ;; year
                         ;; optional conflict field
                         "\\(+[^/]*\\)?/")
Richard M. Stallman's avatar
Richard M. Stallman committed
838
		 nil t)
839 840 841
		;; We found it.  Store away version number now that we 
		;; are anyhow so close to finding it.
		(vc-file-setprop file
842
				 'vc-workfile-version
843 844 845
				 (match-string 1))
		;; If the file hasn't been modified since checkout,
		;; store the checkout-time.
846
		(let ((mtime (nth 5 (file-attributes file)))
847 848 849 850 851
		      (second (string-to-number (match-string 6)))
		      (minute (string-to-number (match-string 5)))
		      (hour (string-to-number (match-string 4)))
		      (day (string-to-number (match-string 3)))
		      (year (string-to-number (match-string 7))))
852 853 854 855
		  (if (equal mtime
			     (encode-time
			      second minute hour day
			      (/ (string-match
856
				  (match-string 2)
857 858 859
				  "xxxJanFebMarAprMayJunJulAugSepOctNovDec")
				 3)
			      year 0))
860 861
		      (vc-file-setprop file 'vc-checkout-time mtime)
		    (vc-file-setprop file 'vc-checkout-time 0)))
862
		(throw 'found (cons (concat dirname "CVS/Entries") 'CVS)))
863 864
               ;; entry with arbitrary text as timestamp
               ;; (this means we should consider it modified)
865
	       ((re-search-forward
866 867 868 869 870 871 872 873 874 875 876
		 (concat "^/" (regexp-quote basename) 
                         ;; revision
                         "/\\([^/]*\\)" 
                         ;; timestamp (arbitrary text)
                         "/[^/]*"
                         ;; optional conflict field
                         "\\(+[^/]*\\)?/")
		 nil t)
		;; We found it.  Store away version number now that we 
		;; are anyhow so close to finding it.
		(vc-file-setprop file 'vc-workfile-version (match-string 1))
877 878
		(vc-file-setprop file 'vc-checkout-time 0)
		(throw 'found (cons (concat dirname "CVS/Entries") 'CVS)))
879
	       (t nil)))
880
	  (kill-buffer buffer)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
881

882 883 884
(defun vc-buffer-backend ()
  "Return the version-control type of the visited file, or nil if none."
  (if (eq vc-buffer-backend t)
885
      (setq vc-buffer-backend (vc-backend (buffer-file-name)))
886 887
    vc-buffer-backend))

888
(defun vc-toggle-read-only (&optional verbose)
889 890 891
  "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
892
of the buffer.  With prefix argument, ask for version number."
893
  (interactive "P")
894 895 896
  (if (or (and (boundp 'vc-dired-mode) vc-dired-mode)
          ;; use boundp because vc.el might not be loaded
          (vc-backend (buffer-file-name)))
897
      (vc-next-action verbose)
Eric S. Raymond's avatar
Eric S. Raymond committed
898
    (toggle-read-only)))
899
(define-key global-map "\C-x\C-q" 'vc-toggle-read-only)
Eric S. Raymond's avatar
Eric S. Raymond committed
900

901 902 903 904 905 906 907 908 909 910 911 912 913
(defun vc-after-save ()
  ;; Function to be called by basic-save-buffer (in files.el).
  ;; If the file in the current buffer is under version control,
  ;; not locked, and the checkout model for it is `implicit',
  ;; mark it "locked" and redisplay the mode line.
  (let ((file (buffer-file-name)))
    (and (vc-file-getprop file 'vc-backend)
	 ;; ...check the property directly, not through the function of the
	 ;; same name.  Otherwise Emacs would check for a master file
	 ;; each time a non-version-controlled buffer is saved.
	 ;; The property is computed when the file is visited, so if it
	 ;; is `nil' now, it is certain that the file is NOT 
	 ;; version-controlled.
914 915 916 917 918 919 920
	 (or (and (equal (vc-file-getprop file 'vc-checkout-time)
			 (nth 5 (file-attributes file)))
		  ;; File has been saved in the same second in which
		  ;; it was checked out.  Clear the checkout-time
		  ;; to avoid confusion.
		  (vc-file-setprop file 'vc-checkout-time nil))
	     t)
921 922
	 (not (vc-locking-user file))
	 (eq (vc-checkout-model file) 'implicit)
923
	 (vc-file-setprop file 'vc-locking-user (vc-user-login-name))
924 925 926 927
	 (or (and (eq (vc-backend file) 'CVS) 
		  (vc-file-setprop file 'vc-cvs-status nil))
	     t)
	 (vc-mode-line file))))
928

Eric S. Raymond's avatar
Eric S. Raymond committed
929
(defun vc-mode-line (file &optional label)
Eric S. Raymond's avatar
Eric S. Raymond committed
930
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
931
The value is set in the current buffer, which should be the buffer
932 933
visiting FILE.  Second optional arg LABEL is put in place of version
control system name."
934
  (interactive (list buffer-file-name nil))
935
  (let ((vc-type (vc-backend file)))
936
    (setq vc-mode
937 938 939
	  (and vc-type
	       (concat " " (or label (symbol-name vc-type)) 
		       (and vc-display-status (vc-status file)))))
940 941
    ;; If the file is locked by some other user, make
    ;; the buffer read-only.  Like this, even root
Richard M. Stallman's avatar
Richard M. Stallman committed
942
    ;; cannot modify a file that someone else has locked.
943 944
    (and vc-type 
	 (equal file (buffer-file-name))
945
	 (vc-locking-user file)
946
	 (not (string= (vc-user-login-name) (vc-locking-user file)))
947
	 (setq buffer-read-only t))
Richard M. Stallman's avatar
Richard M. Stallman committed
948 949 950 951
    ;; If the user is root, and the file is not owner-writable,
    ;; then pretend that we can't write it
    ;; even though we can (because root can write anything).
    ;; This way, even root cannot modify a file that isn't locked.
952 953 954 955 956 957
    (and vc-type
	 (equal file (buffer-file-name))
	 (not buffer-read-only)
	 (zerop (user-real-uid))
	 (zerop (logand (file-modes (buffer-file-name)) 128))
	 (setq buffer-read-only t))
958 959 960
    (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
961

962
(defun vc-status (file)
963
  ;; Return string for placement in modeline by `vc-mode-line'.
964
  ;; Format:
965
  ;;
966 967 968 969
  ;;   "-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
970
  ;;
971 972
  ;; In the CVS case, a "locked" working file is a 
  ;; working file that is modified with respect to the master.
973 974
  ;; The file is "locked" from the moment when the user saves
  ;; the modified buffer.
975 976 977 978 979 980 981
  ;; 
  ;; This function assumes that the file is registered.

  (let ((locker (vc-locking-user file))
	(rev (vc-workfile-version file)))
    (cond ((string= "0" rev)
	   " @@")
982 983
	  ((not locker)
	   (concat "-" rev))
984
	  ((string= locker (vc-user-login-name))
985 986 987
	   (concat ":" rev))
	  (t 
	   (concat ":" locker ":" rev)))))
988

989 990 991 992 993
(defun vc-follow-link ()
  ;; If the current buffer visits a symbolic link, this function makes it
  ;; visit the real file instead.  If the real file is already visited in 
  ;; another buffer, make that buffer current, and kill the buffer 
  ;; that visits the link.
994
  (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name)))
995 996 997 998
         (true-buffer (find-buffer-visiting truename))
	 (this-buffer (current-buffer)))
    (if (eq true-buffer this-buffer)
	(progn
999
	  (kill-buffer this-buffer)
1000 1001 1002
	  ;; In principle, we could do something like set-visited-file-name.
	  ;; However, it can't be exactly the same as set-visited-file-name.
	  ;; I'm not going to work out the details right now. -- rms.
1003
	  (set-buffer (find-file-noselect truename)))
1004 1005
      (set-buffer true-buffer)
      (kill-buffer this-buffer))))
1006

Eric S. Raymond's avatar
Eric S. Raymond committed
1007 1008
;;; install a call to the above as a find-file hook
(defun vc-find-file-hook ()
1009 1010
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
1011 1012 1013 1014
  (cond 
   (buffer-file-name
    (vc-file-clearprops buffer-file-name)
    (cond
1015
     ((vc-backend buffer-file-name)
1016 1017 1018 1019 1020
      (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)
1021 1022
	     (setq backup-inhibited t))))
     ((let* ((link (file-symlink-p buffer-file-name))
1023
	     (link-type (and link (vc-backend (file-chase-links link)))))
1024
	(if link-type
1025 1026 1027
            (cond ((eq vc-follow-symlinks nil)
                   (message
        "Warning: symbolic link to %s-controlled source file" link-type))
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
                  ((or (not (eq vc-follow-symlinks 'ask))
		       ;; If we already visited this file by following
		       ;; the link, don't ask again if we try to visit
		       ;; it again.  GUD does that, and repeated questions
		       ;; are painful.
		       (get-file-buffer
			(abbreviate-file-name (file-chase-links buffer-file-name))))
		       
		   (vc-follow-link)
		   (message "Followed link to %s" buffer-file-name)
		   (vc-find-file-hook))
                  (t
1040 1041
                   (if (yes-or-no-p (format
        "Symbolic link to %s-controlled source file; follow link? " link-type))
1042
                       (progn (vc-follow-link)
1043 1044 1045 1046
                              (message "Followed link to %s" buffer-file-name)
                              (vc-find-file-hook))
                     (message 
        "Warning: editing through the link bypasses version control")
1047
                     ))))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
1048

1049
(add-hook 'find-file-hooks 'vc-find-file-hook)
Eric S. Raymond's avatar
Eric S. Raymond committed
1050 1051 1052 1053 1054

;;; 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."
1055
  (if (vc-backend buffer-file-name)
1056
      (save-excursion
Eric S. Raymond's avatar
Eric S. Raymond committed
1057
	(require 'vc)
1058
	(setq default-directory (file-name-directory (buffer-file-name)))
Eric S. Raymond's avatar
Eric S. Raymond committed
1059 1060
	(not (vc-error-occurred (vc-checkout buffer-file-name))))))