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

Glenn Morris's avatar
Glenn Morris committed
3 4
;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001,
;;   2002, 2003, 2004, 2005, 2006 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$
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
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
25 26
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, 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
(make-obsolete-variable 'vc-master-templates
 "to define master templates for a given BACKEND, use
49
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 56
(defcustom vc-ignore-dir-regexp "\\`\\([\\/][\\/]\\|/net/\\|/afs/\\)\\'"
  "Regexp matching directory names that are not under VC's control.
57 58
The default regexp prevents fruitless and time-consuming attempts
to determine the VC status in directories in which filenames are
59 60 61
interpreted as hostnames."
  :type 'regexp
  :group 'vc)
62

63 64
(defcustom vc-handled-backends '(RCS CVS SVN SCCS Arch MCVS)
  ;; Arch and MCVS come last because they are per-tree rather than per-dir.
Gerd Moellmann's avatar
Gerd Moellmann committed
65 66 67 68 69 70 71
  "*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)
72
  :version "21.1"
Karl Heuer's avatar
Karl Heuer committed
73
  :group 'vc)
74

Karl Heuer's avatar
Karl Heuer committed
75
(defcustom vc-path
76 77 78
  (if (file-directory-p "/usr/sccs")
      '("/usr/sccs")
    nil)
Karl Heuer's avatar
Karl Heuer committed
79 80 81
  "*List of extra directories to search for version control commands."
  :type '(repeat directory)
  :group 'vc)
82

Karl Heuer's avatar
Karl Heuer committed
83
(defcustom vc-make-backup-files nil
84
  "*If non-nil, backups of registered files are made as with other files.
Karl Heuer's avatar
Karl Heuer committed
85 86
If nil (the default), files covered by version control don't get backups."
  :type 'boolean
87 88
  :group 'vc
  :group 'backup)
Eric S. Raymond's avatar
Eric S. Raymond committed
89

Karl Heuer's avatar
Karl Heuer committed
90
(defcustom vc-follow-symlinks 'ask
Gerd Moellmann's avatar
Gerd Moellmann committed
91 92 93 94 95
  "*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,
96 97
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
98
visited and a warning displayed."
Gerd Moellmann's avatar
Gerd Moellmann committed
99 100 101
  :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
102
  :group 'vc)
103

Karl Heuer's avatar
Karl Heuer committed
104
(defcustom vc-display-status t
105
  "*If non-nil, display revision number and lock status in modeline.
Karl Heuer's avatar
Karl Heuer committed
106 107 108 109
Otherwise, not displayed."
  :type 'boolean
  :group 'vc)

110

Karl Heuer's avatar
Karl Heuer committed
111 112 113 114
(defcustom vc-consult-headers t
  "*If non-nil, identify work files by searching for version headers."
  :type 'boolean
  :group 'vc)
115

Karl Heuer's avatar
Karl Heuer committed
116
(defcustom vc-keep-workfiles t
117 118
  "*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
119 120 121
value of this flag."
  :type 'boolean
  :group 'vc)
122

Karl Heuer's avatar
Karl Heuer committed
123
(defcustom vc-mistrust-permissions nil
Gerd Moellmann's avatar
Gerd Moellmann committed
124 125
  "*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
126 127 128
See also variable `vc-consult-headers'."
  :type 'boolean
  :group 'vc)
129 130

(defun vc-mistrust-permissions (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
131
  "Internal access function to variable `vc-mistrust-permissions' for FILE."
132 133
  (or (eq vc-mistrust-permissions 't)
      (and vc-mistrust-permissions
Gerd Moellmann's avatar
Gerd Moellmann committed
134
	   (funcall vc-mistrust-permissions
135 136
		    (vc-backend-subdirectory-name file)))))

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
(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"))))
154
  :version "22.1"
155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
  :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)))))))))))

186
;;; This is handled specially now.
Eric S. Raymond's avatar
Eric S. Raymond committed
187
;; Tell Emacs about this new kind of minor mode
188
;; (add-to-list 'minor-mode-alist '(vc-mode vc-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
189

Eric S. Raymond's avatar
Eric S. Raymond committed
190
(make-variable-buffer-local 'vc-mode)
191
(put 'vc-mode 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
192

193 194 195 196 197 198 199 200
(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}")

201
(defmacro vc-error-occurred (&rest body)
202
  `(condition-case nil (progn ,@body nil) (error t)))
203

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

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

213 214
(defvar vc-touched-properties nil)

Eric S. Raymond's avatar
Eric S. Raymond committed
215
(defun vc-file-setprop (file property value)
Gerd Moellmann's avatar
Gerd Moellmann committed
216
  "Set per-file VC PROPERTY for FILE to VALUE."
217 218 219 220
  (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
221 222 223
  (put (intern file vc-file-prop-obarray) property value))

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

227
(defun vc-file-clearprops (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
228
  "Clear all VC properties of FILE."
229
  (setplist (intern file vc-file-prop-obarray) nil))
230

Gerd Moellmann's avatar
Gerd Moellmann committed
231 232 233 234 235 236 237 238 239 240 241

;; 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.
242
If there is no such implementation, return the default implementation;
Gerd Moellmann's avatar
Gerd Moellmann committed
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263
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."
264 265
  (let ((f (assoc function-name (get backend 'vc-functions))))
    (if f (setq f (cdr f))
Gerd Moellmann's avatar
Gerd Moellmann committed
266
      (setq f (vc-find-backend-function backend function-name))
267 268 269 270 271 272
      (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
273 274 275 276 277 278 279 280 281 282

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

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

309 310 311 312
(defun vc-find-root (file witness)
  "Find the root of a checked out project.
The function walks up the directory tree from FILE looking for WITNESS.
If WITNESS if not found, return nil, otherwise return the root."
313 314 315
  ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
  ;; witnesses in /home or in /.
  (setq file (abbreviate-file-name file))
316 317 318 319 320 321 322 323 324 325
  (let ((root nil))
    (while (not (or root
                   (equal file (setq file (file-name-directory file)))
                   (null file)
                   (string-match vc-ignore-dir-regexp file)))
      (if (file-exists-p (expand-file-name witness file))
         (setq root file)
       (setq file (directory-file-name file))))
    root))

326 327 328 329 330 331
;; 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.)
332

333
;; properties indicating the backend being used for FILE
334

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

338 339 340 341
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
342
  (let (handler)
343 344 345 346 347 348 349
    (cond
     ((string-match vc-ignore-dir-regexp (file-name-directory file)) nil)
     ((and (boundp 'file-name-handler-alist)
          (setq handler (find-file-name-handler file 'vc-registered)))
      ;; handler should set vc-backend and return t if registered
      (funcall handler 'vc-registered file))
     (t
Gerd Moellmann's avatar
Gerd Moellmann committed
350 351 352
      ;; There is no file name handler.
      ;; Try vc-BACKEND-registered for each handled BACKEND.
      (catch 'found
353 354 355 356 357 358
	(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)))
359
	   (if (or (not backend) (eq backend 'none))
360 361
	       vc-handled-backends
	     (cons backend vc-handled-backends))))
Gerd Moellmann's avatar
Gerd Moellmann committed
362 363
        ;; File is not registered.
        (vc-file-setprop file 'vc-backend 'none)
364
        nil)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
365 366 367 368

(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
369
  ;; code like (vc-backend buffer-file-name)).
Gerd Moellmann's avatar
Gerd Moellmann committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383
  (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)))
384

385
(defun vc-name (file)
Dave Love's avatar
Dave Love committed
386 387 388
  "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
389
  ;; in vc-hooks.
390
  (or (vc-file-getprop file 'vc-name)
391 392 393 394
      ;; force computation of the property by calling
      ;; vc-BACKEND-registered explicitly
      (if (and (vc-backend file)
	       (vc-call-backend (vc-backend file) 'registered file))
395
	  (vc-file-getprop file 'vc-name))))
396

397
(defun vc-checkout-model (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
398 399
  "Indicate how FILE is checked out.

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

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

406
  'locking    FILE is read-only if up-to-date; user must type
407
              \\[vc-next-action] before editing.  Strict locking
Gerd Moellmann's avatar
Gerd Moellmann committed
408 409
              is assumed.

410
  'announce   FILE is read-only if up-to-date; user must type
411
              \\[vc-next-action] before editing.  But other users
Gerd Moellmann's avatar
Gerd Moellmann committed
412 413
              may be editing at the same time."
  (or (vc-file-getprop file 'vc-checkout-model)
414 415 416
      (if (vc-backend file)
          (vc-file-setprop file 'vc-checkout-model
                           (vc-call checkout-model file)))))
417

418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433
(defun vc-user-login-name (file)
  "Return the name under which the user accesses the given FILE."
  (or (and (eq (string-match tramp-file-name-regexp file) 0)
           ;; tramp case: execute "whoami" via tramp
           (let ((default-directory (file-name-directory file)))
             (with-temp-buffer
               (if (not (zerop (process-file "whoami" nil t)))
                   ;; fall through if "whoami" didn't work
                   nil
                 ;; remove trailing newline
                 (delete-region (1- (point-max)) (point-max))
                 (buffer-string)))))
      ;; normal case
      (user-login-name)
      ;; if user-login-name is nil, return the UID as a string
      (number-to-string (user-uid))))
Gerd Moellmann's avatar
Gerd Moellmann committed
434 435 436 437

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

438 439
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
440 441 442 443 444 445 446 447 448 449

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

Gerd Moellmann's avatar
Gerd Moellmann committed
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465
  '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)."
466 467 468 469 470 471
  ;; 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
472
  (or (vc-file-getprop file 'vc-state)
473 474 475
      (if (vc-backend file)
          (vc-file-setprop file 'vc-state
                           (vc-call state-heuristic file)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
476

477 478 479 480 481 482
(defun vc-recompute-state (file)
  "Recompute the version control state of FILE, and return it.
This calls the possibly expensive function vc-BACKEND-state,
rather than the heuristic."
  (vc-file-setprop file 'vc-state (vc-call state file)))

Gerd Moellmann's avatar
Gerd Moellmann committed
483 484 485 486 487
(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
488 489 490
  "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
491
   (vc-call-backend backend 'state file))
492

493 494 495 496
(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))))
497 498 499
    (if (and checkout-time
             ;; Tramp and Ange-FTP return this when they don't know the time.
             (not (equal lastmod '(0 0))))
500 501 502 503 504 505 506 507
        (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."
508
  (zerop (condition-case err
509 510 511
             ;; If the implementation supports it, let the output
             ;; go to *vc*, not *vc-diff*, since this is an internal call.
             (vc-call diff file nil nil "*vc*")
512 513 514 515 516 517 518 519
           (wrong-number-of-arguments
            ;; If this error came from the above call to vc-BACKEND-diff,
            ;; try again without the optional buffer argument (for
            ;; backward compatibility).  Otherwise, resignal.
            (if (or (not (eq (cadr err)
                             (indirect-function
                              (vc-find-backend-function (vc-backend file)
                                                        'diff))))
520 521
                    (not (eq (caddr err) 4)))
                (signal (car err) (cdr err))
522
              (vc-call diff file))))))
523

524
(defun vc-workfile-version (file)
525 526
  "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
527
  (or (vc-file-getprop file 'vc-workfile-version)
528 529 530
      (if (vc-backend file)
          (vc-file-setprop file 'vc-workfile-version
                           (vc-call workfile-version file)))))
531

Gerd Moellmann's avatar
Gerd Moellmann committed
532 533 534 535 536 537 538 539 540 541 542
(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)))
543 544
                              (with-no-warnings
                               vc-master-templates)))
Gerd Moellmann's avatar
Gerd Moellmann committed
545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563
		       (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)
564
  "Return non-nil if there is a master corresponding to FILE.
Gerd Moellmann's avatar
Gerd Moellmann committed
565 566 567 568 569 570 571 572 573 574 575 576 577 578 579

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
580
      (mapcar
Gerd Moellmann's avatar
Gerd Moellmann committed
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
       (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))))
596

597
(defun vc-toggle-read-only (&optional verbose)
598
  "Change read-only status of current buffer, perhaps via version control.
599

600 601
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
602 603 604
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;
605 606 607 608
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."
609
  (interactive "P")
610
  (if (or (and (boundp 'vc-dired-mode) vc-dired-mode)
Gerd Moellmann's avatar
Gerd Moellmann committed
611
	  ;; use boundp because vc.el might not be loaded
612
	  (vc-backend buffer-file-name))
613
      (vc-next-action verbose)
Eric S. Raymond's avatar
Eric S. Raymond committed
614 615
    (toggle-read-only)))

616
(defun vc-default-make-version-backups-p (backend file)
617
  "Return non-nil if unmodified versions should be backed up locally.
618
The default is to switch off this feature."
619 620
  nil)

621 622 623 624 625
(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."
626 627 628
  (if regexp
      (concat (regexp-quote (file-name-nondirectory file))
              "\\.~[0-9.]+" (unless manual "\\.") "~")
629 630
    (expand-file-name (concat (file-name-nondirectory file)
                              ".~" (or rev (vc-workfile-version file))
631 632
                              (unless manual ".") "~")
                      (file-name-directory file))))
633 634 635

(defun vc-delete-automatic-version-backups (file)
  "Delete all existing automatic version backups for FILE."
636 637 638
  (condition-case nil
      (mapcar
       'delete-file
639
       (directory-files (or (file-name-directory file) default-directory) t
640 641 642
			(vc-version-backup-file-name file nil nil t)))
    ;; Don't fail when the directory doesn't exist.
    (file-error nil)))
643 644 645 646

(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."
647
  (unless (and (fboundp 'msdos-long-file-names)
648
               (not (with-no-warnings (msdos-long-file-names))))
649
    (vc-delete-automatic-version-backups file)
650 651 652 653 654
    (condition-case nil
        (copy-file file (vc-version-backup-file-name file)
                   nil 'keep-date)
      ;; It's ok if it doesn't work (e.g. directory not writable),
      ;; since this is just for efficiency.
655
      (file-error
656 657 658
       (message
        (concat "Warning: Cannot make version backup; "
                "diff/revert therefore not local"))))))
659 660 661 662 663 664

(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.
665
  (let ((file buffer-file-name))
666 667 668
    (and (vc-backend file)
	 (vc-up-to-date-p file)
	 (eq (vc-checkout-model file) 'implicit)
669 670
	 (vc-call make-version-backups-p file)
         (vc-make-version-backup file))))
671

672
(defun vc-after-save ()
Gerd Moellmann's avatar
Gerd Moellmann committed
673
  "Function to be called by `basic-save-buffer' (in files.el)."
Dave Love's avatar
Dave Love committed
674
  ;; If the file in the current buffer is under version control,
Gerd Moellmann's avatar
Gerd Moellmann committed
675 676
  ;; up-to-date, and locking is not used for the file, set
  ;; the state to 'edited and redisplay the mode line.
677
  (let ((file buffer-file-name))
678
    (and (vc-backend file)
679 680 681 682 683 684 685
	 (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
686 687 688 689
         (vc-up-to-date-p file)
         (eq (vc-checkout-model file) 'implicit)
         (vc-file-setprop file 'vc-state 'edited)
	 (vc-mode-line file)
690 691 692 693
	 (if (featurep 'vc)
	     ;; If VC is not loaded, then there can't be
	     ;; any VC Dired buffer to synchronize.
	     (vc-dired-resynch-file file)))))
694

Gerd Moellmann's avatar
Gerd Moellmann committed
695
(defun vc-mode-line (file)
Eric S. Raymond's avatar
Eric S. Raymond committed
696
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
697
The value is set in the current buffer, which should be the buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
698
visiting FILE."
699
  (interactive (list buffer-file-name))
700 701 702 703 704 705 706 707 708 709 710 711 712 713 714
  (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).
715 716 717
    ;; This way, even root cannot modify a file that isn't locked.
    (and (equal file buffer-file-name)
	 (not buffer-read-only)
718 719 720 721 722
	   (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
723 724 725 726 727 728 729 730 731 732 733 734 735

(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)))
736
    (cond ((or (eq state 'up-to-date)
Gerd Moellmann's avatar
Gerd Moellmann committed
737 738 739 740 741 742 743 744 745
	       (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)))))
746

747
(defun vc-follow-link ()
Gerd Moellmann's avatar
Gerd Moellmann committed
748 749 750
  "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."
751
  (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name)))
752 753 754 755
         (true-buffer (find-buffer-visiting truename))
	 (this-buffer (current-buffer)))
    (if (eq true-buffer this-buffer)
	(progn
756
	  (kill-buffer this-buffer)
757 758 759
	  ;; 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.
760
	  (set-buffer (find-file-noselect truename)))
761 762
      (set-buffer true-buffer)
      (kill-buffer this-buffer))))
763

764 765 766
(defun vc-default-find-file-hook (backend)
  nil)

Eric S. Raymond's avatar
Eric S. Raymond committed
767
(defun vc-find-file-hook ()
768
  "Function for `find-file-hook' activating VC mode if appropriate."
769 770
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
771 772
  (if vc-mode
      (setq vc-mode nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
773
  (when buffer-file-name
774 775
    (vc-file-clearprops buffer-file-name)
    (cond
776
     ((vc-backend buffer-file-name)
777
      ;; Compute the state and put it in the modeline.
778
      (vc-mode-line buffer-file-name)
779 780 781
      (unless vc-make-backup-files
	;; Use this variable, not make-backup-files,
	;; because this is for things that depend on the file name.
782 783 784
	(set (make-local-variable 'backup-inhibited) t))
      ;; Let the backend setup any buffer-local things he needs.
      (vc-call-backend (vc-backend buffer-file-name) 'find-file-hook))
785 786
     ((let ((link-type (and (file-symlink-p buffer-file-name)
			    (vc-backend (file-chase-links buffer-file-name)))))
787 788 789
	(cond ((not link-type) nil)	;Nothing to do.
	      ((eq vc-follow-symlinks nil)
	       (message
790
        "Warning: symbolic link to %s-controlled source file" link-type))
791 792 793 794 795 796 797 798 799 800 801 802 803 804
	      ((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
805
        "Symbolic link to %s-controlled source file; follow link? " link-type))
806 807 808 809
		   (progn (vc-follow-link)
			  (message "Followed link to %s" buffer-file-name)
			  (vc-find-file-hook))
		 (message
810
        "Warning: editing through the link bypasses version control")
811
		 ))))))))
Eric S. Raymond's avatar
Eric S. Raymond committed
812

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

815
;; more hooks, this time for file-not-found
Eric S. Raymond's avatar
Eric S. Raymond committed
816
(defun vc-file-not-found-hook ()
Gerd Moellmann's avatar
Gerd Moellmann committed
817 818
  "When file is not found, try to check it out from version control.
Returns t if checkout was successful, nil otherwise.
819
Used in `find-file-not-found-functions'."
820 821 822
  ;; When a file does not exist, ignore cached info about it
  ;; from a previous visit.
  (vc-file-clearprops buffer-file-name)
823
  (let ((backend (vc-backend buffer-file-name)))
824
    (if backend (vc-call-backend backend 'find-file-not-found-hook))))
825 826 827 828 829 830 831 832 833

(defun vc-default-find-file-not-found-hook (backend)
  (if (yes-or-no-p
       (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
834

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

837
(defun vc-kill-buffer-hook ()
Gerd Moellmann's avatar
Gerd Moellmann committed
838
  "Discard VC info about a file when we kill its buffer."
839 840
  (if buffer-file-name
      (vc-file-clearprops buffer-file-name)))
841

842
(add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)
843

844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869
;; 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
870
(define-key global-map "\C-xv" 'vc-prefix-map)
871

872 873 874 875 876 877
(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)))
878 879 880 881
  (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))
882
  (define-key vc-menu-map [vc-directory] '("VC Directory Listing" . vc-directory))
883
  (define-key vc-menu-map [separator1] '("----"))
884
  (define-key vc-menu-map [vc-annotate] '("Annotate" . vc-annotate))
885 886 887
  (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))
888
  (define-key vc-menu-map [vc-diff] '("Compare with Base Version" . vc-diff))
889 890 891 892 893 894
  (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))
895 896 897 898 899
  (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))
900
  (define-key vc-menu-map [vc-next-action] '("Check In/Out" . vc-next-action))
901 902
  (define-key vc-menu-map [vc-register] '("Register" . vc-register)))

903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
;; 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
919 920 921

(provide 'vc-hooks)

922
;; arch-tag: 2e5a6fa7-1d30-48e2-8bd0-e3d335f04f32
Eric S. Raymond's avatar
Eric S. Raymond committed
923
;;; vc-hooks.el ends here