vc-hooks.el 29.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.136 2001/12/11 07:35:18 pj 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 'cl))
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 126 127 128 129 130
(defun vc-mode (&optional arg)
  ;; Dummy function for C-h m
  "Version Control minor mode.
This minor mode is automatically activated whenever you visit a file under
control of one of the revision control systems in `vc-handled-backends'.
VC commands are globally reachable under the prefix `\\[vc-prefix-map]':
\\{vc-prefix-map}")

131
(defmacro vc-error-occurred (&rest body)
132
  `(condition-case nil (progn ,@body nil) (error t)))
133

Eric S. Raymond's avatar
Eric S. Raymond committed
134
;; We need a notion of per-file properties because the version
135
;; control state of a file is expensive to derive --- we compute
Gerd Moellmann's avatar
Gerd Moellmann committed
136
;; them when the file is initially found, keep them up to date
137 138
;; during any subsequent VC operations, and forget them when
;; the buffer is killed.
Eric S. Raymond's avatar
Eric S. Raymond committed
139

140
(defvar vc-file-prop-obarray (make-vector 17 0)
Eric S. Raymond's avatar
Eric S. Raymond committed
141 142
  "Obarray for per-file properties.")

143 144
(defvar vc-touched-properties nil)

Eric S. Raymond's avatar
Eric S. Raymond committed
145
(defun vc-file-setprop (file property value)
Gerd Moellmann's avatar
Gerd Moellmann committed
146
  "Set per-file VC PROPERTY for FILE to VALUE."
147 148 149 150
  (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
151 152 153
  (put (intern file vc-file-prop-obarray) property value))

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

157
(defun vc-file-clearprops (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
158
  "Clear all VC properties of FILE."
159
  (setplist (intern file vc-file-prop-obarray) nil))
160

Gerd Moellmann's avatar
Gerd Moellmann committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212

;; 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)))
213

214
(defun vc-insert-file (file &optional limit blocksize)
Gerd Moellmann's avatar
Gerd Moellmann committed
215 216 217 218
  "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
219 220
occurrence of LIMIT is found.  The function returns non-nil if FILE 
exists and its contents were successfully inserted."
221
  (erase-buffer)
222 223 224 225
  (when (file-exists-p file)
    (if (not limit)
        (insert-file-contents file)
      (if (not blocksize) (setq blocksize 8192))
226 227 228 229 230 231
      (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)))))))
232 233
    (set-buffer-modified-p nil)
    t))
234

235 236 237 238 239 240
;; 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.)
241

242
;; properties indicating the backend being used for FILE
243

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

247 248 249 250
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
251 252 253 254 255 256 257 258 259
  (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
260 261 262 263 264 265 266 267 268
	(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
269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290
        ;; 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)))
291

292
(defun vc-name (file)
Dave Love's avatar
Dave Love committed
293 294 295
  "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
296
  ;; in vc-hooks.
297
  (or (vc-file-getprop file 'vc-name)
298 299 300 301
      ;; force computation of the property by calling
      ;; vc-BACKEND-registered explicitly
      (if (and (vc-backend file)
	       (vc-call-backend (vc-backend file) 'registered file))
302
	  (vc-file-getprop file 'vc-name))))
303

304
(defun vc-checkout-model (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
305 306
  "Indicate how FILE is checked out.

307 308
If FILE is not registered, this function always returns nil.
For registered files, the possible values are:
Gerd Moellmann's avatar
Gerd Moellmann committed
309

310
  'implicit   FILE is always writeable, and checked out `implicitly'
Gerd Moellmann's avatar
Gerd Moellmann committed
311 312
              when the user saves the first changes to the file.

313
  'locking    FILE is read-only if up-to-date; user must type
Gerd Moellmann's avatar
Gerd Moellmann committed
314 315 316
              \\[vc-toggle-read-only] before editing.  Strict locking
              is assumed.

317
  'announce   FILE is read-only if up-to-date; user must type
Gerd Moellmann's avatar
Gerd Moellmann committed
318 319 320
              \\[vc-toggle-read-only] before editing.  But other users
              may be editing at the same time."
  (or (vc-file-getprop file 'vc-checkout-model)
321 322 323
      (if (vc-backend file)
          (vc-file-setprop file 'vc-checkout-model
                           (vc-call checkout-model file)))))
324

325
(defun vc-user-login-name (&optional uid)
Gerd Moellmann's avatar
Gerd Moellmann committed
326 327 328 329 330
  "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."
331
  (or (user-login-name uid)
Gerd Moellmann's avatar
Gerd Moellmann committed
332 333 334 335 336
      (number-to-string (or uid (user-uid)))))

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

337 338
If FILE is not registered, this function always returns nil.
For registered files, the value returned is one of:
Gerd Moellmann's avatar
Gerd Moellmann committed
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365

  '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)
366 367 368
      (if (vc-backend file)
          (vc-file-setprop file 'vc-state
                           (vc-call state-heuristic file)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
369 370 371 372 373 374

(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
375 376 377
  "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
378
   (vc-call-backend backend 'state file))
379

380
(defun vc-workfile-version (file)
381 382
  "Return the version level of the current workfile FILE.
If FILE is not registered, this function always returns nil."
Gerd Moellmann's avatar
Gerd Moellmann committed
383
  (or (vc-file-getprop file 'vc-workfile-version)
384 385 386
      (if (vc-backend file)
          (vc-file-setprop file 'vc-workfile-version
                           (vc-call workfile-version file)))))
387

André Spiegel's avatar
André Spiegel committed
388 389
;;; actual version-control code starts here

Gerd Moellmann's avatar
Gerd Moellmann committed
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
(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)
421
  "Return non-nil if there is a master corresponding to FILE.
Gerd Moellmann's avatar
Gerd Moellmann committed
422 423 424 425 426 427 428 429 430 431 432 433 434 435 436

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
437
      (mapcar
Gerd Moellmann's avatar
Gerd Moellmann committed
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
       (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))))
453

454
(defun vc-toggle-read-only (&optional verbose)
455 456 457
  "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
458 459 460 461
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."
462
  (interactive "P")
463
  (if (or (and (boundp 'vc-dired-mode) vc-dired-mode)
Gerd Moellmann's avatar
Gerd Moellmann committed
464 465
	  ;; use boundp because vc.el might not be loaded
	  (vc-backend (buffer-file-name)))
466
      (vc-next-action verbose)
Eric S. Raymond's avatar
Eric S. Raymond committed
467
    (toggle-read-only)))
468
(define-key global-map "\C-x\C-q" 'vc-toggle-read-only)
Eric S. Raymond's avatar
Eric S. Raymond committed
469

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

475 476 477 478 479
(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."
480 481 482 483 484 485 486
  (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))))
487 488 489

(defun vc-delete-automatic-version-backups (file)
  "Delete all existing automatic version backups for FILE."
490 491 492
  (condition-case nil
      (mapcar
       'delete-file
493
       (directory-files (or (file-name-directory file) default-directory) t
494 495 496
			(vc-version-backup-file-name file nil nil t)))
    ;; Don't fail when the directory doesn't exist.
    (file-error nil)))
497 498 499 500

(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."
501 502 503 504 505
  (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)))
506 507 508 509 510 511 512 513 514 515

(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)
516 517
	 (vc-call make-version-backups-p file)
         (vc-make-version-backup file))))
518

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

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

592
(defun vc-follow-link ()
Gerd Moellmann's avatar
Gerd Moellmann committed
593 594 595
  "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."
596
  (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name)))
597 598 599 600
         (true-buffer (find-buffer-visiting truename))
	 (this-buffer (current-buffer)))
    (if (eq true-buffer this-buffer)
	(progn
601
	  (kill-buffer this-buffer)
602 603 604
	  ;; 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.
605
	  (set-buffer (find-file-noselect truename)))
606 607
      (set-buffer true-buffer)
      (kill-buffer this-buffer))))
608

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

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

653
;; more hooks, this time for file-not-found
Eric S. Raymond's avatar
Eric S. Raymond committed
654
(defun vc-file-not-found-hook ()
Gerd Moellmann's avatar
Gerd Moellmann committed
655 656 657
  "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'."
658 659 660
  ;; 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
661
  (if (and (vc-backend buffer-file-name)
Dave Love's avatar
Dave Love committed
662
	   (yes-or-no-p
Gerd Moellmann's avatar
Gerd Moellmann committed
663 664 665 666 667 668
	    (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
669

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

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

Gerd Moellmann's avatar
Gerd Moellmann committed
677
;; ??? DL: why is this not done?
678 679
;;;(add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)

680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
;; Now arrange for (autoloaded) bindings of the main package.
;; Bindings for this have to go in the global map, as we'll often
;; want to call them from random buffers.

;; Autoloading works fine, but it prevents shortcuts from appearing
;; in the menu because they don't exist yet when the menu is built.
;; (autoload 'vc-prefix-map "vc" nil nil 'keymap)
(defvar vc-prefix-map
  (let ((map (make-sparse-keymap)))
    (define-key map "a" 'vc-update-change-log)
    (define-key map "b" 'vc-switch-backend)
    (define-key map "c" 'vc-cancel-version)
    (define-key map "d" 'vc-directory)
    (define-key map "g" 'vc-annotate)
    (define-key map "h" 'vc-insert-headers)
    (define-key map "i" 'vc-register)
    (define-key map "l" 'vc-print-log)
    (define-key map "m" 'vc-merge)
    (define-key map "r" 'vc-retrieve-snapshot)
    (define-key map "s" 'vc-create-snapshot)
    (define-key map "u" 'vc-revert-buffer)
    (define-key map "v" 'vc-next-action)
    (define-key map "=" 'vc-diff)
    (define-key map "~" 'vc-version-other-window)
    map))
(fset 'vc-prefix-map vc-prefix-map)
Gerd Moellmann's avatar
Gerd Moellmann committed
706
(define-key global-map "\C-xv" 'vc-prefix-map)
707

708 709 710 711 712 713
(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)))
714 715 716 717
  (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))
718
  (define-key vc-menu-map [vc-directory] '("VC Directory Listing" . vc-directory))
719
  (define-key vc-menu-map [separator1] '("----"))
720
  (define-key vc-menu-map [vc-annotate] '("Annotate" . vc-annotate))
721 722 723 724 725 726 727 728 729 730 731 732 733
  (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))
734
  (define-key vc-menu-map [vc-next-action] '("Check In/Out" . vc-next-action))
735 736
  (define-key vc-menu-map [vc-register] '("Register" . vc-register)))

737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752
;; 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
;;     '(member (vc-buffer-backend) '(RCS CVS)))
;;(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
753 754 755 756

(provide 'vc-hooks)

;;; vc-hooks.el ends here