Commit | Line | Data |
---|---|---|
aae56ea7 | 1 | ;;; vc-hooks.el --- resident support for version-control |
594722a8 | 2 | |
c90f2757 | 3 | ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001, |
d7a0267c | 4 | ;; 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. |
594722a8 | 5 | |
0e0d9831 GM |
6 | ;; Author: FSF (see vc.el for full credits) |
7 | ;; Maintainer: Andre Spiegel <spiegel@gnu.org> | |
594722a8 | 8 | |
ce9f8ffb | 9 | ;; $Id$ |
f4c72097 | 10 | |
594722a8 ER |
11 | ;; This file is part of GNU Emacs. |
12 | ||
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 | |
b4aa6026 | 15 | ;; the Free Software Foundation; either version 3, or (at your option) |
594722a8 ER |
16 | ;; any later version. |
17 | ||
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. | |
22 | ||
23 | ;; You should have received a copy of the GNU General Public License | |
b578f267 | 24 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
086add15 LK |
25 | ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
26 | ;; Boston, MA 02110-1301, USA. | |
594722a8 ER |
27 | |
28 | ;;; Commentary: | |
29 | ||
0e0d9831 GM |
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. | |
594722a8 ER |
34 | |
35 | ;;; Code: | |
36 | ||
c3ce5e29 AS |
37 | (eval-when-compile |
38 | (require 'cl)) | |
099bd78a | 39 | |
e1c0c2d1 KH |
40 | ;; Customization Variables (the rest is in vc.el) |
41 | ||
e18cf2ee | 42 | (defvar vc-ignore-vc-files nil) |
5499f9dc | 43 | (make-obsolete-variable 'vc-ignore-vc-files |
3dab70bf | 44 | "set `vc-handled-backends' to nil to disable VC.") |
5499f9dc | 45 | |
e18cf2ee | 46 | (defvar vc-master-templates ()) |
0d2ce4ef JB |
47 | (make-obsolete-variable 'vc-master-templates |
48 | "to define master templates for a given BACKEND, use | |
5499f9dc | 49 | vc-BACKEND-master-templates. To enable or disable VC for a given |
3dab70bf | 50 | BACKEND, use `vc-handled-backends'.") |
5499f9dc | 51 | |
e18cf2ee JB |
52 | (defvar vc-header-alist ()) |
53 | (make-obsolete-variable 'vc-header-alist 'vc-BACKEND-header) | |
0e0d9831 | 54 | |
456e749f SM |
55 | (defcustom vc-ignore-dir-regexp |
56 | ;; Stop SMB, automounter, AFS, and DFS host lookups. | |
57 | "\\`\\(?:[\\/][\\/]\\|/\\(?:net\\|afs\\|\\.\\\.\\.\\)/\\)\\'" | |
43621386 | 58 | "Regexp matching directory names that are not under VC's control. |
ce9f8ffb SM |
59 | The default regexp prevents fruitless and time-consuming attempts |
60 | to determine the VC status in directories in which filenames are | |
43621386 SM |
61 | interpreted as hostnames." |
62 | :type 'regexp | |
63 | :group 'vc) | |
ce9f8ffb | 64 | |
b5883dcf | 65 | (defcustom vc-handled-backends '(RCS CVS SVN SCCS Bzr Git Hg Mtn Arch MCVS) |
b1dc6d44 SM |
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). | |
e5162bc1 | 69 | "List of version control backends for which VC will be used. |
0e0d9831 GM |
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) | |
dbd3d787 | 76 | :version "23.1" |
50bec091 | 77 | :group 'vc) |
31888047 | 78 | |
50bec091 | 79 | (defcustom vc-path |
e1c0c2d1 KH |
80 | (if (file-directory-p "/usr/sccs") |
81 | '("/usr/sccs") | |
82 | nil) | |
e5162bc1 | 83 | "List of extra directories to search for version control commands." |
50bec091 KH |
84 | :type '(repeat directory) |
85 | :group 'vc) | |
e1c0c2d1 | 86 | |
50bec091 | 87 | (defcustom vc-make-backup-files nil |
e5162bc1 | 88 | "If non-nil, backups of registered files are made as with other files. |
50bec091 KH |
89 | If nil (the default), files covered by version control don't get backups." |
90 | :type 'boolean | |
8f383484 DL |
91 | :group 'vc |
92 | :group 'backup) | |
594722a8 | 93 | |
50bec091 | 94 | (defcustom vc-follow-symlinks 'ask |
e5162bc1 | 95 | "What to do if visiting a symbolic link to a file under version control. |
0e0d9831 GM |
96 | Editing such a file through the link bypasses the version control system, |
97 | which is dangerous and probably not what you want. | |
98 | ||
99 | If this variable is t, VC follows the link and visits the real file, | |
b8063212 AS |
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 | |
50bec091 | 102 | visited and a warning displayed." |
0e0d9831 GM |
103 | :type '(choice (const :tag "Ask for confirmation" ask) |
104 | (const :tag "Visit link and warn" nil) | |
105 | (const :tag "Follow link" t)) | |
50bec091 | 106 | :group 'vc) |
b8063212 | 107 | |
50bec091 | 108 | (defcustom vc-display-status t |
e5162bc1 | 109 | "If non-nil, display revision number and lock status in modeline. |
50bec091 KH |
110 | Otherwise, not displayed." |
111 | :type 'boolean | |
112 | :group 'vc) | |
113 | ||
198d5c00 | 114 | |
50bec091 | 115 | (defcustom vc-consult-headers t |
e5162bc1 | 116 | "If non-nil, identify work files by searching for version headers." |
50bec091 KH |
117 | :type 'boolean |
118 | :group 'vc) | |
e1c0c2d1 | 119 | |
50bec091 | 120 | (defcustom vc-keep-workfiles t |
e5162bc1 | 121 | "If non-nil, don't delete working files after registering changes. |
e1c0c2d1 | 122 | If the back-end is CVS, workfiles are always kept, regardless of the |
50bec091 KH |
123 | value of this flag." |
124 | :type 'boolean | |
125 | :group 'vc) | |
e1c0c2d1 | 126 | |
50bec091 | 127 | (defcustom vc-mistrust-permissions nil |
e5162bc1 | 128 | "If non-nil, don't assume permissions/ownership track version-control status. |
0e0d9831 | 129 | If nil, do rely on the permissions. |
50bec091 KH |
130 | See also variable `vc-consult-headers'." |
131 | :type 'boolean | |
132 | :group 'vc) | |
e66eac08 AS |
133 | |
134 | (defun vc-mistrust-permissions (file) | |
0e0d9831 | 135 | "Internal access function to variable `vc-mistrust-permissions' for FILE." |
e66eac08 AS |
136 | (or (eq vc-mistrust-permissions 't) |
137 | (and vc-mistrust-permissions | |
0e0d9831 | 138 | (funcall vc-mistrust-permissions |
e66eac08 AS |
139 | (vc-backend-subdirectory-name file))))) |
140 | ||
113414a9 | 141 | (defcustom vc-stay-local t |
e5162bc1 | 142 | "Non-nil means use local operations when possible for remote repositories. |
113414a9 SM |
143 | This avoids slow queries over the network and instead uses heuristics |
144 | and past information to determine the current status of a file. | |
145 | ||
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")))) | |
bf247b6e | 158 | :version "22.1" |
113414a9 SM |
159 | :group 'vc) |
160 | ||
161 | (defun vc-stay-local-p (file) | |
162 | "Return non-nil if VC should stay local when handling FILE. | |
33e0847d TTN |
163 | This uses the `repository-hostname' backend operation. |
164 | If FILE is a list of files, return non-nil if any of them | |
165 | individually should stay local." | |
e4d26892 | 166 | (if (listp file) |
33e0847d | 167 | (delq nil (mapcar 'vc-stay-local-p file)) |
e4d26892 ER |
168 | (let* ((backend (vc-backend file)) |
169 | (sym (vc-make-backend-sym backend 'stay-local)) | |
170 | (stay-local (if (boundp sym) (symbol-value sym) t))) | |
171 | (if (eq stay-local t) (setq stay-local vc-stay-local)) | |
172 | (if (symbolp stay-local) stay-local | |
173 | (let ((dirname (if (file-directory-p file) | |
174 | (directory-file-name file) | |
175 | (file-name-directory file)))) | |
176 | (eq 'yes | |
177 | (or (vc-file-getprop dirname 'vc-stay-local-p) | |
178 | (vc-file-setprop | |
179 | dirname 'vc-stay-local-p | |
180 | (let ((hostname (vc-call-backend | |
181 | backend 'repository-hostname dirname))) | |
182 | (if (not hostname) | |
183 | 'no | |
184 | (let ((default t)) | |
185 | (if (eq (car-safe stay-local) 'except) | |
186 | (setq default nil stay-local (cdr stay-local))) | |
187 | (when (consp stay-local) | |
188 | (setq stay-local | |
189 | (mapconcat 'identity stay-local "\\|"))) | |
190 | (if (if (string-match stay-local hostname) | |
191 | default (not default)) | |
192 | 'yes 'no)))))))))))) | |
113414a9 | 193 | |
9bd06e95 | 194 | ;;; This is handled specially now. |
594722a8 | 195 | ;; Tell Emacs about this new kind of minor mode |
9bd06e95 | 196 | ;; (add-to-list 'minor-mode-alist '(vc-mode vc-mode)) |
594722a8 | 197 | |
7bc2b98b | 198 | (make-variable-buffer-local 'vc-mode) |
c43e436c | 199 | (put 'vc-mode 'permanent-local t) |
594722a8 | 200 | |
14fef9de SM |
201 | (defun vc-mode (&optional arg) |
202 | ;; Dummy function for C-h m | |
203 | "Version Control minor mode. | |
204 | This minor mode is automatically activated whenever you visit a file under | |
205 | control of one of the revision control systems in `vc-handled-backends'. | |
206 | VC commands are globally reachable under the prefix `\\[vc-prefix-map]': | |
207 | \\{vc-prefix-map}") | |
208 | ||
099bd78a | 209 | (defmacro vc-error-occurred (&rest body) |
becd6193 | 210 | `(condition-case nil (progn ,@body nil) (error t))) |
099bd78a | 211 | |
594722a8 | 212 | ;; We need a notion of per-file properties because the version |
f2ee4191 | 213 | ;; control state of a file is expensive to derive --- we compute |
0e0d9831 | 214 | ;; them when the file is initially found, keep them up to date |
f2ee4191 RS |
215 | ;; during any subsequent VC operations, and forget them when |
216 | ;; the buffer is killed. | |
594722a8 | 217 | |
becd6193 | 218 | (defvar vc-file-prop-obarray (make-vector 17 0) |
594722a8 ER |
219 | "Obarray for per-file properties.") |
220 | ||
099bd78a SM |
221 | (defvar vc-touched-properties nil) |
222 | ||
594722a8 | 223 | (defun vc-file-setprop (file property value) |
0e0d9831 | 224 | "Set per-file VC PROPERTY for FILE to VALUE." |
099bd78a SM |
225 | (if (and vc-touched-properties |
226 | (not (memq property vc-touched-properties))) | |
227 | (setq vc-touched-properties (append (list property) | |
228 | vc-touched-properties))) | |
594722a8 ER |
229 | (put (intern file vc-file-prop-obarray) property value)) |
230 | ||
231 | (defun vc-file-getprop (file property) | |
099bd78a | 232 | "Get per-file VC PROPERTY for FILE." |
594722a8 ER |
233 | (get (intern file vc-file-prop-obarray) property)) |
234 | ||
e1c0c2d1 | 235 | (defun vc-file-clearprops (file) |
0e0d9831 | 236 | "Clear all VC properties of FILE." |
e1c0c2d1 | 237 | (setplist (intern file vc-file-prop-obarray) nil)) |
f2ee4191 | 238 | |
0e0d9831 GM |
239 | \f |
240 | ;; We keep properties on each symbol naming a backend as follows: | |
241 | ;; * `vc-functions': an alist mapping vc-FUNCTION to vc-BACKEND-FUNCTION. | |
242 | ||
243 | (defun vc-make-backend-sym (backend sym) | |
244 | "Return BACKEND-specific version of VC symbol SYM." | |
245 | (intern (concat "vc-" (downcase (symbol-name backend)) | |
246 | "-" (symbol-name sym)))) | |
247 | ||
248 | (defun vc-find-backend-function (backend fun) | |
249 | "Return BACKEND-specific implementation of FUN. | |
f8b72742 | 250 | If there is no such implementation, return the default implementation; |
0e0d9831 GM |
251 | if that doesn't exist either, return nil." |
252 | (let ((f (vc-make-backend-sym backend fun))) | |
253 | (if (fboundp f) f | |
254 | ;; Load vc-BACKEND.el if needed. | |
255 | (require (intern (concat "vc-" (downcase (symbol-name backend))))) | |
256 | (if (fboundp f) f | |
257 | (let ((def (vc-make-backend-sym 'default fun))) | |
258 | (if (fboundp def) (cons def backend) nil)))))) | |
259 | ||
260 | (defun vc-call-backend (backend function-name &rest args) | |
261 | "Call for BACKEND the implementation of FUNCTION-NAME with the given ARGS. | |
262 | Calls | |
263 | ||
264 | (apply 'vc-BACKEND-FUN ARGS) | |
265 | ||
266 | if vc-BACKEND-FUN exists (after trying to find it in vc-BACKEND.el) | |
267 | and else calls | |
268 | ||
269 | (apply 'vc-default-FUN BACKEND ARGS) | |
270 | ||
271 | It is usually called via the `vc-call' macro." | |
0bfb74a9 SM |
272 | (let ((f (assoc function-name (get backend 'vc-functions)))) |
273 | (if f (setq f (cdr f)) | |
0e0d9831 | 274 | (setq f (vc-find-backend-function backend function-name)) |
0bfb74a9 SM |
275 | (push (cons function-name f) (get backend 'vc-functions))) |
276 | (cond | |
277 | ((null f) | |
278 | (error "Sorry, %s is not implemented for %s" function-name backend)) | |
279 | ((consp f) (apply (car f) (cdr f) args)) | |
280 | (t (apply f args))))) | |
0e0d9831 GM |
281 | |
282 | (defmacro vc-call (fun file &rest args) | |
daffc81a JR |
283 | "A convenience macro for calling VC backend functions. |
284 | Functions called by this macro must accept FILE as the first argument. | |
285 | ARGS specifies any additional arguments. FUN should be unquoted. | |
286 | BEWARE!! `file' is evaluated twice!!" | |
0e0d9831 | 287 | `(vc-call-backend (vc-backend ,file) ',fun ,file ,@args)) |
0e0d9831 GM |
288 | \f |
289 | (defsubst vc-parse-buffer (pattern i) | |
290 | "Find PATTERN in the current buffer and return its Ith submatch." | |
291 | (goto-char (point-min)) | |
292 | (if (re-search-forward pattern nil t) | |
293 | (match-string i))) | |
e1c0c2d1 | 294 | |
02d383eb | 295 | (defun vc-insert-file (file &optional limit blocksize) |
0e0d9831 GM |
296 | "Insert the contents of FILE into the current buffer. |
297 | ||
298 | Optional argument LIMIT is a regexp. If present, the file is inserted | |
299 | in chunks of size BLOCKSIZE (default 8 kByte), until the first | |
f8b72742 | 300 | occurrence of LIMIT is found. Anything from the start of that occurrence |
e30140ce AS |
301 | to the end of the buffer is then deleted. The function returns |
302 | non-nil if FILE exists and its contents were successfully inserted." | |
07de4c3d | 303 | (erase-buffer) |
ff40374a AS |
304 | (when (file-exists-p file) |
305 | (if (not limit) | |
306 | (insert-file-contents file) | |
307 | (if (not blocksize) (setq blocksize 8192)) | |
4d2806e2 SM |
308 | (let ((filepos 0)) |
309 | (while | |
310 | (and (< 0 (cadr (insert-file-contents | |
311 | file nil filepos (incf filepos blocksize)))) | |
312 | (progn (beginning-of-line) | |
e30140ce AS |
313 | (let ((pos (re-search-forward limit nil 'move))) |
314 | (if pos (delete-region (match-beginning 0) | |
315 | (point-max))) | |
316 | (not pos))))))) | |
ff40374a AS |
317 | (set-buffer-modified-p nil) |
318 | t)) | |
02d383eb | 319 | |
ce9f8ffb SM |
320 | (defun vc-find-root (file witness) |
321 | "Find the root of a checked out project. | |
322 | The function walks up the directory tree from FILE looking for WITNESS. | |
323 | If WITNESS if not found, return nil, otherwise return the root." | |
43621386 SM |
324 | ;; Represent /home/luser/foo as ~/foo so that we don't try to look for |
325 | ;; witnesses in /home or in /. | |
3b27900d | 326 | (while (not (file-directory-p file)) |
66752bb4 | 327 | (setq file (file-name-directory (directory-file-name file)))) |
43621386 | 328 | (setq file (abbreviate-file-name file)) |
6e94b3b6 GM |
329 | (let ((root nil) |
330 | (user (nth 2 (file-attributes file)))) | |
ce9f8ffb | 331 | (while (not (or root |
3b27900d SM |
332 | (null file) |
333 | ;; As a heuristic, we stop looking up the hierarchy of | |
334 | ;; directories as soon as we find a directory belonging | |
335 | ;; to another user. This should save us from looking in | |
336 | ;; things like /net and /afs. This assumes that all the | |
337 | ;; files inside a project belong to the same user. | |
338 | (not (equal user (nth 2 (file-attributes file)))) | |
339 | (string-match vc-ignore-dir-regexp file))) | |
ce9f8ffb | 340 | (if (file-exists-p (expand-file-name witness file)) |
3b27900d SM |
341 | (setq root file) |
342 | (if (equal file | |
343 | (setq file (file-name-directory (directory-file-name file)))) | |
344 | (setq file nil)))) | |
ce9f8ffb SM |
345 | root)) |
346 | ||
14fef9de SM |
347 | ;; Access functions to file properties |
348 | ;; (Properties should be _set_ using vc-file-setprop, but | |
349 | ;; _retrieved_ only through these functions, which decide | |
350 | ;; if the property is already known or not. A property should | |
351 | ;; only be retrieved by vc-file-getprop if there is no | |
352 | ;; access function.) | |
02d383eb | 353 | |
14fef9de | 354 | ;; properties indicating the backend being used for FILE |
e1c0c2d1 | 355 | |
0e0d9831 GM |
356 | (defun vc-registered (file) |
357 | "Return non-nil if FILE is registered in a version control system. | |
358 | ||
1f22ad24 AS |
359 | This function performs the check each time it is called. To rely |
360 | on the result of a previous call, use `vc-backend' instead. If the | |
361 | file was previously registered under a certain backend, then that | |
362 | backend is tried first." | |
0e0d9831 | 363 | (let (handler) |
ce9f8ffb SM |
364 | (cond |
365 | ((string-match vc-ignore-dir-regexp (file-name-directory file)) nil) | |
366 | ((and (boundp 'file-name-handler-alist) | |
367 | (setq handler (find-file-name-handler file 'vc-registered))) | |
368 | ;; handler should set vc-backend and return t if registered | |
369 | (funcall handler 'vc-registered file)) | |
370 | (t | |
0e0d9831 GM |
371 | ;; There is no file name handler. |
372 | ;; Try vc-BACKEND-registered for each handled BACKEND. | |
373 | (catch 'found | |
1f22ad24 | 374 | (let ((backend (vc-file-getprop file 'vc-backend))) |
a549ce70 | 375 | (mapc |
1f22ad24 AS |
376 | (lambda (b) |
377 | (and (vc-call-backend b 'registered file) | |
378 | (vc-file-setprop file 'vc-backend b) | |
379 | (throw 'found t))) | |
f8b72742 | 380 | (if (or (not backend) (eq backend 'none)) |
1f22ad24 AS |
381 | vc-handled-backends |
382 | (cons backend vc-handled-backends)))) | |
0e0d9831 GM |
383 | ;; File is not registered. |
384 | (vc-file-setprop file 'vc-backend 'none) | |
ce9f8ffb | 385 | nil))))) |
0e0d9831 | 386 | |
e4d26892 ER |
387 | (defun vc-backend (file-or-list) |
388 | "Return the version control type of FILE-OR-LIST, nil if it's not registered. | |
389 | If the argument is a list, the files must all have the same back end." | |
0e0d9831 | 390 | ;; `file' can be nil in several places (typically due to the use of |
5232a436 | 391 | ;; code like (vc-backend buffer-file-name)). |
e4d26892 ER |
392 | (cond ((stringp file-or-list) |
393 | (let ((property (vc-file-getprop file-or-list 'vc-backend))) | |
394 | ;; Note that internally, Emacs remembers unregistered | |
395 | ;; files by setting the property to `none'. | |
396 | (cond ((eq property 'none) nil) | |
397 | (property) | |
398 | ;; vc-registered sets the vc-backend property | |
399 | (t (if (vc-registered file-or-list) | |
400 | (vc-file-getprop file-or-list 'vc-backend) | |
401 | nil))))) | |
402 | ((and file-or-list (listp file-or-list)) | |
403 | (vc-backend (car file-or-list))) | |
404 | (t | |
405 | nil))) | |
406 | ||
0e0d9831 GM |
407 | |
408 | (defun vc-backend-subdirectory-name (file) | |
409 | "Return where the master and lock FILEs for the current directory are kept." | |
410 | (symbol-name (vc-backend file))) | |
e1c0c2d1 | 411 | |
02d383eb | 412 | (defun vc-name (file) |
5eb2b516 DL |
413 | "Return the master name of FILE. |
414 | If the file is not registered, or the master name is not known, return nil." | |
415 | ;; TODO: This should ultimately become obsolete, at least up here | |
0e0d9831 | 416 | ;; in vc-hooks. |
02d383eb | 417 | (or (vc-file-getprop file 'vc-name) |
64341022 AS |
418 | ;; force computation of the property by calling |
419 | ;; vc-BACKEND-registered explicitly | |
420 | (if (and (vc-backend file) | |
421 | (vc-call-backend (vc-backend file) 'registered file)) | |
8aa81ea8 | 422 | (vc-file-getprop file 'vc-name)))) |
e1c0c2d1 | 423 | |
04446ed0 | 424 | (defun vc-checkout-model (file) |
0e0d9831 GM |
425 | "Indicate how FILE is checked out. |
426 | ||
cb5af02a AS |
427 | If FILE is not registered, this function always returns nil. |
428 | For registered files, the possible values are: | |
0e0d9831 | 429 | |
cb5af02a | 430 | 'implicit FILE is always writeable, and checked out `implicitly' |
0e0d9831 GM |
431 | when the user saves the first changes to the file. |
432 | ||
cb5af02a | 433 | 'locking FILE is read-only if up-to-date; user must type |
db8afaee | 434 | \\[vc-next-action] before editing. Strict locking |
0e0d9831 GM |
435 | is assumed. |
436 | ||
cb5af02a | 437 | 'announce FILE is read-only if up-to-date; user must type |
db8afaee | 438 | \\[vc-next-action] before editing. But other users |
0e0d9831 GM |
439 | may be editing at the same time." |
440 | (or (vc-file-getprop file 'vc-checkout-model) | |
cb5af02a AS |
441 | (if (vc-backend file) |
442 | (vc-file-setprop file 'vc-checkout-model | |
443 | (vc-call checkout-model file))))) | |
7064821c | 444 | |
8d2b9c1a AS |
445 | (defun vc-user-login-name (file) |
446 | "Return the name under which the user accesses the given FILE." | |
447 | (or (and (eq (string-match tramp-file-name-regexp file) 0) | |
448 | ;; tramp case: execute "whoami" via tramp | |
449 | (let ((default-directory (file-name-directory file))) | |
450 | (with-temp-buffer | |
451 | (if (not (zerop (process-file "whoami" nil t))) | |
452 | ;; fall through if "whoami" didn't work | |
453 | nil | |
454 | ;; remove trailing newline | |
455 | (delete-region (1- (point-max)) (point-max)) | |
456 | (buffer-string))))) | |
457 | ;; normal case | |
458 | (user-login-name) | |
459 | ;; if user-login-name is nil, return the UID as a string | |
460 | (number-to-string (user-uid)))) | |
0e0d9831 GM |
461 | |
462 | (defun vc-state (file) | |
463 | "Return the version control state of FILE. | |
464 | ||
cb5af02a AS |
465 | If FILE is not registered, this function always returns nil. |
466 | For registered files, the value returned is one of: | |
0e0d9831 GM |
467 | |
468 | 'up-to-date The working file is unmodified with respect to the | |
469 | latest version on the current branch, and not locked. | |
470 | ||
471 | 'edited The working file has been edited by the user. If | |
472 | locking is used for the file, this state means that | |
473 | the current version is locked by the calling user. | |
474 | ||
475 | USER The current version of the working file is locked by | |
476 | some other USER (a string). | |
f8b72742 | 477 | |
0e0d9831 GM |
478 | 'needs-patch The file has not been edited by the user, but there is |
479 | a more recent version on the current branch stored | |
480 | in the master file. | |
481 | ||
482 | 'needs-merge The file has been edited by the user, and there is also | |
483 | a more recent version on the current branch stored in | |
484 | the master file. This state can only occur if locking | |
485 | is not used for the file. | |
486 | ||
487 | 'unlocked-changes The current version of the working file is not locked, | |
488 | but the working file has been changed with respect | |
489 | to that version. This state can only occur for files | |
490 | with locking; it represents an erroneous condition that | |
491 | should be resolved by the user (vc-next-action will | |
492 | prompt the user to do it)." | |
2a3897f5 SM |
493 | ;; FIXME: New (sub)states needed (?): |
494 | ;; - `added' (i.e. `edited' but with no base version yet, | |
495 | ;; typically represented by vc-workfile-version = "0") | |
496 | ;; - `conflict' (i.e. `edited' with conflict markers) | |
497 | ;; - `removed' | |
498 | ;; - `copied' and `moved' (might be handled by `removed' and `added') | |
0e0d9831 | 499 | (or (vc-file-getprop file 'vc-state) |
e4d26892 | 500 | (if (and (> (length file) 0) (vc-backend file)) |
cb5af02a AS |
501 | (vc-file-setprop file 'vc-state |
502 | (vc-call state-heuristic file))))) | |
0e0d9831 | 503 | |
588c1bf9 AS |
504 | (defun vc-recompute-state (file) |
505 | "Recompute the version control state of FILE, and return it. | |
506 | This calls the possibly expensive function vc-BACKEND-state, | |
507 | rather than the heuristic." | |
508 | (vc-file-setprop file 'vc-state (vc-call state file))) | |
509 | ||
0e0d9831 GM |
510 | (defsubst vc-up-to-date-p (file) |
511 | "Convenience function that checks whether `vc-state' of FILE is `up-to-date'." | |
512 | (eq (vc-state file) 'up-to-date)) | |
513 | ||
514 | (defun vc-default-state-heuristic (backend file) | |
5eb2b516 DL |
515 | "Default implementation of vc-state-heuristic. |
516 | It simply calls the real state computation function `vc-BACKEND-state' | |
517 | and does not employ any heuristic at all." | |
0e0d9831 | 518 | (vc-call-backend backend 'state file)) |
1efcbf46 | 519 | |
e767004f AS |
520 | (defun vc-workfile-unchanged-p (file) |
521 | "Return non-nil if FILE has not changed since the last checkout." | |
522 | (let ((checkout-time (vc-file-getprop file 'vc-checkout-time)) | |
523 | (lastmod (nth 5 (file-attributes file)))) | |
04e77778 AS |
524 | (if (and checkout-time |
525 | ;; Tramp and Ange-FTP return this when they don't know the time. | |
526 | (not (equal lastmod '(0 0)))) | |
e767004f AS |
527 | (equal checkout-time lastmod) |
528 | (let ((unchanged (vc-call workfile-unchanged-p file))) | |
529 | (vc-file-setprop file 'vc-checkout-time (if unchanged lastmod 0)) | |
530 | unchanged)))) | |
531 | ||
532 | (defun vc-default-workfile-unchanged-p (backend file) | |
533 | "Check if FILE is unchanged by diffing against the master version. | |
534 | Return non-nil if FILE is unchanged." | |
f8836381 | 535 | (zerop (condition-case err |
4392edab AS |
536 | ;; If the implementation supports it, let the output |
537 | ;; go to *vc*, not *vc-diff*, since this is an internal call. | |
c0edfa75 | 538 | (vc-call diff (list file) nil nil "*vc*") |
f8836381 AS |
539 | (wrong-number-of-arguments |
540 | ;; If this error came from the above call to vc-BACKEND-diff, | |
541 | ;; try again without the optional buffer argument (for | |
542 | ;; backward compatibility). Otherwise, resignal. | |
543 | (if (or (not (eq (cadr err) | |
544 | (indirect-function | |
545 | (vc-find-backend-function (vc-backend file) | |
546 | 'diff)))) | |
0d2ce4ef JB |
547 | (not (eq (caddr err) 4))) |
548 | (signal (car err) (cdr err)) | |
c0edfa75 | 549 | (vc-call diff (list file))))))) |
e767004f | 550 | |
e1c0c2d1 | 551 | (defun vc-workfile-version (file) |
e4d26892 | 552 | "Return the repository version from which FILE was checked out. |
cb5af02a | 553 | If FILE is not registered, this function always returns nil." |
0e0d9831 | 554 | (or (vc-file-getprop file 'vc-workfile-version) |
cb5af02a AS |
555 | (if (vc-backend file) |
556 | (vc-file-setprop file 'vc-workfile-version | |
557 | (vc-call workfile-version file))))) | |
f2ee4191 | 558 | |
0e0d9831 GM |
559 | (defun vc-default-registered (backend file) |
560 | "Check if FILE is registered in BACKEND using vc-BACKEND-master-templates." | |
561 | (let ((sym (vc-make-backend-sym backend 'master-templates))) | |
562 | (unless (get backend 'vc-templates-grabbed) | |
563 | (put backend 'vc-templates-grabbed t) | |
564 | (set sym (append (delq nil | |
565 | (mapcar | |
566 | (lambda (template) | |
567 | (and (consp template) | |
568 | (eq (cdr template) backend) | |
569 | (car template))) | |
3756d481 AS |
570 | (with-no-warnings |
571 | vc-master-templates))) | |
0e0d9831 GM |
572 | (symbol-value sym)))) |
573 | (let ((result (vc-check-master-templates file (symbol-value sym)))) | |
574 | (if (stringp result) | |
575 | (vc-file-setprop file 'vc-name result) | |
576 | nil)))) ; Not registered | |
577 | ||
578 | (defun vc-possible-master (s dirname basename) | |
579 | (cond | |
580 | ((stringp s) (format s dirname basename)) | |
581 | ((functionp s) | |
582 | ;; The template is a function to invoke. If the | |
583 | ;; function returns non-nil, that means it has found a | |
584 | ;; master. For backward compatibility, we also handle | |
585 | ;; the case that the function throws a 'found atom | |
586 | ;; and a pair (cons MASTER-FILE BACKEND). | |
587 | (let ((result (catch 'found (funcall s dirname basename)))) | |
588 | (if (consp result) (car result) result))))) | |
589 | ||
590 | (defun vc-check-master-templates (file templates) | |
cb5af02a | 591 | "Return non-nil if there is a master corresponding to FILE. |
0e0d9831 GM |
592 | |
593 | TEMPLATES is a list of strings or functions. If an element is a | |
594 | string, it must be a control string as required by `format', with two | |
595 | string placeholders, such as \"%sRCS/%s,v\". The directory part of | |
596 | FILE is substituted for the first placeholder, the basename of FILE | |
597 | for the second. If a file with the resulting name exists, it is taken | |
598 | as the master of FILE, and returned. | |
599 | ||
600 | If an element of TEMPLATES is a function, it is called with the | |
601 | directory part and the basename of FILE as arguments. It should | |
602 | return non-nil if it finds a master; that value is then returned by | |
603 | this function." | |
604 | (let ((dirname (or (file-name-directory file) "")) | |
605 | (basename (file-name-nondirectory file))) | |
606 | (catch 'found | |
5eb2b516 | 607 | (mapcar |
0e0d9831 GM |
608 | (lambda (s) |
609 | (let ((trial (vc-possible-master s dirname basename))) | |
610 | (if (and trial (file-exists-p trial) | |
611 | ;; Make sure the file we found with name | |
612 | ;; TRIAL is not the source file itself. | |
613 | ;; That can happen with RCS-style names if | |
614 | ;; the file name is truncated (e.g. to 14 | |
615 | ;; chars). See if either directory or | |
616 | ;; attributes differ. | |
617 | (or (not (string= dirname | |
618 | (file-name-directory trial))) | |
619 | (not (equal (file-attributes file) | |
620 | (file-attributes trial))))) | |
621 | (throw 'found trial)))) | |
622 | templates)))) | |
f2ee4191 | 623 | |
c844616c | 624 | (defun vc-toggle-read-only (&optional verbose) |
c43e436c | 625 | "Change read-only status of current buffer, perhaps via version control. |
db8afaee | 626 | |
c43e436c RS |
627 | If the buffer is visiting a file registered with version control, |
628 | then check the file in or out. Otherwise, just change the read-only flag | |
ec44193a KH |
629 | of the buffer. |
630 | With prefix argument, ask for version number to check in or check out. | |
631 | Check-out of a specified version number does not lock the file; | |
db8afaee AS |
632 | to do that, use this command a second time with no argument. |
633 | ||
634 | If you bind this function to \\[toggle-read-only], then Emacs checks files | |
635 | in or out whenever you toggle the read-only flag." | |
c844616c | 636 | (interactive "P") |
702220f3 | 637 | (if (or (and (boundp 'vc-dired-mode) vc-dired-mode) |
0e0d9831 | 638 | ;; use boundp because vc.el might not be loaded |
5232a436 | 639 | (vc-backend buffer-file-name)) |
c844616c | 640 | (vc-next-action verbose) |
594722a8 ER |
641 | (toggle-read-only))) |
642 | ||
e896a9e1 | 643 | (defun vc-default-make-version-backups-p (backend file) |
cb5af02a | 644 | "Return non-nil if unmodified versions should be backed up locally. |
9aa10a43 | 645 | The default is to switch off this feature." |
d445a975 AS |
646 | nil) |
647 | ||
e896a9e1 AS |
648 | (defun vc-version-backup-file-name (file &optional rev manual regexp) |
649 | "Return a backup file name for REV or the current version of FILE. | |
650 | If MANUAL is non-nil it means that a name for backups created by | |
651 | the user should be returned; if REGEXP is non-nil that means to return | |
652 | a regexp for matching all such backup files, regardless of the version." | |
e3f955b6 AS |
653 | (if regexp |
654 | (concat (regexp-quote (file-name-nondirectory file)) | |
d4c813e9 | 655 | "\\.~.+" (unless manual "\\.") "~") |
f8b72742 | 656 | (expand-file-name (concat (file-name-nondirectory file) |
d4c813e9 SM |
657 | ".~" (subst-char-in-string |
658 | ?/ ?_ (or rev (vc-workfile-version file))) | |
e3f955b6 AS |
659 | (unless manual ".") "~") |
660 | (file-name-directory file)))) | |
e896a9e1 AS |
661 | |
662 | (defun vc-delete-automatic-version-backups (file) | |
663 | "Delete all existing automatic version backups for FILE." | |
d455f4f7 | 664 | (condition-case nil |
a549ce70 | 665 | (mapc |
d455f4f7 | 666 | 'delete-file |
79e954d0 | 667 | (directory-files (or (file-name-directory file) default-directory) t |
d455f4f7 SM |
668 | (vc-version-backup-file-name file nil nil t))) |
669 | ;; Don't fail when the directory doesn't exist. | |
670 | (file-error nil))) | |
e896a9e1 AS |
671 | |
672 | (defun vc-make-version-backup (file) | |
673 | "Make a backup copy of FILE, which is assumed in sync with the repository. | |
674 | Before doing that, check if there are any old backups and get rid of them." | |
48b15d3f | 675 | (unless (and (fboundp 'msdos-long-file-names) |
ee9be3de | 676 | (not (with-no-warnings (msdos-long-file-names)))) |
48b15d3f | 677 | (vc-delete-automatic-version-backups file) |
27707243 AS |
678 | (condition-case nil |
679 | (copy-file file (vc-version-backup-file-name file) | |
680 | nil 'keep-date) | |
681 | ;; It's ok if it doesn't work (e.g. directory not writable), | |
682 | ;; since this is just for efficiency. | |
bf247b6e | 683 | (file-error |
27707243 AS |
684 | (message |
685 | (concat "Warning: Cannot make version backup; " | |
686 | "diff/revert therefore not local")))))) | |
d445a975 AS |
687 | |
688 | (defun vc-before-save () | |
689 | "Function to be called by `basic-save-buffer' (in files.el)." | |
690 | ;; If the file on disk is still in sync with the repository, | |
691 | ;; and version backups should be made, copy the file to | |
692 | ;; another name. This enables local diffs and local reverting. | |
5232a436 | 693 | (let ((file buffer-file-name)) |
d445a975 AS |
694 | (and (vc-backend file) |
695 | (vc-up-to-date-p file) | |
696 | (eq (vc-checkout-model file) 'implicit) | |
e896a9e1 AS |
697 | (vc-call make-version-backups-p file) |
698 | (vc-make-version-backup file)))) | |
d445a975 | 699 | |
e66eac08 | 700 | (defun vc-after-save () |
0e0d9831 | 701 | "Function to be called by `basic-save-buffer' (in files.el)." |
5eb2b516 | 702 | ;; If the file in the current buffer is under version control, |
0e0d9831 GM |
703 | ;; up-to-date, and locking is not used for the file, set |
704 | ;; the state to 'edited and redisplay the mode line. | |
5232a436 | 705 | (let ((file buffer-file-name)) |
8aa81ea8 | 706 | (and (vc-backend file) |
b23a2306 AS |
707 | (or (and (equal (vc-file-getprop file 'vc-checkout-time) |
708 | (nth 5 (file-attributes file))) | |
709 | ;; File has been saved in the same second in which | |
710 | ;; it was checked out. Clear the checkout-time | |
711 | ;; to avoid confusion. | |
712 | (vc-file-setprop file 'vc-checkout-time nil)) | |
713 | t) | |
0e0d9831 GM |
714 | (vc-up-to-date-p file) |
715 | (eq (vc-checkout-model file) 'implicit) | |
716 | (vc-file-setprop file 'vc-state 'edited) | |
717 | (vc-mode-line file) | |
099bd78a SM |
718 | (if (featurep 'vc) |
719 | ;; If VC is not loaded, then there can't be | |
720 | ;; any VC Dired buffer to synchronize. | |
721 | (vc-dired-resynch-file file))))) | |
04446ed0 | 722 | |
e2247dc8 SM |
723 | (defvar vc-menu-entry |
724 | '(menu-item "Version Control" vc-menu-map | |
725 | :filter vc-menu-map-filter)) | |
726 | ||
727 | (when (boundp 'menu-bar-tools-menu) | |
728 | ;; We do not need to worry here about the placement of this entry | |
729 | ;; because menu-bar.el has already created the proper spot for us | |
730 | ;; and this will simply use it. | |
731 | (define-key menu-bar-tools-menu [vc] vc-menu-entry)) | |
732 | ||
5719a098 SM |
733 | (defconst vc-mode-line-map |
734 | (let ((map (make-sparse-keymap))) | |
e2247dc8 | 735 | (define-key map [mode-line down-mouse-1] vc-menu-entry) |
5719a098 SM |
736 | map)) |
737 | ||
0e0d9831 | 738 | (defun vc-mode-line (file) |
7bc2b98b | 739 | "Set `vc-mode' to display type of version control for FILE. |
594722a8 | 740 | The value is set in the current buffer, which should be the buffer |
0e0d9831 | 741 | visiting FILE." |
67c6f446 | 742 | (interactive (list buffer-file-name)) |
5719a098 | 743 | (let ((backend (vc-backend file))) |
5232a436 SM |
744 | (if (not backend) |
745 | (setq vc-mode nil) | |
5719a098 SM |
746 | (let* ((ml-string (vc-call mode-line-string file)) |
747 | (ml-echo (get-text-property 0 'help-echo ml-string))) | |
748 | (setq vc-mode | |
749 | (concat | |
750 | " " | |
751 | (if (null vc-display-status) | |
752 | (symbol-name backend) | |
753 | (propertize | |
754 | ml-string | |
755 | 'mouse-face 'mode-line-highlight | |
756 | 'help-echo | |
757 | (concat (or ml-echo | |
758 | (format "File under the %s version control system" | |
759 | backend)) | |
760 | "\nmouse-1: Version Control menu") | |
761 | 'local-map vc-mode-line-map))))) | |
5232a436 SM |
762 | ;; If the file is locked by some other user, make |
763 | ;; the buffer read-only. Like this, even root | |
764 | ;; cannot modify a file that someone else has locked. | |
765 | (and (equal file buffer-file-name) | |
766 | (stringp (vc-state file)) | |
767 | (setq buffer-read-only t)) | |
768 | ;; If the user is root, and the file is not owner-writable, | |
769 | ;; then pretend that we can't write it | |
770 | ;; even though we can (because root can write anything). | |
2a3897f5 SM |
771 | ;; This way, even root cannot modify a file that isn't locked. |
772 | (and (equal file buffer-file-name) | |
773 | (not buffer-read-only) | |
5232a436 SM |
774 | (zerop (user-real-uid)) |
775 | (zerop (logand (file-modes buffer-file-name) 128)) | |
776 | (setq buffer-read-only t))) | |
777 | (force-mode-line-update) | |
778 | backend)) | |
0e0d9831 GM |
779 | |
780 | (defun vc-default-mode-line-string (backend file) | |
781 | "Return string for placement in modeline by `vc-mode-line' for FILE. | |
782 | Format: | |
783 | ||
784 | \"BACKEND-REV\" if the file is up-to-date | |
785 | \"BACKEND:REV\" if the file is edited (or locked by the calling user) | |
786 | \"BACKEND:LOCKER:REV\" if the file is locked by somebody else | |
0e0d9831 GM |
787 | |
788 | This function assumes that the file is registered." | |
789 | (setq backend (symbol-name backend)) | |
790 | (let ((state (vc-state file)) | |
82c4728d | 791 | (state-echo nil) |
0e0d9831 | 792 | (rev (vc-workfile-version file))) |
82c4728d DN |
793 | (propertize |
794 | (cond ((or (eq state 'up-to-date) | |
795 | (eq state 'needs-patch)) | |
796 | (setq state-echo "Up to date file") | |
797 | (concat backend "-" rev)) | |
798 | ((stringp state) | |
799 | (setq state-echo (concat "File locked by" state)) | |
800 | (concat backend ":" state ":" rev)) | |
801 | (t | |
802 | ;; Not just for the 'edited state, but also a fallback | |
803 | ;; for all other states. Think about different symbols | |
804 | ;; for 'needs-patch and 'needs-merge. | |
3a12f9f8 | 805 | (setq state-echo "Locally modified file") |
82c4728d | 806 | (concat backend ":" rev))) |
33e0847d | 807 | 'help-echo (concat state-echo " under the " backend |
3a12f9f8 | 808 | " version control system")))) |
f2ee4191 | 809 | |
a3a39848 | 810 | (defun vc-follow-link () |
0e0d9831 GM |
811 | "If current buffer visits a symbolic link, visit the real file. |
812 | If the real file is already visited in another buffer, make that buffer | |
813 | current, and kill the buffer that visits the link." | |
566f2169 | 814 | (let* ((truename (abbreviate-file-name (file-chase-links buffer-file-name))) |
e7f5ddc2 RS |
815 | (true-buffer (find-buffer-visiting truename)) |
816 | (this-buffer (current-buffer))) | |
817 | (if (eq true-buffer this-buffer) | |
818 | (progn | |
d8221951 | 819 | (kill-buffer this-buffer) |
e7f5ddc2 RS |
820 | ;; In principle, we could do something like set-visited-file-name. |
821 | ;; However, it can't be exactly the same as set-visited-file-name. | |
822 | ;; I'm not going to work out the details right now. -- rms. | |
d8221951 | 823 | (set-buffer (find-file-noselect truename))) |
e7f5ddc2 RS |
824 | (set-buffer true-buffer) |
825 | (kill-buffer this-buffer)))) | |
a3a39848 | 826 | |
b8d1db77 SM |
827 | (defun vc-default-find-file-hook (backend) |
828 | nil) | |
829 | ||
594722a8 | 830 | (defun vc-find-file-hook () |
be4d6a6f | 831 | "Function for `find-file-hook' activating VC mode if appropriate." |
18c8a18e PE |
832 | ;; Recompute whether file is version controlled, |
833 | ;; if user has killed the buffer and revisited. | |
060a1456 AS |
834 | (if vc-mode |
835 | (setq vc-mode nil)) | |
0e0d9831 | 836 | (when buffer-file-name |
f2ee4191 RS |
837 | (vc-file-clearprops buffer-file-name) |
838 | (cond | |
fc8b8d0f | 839 | ((with-demoted-errors (vc-backend buffer-file-name)) |
0bfb74a9 | 840 | ;; Compute the state and put it in the modeline. |
f2ee4191 | 841 | (vc-mode-line buffer-file-name) |
0bfb74a9 SM |
842 | (unless vc-make-backup-files |
843 | ;; Use this variable, not make-backup-files, | |
844 | ;; because this is for things that depend on the file name. | |
b8d1db77 SM |
845 | (set (make-local-variable 'backup-inhibited) t)) |
846 | ;; Let the backend setup any buffer-local things he needs. | |
847 | (vc-call-backend (vc-backend buffer-file-name) 'find-file-hook)) | |
4d11f532 SM |
848 | ((let ((link-type (and (file-symlink-p buffer-file-name) |
849 | (vc-backend (file-chase-links buffer-file-name))))) | |
0bfb74a9 SM |
850 | (cond ((not link-type) nil) ;Nothing to do. |
851 | ((eq vc-follow-symlinks nil) | |
852 | (message | |
b8063212 | 853 | "Warning: symbolic link to %s-controlled source file" link-type)) |
0bfb74a9 SM |
854 | ((or (not (eq vc-follow-symlinks 'ask)) |
855 | ;; If we already visited this file by following | |
856 | ;; the link, don't ask again if we try to visit | |
857 | ;; it again. GUD does that, and repeated questions | |
858 | ;; are painful. | |
859 | (get-file-buffer | |
860 | (abbreviate-file-name | |
861 | (file-chase-links buffer-file-name)))) | |
862 | ||
863 | (vc-follow-link) | |
864 | (message "Followed link to %s" buffer-file-name) | |
865 | (vc-find-file-hook)) | |
866 | (t | |
867 | (if (yes-or-no-p (format | |
b8063212 | 868 | "Symbolic link to %s-controlled source file; follow link? " link-type)) |
0bfb74a9 SM |
869 | (progn (vc-follow-link) |
870 | (message "Followed link to %s" buffer-file-name) | |
871 | (vc-find-file-hook)) | |
872 | (message | |
b8063212 | 873 | "Warning: editing through the link bypasses version control") |
0bfb74a9 | 874 | )))))))) |
594722a8 | 875 | |
be4d6a6f | 876 | (add-hook 'find-file-hook 'vc-find-file-hook) |
594722a8 | 877 | |
14fef9de | 878 | ;; more hooks, this time for file-not-found |
594722a8 | 879 | (defun vc-file-not-found-hook () |
0e0d9831 GM |
880 | "When file is not found, try to check it out from version control. |
881 | Returns t if checkout was successful, nil otherwise. | |
d3d558a9 | 882 | Used in `find-file-not-found-functions'." |
5f42a1d4 RS |
883 | ;; When a file does not exist, ignore cached info about it |
884 | ;; from a previous visit. | |
885 | (vc-file-clearprops buffer-file-name) | |
4a330ab7 | 886 | (let ((backend (vc-backend buffer-file-name))) |
1e87be1b | 887 | (if backend (vc-call-backend backend 'find-file-not-found-hook)))) |
4a330ab7 SM |
888 | |
889 | (defun vc-default-find-file-not-found-hook (backend) | |
a3773730 SM |
890 | ;; This used to do what vc-rcs-find-file-not-found-hook does, but it only |
891 | ;; really makes sense for RCS. For other backends, better not do anything. | |
892 | nil) | |
594722a8 | 893 | |
3756d481 | 894 | (add-hook 'find-file-not-found-functions 'vc-file-not-found-hook) |
594722a8 | 895 | |
f2ee4191 | 896 | (defun vc-kill-buffer-hook () |
0e0d9831 | 897 | "Discard VC info about a file when we kill its buffer." |
5232a436 SM |
898 | (if buffer-file-name |
899 | (vc-file-clearprops buffer-file-name))) | |
f2ee4191 | 900 | |
cd32d5d1 | 901 | (add-hook 'kill-buffer-hook 'vc-kill-buffer-hook) |
f2ee4191 | 902 | |
14fef9de SM |
903 | ;; Now arrange for (autoloaded) bindings of the main package. |
904 | ;; Bindings for this have to go in the global map, as we'll often | |
905 | ;; want to call them from random buffers. | |
906 | ||
907 | ;; Autoloading works fine, but it prevents shortcuts from appearing | |
908 | ;; in the menu because they don't exist yet when the menu is built. | |
909 | ;; (autoload 'vc-prefix-map "vc" nil nil 'keymap) | |
910 | (defvar vc-prefix-map | |
911 | (let ((map (make-sparse-keymap))) | |
912 | (define-key map "a" 'vc-update-change-log) | |
913 | (define-key map "b" 'vc-switch-backend) | |
e4d26892 | 914 | (define-key map "c" 'vc-rollback) |
14fef9de SM |
915 | (define-key map "d" 'vc-directory) |
916 | (define-key map "g" 'vc-annotate) | |
917 | (define-key map "h" 'vc-insert-headers) | |
918 | (define-key map "i" 'vc-register) | |
919 | (define-key map "l" 'vc-print-log) | |
920 | (define-key map "m" 'vc-merge) | |
921 | (define-key map "r" 'vc-retrieve-snapshot) | |
922 | (define-key map "s" 'vc-create-snapshot) | |
e4d26892 | 923 | (define-key map "u" 'vc-revert) |
14fef9de | 924 | (define-key map "v" 'vc-next-action) |
e4d26892 | 925 | (define-key map "+" 'vc-update) |
14fef9de SM |
926 | (define-key map "=" 'vc-diff) |
927 | (define-key map "~" 'vc-version-other-window) | |
928 | map)) | |
929 | (fset 'vc-prefix-map vc-prefix-map) | |
0e0d9831 | 930 | (define-key global-map "\C-xv" 'vc-prefix-map) |
624c0e9d | 931 | |
e2247dc8 SM |
932 | (defvar vc-menu-map |
933 | (let ((map (make-sparse-keymap "Version Control"))) | |
934 | ;;(define-key map [show-files] | |
935 | ;; '("Show Files under VC" . (vc-directory t))) | |
936 | (define-key map [vc-retrieve-snapshot] | |
937 | '("Retrieve Snapshot" . vc-retrieve-snapshot)) | |
938 | (define-key map [vc-create-snapshot] | |
939 | '("Create Snapshot" . vc-create-snapshot)) | |
940 | (define-key map [vc-directory] '("VC Directory Listing" . vc-directory)) | |
941 | (define-key map [separator1] '("----")) | |
942 | (define-key map [vc-annotate] '("Annotate" . vc-annotate)) | |
943 | (define-key map [vc-rename-file] '("Rename File" . vc-rename-file)) | |
944 | (define-key map [vc-version-other-window] | |
945 | '("Show Other Version" . vc-version-other-window)) | |
946 | (define-key map [vc-diff] '("Compare with Base Version" . vc-diff)) | |
947 | (define-key map [vc-update-change-log] | |
948 | '("Update ChangeLog" . vc-update-change-log)) | |
949 | (define-key map [vc-print-log] '("Show History" . vc-print-log)) | |
950 | (define-key map [separator2] '("----")) | |
951 | (define-key map [vc-insert-header] | |
952 | '("Insert Header" . vc-insert-headers)) | |
953 | (define-key map [undo] '("Undo Last Check-In" . vc-rollback)) | |
954 | (define-key map [vc-revert] | |
955 | '("Revert to Base Version" . vc-revert)) | |
956 | (define-key map [vc-update] | |
957 | '("Update to Latest Version" . vc-update)) | |
958 | (define-key map [vc-next-action] '("Check In/Out" . vc-next-action)) | |
959 | (define-key map [vc-register] '("Register" . vc-register)) | |
960 | map)) | |
961 | ||
962 | (defalias 'vc-menu-map vc-menu-map) | |
963 | ||
964 | (defun vc-menu-map-filter (orig-binding) | |
965 | (if (and (symbolp orig-binding) (fboundp orig-binding)) | |
966 | (setq orig-binding (indirect-function orig-binding))) | |
967 | (let ((ext-binding | |
4d2f172b JR |
968 | (if vc-mode (vc-call-backend (vc-backend buffer-file-name) |
969 | 'extra-menu)))) | |
e2247dc8 SM |
970 | ;; Give the VC backend a chance to add menu entries |
971 | ;; specific for that backend. | |
972 | (if (null ext-binding) | |
98481bad | 973 | orig-binding |
e2247dc8 SM |
974 | (append orig-binding |
975 | '((ext-menu-separator "---")) | |
98481bad | 976 | ext-binding)))) |
738efc8e | 977 | |
cb223bba DN |
978 | (defun vc-default-extra-menu (backend) |
979 | nil) | |
980 | ||
14fef9de SM |
981 | ;; These are not correct and it's not currently clear how doing it |
982 | ;; better (with more complicated expressions) might slow things down | |
983 | ;; on older systems. | |
984 | ||
985 | ;;(put 'vc-rename-file 'menu-enable 'vc-mode) | |
986 | ;;(put 'vc-annotate 'menu-enable '(eq (vc-buffer-backend) 'CVS)) | |
987 | ;;(put 'vc-version-other-window 'menu-enable 'vc-mode) | |
988 | ;;(put 'vc-diff 'menu-enable 'vc-mode) | |
989 | ;;(put 'vc-update-change-log 'menu-enable | |
990 | ;; '(member (vc-buffer-backend) '(RCS CVS))) | |
991 | ;;(put 'vc-print-log 'menu-enable 'vc-mode) | |
e4d26892 ER |
992 | ;;(put 'vc-rollback 'menu-enable 'vc-mode) |
993 | ;;(put 'vc-revert 'menu-enable 'vc-mode) | |
14fef9de SM |
994 | ;;(put 'vc-insert-headers 'menu-enable 'vc-mode) |
995 | ;;(put 'vc-next-action 'menu-enable 'vc-mode) | |
996 | ;;(put 'vc-register 'menu-enable '(and buffer-file-name (not vc-mode))) | |
594722a8 | 997 | |
594722a8 ER |
998 | (provide 'vc-hooks) |
999 | ||
ce9f8ffb | 1000 | ;; arch-tag: 2e5a6fa7-1d30-48e2-8bd0-e3d335f04f32 |
594722a8 | 1001 | ;;; vc-hooks.el ends here |