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