1 ;;; vc-hooks.el --- resident support for version-control
3 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001,
4 ;; 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
6 ;; Author: FSF (see vc.el for full credits)
7 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; 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)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to the
23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24 ;; Boston, MA 02110-1301, USA.
28 ;; This is the always-loaded portion of VC. It takes care of
29 ;; VC-related activities that are done when you visit a file, so that
30 ;; vc.el itself is loaded only when you use a VC command. See the
31 ;; commentary of vc.el.
38 ;; 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."
45 (defvar vc-master-templates
())
46 (make-obsolete-variable 'vc-master-templates
47 "to define master templates for a given BACKEND, use
48 vc-BACKEND-master-templates. To enable or disable VC for a given
49 BACKEND, use `vc-handled-backends'."
52 (defvar vc-header-alist
())
53 (make-obsolete-variable 'vc-header-alist
'vc-BACKEND-header
"21.1")
55 (defcustom vc-ignore-dir-regexp
56 ;; Stop SMB, automounter, AFS, and DFS host lookups.
57 "\\`\\(?:[\\/][\\/]\\|/\\(?:net\\|afs\\|\\.\\\.\\.\\)/\\)\\'"
58 "Regexp matching directory names that are not under VC's control.
59 The default regexp prevents fruitless and time-consuming attempts
60 to determine the VC status in directories in which filenames are
61 interpreted as hostnames."
65 (defcustom vc-handled-backends
'(RCS CVS SVN SCCS Bzr Git Hg Mtn Arch MCVS
)
66 ;; RCS, CVS, SVN and SCCS come first because they are per-dir
67 ;; rather than per-tree. RCS comes first because of the multibackend
68 ;; support intended to use RCS for local commits (with a remote CVS server).
69 "List of version control backends for which VC will be used.
70 Entries in this list will be tried in order to determine whether a
71 file is under that sort of version control.
72 Removing an entry from the list prevents VC from being activated
73 when visiting a file managed by that backend.
74 An empty list disables VC altogether."
75 :type
'(repeat symbol
)
79 ;; Note: we don't actually have a darcs back end yet.
80 (defcustom vc-directory-exclusion-list
'("SCCS" "RCS" "CVS" "MCVS"
81 ".svn" ".git" ".hg" ".bzr"
82 "_MTN" "_darcs" "{arch}")
83 "List of directory names to be ignored when walking directory trees."
84 :type
'(repeat string
)
87 (defcustom vc-path nil
88 "List of extra directories to search for version control commands."
89 :type
'(repeat directory
)
92 (defcustom vc-make-backup-files nil
93 "If non-nil, backups of registered files are made as with other files.
94 If nil (the default), files covered by version control don't get backups."
99 (defcustom vc-follow-symlinks
'ask
100 "What to do if visiting a symbolic link to a file under version control.
101 Editing such a file through the link bypasses the version control system,
102 which is dangerous and probably not what you want.
104 If this variable is t, VC follows the link and visits the real file,
105 telling you about it in the echo area. If it is `ask', VC asks for
106 confirmation whether it should follow the link. If nil, the link is
107 visited and a warning displayed."
108 :type
'(choice (const :tag
"Ask for confirmation" ask
)
109 (const :tag
"Visit link and warn" nil
)
110 (const :tag
"Follow link" t
))
113 (defcustom vc-display-status t
114 "If non-nil, display revision number and lock status in modeline.
115 Otherwise, not displayed."
120 (defcustom vc-consult-headers t
121 "If non-nil, identify work files by searching for version headers."
125 (defcustom vc-keep-workfiles t
126 "If non-nil, don't delete working files after registering changes.
127 If the back-end is CVS, workfiles are always kept, regardless of the
132 (defcustom vc-mistrust-permissions nil
133 "If non-nil, don't assume permissions/ownership track version-control status.
134 If nil, do rely on the permissions.
135 See also variable `vc-consult-headers'."
139 (defun vc-mistrust-permissions (file)
140 "Internal access function to variable `vc-mistrust-permissions' for FILE."
141 (or (eq vc-mistrust-permissions
't
)
142 (and vc-mistrust-permissions
143 (funcall vc-mistrust-permissions
144 (vc-backend-subdirectory-name file
)))))
146 (defcustom vc-stay-local t
147 "Non-nil means use local operations when possible for remote repositories.
148 This avoids slow queries over the network and instead uses heuristics
149 and past information to determine the current status of a file.
151 The value can also be a regular expression or list of regular
152 expressions to match against the host name of a repository; then VC
153 only stays local for hosts that match it. Alternatively, the value
154 can be a list of regular expressions where the first element is the
155 symbol `except'; then VC always stays local except for hosts matched
156 by these regular expressions."
157 :type
'(choice (const :tag
"Always stay local" t
)
158 (const :tag
"Don't stay local" nil
)
159 (list :format
"\nExamine hostname and %v" :tag
"Examine hostname ..."
160 (set :format
"%v" :inline t
(const :format
"%t" :tag
"don't" except
))
161 (regexp :format
" stay local,\n%t: %v" :tag
"if it matches")
162 (repeat :format
"%v%i\n" :inline t
(regexp :tag
"or"))))
166 (defun vc-stay-local-p (file)
167 "Return non-nil if VC should stay local when handling FILE.
168 This uses the `repository-hostname' backend operation.
169 If FILE is a list of files, return non-nil if any of them
170 individually should stay local."
172 (delq nil
(mapcar 'vc-stay-local-p file
))
173 (let* ((backend (vc-backend file
))
174 (sym (vc-make-backend-sym backend
'stay-local
))
175 (stay-local (if (boundp sym
) (symbol-value sym
) t
)))
176 (if (eq stay-local t
) (setq stay-local vc-stay-local
))
177 (if (symbolp stay-local
) stay-local
178 (let ((dirname (if (file-directory-p file
)
179 (directory-file-name file
)
180 (file-name-directory file
))))
182 (or (vc-file-getprop dirname
'vc-stay-local-p
)
184 dirname
'vc-stay-local-p
185 (let ((hostname (vc-call-backend
186 backend
'repository-hostname dirname
)))
190 (if (eq (car-safe stay-local
) 'except
)
191 (setq default nil stay-local
(cdr stay-local
)))
192 (when (consp stay-local
)
194 (mapconcat 'identity stay-local
"\\|")))
195 (if (if (string-match stay-local hostname
)
196 default
(not default
))
199 ;;; This is handled specially now.
200 ;; Tell Emacs about this new kind of minor mode
201 ;; (add-to-list 'minor-mode-alist '(vc-mode vc-mode))
203 (make-variable-buffer-local 'vc-mode
)
204 (put 'vc-mode
'permanent-local t
)
206 (defun vc-mode (&optional arg
)
207 ;; Dummy function for C-h m
208 "Version Control minor mode.
209 This minor mode is automatically activated whenever you visit a file under
210 control of one of the revision control systems in `vc-handled-backends'.
211 VC commands are globally reachable under the prefix `\\[vc-prefix-map]':
214 (defmacro vc-error-occurred
(&rest body
)
215 `(condition-case nil
(progn ,@body nil
) (error t
)))
217 ;; We need a notion of per-file properties because the version
218 ;; control state of a file is expensive to derive --- we compute
219 ;; them when the file is initially found, keep them up to date
220 ;; during any subsequent VC operations, and forget them when
221 ;; the buffer is killed.
223 (defvar vc-file-prop-obarray
(make-vector 17 0)
224 "Obarray for per-file properties.")
226 (defvar vc-touched-properties nil
)
228 (defun vc-file-setprop (file property value
)
229 "Set per-file VC PROPERTY for FILE to VALUE."
230 (if (and vc-touched-properties
231 (not (memq property vc-touched-properties
)))
232 (setq vc-touched-properties
(append (list property
)
233 vc-touched-properties
)))
234 (put (intern file vc-file-prop-obarray
) property value
))
236 (defun vc-file-getprop (file property
)
237 "Get per-file VC PROPERTY for FILE."
238 (get (intern file vc-file-prop-obarray
) property
))
240 (defun vc-file-clearprops (file)
241 "Clear all VC properties of FILE."
242 (setplist (intern file vc-file-prop-obarray
) nil
))
245 ;; We keep properties on each symbol naming a backend as follows:
246 ;; * `vc-functions': an alist mapping vc-FUNCTION to vc-BACKEND-FUNCTION.
248 (defun vc-make-backend-sym (backend sym
)
249 "Return BACKEND-specific version of VC symbol SYM."
250 (intern (concat "vc-" (downcase (symbol-name backend
))
251 "-" (symbol-name sym
))))
253 (defun vc-find-backend-function (backend fun
)
254 "Return BACKEND-specific implementation of FUN.
255 If there is no such implementation, return the default implementation;
256 if that doesn't exist either, return nil."
257 (let ((f (vc-make-backend-sym backend fun
)))
259 ;; Load vc-BACKEND.el if needed.
260 (require (intern (concat "vc-" (downcase (symbol-name backend
)))))
262 (let ((def (vc-make-backend-sym 'default fun
)))
263 (if (fboundp def
) (cons def backend
) nil
))))))
265 (defun vc-call-backend (backend function-name
&rest args
)
266 "Call for BACKEND the implementation of FUNCTION-NAME with the given ARGS.
269 (apply 'vc-BACKEND-FUN ARGS)
271 if vc-BACKEND-FUN exists (after trying to find it in vc-BACKEND.el)
274 (apply 'vc-default-FUN BACKEND ARGS)
276 It is usually called via the `vc-call' macro."
277 (let ((f (assoc function-name
(get backend
'vc-functions
))))
278 (if f
(setq f
(cdr f
))
279 (setq f
(vc-find-backend-function backend function-name
))
280 (push (cons function-name f
) (get backend
'vc-functions
)))
283 (error "Sorry, %s is not implemented for %s" function-name backend
))
284 ((consp f
) (apply (car f
) (cdr f
) args
))
285 (t (apply f args
)))))
287 (defmacro vc-call
(fun file
&rest args
)
288 "A convenience macro for calling VC backend functions.
289 Functions called by this macro must accept FILE as the first argument.
290 ARGS specifies any additional arguments. FUN should be unquoted.
291 BEWARE!! `file' is evaluated twice!!"
292 `(vc-call-backend (vc-backend ,file
) ',fun
,file
,@args
))
294 (defsubst vc-parse-buffer
(pattern i
)
295 "Find PATTERN in the current buffer and return its Ith submatch."
296 (goto-char (point-min))
297 (if (re-search-forward pattern nil t
)
300 (defun vc-insert-file (file &optional limit blocksize
)
301 "Insert the contents of FILE into the current buffer.
303 Optional argument LIMIT is a regexp. If present, the file is inserted
304 in chunks of size BLOCKSIZE (default 8 kByte), until the first
305 occurrence of LIMIT is found. Anything from the start of that occurrence
306 to the end of the buffer is then deleted. The function returns
307 non-nil if FILE exists and its contents were successfully inserted."
309 (when (file-exists-p file
)
311 (insert-file-contents file
)
312 (if (not blocksize
) (setq blocksize
8192))
315 (and (< 0 (cadr (insert-file-contents
316 file nil filepos
(incf filepos blocksize
))))
317 (progn (beginning-of-line)
318 (let ((pos (re-search-forward limit nil
'move
)))
319 (if pos
(delete-region (match-beginning 0)
322 (set-buffer-modified-p nil
)
325 (defun vc-find-root (file witness
&optional invert
)
326 "Find the root of a checked out project.
327 The function walks up the directory tree from FILE looking for WITNESS.
328 If WITNESS if not found, return nil, otherwise return the root.
329 Optional arg INVERT non-nil reverses the sense of the check;
330 the root is the last directory for which WITNESS *is* found."
331 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
332 ;; witnesses in /home or in /.
333 (setq file
(abbreviate-file-name file
))
336 ;; `user' is not initialized outside the loop because
337 ;; `file' may not exist, so we may have to walk up part of the
338 ;; hierarchy before we find the "initial UID".
343 ;; As a heuristic, we stop looking up the hierarchy of
344 ;; directories as soon as we find a directory belonging
345 ;; to another user. This should save us from looking in
346 ;; things like /net and /afs. This assumes that all the
347 ;; files inside a project belong to the same user.
348 (let ((prev-user user
))
349 (setq user
(nth 2 (file-attributes file
)))
350 (and prev-user
(not (equal user prev-user
))))
351 (string-match vc-ignore-dir-regexp file
)))
352 (setq try
(file-exists-p (expand-file-name witness file
)))
353 (cond ((and invert
(not try
)) (setq root prev-file
))
354 ((and (not invert
) try
) (setq root file
))
355 ((equal file
(setq prev-file file
356 file
(file-name-directory
357 (directory-file-name file
))))
359 ;; Handle the case where ~/WITNESS exists and the original FILE is "~".
360 ;; (This occurs, for example, when placing dotfiles under RCS.)
361 (when (and (not root
) invert prev-file
)
362 (setq root prev-file
))
365 ;; Access functions to file properties
366 ;; (Properties should be _set_ using vc-file-setprop, but
367 ;; _retrieved_ only through these functions, which decide
368 ;; if the property is already known or not. A property should
369 ;; only be retrieved by vc-file-getprop if there is no
372 ;; properties indicating the backend being used for FILE
374 (defun vc-registered (file)
375 "Return non-nil if FILE is registered in a version control system.
377 This function performs the check each time it is called. To rely
378 on the result of a previous call, use `vc-backend' instead. If the
379 file was previously registered under a certain backend, then that
380 backend is tried first."
383 ((and (file-name-directory file
) (string-match vc-ignore-dir-regexp
(file-name-directory file
)))
385 ((and (boundp 'file-name-handler-alist
)
386 (setq handler
(find-file-name-handler file
'vc-registered
)))
387 ;; handler should set vc-backend and return t if registered
388 (funcall handler
'vc-registered file
))
390 ;; There is no file name handler.
391 ;; Try vc-BACKEND-registered for each handled BACKEND.
393 (let ((backend (vc-file-getprop file
'vc-backend
)))
396 (and (vc-call-backend b
'registered file
)
397 (vc-file-setprop file
'vc-backend b
)
399 (if (or (not backend
) (eq backend
'none
))
401 (cons backend vc-handled-backends
))))
402 ;; File is not registered.
403 (vc-file-setprop file
'vc-backend
'none
)
406 (defun vc-backend (file-or-list)
407 "Return the version control type of FILE-OR-LIST, nil if it's not registered.
408 If the argument is a list, the files must all have the same back end."
409 ;; `file' can be nil in several places (typically due to the use of
410 ;; code like (vc-backend buffer-file-name)).
411 (cond ((stringp file-or-list
)
412 (let ((property (vc-file-getprop file-or-list
'vc-backend
)))
413 ;; Note that internally, Emacs remembers unregistered
414 ;; files by setting the property to `none'.
415 (cond ((eq property
'none
) nil
)
417 ;; vc-registered sets the vc-backend property
418 (t (if (vc-registered file-or-list
)
419 (vc-file-getprop file-or-list
'vc-backend
)
421 ((and file-or-list
(listp file-or-list
))
422 (vc-backend (car file-or-list
)))
427 (defun vc-backend-subdirectory-name (file)
428 "Return where the master and lock FILEs for the current directory are kept."
429 (symbol-name (vc-backend file
)))
431 (defun vc-name (file)
432 "Return the master name of FILE.
433 If the file is not registered, or the master name is not known, return nil."
434 ;; TODO: This should ultimately become obsolete, at least up here
436 (or (vc-file-getprop file
'vc-name
)
437 ;; force computation of the property by calling
438 ;; vc-BACKEND-registered explicitly
439 (if (and (vc-backend file
)
440 (vc-call-backend (vc-backend file
) 'registered file
))
441 (vc-file-getprop file
'vc-name
))))
443 (defun vc-checkout-model (file)
444 "Indicate how FILE is checked out.
446 If FILE is not registered, this function always returns nil.
447 For registered files, the possible values are:
449 'implicit FILE is always writeable, and checked out `implicitly'
450 when the user saves the first changes to the file.
452 'locking FILE is read-only if up-to-date; user must type
453 \\[vc-next-action] before editing. Strict locking
456 'announce FILE is read-only if up-to-date; user must type
457 \\[vc-next-action] before editing. But other users
458 may be editing at the same time."
459 (or (vc-file-getprop file
'vc-checkout-model
)
460 (if (vc-backend file
)
461 (vc-file-setprop file
'vc-checkout-model
462 (vc-call checkout-model file
)))))
464 (defun vc-user-login-name (file)
465 "Return the name under which the user accesses the given FILE."
466 (or (and (eq (string-match tramp-file-name-regexp file
) 0)
467 ;; tramp case: execute "whoami" via tramp
468 (let ((default-directory (file-name-directory file
)))
470 (if (not (zerop (process-file "whoami" nil t
)))
471 ;; fall through if "whoami" didn't work
473 ;; remove trailing newline
474 (delete-region (1- (point-max)) (point-max))
478 ;; if user-login-name is nil, return the UID as a string
479 (number-to-string (user-uid))))
481 (defun vc-state (file)
482 "Return the version control state of FILE.
484 If FILE is not registered, this function always returns nil.
485 For registered files, the value returned is one of:
487 'up-to-date The working file is unmodified with respect to the
488 latest version on the current branch, and not locked.
490 'edited The working file has been edited by the user. If
491 locking is used for the file, this state means that
492 the current version is locked by the calling user.
494 USER The current version of the working file is locked by
495 some other USER (a string).
497 'needs-patch The file has not been edited by the user, but there is
498 a more recent version on the current branch stored
501 'needs-merge The file has been edited by the user, and there is also
502 a more recent version on the current branch stored in
503 the master file. This state can only occur if locking
504 is not used for the file.
506 'unlocked-changes The working version of the file is not locked,
507 but the working file has been changed with respect
508 to that version. This state can only occur for files
509 with locking; it represents an erroneous condition that
510 should be resolved by the user (vc-next-action will
511 prompt the user to do it).
513 'added Scheduled to go into the repository on the next commit.
514 Often represented by vc-working-revision = \"0\" in VCSes
515 with monotonic IDs like Subversion and Mercurial.
517 'removed Scheduled to be deleted from the repository on next commit.
519 'conflict The file contains conflicts as the result of a merge.
520 For now the conflicts are text conflicts. In the
521 future this might be extended to deal with metadata
524 'missing The file is not present in the file system, but the VC
525 system still tracks it.
527 'ignored The file showed up in a dir-state listing with a flag
528 indicating the version-control system is ignoring it,
529 Note: This property is not set reliably (some VCSes
530 don't have useful directory-status commands) so assume
531 that any file with vc-state nil might be ignorable
532 without VC knowing it.
534 'unregistered The file showed up in a dir-state listing with a flag
535 indicating that it is not under version control.
536 Note: This property is not set reliably (some VCSes
537 don't have useful directory-status commands) so assume
538 that any file with vc-state nil might be unregistered
539 without VC knowing it.
541 A return of nil from this function means we have no information on the
544 ;; Note: in Emacs 22 and older, return of nil meant the file was unregistered.
545 ;; This is potentially a source of backward-compatibility bugs.
547 ;; FIXME: New (sub)states needed (?):
548 ;; - `conflict' (i.e. `edited' with conflict markers)
550 ;; - `copied' and `moved' (might be handled by `removed' and `added')
551 (or (vc-file-getprop file
'vc-state
)
552 (if (and (> (length file
) 0) (vc-backend file
))
553 (vc-file-setprop file
'vc-state
554 (vc-call state-heuristic file
)))))
556 (defun vc-recompute-state (file)
557 "Recompute the version control state of FILE, and return it.
558 This calls the possibly expensive function vc-BACKEND-state,
559 rather than the heuristic."
560 (vc-file-setprop file
'vc-state
(vc-call state file
)))
562 (defsubst vc-up-to-date-p
(file)
563 "Convenience function that checks whether `vc-state' of FILE is `up-to-date'."
564 (eq (vc-state file
) 'up-to-date
))
566 (defun vc-default-state-heuristic (backend file
)
567 "Default implementation of vc-state-heuristic.
568 It simply calls the real state computation function `vc-BACKEND-state'
569 and does not employ any heuristic at all."
570 (vc-call-backend backend
'state file
))
572 (defun vc-workfile-unchanged-p (file)
573 "Return non-nil if FILE has not changed since the last checkout."
574 (let ((checkout-time (vc-file-getprop file
'vc-checkout-time
))
575 (lastmod (nth 5 (file-attributes file
))))
576 (if (and checkout-time
577 ;; Tramp and Ange-FTP return this when they don't know the time.
578 (not (equal lastmod
'(0 0))))
579 (equal checkout-time lastmod
)
580 (let ((unchanged (vc-call workfile-unchanged-p file
)))
581 (vc-file-setprop file
'vc-checkout-time
(if unchanged lastmod
0))
584 (defun vc-default-workfile-unchanged-p (backend file
)
585 "Check if FILE is unchanged by diffing against the master version.
586 Return non-nil if FILE is unchanged."
587 (zerop (condition-case err
588 ;; If the implementation supports it, let the output
589 ;; go to *vc*, not *vc-diff*, since this is an internal call.
590 (vc-call diff
(list file
) nil nil
"*vc*")
591 (wrong-number-of-arguments
592 ;; If this error came from the above call to vc-BACKEND-diff,
593 ;; try again without the optional buffer argument (for
594 ;; backward compatibility). Otherwise, resignal.
595 (if (or (not (eq (cadr err
)
597 (vc-find-backend-function (vc-backend file
)
599 (not (eq (caddr err
) 4)))
600 (signal (car err
) (cdr err
))
601 (vc-call diff
(list file
)))))))
603 (defun vc-working-revision (file)
604 "Return the repository version from which FILE was checked out.
605 If FILE is not registered, this function always returns nil."
606 (or (vc-file-getprop file
'vc-working-revision
)
607 (if (vc-backend file
)
608 (vc-file-setprop file
'vc-working-revision
609 (vc-call working-revision file
)))))
610 ;; Backward compatibility.
611 (define-obsolete-function-alias
612 'vc-workfile-version
'vc-working-revision
"23.1")
613 (define-obsolete-function-alias
614 'vc-previous-version
'vc-previous-revision
"23.1")
615 (defun vc-default-working-revision (backend file
)
617 "`working-revision' not found: using the old `workfile-version' instead")
618 (vc-call-backend backend
'workfile-version file
))
620 (defun vc-default-registered (backend file
)
621 "Check if FILE is registered in BACKEND using vc-BACKEND-master-templates."
622 (let ((sym (vc-make-backend-sym backend
'master-templates
)))
623 (unless (get backend
'vc-templates-grabbed
)
624 (put backend
'vc-templates-grabbed t
)
625 (set sym
(append (delq nil
628 (and (consp template
)
629 (eq (cdr template
) backend
)
632 vc-master-templates
)))
633 (symbol-value sym
))))
634 (let ((result (vc-check-master-templates file
(symbol-value sym
))))
636 (vc-file-setprop file
'vc-name result
)
637 nil
)))) ; Not registered
639 (defun vc-possible-master (s dirname basename
)
641 ((stringp s
) (format s dirname basename
))
643 ;; The template is a function to invoke. If the
644 ;; function returns non-nil, that means it has found a
645 ;; master. For backward compatibility, we also handle
646 ;; the case that the function throws a 'found atom
647 ;; and a pair (cons MASTER-FILE BACKEND).
648 (let ((result (catch 'found
(funcall s dirname basename
))))
649 (if (consp result
) (car result
) result
)))))
651 (defun vc-check-master-templates (file templates
)
652 "Return non-nil if there is a master corresponding to FILE.
654 TEMPLATES is a list of strings or functions. If an element is a
655 string, it must be a control string as required by `format', with two
656 string placeholders, such as \"%sRCS/%s,v\". The directory part of
657 FILE is substituted for the first placeholder, the basename of FILE
658 for the second. If a file with the resulting name exists, it is taken
659 as the master of FILE, and returned.
661 If an element of TEMPLATES is a function, it is called with the
662 directory part and the basename of FILE as arguments. It should
663 return non-nil if it finds a master; that value is then returned by
665 (let ((dirname (or (file-name-directory file
) ""))
666 (basename (file-name-nondirectory file
)))
670 (let ((trial (vc-possible-master s dirname basename
)))
671 (if (and trial
(file-exists-p trial
)
672 ;; Make sure the file we found with name
673 ;; TRIAL is not the source file itself.
674 ;; That can happen with RCS-style names if
675 ;; the file name is truncated (e.g. to 14
676 ;; chars). See if either directory or
677 ;; attributes differ.
678 (or (not (string= dirname
679 (file-name-directory trial
)))
680 (not (equal (file-attributes file
)
681 (file-attributes trial
)))))
682 (throw 'found trial
))))
685 (defun vc-toggle-read-only (&optional verbose
)
686 "Change read-only status of current buffer, perhaps via version control.
688 If the buffer is visiting a file registered with version control,
689 then check the file in or out. Otherwise, just change the read-only flag
691 With prefix argument, ask for version number to check in or check out.
692 Check-out of a specified version number does not lock the file;
693 to do that, use this command a second time with no argument.
695 If you bind this function to \\[toggle-read-only], then Emacs checks files
696 in or out whenever you toggle the read-only flag."
698 (if (or (and (boundp 'vc-dired-mode
) vc-dired-mode
)
699 ;; use boundp because vc.el might not be loaded
700 (vc-backend buffer-file-name
))
701 (vc-next-action verbose
)
704 (defun vc-default-make-version-backups-p (backend file
)
705 "Return non-nil if unmodified versions should be backed up locally.
706 The default is to switch off this feature."
709 (defun vc-version-backup-file-name (file &optional rev manual regexp
)
710 "Return a backup file name for REV or the current version of FILE.
711 If MANUAL is non-nil it means that a name for backups created by
712 the user should be returned; if REGEXP is non-nil that means to return
713 a regexp for matching all such backup files, regardless of the version."
715 (concat (regexp-quote (file-name-nondirectory file
))
716 "\\.~.+" (unless manual
"\\.") "~")
717 (expand-file-name (concat (file-name-nondirectory file
)
718 ".~" (subst-char-in-string
719 ?
/ ?_
(or rev
(vc-working-revision file
)))
720 (unless manual
".") "~")
721 (file-name-directory file
))))
723 (defun vc-delete-automatic-version-backups (file)
724 "Delete all existing automatic version backups for FILE."
728 (directory-files (or (file-name-directory file
) default-directory
) t
729 (vc-version-backup-file-name file nil nil t
)))
730 ;; Don't fail when the directory doesn't exist.
733 (defun vc-make-version-backup (file)
734 "Make a backup copy of FILE, which is assumed in sync with the repository.
735 Before doing that, check if there are any old backups and get rid of them."
736 (unless (and (fboundp 'msdos-long-file-names
)
737 (not (with-no-warnings (msdos-long-file-names))))
738 (vc-delete-automatic-version-backups file
)
740 (copy-file file
(vc-version-backup-file-name file
)
742 ;; It's ok if it doesn't work (e.g. directory not writable),
743 ;; since this is just for efficiency.
746 (concat "Warning: Cannot make version backup; "
747 "diff/revert therefore not local"))))))
749 (defun vc-before-save ()
750 "Function to be called by `basic-save-buffer' (in files.el)."
751 ;; If the file on disk is still in sync with the repository,
752 ;; and version backups should be made, copy the file to
753 ;; another name. This enables local diffs and local reverting.
754 (let ((file buffer-file-name
))
755 (ignore-errors ;Be careful not to prevent saving the file.
756 (and (vc-backend file
)
757 (vc-up-to-date-p file
)
758 (eq (vc-checkout-model file
) 'implicit
)
759 (vc-call make-version-backups-p file
)
760 (vc-make-version-backup file
)))))
762 (declare-function vc-dired-resynch-file
"vc" (file))
764 (defun vc-after-save ()
765 "Function to be called by `basic-save-buffer' (in files.el)."
766 ;; If the file in the current buffer is under version control,
767 ;; up-to-date, and locking is not used for the file, set
768 ;; the state to 'edited and redisplay the mode line.
769 (let ((file buffer-file-name
))
770 (and (vc-backend file
)
771 (or (and (equal (vc-file-getprop file
'vc-checkout-time
)
772 (nth 5 (file-attributes file
)))
773 ;; File has been saved in the same second in which
774 ;; it was checked out. Clear the checkout-time
775 ;; to avoid confusion.
776 (vc-file-setprop file
'vc-checkout-time nil
))
778 (vc-up-to-date-p file
)
779 (eq (vc-checkout-model file
) 'implicit
)
780 (vc-file-setprop file
'vc-state
'edited
)
783 ;; If VC is not loaded, then there can't be
784 ;; any VC Dired buffer to synchronize.
785 (vc-dired-resynch-file file
)))))
787 (defvar vc-menu-entry
788 '(menu-item "Version Control" vc-menu-map
789 :filter vc-menu-map-filter
))
791 (when (boundp 'menu-bar-tools-menu
)
792 ;; We do not need to worry here about the placement of this entry
793 ;; because menu-bar.el has already created the proper spot for us
794 ;; and this will simply use it.
795 (define-key menu-bar-tools-menu
[vc] vc-menu-entry))
797 (defconst vc-mode-line-map
798 (let ((map (make-sparse-keymap)))
799 (define-key map [mode-line down-mouse-1] vc-menu-entry)
802 (defun vc-mode-line (file)
803 "Set `vc-mode' to display type of version control for FILE.
804 The value is set in the current buffer, which should be the buffer
806 (interactive (list buffer-file-name))
807 (let ((backend (vc-backend file)))
810 (let* ((ml-string (vc-call mode-line-string file))
811 (ml-echo (get-text-property 0 'help-echo ml-string)))
815 (if (null vc-display-status)
816 (symbol-name backend)
819 'mouse-face 'mode-line-highlight
822 (format "File under the %s version control system"
824 "\nmouse-1: Version Control menu")
825 'local-map vc-mode-line-map)))))
826 ;; If the file is locked by some other user, make
827 ;; the buffer read-only. Like this, even root
828 ;; cannot modify a file that someone else has locked.
829 (and (equal file buffer-file-name)
830 (stringp (vc-state file))
831 (setq buffer-read-only t))
832 ;; If the user is root, and the file is not owner-writable,
833 ;; then pretend that we can't write it
834 ;; even though we can (because root can write anything).
835 ;; This way, even root cannot modify a file that isn't locked.
836 (and (equal file buffer-file-name)
837 (not buffer-read-only)
838 (zerop (user-real-uid))
839 (zerop (logand (file-modes buffer-file-name) 128))
840 (setq buffer-read-only t)))
841 (force-mode-line-update)
844 (defun vc-default-mode-line-string (backend file)
845 "Return string for placement in modeline by `vc-mode-line' for FILE.
848 \"BACKEND-REV\" if the file is up-to-date
849 \"BACKEND:REV\" if the file is edited (or locked by the calling user)
850 \"BACKEND:LOCKER:REV\" if the file is locked by somebody else
852 This function assumes that the file is registered."
853 (setq backend (symbol-name backend))
854 (let ((state (vc-state file))
856 (rev (vc-working-revision file)))
858 (cond ((or (eq state 'up-to-date)
859 (eq state 'needs-patch))
860 (setq state-echo "Up to date file")
861 (concat backend "-" rev))
863 (setq state-echo (concat "File locked by" state))
864 (concat backend ":" state ":" rev))
866 (setq state-echo "Locally added file")
867 (concat backend "@" rev))
868 ((eq state 'conflict)
869 (setq state-echo "File contains conflicts after the last merge")
870 (concat backend "!" rev))
872 (setq state-echo "File removed from the VC system")
873 (concat backend "!" rev))
875 (setq state-echo "File tracked by the VC system, but missing from the file system")
876 (concat backend "?" rev))
878 ;; Not just for the 'edited state, but also a fallback
879 ;; for all other states. Think about different symbols
880 ;; for 'needs-patch and 'needs-merge.
881 (setq state-echo "Locally modified file")
882 (concat backend ":" rev)))
883 'help-echo (concat state-echo " under the " backend
884 " version control system"))))
886 (defun vc-follow-link ()
887 "If current buffer visits a symbolic link, visit the real file.
888 If the real file is already visited in another buffer, make that buffer
889 current, and kill the buffer that visits the link."
890 (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name)))
891 (true-buffer (find-buffer-visiting truename))
892 (this-buffer (current-buffer)))
893 (if (eq true-buffer this-buffer)
895 (kill-buffer this-buffer)
896 ;; In principle, we could do something like set-visited-file-name.
897 ;; However, it can't be exactly the same as set-visited-file-name.
898 ;; I'm not going to work out the details right now. -- rms.
899 (set-buffer (find-file-noselect truename)))
900 (set-buffer true-buffer)
901 (kill-buffer this-buffer))))
903 (defun vc-default-find-file-hook (backend)
906 (defun vc-find-file-hook ()
907 "Function for `find-file-hook' activating VC mode if appropriate."
908 ;; Recompute whether file is version controlled,
909 ;; if user has killed the buffer and revisited.
912 (when buffer-file-name
913 (vc-file-clearprops buffer-file-name)
915 ((with-demoted-errors (vc-backend buffer-file-name))
916 ;; Compute the state and put it in the modeline.
917 (vc-mode-line buffer-file-name)
918 (unless vc-make-backup-files
919 ;; Use this variable, not make-backup-files,
920 ;; because this is for things that depend on the file name.
921 (set (make-local-variable 'backup-inhibited) t))
922 ;; Let the backend setup any buffer-local things he needs.
923 (vc-call-backend (vc-backend buffer-file-name) 'find-file-hook))
924 ((let ((link-type (and (file-symlink-p buffer-file-name)
925 (vc-backend (file-chase-links buffer-file-name)))))
926 (cond ((not link-type) nil) ;Nothing to do.
927 ((eq vc-follow-symlinks nil)
929 "Warning: symbolic link to %s-controlled source file" link-type))
930 ((or (not (eq vc-follow-symlinks 'ask))
931 ;; If we already visited this file by following
932 ;; the link, don't ask again if we try to visit
933 ;; it again. GUD does that, and repeated questions
936 (abbreviate-file-name
937 (file-chase-links buffer-file-name))))
940 (message "Followed link to %s" buffer-file-name)
943 (if (yes-or-no-p (format
944 "Symbolic link to %s-controlled source file; follow link? " link-type))
945 (progn (vc-follow-link)
946 (message "Followed link to %s" buffer-file-name)
949 "Warning: editing through the link bypasses version control")
952 (add-hook 'find-file-hook 'vc-find-file-hook)
954 ;; more hooks, this time for file-not-found
955 (defun vc-file-not-found-hook ()
956 "When file is not found, try to check it out from version control.
957 Returns t if checkout was successful, nil otherwise.
958 Used in `find-file-not-found-functions'."
959 ;; When a file does not exist, ignore cached info about it
960 ;; from a previous visit.
961 (vc-file-clearprops buffer-file-name)
962 (let ((backend (vc-backend buffer-file-name)))
963 (if backend (vc-call-backend backend 'find-file-not-found-hook))))
965 (defun vc-default-find-file-not-found-hook (backend)
966 ;; This used to do what vc-rcs-find-file-not-found-hook does, but it only
967 ;; really makes sense for RCS. For other backends, better not do anything.
970 (add-hook 'find-file-not-found-functions 'vc-file-not-found-hook)
972 (defun vc-kill-buffer-hook ()
973 "Discard VC info about a file when we kill its buffer."
975 (vc-file-clearprops buffer-file-name)))
977 (add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)
979 ;; Now arrange for (autoloaded) bindings of the main package.
980 ;; Bindings for this have to go in the global map, as we'll often
981 ;; want to call them from random buffers.
983 ;; Autoloading works fine, but it prevents shortcuts from appearing
984 ;; in the menu because they don't exist yet when the menu is built.
985 ;; (autoload 'vc-prefix-map "vc" nil nil 'keymap)
986 (defvar vc-prefix-map
987 (let ((map (make-sparse-keymap)))
988 (define-key map "a" 'vc-update-change-log)
989 (define-key map "b" 'vc-switch-backend)
990 (define-key map "c" 'vc-rollback)
991 (define-key map "d" 'vc-dir)
992 (define-key map "g" 'vc-annotate)
993 (define-key map "h" 'vc-insert-headers)
994 (define-key map "i" 'vc-register)
995 (define-key map "l" 'vc-print-log)
996 (define-key map "m" 'vc-merge)
997 (define-key map "r" 'vc-retrieve-snapshot)
998 (define-key map "s" 'vc-create-snapshot)
999 (define-key map "u" 'vc-revert)
1000 (define-key map "v" 'vc-next-action)
1001 (define-key map "+" 'vc-update)
1002 (define-key map "=" 'vc-diff)
1003 (define-key map "~" 'vc-revision-other-window)
1004 ;; `vc-dir' is a not-quite-ready replacement for `vc-directory'
1005 ;; (define-key map "?" 'vc-dir)
1007 (fset 'vc-prefix-map vc-prefix-map)
1008 (define-key global-map "\C-xv" 'vc-prefix-map)
1011 (let ((map (make-sparse-keymap "Version Control")))
1012 ;;(define-key map [show-files]
1013 ;; '("Show Files under VC" . (vc-directory t)))
1014 (define-key map [vc-retrieve-snapshot]
1015 '(menu-item "Retrieve Snapshot" vc-retrieve-snapshot
1016 :help "Retrieve snapshot"))
1017 (define-key map [vc-create-snapshot]
1018 '(menu-item "Create Snapshot" vc-create-snapshot
1019 :help "Create Snapshot"))
1020 (define-key map [separator1] '("----"))
1021 (define-key map [vc-annotate]
1022 '(menu-item "Annotate" vc-annotate
1023 :help "Display the edit history of the current file using colors"))
1024 (define-key map [vc-rename-file]
1025 '(menu-item "Rename File" vc-rename-file
1026 :help "Rename file"))
1027 (define-key map [vc-revision-other-window]
1028 '(menu-item "Show Other Version" vc-revision-other-window
1029 :help "Visit another version of the current file in another window"))
1030 (define-key map [vc-diff]
1031 '(menu-item "Compare with Base Version" vc-diff
1032 :help "Compare file set with the base version"))
1033 (define-key map [vc-update-change-log]
1034 '(menu-item "Update ChangeLog" vc-update-change-log
1035 :help "Find change log file and add entries from recent version control logs"))
1036 (define-key map [vc-print-log]
1037 '(menu-item "Show History" vc-print-log
1038 :help "List the change log of the current file set in a window"))
1039 (define-key map [separator2] '("----"))
1040 (define-key map [vc-insert-header]
1041 '(menu-item "Insert Header" vc-insert-headers
1042 :help "Insert headers into a file for use with a version control system.
1044 (define-key map [undo]
1045 '(menu-item "Undo Last Check-In" vc-rollback
1046 :help "Remove the most recent changeset committed to the repository"))
1047 (define-key map [vc-revert]
1048 '(menu-item "Revert to Base Version" vc-revert
1049 :help "Revert working copies of the selected file set to their repository contents"))
1050 (define-key map [vc-update]
1051 '(menu-item "Update to Latest Version" vc-update
1052 :help "Update the current fileset's files to their tip revisions"))
1053 (define-key map [vc-next-action]
1054 '(menu-item "Check In/Out" vc-next-action
1055 :help "Do the next logical version control operation on the current fileset"))
1056 (define-key map [vc-register]
1057 '(menu-item "Register" vc-register
1058 :help "Register file set into a version control system"))
1059 (define-key map [vc-dir]
1060 '(menu-item "VC Dir" vc-dir
1061 :help "Show the VC status of files in a directory"))
1064 (defalias 'vc-menu-map vc-menu-map)
1066 (declare-function vc-responsible-backend "vc" (file &optional register))
1068 (defun vc-menu-map-filter (orig-binding)
1069 (if (and (symbolp orig-binding) (fboundp orig-binding))
1070 (setq orig-binding (indirect-function orig-binding)))
1074 (if buffer-file-name
1075 (vc-backend buffer-file-name)
1076 (vc-responsible-backend default-directory))
1078 ;; Give the VC backend a chance to add menu entries
1079 ;; specific for that backend.
1080 (if (null ext-binding)
1082 (append orig-binding
1083 '((ext-menu-separator "---"))
1086 (defun vc-default-extra-menu (backend)
1089 ;; These are not correct and it's not currently clear how doing it
1090 ;; better (with more complicated expressions) might slow things down
1091 ;; on older systems.
1093 ;;(put 'vc-rename-file 'menu-enable 'vc-mode)
1094 ;;(put 'vc-annotate 'menu-enable '(eq (vc-buffer-backend) 'CVS))
1095 ;;(put 'vc-revision-other-window 'menu-enable 'vc-mode)
1096 ;;(put 'vc-diff 'menu-enable 'vc-mode)
1097 ;;(put 'vc-update-change-log 'menu-enable
1098 ;; '(member (vc-buffer-backend) '(RCS CVS)))
1099 ;;(put 'vc-print-log 'menu-enable 'vc-mode)
1100 ;;(put 'vc-rollback 'menu-enable 'vc-mode)
1101 ;;(put 'vc-revert 'menu-enable 'vc-mode)
1102 ;;(put 'vc-insert-headers 'menu-enable 'vc-mode)
1103 ;;(put 'vc-next-action 'menu-enable 'vc-mode)
1104 ;;(put 'vc-register 'menu-enable '(and buffer-file-name (not vc-mode)))
1108 ;; arch-tag: 2e5a6fa7-1d30-48e2-8bd0-e3d335f04f32
1109 ;;; vc-hooks.el ends here