vc-hooks.el 30.8 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.146 2002/10/17 15:46:06 lektu 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)

41 42 43 44 45 46
(defvar vc-ignore-vc-files nil)
(make-obsolete-variable 'vc-ignore-vc-files 'vc-handled-backends)
(defvar vc-master-templates ())
(make-obsolete-variable 'vc-master-templates 'vc-BACKEND-master-templates)
(defvar vc-header-alist ())
(make-obsolete-variable 'vc-header-alist 'vc-BACKEND-header)
Gerd Moellmann's avatar
Gerd Moellmann committed
47 48 49 50 51 52 53 54 55

(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)
56
  :version "21.1"
Karl Heuer's avatar
Karl Heuer committed
57
  :group 'vc)
58

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

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

Karl Heuer's avatar
Karl Heuer committed
73
(defcustom vc-follow-symlinks 'ask
Gerd Moellmann's avatar
Gerd Moellmann committed
74 75 76 77 78
  "*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,
79 80
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
81
visited and a warning displayed."
Gerd Moellmann's avatar
Gerd Moellmann committed
82 83 84
  :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
85
  :group 'vc)
86

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

93

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

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

Karl Heuer's avatar
Karl Heuer committed
106
(defcustom vc-mistrust-permissions nil
Gerd Moellmann's avatar
Gerd Moellmann committed
107 108
  "*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
109 110 111
See also variable `vc-consult-headers'."
  :type 'boolean
  :group 'vc)
112 113

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

120
;;; This is handled specially now.
Eric S. Raymond's avatar
Eric S. Raymond committed
121
;; Tell Emacs about this new kind of minor mode
122
;; (add-to-list 'minor-mode-alist '(vc-mode vc-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
123

Eric S. Raymond's avatar
Eric S. Raymond committed
124
(make-variable-buffer-local 'vc-mode)
125
(put 'vc-mode 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
126

127 128 129 130 131 132 133 134
(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}")

135
(defmacro vc-error-occurred (&rest body)
136
  `(condition-case nil (progn ,@body nil) (error t)))
137

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

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

147 148
(defvar vc-touched-properties nil)

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

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

161
(defun vc-file-clearprops (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
162
  "Clear all VC properties of FILE."
163
  (setplist (intern file vc-file-prop-obarray) nil))
164

Gerd Moellmann's avatar
Gerd Moellmann committed
165 166 167 168 169 170 171 172 173 174 175

;; 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.
176
If there is no such implementation, return the default implementation;
Gerd Moellmann's avatar
Gerd Moellmann committed
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
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)))
217

218
(defun vc-insert-file (file &optional limit blocksize)
Gerd Moellmann's avatar
Gerd Moellmann committed
219 220 221 222
  "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
223
occurrence of LIMIT is found.  Anything from the start of that occurrence
224 225
to the end of the buffer is then deleted.  The function returns
non-nil if FILE exists and its contents were successfully inserted."
226
  (erase-buffer)
227 228 229 230
  (when (file-exists-p file)
    (if (not limit)
        (insert-file-contents file)
      (if (not blocksize) (setq blocksize 8192))
231 232 233 234 235
      (let ((filepos 0))
        (while
	    (and (< 0 (cadr (insert-file-contents
			     file nil filepos (incf filepos blocksize))))
		 (progn (beginning-of-line)
236 237 238 239
                        (let ((pos (re-search-forward limit nil 'move)))
                          (if pos (delete-region (match-beginning 0)
                                                 (point-max)))
                          (not pos)))))))
240 241
    (set-buffer-modified-p nil)
    t))
242

243 244 245 246 247 248
;; 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.)
249

250
;; properties indicating the backend being used for FILE
251

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

255 256 257 258
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
259 260 261 262 263 264 265 266 267
  (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
268 269 270 271 272 273
	(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)))
274
	   (if (or (not backend) (eq backend 'none))
275 276
	       vc-handled-backends
	     (cons backend vc-handled-backends))))
Gerd Moellmann's avatar
Gerd Moellmann committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
        ;; 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)))
299

300
(defun vc-name (file)
Dave Love's avatar
Dave Love committed
301 302 303
  "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
304
  ;; in vc-hooks.
305
  (or (vc-file-getprop file 'vc-name)
306 307 308 309
      ;; force computation of the property by calling
      ;; vc-BACKEND-registered explicitly
      (if (and (vc-backend file)
	       (vc-call-backend (vc-backend file) 'registered file))
310
	  (vc-file-getprop file 'vc-name))))
311

312
(defun vc-checkout-model (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
313 314
  "Indicate how FILE is checked out.

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

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

321
  'locking    FILE is read-only if up-to-date; user must type
322
              \\[vc-next-action] before editing.  Strict locking
Gerd Moellmann's avatar
Gerd Moellmann committed
323 324
              is assumed.

325
  'announce   FILE is read-only if up-to-date; user must type
326
              \\[vc-next-action] before editing.  But other users
Gerd Moellmann's avatar
Gerd Moellmann committed
327 328
              may be editing at the same time."
  (or (vc-file-getprop file 'vc-checkout-model)
329 330 331
      (if (vc-backend file)
          (vc-file-setprop file 'vc-checkout-model
                           (vc-call checkout-model file)))))
332

333
(defun vc-user-login-name (&optional uid)
Gerd Moellmann's avatar
Gerd Moellmann committed
334 335 336 337 338
  "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."
339
  (or (user-login-name uid)
Gerd Moellmann's avatar
Gerd Moellmann committed
340 341 342 343 344
      (number-to-string (or uid (user-uid)))))

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

345 346
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
347 348 349 350 351 352 353 354 355 356

  '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).
357

Gerd Moellmann's avatar
Gerd Moellmann committed
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373
  '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)
374 375 376
      (if (vc-backend file)
          (vc-file-setprop file 'vc-state
                           (vc-call state-heuristic file)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
377 378 379 380 381 382

(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
383 384 385
  "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
386
   (vc-call-backend backend 'state file))
387

388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
(defun vc-workfile-unchanged-p (file)
  "Return non-nil if FILE has not changed since the 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 (backend file)
  "Check if FILE is unchanged by diffing against the master version.
Return non-nil if FILE is unchanged."
  (zerop (vc-call diff file (vc-workfile-version file))))

403
(defun vc-workfile-version (file)
404 405
  "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
406
  (or (vc-file-getprop file 'vc-workfile-version)
407 408 409
      (if (vc-backend file)
          (vc-file-setprop file 'vc-workfile-version
                           (vc-call workfile-version file)))))
410

Gerd Moellmann's avatar
Gerd Moellmann committed
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 436 437 438 439 440 441
(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)
442
  "Return non-nil if there is a master corresponding to FILE.
Gerd Moellmann's avatar
Gerd Moellmann committed
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457

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
458
      (mapcar
Gerd Moellmann's avatar
Gerd Moellmann committed
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
       (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))))
474

475
(defun vc-toggle-read-only (&optional verbose)
476
  "Change read-only status of current buffer, perhaps via version control.
477

478 479
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
480 481 482
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;
483 484 485 486
to do that, use this command a second time with no argument.

If you bind this function to \\[toggle-read-only], then Emacs checks files
in or out whenever you toggle the read-only flag."
487
  (interactive "P")
488
  (if (or (and (boundp 'vc-dired-mode) vc-dired-mode)
Gerd Moellmann's avatar
Gerd Moellmann committed
489 490
	  ;; use boundp because vc.el might not be loaded
	  (vc-backend (buffer-file-name)))
491
      (vc-next-action verbose)
Eric S. Raymond's avatar
Eric S. Raymond committed
492 493
    (toggle-read-only)))

494
(defun vc-default-make-version-backups-p (backend file)
495
  "Return non-nil if unmodified versions should be backed up locally.
496
The default is to switch off this feature."
497 498
  nil)

499 500 501 502 503
(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."
504 505 506
  (if regexp
      (concat (regexp-quote (file-name-nondirectory file))
              "\\.~[0-9.]+" (unless manual "\\.") "~")
507 508
    (expand-file-name (concat (file-name-nondirectory file)
                              ".~" (or rev (vc-workfile-version file))
509 510
                              (unless manual ".") "~")
                      (file-name-directory file))))
511 512 513

(defun vc-delete-automatic-version-backups (file)
  "Delete all existing automatic version backups for FILE."
514 515 516
  (condition-case nil
      (mapcar
       'delete-file
517
       (directory-files (or (file-name-directory file) default-directory) t
518 519 520
			(vc-version-backup-file-name file nil nil t)))
    ;; Don't fail when the directory doesn't exist.
    (file-error nil)))
521 522 523 524

(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."
525 526 527 528 529
  (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)))
530 531 532 533 534 535 536 537 538 539

(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)
540 541
	 (vc-call make-version-backups-p file)
         (vc-make-version-backup file))))
542

543
(defun vc-after-save ()
Gerd Moellmann's avatar
Gerd Moellmann committed
544
  "Function to be called by `basic-save-buffer' (in files.el)."
Dave Love's avatar
Dave Love committed
545
  ;; If the file in the current buffer is under version control,
Gerd Moellmann's avatar
Gerd Moellmann committed
546 547
  ;; up-to-date, and locking is not used for the file, set
  ;; the state to 'edited and redisplay the mode line.
548
  (let ((file (buffer-file-name)))
549
    (and (vc-backend file)
550 551 552 553 554 555 556
	 (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
557 558 559 560
         (vc-up-to-date-p file)
         (eq (vc-checkout-model file) 'implicit)
         (vc-file-setprop file 'vc-state 'edited)
	 (vc-mode-line file)
561 562 563 564
	 (if (featurep 'vc)
	     ;; If VC is not loaded, then there can't be
	     ;; any VC Dired buffer to synchronize.
	     (vc-dired-resynch-file file)))))
565

Gerd Moellmann's avatar
Gerd Moellmann committed
566
(defun vc-mode-line (file)
Eric S. Raymond's avatar
Eric S. Raymond committed
567
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
568
The value is set in the current buffer, which should be the buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
569
visiting FILE."
570
  (interactive (list buffer-file-name))
571 572
  (if (not (vc-backend file))
      (setq vc-mode nil)
573 574 575
    (setq vc-mode (concat " " (if vc-display-status
				  (vc-call mode-line-string file)
				(symbol-name (vc-backend file)))))
576 577
    ;; 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
578
    ;; cannot modify a file that someone else has locked.
Gerd Moellmann's avatar
Gerd Moellmann committed
579 580
    (and (equal file (buffer-file-name))
         (stringp (vc-state file))
581
	 (setq buffer-read-only t))
Richard M. Stallman's avatar
Richard M. Stallman committed
582 583 584 585
    ;; 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
586
    (and (equal file (buffer-file-name))
587 588 589
	 (not buffer-read-only)
	 (zerop (user-real-uid))
	 (zerop (logand (file-modes (buffer-file-name)) 128))
Gerd Moellmann's avatar
Gerd Moellmann committed
590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
	 (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)))
606
    (cond ((or (eq state 'up-to-date)
Gerd Moellmann's avatar
Gerd Moellmann committed
607 608 609 610 611 612 613 614 615
	       (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)))))
616

617
(defun vc-follow-link ()
Gerd Moellmann's avatar
Gerd Moellmann committed
618 619 620
  "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."
621
  (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name)))
622 623 624 625
         (true-buffer (find-buffer-visiting truename))
	 (this-buffer (current-buffer)))
    (if (eq true-buffer this-buffer)
	(progn
626
	  (kill-buffer this-buffer)
627 628 629
	  ;; 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.
630
	  (set-buffer (find-file-noselect truename)))
631 632
      (set-buffer true-buffer)
      (kill-buffer this-buffer))))
633

Eric S. Raymond's avatar
Eric S. Raymond committed
634
(defun vc-find-file-hook ()
Gerd Moellmann's avatar
Gerd Moellmann committed
635
  "Function for `find-file-hooks' activating VC mode if appropriate."
636 637
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
638 639
  (if vc-mode
      (setq vc-mode nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
640
  (when buffer-file-name
641 642
    (vc-file-clearprops buffer-file-name)
    (cond
643
     ((vc-backend buffer-file-name)
644 645 646 647 648
      (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)
649 650
	     (setq backup-inhibited t))))
     ((let* ((link (file-symlink-p buffer-file-name))
651
	     (link-type (and link (vc-backend (file-chase-links link)))))
652
	(if link-type
653 654 655
            (cond ((eq vc-follow-symlinks nil)
                   (message
        "Warning: symbolic link to %s-controlled source file" link-type))
656 657 658 659 660 661
                  ((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
662
			(abbreviate-file-name
Gerd Moellmann's avatar
Gerd Moellmann committed
663
                         (file-chase-links buffer-file-name))))
664

665 666 667 668
		   (vc-follow-link)
		   (message "Followed link to %s" buffer-file-name)
		   (vc-find-file-hook))
                  (t
669 670
                   (if (yes-or-no-p (format
        "Symbolic link to %s-controlled source file; follow link? " link-type))
671
                       (progn (vc-follow-link)
672 673
                              (message "Followed link to %s" buffer-file-name)
                              (vc-find-file-hook))
Gerd Moellmann's avatar
Gerd Moellmann committed
674
                     (message
675
        "Warning: editing through the link bypasses version control")
Gerd Moellmann's avatar
Gerd Moellmann committed
676
                     )))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
677

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

680
;; more hooks, this time for file-not-found
Eric S. Raymond's avatar
Eric S. Raymond committed
681
(defun vc-file-not-found-hook ()
Gerd Moellmann's avatar
Gerd Moellmann committed
682 683 684
  "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'."
685 686 687
  ;; 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
688
  (if (and (vc-backend buffer-file-name)
Dave Love's avatar
Dave Love committed
689
	   (yes-or-no-p
Gerd Moellmann's avatar
Gerd Moellmann committed
690 691 692 693 694 695
	    (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
696

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

699
(defun vc-kill-buffer-hook ()
Gerd Moellmann's avatar
Gerd Moellmann committed
700 701 702
  "Discard VC info about a file when we kill its buffer."
  (if (buffer-file-name)
      (vc-file-clearprops (buffer-file-name))))
703

704
(add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)
705

706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
;; 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
732
(define-key global-map "\C-xv" 'vc-prefix-map)
733

734 735 736 737 738 739
(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)))
740 741 742 743
  (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))
744
  (define-key vc-menu-map [vc-directory] '("VC Directory Listing" . vc-directory))
745
  (define-key vc-menu-map [separator1] '("----"))
746
  (define-key vc-menu-map [vc-annotate] '("Annotate" . vc-annotate))
747 748 749
  (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))
750
  (define-key vc-menu-map [vc-diff] '("Compare with Base Version" . vc-diff))
751 752 753 754 755 756
  (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 [vc-insert-header]
    '("Insert Header" . vc-insert-headers))
757 758 759 760 761
  (define-key vc-menu-map [undo] '("Undo Last Check-In" . vc-cancel-version))
  (define-key vc-menu-map [vc-revert-buffer]
    '("Revert to Base Version" . vc-revert-buffer))
  (define-key vc-menu-map [vc-update]
    '("Update to Latest Version" . vc-update))
762
  (define-key vc-menu-map [vc-next-action] '("Check In/Out" . vc-next-action))
763 764
  (define-key vc-menu-map [vc-register] '("Register" . vc-register)))

765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
;; 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
781 782 783 784

(provide 'vc-hooks)

;;; vc-hooks.el ends here