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

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

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

9
;; $Id: vc-hooks.el,v 1.157 2003/08/23 10:06:29 spiegel Exp $
André Spiegel's avatar
André Spiegel committed
10

Eric S. Raymond's avatar
Eric S. Raymond committed
11 12 13 14 15 16 17 18 19 20 21 22 23
;; 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
24 25 26
;; 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
27 28 29

;;; Commentary:

Gerd Moellmann's avatar
Gerd Moellmann committed
30 31 32 33
;; 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
34 35 36

;;; Code:

37 38
(eval-when-compile
  (require 'cl))
39

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

42
(defvar vc-ignore-vc-files nil)
43
(make-obsolete-variable 'vc-ignore-vc-files
44
                        "set `vc-handled-backends' to nil to disable VC.")
45

46
(defvar vc-master-templates ())
47 48 49
(make-obsolete-variable 'vc-master-templates 
 "to define master templates for a given BACKEND, use 
vc-BACKEND-master-templates.  To enable or disable VC for a given
50
BACKEND, use `vc-handled-backends'.")
51

52 53
(defvar vc-header-alist ())
(make-obsolete-variable 'vc-header-alist 'vc-BACKEND-header)
Gerd Moellmann's avatar
Gerd Moellmann committed
54

55
(defcustom vc-handled-backends '(RCS CVS SVN MCVS SCCS)
Gerd Moellmann's avatar
Gerd Moellmann committed
56 57 58 59 60 61 62
  "*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)
63
  :version "21.1"
Karl Heuer's avatar
Karl Heuer committed
64
  :group 'vc)
65

Karl Heuer's avatar
Karl Heuer committed
66
(defcustom vc-path
67 68 69
  (if (file-directory-p "/usr/sccs")
      '("/usr/sccs")
    nil)
Karl Heuer's avatar
Karl Heuer committed
70 71 72
  "*List of extra directories to search for version control commands."
  :type '(repeat directory)
  :group 'vc)
73

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

Karl Heuer's avatar
Karl Heuer committed
81
(defcustom vc-follow-symlinks 'ask
Gerd Moellmann's avatar
Gerd Moellmann committed
82 83 84 85 86
  "*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,
87 88
telling you about it in the echo area.  If it is `ask', VC asks for
confirmation whether it should follow the link.  If nil, the link is
Karl Heuer's avatar
Karl Heuer committed
89
visited and a warning displayed."
Gerd Moellmann's avatar
Gerd Moellmann committed
90 91 92
  :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
93
  :group 'vc)
94

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

101

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

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

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

(defun vc-mistrust-permissions (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
122
  "Internal access function to variable `vc-mistrust-permissions' for FILE."
123 124
  (or (eq vc-mistrust-permissions 't)
      (and vc-mistrust-permissions
Gerd Moellmann's avatar
Gerd Moellmann committed
125
	   (funcall vc-mistrust-permissions
126 127
		    (vc-backend-subdirectory-name file)))))

128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
(defcustom vc-stay-local t
  "*Non-nil means use local operations when possible for remote repositories.
This avoids slow queries over the network and instead uses heuristics
and past information to determine the current status of a file.

The value can also be a regular expression or list of regular
expressions to match against the host name of a repository; then VC
only stays local for hosts that match it.  Alternatively, the value
can be a list of regular expressions where the first element is the
symbol `except'; then VC always stays local except for hosts matched
by these regular expressions."
  :type '(choice (const :tag "Always stay local" t)
	  (const :tag "Don't stay local" nil)
	  (list :format "\nExamine hostname and %v" :tag "Examine hostname ..."
		(set :format "%v" :inline t (const :format "%t" :tag "don't" except))
		(regexp :format " stay local,\n%t: %v" :tag "if it matches")
		(repeat :format "%v%i\n" :inline t (regexp :tag "or"))))
  :version "21.4"
  :group 'vc)

(defun vc-stay-local-p (file)
  "Return non-nil if VC should stay local when handling FILE.
This uses the `repository-hostname' backend operation."
  (let* ((backend (vc-backend file))
	 (sym (vc-make-backend-sym backend 'stay-local))
	 (stay-local (if (boundp sym) (symbol-value sym) t)))
    (if (eq stay-local t) (setq stay-local vc-stay-local))
    (if (symbolp stay-local) stay-local
      (let ((dirname (if (file-directory-p file)
			 (directory-file-name file)
		       (file-name-directory file))))
	(eq 'yes
	    (or (vc-file-getprop dirname 'vc-stay-local-p)
		(vc-file-setprop
		 dirname 'vc-stay-local-p
		 (let ((hostname (vc-call-backend
				  backend 'repository-hostname dirname)))
		   (if (not hostname)
		       'no
		     (let ((default t))
		       (if (eq (car-safe stay-local) 'except)
			   (setq default nil stay-local (cdr stay-local)))
		       (when (consp stay-local)
			 (setq stay-local
			       (mapconcat 'identity stay-local "\\|")))
		       (if (if (string-match stay-local hostname)
			       default (not default))
			   'yes 'no)))))))))))

177
;;; This is handled specially now.
Eric S. Raymond's avatar
Eric S. Raymond committed
178
;; Tell Emacs about this new kind of minor mode
179
;; (add-to-list 'minor-mode-alist '(vc-mode vc-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
180

Eric S. Raymond's avatar
Eric S. Raymond committed
181
(make-variable-buffer-local 'vc-mode)
182
(put 'vc-mode 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
183

184 185 186 187 188 189 190 191
(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}")

192
(defmacro vc-error-occurred (&rest body)
193
  `(condition-case nil (progn ,@body nil) (error t)))
194

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

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

204 205
(defvar vc-touched-properties nil)

Eric S. Raymond's avatar
Eric S. Raymond committed
206
(defun vc-file-setprop (file property value)
Gerd Moellmann's avatar
Gerd Moellmann committed
207
  "Set per-file VC PROPERTY for FILE to VALUE."
208 209 210 211
  (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
212 213 214
  (put (intern file vc-file-prop-obarray) property value))

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

218
(defun vc-file-clearprops (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
219
  "Clear all VC properties of FILE."
220
  (setplist (intern file vc-file-prop-obarray) nil))
221

Gerd Moellmann's avatar
Gerd Moellmann committed
222 223 224 225 226 227 228 229 230 231 232

;; 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.
233
If there is no such implementation, return the default implementation;
Gerd Moellmann's avatar
Gerd Moellmann committed
234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
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."
255 256
  (let ((f (assoc function-name (get backend 'vc-functions))))
    (if f (setq f (cdr f))
Gerd Moellmann's avatar
Gerd Moellmann committed
257
      (setq f (vc-find-backend-function backend function-name))
258 259 260 261 262 263
      (push (cons function-name f) (get backend 'vc-functions)))
    (cond
     ((null f)
      (error "Sorry, %s is not implemented for %s" function-name backend))
     ((consp f)	(apply (car f) (cdr f) args))
     (t		(apply f args)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
264 265 266 267 268 269 270 271 272 273 274

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

276
(defun vc-insert-file (file &optional limit blocksize)
Gerd Moellmann's avatar
Gerd Moellmann committed
277 278 279 280
  "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
281
occurrence of LIMIT is found.  Anything from the start of that occurrence
282 283
to the end of the buffer is then deleted.  The function returns
non-nil if FILE exists and its contents were successfully inserted."
284
  (erase-buffer)
285 286 287 288
  (when (file-exists-p file)
    (if (not limit)
        (insert-file-contents file)
      (if (not blocksize) (setq blocksize 8192))
289 290 291 292 293
      (let ((filepos 0))
        (while
	    (and (< 0 (cadr (insert-file-contents
			     file nil filepos (incf filepos blocksize))))
		 (progn (beginning-of-line)
294 295 296 297
                        (let ((pos (re-search-forward limit nil 'move)))
                          (if pos (delete-region (match-beginning 0)
                                                 (point-max)))
                          (not pos)))))))
298 299
    (set-buffer-modified-p nil)
    t))
300

301 302 303 304 305 306
;; 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.)
307

308
;; properties indicating the backend being used for FILE
309

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

313 314 315 316
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
317 318 319 320 321 322 323 324 325
  (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
326 327 328 329 330 331
	(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)))
332
	   (if (or (not backend) (eq backend 'none))
333 334
	       vc-handled-backends
	     (cons backend vc-handled-backends))))
Gerd Moellmann's avatar
Gerd Moellmann committed
335 336 337 338 339 340 341
        ;; 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
342
  ;; code like (vc-backend buffer-file-name)).
Gerd Moellmann's avatar
Gerd Moellmann committed
343 344 345 346 347 348 349 350 351 352 353 354 355 356
  (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)))
357

358
(defun vc-name (file)
Dave Love's avatar
Dave Love committed
359 360 361
  "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
362
  ;; in vc-hooks.
363
  (or (vc-file-getprop file 'vc-name)
364 365 366 367
      ;; force computation of the property by calling
      ;; vc-BACKEND-registered explicitly
      (if (and (vc-backend file)
	       (vc-call-backend (vc-backend file) 'registered file))
368
	  (vc-file-getprop file 'vc-name))))
369

370
(defun vc-checkout-model (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
371 372
  "Indicate how FILE is checked out.

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

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

379
  'locking    FILE is read-only if up-to-date; user must type
380
              \\[vc-next-action] before editing.  Strict locking
Gerd Moellmann's avatar
Gerd Moellmann committed
381 382
              is assumed.

383
  'announce   FILE is read-only if up-to-date; user must type
384
              \\[vc-next-action] before editing.  But other users
Gerd Moellmann's avatar
Gerd Moellmann committed
385 386
              may be editing at the same time."
  (or (vc-file-getprop file 'vc-checkout-model)
387 388 389
      (if (vc-backend file)
          (vc-file-setprop file 'vc-checkout-model
                           (vc-call checkout-model file)))))
390

391
(defun vc-user-login-name (&optional uid)
Gerd Moellmann's avatar
Gerd Moellmann committed
392 393 394 395 396
  "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."
397
  (or (user-login-name uid)
Gerd Moellmann's avatar
Gerd Moellmann committed
398 399 400 401 402
      (number-to-string (or uid (user-uid)))))

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

403 404
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
405 406 407 408 409 410 411 412 413 414

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

Gerd Moellmann's avatar
Gerd Moellmann committed
416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
  '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)."
431 432 433 434 435 436
  ;; FIXME: New (sub)states needed (?):
  ;; - `added' (i.e. `edited' but with no base version yet,
  ;;            typically represented by vc-workfile-version = "0")
  ;; - `conflict' (i.e. `edited' with conflict markers)
  ;; - `removed'
  ;; - `copied' and `moved' (might be handled by `removed' and `added')
Gerd Moellmann's avatar
Gerd Moellmann committed
437
  (or (vc-file-getprop file 'vc-state)
438 439 440
      (if (vc-backend file)
          (vc-file-setprop file 'vc-state
                           (vc-call state-heuristic file)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
441 442 443 444 445 446

(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
447 448 449
  "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
450
   (vc-call-backend backend 'state file))
451

452 453 454 455 456 457 458 459 460 461 462 463 464
(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."
465 466
  ;; If rev1 is nil, `diff' uses the current workfile version.
  (zerop (vc-call diff file)))
467

468
(defun vc-workfile-version (file)
469 470
  "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
471
  (or (vc-file-getprop file 'vc-workfile-version)
472 473 474
      (if (vc-backend file)
          (vc-file-setprop file 'vc-workfile-version
                           (vc-call workfile-version file)))))
475

Gerd Moellmann's avatar
Gerd Moellmann committed
476 477 478 479 480 481 482 483 484 485 486
(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)))
487 488
                              (with-no-warnings
                               vc-master-templates)))
Gerd Moellmann's avatar
Gerd Moellmann committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
		       (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)
508
  "Return non-nil if there is a master corresponding to FILE.
Gerd Moellmann's avatar
Gerd Moellmann committed
509 510 511 512 513 514 515 516 517 518 519 520 521 522 523

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
524
      (mapcar
Gerd Moellmann's avatar
Gerd Moellmann committed
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
       (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))))
540

541
(defun vc-toggle-read-only (&optional verbose)
542
  "Change read-only status of current buffer, perhaps via version control.
543

544 545
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
546 547 548
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;
549 550 551 552
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."
553
  (interactive "P")
554
  (if (or (and (boundp 'vc-dired-mode) vc-dired-mode)
Gerd Moellmann's avatar
Gerd Moellmann committed
555
	  ;; use boundp because vc.el might not be loaded
556
	  (vc-backend buffer-file-name))
557
      (vc-next-action verbose)
Eric S. Raymond's avatar
Eric S. Raymond committed
558 559
    (toggle-read-only)))

560
(defun vc-default-make-version-backups-p (backend file)
561
  "Return non-nil if unmodified versions should be backed up locally.
562
The default is to switch off this feature."
563 564
  nil)

565 566 567 568 569
(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."
570 571 572
  (if regexp
      (concat (regexp-quote (file-name-nondirectory file))
              "\\.~[0-9.]+" (unless manual "\\.") "~")
573 574
    (expand-file-name (concat (file-name-nondirectory file)
                              ".~" (or rev (vc-workfile-version file))
575 576
                              (unless manual ".") "~")
                      (file-name-directory file))))
577 578 579

(defun vc-delete-automatic-version-backups (file)
  "Delete all existing automatic version backups for FILE."
580 581 582
  (condition-case nil
      (mapcar
       'delete-file
583
       (directory-files (or (file-name-directory file) default-directory) t
584 585 586
			(vc-version-backup-file-name file nil nil t)))
    ;; Don't fail when the directory doesn't exist.
    (file-error nil)))
587 588 589 590

(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."
591
  (unless (and (fboundp 'msdos-long-file-names)
592
               (not (with-no-warnings msdos-long-file-names)))
593 594 595
    (vc-delete-automatic-version-backups file)
    (copy-file file (vc-version-backup-file-name file)
               nil 'keep-date)))
596 597 598 599 600 601

(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.
602
  (let ((file buffer-file-name))
603 604 605
    (and (vc-backend file)
	 (vc-up-to-date-p file)
	 (eq (vc-checkout-model file) 'implicit)
606 607
	 (vc-call make-version-backups-p file)
         (vc-make-version-backup file))))
608

609
(defun vc-after-save ()
Gerd Moellmann's avatar
Gerd Moellmann committed
610
  "Function to be called by `basic-save-buffer' (in files.el)."
Dave Love's avatar
Dave Love committed
611
  ;; If the file in the current buffer is under version control,
Gerd Moellmann's avatar
Gerd Moellmann committed
612 613
  ;; up-to-date, and locking is not used for the file, set
  ;; the state to 'edited and redisplay the mode line.
614
  (let ((file buffer-file-name))
615
    (and (vc-backend file)
616 617 618 619 620 621 622
	 (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
623 624 625 626
         (vc-up-to-date-p file)
         (eq (vc-checkout-model file) 'implicit)
         (vc-file-setprop file 'vc-state 'edited)
	 (vc-mode-line file)
627 628 629 630
	 (if (featurep 'vc)
	     ;; If VC is not loaded, then there can't be
	     ;; any VC Dired buffer to synchronize.
	     (vc-dired-resynch-file file)))))
631

Gerd Moellmann's avatar
Gerd Moellmann committed
632
(defun vc-mode-line (file)
Eric S. Raymond's avatar
Eric S. Raymond committed
633
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
634
The value is set in the current buffer, which should be the buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
635
visiting FILE."
636
  (interactive (list buffer-file-name))
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651
  (let ((backend (vc-backend file)))
    (if (not backend)
	(setq vc-mode nil)
      (setq vc-mode (concat " " (if vc-display-status
				    (vc-call mode-line-string file)
				  (symbol-name backend))))
      ;; If the file is locked by some other user, make
      ;; the buffer read-only.  Like this, even root
      ;; cannot modify a file that someone else has locked.
      (and (equal file buffer-file-name)
	   (stringp (vc-state file))
	   (setq buffer-read-only t))
      ;; 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).
652 653 654
    ;; This way, even root cannot modify a file that isn't locked.
    (and (equal file buffer-file-name)
	 (not buffer-read-only)
655 656 657 658 659
	   (zerop (user-real-uid))
	   (zerop (logand (file-modes buffer-file-name) 128))
	   (setq buffer-read-only t)))
    (force-mode-line-update)
    backend))
Gerd Moellmann's avatar
Gerd Moellmann committed
660 661 662 663 664 665 666 667 668 669 670 671 672

(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)))
673
    (cond ((or (eq state 'up-to-date)
Gerd Moellmann's avatar
Gerd Moellmann committed
674 675 676 677 678 679 680 681 682
	       (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)))))
683

684
(defun vc-follow-link ()
Gerd Moellmann's avatar
Gerd Moellmann committed
685 686 687
  "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."
688
  (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name)))
689 690 691 692
         (true-buffer (find-buffer-visiting truename))
	 (this-buffer (current-buffer)))
    (if (eq true-buffer this-buffer)
	(progn
693
	  (kill-buffer this-buffer)
694 695 696
	  ;; 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.
697
	  (set-buffer (find-file-noselect truename)))
698 699
      (set-buffer true-buffer)
      (kill-buffer this-buffer))))
700

Eric S. Raymond's avatar
Eric S. Raymond committed
701
(defun vc-find-file-hook ()
702
  "Function for `find-file-hook' activating VC mode if appropriate."
703 704
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
705 706
  (if vc-mode
      (setq vc-mode nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
707
  (when buffer-file-name
708 709
    (vc-file-clearprops buffer-file-name)
    (cond
710
     ((vc-backend buffer-file-name)
711
      ;; Compute the state and put it in the modeline.
712
      (vc-mode-line buffer-file-name)
713 714 715 716
      (unless vc-make-backup-files
	;; Use this variable, not make-backup-files,
	;; because this is for things that depend on the file name.
	(set (make-local-variable 'backup-inhibited) t)))
717
     ((let* ((link (file-symlink-p buffer-file-name))
718
	     (link-type (and link (vc-backend (file-chase-links link)))))
719 720 721
	(cond ((not link-type) nil)	;Nothing to do.
	      ((eq vc-follow-symlinks nil)
	       (message
722
        "Warning: symbolic link to %s-controlled source file" link-type))
723 724 725 726 727 728 729 730 731 732 733 734 735 736
	      ((or (not (eq vc-follow-symlinks 'ask))
		   ;; If we already visited this file by following
		   ;; the link, don't ask again if we try to visit
		   ;; it again.  GUD does that, and repeated questions
		   ;; are painful.
		   (get-file-buffer
		    (abbreviate-file-name
		     (file-chase-links buffer-file-name))))

	       (vc-follow-link)
	       (message "Followed link to %s" buffer-file-name)
	       (vc-find-file-hook))
	      (t
	       (if (yes-or-no-p (format
737
        "Symbolic link to %s-controlled source file; follow link? " link-type))
738 739 740 741
		   (progn (vc-follow-link)
			  (message "Followed link to %s" buffer-file-name)
			  (vc-find-file-hook))
		 (message
742
        "Warning: editing through the link bypasses version control")
743
		 ))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
744

745
(add-hook 'find-file-hook 'vc-find-file-hook)
Eric S. Raymond's avatar
Eric S. Raymond committed
746

747
;; more hooks, this time for file-not-found
Eric S. Raymond's avatar
Eric S. Raymond committed
748
(defun vc-file-not-found-hook ()
Gerd Moellmann's avatar
Gerd Moellmann committed
749 750
  "When file is not found, try to check it out from version control.
Returns t if checkout was successful, nil otherwise.
751
Used in `find-file-not-found-functions'."
752 753 754
  ;; 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
755
  (if (and (vc-backend buffer-file-name)
Dave Love's avatar
Dave Love committed
756
	   (yes-or-no-p
Gerd Moellmann's avatar
Gerd Moellmann committed
757 758 759 760 761 762
	    (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
763

764
(add-hook 'find-file-not-found-functions 'vc-file-not-found-hook)
Eric S. Raymond's avatar
Eric S. Raymond committed
765

766
(defun vc-kill-buffer-hook ()
Gerd Moellmann's avatar
Gerd Moellmann committed
767
  "Discard VC info about a file when we kill its buffer."
768 769
  (if buffer-file-name
      (vc-file-clearprops buffer-file-name)))
770

771
(add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)
772

773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798
;; 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
799
(define-key global-map "\C-xv" 'vc-prefix-map)
800

801 802 803 804 805 806
(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)))
807 808 809 810
  (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))
811
  (define-key vc-menu-map [vc-directory] '("VC Directory Listing" . vc-directory))
812
  (define-key vc-menu-map [separator1] '("----"))
813
  (define-key vc-menu-map [vc-annotate] '("Annotate" . vc-annotate))
814 815 816
  (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))
817
  (define-key vc-menu-map [vc-diff] '("Compare with Base Version" . vc-diff))
818 819 820 821 822 823
  (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))
824 825 826 827 828
  (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))
829
  (define-key vc-menu-map [vc-next-action] '("Check In/Out" . vc-next-action))
830 831
  (define-key vc-menu-map [vc-register] '("Register" . vc-register)))

832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847
;; 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
848 849 850 851

(provide 'vc-hooks)

;;; vc-hooks.el ends here