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 Free Software Foundation, Inc.
6 ;; Author: FSF (see vc.el for full credits)
7 ;; Maintainer: Andre Spiegel <spiegel@gnu.org>
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 3, or (at your option)
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26 ;; Boston, MA 02110-1301, USA.
30 ;; This is the always-loaded portion of VC. It takes care of
31 ;; VC-related activities that are done when you visit a file, so that
32 ;; vc.el itself is loaded only when you use a VC command. See the
33 ;; commentary of vc.el.
40 ;; 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.")
46 (defvar vc-master-templates ())
47 (make-obsolete-variable 'vc-master-templates
48 "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'.")
52 (defvar vc-header-alist ())
53 (make-obsolete-variable 'vc-header-alist 'vc-BACKEND-header)
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 (defcustom vc-directory-exclusion-list '("SCCS" "RCS" "CVS" "MCVS"
80 ".svn" ".git" ".hg" ".bzr"
82 "List of directory names to be ignored when walking directory trees."
83 :type '(repeat string)
87 (if (file-directory-p "/usr/sccs")
90 "List of extra directories to search for version control commands."
91 :type '(repeat directory)
94 (defcustom vc-make-backup-files nil
95 "If non-nil, backups of registered files are made as with other files.
96 If nil (the default), files covered by version control don't get backups."
101 (defcustom vc-follow-symlinks 'ask
102 "What to do if visiting a symbolic link to a file under version control.
103 Editing such a file through the link bypasses the version control system,
104 which is dangerous and probably not what you want.
106 If this variable is t, VC follows the link and visits the real file,
107 telling you about it in the echo area. If it is `ask', VC asks for
108 confirmation whether it should follow the link. If nil, the link is
109 visited and a warning displayed."
110 :type '(choice (const :tag "Ask for confirmation" ask)
111 (const :tag "Visit link and warn" nil)
112 (const :tag "Follow link" t))
115 (defcustom vc-display-status t
116 "If non-nil, display revision number and lock status in modeline.
117 Otherwise, not displayed."
122 (defcustom vc-consult-headers t
123 "If non-nil, identify work files by searching for version headers."
127 (defcustom vc-keep-workfiles t
128 "If non-nil, don't delete working files after registering changes.
129 If the back-end is CVS, workfiles are always kept, regardless of the
134 (defcustom vc-mistrust-permissions nil
135 "If non-nil, don't assume permissions/ownership track version-control status.
136 If nil, do rely on the permissions.
137 See also variable `vc-consult-headers'."
141 (defun vc-mistrust-permissions (file)
142 "Internal access function to variable `vc-mistrust-permissions' for FILE."
143 (or (eq vc-mistrust-permissions 't)
144 (and vc-mistrust-permissions
145 (funcall vc-mistrust-permissions
146 (vc-backend-subdirectory-name file)))))
148 (defcustom vc-stay-local t
149 "Non-nil means use local operations when possible for remote repositories.
150 This avoids slow queries over the network and instead uses heuristics
151 and past information to determine the current status of a file.
153 The value can also be a regular expression or list of regular
154 expressions to match against the host name of a repository; then VC
155 only stays local for hosts that match it. Alternatively, the value
156 can be a list of regular expressions where the first element is the
157 symbol `except'; then VC always stays local except for hosts matched
158 by these regular expressions."
159 :type '(choice (const :tag "Always stay local" t)
160 (const :tag "Don't stay local" nil)
161 (list :format "\nExamine hostname and %v" :tag "Examine hostname ..."
162 (set :format "%v" :inline t (const :format "%t" :tag "don't" except))
163 (regexp :format " stay local,\n%t: %v" :tag "if it matches")
164 (repeat :format "%v%i\n" :inline t (regexp :tag "or"))))
168 (defun vc-stay-local-p (file)
169 "Return non-nil if VC should stay local when handling FILE.
170 This uses the `repository-hostname' backend operation.
171 If FILE is a list of files, return non-nil if any of them
172 individually should stay local."
174 (delq nil (mapcar 'vc-stay-local-p file))
175 (let* ((backend (vc-backend file))
176 (sym (vc-make-backend-sym backend 'stay-local))
177 (stay-local (if (boundp sym) (symbol-value sym) t)))
178 (if (eq stay-local t) (setq stay-local vc-stay-local))
179 (if (symbolp stay-local) stay-local
180 (let ((dirname (if (file-directory-p file)
181 (directory-file-name file)
182 (file-name-directory file))))
184 (or (vc-file-getprop dirname 'vc-stay-local-p)
186 dirname 'vc-stay-local-p
187 (let ((hostname (vc-call-backend
188 backend 'repository-hostname dirname)))
192 (if (eq (car-safe stay-local) 'except)
193 (setq default nil stay-local (cdr stay-local)))
194 (when (consp stay-local)
196 (mapconcat 'identity stay-local "\\|")))
197 (if (if (string-match stay-local hostname)
198 default (not default))
201 ;;; This is handled specially now.
202 ;; Tell Emacs about this new kind of minor mode
203 ;; (add-to-list 'minor-mode-alist '(vc-mode vc-mode))
205 (make-variable-buffer-local 'vc-mode)
206 (put 'vc-mode 'permanent-local t)
208 (defun vc-mode (&optional arg)
209 ;; Dummy function for C-h m
210 "Version Control minor mode.
211 This minor mode is automatically activated whenever you visit a file under
212 control of one of the revision control systems in `vc-handled-backends'.
213 VC commands are globally reachable under the prefix `\\[vc-prefix-map]':
216 (defmacro vc-error-occurred (&rest body)
217 `(condition-case nil (progn ,@body nil) (error t)))
219 ;; We need a notion of per-file properties because the version
220 ;; control state of a file is expensive to derive --- we compute
221 ;; them when the file is initially found, keep them up to date
222 ;; during any subsequent VC operations, and forget them when
223 ;; the buffer is killed.
225 (defvar vc-file-prop-obarray (make-vector 17 0)
226 "Obarray for per-file properties.")
228 (defvar vc-touched-properties nil)
230 (defun vc-file-setprop (file property value)
231 "Set per-file VC PROPERTY for FILE to VALUE."
232 (if (and vc-touched-properties
233 (not (memq property vc-touched-properties)))
234 (setq vc-touched-properties (append (list property)
235 vc-touched-properties)))
236 (put (intern file vc-file-prop-obarray) property value))
238 (defun vc-file-getprop (file property)
239 "Get per-file VC PROPERTY for FILE."
240 (get (intern file vc-file-prop-obarray) property))
242 (defun vc-file-clearprops (file)
243 "Clear all VC properties of FILE."
244 (setplist (intern file vc-file-prop-obarray) nil))
247 ;; We keep properties on each symbol naming a backend as follows:
248 ;; * `vc-functions': an alist mapping vc-FUNCTION to vc-BACKEND-FUNCTION.
250 (defun vc-make-backend-sym (backend sym)
251 "Return BACKEND-specific version of VC symbol SYM."
252 (intern (concat "vc-" (downcase (symbol-name backend))
253 "-" (symbol-name sym))))
255 (defun vc-find-backend-function (backend fun)
256 "Return BACKEND-specific implementation of FUN.
257 If there is no such implementation, return the default implementation;
258 if that doesn't exist either, return nil."
259 (let ((f (vc-make-backend-sym backend fun)))
261 ;; Load vc-BACKEND.el if needed.
262 (require (intern (concat "vc-" (downcase (symbol-name backend)))))
264 (let ((def (vc-make-backend-sym 'default fun)))
265 (if (fboundp def) (cons def backend) nil))))))
267 (defun vc-call-backend (backend function-name &rest args)
268 "Call for BACKEND the implementation of FUNCTION-NAME with the given ARGS.
271 (apply 'vc-BACKEND-FUN ARGS)
273 if vc-BACKEND-FUN exists (after trying to find it in vc-BACKEND.el)
276 (apply 'vc-default-FUN BACKEND ARGS)
278 It is usually called via the `vc-call' macro."
279 (let ((f (assoc function-name (get backend 'vc-functions))))
280 (if f (setq f (cdr f))
281 (setq f (vc-find-backend-function backend function-name))
282 (push (cons function-name f) (get backend 'vc-functions)))
285 (error "Sorry, %s is not implemented for %s" function-name backend))
286 ((consp f) (apply (car f) (cdr f) args))
287 (t (apply f args)))))
289 (defmacro vc-call (fun file &rest args)
290 "A convenience macro for calling VC backend functions.
291 Functions called by this macro must accept FILE as the first argument.
292 ARGS specifies any additional arguments. FUN should be unquoted.
293 BEWARE!! `file' is evaluated twice!!"
294 `(vc-call-backend (vc-backend ,file) ',fun ,file ,@args))
296 (defsubst vc-parse-buffer (pattern i)
297 "Find PATTERN in the current buffer and return its Ith submatch."
298 (goto-char (point-min))
299 (if (re-search-forward pattern nil t)
302 (defun vc-insert-file (file &optional limit blocksize)
303 "Insert the contents of FILE into the current buffer.
305 Optional argument LIMIT is a regexp. If present, the file is inserted
306 in chunks of size BLOCKSIZE (default 8 kByte), until the first
307 occurrence of LIMIT is found. Anything from the start of that occurrence
308 to the end of the buffer is then deleted. The function returns
309 non-nil if FILE exists and its contents were successfully inserted."
311 (when (file-exists-p file)
313 (insert-file-contents file)
314 (if (not blocksize) (setq blocksize 8192))
317 (and (< 0 (cadr (insert-file-contents
318 file nil filepos (incf filepos blocksize))))
319 (progn (beginning-of-line)
320 (let ((pos (re-search-forward limit nil 'move)))
321 (if pos (delete-region (match-beginning 0)
324 (set-buffer-modified-p nil)
327 (defun vc-find-root (file witness)
328 "Find the root of a checked out project.
329 The function walks up the directory tree from FILE looking for WITNESS.
330 If WITNESS if not found, return nil, otherwise return the root."
331 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
332 ;; witnesses in /home or in /.
333 (while (not (file-directory-p file))
334 (setq file (file-name-directory (directory-file-name file))))
335 (setq file (abbreviate-file-name file))
337 (user (nth 2 (file-attributes file))))
340 ;; As a heuristic, we stop looking up the hierarchy of
341 ;; directories as soon as we find a directory belonging
342 ;; to another user. This should save us from looking in
343 ;; things like /net and /afs. This assumes that all the
344 ;; files inside a project belong to the same user.
345 (not (equal user (nth 2 (file-attributes file))))
346 (string-match vc-ignore-dir-regexp file)))
347 (if (file-exists-p (expand-file-name witness file))
350 (setq file (file-name-directory (directory-file-name file))))
354 ;; Access functions to file properties
355 ;; (Properties should be _set_ using vc-file-setprop, but
356 ;; _retrieved_ only through these functions, which decide
357 ;; if the property is already known or not. A property should
358 ;; only be retrieved by vc-file-getprop if there is no
361 ;; properties indicating the backend being used for FILE
363 (defun vc-registered (file)
364 "Return non-nil if FILE is registered in a version control system.
366 This function performs the check each time it is called. To rely
367 on the result of a previous call, use `vc-backend' instead. If the
368 file was previously registered under a certain backend, then that
369 backend is tried first."
372 ((and (file-name-directory file) (string-match vc-ignore-dir-regexp (file-name-directory file)))
374 ((and (boundp 'file-name-handler-alist)
375 (setq handler (find-file-name-handler file 'vc-registered)))
376 ;; handler should set vc-backend and return t if registered
377 (funcall handler 'vc-registered file))
379 ;; There is no file name handler.
380 ;; Try vc-BACKEND-registered for each handled BACKEND.
382 (let ((backend (vc-file-getprop file 'vc-backend)))
385 (and (vc-call-backend b 'registered file)
386 (vc-file-setprop file 'vc-backend b)
388 (if (or (not backend) (eq backend 'none))
390 (cons backend vc-handled-backends))))
391 ;; File is not registered.
392 (vc-file-setprop file 'vc-backend 'none)
395 (defun vc-backend (file-or-list)
396 "Return the version control type of FILE-OR-LIST, nil if it's not registered.
397 If the argument is a list, the files must all have the same back end."
398 ;; `file' can be nil in several places (typically due to the use of
399 ;; code like (vc-backend buffer-file-name)).
400 (cond ((stringp file-or-list)
401 (let ((property (vc-file-getprop file-or-list 'vc-backend)))
402 ;; Note that internally, Emacs remembers unregistered
403 ;; files by setting the property to `none'.
404 (cond ((eq property 'none) nil)
406 ;; vc-registered sets the vc-backend property
407 (t (if (vc-registered file-or-list)
408 (vc-file-getprop file-or-list 'vc-backend)
410 ((and file-or-list (listp file-or-list))
411 (vc-backend (car file-or-list)))
416 (defun vc-backend-subdirectory-name (file)
417 "Return where the master and lock FILEs for the current directory are kept."
418 (symbol-name (vc-backend file)))
420 (defun vc-name (file)
421 "Return the master name of FILE.
422 If the file is not registered, or the master name is not known, return nil."
423 ;; TODO: This should ultimately become obsolete, at least up here
425 (or (vc-file-getprop file 'vc-name)
426 ;; force computation of the property by calling
427 ;; vc-BACKEND-registered explicitly
428 (if (and (vc-backend file)
429 (vc-call-backend (vc-backend file) 'registered file))
430 (vc-file-getprop file 'vc-name))))
432 (defun vc-checkout-model (file)
433 "Indicate how FILE is checked out.
435 If FILE is not registered, this function always returns nil.
436 For registered files, the possible values are:
438 'implicit FILE is always writeable, and checked out `implicitly'
439 when the user saves the first changes to the file.
441 'locking FILE is read-only if up-to-date; user must type
442 \\[vc-next-action] before editing. Strict locking
445 'announce FILE is read-only if up-to-date; user must type
446 \\[vc-next-action] before editing. But other users
447 may be editing at the same time."
448 (or (vc-file-getprop file 'vc-checkout-model)
449 (if (vc-backend file)
450 (vc-file-setprop file 'vc-checkout-model
451 (vc-call checkout-model file)))))
453 (defun vc-user-login-name (file)
454 "Return the name under which the user accesses the given FILE."
455 (or (and (eq (string-match tramp-file-name-regexp file) 0)
456 ;; tramp case: execute "whoami" via tramp
457 (let ((default-directory (file-name-directory file)))
459 (if (not (zerop (process-file "whoami" nil t)))
460 ;; fall through if "whoami" didn't work
462 ;; remove trailing newline
463 (delete-region (1- (point-max)) (point-max))
467 ;; if user-login-name is nil, return the UID as a string
468 (number-to-string (user-uid))))
470 (defun vc-state (file)
471 "Return the version control state of FILE.
473 If FILE is not registered, this function always returns nil.
474 For registered files, the value returned is one of:
476 'up-to-date The working file is unmodified with respect to the
477 latest version on the current branch, and not locked.
479 'edited The working file has been edited by the user. If
480 locking is used for the file, this state means that
481 the current version is locked by the calling user.
483 USER The current version of the working file is locked by
484 some other USER (a string).
486 'needs-patch The file has not been edited by the user, but there is
487 a more recent version on the current branch stored
490 'needs-merge The file has been edited by the user, and there is also
491 a more recent version on the current branch stored in
492 the master file. This state can only occur if locking
493 is not used for the file.
495 'unlocked-changes The working version of the file is not locked,
496 but the working file has been changed with respect
497 to that version. This state can only occur for files
498 with locking; it represents an erroneous condition that
499 should be resolved by the user (vc-next-action will
500 prompt the user to do it).
502 'added Scheduled to go into the repository on the next commit.
503 Often represented by vc-working-revision = \"0\" in VCSes
504 with monotonic IDs like Subversion and Mercurial.
506 'removed Scheduled to be deleted from the repository on next commit.
508 'ignored The file showed up in a dir-state listing with a flag
509 indicating the version-control system is ignoring it,
510 Note: This property is not set reliably (some VCSes
511 don't have useful directory-status commands) so assume
512 that any file with vc-state nil might be ignorable
513 without VC knowing it.
515 'unregistered The file showed up in a dir-state listing with a flag
516 indicating that it is not under version control.
517 Note: This property is not set reliably (some VCSes
518 don't have useful directory-status commands) so assume
519 that any file with vc-state nil might be unregistered
520 without VC knowing it.
522 A return of nil from this function means we have no information on the
525 ;; Note: in Emacs 22 and older, return of nil meant the file was unregistered.
526 ;; This is potentially a source of backward-compatibility bugs.
528 ;; FIXME: New (sub)states needed (?):
529 ;; - `conflict' (i.e. `edited' with conflict markers)
531 ;; - `copied' and `moved' (might be handled by `removed' and `added')
532 (or (vc-file-getprop file 'vc-state)
533 (if (and (> (length file) 0) (vc-backend file))
534 (vc-file-setprop file 'vc-state
535 (vc-call state-heuristic file)))))
537 (defun vc-recompute-state (file)
538 "Recompute the version control state of FILE, and return it.
539 This calls the possibly expensive function vc-BACKEND-state,
540 rather than the heuristic."
541 (vc-file-setprop file 'vc-state (vc-call state file)))
543 (defsubst vc-up-to-date-p (file)
544 "Convenience function that checks whether `vc-state' of FILE is `up-to-date'."
545 (eq (vc-state file) 'up-to-date))
547 (defun vc-default-state-heuristic (backend file)
548 "Default implementation of vc-state-heuristic.
549 It simply calls the real state computation function `vc-BACKEND-state'
550 and does not employ any heuristic at all."
551 (vc-call-backend backend 'state file))
553 (defun vc-workfile-unchanged-p (file)
554 "Return non-nil if FILE has not changed since the last checkout."
555 (let ((checkout-time (vc-file-getprop file 'vc-checkout-time))
556 (lastmod (nth 5 (file-attributes file))))
557 (if (and checkout-time
558 ;; Tramp and Ange-FTP return this when they don't know the time.
559 (not (equal lastmod '(0 0))))
560 (equal checkout-time lastmod)
561 (let ((unchanged (vc-call workfile-unchanged-p file)))
562 (vc-file-setprop file 'vc-checkout-time (if unchanged lastmod 0))
565 (defun vc-default-workfile-unchanged-p (backend file)
566 "Check if FILE is unchanged by diffing against the master version.
567 Return non-nil if FILE is unchanged."
568 (zerop (condition-case err
569 ;; If the implementation supports it, let the output
570 ;; go to *vc*, not *vc-diff*, since this is an internal call.
571 (vc-call diff (list file) nil nil "*vc*")
572 (wrong-number-of-arguments
573 ;; If this error came from the above call to vc-BACKEND-diff,
574 ;; try again without the optional buffer argument (for
575 ;; backward compatibility). Otherwise, resignal.
576 (if (or (not (eq (cadr err)
578 (vc-find-backend-function (vc-backend file)
580 (not (eq (caddr err) 4)))
581 (signal (car err) (cdr err))
582 (vc-call diff (list file)))))))
584 (defun vc-working-revision (file)
585 "Return the repository version from which FILE was checked out.
586 If FILE is not registered, this function always returns nil."
587 (or (vc-file-getprop file 'vc-working-revision)
588 (if (vc-backend file)
589 (vc-file-setprop file 'vc-working-revision
590 (vc-call working-revision file)))))
591 ;; Backward compatibility.
592 (define-obsolete-function-alias
593 'vc-workfile-version 'vc-working-revision "23.1")
594 (defun vc-default-working-revision (backend file)
596 "`working-revision' not found: using the old `workfile-version' instead")
597 (vc-call-backend backend 'workfile-version file))
599 (defun vc-default-registered (backend file)
600 "Check if FILE is registered in BACKEND using vc-BACKEND-master-templates."
601 (let ((sym (vc-make-backend-sym backend 'master-templates)))
602 (unless (get backend 'vc-templates-grabbed)
603 (put backend 'vc-templates-grabbed t)
604 (set sym (append (delq nil
607 (and (consp template)
608 (eq (cdr template) backend)
611 vc-master-templates)))
612 (symbol-value sym))))
613 (let ((result (vc-check-master-templates file (symbol-value sym))))
615 (vc-file-setprop file 'vc-name result)
616 nil)))) ; Not registered
618 (defun vc-possible-master (s dirname basename)
620 ((stringp s) (format s dirname basename))
622 ;; The template is a function to invoke. If the
623 ;; function returns non-nil, that means it has found a
624 ;; master. For backward compatibility, we also handle
625 ;; the case that the function throws a 'found atom
626 ;; and a pair (cons MASTER-FILE BACKEND).
627 (let ((result (catch 'found (funcall s dirname basename))))
628 (if (consp result) (car result) result)))))
630 (defun vc-check-master-templates (file templates)
631 "Return non-nil if there is a master corresponding to FILE.
633 TEMPLATES is a list of strings or functions. If an element is a
634 string, it must be a control string as required by `format', with two
635 string placeholders, such as \"%sRCS/%s,v\". The directory part of
636 FILE is substituted for the first placeholder, the basename of FILE
637 for the second. If a file with the resulting name exists, it is taken
638 as the master of FILE, and returned.
640 If an element of TEMPLATES is a function, it is called with the
641 directory part and the basename of FILE as arguments. It should
642 return non-nil if it finds a master; that value is then returned by
644 (let ((dirname (or (file-name-directory file) ""))
645 (basename (file-name-nondirectory file)))
649 (let ((trial (vc-possible-master s dirname basename)))
650 (if (and trial (file-exists-p trial)
651 ;; Make sure the file we found with name
652 ;; TRIAL is not the source file itself.
653 ;; That can happen with RCS-style names if
654 ;; the file name is truncated (e.g. to 14
655 ;; chars). See if either directory or
656 ;; attributes differ.
657 (or (not (string= dirname
658 (file-name-directory trial)))
659 (not (equal (file-attributes file)
660 (file-attributes trial)))))
661 (throw 'found trial))))
664 (defun vc-toggle-read-only (&optional verbose)
665 "Change read-only status of current buffer, perhaps via version control.
667 If the buffer is visiting a file registered with version control,
668 then check the file in or out. Otherwise, just change the read-only flag
670 With prefix argument, ask for version number to check in or check out.
671 Check-out of a specified version number does not lock the file;
672 to do that, use this command a second time with no argument.
674 If you bind this function to \\[toggle-read-only], then Emacs checks files
675 in or out whenever you toggle the read-only flag."
677 (if (or (and (boundp 'vc-dired-mode) vc-dired-mode)
678 ;; use boundp because vc.el might not be loaded
679 (vc-backend buffer-file-name))
680 (vc-next-action verbose)
683 (defun vc-default-make-version-backups-p (backend file)
684 "Return non-nil if unmodified versions should be backed up locally.
685 The default is to switch off this feature."
688 (defun vc-version-backup-file-name (file &optional rev manual regexp)
689 "Return a backup file name for REV or the current version of FILE.
690 If MANUAL is non-nil it means that a name for backups created by
691 the user should be returned; if REGEXP is non-nil that means to return
692 a regexp for matching all such backup files, regardless of the version."
694 (concat (regexp-quote (file-name-nondirectory file))
695 "\\.~.+" (unless manual "\\.") "~")
696 (expand-file-name (concat (file-name-nondirectory file)
697 ".~" (subst-char-in-string
698 ?/ ?_ (or rev (vc-working-revision file)))
699 (unless manual ".") "~")
700 (file-name-directory file))))
702 (defun vc-delete-automatic-version-backups (file)
703 "Delete all existing automatic version backups for FILE."
707 (directory-files (or (file-name-directory file) default-directory) t
708 (vc-version-backup-file-name file nil nil t)))
709 ;; Don't fail when the directory doesn't exist.
712 (defun vc-make-version-backup (file)
713 "Make a backup copy of FILE, which is assumed in sync with the repository.
714 Before doing that, check if there are any old backups and get rid of them."
715 (unless (and (fboundp 'msdos-long-file-names)
716 (not (with-no-warnings (msdos-long-file-names))))
717 (vc-delete-automatic-version-backups file)
719 (copy-file file (vc-version-backup-file-name file)
721 ;; It's ok if it doesn't work (e.g. directory not writable),
722 ;; since this is just for efficiency.
725 (concat "Warning: Cannot make version backup; "
726 "diff/revert therefore not local"))))))
728 (defun vc-before-save ()
729 "Function to be called by `basic-save-buffer' (in files.el)."
730 ;; If the file on disk is still in sync with the repository,
731 ;; and version backups should be made, copy the file to
732 ;; another name. This enables local diffs and local reverting.
733 (let ((file buffer-file-name))
734 (and (vc-backend file)
735 (vc-up-to-date-p file)
736 (eq (vc-checkout-model file) 'implicit)
737 (vc-call make-version-backups-p file)
738 (vc-make-version-backup file))))
740 (declare-function vc-dired-resynch-file "vc" (file))
742 (defun vc-after-save ()
743 "Function to be called by `basic-save-buffer' (in files.el)."
744 ;; If the file in the current buffer is under version control,
745 ;; up-to-date, and locking is not used for the file, set
746 ;; the state to 'edited and redisplay the mode line.
747 (let ((file buffer-file-name))
748 (and (vc-backend file)
749 (or (and (equal (vc-file-getprop file 'vc-checkout-time)
750 (nth 5 (file-attributes file)))
751 ;; File has been saved in the same second in which
752 ;; it was checked out. Clear the checkout-time
753 ;; to avoid confusion.
754 (vc-file-setprop file 'vc-checkout-time nil))
756 (vc-up-to-date-p file)
757 (eq (vc-checkout-model file) 'implicit)
758 (vc-file-setprop file 'vc-state 'edited)
761 ;; If VC is not loaded, then there can't be
762 ;; any VC Dired buffer to synchronize.
763 (vc-dired-resynch-file file)))))
765 (defvar vc-menu-entry
766 '(menu-item "Version Control" vc-menu-map
767 :filter vc-menu-map-filter))
769 (when (boundp 'menu-bar-tools-menu)
770 ;; We do not need to worry here about the placement of this entry
771 ;; because menu-bar.el has already created the proper spot for us
772 ;; and this will simply use it.
773 (define-key menu-bar-tools-menu [vc] vc-menu-entry))
775 (defconst vc-mode-line-map
776 (let ((map (make-sparse-keymap)))
777 (define-key map [mode-line down-mouse-1] vc-menu-entry)
780 (defun vc-mode-line (file)
781 "Set `vc-mode' to display type of version control for FILE.
782 The value is set in the current buffer, which should be the buffer
784 (interactive (list buffer-file-name))
785 (let ((backend (vc-backend file)))
788 (let* ((ml-string (vc-call mode-line-string file))
789 (ml-echo (get-text-property 0 'help-echo ml-string)))
793 (if (null vc-display-status)
794 (symbol-name backend)
797 'mouse-face 'mode-line-highlight
800 (format "File under the %s version control system"
802 "\nmouse-1: Version Control menu")
803 'local-map vc-mode-line-map)))))
804 ;; If the file is locked by some other user, make
805 ;; the buffer read-only. Like this, even root
806 ;; cannot modify a file that someone else has locked.
807 (and (equal file buffer-file-name)
808 (stringp (vc-state file))
809 (setq buffer-read-only t))
810 ;; If the user is root, and the file is not owner-writable,
811 ;; then pretend that we can't write it
812 ;; even though we can (because root can write anything).
813 ;; This way, even root cannot modify a file that isn't locked.
814 (and (equal file buffer-file-name)
815 (not buffer-read-only)
816 (zerop (user-real-uid))
817 (zerop (logand (file-modes buffer-file-name) 128))
818 (setq buffer-read-only t)))
819 (force-mode-line-update)
822 (defun vc-default-mode-line-string (backend file)
823 "Return string for placement in modeline by `vc-mode-line' for FILE.
826 \"BACKEND-REV\" if the file is up-to-date
827 \"BACKEND:REV\" if the file is edited (or locked by the calling user)
828 \"BACKEND:LOCKER:REV\" if the file is locked by somebody else
830 This function assumes that the file is registered."
831 (setq backend (symbol-name backend))
832 (let ((state (vc-state file))
834 (rev (vc-working-revision file)))
836 (cond ((or (eq state 'up-to-date)
837 (eq state 'needs-patch))
838 (setq state-echo "Up to date file")
839 (concat backend "-" rev))
841 (setq state-echo (concat "File locked by" state))
842 (concat backend ":" state ":" rev))
844 ;; Not just for the 'edited state, but also a fallback
845 ;; for all other states. Think about different symbols
846 ;; for 'needs-patch and 'needs-merge.
847 (setq state-echo "Locally modified file")
848 (concat backend ":" rev)))
849 'help-echo (concat state-echo " under the " backend
850 " version control system"))))
852 (defun vc-follow-link ()
853 "If current buffer visits a symbolic link, visit the real file.
854 If the real file is already visited in another buffer, make that buffer
855 current, and kill the buffer that visits the link."
856 (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name)))
857 (true-buffer (find-buffer-visiting truename))
858 (this-buffer (current-buffer)))
859 (if (eq true-buffer this-buffer)
861 (kill-buffer this-buffer)
862 ;; In principle, we could do something like set-visited-file-name.
863 ;; However, it can't be exactly the same as set-visited-file-name.
864 ;; I'm not going to work out the details right now. -- rms.
865 (set-buffer (find-file-noselect truename)))
866 (set-buffer true-buffer)
867 (kill-buffer this-buffer))))
869 (defun vc-default-find-file-hook (backend)
872 (defun vc-find-file-hook ()
873 "Function for `find-file-hook' activating VC mode if appropriate."
874 ;; Recompute whether file is version controlled,
875 ;; if user has killed the buffer and revisited.
878 (when buffer-file-name
879 (vc-file-clearprops buffer-file-name)
881 ((with-demoted-errors (vc-backend buffer-file-name))
882 ;; Compute the state and put it in the modeline.
883 (vc-mode-line buffer-file-name)
884 (unless vc-make-backup-files
885 ;; Use this variable, not make-backup-files,
886 ;; because this is for things that depend on the file name.
887 (set (make-local-variable 'backup-inhibited) t))
888 ;; Let the backend setup any buffer-local things he needs.
889 (vc-call-backend (vc-backend buffer-file-name) 'find-file-hook))
890 ((let ((link-type (and (file-symlink-p buffer-file-name)
891 (vc-backend (file-chase-links buffer-file-name)))))
892 (cond ((not link-type) nil) ;Nothing to do.
893 ((eq vc-follow-symlinks nil)
895 "Warning: symbolic link to %s-controlled source file" link-type))
896 ((or (not (eq vc-follow-symlinks 'ask))
897 ;; If we already visited this file by following
898 ;; the link, don't ask again if we try to visit
899 ;; it again. GUD does that, and repeated questions
902 (abbreviate-file-name
903 (file-chase-links buffer-file-name))))
906 (message "Followed link to %s" buffer-file-name)
909 (if (yes-or-no-p (format
910 "Symbolic link to %s-controlled source file; follow link? " link-type))
911 (progn (vc-follow-link)
912 (message "Followed link to %s" buffer-file-name)
915 "Warning: editing through the link bypasses version control")
918 (add-hook 'find-file-hook 'vc-find-file-hook)
920 ;; more hooks, this time for file-not-found
921 (defun vc-file-not-found-hook ()
922 "When file is not found, try to check it out from version control.
923 Returns t if checkout was successful, nil otherwise.
924 Used in `find-file-not-found-functions'."
925 ;; When a file does not exist, ignore cached info about it
926 ;; from a previous visit.
927 (vc-file-clearprops buffer-file-name)
928 (let ((backend (vc-backend buffer-file-name)))
929 (if backend (vc-call-backend backend 'find-file-not-found-hook))))
931 (defun vc-default-find-file-not-found-hook (backend)
932 ;; This used to do what vc-rcs-find-file-not-found-hook does, but it only
933 ;; really makes sense for RCS. For other backends, better not do anything.
936 (add-hook 'find-file-not-found-functions 'vc-file-not-found-hook)
938 (defun vc-kill-buffer-hook ()
939 "Discard VC info about a file when we kill its buffer."
941 (vc-file-clearprops buffer-file-name)))
943 (add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)
945 ;; Now arrange for (autoloaded) bindings of the main package.
946 ;; Bindings for this have to go in the global map, as we'll often
947 ;; want to call them from random buffers.
949 ;; Autoloading works fine, but it prevents shortcuts from appearing
950 ;; in the menu because they don't exist yet when the menu is built.
951 ;; (autoload 'vc-prefix-map "vc" nil nil 'keymap)
952 (defvar vc-prefix-map
953 (let ((map (make-sparse-keymap)))
954 (define-key map "a" 'vc-update-change-log)
955 (define-key map "b" 'vc-switch-backend)
956 (define-key map "c" 'vc-rollback)
957 (define-key map "d" 'vc-directory)
958 (define-key map "g" 'vc-annotate)
959 (define-key map "h" 'vc-insert-headers)
960 (define-key map "i" 'vc-register)
961 (define-key map "l" 'vc-print-log)
962 (define-key map "m" 'vc-merge)
963 (define-key map "r" 'vc-retrieve-snapshot)
964 (define-key map "s" 'vc-create-snapshot)
965 (define-key map "u" 'vc-revert)
966 (define-key map "v" 'vc-next-action)
967 (define-key map "+" 'vc-update)
968 (define-key map "=" 'vc-diff)
969 (define-key map "~" 'vc-revision-other-window)
971 (fset 'vc-prefix-map vc-prefix-map)
972 (define-key global-map "\C-xv" 'vc-prefix-map)
975 (let ((map (make-sparse-keymap "Version Control")))
976 ;;(define-key map [show-files]
977 ;; '("Show Files under VC" . (vc-directory t)))
978 (define-key map [vc-retrieve-snapshot]
979 '("Retrieve Snapshot" . vc-retrieve-snapshot))
980 (define-key map [vc-create-snapshot]
981 '("Create Snapshot" . vc-create-snapshot))
982 (define-key map [vc-directory] '("VC Directory Listing" . vc-directory))
983 (define-key map [separator1] '("----"))
984 (define-key map [vc-annotate] '("Annotate" . vc-annotate))
985 (define-key map [vc-rename-file] '("Rename File" . vc-rename-file))
986 (define-key map [vc-revision-other-window]
987 '("Show Other Version" . vc-revision-other-window))
988 (define-key map [vc-diff] '("Compare with Base Version" . vc-diff))
989 (define-key map [vc-update-change-log]
990 '("Update ChangeLog" . vc-update-change-log))
991 (define-key map [vc-print-log] '("Show History" . vc-print-log))
992 (define-key map [separator2] '("----"))
993 (define-key map [vc-insert-header]
994 '("Insert Header" . vc-insert-headers))
995 (define-key map [undo] '("Undo Last Check-In" . vc-rollback))
996 (define-key map [vc-revert]
997 '("Revert to Base Version" . vc-revert))
998 (define-key map [vc-update]
999 '("Update to Latest Version" . vc-update))
1000 (define-key map [vc-next-action] '("Check In/Out" . vc-next-action))
1001 (define-key map [vc-register] '("Register" . vc-register))
1004 (defalias 'vc-menu-map vc-menu-map)
1006 (defun vc-menu-map-filter (orig-binding)
1007 (if (and (symbolp orig-binding) (fboundp orig-binding))
1008 (setq orig-binding (indirect-function orig-binding)))
1010 (if vc-mode (vc-call-backend (vc-backend buffer-file-name)
1012 ;; Give the VC backend a chance to add menu entries
1013 ;; specific for that backend.
1014 (if (null ext-binding)
1016 (append orig-binding
1017 '((ext-menu-separator "---"))
1020 (defun vc-default-extra-menu (backend)
1023 ;; These are not correct and it's not currently clear how doing it
1024 ;; better (with more complicated expressions) might slow things down
1025 ;; on older systems.
1027 ;;(put 'vc-rename-file 'menu-enable 'vc-mode)
1028 ;;(put 'vc-annotate 'menu-enable '(eq (vc-buffer-backend) 'CVS))
1029 ;;(put 'vc-revision-other-window 'menu-enable 'vc-mode)
1030 ;;(put 'vc-diff 'menu-enable 'vc-mode)
1031 ;;(put 'vc-update-change-log 'menu-enable
1032 ;; '(member (vc-buffer-backend) '(RCS CVS)))
1033 ;;(put 'vc-print-log 'menu-enable 'vc-mode)
1034 ;;(put 'vc-rollback 'menu-enable 'vc-mode)
1035 ;;(put 'vc-revert 'menu-enable 'vc-mode)
1036 ;;(put 'vc-insert-headers 'menu-enable 'vc-mode)
1037 ;;(put 'vc-next-action 'menu-enable 'vc-mode)
1038 ;;(put 'vc-register 'menu-enable '(and buffer-file-name (not vc-mode)))
1042 ;; arch-tag: 2e5a6fa7-1d30-48e2-8bd0-e3d335f04f32
1043 ;;; vc-hooks.el ends here