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

Gerd Moellmann's avatar
Gerd Moellmann committed
3
;; Copyright (C) 1992,93,94,95,96,98,99,2000  Free Software Foundation, Inc.
Eric S. Raymond's avatar
Eric S. Raymond committed
4

Gerd Moellmann's avatar
Gerd Moellmann committed
5 6
;; Author:     FSF (see vc.el for full credits)
;; Maintainer: Andre Spiegel <spiegel@gnu.org>
Eric S. Raymond's avatar
Eric S. Raymond committed
7

8
;; $Id: vc-hooks.el,v 1.128 2000/11/06 13:19:38 monnier Exp $
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:

Gerd Moellmann's avatar
Gerd Moellmann committed
29 30 31 32
;; This is the always-loaded portion of VC.  It takes care of
;; 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.  See the
;; commentary of vc.el.
Eric S. Raymond's avatar
Eric S. Raymond committed
33 34 35

;;; Code:

36 37
;(eval-when-compile
;  (require 'vc))
38

39 40
;; Customization Variables (the rest is in vc.el)

Gerd Moellmann's avatar
Gerd Moellmann committed
41 42 43 44 45 46 47 48 49 50 51 52
(defvar vc-ignore-vc-files nil "Obsolete -- use `vc-handled-backends'.")
(defvar vc-master-templates () "Obsolete -- use vc-BACKEND-master-templates.")
(defvar vc-header-alist () "Obsolete -- use vc-BACKEND-header.")

(defcustom vc-handled-backends '(RCS CVS SCCS)
  "*List of version control backends for which VC will be used.
Entries in this list will be tried in order to determine whether a
file is under that sort of version control.
Removing an entry from the list prevents VC from being activated
when visiting a file managed by that backend.
An empty list disables VC altogether."
  :type '(repeat symbol)
53
  :version "21.1"
Karl Heuer's avatar
Karl Heuer committed
54
  :group 'vc)
55

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

Karl Heuer's avatar
Karl Heuer committed
64
(defcustom vc-make-backup-files nil
65
  "*If non-nil, backups of registered files are made as with other files.
Karl Heuer's avatar
Karl Heuer committed
66 67 68
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
69

Karl Heuer's avatar
Karl Heuer committed
70
(defcustom vc-follow-symlinks 'ask
Gerd Moellmann's avatar
Gerd Moellmann committed
71 72 73 74 75
  "*What to do if visiting a symbolic link to a file 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,
76 77
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
78
visited and a warning displayed."
Gerd Moellmann's avatar
Gerd Moellmann committed
79 80 81
  :type '(choice (const :tag "Ask for confirmation" ask)
		 (const :tag "Visit link and warn" nil)
		 (const :tag "Follow link" t))
Karl Heuer's avatar
Karl Heuer committed
82
  :group 'vc)
83

Karl Heuer's avatar
Karl Heuer committed
84
(defcustom vc-display-status t
85
  "*If non-nil, display revision number and lock status in modeline.
Karl Heuer's avatar
Karl Heuer committed
86 87 88 89
Otherwise, not displayed."
  :type 'boolean
  :group 'vc)

90

Karl Heuer's avatar
Karl Heuer committed
91 92 93 94
(defcustom vc-consult-headers t
  "*If non-nil, identify work files by searching for version headers."
  :type 'boolean
  :group 'vc)
95

Karl Heuer's avatar
Karl Heuer committed
96
(defcustom vc-keep-workfiles t
97 98
  "*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
99 100 101
value of this flag."
  :type 'boolean
  :group 'vc)
102

Karl Heuer's avatar
Karl Heuer committed
103
(defcustom vc-mistrust-permissions nil
Gerd Moellmann's avatar
Gerd Moellmann committed
104 105
  "*If non-nil, don't assume permissions/ownership track version-control status.
If nil, do rely on the permissions.
Karl Heuer's avatar
Karl Heuer committed
106 107 108
See also variable `vc-consult-headers'."
  :type 'boolean
  :group 'vc)
109 110

(defun vc-mistrust-permissions (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
111
  "Internal access function to variable `vc-mistrust-permissions' for FILE."
112 113
  (or (eq vc-mistrust-permissions 't)
      (and vc-mistrust-permissions
Gerd Moellmann's avatar
Gerd Moellmann committed
114
	   (funcall vc-mistrust-permissions
115 116
		    (vc-backend-subdirectory-name file)))))

Eric S. Raymond's avatar
Eric S. Raymond committed
117
;; Tell Emacs about this new kind of minor mode
Gerd Moellmann's avatar
Gerd Moellmann committed
118
(add-to-list 'minor-mode-alist '(vc-mode vc-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
119

Eric S. Raymond's avatar
Eric S. Raymond committed
120
(make-variable-buffer-local 'vc-mode)
121
(put 'vc-mode 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
122

123 124 125
(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
126
;; We need a notion of per-file properties because the version
127
;; control state of a file is expensive to derive --- we compute
Gerd Moellmann's avatar
Gerd Moellmann committed
128
;; them when the file is initially found, keep them up to date
129 130
;; during any subsequent VC operations, and forget them when
;; the buffer is killed.
Eric S. Raymond's avatar
Eric S. Raymond committed
131

Gerd Moellmann's avatar
Gerd Moellmann committed
132
(defvar vc-file-prop-obarray (make-vector 16 0)
Eric S. Raymond's avatar
Eric S. Raymond committed
133 134
  "Obarray for per-file properties.")

135 136
(defvar vc-touched-properties nil)

Eric S. Raymond's avatar
Eric S. Raymond committed
137
(defun vc-file-setprop (file property value)
Gerd Moellmann's avatar
Gerd Moellmann committed
138
  "Set per-file VC PROPERTY for FILE to VALUE."
139 140 141 142
  (if (and vc-touched-properties
	   (not (memq property vc-touched-properties)))
      (setq vc-touched-properties (append (list property)
					  vc-touched-properties)))
Eric S. Raymond's avatar
Eric S. Raymond committed
143 144 145
  (put (intern file vc-file-prop-obarray) property value))

(defun vc-file-getprop (file property)
146
  "Get per-file VC PROPERTY for FILE."
Eric S. Raymond's avatar
Eric S. Raymond committed
147 148
  (get (intern file vc-file-prop-obarray) property))

149
(defun vc-file-clearprops (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
150
  "Clear all VC properties of FILE."
151
  (setplist (intern file vc-file-prop-obarray) nil))
152

Gerd Moellmann's avatar
Gerd Moellmann committed
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204

;; We keep properties on each symbol naming a backend as follows:
;;  * `vc-functions': an alist mapping vc-FUNCTION to vc-BACKEND-FUNCTION.

(defun vc-make-backend-sym (backend sym)
  "Return BACKEND-specific version of VC symbol SYM."
  (intern (concat "vc-" (downcase (symbol-name backend))
		  "-" (symbol-name sym))))

(defun vc-find-backend-function (backend fun)
  "Return BACKEND-specific implementation of FUN.
If there is no such implementation, return the default implementation; 
if that doesn't exist either, return nil."
  (let ((f (vc-make-backend-sym backend fun)))
    (if (fboundp f) f
      ;; Load vc-BACKEND.el if needed.
      (require (intern (concat "vc-" (downcase (symbol-name backend)))))
      (if (fboundp f) f
	(let ((def (vc-make-backend-sym 'default fun)))
	  (if (fboundp def) (cons def backend) nil))))))

(defun vc-call-backend (backend function-name &rest args)
  "Call for BACKEND the implementation of FUNCTION-NAME with the given ARGS.
Calls

    (apply 'vc-BACKEND-FUN ARGS)

if vc-BACKEND-FUN exists (after trying to find it in vc-BACKEND.el)
and else calls

    (apply 'vc-default-FUN BACKEND ARGS)

It is usually called via the `vc-call' macro."
  (let ((f (cdr (assoc function-name (get backend 'vc-functions)))))
    (unless f
      (setq f (vc-find-backend-function backend function-name))
      (put backend 'vc-functions (cons (cons function-name f)
				       (get backend 'vc-functions))))
    (if (consp f)
	(apply (car f) (cdr f) args)
      (apply f args))))

(defmacro vc-call (fun file &rest args)
  ;; BEWARE!! `file' is evaluated twice!!
  `(vc-call-backend (vc-backend ,file) ',fun ,file ,@args))


(defsubst vc-parse-buffer (pattern i)
  "Find PATTERN in the current buffer and return its Ith submatch."
  (goto-char (point-min))
  (if (re-search-forward pattern nil t)
      (match-string i)))
205

206
(defun vc-insert-file (file &optional limit blocksize)
Gerd Moellmann's avatar
Gerd Moellmann committed
207 208 209 210
  "Insert the contents of FILE into the current buffer.

Optional argument LIMIT is a regexp.  If present, the file is inserted
in chunks of size BLOCKSIZE (default 8 kByte), until the first
211 212
occurrence of LIMIT is found.  The function returns non-nil if FILE 
exists and its contents were successfully inserted."
213
  (erase-buffer)
214 215 216 217
  (when (file-exists-p file)
    (if (not limit)
        (insert-file-contents file)
      (if (not blocksize) (setq blocksize 8192))
218 219 220 221 222 223
      (let ((filepos 0))
        (while
	    (and (< 0 (cadr (insert-file-contents
			     file nil filepos (incf filepos blocksize))))
		 (progn (beginning-of-line)
			(not (re-search-forward limit nil 'move)))))))
224 225
    (set-buffer-modified-p nil)
    t))
226 227 228 229 230

;;; 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
Gerd Moellmann's avatar
Gerd Moellmann committed
231
;;; only be retrieved by vc-file-getprop if there is no
232 233
;;; access function.)

Gerd Moellmann's avatar
Gerd Moellmann committed
234
;;; properties indicating the backend being used for FILE
235

Gerd Moellmann's avatar
Gerd Moellmann committed
236 237 238
(defun vc-registered (file)
  "Return non-nil if FILE is registered in a version control system.

239 240 241 242
This function performs the check each time it is called.  To rely
on the result of a previous call, use `vc-backend' instead.  If the
file was previously registered under a certain backend, then that
backend is tried first."
Gerd Moellmann's avatar
Gerd Moellmann committed
243 244 245 246 247 248 249 250 251
  (let (handler)
    (if (boundp 'file-name-handler-alist)
  	(setq handler (find-file-name-handler file 'vc-registered)))
    (if handler
        ;; handler should set vc-backend and return t if registered
  	(funcall handler 'vc-registered file)
      ;; There is no file name handler.
      ;; Try vc-BACKEND-registered for each handled BACKEND.
      (catch 'found
252 253 254 255 256 257 258 259 260
	(let ((backend (vc-file-getprop file 'vc-backend)))
	  (mapcar
	   (lambda (b)
	     (and (vc-call-backend b 'registered file)
		  (vc-file-setprop file 'vc-backend b)
		  (throw 'found t)))
	   (if (or (not backend) (eq backend 'none)) 
	       vc-handled-backends
	     (cons backend vc-handled-backends))))
Gerd Moellmann's avatar
Gerd Moellmann committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
        ;; File is not registered.
        (vc-file-setprop file 'vc-backend 'none)
        nil))))

(defun vc-backend (file)
  "Return the version control type of FILE, nil if it is not registered."
  ;; `file' can be nil in several places (typically due to the use of
  ;; code like (vc-backend (buffer-file-name))).
  (when (stringp file)
    (let ((property (vc-file-getprop file 'vc-backend)))
      ;; Note that internally, Emacs remembers unregistered
      ;; files by setting the property to `none'.
      (cond ((eq property 'none) nil)
	    (property)
	    ;; vc-registered sets the vc-backend property
	    (t (if (vc-registered file)
		   (vc-file-getprop file 'vc-backend)
		 nil))))))

(defun vc-backend-subdirectory-name (file)
  "Return where the master and lock FILEs for the current directory are kept."
  (symbol-name (vc-backend file)))
283

284
(defun vc-name (file)
Dave Love's avatar
Dave Love committed
285 286 287
  "Return the master name of FILE.
If the file is not registered, or the master name is not known, return nil."
  ;; TODO: This should ultimately become obsolete, at least up here
Gerd Moellmann's avatar
Gerd Moellmann committed
288
  ;; in vc-hooks.
289
  (or (vc-file-getprop file 'vc-name)
290 291 292 293
      ;; force computation of the property by calling
      ;; vc-BACKEND-registered explicitly
      (if (and (vc-backend file)
	       (vc-call-backend (vc-backend file) 'registered file))
294
	  (vc-file-getprop file 'vc-name))))
295

296
(defun vc-checkout-model (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313
  "Indicate how FILE is checked out.

Possible values:

  'implicit   File is always writeable, and checked out `implicitly'
              when the user saves the first changes to the file.

  'locking    File is read-only if up-to-date; user must type
              \\[vc-toggle-read-only] before editing.  Strict locking
              is assumed.

  'announce   File is read-only if up-to-date; user must type
              \\[vc-toggle-read-only] before editing.  But other users
              may be editing at the same time."
  (or (vc-file-getprop file 'vc-checkout-model)
      (vc-file-setprop file 'vc-checkout-model
                       (vc-call checkout-model file))))
314

315
(defun vc-user-login-name (&optional uid)
Gerd Moellmann's avatar
Gerd Moellmann committed
316 317 318 319 320
  "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 function `user-login-name', but unlike
that, it never returns nil.  If a UID cannot be resolved, that
UID is returned as a string."
321
  (or (user-login-name uid)
Gerd Moellmann's avatar
Gerd Moellmann committed
322 323 324 325 326
      (number-to-string (or uid (user-uid)))))

(defun vc-state (file)
  "Return the version control state of FILE.

Dave Love's avatar
Dave Love committed
327
The value returned is one of:
Gerd Moellmann's avatar
Gerd Moellmann committed
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362

  'up-to-date        The working file is unmodified with respect to the
                     latest version on the current branch, and not locked.

  'edited            The working file has been edited by the user.  If
                     locking is used for the file, this state means that
                     the current version is locked by the calling user.

  USER               The current version of the working file is locked by
                     some other USER (a string).
            
  'needs-patch       The file has not been edited by the user, but there is
                     a more recent version on the current branch stored
                     in the master file.

  'needs-merge       The file has been edited by the user, and there is also
                     a more recent version on the current branch stored in
                     the master file.  This state can only occur if locking
                     is not used for the file.

  'unlocked-changes  The current version of the working file is not locked,
                     but the working file has been changed with respect
                     to that version.  This state can only occur for files
                     with locking; it represents an erroneous condition that
                     should be resolved by the user (vc-next-action will
                     prompt the user to do it)."
  (or (vc-file-getprop file 'vc-state)
      (vc-file-setprop file 'vc-state
		       (vc-call state-heuristic file))))

(defsubst vc-up-to-date-p (file)
  "Convenience function that checks whether `vc-state' of FILE is `up-to-date'."
  (eq (vc-state file) 'up-to-date))

(defun vc-default-state-heuristic (backend file)
Dave Love's avatar
Dave Love committed
363 364 365
  "Default implementation of vc-state-heuristic.
It simply calls the real state computation function `vc-BACKEND-state'
and does not employ any heuristic at all."
Gerd Moellmann's avatar
Gerd Moellmann committed
366
   (vc-call-backend backend 'state file))
367

368 369 370 371 372 373 374 375 376 377 378 379 380 381
(defun vc-workfile-unchanged-p (file)
  "Has FILE changed since last checkout?"
  (let ((checkout-time (vc-file-getprop file 'vc-checkout-time))
        (lastmod (nth 5 (file-attributes file))))
    (if checkout-time
        (equal checkout-time lastmod)
      (let ((unchanged (vc-call workfile-unchanged-p file)))
        (vc-file-setprop file 'vc-checkout-time (if unchanged lastmod 0))
        unchanged))))

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

382
(defun vc-workfile-version (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
383 384 385 386
  "Return version level of the current workfile FILE."
  (or (vc-file-getprop file 'vc-workfile-version)
      (vc-file-setprop file 'vc-workfile-version
                       (vc-call workfile-version file))))
387

Gerd Moellmann's avatar
Gerd Moellmann committed
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435
(defun vc-default-registered (backend file)
  "Check if FILE is registered in BACKEND using vc-BACKEND-master-templates."
  (let ((sym (vc-make-backend-sym backend 'master-templates)))
    (unless (get backend 'vc-templates-grabbed)
      (put backend 'vc-templates-grabbed t)
      (set sym (append (delq nil
			     (mapcar
			      (lambda (template)
				(and (consp template)
				     (eq (cdr template) backend)
				     (car template)))
			      vc-master-templates))
		       (symbol-value sym))))
    (let ((result (vc-check-master-templates file (symbol-value sym))))
      (if (stringp result)
	  (vc-file-setprop file 'vc-name result)
	nil))))				; Not registered

(defun vc-possible-master (s dirname basename)
  (cond
   ((stringp s) (format s dirname basename))
   ((functionp s)
    ;; The template is a function to invoke.  If the
    ;; function returns non-nil, that means it has found a
    ;; master.  For backward compatibility, we also handle
    ;; the case that the function throws a 'found atom
    ;; and a pair (cons MASTER-FILE BACKEND).
    (let ((result (catch 'found (funcall s dirname basename))))
      (if (consp result) (car result) result)))))

(defun vc-check-master-templates (file templates)
  "Return non-nil if there is a master corresponding to FILE,
according to any of the elements in TEMPLATES.

TEMPLATES is a list of strings or functions.  If an element is a
string, it must be a control string as required by `format', with two
string placeholders, such as \"%sRCS/%s,v\".  The directory part of
FILE is substituted for the first placeholder, the basename of FILE
for the second.  If a file with the resulting name exists, it is taken
as the master of FILE, and returned.

If an element of TEMPLATES is a function, it is called with the
directory part and the basename of FILE as arguments.  It should
return non-nil if it finds a master; that value is then returned by
this function."
  (let ((dirname (or (file-name-directory file) ""))
        (basename (file-name-nondirectory file)))
    (catch 'found
Dave Love's avatar
Dave Love committed
436
      (mapcar
Gerd Moellmann's avatar
Gerd Moellmann committed
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
       (lambda (s)
	 (let ((trial (vc-possible-master s dirname basename)))
	   (if (and trial (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 trial))))
       templates))))
452

453
(defun vc-toggle-read-only (&optional verbose)
454 455 456
  "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
Karl Heuer's avatar
Karl Heuer committed
457 458 459 460
of the buffer.
With prefix argument, ask for version number to check in or check out.
Check-out of a specified version number does not lock the file;
to do that, use this command a second time with no argument."
461
  (interactive "P")
462
  (if (or (and (boundp 'vc-dired-mode) vc-dired-mode)
Gerd Moellmann's avatar
Gerd Moellmann committed
463 464
	  ;; use boundp because vc.el might not be loaded
	  (vc-backend (buffer-file-name)))
465
      (vc-next-action verbose)
Eric S. Raymond's avatar
Eric S. Raymond committed
466
    (toggle-read-only)))
467
(define-key global-map "\C-x\C-q" 'vc-toggle-read-only)
Eric S. Raymond's avatar
Eric S. Raymond committed
468

469
(defun vc-default-make-version-backups-p (backend file)
470 471 472 473
  "Return non-nil if unmodified repository versions should 
be backed up locally.  The default is to switch off this feature."
  nil)

474 475 476 477 478
(defun vc-version-backup-file-name (file &optional rev manual regexp)
  "Return a backup file name for REV or the current version of FILE.
If MANUAL is non-nil it means that a name for backups created by
the user should be returned; if REGEXP is non-nil that means to return
a regexp for matching all such backup files, regardless of the version."
479 480 481 482 483 484 485
  (if regexp
      (concat (regexp-quote (file-name-nondirectory file))
              "\\.~[0-9.]+" (unless manual "\\.") "~")
    (expand-file-name (concat (file-name-nondirectory file) 
                              ".~" (or rev (vc-workfile-version file)) 
                              (unless manual ".") "~")
                      (file-name-directory file))))
486 487 488 489 490 491 492 493 494 495 496 497

(defun vc-delete-automatic-version-backups (file)
  "Delete all existing automatic version backups for FILE."
  (mapcar
   (lambda (f)
     (delete-file f))
   (directory-files (file-name-directory file) t
                    (vc-version-backup-file-name file nil nil t))))

(defun vc-make-version-backup (file)
  "Make a backup copy of FILE, which is assumed in sync with the repository.
Before doing that, check if there are any old backups and get rid of them."
498 499 500 501 502
  (unless (and (fboundp 'msdos-long-file-names)
               (not (msdos-long-file-names)))
    (vc-delete-automatic-version-backups file)
    (copy-file file (vc-version-backup-file-name file)
               nil 'keep-date)))
503 504 505 506 507 508 509 510 511 512

(defun vc-before-save ()
  "Function to be called by `basic-save-buffer' (in files.el)."
  ;; If the file on disk is still in sync with the repository,
  ;; and version backups should be made, copy the file to
  ;; another name.  This enables local diffs and local reverting.
  (let ((file (buffer-file-name)))
    (and (vc-backend file)
	 (vc-up-to-date-p file)
	 (eq (vc-checkout-model file) 'implicit)
513 514
	 (vc-call make-version-backups-p file)
         (vc-make-version-backup file))))
515

516
(defun vc-after-save ()
Gerd Moellmann's avatar
Gerd Moellmann committed
517
  "Function to be called by `basic-save-buffer' (in files.el)."
Dave Love's avatar
Dave Love committed
518
  ;; If the file in the current buffer is under version control,
Gerd Moellmann's avatar
Gerd Moellmann committed
519 520
  ;; up-to-date, and locking is not used for the file, set
  ;; the state to 'edited and redisplay the mode line.
521
  (let ((file (buffer-file-name)))
522
    (and (vc-backend file)
523 524 525 526 527 528 529
	 (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)
Gerd Moellmann's avatar
Gerd Moellmann committed
530 531 532 533
         (vc-up-to-date-p file)
         (eq (vc-checkout-model file) 'implicit)
         (vc-file-setprop file 'vc-state 'edited)
	 (vc-mode-line file)
534 535 536 537
	 (if (featurep 'vc)
	     ;; If VC is not loaded, then there can't be
	     ;; any VC Dired buffer to synchronize.
	     (vc-dired-resynch-file file)))))
538

Gerd Moellmann's avatar
Gerd Moellmann committed
539
(defun vc-mode-line (file)
Eric S. Raymond's avatar
Eric S. Raymond committed
540
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
541
The value is set in the current buffer, which should be the buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
542
visiting FILE."
543
  (interactive (list buffer-file-name))
Gerd Moellmann's avatar
Gerd Moellmann committed
544
  (unless (not (vc-backend file))
545 546 547
    (setq vc-mode (concat " " (if vc-display-status
				  (vc-call mode-line-string file)
				(symbol-name (vc-backend file)))))
548 549
    ;; 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
550
    ;; cannot modify a file that someone else has locked.
Gerd Moellmann's avatar
Gerd Moellmann committed
551 552
    (and (equal file (buffer-file-name))
         (stringp (vc-state file))
553
	 (setq buffer-read-only t))
Richard M. Stallman's avatar
Richard M. Stallman committed
554 555 556 557
    ;; 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.
Gerd Moellmann's avatar
Gerd Moellmann committed
558
    (and (equal file (buffer-file-name))
559 560 561
	 (not buffer-read-only)
	 (zerop (user-real-uid))
	 (zerop (logand (file-modes (buffer-file-name)) 128))
Gerd Moellmann's avatar
Gerd Moellmann committed
562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577
	 (setq buffer-read-only t)))
  (force-mode-line-update)
  (vc-backend file))

(defun vc-default-mode-line-string (backend file)
  "Return string for placement in modeline by `vc-mode-line' for FILE.
Format:

  \"BACKEND-REV\"        if the file is up-to-date
  \"BACKEND:REV\"        if the file is edited (or locked by the calling user)
  \"BACKEND:LOCKER:REV\" if the file is locked by somebody else

This function assumes that the file is registered."
  (setq backend (symbol-name backend))
  (let ((state   (vc-state file))
	(rev     (vc-workfile-version file)))
578
    (cond ((or (eq state 'up-to-date)
Gerd Moellmann's avatar
Gerd Moellmann committed
579 580 581 582 583 584 585 586 587
	       (eq state 'needs-patch))
	   (concat backend "-" rev))
          ((stringp state)
	   (concat backend ":" state ":" rev))
          (t
           ;; Not just for the 'edited state, but also a fallback
           ;; for all other states.  Think about different symbols
           ;; for 'needs-patch and 'needs-merge.
           (concat backend ":" rev)))))
588

589
(defun vc-follow-link ()
Gerd Moellmann's avatar
Gerd Moellmann committed
590 591 592
  "If current buffer visits a symbolic link, visit the real file.
If the real file is already visited in another buffer, make that buffer
current, and kill the buffer that visits the link."
593
  (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name)))
594 595 596 597
         (true-buffer (find-buffer-visiting truename))
	 (this-buffer (current-buffer)))
    (if (eq true-buffer this-buffer)
	(progn
598
	  (kill-buffer this-buffer)
599 600 601
	  ;; 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.
602
	  (set-buffer (find-file-noselect truename)))
603 604
      (set-buffer true-buffer)
      (kill-buffer this-buffer))))
605

Eric S. Raymond's avatar
Eric S. Raymond committed
606
(defun vc-find-file-hook ()
Gerd Moellmann's avatar
Gerd Moellmann committed
607
  "Function for `find-file-hooks' activating VC mode if appropriate."
608 609
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
Gerd Moellmann's avatar
Gerd Moellmann committed
610
  (when buffer-file-name
611 612
    (vc-file-clearprops buffer-file-name)
    (cond
613
     ((vc-backend buffer-file-name)
614 615 616 617 618
      (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)
619 620
	     (setq backup-inhibited t))))
     ((let* ((link (file-symlink-p buffer-file-name))
621
	     (link-type (and link (vc-backend (file-chase-links link)))))
622
	(if link-type
623 624 625
            (cond ((eq vc-follow-symlinks nil)
                   (message
        "Warning: symbolic link to %s-controlled source file" link-type))
626 627 628 629 630 631
                  ((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
Dave Love's avatar
Dave Love committed
632
			(abbreviate-file-name
Gerd Moellmann's avatar
Gerd Moellmann committed
633
                         (file-chase-links buffer-file-name))))
634 635 636 637 638
		       
		   (vc-follow-link)
		   (message "Followed link to %s" buffer-file-name)
		   (vc-find-file-hook))
                  (t
639 640
                   (if (yes-or-no-p (format
        "Symbolic link to %s-controlled source file; follow link? " link-type))
641
                       (progn (vc-follow-link)
642 643
                              (message "Followed link to %s" buffer-file-name)
                              (vc-find-file-hook))
Gerd Moellmann's avatar
Gerd Moellmann committed
644
                     (message
645
        "Warning: editing through the link bypasses version control")
Gerd Moellmann's avatar
Gerd Moellmann committed
646
                     )))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
647

648
(add-hook 'find-file-hooks 'vc-find-file-hook)
Eric S. Raymond's avatar
Eric S. Raymond committed
649 650 651

;;; more hooks, this time for file-not-found
(defun vc-file-not-found-hook ()
Gerd Moellmann's avatar
Gerd Moellmann committed
652 653 654
  "When file is not found, try to check it out from version control.
Returns t if checkout was successful, nil otherwise.
Used in `find-file-not-found-hooks'."
655 656 657
  ;; When a file does not exist, ignore cached info about it
  ;; from a previous visit.
  (vc-file-clearprops buffer-file-name)
Gerd Moellmann's avatar
Gerd Moellmann committed
658
  (if (and (vc-backend buffer-file-name)
Dave Love's avatar
Dave Love committed
659
	   (yes-or-no-p
Gerd Moellmann's avatar
Gerd Moellmann committed
660 661 662 663 664 665
	    (format "File %s was lost; check out from version control? "
		    (file-name-nondirectory buffer-file-name))))
    (save-excursion
      (require 'vc)
      (setq default-directory (file-name-directory buffer-file-name))
      (not (vc-error-occurred (vc-checkout buffer-file-name))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
666

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

669
(defun vc-kill-buffer-hook ()
Gerd Moellmann's avatar
Gerd Moellmann committed
670 671 672
  "Discard VC info about a file when we kill its buffer."
  (if (buffer-file-name)
      (vc-file-clearprops (buffer-file-name))))
673

Gerd Moellmann's avatar
Gerd Moellmann committed
674
;; ??? DL: why is this not done?
675 676
;;;(add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)

Eric S. Raymond's avatar
Eric S. Raymond committed
677
;;; Now arrange for bindings and autoloading of the main package.
Eric S. Raymond's avatar
Eric S. Raymond committed
678 679
;;; Bindings for this have to go in the global map, as we'll often
;;; want to call them from random buffers.
Eric S. Raymond's avatar
Eric S. Raymond committed
680

Gerd Moellmann's avatar
Gerd Moellmann committed
681 682
(autoload 'vc-prefix-map "vc" nil nil 'keymap)
(define-key global-map "\C-xv" 'vc-prefix-map)
683

684 685 686 687 688 689
(if (not (boundp 'vc-menu-map))
    ;; Don't do the menu bindings if menu-bar.el wasn't loaded to defvar
    ;; vc-menu-map.
    ()
  ;;(define-key vc-menu-map [show-files]
  ;;  '("Show Files under VC" . (vc-directory t)))
690 691 692 693
  (define-key vc-menu-map [vc-retrieve-snapshot]
    '("Retrieve Snapshot" . vc-retrieve-snapshot))
  (define-key vc-menu-map [vc-create-snapshot]
    '("Create Snapshot" . vc-create-snapshot))
694
  (define-key vc-menu-map [vc-directory] '("VC Directory Listing" . vc-directory))
695
  (define-key vc-menu-map [separator1] '("----"))
696
  (define-key vc-menu-map [vc-annotate] '("Annotate" . vc-annotate))
697 698 699 700 701 702 703 704 705 706 707 708 709
  (define-key vc-menu-map [vc-rename-file] '("Rename File" . vc-rename-file))
  (define-key vc-menu-map [vc-version-other-window]
    '("Show Other Version" . vc-version-other-window))
  (define-key vc-menu-map [vc-diff] '("Compare with Last Version" . vc-diff))
  (define-key vc-menu-map [vc-update-change-log]
    '("Update ChangeLog" . vc-update-change-log))
  (define-key vc-menu-map [vc-print-log] '("Show History" . vc-print-log))
  (define-key vc-menu-map [separator2] '("----"))
  (define-key vc-menu-map [undo] '("Undo Last Check-In" . vc-cancel-version))
  (define-key vc-menu-map [vc-revert-buffer]
    '("Revert to Last Version" . vc-revert-buffer))
  (define-key vc-menu-map [vc-insert-header]
    '("Insert Header" . vc-insert-headers))
710
  (define-key vc-menu-map [vc-next-action] '("Check In/Out" . vc-next-action))
711 712
  (define-key vc-menu-map [vc-register] '("Register" . vc-register)))

713 714 715 716 717 718 719 720 721
;;; These are not correct and it's not currently clear how doing it
;;; better (with more complicated expressions) might slow things down
;;; on older systems.

;;;(put 'vc-rename-file 'menu-enable 'vc-mode)
;;;(put 'vc-annotate 'menu-enable '(eq (vc-buffer-backend) 'CVS))
;;;(put 'vc-version-other-window 'menu-enable 'vc-mode)
;;;(put 'vc-diff 'menu-enable 'vc-mode)
;;;(put 'vc-update-change-log 'menu-enable
Gerd Moellmann's avatar
Gerd Moellmann committed
722
;;;     '(member (vc-buffer-backend) '(RCS CVS)))
723 724 725 726 727 728
;;;(put 'vc-print-log 'menu-enable 'vc-mode)
;;;(put 'vc-cancel-version 'menu-enable 'vc-mode)
;;;(put 'vc-revert-buffer 'menu-enable 'vc-mode)
;;;(put 'vc-insert-headers 'menu-enable 'vc-mode)
;;;(put 'vc-next-action 'menu-enable 'vc-mode)
;;;(put 'vc-register 'menu-enable '(and buffer-file-name (not vc-mode)))
Eric S. Raymond's avatar
Eric S. Raymond committed
729 730 731 732

(provide 'vc-hooks)

;;; vc-hooks.el ends here