vc-hooks.el 47.8 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, 1996, 1998 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
;; $Id: vc-hooks.el,v 1.108 1998/05/06 13:36:45 spiegel Exp rms $
André Spiegel's avatar
André Spiegel committed
9

Eric S. Raymond's avatar
Eric S. Raymond committed
10 11 12 13 14 15 16 17 18 19 20 21 22
;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
Erik Naggum's avatar
Erik Naggum committed
23 24 25
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
;; Boston, MA 02111-1307, USA.
Eric S. Raymond's avatar
Eric S. Raymond committed
26 27 28

;;; Commentary:

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

;;; Code:

36 37
;; Customization Variables (the rest is in vc.el)

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

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

Karl Heuer's avatar
Karl Heuer committed
50
(defcustom vc-rcsdiff-knows-brief nil
51 52
  "*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
53 54 55
to use --brief and sets this variable to remember whether it worked."
  :type '(choice (const nil) (const yes) (const no))
  :group 'vc)
56

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

Karl Heuer's avatar
Karl Heuer committed
65
(defcustom vc-master-templates
Eric S. Raymond's avatar
Eric S. Raymond committed
66
  '(("%sRCS/%s,v" . RCS) ("%s%s,v" . RCS) ("%sRCS/%s" . RCS)
Richard M. Stallman's avatar
Richard M. Stallman committed
67
    ("%sSCCS/s.%s" . SCCS) ("%ss.%s". SCCS)
68 69
    vc-find-cvs-master
    vc-search-sccs-project-dir)
Eric S. Raymond's avatar
Eric S. Raymond committed
70 71
  "*Where to look for version-control master files.
The first pair corresponding to a given back end is used as a template
72
when creating new masters.
Karl Heuer's avatar
Karl Heuer committed
73 74 75
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
76

Karl Heuer's avatar
Karl Heuer committed
77
(defcustom vc-make-backup-files nil
78
  "*If non-nil, backups of registered files are made as with other files.
Karl Heuer's avatar
Karl Heuer committed
79 80 81
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
82

Karl Heuer's avatar
Karl Heuer committed
83
(defcustom vc-follow-symlinks 'ask
84 85 86 87 88 89 90
  "*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
91 92 93
visited and a warning displayed."
  :type '(choice (const ask) (const nil) (const t))
  :group 'vc)
94

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

101

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

Karl Heuer's avatar
Karl Heuer committed
107
(defcustom vc-keep-workfiles t
108 109
  "*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
110 111 112
value of this flag."
  :type 'boolean
  :group 'vc)
113

Karl Heuer's avatar
Karl Heuer committed
114
(defcustom vc-mistrust-permissions nil
115 116
  "*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
117 118 119
See also variable `vc-consult-headers'."
  :type 'boolean
  :group 'vc)
120

121 122 123 124 125 126 127
(defcustom vc-ignore-vc-files nil
  "*If non-nil don't look for version control information when finding files.

It may be useful to set this if (say) you edit files in a directory
containing corresponding RCS files but don't have RCS available;
similarly for other version control systems."
  :type 'boolean
Dan Nicolaescu's avatar
Dan Nicolaescu committed
128 129
  :group 'vc
  :version "20.3")
130

131 132 133 134 135 136 137
(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
138
;; Tell Emacs about this new kind of minor mode
Eric S. Raymond's avatar
Eric S. Raymond committed
139 140
(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
141 142
				 minor-mode-alist)))

Eric S. Raymond's avatar
Eric S. Raymond committed
143
(make-variable-buffer-local 'vc-mode)
144
(put 'vc-mode 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
145 146

;; We need a notion of per-file properties because the version
147 148 149 150
;; 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
151

152 153 154
(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
155 156 157
(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.")

158 159 160
(defvar vc-buffer-backend t)
(make-variable-buffer-local 'vc-buffer-backend)

Eric S. Raymond's avatar
Eric S. Raymond committed
161 162 163 164 165 166 167 168
(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))

169 170 171
(defun vc-file-clearprops (file)
  ;; clear all properties of a given file
  (setplist (intern file vc-file-prop-obarray) nil))
172

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

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

228 229 230 231
(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
232
  ;; (default 8 kByte), until the first occurrence of
233 234
  ;; LIMIT is found. The function returns nil if FILE 
  ;; doesn't exist.
235
  (erase-buffer)
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 269 270 271 272 273 274 275 276 277 278 279 280
  (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))))
281 282 283 284
	       (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))))
285 286
      (vc-file-setprop file 'vc-master-locks (or master-locks 'none)))))

287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
(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))

310
(defun vc-parse-cvs-status (&optional full)
311
  ;; Parse output of "cvs status" command in the current buffer and
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
  ;; set file properties accordingly.  Unless FULL is t, parse only
  ;; essential information.
  (let (file status)
    (goto-char (point-min))
    (if (re-search-forward "^File: " nil t)
        (cond 
         ((looking-at "no file") nil)
         ((re-search-forward "\\=\\([^ \t]+\\)" nil t)
          (setq file (concat default-directory (match-string 1)))
          (vc-file-setprop file 'vc-backend 'CVS)
          (if (not (re-search-forward "\\=[ \t]+Status: \\(.*\\)" nil t))
              (setq status "Unknown")
            (setq status (match-string 1)))
          (if (and full 
                   (re-search-forward 
  "\\(RCS Version\\|RCS Revision\\|Repository revision\\):[\t ]+\\([0-9.]+\\)"
                    nil t))
              (vc-file-setprop file 'vc-latest-version (match-string 2)))
          (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
             (cond 
              ((string-match "Locally Modified"    status) 'locally-modified)
              ((string-match "Needs Merge"         status) 'needs-merge)
              ((string-match "Needs \\(Checkout\\|Patch\\)" status) 
               'needs-checkout)
              ((string-match "Unresolved Conflict" status) 'unresolved-conflict)
              ((string-match "Locally Added"       status) 'locally-added)
              ((string-match "New file!"           status) 'locally-added)
              (t 'unknown))))))))))
345

346 347
(defun vc-fetch-master-properties (file)
  ;; Fetch those properties of FILE that are stored in the master file.
348 349 350 351
  ;; 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.
352 353 354 355 356
  (save-excursion
    (cond
     ((eq (vc-backend file) 'SCCS)
      (set-buffer (get-buffer-create "*vc-info*"))
      (if (vc-insert-file (vc-lock-file file))
357
	  (vc-parse-locks file (buffer-string))
358 359 360 361 362
	(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 \\([^ ]+\\) .* " 
363
			   (regexp-quote (vc-user-login-name)) " ") 1))
364 365 366 367 368
       file
       '(vc-latest-version vc-your-latest-version)))

     ((eq (vc-backend file) 'RCS)
      (set-buffer (get-buffer-create "*vc-info*"))
369
      (vc-insert-file (vc-name file) "^[0-9]")
370 371 372
      (vc-parse-buffer 
       (list '("^head[ \t\n]+\\([^;]+\\);" 1)
	     '("^branch[ \t\n]+\\([^;]+\\);" 1)
373
	     '("^locks[ \t\n]*\\([^;]*;\\([ \t\n]*strict;\\)?\\)" 1))
374 375 376
       file
       '(vc-head-version
	 vc-default-branch
377
	 vc-master-locks))
378 379 380
      ;; 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.
381 382 383 384
      (let ((default-branch (vc-file-getprop file 'vc-default-branch)))
	(cond 
	 ;; no default branch
	 ((or (not default-branch) (string= "" default-branch))
385
	  (vc-file-setprop file 'vc-master-workfile-version 
386 387 388 389
			   (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)
390 391
	  (vc-file-setprop file 'vc-master-workfile-version default-branch))
	 ;; else, search for the head of the default branch
392
	 (t (vc-insert-file (vc-name file) "^desc")
393
	    (vc-parse-buffer (list (list 
394 395 396
	       (concat "^\\(" 
		       (regexp-quote default-branch)
		       "\\.[0-9]+\\)\ndate[ \t]+\\([0-9.]+\\);") 1 2))
397
			 file '(vc-master-workfile-version)))))
398 399 400 401
      ;; translate the locks
      (vc-parse-locks file (vc-file-getprop file 'vc-master-locks)))

     ((eq (vc-backend file) 'CVS)
402
      (save-excursion
403 404 405 406 407
        ;; 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"))
408
	(set-buffer (get-buffer "*vc-info*"))
409
        (vc-parse-cvs-status t))))
410 411
    (if (get-buffer "*vc-info*")
	(kill-buffer (get-buffer "*vc-info*")))))
412 413 414 415 416 417 418 419 420 421 422 423 424 425

;;; 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 
426
  (cond
427
   ((or (not vc-consult-headers) 
428
	(not (get-file-buffer file))) nil)
429 430
   ((let (status version locking-user)
     (save-excursion
431 432 433 434 435
      (set-buffer (get-file-buffer file))
      (goto-char (point-min))
      (cond  
       ;; search for $Id or $Header
       ;; -------------------------
436 437
       ;; The `\ 's below avoid an RCS 5.7 bug when checking in this file.
       ((or (and (search-forward "$Id\ : " nil t)
438 439
		 (looking-at "[^ ]+ \\([0-9.]+\\) "))
	    (and (progn (goto-char (point-min))
440
			(search-forward "$Header\ : " nil t))
441
		 (looking-at "[^ ]+ \\([0-9.]+\\) ")))
442
	(goto-char (match-end 0))
443
	;; if found, store the revision number ...
444 445
	(setq version (buffer-substring-no-properties (match-beginning 1)
						      (match-end 1)))
446 447 448 449 450 451 452
	;; ... 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
453
	  (cond 
454 455 456 457 458 459 460
	   ;; unlocked revision
	   ((looking-at "\\$")
	    (setq locking-user 'none)
	    (setq status 'rev-and-lock))
	   ;; revision is locked by some user
	   ((looking-at "\\([^ ]+\\) \\$")
	    (setq locking-user
461 462
		  (buffer-substring-no-properties (match-beginning 1)
						  (match-end 1)))
463 464 465 466 467 468
	    (setq status 'rev-and-lock))
	   ;; everything else: false
	   (nil)))
	 ;; unexpected information in
	 ;; keyword string --> quit
	 (nil)))
469 470 471 472 473 474
       ;; search for $Revision
       ;; --------------------
       ((re-search-forward (concat "\\$" 
				   "Revision: \\([0-9.]+\\) \\$")
			   nil t)
	;; if found, store the revision number ...
475 476
	(setq version (buffer-substring-no-properties (match-beginning 1)
						      (match-end 1)))
477 478 479 480
	;; and see if there's any lock information
	(goto-char (point-min))
	(if (re-search-forward (concat "\\$" "Locker:") nil t)
	    (cond ((looking-at " \\([^ ]+\\) \\$")
481 482 483
		   (setq locking-user (buffer-substring-no-properties
				       (match-beginning 1)
				       (match-end 1)))
484 485 486 487 488 489 490 491
		   (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)))
492 493
       ;; else: nothing found
       ;; -------------------
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
       (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)
509 510
	    (vc-file-setprop file 'vc-checkout-model 'implicit)))
     status))))
511

512 513 514 515 516 517 518 519 520
;;; 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
521 522 523 524 525 526 527 528 529

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

530
(defun vc-name (file)
531 532
  "Return the master name of a file, nil if it is not registered.
For CVS, the full name of CVS/Entries is returned."
533
  (or (vc-file-getprop file 'vc-name)
534 535 536
      ;; Use the caching mechanism of vc-backend, below.
      (if (vc-backend file)
	  (vc-file-getprop file 'vc-name))))
537

538 539
(defun vc-backend (file)
  "Return the version-control type of a file, nil if it is not registered."
540 541 542 543 544 545 546 547 548 549 550 551 552 553
  ;; Note that internally, Emacs remembers unregistered 
  ;; files by setting the property to `none'.
  (if file
      (let ((property (vc-file-getprop file 'vc-backend))
	    (name-and-type))
	(cond ((eq property 'none) nil)
	      (property)
	      (t (setq 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)))
		   (vc-file-setprop file 'vc-backend 'none)
		   nil))))))
554

555 556
(defun vc-checkout-model (file)
  ;; Return `manual' if the user has to type C-x C-q to check out FILE.
557 558 559 560 561 562 563 564 565 566 567 568 569
  ;; 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
570 571 572 573 574 575 576 577 578 579
      (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)))))))
580

581
;;; properties indicating the locking state
582 583 584 585 586

(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))
587
	(t (vc-fetch-master-properties file)
588 589
	   (vc-file-getprop file 'vc-cvs-status))))

590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608
(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)))))

609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628
(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)))
629
	       (vc-file-setprop file 'vc-locking-user (vc-user-login-name)))
630 631
	      (nil)))))

632 633 634 635 636 637 638 639 640 641
(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))))

642
(defun vc-file-owner (file)
643
  ;; Return who owns FILE (user name, as a string).
644
  (vc-user-login-name (nth 2 (file-attributes file))))
645 646 647

(defun vc-rcs-lock-from-diff (file)
  ;; Diff the file against the master version.  If differences are found,
648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
  ;; 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)))))
664

665
(defun vc-locking-user (file)
666
  ;; Return the name of the person currently holding a lock on FILE.
667
  ;; Return nil if there is no such person.
668
  ;;   Under CVS, a file is considered locked if it has been modified since
669
  ;; it was checked out.
670 671
  ;;   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
672
  ;; is `none', to distinguish it from an unknown locking state.  That value
673 674 675 676 677 678 679 680 681
  ;; 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)
682 683
	(or (and (eq (vc-checkout-model file) 'manual)
		 (vc-lock-from-permissions file))
684 685 686
	    (and (equal (vc-file-getprop file 'vc-checkout-time)
			(nth 5 (file-attributes file)))
		 (vc-file-setprop file 'vc-locking-user 'none))
687
	    (vc-file-setprop file 'vc-locking-user (vc-file-owner file))))
688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720

       ((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 
721
			    (vc-master-locking-user file)))))
722 723 724
  
      ;; convert a possible 'none value
      (setq locking-user (vc-file-getprop file 'vc-locking-user))
725
      (if (eq locking-user 'none) nil locking-user))))
726 727

;;; properties to store current and recent version numbers
728 729 730

(defun vc-latest-version (file)
  ;; Return version level of the latest version of FILE
731
  (cond ((vc-file-getprop file 'vc-latest-version))
732
	(t (vc-fetch-properties file)
733
	   (vc-file-getprop file 'vc-latest-version))))
734 735 736

(defun vc-your-latest-version (file)
  ;; Return version level of the latest version of FILE checked in by you
737
  (cond ((vc-file-getprop file 'vc-your-latest-version))
738
	(t (vc-fetch-properties file)
739
	   (vc-file-getprop file 'vc-your-latest-version))))
740

741 742
(defun vc-master-workfile-version (file)
  ;; Return the master file's idea of what is the current workfile version.
743
  ;; This property is defined for RCS only.
744
  (cond ((vc-file-getprop file 'vc-master-workfile-version))
745
	(t (vc-fetch-master-properties file)
746
	   (vc-file-getprop file 'vc-master-workfile-version))))
747

748 749 750
(defun vc-fetch-properties (file)
  ;; Fetch vc-latest-version and vc-your-latest-version
  ;; if that wasn't already done.
751 752
  (cond
   ((eq (vc-backend file) 'RCS)
753 754 755 756 757 758 759 760
    (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]+"
761
			   (regexp-quote (vc-user-login-name)) ";") 1 2))
762
       file
763 764 765
       '(vc-latest-version vc-your-latest-version))
      (if (get-buffer "*vc-info*")
	  (kill-buffer (get-buffer "*vc-info*")))))
766
   (t (vc-fetch-master-properties file))
767 768
   ))

769 770 771 772
(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, 
773
  ;; vc-master-workfile-version is taken.
774 775 776 777 778 779 780 781
  ;; 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)
782
	   (let ((rev (cond ((vc-master-workfile-version file))
783 784 785 786 787 788
			    ((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)
789 790 791
	   (catch 'found
	     (vc-find-cvs-master (file-name-directory file)
				 (file-name-nondirectory file)))
792
	   (vc-file-getprop file 'vc-workfile-version)))))
793

Eric S. Raymond's avatar
Eric S. Raymond committed
794 795 796
;;; actual version-control code starts here

(defun vc-registered (file)
797 798
  (let (handler handlers)
    (if (boundp 'file-name-handler-alist)
799
	(setq handler (find-file-name-handler file 'vc-registered)))
800 801 802 803 804 805 806 807
    (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
808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823
	      (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))))))))
824 825
	   vc-master-templates)
	  nil)))))
Eric S. Raymond's avatar
Eric S. Raymond committed
826

827 828 829 830 831 832 833 834 835 836 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 865 866 867
(defun vc-sccs-project-dir () 
  ;; Return the full pathname of the SCCS PROJECTDIR, if it exists,
  ;; otherwise nil.  The PROJECTDIR is indicated by the environment
  ;; variable of the same name.  If its value starts with a slash,
  ;; it must be an absolute path name that points to the 
  ;; directory where SCCS history files reside.  If it does not
  ;; begin with a slash, it is taken as the name of a user,
  ;; and history files reside in an "src" or "source" subdirectory
  ;; of that user's home directory.
  (let ((project-dir (getenv "PROJECTDIR")))
    (and project-dir
         (if (eq (elt project-dir 0) ?/)
             (if (file-exists-p (concat project-dir "/SCCS"))
                 (concat project-dir "/SCCS/")
               (if (file-exists-p project-dir)
                   project-dir))
           (setq project-dir (expand-file-name (concat "~" project-dir)))
           (let (trial)
             (setq trial (concat project-dir "/src/SCCS"))
             (if (file-exists-p trial)
                 (concat trial "/")
               (setq trial (concat project-dir "/src"))
               (if (file-exists-p trial)
                   (concat trial "/")
                 (setq trial (concat project-dir "/source/SCCS"))
                 (if (file-exists-p trial)
                     (concat trial "/")
                   (setq trial (concat project-dir "/source/"))
                   (if (file-exists-p trial)
                       (concat trial "/"))))))))))

(defun vc-search-sccs-project-dir (dirname basename)
  ;; Check if there is a master file for BASENAME in the 
  ;; SCCS project directory.  If yes, throw `found' as
  ;; expected by vc-registered.  If not, return nil.
  (let* ((project-dir (vc-sccs-project-dir))
         (master-file (and project-dir (concat project-dir "s." basename))))
    (and master-file
         (file-exists-p master-file)
         (throw 'found (cons master-file 'SCCS)))))

Richard M. Stallman's avatar
Richard M. Stallman committed
868 869
(defun vc-find-cvs-master (dirname basename)
  ;; Check if DIRNAME/BASENAME is handled by CVS.
870
  ;; If it is, do a (throw 'found (cons MASTER-FILE 'CVS)).
871 872 873 874
  ;; 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.
875 876
  (if (and vc-handle-cvs
	   (file-directory-p (concat dirname "CVS/"))
877
	   (file-readable-p (concat dirname "CVS/Entries")))
878 879 880 881 882
      (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
883 884
	(unwind-protect
	    (save-excursion
885 886
	      (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
887 888
	      (goto-char (point-min))
	      (cond
889 890 891 892 893 894
	       ;; 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)))
895
	       ;; normal entry
Richard M. Stallman's avatar
Richard M. Stallman committed
896
	       ((re-search-forward
897
		 (concat "^/" (regexp-quote basename) 
898 899 900 901 902 903 904 905 906 907
                         ;; 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
908
		 nil t)
909 910 911
		;; We found it.  Store away version number now that we 
		;; are anyhow so close to finding it.
		(vc-file-setprop file
912
				 'vc-workfile-version
913 914 915
				 (match-string 1))
		;; If the file hasn't been modified since checkout,
		;; store the checkout-time.
916
		(let ((mtime (nth 5 (file-attributes file)))
917 918 919 920 921
		      (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))))
922 923 924 925
		  (if (equal mtime
			     (encode-time
			      second minute hour day
			      (/ (string-match
926
				  (match-string 2)
927 928 929
				  "xxxJanFebMarAprMayJunJulAugSepOctNovDec")
				 3)
			      year 0))
930 931
		      (vc-file-setprop file 'vc-checkout-time mtime)
		    (vc-file-setprop file 'vc-checkout-time 0)))
932
		(throw 'found (cons (concat dirname "CVS/Entries") 'CVS)))
933 934
               ;; entry with arbitrary text as timestamp
               ;; (this means we should consider it modified)
935
	       ((re-search-forward
936 937 938 939 940 941 942 943 944 945 946
		 (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))
947 948
		(vc-file-setprop file 'vc-checkout-time 0)
		(throw 'found (cons (concat dirname "CVS/Entries") 'CVS)))
949
	       (t nil)))
950
	  (kill-buffer buffer)))))
Richard M. Stallman's avatar
Richard M. Stallman committed
951

952 953 954
(defun vc-buffer-backend ()
  "Return the version-control type of the visited file, or nil if none."
  (if (eq vc-buffer-backend t)
955
      (setq vc-buffer-backend (vc-backend (buffer-file-name)))
956 957
    vc-buffer-backend))

958
(defun vc-toggle-read-only (&optional verbose)
959 960 961
  "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
962
of the buffer.  With prefix argument, ask for version number."
963
  (interactive "P")
964 965 966
  (if (or (and (boundp 'vc-dired-mode) vc-dired-mode)
          ;; use boundp because vc.el might not be loaded
          (vc-backend (buffer-file-name)))
967
      (vc-next-action verbose)
Eric S. Raymond's avatar
Eric S. Raymond committed
968
    (toggle-read-only)))
969
(define-key global-map "\C-x\C-q" 'vc-toggle-read-only)
Eric S. Raymond's avatar
Eric S. Raymond committed
970

971 972 973 974 975 976
(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)))
977
    (and (vc-backend file)
978 979 980 981 982 983 984
	 (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)
985 986
	 (not (vc-locking-user file))
	 (eq (vc-checkout-model file) 'implicit)
987
	 (vc-file-setprop file 'vc-locking-user (vc-user-login-name))
988 989 990 991
	 (or (and (eq (vc-backend file) 'CVS) 
		  (vc-file-setprop file 'vc-cvs-status nil))
	     t)
	 (vc-mode-line file))))
992

Eric S. Raymond's avatar
Eric S. Raymond committed
993
(defun vc-mode-line (file &optional label)
Eric S. Raymond's avatar
Eric S. Raymond committed
994
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
995
The value is set in the current buffer, which should be the buffer
996 997
visiting FILE.  Second optional arg LABEL is put in place of version
control system name."
998
  (interactive (list buffer-file-name nil))
999
  (let ((vc-type (vc-backend file)))
1000
    (setq vc-mode
1001 1002 1003
	  (and vc-type
	       (concat " " (or label (symbol-name vc-type)) 
		       (and vc-display-status (vc-status file)))))
1004 1005
    ;; 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
1006
    ;; cannot modify a file that someone else has locked.
1007 1008
    (and vc-type 
	 (equal file (buffer-file-name))
1009
	 (vc-locking-user file)
1010
	 (not (string= (vc-user-login-name) (vc-locking-user file)))
1011
	 (setq buffer-read-only t))
Richard M. Stallman's avatar
Richard M. Stallman committed
1012 1013 1014 1015
    ;; 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.
1016 1017 1018 1019 1020 1021
    (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))
1022 1023 1024
    (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
1025

1026
(defun vc-status (file)
1027
  ;; Return string for placement in modeline by `vc-mode-line'.
1028
  ;; Format:
1029
  ;;
1030 1031 1032 1033
  ;;   "-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
1034
  ;;
1035 1036
  ;; In the CVS case, a "locked" working file is a 
  ;; working file that is modified with respect to the master.
1037 1038
  ;; The file is "locked" from the moment when the user saves
  ;; the modified buffer.
1039 1040 1041 1042 1043 1044 1045
  ;; 
  ;; This function assumes that the file is registered.

  (let ((locker (vc-locking-user file))
	(rev (vc-workfile-version file)))
    (cond ((string= "0" rev)
	   " @@")
1046 1047
	  ((not locker)
	   (concat "-" rev))
1048
	  ((string= locker (vc-user-login-name))
1049 1050 1051
	   (concat ":" rev))
	  (t 
	   (concat ":" locker ":" rev)))))
1052

1053 1054 1055 1056 1057
(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.
1058
  (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name)))
1059 1060 1061 1062
         (true-buffer (find-buffer-visiting truename))
	 (this-buffer (current-buffer)))
    (if (eq true-buffer this-buffer)
	(progn
1063
	  (kill-buffer this-buffer)
1064 1065 1066
	  ;; 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.
1067
	  (set-buffer (find-file-noselect truename)))
1068 1069
      (set-buffer true-buffer)
      (kill-buffer this-buffer))))
1070

Eric S. Raymond's avatar
Eric S. Raymond committed
1071 1072
;;; install a call to the above as a find-file hook
(defun vc-find-file-hook ()
1073 1074
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
1075
  (cond