vc-hooks.el 44.4 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
;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001,
Glenn Morris's avatar
Glenn Morris committed
4
;;   2002, 2003, 2004, 2005, 2006, 2007, 2008 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 10 11 12

;; 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
13
;; the Free Software Foundation; either version 3, or (at your option)
Eric S. Raymond's avatar
Eric S. Raymond committed
14 15 16 17 18 19 20 21
;; 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
22
;; along with GNU Emacs; see the file COPYING.  If not, write to the
Lute Kamstra's avatar
Lute Kamstra committed
23 24
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Eric S. Raymond's avatar
Eric S. Raymond committed
25 26 27

;;; Commentary:

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

;;; Code:

35 36
(eval-when-compile
  (require 'cl))
37

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

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

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

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

53 54 55
(defcustom vc-ignore-dir-regexp
  ;; Stop SMB, automounter, AFS, and DFS host lookups.
  "\\`\\(?:[\\/][\\/]\\|/\\(?:net\\|afs\\|\\.\\\.\\.\\)/\\)\\'"
56
  "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
(defcustom vc-handled-backends '(RCS CVS SVN SCCS Bzr Git Hg Mtn Arch MCVS)
Stefan Monnier's avatar
Stefan Monnier committed
64 65 66
  ;; RCS, CVS, SVN and SCCS come first because they are per-dir
  ;; rather than per-tree.  RCS comes first because of the multibackend
  ;; support intended to use RCS for local commits (with a remote CVS server).
67
  "List of version control backends for which VC will be used.
Gerd Moellmann's avatar
Gerd Moellmann committed
68 69 70 71 72 73
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)
74
  :version "23.1"
Karl Heuer's avatar
Karl Heuer committed
75
  :group 'vc)
76

77
;; Note: we don't actually have a darcs back end yet.
78 79
(defcustom vc-directory-exclusion-list '("SCCS" "RCS" "CVS" "MCVS"
					 ".svn" ".git" ".hg" ".bzr"
80
					 "_MTN" "_darcs" "{arch}")
81 82 83 84
  "List of directory names to be ignored when walking directory trees."
  :type '(repeat string)
  :group 'vc)

Karl Heuer's avatar
Karl Heuer committed
85
(defcustom vc-path
86 87 88
  (if (file-directory-p "/usr/sccs")
      '("/usr/sccs")
    nil)
89
  "List of extra directories to search for version control commands."
Karl Heuer's avatar
Karl Heuer committed
90 91
  :type '(repeat directory)
  :group 'vc)
92

Karl Heuer's avatar
Karl Heuer committed
93
(defcustom vc-make-backup-files nil
94
  "If non-nil, backups of registered files are made as with other files.
Karl Heuer's avatar
Karl Heuer committed
95 96
If nil (the default), files covered by version control don't get backups."
  :type 'boolean
97 98
  :group 'vc
  :group 'backup)
Eric S. Raymond's avatar
Eric S. Raymond committed
99

Karl Heuer's avatar
Karl Heuer committed
100
(defcustom vc-follow-symlinks 'ask
101
  "What to do if visiting a symbolic link to a file under version control.
Gerd Moellmann's avatar
Gerd Moellmann committed
102 103 104 105
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,
106 107
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
108
visited and a warning displayed."
Gerd Moellmann's avatar
Gerd Moellmann committed
109 110 111
  :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
112
  :group 'vc)
113

Karl Heuer's avatar
Karl Heuer committed
114
(defcustom vc-display-status t
115
  "If non-nil, display revision number and lock status in modeline.
Karl Heuer's avatar
Karl Heuer committed
116 117 118 119
Otherwise, not displayed."
  :type 'boolean
  :group 'vc)

120

Karl Heuer's avatar
Karl Heuer committed
121
(defcustom vc-consult-headers t
122
  "If non-nil, identify work files by searching for version headers."
Karl Heuer's avatar
Karl Heuer committed
123 124
  :type 'boolean
  :group 'vc)
125

Karl Heuer's avatar
Karl Heuer committed
126
(defcustom vc-keep-workfiles t
127
  "If non-nil, don't delete working files after registering changes.
128
If the back-end is CVS, workfiles are always kept, regardless of the
Karl Heuer's avatar
Karl Heuer committed
129 130 131
value of this flag."
  :type 'boolean
  :group 'vc)
132

Karl Heuer's avatar
Karl Heuer committed
133
(defcustom vc-mistrust-permissions nil
134
  "If non-nil, don't assume permissions/ownership track version-control status.
Gerd Moellmann's avatar
Gerd Moellmann committed
135
If nil, do rely on the permissions.
Karl Heuer's avatar
Karl Heuer committed
136 137 138
See also variable `vc-consult-headers'."
  :type 'boolean
  :group 'vc)
139 140

(defun vc-mistrust-permissions (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
141
  "Internal access function to variable `vc-mistrust-permissions' for FILE."
142 143
  (or (eq vc-mistrust-permissions 't)
      (and vc-mistrust-permissions
Gerd Moellmann's avatar
Gerd Moellmann committed
144
	   (funcall vc-mistrust-permissions
145 146
		    (vc-backend-subdirectory-name file)))))

147
(defcustom vc-stay-local t
148
  "Non-nil means use local operations when possible for remote repositories.
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
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"))))
164
  :version "22.1"
165 166 167 168
  :group 'vc)

(defun vc-stay-local-p (file)
  "Return non-nil if VC should stay local when handling FILE.
169 170 171
This uses the `repository-hostname' backend operation.
If FILE is a list of files, return non-nil if any of them
individually should stay local."
172
  (if (listp file)
173
      (delq nil (mapcar 'vc-stay-local-p file))
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198
    (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))))))))))))
199

200
;;; This is handled specially now.
Eric S. Raymond's avatar
Eric S. Raymond committed
201
;; Tell Emacs about this new kind of minor mode
202
;; (add-to-list 'minor-mode-alist '(vc-mode vc-mode))
Eric S. Raymond's avatar
Eric S. Raymond committed
203

Eric S. Raymond's avatar
Eric S. Raymond committed
204
(make-variable-buffer-local 'vc-mode)
205
(put 'vc-mode 'permanent-local t)
Eric S. Raymond's avatar
Eric S. Raymond committed
206

207 208 209 210 211 212 213 214
(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}")

215
(defmacro vc-error-occurred (&rest body)
216
  `(condition-case nil (progn ,@body nil) (error t)))
217

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

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

227 228
(defvar vc-touched-properties nil)

Eric S. Raymond's avatar
Eric S. Raymond committed
229
(defun vc-file-setprop (file property value)
Gerd Moellmann's avatar
Gerd Moellmann committed
230
  "Set per-file VC PROPERTY for FILE to VALUE."
231 232 233 234
  (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
235 236 237
  (put (intern file vc-file-prop-obarray) property value))

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

241
(defun vc-file-clearprops (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
242
  "Clear all VC properties of FILE."
243
  (setplist (intern file vc-file-prop-obarray) nil))
244

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

(defmacro vc-call (fun file &rest args)
Jason Rumney's avatar
Jason Rumney committed
289 290 291 292
  "A convenience macro for calling VC backend functions.
Functions called by this macro must accept FILE as the first argument.
ARGS specifies any additional arguments. FUN should be unquoted.
BEWARE!! `file' is evaluated twice!!"
Gerd Moellmann's avatar
Gerd Moellmann committed
293 294 295 296 297 298 299
  `(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)))
300

301
(defun vc-insert-file (file &optional limit blocksize)
Gerd Moellmann's avatar
Gerd Moellmann committed
302 303 304 305
  "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
306
occurrence of LIMIT is found.  Anything from the start of that occurrence
307 308
to the end of the buffer is then deleted.  The function returns
non-nil if FILE exists and its contents were successfully inserted."
309
  (erase-buffer)
310 311 312 313
  (when (file-exists-p file)
    (if (not limit)
        (insert-file-contents file)
      (if (not blocksize) (setq blocksize 8192))
314 315 316 317 318
      (let ((filepos 0))
        (while
	    (and (< 0 (cadr (insert-file-contents
			     file nil filepos (incf filepos blocksize))))
		 (progn (beginning-of-line)
319 320 321 322
                        (let ((pos (re-search-forward limit nil 'move)))
                          (if pos (delete-region (match-beginning 0)
                                                 (point-max)))
                          (not pos)))))))
323 324
    (set-buffer-modified-p nil)
    t))
325

326
(defun vc-find-root (file witness &optional invert)
327 328
  "Find the root of a checked out project.
The function walks up the directory tree from FILE looking for WITNESS.
329 330 331
If WITNESS if not found, return nil, otherwise return the root.
Optional arg INVERT non-nil reverses the sense of the check;
the root is the last directory for which WITNESS *is* found."
332 333 334
  ;; 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))
335
  (let ((root nil)
336
        (prev-file file)
337 338 339
        ;; `user' is not initialized outside the loop because
        ;; `file' may not exist, so we may have to walk up part of the
        ;; hierarchy before we find the "initial UID".
Miles Bader's avatar
Miles Bader committed
340
        (user nil)
341
        try)
342
    (while (not (or root
343 344 345 346 347 348
                    (null file)
                    ;; As a heuristic, we stop looking up the hierarchy of
                    ;; directories as soon as we find a directory belonging
                    ;; to another user.  This should save us from looking in
                    ;; things like /net and /afs.  This assumes that all the
                    ;; files inside a project belong to the same user.
349 350 351
                    (let ((prev-user user))
                      (setq user (nth 2 (file-attributes file)))
                      (and prev-user (not (equal user prev-user))))
352
                    (string-match vc-ignore-dir-regexp file)))
353 354 355 356 357 358 359 360 361 362 363
      (setq try (file-exists-p (expand-file-name witness file)))
      (cond ((and invert (not try)) (setq root prev-file))
            ((and (not invert) try) (setq root file))
            ((equal file (setq prev-file file
                               file (file-name-directory
                                     (directory-file-name file))))
             (setq file nil))))
    ;; Handle the case where ~/WITNESS exists and the original FILE is "~".
    ;; (This occurs, for example, when placing dotfiles under RCS.)
    (when (and (not root) invert prev-file)
      (setq root prev-file))
364 365
    root))

366 367 368 369 370 371
;; 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.)
372

373
;; properties indicating the backend being used for FILE
374

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

378 379 380 381
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
382
  (let (handler)
383
    (cond
384 385
     ((and (file-name-directory file) (string-match vc-ignore-dir-regexp (file-name-directory file)))
      nil)
386 387 388 389 390
     ((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
391 392 393
      ;; There is no file name handler.
      ;; Try vc-BACKEND-registered for each handled BACKEND.
      (catch 'found
394
	(let ((backend (vc-file-getprop file 'vc-backend)))
395
	  (mapc
396 397 398 399
	   (lambda (b)
	     (and (vc-call-backend b 'registered file)
		  (vc-file-setprop file 'vc-backend b)
		  (throw 'found t)))
400
	   (if (or (not backend) (eq backend 'none))
401 402
	       vc-handled-backends
	     (cons backend vc-handled-backends))))
Gerd Moellmann's avatar
Gerd Moellmann committed
403 404
        ;; File is not registered.
        (vc-file-setprop file 'vc-backend 'none)
405
        nil)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
406

407 408 409
(defun vc-backend (file-or-list)
  "Return the version control type of FILE-OR-LIST, nil if it's not registered.
If the argument is a list, the files must all have the same back end."
Gerd Moellmann's avatar
Gerd Moellmann committed
410
  ;; `file' can be nil in several places (typically due to the use of
411
  ;; code like (vc-backend buffer-file-name)).
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426
  (cond ((stringp file-or-list)
	 (let ((property (vc-file-getprop file-or-list '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-or-list)
			(vc-file-getprop file-or-list 'vc-backend)
		      nil)))))
	((and file-or-list (listp file-or-list))
	 (vc-backend (car file-or-list)))
	(t
	 nil)))

Gerd Moellmann's avatar
Gerd Moellmann committed
427 428 429 430

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

432
(defun vc-name (file)
Dave Love's avatar
Dave Love committed
433 434 435
  "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
436
  ;; in vc-hooks.
437
  (or (vc-file-getprop file 'vc-name)
438 439 440 441
      ;; force computation of the property by calling
      ;; vc-BACKEND-registered explicitly
      (if (and (vc-backend file)
	       (vc-call-backend (vc-backend file) 'registered file))
442
	  (vc-file-getprop file 'vc-name))))
443

444
(defun vc-checkout-model (file)
Gerd Moellmann's avatar
Gerd Moellmann committed
445 446
  "Indicate how FILE is checked out.

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

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

453
  'locking    FILE is read-only if up-to-date; user must type
454
              \\[vc-next-action] before editing.  Strict locking
Gerd Moellmann's avatar
Gerd Moellmann committed
455 456
              is assumed.

457
  'announce   FILE is read-only if up-to-date; user must type
458
              \\[vc-next-action] before editing.  But other users
Gerd Moellmann's avatar
Gerd Moellmann committed
459 460
              may be editing at the same time."
  (or (vc-file-getprop file 'vc-checkout-model)
461 462 463
      (if (vc-backend file)
          (vc-file-setprop file 'vc-checkout-model
                           (vc-call checkout-model file)))))
464

465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
(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
481 482 483 484

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

485 486
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
487 488 489 490 491 492 493 494 495 496

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

Gerd Moellmann's avatar
Gerd Moellmann committed
498 499 500 501 502 503 504 505 506
  '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.

Eric S. Raymond's avatar
Eric S. Raymond committed
507
  'unlocked-changes  The working version of the file is not locked,
Gerd Moellmann's avatar
Gerd Moellmann committed
508 509 510 511
                     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
Eric S. Raymond's avatar
Eric S. Raymond committed
512 513 514
                     prompt the user to do it).

  'added             Scheduled to go into the repository on the next commit.
Eric S. Raymond's avatar
Eric S. Raymond committed
515
                     Often represented by vc-working-revision = \"0\" in VCSes
516 517
                     with monotonic IDs like Subversion and Mercurial.

518
  'removed           Scheduled to be deleted from the repository on next commit.
519

520 521 522
  'missing           The file is not present in the file system, but the VC 
                     system still tracks it.

523
  'ignored           The file showed up in a dir-state listing with a flag
524
                     indicating the version-control system is ignoring it,
525 526
                     Note: This property is not set reliably (some VCSes
                     don't have useful directory-status commands) so assume
527
                     that any file with vc-state nil might be ignorable
528
                     without VC knowing it.
529

530
  'unregistered      The file showed up in a dir-state listing with a flag
531
                     indicating that it is not under version control.
532 533
                     Note: This property is not set reliably (some VCSes
                     don't have useful directory-status commands) so assume
534
                     that any file with vc-state nil might be unregistered
535
                     without VC knowing it.
536

537
A return of nil from this function means we have no information on the
538 539 540 541
status of this file.
"
  ;; Note: in Emacs 22 and older, return of nil meant the file was unregistered.
  ;; This is potentially a source of backward-compatibility bugs.
Eric S. Raymond's avatar
Eric S. Raymond committed
542

543 544 545 546
  ;; FIXME: New (sub)states needed (?):
  ;; - `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
547
  (or (vc-file-getprop file 'vc-state)
548
      (if (and (> (length file) 0) (vc-backend file))
549 550
          (vc-file-setprop file 'vc-state
                           (vc-call state-heuristic file)))))
Gerd Moellmann's avatar
Gerd Moellmann committed
551

552 553 554 555 556 557
(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
558 559 560 561 562
(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
563 564 565
  "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
566
   (vc-call-backend backend 'state file))
567

568 569 570 571
(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))))
572 573 574
    (if (and checkout-time
             ;; Tramp and Ange-FTP return this when they don't know the time.
             (not (equal lastmod '(0 0))))
575 576 577 578 579 580 581 582
        (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."
583
  (zerop (condition-case err
584 585
             ;; If the implementation supports it, let the output
             ;; go to *vc*, not *vc-diff*, since this is an internal call.
586
             (vc-call diff (list file) nil nil "*vc*")
587 588 589 590 591 592 593 594
           (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))))
595 596
                    (not (eq (caddr err) 4)))
                (signal (car err) (cdr err))
597
              (vc-call diff (list file)))))))
598

Eric S. Raymond's avatar
Eric S. Raymond committed
599
(defun vc-working-revision (file)
600
  "Return the repository version from which FILE was checked out.
601
If FILE is not registered, this function always returns nil."
Eric S. Raymond's avatar
Eric S. Raymond committed
602
  (or (vc-file-getprop file 'vc-working-revision)
603
      (if (vc-backend file)
Eric S. Raymond's avatar
Eric S. Raymond committed
604 605
          (vc-file-setprop file 'vc-working-revision
                           (vc-call working-revision file)))))
606 607 608
;; Backward compatibility.
(define-obsolete-function-alias
  'vc-workfile-version 'vc-working-revision "23.1")
609 610
(define-obsolete-function-alias
  'vc-previous-version 'vc-previous-revision "23.1")
611 612 613 614
(defun vc-default-working-revision (backend file)
  (message
   "`working-revision' not found: using the old `workfile-version' instead")
  (vc-call-backend backend 'workfile-version file))
615

Gerd Moellmann's avatar
Gerd Moellmann committed
616 617 618 619 620 621 622 623 624 625 626
(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)))
627 628
                              (with-no-warnings
                               vc-master-templates)))
Gerd Moellmann's avatar
Gerd Moellmann committed
629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
		       (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)
648
  "Return non-nil if there is a master corresponding to FILE.
Gerd Moellmann's avatar
Gerd Moellmann committed
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663

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
664
      (mapcar
Gerd Moellmann's avatar
Gerd Moellmann committed
665 666 667 668 669 670 671 672 673 674 675 676 677 678 679
       (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))))
680

681
(defun vc-toggle-read-only (&optional verbose)
682
  "Change read-only status of current buffer, perhaps via version control.
683

684 685
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
686 687 688
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;
689 690 691 692
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."
693
  (interactive "P")
694
  (if (or (and (boundp 'vc-dired-mode) vc-dired-mode)
Gerd Moellmann's avatar
Gerd Moellmann committed
695
	  ;; use boundp because vc.el might not be loaded
696
	  (vc-backend buffer-file-name))
697
      (vc-next-action verbose)
Eric S. Raymond's avatar
Eric S. Raymond committed
698 699
    (toggle-read-only)))

700
(defun vc-default-make-version-backups-p (backend file)
701
  "Return non-nil if unmodified versions should be backed up locally.
702
The default is to switch off this feature."
703 704
  nil)

705 706 707 708 709
(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."
710 711
  (if regexp
      (concat (regexp-quote (file-name-nondirectory file))
712
              "\\.~.+" (unless manual "\\.") "~")
713
    (expand-file-name (concat (file-name-nondirectory file)
714
                              ".~" (subst-char-in-string
Eric S. Raymond's avatar
Eric S. Raymond committed
715
                                    ?/ ?_ (or rev (vc-working-revision file)))
716 717
                              (unless manual ".") "~")
                      (file-name-directory file))))
718 719 720

(defun vc-delete-automatic-version-backups (file)
  "Delete all existing automatic version backups for FILE."
721
  (condition-case nil
722
      (mapc
723
       'delete-file
724
       (directory-files (or (file-name-directory file) default-directory) t
725 726 727
			(vc-version-backup-file-name file nil nil t)))
    ;; Don't fail when the directory doesn't exist.
    (file-error nil)))
728 729 730 731

(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."
732
  (unless (and (fboundp 'msdos-long-file-names)
733
               (not (with-no-warnings (msdos-long-file-names))))
734
    (vc-delete-automatic-version-backups file)
735 736 737 738 739
    (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.
740
      (file-error
741 742 743
       (message
        (concat "Warning: Cannot make version backup; "
                "diff/revert therefore not local"))))))
744 745 746 747 748 749

(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.
750
  (let ((file buffer-file-name))
751 752 753 754 755 756
    (ignore-errors               ;Be careful not to prevent saving the file.
      (and (vc-backend file)
           (vc-up-to-date-p file)
           (eq (vc-checkout-model file) 'implicit)
           (vc-call make-version-backups-p file)
           (vc-make-version-backup file)))))
757

758 759
(declare-function vc-dired-resynch-file "vc" (file))

760
(defun vc-after-save ()
Gerd Moellmann's avatar
Gerd Moellmann committed
761
  "Function to be called by `basic-save-buffer' (in files.el)."
Dave Love's avatar
Dave Love committed
762
  ;; If the file in the current buffer is under version control,
Gerd Moellmann's avatar
Gerd Moellmann committed
763 764
  ;; up-to-date, and locking is not used for the file, set
  ;; the state to 'edited and redisplay the mode line.
765
  (let ((file buffer-file-name))
766
    (and (vc-backend file)
767 768 769 770 771 772 773
	 (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
774 775 776 777
         (vc-up-to-date-p file)
         (eq (vc-checkout-model file) 'implicit)
         (vc-file-setprop file 'vc-state 'edited)
	 (vc-mode-line file)
778 779 780 781
	 (if (featurep 'vc)
	     ;; If VC is not loaded, then there can't be
	     ;; any VC Dired buffer to synchronize.
	     (vc-dired-resynch-file file)))))
782

Stefan Monnier's avatar
Stefan Monnier committed
783 784 785 786 787 788 789 790 791 792
(defvar vc-menu-entry
  '(menu-item "Version Control" vc-menu-map
    :filter vc-menu-map-filter))

(when (boundp 'menu-bar-tools-menu)
  ;; We do not need to worry here about the placement of this entry
  ;; because menu-bar.el has already created the proper spot for us
  ;; and this will simply use it.
  (define-key menu-bar-tools-menu [vc] vc-menu-entry))

793 794
(defconst vc-mode-line-map
  (let ((map (make-sparse-keymap)))
Stefan Monnier's avatar
Stefan Monnier committed
795
    (define-key map [mode-line down-mouse-1] vc-menu-entry)
796 797
    map))

Gerd Moellmann's avatar
Gerd Moellmann committed
798
(defun vc-mode-line (file)
Eric S. Raymond's avatar
Eric S. Raymond committed
799
  "Set `vc-mode' to display type of version control for FILE.
Eric S. Raymond's avatar
Eric S. Raymond committed
800
The value is set in the current buffer, which should be the buffer
Gerd Moellmann's avatar
Gerd Moellmann committed
801
visiting FILE."
802
  (interactive (list buffer-file-name))
803
  (let ((backend (vc-backend file)))
804 805
    (if (not backend)
	(setq vc-mode nil)
806 807 808 809 810 811 812 813 814 815
      (let* ((ml-string (vc-call mode-line-string file))
             (ml-echo (get-text-property 0 'help-echo ml-string)))
        (setq vc-mode
              (concat
               " "
               (if (null vc-display-status)
                   (symbol-name backend)
                 (propertize
                  ml-string
                  'mouse-face 'mode-line-highlight
816
                  'help-echo
817 818 819 820 821
                  (concat (or ml-echo
                              (format "File under the %s version control system"
                                      backend))
                          "\nmouse-1: Version Control menu")
                  'local-map vc-mode-line-map)))))
822 823 824 825 826 827 828 829 830
      ;; 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).
831 832 833
    ;; This way, even root cannot modify a file that isn't locked.
    (and (equal file buffer-file-name)
	 (not buffer-read-only)
834 835 836 837 838
	   (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
839 840 841 842 843 844 845 846 847 848 849 850

(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))
851
	(state-echo nil)
Eric S. Raymond's avatar
Eric S. Raymond committed
852
	(rev     (vc-working-revision file)))
853 854 855 856 857 858 859 860
    (propertize
     (cond ((or (eq state 'up-to-date)
		(eq state 'needs-patch))
	    (setq state-echo "Up to date file")
	    (concat backend "-" rev))
	   ((stringp state)
	    (setq state-echo (concat "File locked by" state))
	    (concat backend ":" state ":" rev))
861 862 863
           ((eq state 'added)
            (setq state-echo "Locally added file")
            (concat backend "@" rev))
864 865 866 867 868
           ((eq state 'removed)
            (setq state-echo "File removed from the VC system")
            (concat backend "!" rev))
           ((eq state 'missing)
            (setq state-echo "File tracked by the VC system, but missing from the file system")
869
            (concat backend "?" rev))
870 871 872 873
	   (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.
874
	    (setq state-echo "Locally modified file")
875
	    (concat backend ":" rev)))
876
     'help-echo (concat state-echo " under the " backend
877
			" version control system"))))
878

879
(defun vc-follow-link ()
Gerd Moellmann's avatar
Gerd Moellmann committed
880 881 882
  "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."
883
  (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name)))
884 885 886 887
         (true-buffer (find-buffer-visiting truename))
	 (this-buffer (current-buffer)))
    (if (eq true-buffer this-buffer)
	(progn
888
	  (kill-buffer this-buffer)
889 890 891
	  ;; 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.
892
	  (set-buffer (find-file-noselect truename)))
893 894
      (set-buffer true-buffer)
      (kill-buffer this-buffer))))
895

896 897 898
(defun vc-default-find-file-hook (backend)
  nil)

Eric S. Raymond's avatar
Eric S. Raymond committed
899
(defun vc-find-file-hook ()
900
  "Function for `find-file-hook' activating VC mode if appropriate."
901 902
  ;; Recompute whether file is version controlled,
  ;; if user has killed the buffer and revisited.
903 904
  (if vc-mode
      (setq vc-mode nil))
Gerd Moellmann's avatar
Gerd Moellmann committed
905
  (when buffer-file-name
906 907
    (vc-file-clearprops buffer-file-name)
    (cond
908
     ((with-demoted-errors (vc-backend buffer-file-name))
909
      ;; Compute the state and put it in the modeline.
910
      (vc-mode-line buffer-file-name)
911 912 913
      (unless vc-make-backup-files
	;; Use this variable, not make-backup-files,
	;; because this is for things that depend on the file name.
914 915 916
	(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))
917 918
     ((let ((link-type (and (file-symlink-p buffer-file-name)
			    (vc-backend (file-chase-links buffer-file-name)))))
919 920 921
	(cond ((not link-type) nil)	;Nothing to do.
	      ((eq vc-follow-symlinks nil)
	       (message
922
        "Warning: symbolic link to %s-controlled source file" link-type))
923 924 925 926 927 928 929 930 931 932