Replace MenuHandle and GetMenuHandle with MenuRef and
[emacs.git] / lisp / vc-hooks.el
blob0bf03b2789bbbce20a4c0cbb9ae0b0697f781ee8
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 ;; $Id$
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)
16 ;; any later version.
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.
28 ;;; Commentary:
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.
35 ;;; Code:
37 (eval-when-compile
38 (require 'cl))
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."
62 :type 'regexp
63 :group 'vc)
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)
76 :version "22.2"
77 :group 'vc)
79 (defcustom vc-path
80 (if (file-directory-p "/usr/sccs")
81 '("/usr/sccs")
82 nil)
83 "*List of extra directories to search for version control commands."
84 :type '(repeat directory)
85 :group 'vc)
87 (defcustom vc-make-backup-files nil
88 "*If non-nil, backups of registered files are made as with other files.
89 If nil (the default), files covered by version control don't get backups."
90 :type 'boolean
91 :group 'vc
92 :group 'backup)
94 (defcustom vc-follow-symlinks 'ask
95 "*What to do if visiting a symbolic link to a file under version control.
96 Editing such a file through the link bypasses the version control system,
97 which is dangerous and probably not what you want.
99 If this variable is t, VC follows the link and visits the real file,
100 telling you about it in the echo area. If it is `ask', VC asks for
101 confirmation whether it should follow the link. If nil, the link is
102 visited and a warning displayed."
103 :type '(choice (const :tag "Ask for confirmation" ask)
104 (const :tag "Visit link and warn" nil)
105 (const :tag "Follow link" t))
106 :group 'vc)
108 (defcustom vc-display-status t
109 "*If non-nil, display revision number and lock status in modeline.
110 Otherwise, not displayed."
111 :type 'boolean
112 :group 'vc)
115 (defcustom vc-consult-headers t
116 "*If non-nil, identify work files by searching for version headers."
117 :type 'boolean
118 :group 'vc)
120 (defcustom vc-keep-workfiles t
121 "*If non-nil, don't delete working files after registering changes.
122 If the back-end is CVS, workfiles are always kept, regardless of the
123 value of this flag."
124 :type 'boolean
125 :group 'vc)
127 (defcustom vc-mistrust-permissions nil
128 "*If non-nil, don't assume permissions/ownership track version-control status.
129 If nil, do rely on the permissions.
130 See also variable `vc-consult-headers'."
131 :type 'boolean
132 :group 'vc)
134 (defun vc-mistrust-permissions (file)
135 "Internal access function to variable `vc-mistrust-permissions' for FILE."
136 (or (eq vc-mistrust-permissions 't)
137 (and vc-mistrust-permissions
138 (funcall vc-mistrust-permissions
139 (vc-backend-subdirectory-name file)))))
141 (defcustom vc-stay-local t
142 "*Non-nil means use local operations when possible for remote repositories.
143 This avoids slow queries over the network and instead uses heuristics
144 and past information to determine the current status of a file.
146 The value can also be a regular expression or list of regular
147 expressions to match against the host name of a repository; then VC
148 only stays local for hosts that match it. Alternatively, the value
149 can be a list of regular expressions where the first element is the
150 symbol `except'; then VC always stays local except for hosts matched
151 by these regular expressions."
152 :type '(choice (const :tag "Always stay local" t)
153 (const :tag "Don't stay local" nil)
154 (list :format "\nExamine hostname and %v" :tag "Examine hostname ..."
155 (set :format "%v" :inline t (const :format "%t" :tag "don't" except))
156 (regexp :format " stay local,\n%t: %v" :tag "if it matches")
157 (repeat :format "%v%i\n" :inline t (regexp :tag "or"))))
158 :version "22.1"
159 :group 'vc)
161 (defun vc-stay-local-p (file)
162 "Return non-nil if VC should stay local when handling FILE.
163 This uses the `repository-hostname' backend operation."
164 (let* ((backend (vc-backend file))
165 (sym (vc-make-backend-sym backend 'stay-local))
166 (stay-local (if (boundp sym) (symbol-value sym) t)))
167 (if (eq stay-local t) (setq stay-local vc-stay-local))
168 (if (symbolp stay-local) stay-local
169 (let ((dirname (if (file-directory-p file)
170 (directory-file-name file)
171 (file-name-directory file))))
172 (eq 'yes
173 (or (vc-file-getprop dirname 'vc-stay-local-p)
174 (vc-file-setprop
175 dirname 'vc-stay-local-p
176 (let ((hostname (vc-call-backend
177 backend 'repository-hostname dirname)))
178 (if (not hostname)
180 (let ((default t))
181 (if (eq (car-safe stay-local) 'except)
182 (setq default nil stay-local (cdr stay-local)))
183 (when (consp stay-local)
184 (setq stay-local
185 (mapconcat 'identity stay-local "\\|")))
186 (if (if (string-match stay-local hostname)
187 default (not default))
188 'yes 'no)))))))))))
190 ;;; This is handled specially now.
191 ;; Tell Emacs about this new kind of minor mode
192 ;; (add-to-list 'minor-mode-alist '(vc-mode vc-mode))
194 (make-variable-buffer-local 'vc-mode)
195 (put 'vc-mode 'permanent-local t)
197 (defun vc-mode (&optional arg)
198 ;; Dummy function for C-h m
199 "Version Control minor mode.
200 This minor mode is automatically activated whenever you visit a file under
201 control of one of the revision control systems in `vc-handled-backends'.
202 VC commands are globally reachable under the prefix `\\[vc-prefix-map]':
203 \\{vc-prefix-map}")
205 (defmacro vc-error-occurred (&rest body)
206 `(condition-case nil (progn ,@body nil) (error t)))
208 ;; We need a notion of per-file properties because the version
209 ;; control state of a file is expensive to derive --- we compute
210 ;; them when the file is initially found, keep them up to date
211 ;; during any subsequent VC operations, and forget them when
212 ;; the buffer is killed.
214 (defvar vc-file-prop-obarray (make-vector 17 0)
215 "Obarray for per-file properties.")
217 (defvar vc-touched-properties nil)
219 (defun vc-file-setprop (file property value)
220 "Set per-file VC PROPERTY for FILE to VALUE."
221 (if (and vc-touched-properties
222 (not (memq property vc-touched-properties)))
223 (setq vc-touched-properties (append (list property)
224 vc-touched-properties)))
225 (put (intern file vc-file-prop-obarray) property value))
227 (defun vc-file-getprop (file property)
228 "Get per-file VC PROPERTY for FILE."
229 (get (intern file vc-file-prop-obarray) property))
231 (defun vc-file-clearprops (file)
232 "Clear all VC properties of FILE."
233 (setplist (intern file vc-file-prop-obarray) nil))
236 ;; We keep properties on each symbol naming a backend as follows:
237 ;; * `vc-functions': an alist mapping vc-FUNCTION to vc-BACKEND-FUNCTION.
239 (defun vc-make-backend-sym (backend sym)
240 "Return BACKEND-specific version of VC symbol SYM."
241 (intern (concat "vc-" (downcase (symbol-name backend))
242 "-" (symbol-name sym))))
244 (defun vc-find-backend-function (backend fun)
245 "Return BACKEND-specific implementation of FUN.
246 If there is no such implementation, return the default implementation;
247 if that doesn't exist either, return nil."
248 (let ((f (vc-make-backend-sym backend fun)))
249 (if (fboundp f) f
250 ;; Load vc-BACKEND.el if needed.
251 (require (intern (concat "vc-" (downcase (symbol-name backend)))))
252 (if (fboundp f) f
253 (let ((def (vc-make-backend-sym 'default fun)))
254 (if (fboundp def) (cons def backend) nil))))))
256 (defun vc-call-backend (backend function-name &rest args)
257 "Call for BACKEND the implementation of FUNCTION-NAME with the given ARGS.
258 Calls
260 (apply 'vc-BACKEND-FUN ARGS)
262 if vc-BACKEND-FUN exists (after trying to find it in vc-BACKEND.el)
263 and else calls
265 (apply 'vc-default-FUN BACKEND ARGS)
267 It is usually called via the `vc-call' macro."
268 (let ((f (assoc function-name (get backend 'vc-functions))))
269 (if f (setq f (cdr f))
270 (setq f (vc-find-backend-function backend function-name))
271 (push (cons function-name f) (get backend 'vc-functions)))
272 (cond
273 ((null f)
274 (error "Sorry, %s is not implemented for %s" function-name backend))
275 ((consp f) (apply (car f) (cdr f) args))
276 (t (apply f args)))))
278 (defmacro vc-call (fun file &rest args)
279 ;; BEWARE!! `file' is evaluated twice!!
280 `(vc-call-backend (vc-backend ,file) ',fun ,file ,@args))
282 (defsubst vc-parse-buffer (pattern i)
283 "Find PATTERN in the current buffer and return its Ith submatch."
284 (goto-char (point-min))
285 (if (re-search-forward pattern nil t)
286 (match-string i)))
288 (defun vc-insert-file (file &optional limit blocksize)
289 "Insert the contents of FILE into the current buffer.
291 Optional argument LIMIT is a regexp. If present, the file is inserted
292 in chunks of size BLOCKSIZE (default 8 kByte), until the first
293 occurrence of LIMIT is found. Anything from the start of that occurrence
294 to the end of the buffer is then deleted. The function returns
295 non-nil if FILE exists and its contents were successfully inserted."
296 (erase-buffer)
297 (when (file-exists-p file)
298 (if (not limit)
299 (insert-file-contents file)
300 (if (not blocksize) (setq blocksize 8192))
301 (let ((filepos 0))
302 (while
303 (and (< 0 (cadr (insert-file-contents
304 file nil filepos (incf filepos blocksize))))
305 (progn (beginning-of-line)
306 (let ((pos (re-search-forward limit nil 'move)))
307 (if pos (delete-region (match-beginning 0)
308 (point-max)))
309 (not pos)))))))
310 (set-buffer-modified-p nil)
313 (defun vc-find-root (file witness)
314 "Find the root of a checked out project.
315 The function walks up the directory tree from FILE looking for WITNESS.
316 If WITNESS if not found, return nil, otherwise return the root."
317 ;; Represent /home/luser/foo as ~/foo so that we don't try to look for
318 ;; witnesses in /home or in /.
319 (setq file (abbreviate-file-name file))
320 (let ((root nil)
321 ;; `user' is not initialized outside the loop because
322 ;; `file' may not exist, so we may have to walk up part of the
323 ;; hierarchy before we find the "initial UID".
324 (user nil))
325 (while (not (or root
326 (null file)
327 ;; As a heuristic, we stop looking up the hierarchy of
328 ;; directories as soon as we find a directory belonging
329 ;; to another user. This should save us from looking in
330 ;; things like /net and /afs. This assumes that all the
331 ;; files inside a project belong to the same user.
332 (let ((prev-user user))
333 (setq user (nth 2 (file-attributes file)))
334 (and prev-user (not (equal user prev-user))))
335 (string-match vc-ignore-dir-regexp file)))
336 (if (file-exists-p (expand-file-name witness file))
337 (setq root file)
338 (if (equal file
339 (setq file (file-name-directory (directory-file-name file))))
340 (setq file nil))))
341 root))
343 ;; Access functions to file properties
344 ;; (Properties should be _set_ using vc-file-setprop, but
345 ;; _retrieved_ only through these functions, which decide
346 ;; if the property is already known or not. A property should
347 ;; only be retrieved by vc-file-getprop if there is no
348 ;; access function.)
350 ;; properties indicating the backend being used for FILE
352 (defun vc-registered (file)
353 "Return non-nil if FILE is registered in a version control system.
355 This function performs the check each time it is called. To rely
356 on the result of a previous call, use `vc-backend' instead. If the
357 file was previously registered under a certain backend, then that
358 backend is tried first."
359 (let (handler)
360 (cond
361 ((string-match vc-ignore-dir-regexp (file-name-directory file)) nil)
362 ((and (boundp 'file-name-handler-alist)
363 (setq handler (find-file-name-handler file 'vc-registered)))
364 ;; handler should set vc-backend and return t if registered
365 (funcall handler 'vc-registered file))
367 ;; There is no file name handler.
368 ;; Try vc-BACKEND-registered for each handled BACKEND.
369 (catch 'found
370 (let ((backend (vc-file-getprop file 'vc-backend)))
371 (mapcar
372 (lambda (b)
373 (and (vc-call-backend b 'registered file)
374 (vc-file-setprop file 'vc-backend b)
375 (throw 'found t)))
376 (if (or (not backend) (eq backend 'none))
377 vc-handled-backends
378 (cons backend vc-handled-backends))))
379 ;; File is not registered.
380 (vc-file-setprop file 'vc-backend 'none)
381 nil)))))
383 (defun vc-backend (file)
384 "Return the version control type of FILE, nil if it is not registered."
385 ;; `file' can be nil in several places (typically due to the use of
386 ;; code like (vc-backend buffer-file-name)).
387 (when (stringp file)
388 (let ((property (vc-file-getprop file 'vc-backend)))
389 ;; Note that internally, Emacs remembers unregistered
390 ;; files by setting the property to `none'.
391 (cond ((eq property 'none) nil)
392 (property)
393 ;; vc-registered sets the vc-backend property
394 (t (if (vc-registered file)
395 (vc-file-getprop file 'vc-backend)
396 nil))))))
398 (defun vc-backend-subdirectory-name (file)
399 "Return where the master and lock FILEs for the current directory are kept."
400 (symbol-name (vc-backend file)))
402 (defun vc-name (file)
403 "Return the master name of FILE.
404 If the file is not registered, or the master name is not known, return nil."
405 ;; TODO: This should ultimately become obsolete, at least up here
406 ;; in vc-hooks.
407 (or (vc-file-getprop file 'vc-name)
408 ;; force computation of the property by calling
409 ;; vc-BACKEND-registered explicitly
410 (if (and (vc-backend file)
411 (vc-call-backend (vc-backend file) 'registered file))
412 (vc-file-getprop file 'vc-name))))
414 (defun vc-checkout-model (file)
415 "Indicate how FILE is checked out.
417 If FILE is not registered, this function always returns nil.
418 For registered files, the possible values are:
420 'implicit FILE is always writeable, and checked out `implicitly'
421 when the user saves the first changes to the file.
423 'locking FILE is read-only if up-to-date; user must type
424 \\[vc-next-action] before editing. Strict locking
425 is assumed.
427 'announce FILE is read-only if up-to-date; user must type
428 \\[vc-next-action] before editing. But other users
429 may be editing at the same time."
430 (or (vc-file-getprop file 'vc-checkout-model)
431 (if (vc-backend file)
432 (vc-file-setprop file 'vc-checkout-model
433 (vc-call checkout-model file)))))
435 (defun vc-user-login-name (file)
436 "Return the name under which the user accesses the given FILE."
437 (or (and (eq (string-match tramp-file-name-regexp file) 0)
438 ;; tramp case: execute "whoami" via tramp
439 (let ((default-directory (file-name-directory file)))
440 (with-temp-buffer
441 (if (not (zerop (process-file "whoami" nil t)))
442 ;; fall through if "whoami" didn't work
444 ;; remove trailing newline
445 (delete-region (1- (point-max)) (point-max))
446 (buffer-string)))))
447 ;; normal case
448 (user-login-name)
449 ;; if user-login-name is nil, return the UID as a string
450 (number-to-string (user-uid))))
452 (defun vc-state (file)
453 "Return the version control state of FILE.
455 If FILE is not registered, this function always returns nil.
456 For registered files, the value returned is one of:
458 'up-to-date The working file is unmodified with respect to the
459 latest version on the current branch, and not locked.
461 'edited The working file has been edited by the user. If
462 locking is used for the file, this state means that
463 the current version is locked by the calling user.
465 USER The current version of the working file is locked by
466 some other USER (a string).
468 'needs-patch The file has not been edited by the user, but there is
469 a more recent version on the current branch stored
470 in the master file.
472 'needs-merge The file has been edited by the user, and there is also
473 a more recent version on the current branch stored in
474 the master file. This state can only occur if locking
475 is not used for the file.
477 'unlocked-changes The current version of the working file is not locked,
478 but the working file has been changed with respect
479 to that version. This state can only occur for files
480 with locking; it represents an erroneous condition that
481 should be resolved by the user (vc-next-action will
482 prompt the user to do it)."
483 ;; FIXME: New (sub)states needed (?):
484 ;; - `added' (i.e. `edited' but with no base version yet,
485 ;; typically represented by vc-workfile-version = "0")
486 ;; - `conflict' (i.e. `edited' with conflict markers)
487 ;; - `removed'
488 ;; - `copied' and `moved' (might be handled by `removed' and `added')
489 (or (vc-file-getprop file 'vc-state)
490 (if (vc-backend file)
491 (vc-file-setprop file 'vc-state
492 (vc-call state-heuristic file)))))
494 (defun vc-recompute-state (file)
495 "Recompute the version control state of FILE, and return it.
496 This calls the possibly expensive function vc-BACKEND-state,
497 rather than the heuristic."
498 (vc-file-setprop file 'vc-state (vc-call state file)))
500 (defsubst vc-up-to-date-p (file)
501 "Convenience function that checks whether `vc-state' of FILE is `up-to-date'."
502 (eq (vc-state file) 'up-to-date))
504 (defun vc-default-state-heuristic (backend file)
505 "Default implementation of vc-state-heuristic.
506 It simply calls the real state computation function `vc-BACKEND-state'
507 and does not employ any heuristic at all."
508 (vc-call-backend backend 'state file))
510 (defun vc-workfile-unchanged-p (file)
511 "Return non-nil if FILE has not changed since the last checkout."
512 (let ((checkout-time (vc-file-getprop file 'vc-checkout-time))
513 (lastmod (nth 5 (file-attributes file))))
514 (if (and checkout-time
515 ;; Tramp and Ange-FTP return this when they don't know the time.
516 (not (equal lastmod '(0 0))))
517 (equal checkout-time lastmod)
518 (let ((unchanged (vc-call workfile-unchanged-p file)))
519 (vc-file-setprop file 'vc-checkout-time (if unchanged lastmod 0))
520 unchanged))))
522 (defun vc-default-workfile-unchanged-p (backend file)
523 "Check if FILE is unchanged by diffing against the master version.
524 Return non-nil if FILE is unchanged."
525 (zerop (condition-case err
526 ;; If the implementation supports it, let the output
527 ;; go to *vc*, not *vc-diff*, since this is an internal call.
528 (vc-call diff file nil nil "*vc*")
529 (wrong-number-of-arguments
530 ;; If this error came from the above call to vc-BACKEND-diff,
531 ;; try again without the optional buffer argument (for
532 ;; backward compatibility). Otherwise, resignal.
533 (if (or (not (eq (cadr err)
534 (indirect-function
535 (vc-find-backend-function (vc-backend file)
536 'diff))))
537 (not (eq (caddr err) 4)))
538 (signal (car err) (cdr err))
539 (vc-call diff file))))))
541 (defun vc-workfile-version (file)
542 "Return the version level of the current workfile FILE.
543 If FILE is not registered, this function always returns nil."
544 (or (vc-file-getprop file 'vc-workfile-version)
545 (if (vc-backend file)
546 (vc-file-setprop file 'vc-workfile-version
547 (vc-call workfile-version file)))))
549 (defun vc-default-registered (backend file)
550 "Check if FILE is registered in BACKEND using vc-BACKEND-master-templates."
551 (let ((sym (vc-make-backend-sym backend 'master-templates)))
552 (unless (get backend 'vc-templates-grabbed)
553 (put backend 'vc-templates-grabbed t)
554 (set sym (append (delq nil
555 (mapcar
556 (lambda (template)
557 (and (consp template)
558 (eq (cdr template) backend)
559 (car template)))
560 (with-no-warnings
561 vc-master-templates)))
562 (symbol-value sym))))
563 (let ((result (vc-check-master-templates file (symbol-value sym))))
564 (if (stringp result)
565 (vc-file-setprop file 'vc-name result)
566 nil)))) ; Not registered
568 (defun vc-possible-master (s dirname basename)
569 (cond
570 ((stringp s) (format s dirname basename))
571 ((functionp s)
572 ;; The template is a function to invoke. If the
573 ;; function returns non-nil, that means it has found a
574 ;; master. For backward compatibility, we also handle
575 ;; the case that the function throws a 'found atom
576 ;; and a pair (cons MASTER-FILE BACKEND).
577 (let ((result (catch 'found (funcall s dirname basename))))
578 (if (consp result) (car result) result)))))
580 (defun vc-check-master-templates (file templates)
581 "Return non-nil if there is a master corresponding to FILE.
583 TEMPLATES is a list of strings or functions. If an element is a
584 string, it must be a control string as required by `format', with two
585 string placeholders, such as \"%sRCS/%s,v\". The directory part of
586 FILE is substituted for the first placeholder, the basename of FILE
587 for the second. If a file with the resulting name exists, it is taken
588 as the master of FILE, and returned.
590 If an element of TEMPLATES is a function, it is called with the
591 directory part and the basename of FILE as arguments. It should
592 return non-nil if it finds a master; that value is then returned by
593 this function."
594 (let ((dirname (or (file-name-directory file) ""))
595 (basename (file-name-nondirectory file)))
596 (catch 'found
597 (mapcar
598 (lambda (s)
599 (let ((trial (vc-possible-master s dirname basename)))
600 (if (and trial (file-exists-p trial)
601 ;; Make sure the file we found with name
602 ;; TRIAL is not the source file itself.
603 ;; That can happen with RCS-style names if
604 ;; the file name is truncated (e.g. to 14
605 ;; chars). See if either directory or
606 ;; attributes differ.
607 (or (not (string= dirname
608 (file-name-directory trial)))
609 (not (equal (file-attributes file)
610 (file-attributes trial)))))
611 (throw 'found trial))))
612 templates))))
614 (defun vc-toggle-read-only (&optional verbose)
615 "Change read-only status of current buffer, perhaps via version control.
617 If the buffer is visiting a file registered with version control,
618 then check the file in or out. Otherwise, just change the read-only flag
619 of the buffer.
620 With prefix argument, ask for version number to check in or check out.
621 Check-out of a specified version number does not lock the file;
622 to do that, use this command a second time with no argument.
624 If you bind this function to \\[toggle-read-only], then Emacs checks files
625 in or out whenever you toggle the read-only flag."
626 (interactive "P")
627 (if (or (and (boundp 'vc-dired-mode) vc-dired-mode)
628 ;; use boundp because vc.el might not be loaded
629 (vc-backend buffer-file-name))
630 (vc-next-action verbose)
631 (toggle-read-only)))
633 (defun vc-default-make-version-backups-p (backend file)
634 "Return non-nil if unmodified versions should be backed up locally.
635 The default is to switch off this feature."
636 nil)
638 (defun vc-version-backup-file-name (file &optional rev manual regexp)
639 "Return a backup file name for REV or the current version of FILE.
640 If MANUAL is non-nil it means that a name for backups created by
641 the user should be returned; if REGEXP is non-nil that means to return
642 a regexp for matching all such backup files, regardless of the version."
643 (if regexp
644 (concat (regexp-quote (file-name-nondirectory file))
645 "\\.~.+" (unless manual "\\.") "~")
646 (expand-file-name (concat (file-name-nondirectory file)
647 ".~" (subst-char-in-string
648 ?/ ?_ (or rev (vc-workfile-version file)))
649 (unless manual ".") "~")
650 (file-name-directory file))))
652 (defun vc-delete-automatic-version-backups (file)
653 "Delete all existing automatic version backups for FILE."
654 (condition-case nil
655 (mapcar
656 'delete-file
657 (directory-files (or (file-name-directory file) default-directory) t
658 (vc-version-backup-file-name file nil nil t)))
659 ;; Don't fail when the directory doesn't exist.
660 (file-error nil)))
662 (defun vc-make-version-backup (file)
663 "Make a backup copy of FILE, which is assumed in sync with the repository.
664 Before doing that, check if there are any old backups and get rid of them."
665 (unless (and (fboundp 'msdos-long-file-names)
666 (not (with-no-warnings (msdos-long-file-names))))
667 (vc-delete-automatic-version-backups file)
668 (condition-case nil
669 (copy-file file (vc-version-backup-file-name file)
670 nil 'keep-date)
671 ;; It's ok if it doesn't work (e.g. directory not writable),
672 ;; since this is just for efficiency.
673 (file-error
674 (message
675 (concat "Warning: Cannot make version backup; "
676 "diff/revert therefore not local"))))))
678 (defun vc-before-save ()
679 "Function to be called by `basic-save-buffer' (in files.el)."
680 ;; If the file on disk is still in sync with the repository,
681 ;; and version backups should be made, copy the file to
682 ;; another name. This enables local diffs and local reverting.
683 (let ((file buffer-file-name))
684 (and (vc-backend file)
685 (vc-up-to-date-p file)
686 (eq (vc-checkout-model file) 'implicit)
687 (vc-call make-version-backups-p file)
688 (vc-make-version-backup file))))
690 (defun vc-after-save ()
691 "Function to be called by `basic-save-buffer' (in files.el)."
692 ;; If the file in the current buffer is under version control,
693 ;; up-to-date, and locking is not used for the file, set
694 ;; the state to 'edited and redisplay the mode line.
695 (let ((file buffer-file-name))
696 (and (vc-backend file)
697 (or (and (equal (vc-file-getprop file 'vc-checkout-time)
698 (nth 5 (file-attributes file)))
699 ;; File has been saved in the same second in which
700 ;; it was checked out. Clear the checkout-time
701 ;; to avoid confusion.
702 (vc-file-setprop file 'vc-checkout-time nil))
704 (vc-up-to-date-p file)
705 (eq (vc-checkout-model file) 'implicit)
706 (vc-file-setprop file 'vc-state 'edited)
707 (vc-mode-line file)
708 (if (featurep 'vc)
709 ;; If VC is not loaded, then there can't be
710 ;; any VC Dired buffer to synchronize.
711 (vc-dired-resynch-file file)))))
713 (defvar vc-menu-entry
714 '(menu-item "Version Control" vc-menu-map
715 :filter vc-menu-map-filter))
717 (when (boundp 'menu-bar-tools-menu)
718 ;; We do not need to worry here about the placement of this entry
719 ;; because menu-bar.el has already created the proper spot for us
720 ;; and this will simply use it.
721 (define-key menu-bar-tools-menu [vc] vc-menu-entry))
723 (defconst vc-mode-line-map
724 (let ((map (make-sparse-keymap)))
725 (define-key map [mode-line down-mouse-1] vc-menu-entry)
726 map))
728 (defun vc-mode-line (file)
729 "Set `vc-mode' to display type of version control for FILE.
730 The value is set in the current buffer, which should be the buffer
731 visiting FILE."
732 (interactive (list buffer-file-name))
733 (let ((backend (vc-backend file)))
734 (if (not backend)
735 (setq vc-mode nil)
736 (setq vc-mode (concat " " (if vc-display-status
737 (vc-call mode-line-string file)
738 (symbol-name backend))))
739 ;; If the file is locked by some other user, make
740 ;; the buffer read-only. Like this, even root
741 ;; cannot modify a file that someone else has locked.
742 (and (equal file buffer-file-name)
743 (stringp (vc-state file))
744 (setq buffer-read-only t))
745 ;; If the user is root, and the file is not owner-writable,
746 ;; then pretend that we can't write it
747 ;; even though we can (because root can write anything).
748 ;; This way, even root cannot modify a file that isn't locked.
749 (and (equal file buffer-file-name)
750 (not buffer-read-only)
751 (zerop (user-real-uid))
752 (zerop (logand (file-modes buffer-file-name) 128))
753 (setq buffer-read-only t)))
754 (force-mode-line-update)
755 backend))
757 (defun vc-default-mode-line-string (backend file)
758 "Return string for placement in modeline by `vc-mode-line' for FILE.
759 Format:
761 \"BACKEND-REV\" if the file is up-to-date
762 \"BACKEND:REV\" if the file is edited (or locked by the calling user)
763 \"BACKEND:LOCKER:REV\" if the file is locked by somebody else
765 This function assumes that the file is registered."
766 (setq backend (symbol-name backend))
767 (let ((state (vc-state file))
768 (rev (vc-workfile-version file)))
769 (cond ((or (eq state 'up-to-date)
770 (eq state 'needs-patch))
771 (concat backend "-" rev))
772 ((stringp state)
773 (concat backend ":" state ":" rev))
775 ;; Not just for the 'edited state, but also a fallback
776 ;; for all other states. Think about different symbols
777 ;; for 'needs-patch and 'needs-merge.
778 (concat backend ":" rev)))))
780 (defun vc-follow-link ()
781 "If current buffer visits a symbolic link, visit the real file.
782 If the real file is already visited in another buffer, make that buffer
783 current, and kill the buffer that visits the link."
784 (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name)))
785 (true-buffer (find-buffer-visiting truename))
786 (this-buffer (current-buffer)))
787 (if (eq true-buffer this-buffer)
788 (progn
789 (kill-buffer this-buffer)
790 ;; In principle, we could do something like set-visited-file-name.
791 ;; However, it can't be exactly the same as set-visited-file-name.
792 ;; I'm not going to work out the details right now. -- rms.
793 (set-buffer (find-file-noselect truename)))
794 (set-buffer true-buffer)
795 (kill-buffer this-buffer))))
797 (defun vc-default-find-file-hook (backend)
798 nil)
800 (defun vc-find-file-hook ()
801 "Function for `find-file-hook' activating VC mode if appropriate."
802 ;; Recompute whether file is version controlled,
803 ;; if user has killed the buffer and revisited.
804 (if vc-mode
805 (setq vc-mode nil))
806 (when buffer-file-name
807 (vc-file-clearprops buffer-file-name)
808 (cond
809 ((ignore-errors (vc-backend buffer-file-name))
810 ;; Compute the state and put it in the modeline.
811 (vc-mode-line buffer-file-name)
812 (unless vc-make-backup-files
813 ;; Use this variable, not make-backup-files,
814 ;; because this is for things that depend on the file name.
815 (set (make-local-variable 'backup-inhibited) t))
816 ;; Let the backend setup any buffer-local things he needs.
817 (vc-call-backend (vc-backend buffer-file-name) 'find-file-hook))
818 ((let ((link-type (and (file-symlink-p buffer-file-name)
819 (vc-backend (file-chase-links buffer-file-name)))))
820 (cond ((not link-type) nil) ;Nothing to do.
821 ((eq vc-follow-symlinks nil)
822 (message
823 "Warning: symbolic link to %s-controlled source file" link-type))
824 ((or (not (eq vc-follow-symlinks 'ask))
825 ;; If we already visited this file by following
826 ;; the link, don't ask again if we try to visit
827 ;; it again. GUD does that, and repeated questions
828 ;; are painful.
829 (get-file-buffer
830 (abbreviate-file-name
831 (file-chase-links buffer-file-name))))
833 (vc-follow-link)
834 (message "Followed link to %s" buffer-file-name)
835 (vc-find-file-hook))
837 (if (yes-or-no-p (format
838 "Symbolic link to %s-controlled source file; follow link? " link-type))
839 (progn (vc-follow-link)
840 (message "Followed link to %s" buffer-file-name)
841 (vc-find-file-hook))
842 (message
843 "Warning: editing through the link bypasses version control")
844 ))))))))
846 (add-hook 'find-file-hook 'vc-find-file-hook)
848 ;; more hooks, this time for file-not-found
849 (defun vc-file-not-found-hook ()
850 "When file is not found, try to check it out from version control.
851 Returns t if checkout was successful, nil otherwise.
852 Used in `find-file-not-found-functions'."
853 ;; When a file does not exist, ignore cached info about it
854 ;; from a previous visit.
855 (vc-file-clearprops buffer-file-name)
856 (let ((backend (vc-backend buffer-file-name)))
857 (if backend (vc-call-backend backend 'find-file-not-found-hook))))
859 (defun vc-default-find-file-not-found-hook (backend)
860 ;; This used to do what vc-rcs-find-file-not-found-hook does, but it only
861 ;; really makes sense for RCS. For other backends, better not do anything.
862 nil)
864 (add-hook 'find-file-not-found-functions 'vc-file-not-found-hook)
866 (defun vc-kill-buffer-hook ()
867 "Discard VC info about a file when we kill its buffer."
868 (if buffer-file-name
869 (vc-file-clearprops buffer-file-name)))
871 (add-hook 'kill-buffer-hook 'vc-kill-buffer-hook)
873 ;; Now arrange for (autoloaded) bindings of the main package.
874 ;; Bindings for this have to go in the global map, as we'll often
875 ;; want to call them from random buffers.
877 ;; Autoloading works fine, but it prevents shortcuts from appearing
878 ;; in the menu because they don't exist yet when the menu is built.
879 ;; (autoload 'vc-prefix-map "vc" nil nil 'keymap)
880 (defvar vc-prefix-map
881 (let ((map (make-sparse-keymap)))
882 (define-key map "a" 'vc-update-change-log)
883 (define-key map "b" 'vc-switch-backend)
884 (define-key map "c" 'vc-cancel-version)
885 (define-key map "d" 'vc-directory)
886 (define-key map "g" 'vc-annotate)
887 (define-key map "h" 'vc-insert-headers)
888 (define-key map "i" 'vc-register)
889 (define-key map "l" 'vc-print-log)
890 (define-key map "m" 'vc-merge)
891 (define-key map "r" 'vc-retrieve-snapshot)
892 (define-key map "s" 'vc-create-snapshot)
893 (define-key map "u" 'vc-revert-buffer)
894 (define-key map "v" 'vc-next-action)
895 (define-key map "=" 'vc-diff)
896 (define-key map "~" 'vc-version-other-window)
897 map))
898 (fset 'vc-prefix-map vc-prefix-map)
899 (define-key global-map "\C-xv" 'vc-prefix-map)
901 (defvar vc-menu-map
902 (let ((map (make-sparse-keymap "Version Control")))
903 ;;(define-key map [show-files]
904 ;; '("Show Files under VC" . (vc-directory t)))
905 (define-key map [vc-retrieve-snapshot]
906 '("Retrieve Snapshot" . vc-retrieve-snapshot))
907 (define-key map [vc-create-snapshot]
908 '("Create Snapshot" . vc-create-snapshot))
909 (define-key map [vc-directory] '("VC Directory Listing" . vc-directory))
910 (define-key map [separator1] '("----"))
911 (define-key map [vc-annotate] '("Annotate" . vc-annotate))
912 (define-key map [vc-rename-file] '("Rename File" . vc-rename-file))
913 (define-key map [vc-version-other-window]
914 '("Show Other Version" . vc-version-other-window))
915 (define-key map [vc-diff] '("Compare with Base Version" . vc-diff))
916 (define-key map [vc-update-change-log]
917 '("Update ChangeLog" . vc-update-change-log))
918 (define-key map [vc-print-log] '("Show History" . vc-print-log))
919 (define-key map [separator2] '("----"))
920 (define-key map [vc-insert-header]
921 '("Insert Header" . vc-insert-headers))
922 (define-key map [undo] '("Undo Last Check-In" . vc-cancel-version))
923 (define-key map [vc-revert-buffer]
924 '("Revert to Base Version" . vc-revert-buffer))
925 (define-key map [vc-update]
926 '("Update to Latest Version" . vc-update))
927 (define-key map [vc-next-action] '("Check In/Out" . vc-next-action))
928 (define-key map [vc-register] '("Register" . vc-register))
929 map))
931 (defalias 'vc-menu-map vc-menu-map)
933 (defun vc-menu-map-filter (orig-binding)
934 (if (and (symbolp orig-binding) (fboundp orig-binding))
935 (setq orig-binding (indirect-function orig-binding)))
936 (let ((ext-binding
937 (if vc-mode (vc-call-backend (vc-backend buffer-file-name)
938 'extra-menu))))
939 ;; Give the VC backend a chance to add menu entries
940 ;; specific for that backend.
941 (if (null ext-binding)
942 orig-binding
943 (append orig-binding
944 '((ext-menu-separator "---"))
945 ext-binding))))
947 (defun vc-default-extra-menu (backend)
948 nil)
950 ;; These are not correct and it's not currently clear how doing it
951 ;; better (with more complicated expressions) might slow things down
952 ;; on older systems.
954 ;;(put 'vc-rename-file 'menu-enable 'vc-mode)
955 ;;(put 'vc-annotate 'menu-enable '(eq (vc-buffer-backend) 'CVS))
956 ;;(put 'vc-version-other-window 'menu-enable 'vc-mode)
957 ;;(put 'vc-diff 'menu-enable 'vc-mode)
958 ;;(put 'vc-update-change-log 'menu-enable
959 ;; '(member (vc-buffer-backend) '(RCS CVS)))
960 ;;(put 'vc-print-log 'menu-enable 'vc-mode)
961 ;;(put 'vc-cancel-version 'menu-enable 'vc-mode)
962 ;;(put 'vc-revert-buffer 'menu-enable 'vc-mode)
963 ;;(put 'vc-insert-headers 'menu-enable 'vc-mode)
964 ;;(put 'vc-next-action 'menu-enable 'vc-mode)
965 ;;(put 'vc-register 'menu-enable '(and buffer-file-name (not vc-mode)))
967 (provide 'vc-hooks)
969 ;; arch-tag: 2e5a6fa7-1d30-48e2-8bd0-e3d335f04f32
970 ;;; vc-hooks.el ends here