Commit | Line | Data |
---|---|---|
594722a8 ER |
1 | ;;; vc.el --- drive a version-control system from within Emacs |
2 | ||
0101cc40 | 3 | ;; Copyright (C) 1992, 93, 94, 95, 96, 97 Free Software Foundation, Inc. |
594722a8 | 4 | |
28a25aa5 AS |
5 | ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> |
6 | ;; Maintainer: Andre Spiegel <spiegel@inf.fu-berlin.de> | |
594722a8 ER |
7 | |
8 | ;; This file is part of GNU Emacs. | |
9 | ||
10 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
11 | ;; it under the terms of the GNU General Public License as published by | |
12 | ;; the Free Software Foundation; either version 2, or (at your option) | |
13 | ;; any later version. | |
14 | ||
15 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
16 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
17 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
18 | ;; GNU General Public License for more details. | |
19 | ||
20 | ;; You should have received a copy of the GNU General Public License | |
b578f267 EN |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to the |
22 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
23 | ;; Boston, MA 02111-1307, USA. | |
594722a8 ER |
24 | |
25 | ;;; Commentary: | |
26 | ||
1a2f456b ER |
27 | ;; This mode is fully documented in the Emacs user's manual. |
28 | ;; | |
594722a8 ER |
29 | ;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>. |
30 | ;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>, | |
31 | ;; and Richard Stallman contributed valuable criticism, support, and testing. | |
632e9525 | 32 | ;; CVS support was added by Per Cederqvist <ceder@lysator.liu.se> |
28a25aa5 AS |
33 | ;; in Jan-Feb 1994. Further enhancements came from ttn.netcom.com and |
34 | ;; Andre Spiegel <spiegel@inf.fu-berlin.de>. | |
594722a8 | 35 | ;; |
632e9525 | 36 | ;; Supported version-control systems presently include SCCS, RCS, and CVS. |
b0c9bc8c AS |
37 | ;; |
38 | ;; Some features will not work with old RCS versions. Where | |
39 | ;; appropriate, VC finds out which version you have, and allows or | |
40 | ;; disallows those features (stealing locks, for example, works only | |
41 | ;; from 5.6.2 onwards). | |
632e9525 RS |
42 | ;; Even initial checkins will fail if your RCS version is so old that ci |
43 | ;; doesn't understand -t-; this has been known to happen to people running | |
44 | ;; NExTSTEP 3.0. | |
594722a8 | 45 | ;; |
6b9d0764 AS |
46 | ;; You can support the RCS -x option by adding pairs to the |
47 | ;; vc-master-templates list. | |
594722a8 ER |
48 | ;; |
49 | ;; Proper function of the SCCS diff commands requires the shellscript vcdiff | |
50 | ;; to be installed somewhere on Emacs's path for executables. | |
51 | ;; | |
1a2f456b | 52 | ;; If your site uses the ChangeLog convention supported by Emacs, the |
594be62e | 53 | ;; function vc-comment-to-change-log should prove a useful checkin hook. |
1a2f456b | 54 | ;; |
594722a8 | 55 | ;; This code depends on call-process passing back the subprocess exit |
e1f297e6 | 56 | ;; status. Thus, you need Emacs 18.58 or later to run it. For the |
6ed5075c | 57 | ;; vc-directory command to work properly as documented, you need 19. |
7ef84cf9 | 58 | ;; You also need Emacs 19's ring.el. |
594722a8 ER |
59 | ;; |
60 | ;; The vc code maintains some internal state in order to reduce expensive | |
61 | ;; version-control operations to a minimum. Some names are only computed | |
34291cd2 | 62 | ;; once. If you perform version control operations with RCS/SCCS/CVS while |
594722a8 ER |
63 | ;; vc's back is turned, or move/rename master files while vc is running, |
64 | ;; vc may get seriously confused. Don't do these things! | |
65 | ;; | |
66 | ;; Developer's notes on some concurrency issues are included at the end of | |
67 | ;; the file. | |
68 | ||
69 | ;;; Code: | |
70 | ||
71 | (require 'vc-hooks) | |
8c0aaf40 | 72 | (require 'ring) |
5c6f8be0 | 73 | (eval-when-compile (require 'dired)) ; for dired-map-over-marks macro |
8c0aaf40 ER |
74 | |
75 | (if (not (assoc 'vc-parent-buffer minor-mode-alist)) | |
76 | (setq minor-mode-alist | |
77 | (cons '(vc-parent-buffer vc-parent-buffer-name) | |
78 | minor-mode-alist))) | |
594722a8 | 79 | |
d7eff0e0 RS |
80 | ;; To implement support for a new version-control system, add another |
81 | ;; branch to the vc-backend-dispatch macro and fill it in in each | |
82 | ;; call. The variable vc-master-templates in vc-hooks.el will also | |
83 | ;; have to change. | |
84 | ||
85 | (defmacro vc-backend-dispatch (f s r c) | |
86 | "Execute FORM1, FORM2 or FORM3 for SCCS, RCS or CVS respectively. | |
87 | If FORM3 is `RCS', use FORM2 for CVS as well as RCS. | |
88 | \(CVS shares some code with RCS)." | |
89 | (list 'let (list (list 'type (list 'vc-backend f))) | |
90 | (list 'cond | |
91 | (list (list 'eq 'type (quote 'SCCS)) s) ;; SCCS | |
92 | (list (list 'eq 'type (quote 'RCS)) r) ;; RCS | |
93 | (list (list 'eq 'type (quote 'CVS)) ;; CVS | |
94 | (if (eq c 'RCS) r c)) | |
95 | ))) | |
96 | ||
594722a8 ER |
97 | ;; General customization |
98 | ||
0101cc40 RS |
99 | (defgroup vc nil |
100 | "Version-control system in Emacs." | |
101 | :group 'tools) | |
102 | ||
103 | (defcustom vc-suppress-confirm nil | |
104 | "*If non-nil, treat user as expert; suppress yes-no prompts on some things." | |
105 | :type 'boolean | |
106 | :group 'vc) | |
107 | ||
108 | (defcustom vc-initial-comment nil | |
109 | "*If non-nil, prompt for initial comment when a file is registered." | |
110 | :type 'boolean | |
111 | :group 'vc) | |
112 | ||
113 | (defcustom vc-command-messages nil | |
114 | "*If non-nil, display run messages from back-end commands." | |
115 | :type 'boolean | |
116 | :group 'vc) | |
117 | ||
118 | (defcustom vc-checkin-switches nil | |
119 | "*A string or list of strings specifying extra switches for checkin. | |
120 | These are passed to the checkin program by \\[vc-checkin]." | |
121 | :type '(choice (const :tag "None" nil) | |
122 | (string :tag "Argument String") | |
123 | (repeat :tag "Argument List" | |
124 | :value ("") | |
125 | string)) | |
126 | :group 'vc) | |
127 | ||
128 | (defcustom vc-checkout-switches nil | |
129 | "*A string or list of strings specifying extra switches for checkout. | |
130 | These are passed to the checkout program by \\[vc-checkout]." | |
131 | :type '(choice (const :tag "None" nil) | |
132 | (string :tag "Argument String") | |
133 | (repeat :tag "Argument List" | |
134 | :value ("") | |
135 | string)) | |
136 | :group 'vc) | |
137 | ||
138 | (defcustom vc-register-switches nil | |
139 | "*A string or list of strings; extra switches for registering a file. | |
140 | These are passed to the checkin program by \\[vc-register]." | |
141 | :type '(choice (const :tag "None" nil) | |
142 | (string :tag "Argument String") | |
143 | (repeat :tag "Argument List" | |
144 | :value ("") | |
145 | string)) | |
146 | :group 'vc) | |
147 | ||
148 | (defcustom vc-directory-exclusion-list '("SCCS" "RCS" "CVS") | |
149 | "*List of directory names to be ignored while recursively walking file trees." | |
150 | :type '(repeat string) | |
151 | :group 'vc) | |
666a0ebb | 152 | |
8c0aaf40 ER |
153 | (defconst vc-maximum-comment-ring-size 32 |
154 | "Maximum number of saved comments in the comment ring.") | |
155 | ||
2e810285 | 156 | ;;; This is duplicated in diff.el. |
0101cc40 | 157 | ;;; ...and customized. |
2e810285 RS |
158 | (defvar diff-switches "-c" |
159 | "*A string or list of strings specifying switches to be be passed to diff.") | |
160 | ||
f0b188ed | 161 | ;;;###autoload |
0101cc40 RS |
162 | (defcustom vc-checkin-hook nil |
163 | "*Normal hook (List of functions) run after a checkin is done. | |
164 | See `run-hooks'." | |
165 | :type 'hook | |
166 | :group 'vc) | |
f0b188ed | 167 | |
67242a23 | 168 | ;;;###autoload |
0101cc40 RS |
169 | (defcustom vc-before-checkin-hook nil |
170 | "*Normal hook (list of functions) run before a file gets checked in. | |
171 | See `run-hooks'." | |
172 | :type 'hook | |
173 | :group 'vc) | |
67242a23 | 174 | |
594722a8 ER |
175 | ;; Header-insertion hair |
176 | ||
0101cc40 | 177 | (defcustom vc-header-alist |
80688f5c | 178 | '((SCCS "\%W\%") (RCS "\$Id\$") (CVS "\$Id\$")) |
7e48e092 AS |
179 | "*Header keywords to be inserted by `vc-insert-headers'. |
180 | Must be a list of two-element lists, the first element of each must | |
181 | be `RCS', `CVS', or `SCCS'. The second element is the string to | |
0101cc40 RS |
182 | be inserted for this particular backend." |
183 | :type '(repeat (list :format "%v" | |
184 | (choice :tag "System" | |
185 | (const SCCS) | |
186 | (const RCS) | |
187 | (const CVS)) | |
188 | (string :tag "Header"))) | |
189 | :group 'vc) | |
190 | ||
191 | (defcustom vc-static-header-alist | |
594722a8 ER |
192 | '(("\\.c$" . |
193 | "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n")) | |
194 | "*Associate static header string templates with file types. A \%s in the | |
195 | template is replaced with the first string associated with the file's | |
0101cc40 RS |
196 | version-control type in `vc-header-alist'." |
197 | :type '(repeat (cons :format "%v" | |
198 | (regexp :tag "File Type") | |
199 | (string :tag "Header String"))) | |
200 | :group 'vc) | |
7b4f934d | 201 | |
0101cc40 | 202 | (defcustom vc-comment-alist |
594722a8 ER |
203 | '((nroff-mode ".\\\"" "")) |
204 | "*Special comment delimiters to be used in generating vc headers only. | |
205 | Add an entry in this list if you need to override the normal comment-start | |
206 | and comment-end variables. This will only be necessary if the mode language | |
0101cc40 RS |
207 | is sensitive to blank lines." |
208 | :type '(repeat (list :format "%v" | |
209 | (symbol :tag "Mode") | |
210 | (string :tag "Comment Start") | |
211 | (string :tag "Comment End"))) | |
212 | :group 'vc) | |
594722a8 | 213 | |
bbf97570 | 214 | ;; Default is to be extra careful for super-user. |
0101cc40 | 215 | (defcustom vc-checkout-carefully (= (user-uid) 0) |
bbf97570 RS |
216 | "*Non-nil means be extra-careful in checkout. |
217 | Verify that the file really is not locked | |
0101cc40 RS |
218 | and that its contents match what the master file says." |
219 | :type 'boolean | |
220 | :group 'vc) | |
bbf97570 | 221 | |
0101cc40 | 222 | (defcustom vc-rcs-release nil |
b0c9bc8c | 223 | "*The release number of your RCS installation, as a string. |
0101cc40 RS |
224 | If nil, VC itself computes this value when it is first needed." |
225 | :type '(choice (const :tag "Auto" nil) | |
226 | string) | |
227 | :group 'vc) | |
b0c9bc8c | 228 | |
0101cc40 | 229 | (defcustom vc-sccs-release nil |
b0c9bc8c | 230 | "*The release number of your SCCS installation, as a string. |
0101cc40 RS |
231 | If nil, VC itself computes this value when it is first needed." |
232 | :type '(choice (const :tag "Auto" nil) | |
233 | string) | |
234 | :group 'vc) | |
b0c9bc8c | 235 | |
0101cc40 | 236 | (defcustom vc-cvs-release nil |
7e48e092 | 237 | "*The release number of your CVS installation, as a string. |
0101cc40 RS |
238 | If nil, VC itself computes this value when it is first needed." |
239 | :type '(choice (const :tag "Auto" nil) | |
240 | string) | |
241 | :group 'vc) | |
b0c9bc8c | 242 | |
594722a8 ER |
243 | ;; Variables the user doesn't need to know about. |
244 | (defvar vc-log-entry-mode nil) | |
245 | (defvar vc-log-operation nil) | |
67242a23 | 246 | (defvar vc-log-after-operation-hook nil) |
34291cd2 | 247 | (defvar vc-checkout-writable-buffer-hook 'vc-checkout-writable-buffer) |
dbf87856 RS |
248 | ;; In a log entry buffer, this is a local variable |
249 | ;; that points to the buffer for which it was made | |
250 | ;; (either a file, or a VC dired buffer). | |
1a2f456b | 251 | (defvar vc-parent-buffer nil) |
8c0aaf40 | 252 | (defvar vc-parent-buffer-name nil) |
594722a8 | 253 | |
db59472c RS |
254 | (defvar vc-log-file) |
255 | (defvar vc-log-version) | |
256 | ||
594722a8 ER |
257 | (defconst vc-name-assoc-file "VC-names") |
258 | ||
8c0aaf40 | 259 | (defvar vc-dired-mode nil) |
e1f297e6 ER |
260 | (make-variable-buffer-local 'vc-dired-mode) |
261 | ||
c9b35ece | 262 | (defvar vc-comment-ring (make-ring vc-maximum-comment-ring-size)) |
8c0aaf40 ER |
263 | (defvar vc-comment-ring-index nil) |
264 | (defvar vc-last-comment-match nil) | |
265 | ||
632e9525 RS |
266 | ;; Back-portability to Emacs 18 |
267 | ||
268 | (defun file-executable-p-18 (f) | |
269 | (let ((modes (file-modes f))) | |
270 | (and modes (not (zerop (logand 292)))))) | |
271 | ||
272 | (defun file-regular-p-18 (f) | |
273 | (let ((attributes (file-attributes f))) | |
274 | (and attributes (not (car attributes))))) | |
275 | ||
276 | ; Conditionally rebind some things for Emacs 18 compatibility | |
277 | (if (not (boundp 'minor-mode-map-alist)) | |
278 | (progn | |
279 | (setq compilation-old-error-list nil) | |
280 | (fset 'file-executable-p 'file-executable-p-18) | |
281 | (fset 'shrink-window-if-larger-than-buffer 'beginning-of-buffer) | |
282 | )) | |
283 | ||
4040437e | 284 | (if (not (fboundp 'file-regular-p)) |
632e9525 RS |
285 | (fset 'file-regular-p 'file-regular-p-18)) |
286 | ||
b0c9bc8c AS |
287 | ;;; Find and compare backend releases |
288 | ||
289 | (defun vc-backend-release (backend) | |
290 | ;; Returns which backend release is installed on this system. | |
291 | (cond | |
292 | ((eq backend 'RCS) | |
293 | (or vc-rcs-release | |
2bb00bdd | 294 | (and (zerop (vc-do-command nil nil "rcs" nil nil "-V")) |
b0c9bc8c AS |
295 | (save-excursion |
296 | (set-buffer (get-buffer "*vc*")) | |
297 | (setq vc-rcs-release | |
298 | (car (vc-parse-buffer | |
299 | '(("^RCS version \\([0-9.]+ *.*\\)" 1))))))) | |
300 | (setq vc-rcs-release 'unknown))) | |
301 | ((eq backend 'CVS) | |
302 | (or vc-cvs-release | |
303 | (and (zerop (vc-do-command nil 1 "cvs" nil nil "-v")) | |
304 | (save-excursion | |
305 | (set-buffer (get-buffer "*vc*")) | |
306 | (setq vc-cvs-release | |
307 | (car (vc-parse-buffer | |
308 | '(("^Concurrent Versions System (CVS) \\([0-9.]+\\)" | |
309 | 1))))))) | |
310 | (setq vc-cvs-release 'unknown))) | |
311 | ((eq backend 'SCCS) | |
312 | vc-sccs-release))) | |
313 | ||
314 | (defun vc-release-greater-or-equal (r1 r2) | |
315 | ;; Compare release numbers, represented as strings. | |
316 | ;; Release components are assumed cardinal numbers, not decimal | |
317 | ;; fractions (5.10 is a higher release than 5.9). Omitted fields | |
318 | ;; are considered lower (5.6.7 is earlier than 5.6.7.1). | |
319 | ;; Comparison runs till the end of the string is found, or a | |
320 | ;; non-numeric component shows up (5.6.7 is earlier than "5.6.7 beta", | |
321 | ;; which is probably not what you want in some cases). | |
322 | ;; This code is suitable for existing RCS release numbers. | |
323 | ;; CVS releases are handled reasonably, too (1.3 < 1.4* < 1.5). | |
324 | (let (v1 v2 i1 i2) | |
325 | (catch 'done | |
326 | (or (and (string-match "^\\.?\\([0-9]+\\)" r1) | |
327 | (setq i1 (match-end 0)) | |
328 | (setq v1 (string-to-number (match-string 1 r1))) | |
329 | (or (and (string-match "^\\.?\\([0-9]+\\)" r2) | |
330 | (setq i2 (match-end 0)) | |
331 | (setq v2 (string-to-number (match-string 1 r2))) | |
332 | (if (> v1 v2) (throw 'done t) | |
333 | (if (< v1 v2) (throw 'done nil) | |
334 | (throw 'done | |
335 | (vc-release-greater-or-equal | |
336 | (substring r1 i1) | |
337 | (substring r2 i2))))))) | |
338 | (throw 'done t))) | |
339 | (or (and (string-match "^\\.?\\([0-9]+\\)" r2) | |
340 | (throw 'done nil)) | |
341 | (throw 'done t))))) | |
342 | ||
343 | (defun vc-backend-release-p (backend release) | |
344 | ;; Return t if we have RELEASE of BACKEND or better | |
345 | (let (i r (ri 0) (ii 0) is rs (installation (vc-backend-release backend))) | |
346 | (if (not (eq installation 'unknown)) | |
347 | (cond | |
348 | ((or (eq backend 'RCS) (eq backend 'CVS)) | |
349 | (vc-release-greater-or-equal installation release)))))) | |
350 | ||
c8de1d91 AS |
351 | ;;; functions that operate on RCS revision numbers |
352 | ||
353 | (defun vc-trunk-p (rev) | |
354 | ;; return t if REV is a revision on the trunk | |
355 | (not (eq nil (string-match "\\`[0-9]+\\.[0-9]+\\'" rev)))) | |
356 | ||
357 | (defun vc-branch-part (rev) | |
358 | ;; return the branch part of a revision number REV | |
359 | (substring rev 0 (string-match "\\.[0-9]+\\'" rev))) | |
360 | ||
594722a8 ER |
361 | ;; File property caching |
362 | ||
8c0aaf40 ER |
363 | (defun vc-clear-context () |
364 | "Clear all cached file properties and the comment ring." | |
365 | (interactive) | |
366 | (fillarray vc-file-prop-obarray nil) | |
367 | ;; Note: there is potential for minor lossage here if there is an open | |
368 | ;; log buffer with a nonzero local value of vc-comment-ring-index. | |
c9b35ece | 369 | (setq vc-comment-ring (make-ring vc-maximum-comment-ring-size))) |
8c0aaf40 | 370 | |
88a2ffaf RS |
371 | (defun vc-file-clear-masterprops (file) |
372 | ;; clear all properties of FILE that were retrieved | |
373 | ;; from the master file | |
374 | (vc-file-setprop file 'vc-latest-version nil) | |
375 | (vc-file-setprop file 'vc-your-latest-version nil) | |
376 | (vc-backend-dispatch file | |
377 | (progn ;; SCCS | |
378 | (vc-file-setprop file 'vc-master-locks nil)) | |
379 | (progn ;; RCS | |
380 | (vc-file-setprop file 'vc-default-branch nil) | |
381 | (vc-file-setprop file 'vc-head-version nil) | |
8dd71345 | 382 | (vc-file-setprop file 'vc-master-workfile-version nil) |
88a2ffaf RS |
383 | (vc-file-setprop file 'vc-master-locks nil)) |
384 | (progn | |
385 | (vc-file-setprop file 'vc-cvs-status nil)))) | |
f3c61d82 | 386 | |
c8de1d91 AS |
387 | (defun vc-head-version (file) |
388 | ;; Return the RCS head version of FILE | |
389 | (cond ((vc-file-getprop file 'vc-head-version)) | |
390 | (t (vc-fetch-master-properties file) | |
391 | (vc-file-getprop file 'vc-head-version)))) | |
f3c61d82 | 392 | |
594722a8 ER |
393 | ;; Random helper functions |
394 | ||
c8de1d91 AS |
395 | (defun vc-latest-on-branch-p (file) |
396 | ;; return t iff the current workfile version of FILE is | |
397 | ;; the latest on its branch. | |
398 | (vc-backend-dispatch file | |
399 | ;; SCCS | |
400 | (string= (vc-workfile-version file) (vc-latest-version file)) | |
401 | ;; RCS | |
402 | (let ((workfile-version (vc-workfile-version file)) tip-version) | |
403 | (if (vc-trunk-p workfile-version) | |
404 | (progn | |
405 | ;; Re-fetch the head version number. This is to make | |
406 | ;; sure that no-one has checked in a new version behind | |
407 | ;; our back. | |
408 | (vc-fetch-master-properties file) | |
409 | (string= (vc-file-getprop file 'vc-head-version) | |
410 | workfile-version)) | |
411 | ;; If we are not on the trunk, we need to examine the | |
7d88be52 AS |
412 | ;; whole current branch. (vc-master-workfile-version |
413 | ;; is not what we need.) | |
c8de1d91 AS |
414 | (save-excursion |
415 | (set-buffer (get-buffer-create "*vc-info*")) | |
416 | (vc-insert-file (vc-name file) "^desc") | |
417 | (setq tip-version (car (vc-parse-buffer (list (list | |
418 | (concat "^\\(" (regexp-quote (vc-branch-part workfile-version)) | |
419 | "\\.[0-9]+\\)\ndate[ \t]+\\([0-9.]+\\);") 1 2))))) | |
420 | (if (get-buffer "*vc-info*") | |
421 | (kill-buffer (get-buffer "*vc-info*"))) | |
422 | (string= tip-version workfile-version)))) | |
423 | ;; CVS | |
8dd71345 | 424 | t)) |
c8de1d91 | 425 | |
7ef84cf9 RS |
426 | (defun vc-registration-error (file) |
427 | (if file | |
590cc449 RS |
428 | (error "File %s is not under version control" file) |
429 | (error "Buffer %s is not associated with a file" (buffer-name)))) | |
7ef84cf9 | 430 | |
594722a8 ER |
431 | (defvar vc-binary-assoc nil) |
432 | ||
433 | (defun vc-find-binary (name) | |
434 | "Look for a command anywhere on the subprocess-command search path." | |
435 | (or (cdr (assoc name vc-binary-assoc)) | |
deb9ebc6 PE |
436 | (catch 'found |
437 | (mapcar | |
438 | (function | |
439 | (lambda (s) | |
440 | (if s | |
441 | (let ((full (concat s "/" name))) | |
442 | (if (file-executable-p full) | |
443 | (progn | |
444 | (setq vc-binary-assoc | |
445 | (cons (cons name full) vc-binary-assoc)) | |
446 | (throw 'found full))))))) | |
447 | exec-path) | |
448 | nil))) | |
594722a8 | 449 | |
6aa13729 | 450 | (defun vc-do-command (buffer okstatus command file last &rest flags) |
594722a8 | 451 | "Execute a version-control command, notifying user and checking for errors. |
6aa13729 | 452 | Output from COMMAND goes to BUFFER, or *vc* if BUFFER is nil. |
594722a8 | 453 | The command is successful if its exit status does not exceed OKSTATUS. |
2bb00bdd | 454 | (If OKSTATUS is nil, that means to ignore errors.) |
6aa13729 RS |
455 | The last argument of the command is the master name of FILE if LAST is |
456 | `MASTER', or the workfile of FILE if LAST is `WORKFILE'; this is appended | |
457 | to an optional list of FLAGS." | |
b0c9bc8c | 458 | (and file (setq file (expand-file-name file))) |
6aa13729 | 459 | (if (not buffer) (setq buffer "*vc*")) |
594722a8 | 460 | (if vc-command-messages |
02da6253 | 461 | (message "Running %s on %s..." command file)) |
1a2f456b | 462 | (let ((obuf (current-buffer)) (camefrom (current-buffer)) |
594722a8 ER |
463 | (squeezed nil) |
464 | (vc-file (and file (vc-name file))) | |
632e9525 | 465 | (olddir default-directory) |
594722a8 | 466 | status) |
6aa13729 | 467 | (set-buffer (get-buffer-create buffer)) |
8c0aaf40 ER |
468 | (set (make-local-variable 'vc-parent-buffer) camefrom) |
469 | (set (make-local-variable 'vc-parent-buffer-name) | |
470 | (concat " from " (buffer-name camefrom))) | |
632e9525 | 471 | (setq default-directory olddir) |
8c0aaf40 | 472 | |
594722a8 | 473 | (erase-buffer) |
315e49ed | 474 | |
594722a8 ER |
475 | (mapcar |
476 | (function (lambda (s) (and s (setq squeezed (append squeezed (list s)))))) | |
477 | flags) | |
80688f5c | 478 | (if (and vc-file (eq last 'MASTER)) |
594722a8 | 479 | (setq squeezed (append squeezed (list vc-file)))) |
632e9525 RS |
480 | (if (eq last 'WORKFILE) |
481 | (progn | |
482 | (let* ((pwd (expand-file-name default-directory)) | |
483 | (preflen (length pwd))) | |
484 | (if (string= (substring file 0 preflen) pwd) | |
485 | (setq file (substring file preflen)))) | |
486 | (setq squeezed (append squeezed (list file))))) | |
46cd263f | 487 | (let ((exec-path (append vc-path exec-path)) |
eadcb02c RS |
488 | ;; Add vc-path to PATH for the execution of this command. |
489 | (process-environment | |
490 | (cons (concat "PATH=" (getenv "PATH") | |
993a1a44 RS |
491 | path-separator |
492 | (mapconcat 'identity vc-path path-separator)) | |
bcbe4d57 | 493 | process-environment)) |
b86b9918 | 494 | (w32-quote-process-args t)) |
1a2f456b | 495 | (setq status (apply 'call-process command nil t nil squeezed))) |
594722a8 | 496 | (goto-char (point-max)) |
632e9525 | 497 | (set-buffer-modified-p nil) |
4805f679 | 498 | (forward-line -1) |
2bb00bdd | 499 | (if (or (not (integerp status)) (and okstatus (< okstatus status))) |
594722a8 | 500 | (progn |
6aa13729 | 501 | (pop-to-buffer buffer) |
594722a8 | 502 | (goto-char (point-min)) |
4c2d8cf9 | 503 | (shrink-window-if-larger-than-buffer) |
02da6253 PE |
504 | (error "Running %s...FAILED (%s)" command |
505 | (if (integerp status) | |
506 | (format "status %d" status) | |
507 | status)) | |
594722a8 ER |
508 | ) |
509 | (if vc-command-messages | |
02da6253 | 510 | (message "Running %s...OK" command)) |
594722a8 ER |
511 | ) |
512 | (set-buffer obuf) | |
513 | status) | |
514 | ) | |
515 | ||
c4ae7096 JB |
516 | ;;; Save a bit of the text around POSN in the current buffer, to help |
517 | ;;; us find the corresponding position again later. This works even | |
518 | ;;; if all markers are destroyed or corrupted. | |
c8de1d91 | 519 | ;;; A lot of this was shamelessly lifted from Sebastian Kremer's rcs.el mode. |
c4ae7096 JB |
520 | (defun vc-position-context (posn) |
521 | (list posn | |
522 | (buffer-size) | |
523 | (buffer-substring posn | |
524 | (min (point-max) (+ posn 100))))) | |
525 | ||
526 | ;;; Return the position of CONTEXT in the current buffer, or nil if we | |
527 | ;;; couldn't find it. | |
528 | (defun vc-find-position-by-context (context) | |
529 | (let ((context-string (nth 2 context))) | |
530 | (if (equal "" context-string) | |
531 | (point-max) | |
532 | (save-excursion | |
533 | (let ((diff (- (nth 1 context) (buffer-size)))) | |
534 | (if (< diff 0) (setq diff (- diff))) | |
535 | (goto-char (nth 0 context)) | |
536 | (if (or (search-forward context-string nil t) | |
537 | ;; Can't use search-backward since the match may continue | |
538 | ;; after point. | |
539 | (progn (goto-char (- (point) diff (length context-string))) | |
540 | ;; goto-char doesn't signal an error at | |
541 | ;; beginning of buffer like backward-char would | |
542 | (search-forward context-string nil t))) | |
543 | ;; to beginning of OSTRING | |
544 | (- (point) (length context-string)))))))) | |
545 | ||
c8de1d91 AS |
546 | (defun vc-buffer-context () |
547 | ;; Return a list '(point-context mark-context reparse); from which | |
548 | ;; vc-restore-buffer-context can later restore the context. | |
c4ae7096 | 549 | (let ((point-context (vc-position-context (point))) |
cfadef63 RS |
550 | ;; Use mark-marker to avoid confusion in transient-mark-mode. |
551 | (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer)) | |
552 | (vc-position-context (mark-marker)))) | |
553 | ;; Make the right thing happen in transient-mark-mode. | |
ab877583 RM |
554 | (mark-active nil) |
555 | ;; We may want to reparse the compilation buffer after revert | |
556 | (reparse (and (boundp 'compilation-error-list) ;compile loaded | |
557 | (let ((curbuf (current-buffer))) | |
558 | ;; Construct a list; each elt is nil or a buffer | |
559 | ;; iff that buffer is a compilation output buffer | |
560 | ;; that contains markers into the current buffer. | |
561 | (save-excursion | |
7ef84cf9 RS |
562 | (mapcar (function |
563 | (lambda (buffer) | |
ab877583 RM |
564 | (set-buffer buffer) |
565 | (let ((errors (or | |
566 | compilation-old-error-list | |
567 | compilation-error-list)) | |
568 | (buffer-error-marked-p nil)) | |
6fb6ab11 | 569 | (while (and (consp errors) |
ab877583 | 570 | (not buffer-error-marked-p)) |
a1bda481 | 571 | (and (markerp (cdr (car errors))) |
e9c8e248 RM |
572 | (eq buffer |
573 | (marker-buffer | |
a1bda481 | 574 | (cdr (car errors)))) |
e9c8e248 | 575 | (setq buffer-error-marked-p t)) |
ab877583 | 576 | (setq errors (cdr errors))) |
7ef84cf9 | 577 | (if buffer-error-marked-p buffer)))) |
ab877583 | 578 | (buffer-list))))))) |
c8de1d91 AS |
579 | (list point-context mark-context reparse))) |
580 | ||
581 | (defun vc-restore-buffer-context (context) | |
582 | ;; Restore point/mark, and reparse any affected compilation buffers. | |
583 | ;; CONTEXT is that which vc-buffer-context returns. | |
584 | (let ((point-context (nth 0 context)) | |
585 | (mark-context (nth 1 context)) | |
586 | (reparse (nth 2 context))) | |
ab877583 RM |
587 | ;; Reparse affected compilation buffers. |
588 | (while reparse | |
589 | (if (car reparse) | |
590 | (save-excursion | |
591 | (set-buffer (car reparse)) | |
592 | (let ((compilation-last-buffer (current-buffer)) ;select buffer | |
593 | ;; Record the position in the compilation buffer of | |
594 | ;; the last error next-error went to. | |
595 | (error-pos (marker-position | |
596 | (car (car-safe compilation-error-list))))) | |
597 | ;; Reparse the error messages as far as they were parsed before. | |
598 | (compile-reinitialize-errors '(4) compilation-parsing-end) | |
599 | ;; Move the pointer up to find the error we were at before | |
600 | ;; reparsing. Now next-error should properly go to the next one. | |
601 | (while (and compilation-error-list | |
27f2f10b | 602 | (/= error-pos (car (car compilation-error-list)))) |
ab877583 RM |
603 | (setq compilation-error-list (cdr compilation-error-list)))))) |
604 | (setq reparse (cdr reparse))) | |
e1f297e6 | 605 | |
7b4f934d | 606 | ;; Restore point and mark |
c4ae7096 JB |
607 | (let ((new-point (vc-find-position-by-context point-context))) |
608 | (if new-point (goto-char new-point))) | |
609 | (if mark-context | |
610 | (let ((new-mark (vc-find-position-by-context mark-context))) | |
611 | (if new-mark (set-mark new-mark)))))) | |
612 | ||
c8de1d91 AS |
613 | (defun vc-revert-buffer1 (&optional arg no-confirm) |
614 | ;; Revert buffer, try to keep point and mark where user expects them in spite | |
615 | ;; of changes because of expanded version-control key words. | |
616 | ;; This is quite important since otherwise typeahead won't work as expected. | |
617 | (interactive "P") | |
618 | (widen) | |
619 | (let ((context (vc-buffer-context))) | |
e7ffe86a RS |
620 | ;; t means don't call normal-mode; that's to preserve various minor modes. |
621 | (revert-buffer arg no-confirm t) | |
c8de1d91 AS |
622 | (vc-restore-buffer-context context))) |
623 | ||
594722a8 | 624 | |
97d3f950 | 625 | (defun vc-buffer-sync (&optional not-urgent) |
594722a8 | 626 | ;; Make sure the current buffer and its working file are in sync |
97d3f950 | 627 | ;; NOT-URGENT means it is ok to continue if the user says not to save. |
bbf97570 | 628 | (if (buffer-modified-p) |
97d3f950 RS |
629 | (if (or vc-suppress-confirm |
630 | (y-or-n-p (format "Buffer %s modified; save it? " (buffer-name)))) | |
631 | (save-buffer) | |
632 | (if not-urgent | |
633 | nil | |
634 | (error "Aborted"))))) | |
635 | ||
594722a8 | 636 | |
9a51ed3a | 637 | (defun vc-workfile-unchanged-p (file &optional want-differences-if-changed) |
594722a8 ER |
638 | ;; Has the given workfile changed since last checkout? |
639 | (let ((checkout-time (vc-file-getprop file 'vc-checkout-time)) | |
640 | (lastmod (nth 5 (file-attributes file)))) | |
9a51ed3a PE |
641 | (or (equal checkout-time lastmod) |
642 | (and (or (not checkout-time) want-differences-if-changed) | |
643 | (let ((unchanged (zerop (vc-backend-diff file nil nil | |
c6d4f628 | 644 | (not want-differences-if-changed))))) |
9a51ed3a PE |
645 | ;; 0 stands for an unknown time; it can't match any mod time. |
646 | (vc-file-setprop file 'vc-checkout-time (if unchanged lastmod 0)) | |
647 | unchanged))))) | |
594722a8 | 648 | |
e1f297e6 ER |
649 | (defun vc-next-action-on-file (file verbose &optional comment) |
650 | ;;; If comment is specified, it will be used as an admin or checkin comment. | |
80688f5c | 651 | (let ((vc-file (vc-name file)) |
f3c61d82 | 652 | (vc-type (vc-backend file)) |
8dd71345 | 653 | owner version buffer) |
e1f297e6 ER |
654 | (cond |
655 | ||
656 | ;; if there is no master file corresponding, create one | |
657 | ((not vc-file) | |
632e9525 RS |
658 | (vc-register verbose comment) |
659 | (if vc-initial-comment | |
660 | (setq vc-log-after-operation-hook | |
661 | 'vc-checkout-writable-buffer-hook) | |
662 | (vc-checkout-writable-buffer file))) | |
e1f297e6 | 663 | |
61dee1e7 AS |
664 | ;; CVS: changes to the master file need to be |
665 | ;; merged back into the working file | |
666 | ((and (eq vc-type 'CVS) | |
667 | (or (eq (vc-cvs-status file) 'needs-checkout) | |
668 | (eq (vc-cvs-status file) 'needs-merge))) | |
8dd71345 AS |
669 | (if (or vc-dired-mode |
670 | (yes-or-no-p | |
671 | (format "%s is not up-to-date. Merge in changes now? " | |
672 | (buffer-name)))) | |
61dee1e7 | 673 | (progn |
8dd71345 AS |
674 | (if vc-dired-mode |
675 | (and (setq buffer (get-file-buffer file)) | |
676 | (buffer-modified-p buffer) | |
677 | (switch-to-buffer-other-window buffer) | |
678 | (vc-buffer-sync t)) | |
679 | (setq buffer (current-buffer)) | |
680 | (vc-buffer-sync t)) | |
681 | (if (and buffer (buffer-modified-p buffer) | |
61dee1e7 | 682 | (not (yes-or-no-p |
8dd71345 AS |
683 | (format |
684 | "Buffer %s modified; merge file on disc anyhow? " | |
685 | (buffer-name buffer))))) | |
61dee1e7 AS |
686 | (error "Merge aborted")) |
687 | (if (not (zerop (vc-backend-merge-news file))) | |
688 | ;; Overlaps detected - what now? Should use some | |
689 | ;; fancy RCS conflict resolving package, or maybe | |
690 | ;; emerge, but for now, simply warn the user with a | |
691 | ;; message. | |
692 | (message "Conflicts detected!")) | |
8dd71345 AS |
693 | (and buffer |
694 | (vc-resynch-buffer file t (not (buffer-modified-p buffer))))) | |
61dee1e7 AS |
695 | (error "%s needs update" (buffer-name)))) |
696 | ||
4cbeb71c RS |
697 | ;; If there is no lock on the file, assert one and get it. |
698 | ;; (With implicit checkout, make sure not to lose unsaved changes.) | |
699 | ((progn (and (eq (vc-checkout-model file) 'implicit) | |
700 | (buffer-modified-p buffer) | |
701 | (vc-buffer-sync)) | |
702 | (not (setq owner (vc-locking-user file)))) | |
bbf97570 | 703 | (if (and vc-checkout-carefully |
9a51ed3a | 704 | (not (vc-workfile-unchanged-p file t))) |
bbf97570 | 705 | (if (save-window-excursion |
6aa13729 | 706 | (pop-to-buffer "*vc-diff*") |
bbf97570 RS |
707 | (goto-char (point-min)) |
708 | (insert-string (format "Changes to %s since last lock:\n\n" | |
709 | file)) | |
710 | (not (beep)) | |
711 | (yes-or-no-p | |
712 | (concat "File has unlocked changes, " | |
713 | "claim lock retaining changes? "))) | |
714 | (progn (vc-backend-steal file) | |
715 | (vc-mode-line file)) | |
716 | (if (not (yes-or-no-p "Revert to checked-in version, instead? ")) | |
2c28ac43 | 717 | (error "Checkout aborted") |
bbf97570 RS |
718 | (vc-revert-buffer1 t t) |
719 | (vc-checkout-writable-buffer file)) | |
720 | ) | |
c6d4f628 RS |
721 | (if verbose |
722 | (if (not (eq vc-type 'SCCS)) | |
e163b283 AS |
723 | (vc-checkout file nil |
724 | (read-string "Branch or version to move to: ")) | |
2c28ac43 | 725 | (error "Sorry, this is not implemented for SCCS")) |
9341ff29 AS |
726 | (if (vc-latest-on-branch-p file) |
727 | (vc-checkout-writable-buffer file) | |
728 | (if (yes-or-no-p | |
729 | "This is not the latest version. Really lock it? ") | |
730 | (vc-checkout-writable-buffer file) | |
731 | (if (yes-or-no-p "Lock the latest version instead? ") | |
732 | (vc-checkout-writable-buffer file | |
1ba1cade AS |
733 | (if (vc-trunk-p (vc-workfile-version file)) |
734 | "" ;; this means check out latest on trunk | |
735 | (vc-branch-part (vc-workfile-version file))))))) | |
9341ff29 | 736 | ))) |
e1f297e6 ER |
737 | |
738 | ;; a checked-out version exists, but the user may not own the lock | |
61dee1e7 | 739 | ((and (not (eq vc-type 'CVS)) |
8172cd86 | 740 | (not (string-equal owner (vc-user-login-name)))) |
e1f297e6 | 741 | (if comment |
590cc449 | 742 | (error "Sorry, you can't steal the lock on %s this way" file)) |
b0c9bc8c AS |
743 | (and (eq vc-type 'RCS) |
744 | (not (vc-backend-release-p 'RCS "5.6.2")) | |
2c28ac43 | 745 | (error "File is locked by %s" owner)) |
e1f297e6 ER |
746 | (vc-steal-lock |
747 | file | |
c6d4f628 RS |
748 | (if verbose (read-string "Version to steal: ") |
749 | (vc-workfile-version file)) | |
e1f297e6 | 750 | owner)) |
80688f5c | 751 | |
c6d4f628 | 752 | ;; OK, user owns the lock on the file |
8c0aaf40 | 753 | (t |
b0c9bc8c AS |
754 | (if vc-dired-mode |
755 | (find-file-other-window file) | |
756 | (find-file file)) | |
e1f297e6 ER |
757 | |
758 | ;; give luser a chance to save before checking in. | |
759 | (vc-buffer-sync) | |
760 | ||
761 | ;; Revert if file is unchanged and buffer is too. | |
762 | ;; If buffer is modified, that means the user just said no | |
763 | ;; to saving it; in that case, don't revert, | |
764 | ;; because the user might intend to save | |
765 | ;; after finishing the log entry. | |
80688f5c | 766 | (if (and (vc-workfile-unchanged-p file) |
e1f297e6 | 767 | (not (buffer-modified-p))) |
c6d4f628 RS |
768 | ;; DO NOT revert the file without asking the user! |
769 | (cond | |
770 | ((yes-or-no-p "Revert to master version? ") | |
771 | (vc-backend-revert file) | |
772 | (vc-resynch-window file t t))) | |
e1f297e6 ER |
773 | |
774 | ;; user may want to set nonstandard parameters | |
775 | (if verbose | |
776 | (setq version (read-string "New version level: "))) | |
777 | ||
778 | ;; OK, let's do the checkin | |
779 | (vc-checkin file version comment) | |
8c0aaf40 | 780 | ))))) |
e1f297e6 ER |
781 | |
782 | (defun vc-next-action-dired (file rev comment) | |
b0c9bc8c AS |
783 | ;; Do a vc-next-action-on-file on all the marked files, possibly |
784 | ;; passing on the log comment we've just entered. | |
785 | (let ((configuration (current-window-configuration)) | |
8dd71345 AS |
786 | (dired-buffer (current-buffer)) |
787 | (dired-dir default-directory)) | |
632e9525 | 788 | (dired-map-over-marks |
f008ca58 KH |
789 | (let ((file (dired-get-filename)) p |
790 | (default-directory default-directory)) | |
b0c9bc8c | 791 | (message "Processing %s..." file) |
8dd71345 AS |
792 | ;; Adjust the default directory so that checkouts |
793 | ;; go to the right place. | |
794 | (setq default-directory (file-name-directory file)) | |
b0c9bc8c AS |
795 | (vc-next-action-on-file file nil comment) |
796 | (set-buffer dired-buffer) | |
8dd71345 | 797 | (setq default-directory dired-dir) |
b0c9bc8c AS |
798 | (vc-dired-update-line file) |
799 | (set-window-configuration configuration) | |
800 | (message "Processing %s...done" file)) | |
801 | nil t))) | |
e1f297e6 | 802 | |
637a8ae9 | 803 | ;; Here's the major entry point. |
594722a8 | 804 | |
637a8ae9 | 805 | ;;;###autoload |
594722a8 ER |
806 | (defun vc-next-action (verbose) |
807 | "Do the next logical checkin or checkout operation on the current file. | |
c6d4f628 RS |
808 | If you call this from within a VC dired buffer with no files marked, |
809 | it will operate on the file in the current line. | |
810 | If you call this from within a VC dired buffer, and one or more | |
811 | files are marked, it will accept a log message and then operate on | |
812 | each one. The log message will be used as a comment for any register | |
813 | or checkin operations, but ignored when doing checkouts. Attempted | |
814 | lock steals will raise an error. | |
815 | A prefix argument lets you specify the version number to use. | |
80688f5c RS |
816 | |
817 | For RCS and SCCS files: | |
594722a8 | 818 | If the file is not already registered, this registers it for version |
34291cd2 | 819 | control and then retrieves a writable, locked copy for editing. |
594722a8 | 820 | If the file is registered and not locked by anyone, this checks out |
34291cd2 | 821 | a writable and locked file ready for editing. |
594722a8 ER |
822 | If the file is checked out and locked by the calling user, this |
823 | first checks to see if the file has changed since checkout. If not, | |
824 | it performs a revert. | |
e1f297e6 ER |
825 | If the file has been changed, this pops up a buffer for entry |
826 | of a log message; when the message has been entered, it checks in the | |
594722a8 | 827 | resulting changes along with the log message as change commentary. If |
34291cd2 | 828 | the variable `vc-keep-workfiles' is non-nil (which is its default), a |
594722a8 ER |
829 | read-only copy of the changed file is left in place afterwards. |
830 | If the file is registered and locked by someone else, you are given | |
e1f297e6 | 831 | the option to steal the lock. |
80688f5c RS |
832 | |
833 | For CVS files: | |
834 | If the file is not already registered, this registers it for version | |
835 | control. This does a \"cvs add\", but no \"cvs commit\". | |
836 | If the file is added but not committed, it is committed. | |
80688f5c RS |
837 | If your working file is changed, but the repository file is |
838 | unchanged, this pops up a buffer for entry of a log message; when the | |
839 | message has been entered, it checks in the resulting changes along | |
840 | with the logmessage as change commentary. A writable file is retained. | |
841 | If the repository file is changed, you are asked if you want to | |
c6d4f628 | 842 | merge in the changes into your working copy." |
bbf97570 | 843 | |
594722a8 | 844 | (interactive "P") |
8c0aaf40 ER |
845 | (catch 'nogo |
846 | (if vc-dired-mode | |
847 | (let ((files (dired-get-marked-files))) | |
8dd71345 AS |
848 | (if (string= "" |
849 | (mapconcat | |
b0c9bc8c AS |
850 | (function (lambda (f) |
851 | (if (eq (vc-backend f) 'CVS) | |
8dd71345 AS |
852 | (if (or (eq (vc-cvs-status f) 'locally-modified) |
853 | (eq (vc-cvs-status f) 'locally-added)) | |
b0c9bc8c AS |
854 | "@" "") |
855 | (if (vc-locking-user f) "@" "")))) | |
856 | files "")) | |
857 | (vc-next-action-dired nil nil "dummy") | |
858 | (vc-start-entry nil nil nil | |
859 | "Enter a change comment for the marked files." | |
860 | 'vc-next-action-dired)) | |
8dd71345 | 861 | (throw 'nogo nil))) |
e1f297e6 | 862 | (while vc-parent-buffer |
1a2f456b | 863 | (pop-to-buffer vc-parent-buffer)) |
e1f297e6 ER |
864 | (if buffer-file-name |
865 | (vc-next-action-on-file buffer-file-name verbose) | |
7ef84cf9 | 866 | (vc-registration-error nil)))) |
594722a8 ER |
867 | |
868 | ;;; These functions help the vc-next-action entry point | |
869 | ||
c6d4f628 | 870 | (defun vc-checkout-writable-buffer (&optional file rev) |
34291cd2 | 871 | "Retrieve a writable copy of the latest version of the current buffer's file." |
c6d4f628 | 872 | (vc-checkout (or file (buffer-file-name)) t rev) |
02da6253 PE |
873 | ) |
874 | ||
637a8ae9 | 875 | ;;;###autoload |
e1f297e6 | 876 | (defun vc-register (&optional override comment) |
594722a8 ER |
877 | "Register the current file into your version-control system." |
878 | (interactive "P") | |
f1b82fc8 KH |
879 | (or buffer-file-name |
880 | (error "No visited file")) | |
e837a82f RS |
881 | (let ((master (vc-name buffer-file-name))) |
882 | (and master (file-exists-p master) | |
883 | (error "This file is already registered")) | |
884 | (and master | |
885 | (not (y-or-n-p "Previous master file has vanished. Make a new one? ")) | |
886 | (error "This file is already registered"))) | |
02da6253 PE |
887 | ;; Watch out for new buffers of size 0: the corresponding file |
888 | ;; does not exist yet, even though buffer-modified-p is nil. | |
889 | (if (and (not (buffer-modified-p)) | |
890 | (zerop (buffer-size)) | |
891 | (not (file-exists-p buffer-file-name))) | |
892 | (set-buffer-modified-p t)) | |
594722a8 | 893 | (vc-buffer-sync) |
993a1a44 RS |
894 | (cond ((not vc-make-backup-files) |
895 | ;; inhibit backup for this buffer | |
896 | (make-local-variable 'backup-inhibited) | |
897 | (setq backup-inhibited t))) | |
594722a8 ER |
898 | (vc-admin |
899 | buffer-file-name | |
e1f297e6 ER |
900 | (and override |
901 | (read-string | |
902 | (format "Initial version level for %s: " buffer-file-name)))) | |
594722a8 ER |
903 | ) |
904 | ||
624b4662 | 905 | (defun vc-resynch-window (file &optional keep noquery) |
594722a8 | 906 | ;; If the given file is in the current buffer, |
a7acbbe4 | 907 | ;; either revert on it so we see expanded keywords, |
594722a8 | 908 | ;; or unvisit it (depending on vc-keep-workfiles) |
624b4662 RS |
909 | ;; NOQUERY if non-nil inhibits confirmation for reverting. |
910 | ;; NOQUERY should be t *only* if it is known the only difference | |
911 | ;; between the buffer and the file is due to RCS rather than user editing! | |
594722a8 ER |
912 | (and (string= buffer-file-name file) |
913 | (if keep | |
914 | (progn | |
88a2ffaf RS |
915 | ;; temporarily remove vc-find-file-hook, so that |
916 | ;; we don't lose the properties | |
917 | (remove-hook 'find-file-hooks 'vc-find-file-hook) | |
1ab31687 | 918 | (vc-revert-buffer1 t noquery) |
88a2ffaf | 919 | (add-hook 'find-file-hooks 'vc-find-file-hook) |
594722a8 | 920 | (vc-mode-line buffer-file-name)) |
88a2ffaf | 921 | (kill-buffer (current-buffer))))) |
594722a8 | 922 | |
503b5c85 | 923 | (defun vc-resynch-buffer (file &optional keep noquery) |
b0c9bc8c | 924 | ;; if FILE is currently visited, resynch its buffer |
503b5c85 RS |
925 | (let ((buffer (get-file-buffer file))) |
926 | (if buffer | |
927 | (save-excursion | |
928 | (set-buffer buffer) | |
929 | (vc-resynch-window file keep noquery))))) | |
930 | ||
b965445f | 931 | (defun vc-start-entry (file rev comment msg action &optional after-hook) |
e1f297e6 ER |
932 | ;; Accept a comment for an operation on FILE revision REV. If COMMENT |
933 | ;; is nil, pop up a VC-log buffer, emit MSG, and set the | |
934 | ;; action on close to ACTION; otherwise, do action immediately. | |
cdaf7a1a | 935 | ;; Remember the file's buffer in vc-parent-buffer (current one if no file). |
b965445f | 936 | ;; AFTER-HOOK specifies the local value for vc-log-operation-hook. |
e1f297e6 | 937 | (let ((parent (if file (find-file-noselect file) (current-buffer)))) |
f0b188ed RS |
938 | (if vc-before-checkin-hook |
939 | (if file | |
940 | (save-excursion | |
941 | (set-buffer parent) | |
942 | (run-hooks 'vc-before-checkin-hook)) | |
943 | (run-hooks 'vc-before-checkin-hook))) | |
e1f297e6 ER |
944 | (if comment |
945 | (set-buffer (get-buffer-create "*VC-log*")) | |
946 | (pop-to-buffer (get-buffer-create "*VC-log*"))) | |
8c0aaf40 ER |
947 | (set (make-local-variable 'vc-parent-buffer) parent) |
948 | (set (make-local-variable 'vc-parent-buffer-name) | |
949 | (concat " from " (buffer-name vc-parent-buffer))) | |
7e869659 | 950 | (if file (vc-mode-line file)) |
37667a5c | 951 | (vc-log-mode file) |
b965445f RS |
952 | (make-local-variable 'vc-log-after-operation-hook) |
953 | (if after-hook | |
954 | (setq vc-log-after-operation-hook after-hook)) | |
e1f297e6 | 955 | (setq vc-log-operation action) |
e1f297e6 ER |
956 | (setq vc-log-version rev) |
957 | (if comment | |
958 | (progn | |
959 | (erase-buffer) | |
8c0aaf40 ER |
960 | (if (eq comment t) |
961 | (vc-finish-logentry t) | |
962 | (insert comment) | |
963 | (vc-finish-logentry nil))) | |
e1f297e6 | 964 | (message "%s Type C-c C-c when done." msg)))) |
594722a8 | 965 | |
e1f297e6 | 966 | (defun vc-admin (file rev &optional comment) |
624b4662 | 967 | "Check a file into your version-control system. |
594722a8 | 968 | FILE is the unmodified name of the file. REV should be the base version |
e1f297e6 | 969 | level to check it in under. COMMENT, if specified, is the checkin comment." |
b965445f RS |
970 | (vc-start-entry file rev |
971 | (or comment (not vc-initial-comment)) | |
972 | "Enter initial comment." 'vc-backend-admin | |
6bcb1d4e | 973 | nil)) |
e1f297e6 | 974 | |
c6d4f628 | 975 | (defun vc-checkout (file &optional writable rev) |
e1f297e6 ER |
976 | "Retrieve a copy of the latest version of the given file." |
977 | ;; If ftp is on this system and the name matches the ange-ftp format | |
978 | ;; for a remote file, the user is trying something that won't work. | |
979 | (if (and (string-match "^/[^/:]+:" file) (vc-find-binary "ftp")) | |
980 | (error "Sorry, you can't check out files over FTP")) | |
c6d4f628 | 981 | (vc-backend-checkout file writable rev) |
b0c9bc8c | 982 | (vc-resynch-buffer file t t)) |
594722a8 ER |
983 | |
984 | (defun vc-steal-lock (file rev &optional owner) | |
985 | "Steal the lock on the current workfile." | |
29fc1ce9 RS |
986 | (let (file-description) |
987 | (if (not owner) | |
988 | (setq owner (vc-locking-user file))) | |
989 | (if rev | |
990 | (setq file-description (format "%s:%s" file rev)) | |
991 | (setq file-description file)) | |
992 | (if (not (y-or-n-p (format "Take the lock on %s from %s? " | |
993 | file-description owner))) | |
994 | (error "Steal cancelled")) | |
995 | (pop-to-buffer (get-buffer-create "*VC-mail*")) | |
996 | (setq default-directory (expand-file-name "~/")) | |
997 | (auto-save-mode auto-save-default) | |
998 | (mail-mode) | |
999 | (erase-buffer) | |
1000 | (mail-setup owner (format "Stolen lock on %s" file-description) nil nil nil | |
3e3da61f | 1001 | (list (list 'vc-finish-steal file rev))) |
29fc1ce9 RS |
1002 | (goto-char (point-max)) |
1003 | (insert | |
1004 | (format "I stole the lock on %s, " file-description) | |
1005 | (current-time-string) | |
1006 | ".\n") | |
1007 | (message "Please explain why you stole the lock. Type C-c C-c when done."))) | |
594722a8 | 1008 | |
ad014629 | 1009 | ;; This is called when the notification has been sent. |
594722a8 | 1010 | (defun vc-finish-steal (file version) |
594722a8 | 1011 | (vc-backend-steal file version) |
3e3da61f RS |
1012 | (if (get-file-buffer file) |
1013 | (save-excursion | |
6242bee4 | 1014 | (set-buffer (get-file-buffer file)) |
3e3da61f | 1015 | (vc-resynch-window file t t)))) |
594722a8 | 1016 | |
594722a8 ER |
1017 | (defun vc-checkin (file &optional rev comment) |
1018 | "Check in the file specified by FILE. | |
1019 | The optional argument REV may be a string specifying the new version level | |
67242a23 | 1020 | \(if nil increment the current level). The file is either retained with write |
34291cd2 | 1021 | permissions zeroed, or deleted (according to the value of `vc-keep-workfiles'). |
80688f5c | 1022 | If the back-end is CVS, a writable workfile is always kept. |
594722a8 ER |
1023 | COMMENT is a comment string; if omitted, a buffer is |
1024 | popped up to accept a comment." | |
61446fe7 | 1025 | (vc-start-entry file rev comment |
b965445f RS |
1026 | "Enter a change comment." 'vc-backend-checkin |
1027 | 'vc-checkin-hook)) | |
594722a8 | 1028 | |
1a2f456b ER |
1029 | ;;; Here is a checkin hook that may prove useful to sites using the |
1030 | ;;; ChangeLog facility supported by Emacs. | |
3b4dd9a9 RM |
1031 | (defun vc-comment-to-change-log (&optional whoami file-name) |
1032 | "Enter last VC comment into change log file for current buffer's file. | |
1033 | Optional arg (interactive prefix) non-nil means prompt for user name and site. | |
1034 | Second arg is file name of change log. \ | |
1035 | If nil, uses `change-log-default-name'." | |
43cea1ab RM |
1036 | (interactive (if current-prefix-arg |
1037 | (list current-prefix-arg | |
1038 | (prompt-for-change-log-name)))) | |
41208291 KH |
1039 | ;; Make sure the defvar for add-log-current-defun-function has been executed |
1040 | ;; before binding it. | |
1041 | (require 'add-log) | |
3b4dd9a9 RM |
1042 | (let (;; Extract the comment first so we get any error before doing anything. |
1043 | (comment (ring-ref vc-comment-ring 0)) | |
43cea1ab | 1044 | ;; Don't let add-change-log-entry insert a defun name. |
3b4dd9a9 RM |
1045 | (add-log-current-defun-function 'ignore) |
1046 | end) | |
1047 | ;; Call add-log to do half the work. | |
43cea1ab | 1048 | (add-change-log-entry whoami file-name t t) |
3b4dd9a9 RM |
1049 | ;; Insert the VC comment, leaving point before it. |
1050 | (setq end (save-excursion (insert comment) (point-marker))) | |
1051 | (if (looking-at "\\s *\\s(") | |
1052 | ;; It starts with an open-paren, as in "(foo): Frobbed." | |
43cea1ab | 1053 | ;; So remove the ": " add-log inserted. |
3b4dd9a9 RM |
1054 | (delete-char -2)) |
1055 | ;; Canonicalize the white space between the file name and comment. | |
1056 | (just-one-space) | |
1057 | ;; Indent rest of the text the same way add-log indented the first line. | |
1058 | (let ((indentation (current-indentation))) | |
1059 | (save-excursion | |
1060 | (while (< (point) end) | |
1061 | (forward-line 1) | |
1062 | (indent-to indentation)) | |
c124b1b4 | 1063 | (setq end (point)))) |
3b4dd9a9 | 1064 | ;; Fill the inserted text, preserving open-parens at bol. |
6b60c5d1 BG |
1065 | (let ((paragraph-separate (concat paragraph-separate "\\|\\s *\\s(")) |
1066 | (paragraph-start (concat paragraph-start "\\|\\s *\\s("))) | |
43cea1ab | 1067 | (beginning-of-line) |
c124b1b4 RM |
1068 | (fill-region (point) end)) |
1069 | ;; Canonicalize the white space at the end of the entry so it is | |
1070 | ;; separated from the next entry by a single blank line. | |
1071 | (skip-syntax-forward " " end) | |
1072 | (delete-char (- (skip-syntax-backward " "))) | |
1073 | (or (eobp) (looking-at "\n\n") | |
1074 | (insert "\n")))) | |
3b4dd9a9 | 1075 | |
1a2f456b | 1076 | |
8c0aaf40 | 1077 | (defun vc-finish-logentry (&optional nocomment) |
594722a8 ER |
1078 | "Complete the operation implied by the current log entry." |
1079 | (interactive) | |
8c0aaf40 ER |
1080 | ;; Check and record the comment, if any. |
1081 | (if (not nocomment) | |
1082 | (progn | |
1083 | (goto-char (point-max)) | |
1084 | (if (not (bolp)) | |
1085 | (newline)) | |
1086 | ;; Comment too long? | |
1087 | (vc-backend-logentry-check vc-log-file) | |
1088 | ;; Record the comment in the comment ring | |
8c0aaf40 ER |
1089 | (ring-insert vc-comment-ring (buffer-string)) |
1090 | )) | |
b2396d1f | 1091 | ;; Sync parent buffer in case the user modified it while editing the comment. |
cdaf7a1a | 1092 | ;; But not if it is a vc-dired buffer. |
b2396d1f | 1093 | (save-excursion |
cdaf7a1a RS |
1094 | (set-buffer vc-parent-buffer) |
1095 | (or vc-dired-mode | |
1096 | (vc-buffer-sync))) | |
61dee1e7 AS |
1097 | (if (not vc-log-operation) (error "No log operation is pending")) |
1098 | ;; save the parameters held in buffer-local variables | |
1099 | (let ((log-operation vc-log-operation) | |
1100 | (log-file vc-log-file) | |
1101 | (log-version vc-log-version) | |
1102 | (log-entry (buffer-string)) | |
1103 | (after-hook vc-log-after-operation-hook)) | |
e2bef5c3 RS |
1104 | ;; Return to "parent" buffer of this checkin and remove checkin window |
1105 | (pop-to-buffer vc-parent-buffer) | |
1106 | (let ((logbuf (get-buffer "*VC-log*"))) | |
1107 | (delete-windows-on logbuf) | |
1108 | (kill-buffer logbuf)) | |
61dee1e7 AS |
1109 | ;; OK, do it to it |
1110 | (save-excursion | |
1111 | (funcall log-operation | |
1112 | log-file | |
1113 | log-version | |
1114 | log-entry)) | |
e2bef5c3 RS |
1115 | ;; Now make sure we see the expanded headers |
1116 | (if buffer-file-name | |
e1f297e6 | 1117 | (vc-resynch-window buffer-file-name vc-keep-workfiles t)) |
37667a5c | 1118 | (run-hooks after-hook 'vc-finish-logentry-hook))) |
594722a8 ER |
1119 | |
1120 | ;; Code for access to the comment ring | |
1121 | ||
8c0aaf40 ER |
1122 | (defun vc-previous-comment (arg) |
1123 | "Cycle backwards through comment history." | |
1124 | (interactive "*p") | |
1125 | (let ((len (ring-length vc-comment-ring))) | |
1126 | (cond ((<= len 0) | |
1127 | (message "Empty comment ring") | |
1128 | (ding)) | |
1129 | (t | |
1130 | (erase-buffer) | |
1131 | ;; Initialize the index on the first use of this command | |
1132 | ;; so that the first M-p gets index 0, and the first M-n gets | |
1133 | ;; index -1. | |
1134 | (if (null vc-comment-ring-index) | |
1135 | (setq vc-comment-ring-index | |
1136 | (if (> arg 0) -1 | |
1137 | (if (< arg 0) 1 0)))) | |
1138 | (setq vc-comment-ring-index | |
c6bfcd12 | 1139 | (mod (+ vc-comment-ring-index arg) len)) |
8c0aaf40 ER |
1140 | (message "%d" (1+ vc-comment-ring-index)) |
1141 | (insert (ring-ref vc-comment-ring vc-comment-ring-index)))))) | |
1142 | ||
1143 | (defun vc-next-comment (arg) | |
1144 | "Cycle forwards through comment history." | |
1145 | (interactive "*p") | |
1146 | (vc-previous-comment (- arg))) | |
1147 | ||
1148 | (defun vc-comment-search-reverse (str) | |
1149 | "Searches backwards through comment history for substring match." | |
1150 | (interactive "sComment substring: ") | |
1151 | (if (string= str "") | |
1152 | (setq str vc-last-comment-match) | |
1153 | (setq vc-last-comment-match str)) | |
1154 | (if (null vc-comment-ring-index) | |
1155 | (setq vc-comment-ring-index -1)) | |
1156 | (let ((str (regexp-quote str)) | |
1157 | (len (ring-length vc-comment-ring)) | |
1158 | (n (1+ vc-comment-ring-index))) | |
1159 | (while (and (< n len) (not (string-match str (ring-ref vc-comment-ring n)))) | |
1160 | (setq n (+ n 1))) | |
1161 | (cond ((< n len) | |
1162 | (vc-previous-comment (- n vc-comment-ring-index))) | |
1163 | (t (error "Not found"))))) | |
1164 | ||
1165 | (defun vc-comment-search-forward (str) | |
1166 | "Searches forwards through comment history for substring match." | |
1167 | (interactive "sComment substring: ") | |
1168 | (if (string= str "") | |
1169 | (setq str vc-last-comment-match) | |
1170 | (setq vc-last-comment-match str)) | |
1171 | (if (null vc-comment-ring-index) | |
1172 | (setq vc-comment-ring-index 0)) | |
1173 | (let ((str (regexp-quote str)) | |
1174 | (len (ring-length vc-comment-ring)) | |
1175 | (n vc-comment-ring-index)) | |
1176 | (while (and (>= n 0) (not (string-match str (ring-ref vc-comment-ring n)))) | |
1177 | (setq n (- n 1))) | |
1178 | (cond ((>= n 0) | |
1179 | (vc-next-comment (- n vc-comment-ring-index))) | |
1180 | (t (error "Not found"))))) | |
594722a8 ER |
1181 | |
1182 | ;; Additional entry points for examining version histories | |
1183 | ||
637a8ae9 | 1184 | ;;;###autoload |
97d3f950 | 1185 | (defun vc-diff (historic &optional not-urgent) |
e8ee1ccf RS |
1186 | "Display diffs between file versions. |
1187 | Normally this compares the current file and buffer with the most recent | |
1188 | checked in version of that file. This uses no arguments. | |
1189 | With a prefix argument, it reads the file name to use | |
1190 | and two version designators specifying which versions to compare." | |
48078f8f | 1191 | (interactive (list current-prefix-arg t)) |
e1f297e6 ER |
1192 | (if vc-dired-mode |
1193 | (set-buffer (find-file-noselect (dired-get-filename)))) | |
8ac8c82f | 1194 | (while vc-parent-buffer |
1a2f456b | 1195 | (pop-to-buffer vc-parent-buffer)) |
594722a8 ER |
1196 | (if historic |
1197 | (call-interactively 'vc-version-diff) | |
8c0aaf40 | 1198 | (if (or (null buffer-file-name) (null (vc-name buffer-file-name))) |
064726ac JB |
1199 | (error |
1200 | "There is no version-control master associated with this buffer")) | |
02da6253 | 1201 | (let ((file buffer-file-name) |
594722a8 | 1202 | unchanged) |
7ef84cf9 RS |
1203 | (or (and file (vc-name file)) |
1204 | (vc-registration-error file)) | |
97d3f950 | 1205 | (vc-buffer-sync not-urgent) |
594722a8 ER |
1206 | (setq unchanged (vc-workfile-unchanged-p buffer-file-name)) |
1207 | (if unchanged | |
7e48e092 | 1208 | (message "No changes to %s since latest version" file) |
9a51ed3a | 1209 | (vc-backend-diff file) |
8c0aaf40 ER |
1210 | ;; Ideally, we'd like at this point to parse the diff so that |
1211 | ;; the buffer effectively goes into compilation mode and we | |
1212 | ;; can visit the old and new change locations via next-error. | |
1213 | ;; Unfortunately, this is just too painful to do. The basic | |
1214 | ;; problem is that the `old' file doesn't exist to be | |
1215 | ;; visited. This plays hell with numerous assumptions in | |
1216 | ;; the diff.el and compile.el machinery. | |
7e48e092 | 1217 | (set-buffer "*vc-diff*") |
632e9525 | 1218 | (setq default-directory (file-name-directory file)) |
b246f571 RS |
1219 | (if (= 0 (buffer-size)) |
1220 | (progn | |
1221 | (setq unchanged t) | |
7e48e092 AS |
1222 | (message "No changes to %s since latest version" file)) |
1223 | (pop-to-buffer "*vc-diff*") | |
4c2d8cf9 | 1224 | (goto-char (point-min)) |
064726ac JB |
1225 | (shrink-window-if-larger-than-buffer))) |
1226 | (not unchanged)))) | |
594722a8 ER |
1227 | |
1228 | (defun vc-version-diff (file rel1 rel2) | |
1229 | "For FILE, report diffs between two stored versions REL1 and REL2 of it. | |
1230 | If FILE is a directory, generate diffs between versions for all registered | |
1231 | files in or below it." | |
3234e2a3 | 1232 | (interactive "FFile or directory to diff: \nsOlder version: \nsNewer version: ") |
594722a8 ER |
1233 | (if (string-equal rel1 "") (setq rel1 nil)) |
1234 | (if (string-equal rel2 "") (setq rel2 nil)) | |
1235 | (if (file-directory-p file) | |
1a2f456b | 1236 | (let ((camefrom (current-buffer))) |
594722a8 | 1237 | (set-buffer (get-buffer-create "*vc-status*")) |
8c0aaf40 ER |
1238 | (set (make-local-variable 'vc-parent-buffer) camefrom) |
1239 | (set (make-local-variable 'vc-parent-buffer-name) | |
1240 | (concat " from " (buffer-name camefrom))) | |
594722a8 | 1241 | (erase-buffer) |
3234e2a3 ER |
1242 | (insert "Diffs between " |
1243 | (or rel1 "last version checked in") | |
1244 | " and " | |
1245 | (or rel2 "current workfile(s)") | |
1246 | ":\n\n") | |
6aa13729 | 1247 | (set-buffer (get-buffer-create "*vc-diff*")) |
e1f297e6 | 1248 | (cd file) |
594722a8 | 1249 | (vc-file-tree-walk |
2f119435 | 1250 | default-directory |
594722a8 | 1251 | (function (lambda (f) |
a9a59766 | 1252 | (message "Looking at %s" f) |
594722a8 | 1253 | (and |
3234e2a3 ER |
1254 | (not (file-directory-p f)) |
1255 | (vc-registered f) | |
02da6253 PE |
1256 | (vc-backend-diff f rel1 rel2) |
1257 | (append-to-buffer "*vc-status*" (point-min) (point-max))) | |
1258 | ))) | |
594722a8 ER |
1259 | (pop-to-buffer "*vc-status*") |
1260 | (insert "\nEnd of diffs.\n") | |
1261 | (goto-char (point-min)) | |
1262 | (set-buffer-modified-p nil) | |
1263 | ) | |
36bed8bc RS |
1264 | (if (zerop (vc-backend-diff file rel1 rel2)) |
1265 | (message "No changes to %s between %s and %s." file rel1 rel2) | |
6aa13729 | 1266 | (pop-to-buffer "*vc-diff*")))) |
594722a8 | 1267 | |
f1818994 PE |
1268 | ;;;###autoload |
1269 | (defun vc-version-other-window (rev) | |
1270 | "Visit version REV of the current buffer in another window. | |
1271 | If the current buffer is named `F', the version is named `F.~REV~'. | |
1272 | If `F.~REV~' already exists, it is used instead of being re-created." | |
1273 | (interactive "sVersion to visit (default is latest version): ") | |
1274 | (if vc-dired-mode | |
1275 | (set-buffer (find-file-noselect (dired-get-filename)))) | |
1276 | (while vc-parent-buffer | |
1277 | (pop-to-buffer vc-parent-buffer)) | |
1278 | (if (and buffer-file-name (vc-name buffer-file-name)) | |
1279 | (let* ((version (if (string-equal rev "") | |
1280 | (vc-latest-version buffer-file-name) | |
1281 | rev)) | |
1282 | (filename (concat buffer-file-name ".~" version "~"))) | |
1283 | (or (file-exists-p filename) | |
1284 | (vc-backend-checkout buffer-file-name nil version filename)) | |
1285 | (find-file-other-window filename)) | |
1286 | (vc-registration-error buffer-file-name))) | |
1287 | ||
594722a8 ER |
1288 | ;; Header-insertion code |
1289 | ||
637a8ae9 | 1290 | ;;;###autoload |
594722a8 ER |
1291 | (defun vc-insert-headers () |
1292 | "Insert headers in a file for use with your version-control system. | |
1293 | Headers desired are inserted at the start of the buffer, and are pulled from | |
34291cd2 | 1294 | the variable `vc-header-alist'." |
594722a8 | 1295 | (interactive) |
e1f297e6 ER |
1296 | (if vc-dired-mode |
1297 | (find-file-other-window (dired-get-filename))) | |
8ac8c82f | 1298 | (while vc-parent-buffer |
1a2f456b | 1299 | (pop-to-buffer vc-parent-buffer)) |
594722a8 ER |
1300 | (save-excursion |
1301 | (save-restriction | |
1302 | (widen) | |
1303 | (if (or (not (vc-check-headers)) | |
820bde8d | 1304 | (y-or-n-p "Version headers already exist. Insert another set? ")) |
594722a8 ER |
1305 | (progn |
1306 | (let* ((delims (cdr (assq major-mode vc-comment-alist))) | |
1307 | (comment-start-vc (or (car delims) comment-start "#")) | |
1308 | (comment-end-vc (or (car (cdr delims)) comment-end "")) | |
f3c61d82 | 1309 | (hdstrings (cdr (assoc (vc-backend (buffer-file-name)) vc-header-alist)))) |
594722a8 ER |
1310 | (mapcar (function (lambda (s) |
1311 | (insert comment-start-vc "\t" s "\t" | |
1312 | comment-end-vc "\n"))) | |
1313 | hdstrings) | |
1314 | (if vc-static-header-alist | |
1315 | (mapcar (function (lambda (f) | |
1316 | (if (string-match (car f) buffer-file-name) | |
1317 | (insert (format (cdr f) (car hdstrings)))))) | |
1318 | vc-static-header-alist)) | |
1319 | ) | |
1320 | ))))) | |
1321 | ||
c8de1d91 AS |
1322 | (defun vc-clear-headers () |
1323 | ;; Clear all version headers in the current buffer, i.e. reset them | |
1324 | ;; to the nonexpanded form. Only implemented for RCS, yet. | |
1325 | ;; Don't lose point and mark during this. | |
1326 | (let ((context (vc-buffer-context))) | |
1327 | (goto-char (point-min)) | |
1328 | (while (re-search-forward "\\$\\([A-Za-z]+\\): [^\\$]+\\$" nil t) | |
1329 | (replace-match "$\\1$")) | |
1330 | (vc-restore-buffer-context context))) | |
1331 | ||
2f119435 | 1332 | ;; The VC directory major mode. Coopt Dired for this. |
e1f297e6 ER |
1333 | ;; All VC commands get mapped into logical equivalents. |
1334 | ||
2f119435 AS |
1335 | (define-derived-mode vc-dired-mode dired-mode "Dired under VC" |
1336 | "The major mode used in VC directory buffers. It is derived from Dired. | |
e1f297e6 | 1337 | All Dired commands operate normally. Users currently locking listed files |
ee7e9c88 | 1338 | are listed in place of the file's owner and group. |
e1f297e6 ER |
1339 | Keystrokes bound to VC commands will execute as though they had been called |
1340 | on a buffer attached to the file named in the current Dired buffer line." | |
2f119435 AS |
1341 | (setq vc-dired-mode t)) |
1342 | ||
1343 | (define-key vc-dired-mode-map "\C-xv" vc-prefix-map) | |
1344 | (define-key vc-dired-mode-map "g" 'vc-dired-update) | |
1345 | (define-key vc-dired-mode-map "=" 'vc-diff) | |
594722a8 | 1346 | |
b0c9bc8c AS |
1347 | (defun vc-dired-state-info (file) |
1348 | ;; Return the string that indicates the version control status | |
1349 | ;; on a VC dired line. | |
1350 | (let ((cvs-state (and (eq (vc-backend file) 'CVS) | |
1351 | (vc-cvs-status file)))) | |
1352 | (if cvs-state | |
1353 | (cond ((eq cvs-state 'up-to-date) nil) | |
1354 | ((eq cvs-state 'needs-checkout) "patch") | |
1355 | ((eq cvs-state 'locally-modified) "modified") | |
1356 | ((eq cvs-state 'needs-merge) "merge") | |
1357 | ((eq cvs-state 'unresolved-conflict) "conflict") | |
1358 | ((eq cvs-state 'locally-added) "added")) | |
1359 | (vc-locking-user file)))) | |
1360 | ||
8c0aaf40 ER |
1361 | (defun vc-dired-reformat-line (x) |
1362 | ;; Hack a directory-listing line, plugging in locking-user info in | |
34291cd2 RS |
1363 | ;; place of the user and group info. Should have the beneficial |
1364 | ;; side-effect of shortening the listing line. Each call starts with | |
8c0aaf40 ER |
1365 | ;; point immediately following the dired mark area on the line to be |
1366 | ;; hacked. | |
1367 | ;; | |
1368 | ;; Simplest possible one: | |
1369 | ;; (insert (concat x "\t"))) | |
1370 | ;; | |
1371 | ;; This code, like dired, assumes UNIX -l format. | |
2f119435 AS |
1372 | (let ((pos (point)) limit perm owner date-and-file) |
1373 | (end-of-line) | |
1374 | (setq limit (point)) | |
1375 | (goto-char pos) | |
1376 | (cond | |
1377 | ((or | |
1378 | (re-search-forward ;; owner and group | |
1379 | "\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[^ ]+ +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)" | |
1380 | limit t) | |
1381 | (re-search-forward ;; only owner displayed | |
1382 | "\\([drwxlts-]+ \\) *[0-9]+ \\([^ ]+\\) +[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)" | |
1383 | limit t)) | |
1384 | (setq perm (match-string 1) | |
1385 | owner (match-string 2) | |
1386 | date-and-file (match-string 3))) | |
1387 | ((re-search-forward ;; OS/2 -l format, no links, owner, group | |
1388 | "\\([drwxlts-]+ \\) *[0-9]+\\( [^ 0-9]+ [0-9 ][0-9] .*\\)" | |
1389 | limit t) | |
1390 | (setq perm (match-string 1) | |
1391 | date-and-file (match-string 2)))) | |
80688f5c | 1392 | (if x (setq x (concat "(" x ")"))) |
b0c9bc8c | 1393 | (let ((rep (substring (concat x " ") 0 10))) |
2f119435 AS |
1394 | (replace-match (concat perm rep date-and-file))))) |
1395 | ||
b0c9bc8c AS |
1396 | (defun vc-dired-update-line (file) |
1397 | ;; Update the vc-dired listing line of file -- it is assumed | |
8dd71345 AS |
1398 | ;; that point is already on this line. Don't use dired-do-redisplay |
1399 | ;; for this, because it cannot handle the way vc-dired deals with | |
1400 | ;; subdirectories. | |
b0c9bc8c | 1401 | (beginning-of-line) |
8dd71345 AS |
1402 | (forward-char 2) |
1403 | (let ((start (point))) | |
1404 | (forward-line 1) | |
1405 | (beginning-of-line) | |
1406 | (delete-region start (point)) | |
1407 | (insert-directory file dired-listing-switches) | |
1408 | (forward-line -1) | |
1409 | (end-of-line) | |
1410 | (delete-char (- (length file))) | |
1411 | (insert (substring file (length (expand-file-name default-directory)))) | |
1412 | (goto-char start)) | |
b0c9bc8c | 1413 | (vc-dired-reformat-line (vc-dired-state-info file))) |
8c0aaf40 | 1414 | |
2f119435 AS |
1415 | (defun vc-dired-update (verbose) |
1416 | (interactive "P") | |
1417 | (vc-directory default-directory verbose)) | |
1418 | ||
632e9525 RS |
1419 | ;;; Note in Emacs 18 the following defun gets overridden |
1420 | ;;; with the symbol 'vc-directory-18. See below. | |
637a8ae9 | 1421 | ;;;###autoload |
2f119435 | 1422 | (defun vc-directory (dirname verbose) |
632e9525 RS |
1423 | "Show version-control status of the current directory and subdirectories. |
1424 | Normally it creates a Dired buffer that lists only the locked files | |
1425 | in all these directories. With a prefix argument, it lists all files." | |
2f119435 | 1426 | (interactive "DDired under VC (directory): \nP") |
221cc4f4 | 1427 | (require 'dired) |
2f119435 AS |
1428 | (setq dirname (expand-file-name dirname)) |
1429 | ;; force a trailing slash | |
1430 | (if (not (eq (elt dirname (1- (length dirname))) ?/)) | |
1431 | (setq dirname (concat dirname "/"))) | |
632e9525 | 1432 | (let (nonempty |
2f119435 | 1433 | (dl (length dirname)) |
b0c9bc8c | 1434 | (filelist nil) (statelist nil) |
2f119435 | 1435 | (old-dir default-directory) |
632e9525 RS |
1436 | dired-buf |
1437 | dired-buf-mod-count) | |
1438 | (vc-file-tree-walk | |
2f119435 | 1439 | dirname |
b0c9bc8c AS |
1440 | (function |
1441 | (lambda (f) | |
1442 | (if (vc-registered f) | |
1443 | (let ((state (vc-dired-state-info f))) | |
1444 | (and (or verbose state) | |
1445 | (setq filelist (cons (substring f dl) filelist)) | |
1446 | (setq statelist (cons state statelist)))))))) | |
1447 | (save-window-excursion | |
1448 | (save-excursion | |
2f119435 AS |
1449 | ;; This uses a semi-documented feature of dired; giving a switch |
1450 | ;; argument forces the buffer to refresh each time. | |
1451 | (setq dired-buf | |
1452 | (dired-internal-noselect | |
1453 | (cons dirname (nreverse filelist)) | |
1454 | dired-listing-switches 'vc-dired-mode)) | |
1455 | (setq nonempty (not (eq 0 (length filelist)))))) | |
8dd71345 | 1456 | (switch-to-buffer dired-buf) |
8dd71345 AS |
1457 | ;; Make a few modifications to the header |
1458 | (setq buffer-read-only nil) | |
1459 | (goto-char (point-min)) | |
1460 | (forward-line 1) ;; Skip header line | |
1461 | (let ((start (point))) ;; Erase (but don't remove) the | |
1462 | (end-of-line) ;; "wildcard" line. | |
1463 | (delete-region start (point))) | |
1464 | (beginning-of-line) | |
594722a8 ER |
1465 | (if nonempty |
1466 | (progn | |
8dd71345 | 1467 | ;; Plug the version information into the individual lines |
e1f297e6 | 1468 | (mapcar |
7ef84cf9 RS |
1469 | (function |
1470 | (lambda (x) | |
8c0aaf40 ER |
1471 | (forward-char 2) ;; skip dired's mark area |
1472 | (vc-dired-reformat-line x) | |
7ef84cf9 | 1473 | (forward-line 1))) ;; go to next line |
b0c9bc8c | 1474 | (nreverse statelist)) |
e1f297e6 ER |
1475 | (setq buffer-read-only t) |
1476 | (goto-char (point-min)) | |
8dd71345 | 1477 | (dired-next-line 2) |
e1f297e6 | 1478 | ) |
8dd71345 AS |
1479 | (dired-next-line 1) |
1480 | (insert " ") | |
1481 | (setq buffer-read-only t) | |
02da6253 | 1482 | (message "No files are currently %s under %s" |
2f119435 | 1483 | (if verbose "registered" "locked") dirname)) |
594722a8 ER |
1484 | )) |
1485 | ||
632e9525 RS |
1486 | ;; Emacs 18 version |
1487 | (defun vc-directory-18 (verbose) | |
1488 | "Show version-control status of all files under the current directory." | |
1489 | (interactive "P") | |
1490 | (let (nonempty (dir default-directory)) | |
1491 | (save-excursion | |
1492 | (set-buffer (get-buffer-create "*vc-status*")) | |
1493 | (erase-buffer) | |
1494 | (cd dir) | |
1495 | (vc-file-tree-walk | |
2f119435 | 1496 | default-directory |
632e9525 RS |
1497 | (function (lambda (f) |
1498 | (if (vc-registered f) | |
1499 | (let ((user (vc-locking-user f))) | |
1500 | (if (or user verbose) | |
1501 | (insert (format | |
1502 | "%s %s\n" | |
1503 | (concat user) f)))))))) | |
1504 | (setq nonempty (not (zerop (buffer-size))))) | |
2f119435 | 1505 | |
632e9525 RS |
1506 | (if nonempty |
1507 | (progn | |
1508 | (pop-to-buffer "*vc-status*" t) | |
1509 | (goto-char (point-min)) | |
1510 | (shrink-window-if-larger-than-buffer))) | |
1511 | (message "No files are currently %s under %s" | |
1512 | (if verbose "registered" "locked") default-directory)) | |
1513 | ) | |
1514 | ||
1515 | (or (boundp 'minor-mode-map-alist) | |
1516 | (fset 'vc-directory 'vc-directory-18)) | |
e70bdc98 | 1517 | |
594722a8 ER |
1518 | ;; Named-configuration support for SCCS |
1519 | ||
1520 | (defun vc-add-triple (name file rev) | |
1521 | (save-excursion | |
993a1a44 RS |
1522 | (find-file (expand-file-name |
1523 | vc-name-assoc-file | |
1524 | (file-name-as-directory | |
1525 | (expand-file-name (vc-backend-subdirectory-name file) | |
1526 | (file-name-directory file))))) | |
594722a8 ER |
1527 | (goto-char (point-max)) |
1528 | (insert name "\t:\t" file "\t" rev "\n") | |
1529 | (basic-save-buffer) | |
1530 | (kill-buffer (current-buffer)) | |
1531 | )) | |
1532 | ||
1533 | (defun vc-record-rename (file newname) | |
1534 | (save-excursion | |
993a1a44 RS |
1535 | (find-file |
1536 | (expand-file-name | |
1537 | vc-name-assoc-file | |
1538 | (file-name-as-directory | |
1539 | (expand-file-name (vc-backend-subdirectory-name file) | |
1540 | (file-name-directory file))))) | |
594722a8 | 1541 | (goto-char (point-min)) |
7d847440 RS |
1542 | ;; (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname)) |
1543 | (while (re-search-forward (concat ":" (regexp-quote file) "$") nil t) | |
1544 | (replace-match (concat ":" newname) nil nil)) | |
594722a8 ER |
1545 | (basic-save-buffer) |
1546 | (kill-buffer (current-buffer)) | |
1547 | )) | |
1548 | ||
1549 | (defun vc-lookup-triple (file name) | |
7b4f934d ER |
1550 | ;; Return the numeric version corresponding to a named snapshot of file |
1551 | ;; If name is nil or a version number string it's just passed through | |
47ca02a6 | 1552 | (cond ((null name) name) |
7b4f934d ER |
1553 | ((let ((firstchar (aref name 0))) |
1554 | (and (>= firstchar ?0) (<= firstchar ?9))) | |
1555 | name) | |
1556 | (t | |
b7011339 RS |
1557 | (save-excursion |
1558 | (set-buffer (get-buffer-create "*vc-info*")) | |
993a1a44 RS |
1559 | (vc-insert-file |
1560 | (expand-file-name | |
1561 | vc-name-assoc-file | |
1562 | (file-name-as-directory | |
1563 | (expand-file-name (vc-backend-subdirectory-name file) | |
1564 | (file-name-directory file))))) | |
b7011339 RS |
1565 | (prog1 |
1566 | (car (vc-parse-buffer | |
1567 | (list (list (concat name "\t:\t" file "\t\\(.+\\)") 1)))) | |
1568 | (kill-buffer "*vc-info*")))) | |
1569 | )) | |
594722a8 ER |
1570 | |
1571 | ;; Named-configuration entry points | |
1572 | ||
503b5c85 RS |
1573 | (defun vc-snapshot-precondition () |
1574 | ;; Scan the tree below the current directory. | |
1575 | ;; If any files are locked, return the name of the first such file. | |
1576 | ;; (This means, neither snapshot creation nor retrieval is allowed.) | |
1577 | ;; If one or more of the files are currently visited, return `visited'. | |
1578 | ;; Otherwise, return nil. | |
1579 | (let ((status nil)) | |
1580 | (catch 'vc-locked-example | |
1581 | (vc-file-tree-walk | |
2f119435 | 1582 | default-directory |
503b5c85 RS |
1583 | (function (lambda (f) |
1584 | (and (vc-registered f) | |
1585 | (if (vc-locking-user f) (throw 'vc-locked-example f) | |
1586 | (if (get-file-buffer f) (setq status 'visited))))))) | |
1587 | status))) | |
594722a8 | 1588 | |
637a8ae9 | 1589 | ;;;###autoload |
594722a8 ER |
1590 | (defun vc-create-snapshot (name) |
1591 | "Make a snapshot called NAME. | |
1592 | The snapshot is made from all registered files at or below the current | |
1593 | directory. For each file, the version level of its latest | |
1594 | version becomes part of the named configuration." | |
1595 | (interactive "sNew snapshot name: ") | |
503b5c85 RS |
1596 | (let ((result (vc-snapshot-precondition))) |
1597 | (if (stringp result) | |
1598 | (error "File %s is locked" result) | |
1dabb4e6 | 1599 | (vc-file-tree-walk |
2f119435 | 1600 | default-directory |
1dabb4e6 PE |
1601 | (function (lambda (f) (and |
1602 | (vc-name f) | |
1603 | (vc-backend-assign-name f name))))) | |
1604 | ))) | |
594722a8 | 1605 | |
637a8ae9 | 1606 | ;;;###autoload |
594722a8 ER |
1607 | (defun vc-retrieve-snapshot (name) |
1608 | "Retrieve the snapshot called NAME. | |
1609 | This function fails if any files are locked at or below the current directory | |
1610 | Otherwise, all registered files are checked out (unlocked) at their version | |
1611 | levels in the snapshot." | |
1612 | (interactive "sSnapshot name to retrieve: ") | |
503b5c85 RS |
1613 | (let ((result (vc-snapshot-precondition)) |
1614 | (update nil)) | |
1615 | (if (stringp result) | |
1616 | (error "File %s is locked" result) | |
1617 | (if (eq result 'visited) | |
1618 | (setq update (yes-or-no-p "Update the affected buffers? "))) | |
1dabb4e6 | 1619 | (vc-file-tree-walk |
2f119435 | 1620 | default-directory |
1dabb4e6 PE |
1621 | (function (lambda (f) (and |
1622 | (vc-name f) | |
1623 | (vc-error-occurred | |
503b5c85 RS |
1624 | (vc-backend-checkout f nil name) |
1625 | (if update (vc-resynch-buffer f t t))))))) | |
1dabb4e6 | 1626 | ))) |
594722a8 ER |
1627 | |
1628 | ;; Miscellaneous other entry points | |
1629 | ||
637a8ae9 | 1630 | ;;;###autoload |
594722a8 ER |
1631 | (defun vc-print-log () |
1632 | "List the change log of the current buffer in a window." | |
1633 | (interactive) | |
e1f297e6 ER |
1634 | (if vc-dired-mode |
1635 | (set-buffer (find-file-noselect (dired-get-filename)))) | |
8ac8c82f | 1636 | (while vc-parent-buffer |
1a2f456b | 1637 | (pop-to-buffer vc-parent-buffer)) |
594722a8 | 1638 | (if (and buffer-file-name (vc-name buffer-file-name)) |
632e9525 RS |
1639 | (let ((file buffer-file-name)) |
1640 | (vc-backend-print-log file) | |
594722a8 | 1641 | (pop-to-buffer (get-buffer-create "*vc*")) |
632e9525 | 1642 | (setq default-directory (file-name-directory file)) |
b667752d | 1643 | (goto-char (point-max)) (forward-line -1) |
4805f679 BF |
1644 | (while (looking-at "=*\n") |
1645 | (delete-char (- (match-end 0) (match-beginning 0))) | |
1646 | (forward-line -1)) | |
594722a8 | 1647 | (goto-char (point-min)) |
4805f679 BF |
1648 | (if (looking-at "[\b\t\n\v\f\r ]+") |
1649 | (delete-char (- (match-end 0) (match-beginning 0)))) | |
4c2d8cf9 | 1650 | (shrink-window-if-larger-than-buffer) |
6dfe5fe0 | 1651 | ;; move point to the log entry for the current version |
b667752d AS |
1652 | (and (not (eq (vc-backend file) 'SCCS)) |
1653 | (re-search-forward | |
1654 | ;; also match some context, for safety | |
1655 | (concat "----\nrevision " (vc-workfile-version file) | |
1656 | "\\(\tlocked by:.*\n\\|\n\\)date: ") nil t) | |
1657 | ;; set the display window so that | |
1658 | ;; the whole log entry is displayed | |
1659 | (let (start end lines) | |
1660 | (beginning-of-line) (forward-line -1) (setq start (point)) | |
1661 | (if (not (re-search-forward "^----*\nrevision" nil t)) | |
1662 | (setq end (point-max)) | |
1663 | (beginning-of-line) (forward-line -1) (setq end (point))) | |
1664 | (setq lines (count-lines start end)) | |
1665 | (cond | |
1666 | ;; if the global information and this log entry fit | |
1667 | ;; into the window, display from the beginning | |
1668 | ((< (count-lines (point-min) end) (window-height)) | |
1669 | (goto-char (point-min)) | |
1670 | (recenter 0) | |
1671 | (goto-char start)) | |
1672 | ;; if the whole entry fits into the window, | |
1673 | ;; display it centered | |
1674 | ((< (1+ lines) (window-height)) | |
1675 | (goto-char start) | |
1676 | (recenter (1- (- (/ (window-height) 2) (/ lines 2))))) | |
1677 | ;; otherwise (the entry is too large for the window), | |
1678 | ;; display from the start | |
1679 | (t | |
1680 | (goto-char start) | |
1681 | (recenter 0))))) | |
594722a8 | 1682 | ) |
7ef84cf9 | 1683 | (vc-registration-error buffer-file-name) |
594722a8 ER |
1684 | ) |
1685 | ) | |
1686 | ||
637a8ae9 | 1687 | ;;;###autoload |
594722a8 | 1688 | (defun vc-revert-buffer () |
9c95ac44 RS |
1689 | "Revert the current buffer's file back to the latest checked-in version. |
1690 | This asks for confirmation if the buffer contents are not identical | |
80688f5c RS |
1691 | to that version. |
1692 | If the back-end is CVS, this will give you the most recent revision of | |
1693 | the file on the branch you are editing." | |
594722a8 | 1694 | (interactive) |
e1f297e6 ER |
1695 | (if vc-dired-mode |
1696 | (find-file-other-window (dired-get-filename))) | |
8ac8c82f | 1697 | (while vc-parent-buffer |
1a2f456b | 1698 | (pop-to-buffer vc-parent-buffer)) |
594722a8 | 1699 | (let ((file buffer-file-name) |
221cc4f4 RS |
1700 | ;; This operation should always ask for confirmation. |
1701 | (vc-suppress-confirm nil) | |
97d3f950 | 1702 | (obuf (current-buffer)) (changed (vc-diff nil t))) |
221cc4f4 | 1703 | (if (and changed (not (yes-or-no-p "Discard changes? "))) |
594722a8 | 1704 | (progn |
fab2e906 RS |
1705 | (if (and (window-dedicated-p (selected-window)) |
1706 | (one-window-p t 'selected-frame)) | |
1707 | (make-frame-invisible (selected-frame)) | |
1708 | (delete-window)) | |
590cc449 | 1709 | (error "Revert cancelled")) |
594722a8 ER |
1710 | (set-buffer obuf)) |
1711 | (if changed | |
fab2e906 RS |
1712 | (if (and (window-dedicated-p (selected-window)) |
1713 | (one-window-p t 'selected-frame)) | |
1714 | (make-frame-invisible (selected-frame)) | |
1715 | (delete-window))) | |
594722a8 | 1716 | (vc-backend-revert file) |
624b4662 | 1717 | (vc-resynch-window file t t) |
594722a8 ER |
1718 | ) |
1719 | ) | |
1720 | ||
637a8ae9 | 1721 | ;;;###autoload |
594722a8 | 1722 | (defun vc-cancel-version (norevert) |
34291cd2 RS |
1723 | "Get rid of most recently checked in version of this file. |
1724 | A prefix argument means do not revert the buffer afterwards." | |
594722a8 | 1725 | (interactive "P") |
e1f297e6 ER |
1726 | (if vc-dired-mode |
1727 | (find-file-other-window (dired-get-filename))) | |
8ac8c82f ER |
1728 | (while vc-parent-buffer |
1729 | (pop-to-buffer vc-parent-buffer)) | |
c8de1d91 | 1730 | (cond |
7e48e092 | 1731 | ((not (vc-registered (buffer-file-name))) |
1694bd16 RS |
1732 | (vc-registration-error (buffer-file-name))) |
1733 | ((eq (vc-backend (buffer-file-name)) 'CVS) | |
c8de1d91 AS |
1734 | (error "Unchecking files under CVS is dangerous and not supported in VC")) |
1735 | ((vc-locking-user (buffer-file-name)) | |
2c28ac43 | 1736 | (error "This version is locked; use vc-revert-buffer to discard changes")) |
c8de1d91 | 1737 | ((not (vc-latest-on-branch-p (buffer-file-name))) |
2c28ac43 | 1738 | (error "This is not the latest version--VC cannot cancel it"))) |
7e48e092 AS |
1739 | (let* ((target (vc-workfile-version (buffer-file-name))) |
1740 | (recent (if (vc-trunk-p target) "" (vc-branch-part target))) | |
1741 | (config (current-window-configuration)) done) | |
1742 | (if (null (yes-or-no-p (format "Remove version %s from master? " target))) | |
7b4f934d | 1743 | nil |
c8de1d91 AS |
1744 | (setq norevert (or norevert (not |
1745 | (yes-or-no-p "Revert buffer to most recent remaining version? ")))) | |
7b4f934d | 1746 | (vc-backend-uncheck (buffer-file-name) target) |
7e48e092 AS |
1747 | ;; Check out the most recent remaining version. If it fails, because |
1748 | ;; the whole branch got deleted, do a double-take and check out the | |
1749 | ;; version where the branch started. | |
1750 | (while (not done) | |
1751 | (condition-case err | |
1752 | (progn | |
1753 | (if norevert | |
1754 | ;; Check out locked, but only to disc, and keep | |
1755 | ;; modifications in the buffer. | |
1756 | (vc-backend-checkout (buffer-file-name) t recent) | |
1757 | ;; Check out unlocked, and revert buffer. | |
1758 | (vc-checkout (buffer-file-name) nil recent)) | |
1759 | (setq done t)) | |
ae2506d0 AS |
1760 | ;; If the checkout fails, vc-do-command signals an error. |
1761 | ;; We catch this error, check the reason, correct the | |
1762 | ;; version number, and try a second time. | |
7e48e092 AS |
1763 | (error (set-buffer "*vc*") |
1764 | (goto-char (point-min)) | |
ae2506d0 | 1765 | (if (search-forward "no side branches present for" nil t) |
7e48e092 | 1766 | (progn (setq recent (vc-branch-part recent)) |
ae2506d0 AS |
1767 | ;; vc-do-command popped up a window with |
1768 | ;; the error message. Get rid of it, by | |
1769 | ;; restoring the old window configuration. | |
7e48e092 AS |
1770 | (set-window-configuration config)) |
1771 | ;; No, it was some other error: re-signal it. | |
1772 | (signal (car err) (cdr err)))))) | |
1773 | ;; If norevert, clear version headers and mark the buffer modified. | |
1774 | (if norevert | |
1775 | (progn | |
1776 | (set-visited-file-name (buffer-file-name)) | |
1777 | (if (not vc-make-backup-files) | |
1778 | ;; inhibit backup for this buffer | |
1779 | (progn (make-local-variable 'backup-inhibited) | |
1780 | (setq backup-inhibited t))) | |
1781 | (if (eq (vc-backend (buffer-file-name)) 'RCS) | |
1782 | (progn (setq buffer-read-only nil) | |
1783 | (vc-clear-headers))) | |
1784 | (vc-mode-line (buffer-file-name)))) | |
1785 | (message "Version %s has been removed from the master" target) | |
c8de1d91 | 1786 | ))) |
594722a8 | 1787 | |
29fc1ce9 | 1788 | ;;;###autoload |
594722a8 | 1789 | (defun vc-rename-file (old new) |
34291cd2 RS |
1790 | "Rename file OLD to NEW, and rename its master file likewise." |
1791 | (interactive "fVC rename file: \nFRename to: ") | |
80688f5c RS |
1792 | ;; There are several ways of renaming files under CVS 1.3, but they all |
1793 | ;; have serious disadvantages. See the FAQ (available from think.com in | |
1794 | ;; pub/cvs/). I'd rather send the user an error, than do something he might | |
1795 | ;; consider to be wrong. When the famous, long-awaited rename database is | |
1796 | ;; implemented things might change for the better. This is unlikely to occur | |
1797 | ;; until CVS 2.0 is released. --ceder 1994-01-23 21:27:51 | |
f3c61d82 | 1798 | (if (eq (vc-backend old) 'CVS) |
2c28ac43 | 1799 | (error "Renaming files under CVS is dangerous and not supported in VC")) |
594722a8 | 1800 | (let ((oldbuf (get-file-buffer old))) |
d52f0de9 | 1801 | (if (and oldbuf (buffer-modified-p oldbuf)) |
590cc449 | 1802 | (error "Please save files before moving them")) |
594722a8 | 1803 | (if (get-file-buffer new) |
590cc449 | 1804 | (error "Already editing new file name")) |
d52f0de9 RS |
1805 | (if (file-exists-p new) |
1806 | (error "New file already exists")) | |
594722a8 ER |
1807 | (let ((oldmaster (vc-name old))) |
1808 | (if oldmaster | |
d52f0de9 RS |
1809 | (progn |
1810 | (if (vc-locking-user old) | |
1811 | (error "Please check in files before moving them")) | |
1812 | (if (or (file-symlink-p oldmaster) | |
1813 | ;; This had FILE, I changed it to OLD. -- rms. | |
1814 | (file-symlink-p (vc-backend-subdirectory-name old))) | |
1815 | (error "This is not a safe thing to do in the presence of symbolic links")) | |
1816 | (rename-file | |
1817 | oldmaster | |
f3c61d82 | 1818 | (let ((backend (vc-backend old)) |
d52f0de9 RS |
1819 | (newdir (or (file-name-directory new) "")) |
1820 | (newbase (file-name-nondirectory new))) | |
1821 | (catch 'found | |
1822 | (mapcar | |
1823 | (function | |
1824 | (lambda (s) | |
1825 | (if (eq backend (cdr s)) | |
1826 | (let* ((newmaster (format (car s) newdir newbase)) | |
1827 | (newmasterdir (file-name-directory newmaster))) | |
1828 | (if (or (not newmasterdir) | |
1829 | (file-directory-p newmasterdir)) | |
1830 | (throw 'found newmaster)))))) | |
1831 | vc-master-templates) | |
1832 | (error "New file lacks a version control directory")))))) | |
594722a8 ER |
1833 | (if (or (not oldmaster) (file-exists-p old)) |
1834 | (rename-file old new))) | |
1835 | ; ?? Renaming a file might change its contents due to keyword expansion. | |
1836 | ; We should really check out a new copy if the old copy was precisely equal | |
1837 | ; to some checked in version. However, testing for this is tricky.... | |
1838 | (if oldbuf | |
1839 | (save-excursion | |
1840 | (set-buffer oldbuf) | |
4c145b9e RS |
1841 | (let ((buffer-read-only buffer-read-only)) |
1842 | (set-visited-file-name new)) | |
1843 | (vc-backend new) | |
1844 | (vc-mode-line new) | |
594722a8 | 1845 | (set-buffer-modified-p nil)))) |
60213ed0 RS |
1846 | ;; This had FILE, I changed it to OLD. -- rms. |
1847 | (vc-backend-dispatch old | |
80688f5c RS |
1848 | (vc-record-rename old new) ;SCCS |
1849 | nil ;RCS | |
1850 | nil ;CVS | |
1851 | ) | |
594722a8 ER |
1852 | ) |
1853 | ||
637a8ae9 | 1854 | ;;;###autoload |
f35ecf88 | 1855 | (defun vc-update-change-log (&rest args) |
73a9679c | 1856 | "Find change log file and add entries from recent RCS/CVS logs. |
d68e6990 RS |
1857 | Normally, find log entries for all registered files in the default |
1858 | directory using `rcs2log', which finds CVS logs preferentially. | |
f35ecf88 | 1859 | The mark is left at the end of the text prepended to the change log. |
d68e6990 | 1860 | |
f35ecf88 | 1861 | With prefix arg of C-u, only find log entries for the current buffer's file. |
d68e6990 RS |
1862 | |
1863 | With any numeric prefix arg, find log entries for all currently visited | |
1864 | files that are under version control. This puts all the entries in the | |
1865 | log for the default directory, which may not be appropriate. | |
1866 | ||
73a9679c RS |
1867 | From a program, any arguments are assumed to be filenames and are |
1868 | passed to the `rcs2log' script after massaging to be relative to the | |
1869 | default directory." | |
67242a23 RM |
1870 | (interactive |
1871 | (cond ((consp current-prefix-arg) ;C-u | |
1872 | (list buffer-file-name)) | |
1873 | (current-prefix-arg ;Numeric argument. | |
1874 | (let ((files nil) | |
1875 | (buffers (buffer-list)) | |
1876 | file) | |
1877 | (while buffers | |
1878 | (setq file (buffer-file-name (car buffers))) | |
f3c61d82 | 1879 | (and file (vc-backend file) |
4b40fdea | 1880 | (setq files (cons file files))) |
67242a23 | 1881 | (setq buffers (cdr buffers))) |
4b40fdea PE |
1882 | files)) |
1883 | (t | |
73a9679c RS |
1884 | ;; `rcs2log' will find the relevant RCS or CVS files |
1885 | ;; relative to the curent directory if none supplied. | |
1886 | nil))) | |
449decf5 | 1887 | (let ((odefault default-directory) |
124c852b RS |
1888 | (changelog (find-change-log)) |
1889 | ;; Presumably not portable to non-Unixy systems, along with rcs2log: | |
1890 | (tempfile (make-temp-name | |
1891 | (concat (file-name-as-directory | |
1892 | (directory-file-name (or (getenv "TMPDIR") | |
1893 | (getenv "TMP") | |
1894 | (getenv "TEMP") | |
1895 | "/tmp"))) | |
1896 | "vc"))) | |
b91916f3 | 1897 | (full-name (or add-log-full-name |
8172cd86 AS |
1898 | (user-full-name) |
1899 | (user-login-name) | |
1900 | (format "uid%d" (number-to-string (user-uid))))) | |
b91916f3 RS |
1901 | (mailing-address (or add-log-mailing-address |
1902 | user-mail-address))) | |
124c852b | 1903 | (find-file-other-window changelog) |
41dfb835 RS |
1904 | (barf-if-buffer-read-only) |
1905 | (vc-buffer-sync) | |
1906 | (undo-boundary) | |
1907 | (goto-char (point-min)) | |
1908 | (push-mark) | |
1909 | (message "Computing change log entries...") | |
4b40fdea | 1910 | (message "Computing change log entries... %s" |
124c852b RS |
1911 | (unwind-protect |
1912 | (progn | |
1913 | (cd odefault) | |
1914 | (if (eq 0 (apply 'call-process "rcs2log" nil | |
1915 | (list t tempfile) nil | |
1916 | "-c" changelog | |
1917 | "-u" (concat (vc-user-login-name) | |
1918 | "\t" full-name | |
1919 | "\t" mailing-address) | |
1920 | (mapcar | |
1921 | (function | |
1922 | (lambda (f) | |
1923 | (file-relative-name | |
1924 | (if (file-name-absolute-p f) | |
1925 | f | |
1926 | (concat odefault f))))) | |
1927 | args))) | |
1928 | "done" | |
1929 | (pop-to-buffer | |
1930 | (set-buffer (get-buffer-create "*vc*"))) | |
1931 | (erase-buffer) | |
1932 | (insert-file tempfile) | |
1933 | "failed")) | |
1934 | (cd (file-name-directory changelog)) | |
1935 | (delete-file tempfile))))) | |
594722a8 | 1936 | |
c6d4f628 | 1937 | ;; Collect back-end-dependent stuff here |
594722a8 | 1938 | |
594722a8 ER |
1939 | (defun vc-backend-admin (file &optional rev comment) |
1940 | ;; Register a file into the version-control system | |
1941 | ;; Automatically retrieves a read-only version of the file with | |
1942 | ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise | |
1943 | ;; it deletes the workfile. | |
1944 | (vc-file-clearprops file) | |
1945 | (or vc-default-back-end | |
1946 | (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS))) | |
1947 | (message "Registering %s..." file) | |
a633d9af RS |
1948 | (let ((switches |
1949 | (if (stringp vc-register-switches) | |
1950 | (list vc-register-switches) | |
1951 | vc-register-switches)) | |
1952 | (backend | |
594722a8 ER |
1953 | (cond |
1954 | ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end) | |
1955 | ((file-exists-p "RCS") 'RCS) | |
1956 | ((file-exists-p "SCCS") 'SCCS) | |
80688f5c | 1957 | ((file-exists-p "CVS") 'CVS) |
594722a8 ER |
1958 | (t vc-default-back-end)))) |
1959 | (cond ((eq backend 'SCCS) | |
a1d713ef AS |
1960 | ;; If there is no SCCS subdirectory yet, create it. |
1961 | ;; (SCCS could do without it, but VC requires it to be there.) | |
1962 | (if (not (file-exists-p "SCCS")) (make-directory "SCCS")) | |
a633d9af RS |
1963 | (apply 'vc-do-command nil 0 "admin" file 'MASTER ;; SCCS |
1964 | (and rev (concat "-r" rev)) | |
1965 | "-fb" | |
1966 | (concat "-i" file) | |
1967 | (and comment (concat "-y" comment)) | |
1968 | (format | |
1969 | (car (rassq 'SCCS vc-master-templates)) | |
1970 | (or (file-name-directory file) "") | |
1971 | (file-name-nondirectory file)) | |
1972 | switches) | |
594722a8 ER |
1973 | (delete-file file) |
1974 | (if vc-keep-workfiles | |
6aa13729 | 1975 | (vc-do-command nil 0 "get" file 'MASTER))) |
594722a8 | 1976 | ((eq backend 'RCS) |
a633d9af RS |
1977 | (apply 'vc-do-command nil 0 "ci" file 'WORKFILE ;; RCS |
1978 | ;; if available, use the secure registering option | |
1979 | (and (vc-backend-release-p 'RCS "5.6.4") "-i") | |
1980 | (concat (if vc-keep-workfiles "-u" "-r") rev) | |
1981 | (and comment (concat "-t-" comment)) | |
1982 | switches)) | |
80688f5c | 1983 | ((eq backend 'CVS) |
a633d9af RS |
1984 | (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE ;; CVS |
1985 | "add" | |
1986 | (and comment (string-match "[^\t\n ]" comment) | |
1987 | (concat "-m" comment)) | |
1988 | switches) | |
594722a8 ER |
1989 | ))) |
1990 | (message "Registering %s...done" file) | |
1991 | ) | |
1992 | ||
f1818994 | 1993 | (defun vc-backend-checkout (file &optional writable rev workfile) |
594722a8 | 1994 | ;; Retrieve a copy of a saved version into a workfile |
503b5c85 RS |
1995 | (let ((filename (or workfile file)) |
1996 | (file-buffer (get-file-buffer file)) | |
2c28ac43 | 1997 | switches) |
f1818994 | 1998 | (message "Checking out %s..." filename) |
f797cb30 | 1999 | (save-excursion |
2c28ac43 | 2000 | ;; Change buffers to get local value of vc-checkout-switches. |
503b5c85 | 2001 | (if file-buffer (set-buffer file-buffer)) |
2c28ac43 RS |
2002 | (setq switches (if (stringp vc-checkout-switches) |
2003 | (list vc-checkout-switches) | |
2004 | vc-checkout-switches)) | |
f008ca58 KH |
2005 | ;; Save this buffer's default-directory |
2006 | ;; and use save-excursion to make sure it is restored | |
2007 | ;; in the same buffer it was saved in. | |
2008 | (let ((default-directory default-directory)) | |
2009 | (save-excursion | |
2010 | ;; Adjust the default-directory so that the check-out creates | |
2011 | ;; the file in the right place. | |
2012 | (setq default-directory (file-name-directory filename)) | |
2013 | (vc-backend-dispatch file | |
2014 | (progn ;; SCCS | |
2015 | (and rev (string= rev "") (setq rev nil)) | |
2016 | (if workfile | |
2017 | ;; Some SCCS implementations allow checking out directly to a | |
2018 | ;; file using the -G option, but then some don't so use the | |
2019 | ;; least common denominator approach and use the -p option | |
2020 | ;; ala RCS. | |
2021 | (let ((vc-modes (logior (file-modes (vc-name file)) | |
2022 | (if writable 128 0))) | |
2023 | (failed t)) | |
2024 | (unwind-protect | |
2025 | (progn | |
2026 | (apply 'vc-do-command | |
2027 | nil 0 "/bin/sh" file 'MASTER "-c" | |
2028 | ;; Some shells make the "" dummy argument into $0 | |
2029 | ;; while others use the shell's name as $0 and | |
2030 | ;; use the "" as $1. The if-statement | |
2031 | ;; converts the latter case to the former. | |
2032 | (format "if [ x\"$1\" = x ]; then shift; fi; \ | |
29fc1ce9 RS |
2033 | umask %o; exec >\"$1\" || exit; \ |
2034 | shift; umask %o; exec get \"$@\"" | |
f008ca58 KH |
2035 | (logand 511 (lognot vc-modes)) |
2036 | (logand 511 (lognot (default-file-modes)))) | |
2037 | "" ; dummy argument for shell's $0 | |
2038 | filename | |
2039 | (if writable "-e") | |
2040 | "-p" | |
2041 | (and rev | |
2042 | (concat "-r" (vc-lookup-triple file rev))) | |
2043 | switches) | |
2044 | (setq failed nil)) | |
2045 | (and failed (file-exists-p filename) | |
2046 | (delete-file filename)))) | |
2047 | (apply 'vc-do-command nil 0 "get" file 'MASTER ;; SCCS | |
2048 | (if writable "-e") | |
2049 | (and rev (concat "-r" (vc-lookup-triple file rev))) | |
2050 | switches) | |
2051 | (vc-file-setprop file 'vc-workfile-version nil))) | |
2052 | (if workfile ;; RCS | |
2053 | ;; RCS doesn't let us check out into arbitrary file names directly. | |
2054 | ;; Use `co -p' and make stdout point to the correct file. | |
2055 | (let ((vc-modes (logior (file-modes (vc-name file)) | |
2056 | (if writable 128 0))) | |
2057 | (failed t)) | |
2058 | (unwind-protect | |
2059 | (progn | |
2060 | (apply 'vc-do-command | |
2061 | nil 0 "/bin/sh" file 'MASTER "-c" | |
2062 | ;; See the SCCS case, above, regarding the | |
2063 | ;; if-statement. | |
2064 | (format "if [ x\"$1\" = x ]; then shift; fi; \ | |
29fc1ce9 RS |
2065 | umask %o; exec >\"$1\" || exit; \ |
2066 | shift; umask %o; exec co \"$@\"" | |
f008ca58 KH |
2067 | (logand 511 (lognot vc-modes)) |
2068 | (logand 511 (lognot (default-file-modes)))) | |
2069 | "" ; dummy argument for shell's $0 | |
2070 | filename | |
2071 | (if writable "-l") | |
2072 | (concat "-p" rev) | |
2073 | switches) | |
2074 | (setq failed nil)) | |
2075 | (and failed (file-exists-p filename) (delete-file filename)))) | |
2076 | (let (new-version) | |
2077 | ;; if we should go to the head of the trunk, | |
2078 | ;; clear the default branch first | |
2079 | (and rev (string= rev "") | |
2080 | (vc-do-command nil 0 "rcs" file 'MASTER "-b")) | |
2081 | ;; now do the checkout | |
2082 | (apply 'vc-do-command | |
2083 | nil 0 "co" file 'MASTER | |
2084 | ;; If locking is not strict, force to overwrite | |
2085 | ;; the writable workfile. | |
2086 | (if (eq (vc-checkout-model file) 'implicit) "-f") | |
2087 | (if writable "-l") | |
2088 | (if rev (concat "-r" rev) | |
2089 | ;; if no explicit revision was specified, | |
2090 | ;; check out that of the working file | |
2091 | (let ((workrev (vc-workfile-version file))) | |
2092 | (if workrev (concat "-r" workrev) | |
2093 | nil))) | |
2094 | switches) | |
2095 | ;; determine the new workfile version | |
2096 | (save-excursion | |
2097 | (set-buffer "*vc*") | |
2098 | (goto-char (point-min)) | |
2099 | (setq new-version | |
2100 | (if (re-search-forward "^revision \\([0-9.]+\\).*\n" nil t) | |
2101 | (buffer-substring (match-beginning 1) (match-end 1))))) | |
2102 | (vc-file-setprop file 'vc-workfile-version new-version) | |
2103 | ;; if necessary, adjust the default branch | |
2104 | (and rev (not (string= rev "")) | |
2105 | (vc-do-command nil 0 "rcs" file 'MASTER | |
2106 | (concat "-b" (if (vc-latest-on-branch-p file) | |
2107 | (if (vc-trunk-p new-version) nil | |
2108 | (vc-branch-part new-version)) | |
2109 | new-version)))))) | |
2110 | (if workfile ;; CVS | |
2111 | ;; CVS is much like RCS | |
2112 | (let ((failed t)) | |
2113 | (unwind-protect | |
2114 | (progn | |
2115 | (apply 'vc-do-command | |
2116 | nil 0 "/bin/sh" file 'WORKFILE "-c" | |
2117 | "exec >\"$1\" || exit; shift; exec cvs update \"$@\"" | |
2118 | "" ; dummy argument for shell's $0 | |
2119 | workfile | |
2120 | (concat "-r" rev) | |
2121 | "-p" | |
2122 | switches) | |
2123 | (setq failed nil)) | |
2124 | (and failed (file-exists-p filename) (delete-file filename)))) | |
2125 | ;; default for verbose checkout: clear the sticky tag | |
2126 | ;; so that the actual update will get the head of the trunk | |
2127 | (and rev (string= rev "") | |
2128 | (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A")) | |
2129 | ;; If a revision was specified, check that out. | |
2130 | (if rev | |
2131 | (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE | |
2132 | (and writable (eq (vc-checkout-model file) 'manual) "-w") | |
2133 | "update" | |
2134 | (and rev (not (string= rev "")) | |
2135 | (concat "-r" rev)) | |
2136 | switches) | |
2137 | ;; If no revision was specified, simply make the file writable. | |
2138 | (and writable | |
2139 | (or (eq (vc-checkout-model file) 'manual) | |
2140 | (zerop (logand 128 (file-modes file)))) | |
2141 | (set-file-modes file (logior 128 (file-modes file))))) | |
2142 | (if rev (vc-file-setprop file 'vc-workfile-version nil)))) | |
2143 | (cond | |
2144 | ((not workfile) | |
2145 | (vc-file-clear-masterprops file) | |
2146 | (if writable | |
8172cd86 | 2147 | (vc-file-setprop file 'vc-locking-user (vc-user-login-name))) |
f008ca58 KH |
2148 | (vc-file-setprop file |
2149 | 'vc-checkout-time (nth 5 (file-attributes file))))) | |
2150 | (message "Checking out %s...done" filename)))))) | |
594722a8 ER |
2151 | |
2152 | (defun vc-backend-logentry-check (file) | |
2153 | (vc-backend-dispatch file | |
8c0aaf40 | 2154 | (if (>= (buffer-size) 512) ;; SCCS |
594722a8 ER |
2155 | (progn |
2156 | (goto-char 512) | |
2157 | (error | |
590cc449 | 2158 | "Log must be less than 512 characters; point is now at pos 512"))) |
80688f5c RS |
2159 | nil ;; RCS |
2160 | nil) ;; CVS | |
594722a8 ER |
2161 | ) |
2162 | ||
80688f5c | 2163 | (defun vc-backend-checkin (file rev comment) |
594722a8 ER |
2164 | ;; Register changes to FILE as level REV with explanatory COMMENT. |
2165 | ;; Automatically retrieves a read-only version of the file with | |
2166 | ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise | |
2167 | ;; it deletes the workfile. | |
a7acbbe4 | 2168 | ;; Adaptation for RCS branch support: if this is an explicit checkin, |
c6d4f628 RS |
2169 | ;; or if the checkin creates a new branch, set the master file branch |
2170 | ;; accordingly. | |
594722a8 | 2171 | (message "Checking in %s..." file) |
7d665008 | 2172 | ;; "This log message intentionally left almost blank". |
9e0cc6e6 RS |
2173 | ;; RCS 5.7 gripes about white-space-only comments too. |
2174 | (or (and comment (string-match "[^\t\n ]" comment)) | |
2175 | (setq comment "*** empty log message ***")) | |
2ea8ce47 RM |
2176 | (save-excursion |
2177 | ;; Change buffers to get local value of vc-checkin-switches. | |
2178 | (set-buffer (or (get-file-buffer file) (current-buffer))) | |
2c28ac43 | 2179 | (let ((switches |
90681ae2 EN |
2180 | (if (stringp vc-checkin-switches) |
2181 | (list vc-checkin-switches) | |
2182 | vc-checkin-switches))) | |
2c28ac43 RS |
2183 | ;; Clear the master-properties. Do that here, not at the |
2184 | ;; end, because if the check-in fails we want them to get | |
2185 | ;; re-computed before the next try. | |
2186 | (vc-file-clear-masterprops file) | |
2187 | (vc-backend-dispatch file | |
2188 | ;; SCCS | |
2189 | (progn | |
2190 | (apply 'vc-do-command nil 0 "delta" file 'MASTER | |
2191 | (if rev (concat "-r" rev)) | |
2192 | (concat "-y" comment) | |
2193 | switches) | |
2194 | (vc-file-setprop file 'vc-locking-user 'none) | |
2195 | (vc-file-setprop file 'vc-workfile-version nil) | |
2196 | (if vc-keep-workfiles | |
2197 | (vc-do-command nil 0 "get" file 'MASTER)) | |
2198 | ) | |
2199 | ;; RCS | |
2200 | (let ((old-version (vc-workfile-version file)) new-version) | |
2201 | (apply 'vc-do-command nil 0 "ci" file 'MASTER | |
2202 | ;; if available, use the secure check-in option | |
2203 | (and (vc-backend-release-p 'RCS "5.6.4") "-j") | |
2204 | (concat (if vc-keep-workfiles "-u" "-r") rev) | |
2205 | (concat "-m" comment) | |
2206 | switches) | |
2207 | (vc-file-setprop file 'vc-locking-user 'none) | |
2208 | (vc-file-setprop file 'vc-workfile-version nil) | |
2209 | ||
2210 | ;; determine the new workfile version | |
2211 | (set-buffer "*vc*") | |
2212 | (goto-char (point-min)) | |
2213 | (if (or (re-search-forward | |
2214 | "new revision: \\([0-9.]+\\);" nil t) | |
2215 | (re-search-forward | |
2216 | "reverting to previous revision \\([0-9.]+\\)" nil t)) | |
2217 | (progn (setq new-version (buffer-substring (match-beginning 1) | |
2218 | (match-end 1))) | |
2219 | (vc-file-setprop file 'vc-workfile-version new-version))) | |
2220 | ||
2221 | ;; if we got to a different branch, adjust the default | |
2222 | ;; branch accordingly | |
2223 | (cond | |
2224 | ((and old-version new-version | |
2225 | (not (string= (vc-branch-part old-version) | |
2226 | (vc-branch-part new-version)))) | |
2227 | (vc-do-command nil 0 "rcs" file 'MASTER | |
2228 | (if (vc-trunk-p new-version) "-b" | |
2229 | (concat "-b" (vc-branch-part new-version)))) | |
2230 | ;; If this is an old RCS release, we might have | |
2231 | ;; to remove a remaining lock. | |
2232 | (if (not (vc-backend-release-p 'RCS "5.6.2")) | |
2233 | ;; exit status of 1 is also accepted. | |
2234 | ;; It means that the lock was removed before. | |
2235 | (vc-do-command nil 1 "rcs" file 'MASTER | |
2236 | (concat "-u" old-version)))))) | |
2237 | ;; CVS | |
2238 | (progn | |
2239 | ;; explicit check-in to the trunk requires a | |
2240 | ;; double check-in (first unexplicit) (CVS-1.3) | |
2241 | (condition-case nil | |
2242 | (progn | |
2243 | (if (and rev (vc-trunk-p rev)) | |
2244 | (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE | |
2245 | "ci" "-m" "intermediate" | |
2246 | switches)) | |
2247 | (apply 'vc-do-command nil 0 "cvs" file 'WORKFILE | |
2248 | "ci" (if rev (concat "-r" rev)) | |
2249 | (concat "-m" comment) | |
2250 | switches)) | |
2251 | (error (if (eq (vc-cvs-status file) 'needs-merge) | |
2252 | ;; The CVS output will be on top of this message. | |
2253 | (error "Type C-x 0 C-x C-q to merge in changes") | |
2254 | (error "Check-in failed")))) | |
2255 | ;; determine and store the new workfile version | |
2256 | (set-buffer "*vc*") | |
2257 | (goto-char (point-min)) | |
2258 | (if (re-search-forward | |
2259 | "^\\(new\\|initial\\) revision: \\([0-9.]+\\)" nil t) | |
2260 | (vc-file-setprop file 'vc-workfile-version | |
2261 | (buffer-substring (match-beginning 2) | |
2262 | (match-end 2))) | |
2263 | (vc-file-setprop file 'vc-workfile-version nil)) | |
2264 | ;; if this was an explicit check-in, remove the sticky tag | |
2265 | (if rev | |
2266 | (vc-do-command nil 0 "cvs" file 'WORKFILE "update" "-A")) | |
2267 | (vc-file-setprop file 'vc-locking-user 'none) | |
2268 | (vc-file-setprop file 'vc-checkout-time | |
2269 | (nth 5 (file-attributes file))))))) | |
88a2ffaf | 2270 | (message "Checking in %s...done" file)) |
594722a8 ER |
2271 | |
2272 | (defun vc-backend-revert (file) | |
2273 | ;; Revert file to latest checked-in version. | |
c6d4f628 | 2274 | ;; (for RCS, to workfile version) |
594722a8 | 2275 | (message "Reverting %s..." file) |
61dee1e7 | 2276 | (vc-file-clear-masterprops file) |
594722a8 ER |
2277 | (vc-backend-dispatch |
2278 | file | |
c6d4f628 RS |
2279 | ;; SCCS |
2280 | (progn | |
6aa13729 RS |
2281 | (vc-do-command nil 0 "unget" file 'MASTER nil) |
2282 | (vc-do-command nil 0 "get" file 'MASTER nil)) | |
c6d4f628 | 2283 | ;; RCS |
6aa13729 | 2284 | (vc-do-command nil 0 "co" file 'MASTER |
c6d4f628 RS |
2285 | "-f" (concat "-u" (vc-workfile-version file))) |
2286 | ;; CVS | |
2287 | (progn | |
80688f5c | 2288 | (delete-file file) |
6aa13729 | 2289 | (vc-do-command nil 0 "cvs" file 'WORKFILE "update"))) |
88a2ffaf | 2290 | (vc-file-setprop file 'vc-locking-user 'none) |
c6d4f628 | 2291 | (vc-file-setprop file 'vc-checkout-time (nth 5 (file-attributes file))) |
594722a8 ER |
2292 | (message "Reverting %s...done" file) |
2293 | ) | |
2294 | ||
2295 | (defun vc-backend-steal (file &optional rev) | |
2296 | ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M. | |
2297 | (message "Stealing lock on %s..." file) | |
af1b8606 | 2298 | (vc-backend-dispatch file |
80688f5c | 2299 | (progn ;SCCS |
6aa13729 RS |
2300 | (vc-do-command nil 0 "unget" file 'MASTER "-n" (if rev (concat "-r" rev))) |
2301 | (vc-do-command nil 0 "get" file 'MASTER "-g" (if rev (concat "-r" rev))) | |
d76b8d38 | 2302 | ) |
6aa13729 | 2303 | (vc-do-command nil 0 "rcs" file 'MASTER ;RCS |
80688f5c | 2304 | "-M" (concat "-u" rev) (concat "-l" rev)) |
2c28ac43 | 2305 | (error "You cannot steal a CVS lock; there are no CVS locks to steal") ;CVS |
80688f5c | 2306 | ) |
8172cd86 | 2307 | (vc-file-setprop file 'vc-locking-user (vc-user-login-name)) |
594722a8 ER |
2308 | (message "Stealing lock on %s...done" file) |
2309 | ) | |
2310 | ||
2311 | (defun vc-backend-uncheck (file target) | |
c8de1d91 | 2312 | ;; Undo the latest checkin. |
594722a8 ER |
2313 | (message "Removing last change from %s..." file) |
2314 | (vc-backend-dispatch file | |
6aa13729 RS |
2315 | (vc-do-command nil 0 "rmdel" file 'MASTER (concat "-r" target)) |
2316 | (vc-do-command nil 0 "rcs" file 'MASTER (concat "-o" target)) | |
88a2ffaf | 2317 | nil ;; this is never reached under CVS |
594722a8 ER |
2318 | ) |
2319 | (message "Removing last change from %s...done" file) | |
2320 | ) | |
2321 | ||
2322 | (defun vc-backend-print-log (file) | |
6aa13729 | 2323 | ;; Get change log associated with FILE. |
80688f5c RS |
2324 | (vc-backend-dispatch |
2325 | file | |
6aa13729 RS |
2326 | (vc-do-command nil 0 "prs" file 'MASTER) |
2327 | (vc-do-command nil 0 "rlog" file 'MASTER) | |
81b8f0e6 | 2328 | (vc-do-command nil 0 "cvs" file 'WORKFILE "log"))) |
594722a8 ER |
2329 | |
2330 | (defun vc-backend-assign-name (file name) | |
2331 | ;; Assign to a FILE's latest version a given NAME. | |
2332 | (vc-backend-dispatch file | |
6aa13729 RS |
2333 | (vc-add-triple name file (vc-latest-version file)) ;; SCCS |
2334 | (vc-do-command nil 0 "rcs" file 'MASTER (concat "-n" name ":")) ;; RCS | |
2335 | (vc-do-command nil 0 "cvs" file 'WORKFILE "tag" name) ;; CVS | |
3234e2a3 | 2336 | ) |
3234e2a3 | 2337 | ) |
594722a8 | 2338 | |
9a51ed3a PE |
2339 | (defun vc-backend-diff (file &optional oldvers newvers cmp) |
2340 | ;; Get a difference report between two versions of FILE. | |
2341 | ;; Get only a brief comparison report if CMP, a difference report otherwise. | |
eb302e54 AS |
2342 | (let ((backend (vc-backend file)) options status |
2343 | (diff-switches-list (if (listp diff-switches) | |
2344 | diff-switches | |
2345 | (list diff-switches)))) | |
80688f5c RS |
2346 | (cond |
2347 | ((eq backend 'SCCS) | |
7b4f934d | 2348 | (setq oldvers (vc-lookup-triple file oldvers)) |
eb302e54 AS |
2349 | (setq newvers (vc-lookup-triple file newvers)) |
2350 | (setq options (append (list (and cmp "--brief") "-q" | |
2351 | (and oldvers (concat "-r" oldvers)) | |
2352 | (and newvers (concat "-r" newvers))) | |
2353 | (and (not cmp) diff-switches-list))) | |
2354 | (apply 'vc-do-command "*vc-diff*" 1 "vcdiff" file 'MASTER options)) | |
c6d4f628 | 2355 | ((eq backend 'RCS) |
99e76dda AS |
2356 | (if (not oldvers) (setq oldvers (vc-workfile-version file))) |
2357 | ;; If we know that --brief is not supported, don't try it. | |
eb302e54 AS |
2358 | (setq cmp (and cmp (not (eq vc-rcsdiff-knows-brief 'no)))) |
2359 | (setq options (append (list (and cmp "--brief") "-q" | |
2360 | (concat "-r" oldvers) | |
2361 | (and newvers (concat "-r" newvers))) | |
2362 | (and (not cmp) diff-switches-list))) | |
2363 | (setq status (apply 'vc-do-command "*vc-diff*" 2 | |
2364 | "rcsdiff" file 'WORKFILE options)) | |
2365 | ;; If --brief didn't work, do a double-take and remember it | |
2366 | ;; for the future. | |
2367 | (if (eq status 2) | |
2368 | (prog1 | |
2369 | (apply 'vc-do-command "*vc-diff*" 1 "rcsdiff" file 'WORKFILE | |
2370 | (if cmp (cdr options) options)) | |
2371 | (if cmp (setq vc-rcsdiff-knows-brief 'no))) | |
2372 | ;; If --brief DID work, remember that, too. | |
2373 | (and cmp (not vc-rcsdiff-knows-brief) | |
2374 | (setq vc-rcsdiff-knows-brief 'yes)) | |
2375 | status)) | |
80688f5c | 2376 | ;; CVS is different. |
80688f5c | 2377 | ((eq backend 'CVS) |
eb302e54 | 2378 | (if (string= (vc-workfile-version file) "0") |
80688f5c | 2379 | ;; This file is added but not yet committed; there is no master file. |
80688f5c | 2380 | (if (or oldvers newvers) |
b0c9bc8c AS |
2381 | (error "No revisions of %s exist" file) |
2382 | (if cmp 1 ;; file is added but not committed, | |
2383 | ;; we regard this as "changed". | |
2384 | ;; diff it against /dev/null. | |
2385 | (apply 'vc-do-command | |
2386 | "*vc-diff*" 1 "diff" file 'WORKFILE | |
2387 | (append (if (listp diff-switches) | |
2388 | diff-switches | |
2389 | (list diff-switches)) '("/dev/null"))))) | |
2390 | ;; cmp is not yet implemented -- we always do a full diff. | |
80688f5c | 2391 | (apply 'vc-do-command |
6aa13729 | 2392 | "*vc-diff*" 1 "cvs" file 'WORKFILE "diff" |
80688f5c RS |
2393 | (and oldvers (concat "-r" oldvers)) |
2394 | (and newvers (concat "-r" newvers)) | |
2395 | (if (listp diff-switches) | |
2396 | diff-switches | |
2397 | (list diff-switches))))) | |
2398 | (t | |
2399 | (vc-registration-error file))))) | |
2400 | ||
2401 | (defun vc-backend-merge-news (file) | |
2402 | ;; Merge in any new changes made to FILE. | |
61dee1e7 AS |
2403 | (message "Merging changes into %s..." file) |
2404 | (prog1 | |
2405 | (vc-backend-dispatch | |
2406 | file | |
2407 | (error "vc-backend-merge-news not meaningful for SCCS files") ;SCCS | |
2408 | (error "vc-backend-merge-news not meaningful for RCS files") ;RCS | |
2409 | (save-excursion ; CVS | |
2410 | (vc-file-clear-masterprops file) | |
2411 | (vc-file-setprop file 'vc-workfile-version nil) | |
2412 | (vc-file-setprop file 'vc-locking-user nil) | |
2413 | (vc-do-command nil 0 "cvs" file 'WORKFILE "update") | |
2414 | ;; CVS doesn't return an error code if conflicts are detected. | |
2415 | ;; Since we want to warn the user about it (and possibly start | |
2416 | ;; emerge later), scan the output and see if this occurred. | |
2417 | (set-buffer (get-buffer "*vc*")) | |
2418 | (goto-char (point-min)) | |
2419 | (if (re-search-forward "^cvs update: conflicts found in .*" nil t) | |
2420 | 1 ;; error code for caller | |
2421 | 0 ;; no conflict detected | |
2422 | ))) | |
2423 | (message "Merging changes into %s...done" file))) | |
594722a8 ER |
2424 | |
2425 | (defun vc-check-headers () | |
2426 | "Check if the current file has any headers in it." | |
2427 | (interactive) | |
2428 | (save-excursion | |
2429 | (goto-char (point-min)) | |
2430 | (vc-backend-dispatch buffer-file-name | |
2431 | (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t) ;; SCCS | |
2432 | (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t) ;; RCS | |
80688f5c | 2433 | 'RCS ;; CVS works like RCS in this regard. |
594722a8 ER |
2434 | ) |
2435 | )) | |
2436 | ||
2437 | ;; Back-end-dependent stuff ends here. | |
2438 | ||
2439 | ;; Set up key bindings for use while editing log messages | |
2440 | ||
37667a5c | 2441 | (defun vc-log-mode (&optional file) |
594722a8 ER |
2442 | "Minor mode for driving version-control tools. |
2443 | These bindings are added to the global keymap when you enter this mode: | |
2444 | \\[vc-next-action] perform next logical version-control operation on current file | |
2445 | \\[vc-register] register current file | |
2446 | \\[vc-toggle-read-only] like next-action, but won't register files | |
2447 | \\[vc-insert-headers] insert version-control headers in current file | |
2448 | \\[vc-print-log] display change history of current file | |
2449 | \\[vc-revert-buffer] revert buffer to latest version | |
2450 | \\[vc-cancel-version] undo latest checkin | |
2451 | \\[vc-diff] show diffs between file versions | |
f1818994 | 2452 | \\[vc-version-other-window] visit old version in another window |
594722a8 ER |
2453 | \\[vc-directory] show all files locked by any user in or below . |
2454 | \\[vc-update-change-log] add change log entry from recent checkins | |
2455 | ||
2456 | While you are entering a change log message for a version, the following | |
2457 | additional bindings will be in effect. | |
2458 | ||
2459 | \\[vc-finish-logentry] proceed with check in, ending log message entry | |
2460 | ||
2461 | Whenever you do a checkin, your log comment is added to a ring of | |
2462 | saved comments. These can be recalled as follows: | |
2463 | ||
2464 | \\[vc-next-comment] replace region with next message in comment ring | |
2465 | \\[vc-previous-comment] replace region with previous message in comment ring | |
8c0aaf40 ER |
2466 | \\[vc-comment-search-reverse] search backward for regexp in the comment ring |
2467 | \\[vc-comment-search-forward] search backward for regexp in the comment ring | |
594722a8 ER |
2468 | |
2469 | Entry to the change-log submode calls the value of text-mode-hook, then | |
2470 | the value of vc-log-mode-hook. | |
2471 | ||
2472 | Global user options: | |
2473 | vc-initial-comment If non-nil, require user to enter a change | |
2474 | comment upon first checkin of the file. | |
2475 | ||
2476 | vc-keep-workfiles Non-nil value prevents workfiles from being | |
2477 | deleted when changes are checked in | |
2478 | ||
2479 | vc-suppress-confirm Suppresses some confirmation prompts, | |
2480 | notably for reversions. | |
2481 | ||
7b4f934d | 2482 | vc-header-alist Which keywords to insert when adding headers |
594722a8 | 2483 | with \\[vc-insert-headers]. Defaults to |
80688f5c RS |
2484 | '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under |
2485 | RCS and CVS. | |
594722a8 ER |
2486 | |
2487 | vc-static-header-alist By default, version headers inserted in C files | |
2488 | get stuffed in a static string area so that | |
80688f5c RS |
2489 | ident(RCS/CVS) or what(SCCS) can see them in |
2490 | the compiled object code. You can override | |
2491 | this by setting this variable to nil, or change | |
594722a8 ER |
2492 | the header template by changing it. |
2493 | ||
2494 | vc-command-messages if non-nil, display run messages from the | |
2495 | actual version-control utilities (this is | |
2496 | intended primarily for people hacking vc | |
2497 | itself). | |
2498 | " | |
2499 | (interactive) | |
2500 | (set-syntax-table text-mode-syntax-table) | |
2501 | (use-local-map vc-log-entry-mode) | |
2502 | (setq local-abbrev-table text-mode-abbrev-table) | |
2503 | (setq major-mode 'vc-log-mode) | |
2504 | (setq mode-name "VC-Log") | |
2505 | (make-local-variable 'vc-log-file) | |
37667a5c | 2506 | (setq vc-log-file file) |
594722a8 | 2507 | (make-local-variable 'vc-log-version) |
8c0aaf40 | 2508 | (make-local-variable 'vc-comment-ring-index) |
594722a8 ER |
2509 | (set-buffer-modified-p nil) |
2510 | (setq buffer-file-name nil) | |
2511 | (run-hooks 'text-mode-hook 'vc-log-mode-hook) | |
2512 | ) | |
2513 | ||
2514 | ;; Initialization code, to be done just once at load-time | |
2515 | (if vc-log-entry-mode | |
2516 | nil | |
2517 | (setq vc-log-entry-mode (make-sparse-keymap)) | |
2518 | (define-key vc-log-entry-mode "\M-n" 'vc-next-comment) | |
2519 | (define-key vc-log-entry-mode "\M-p" 'vc-previous-comment) | |
8c0aaf40 | 2520 | (define-key vc-log-entry-mode "\M-r" 'vc-comment-search-reverse) |
594722a8 ER |
2521 | (define-key vc-log-entry-mode "\M-s" 'vc-comment-search-forward) |
2522 | (define-key vc-log-entry-mode "\C-c\C-c" 'vc-finish-logentry) | |
2523 | ) | |
2524 | ||
2525 | ;;; These things should probably be generally available | |
2526 | ||
2f119435 AS |
2527 | (defun vc-file-tree-walk (dirname func &rest args) |
2528 | "Walk recursively through DIRNAME. | |
34291cd2 | 2529 | Invoke FUNC f ARGS on each non-directory file f underneath it." |
2f119435 AS |
2530 | (vc-file-tree-walk-internal (expand-file-name dirname) func args) |
2531 | (message "Traversing directory %s...done" dirname)) | |
02da6253 PE |
2532 | |
2533 | (defun vc-file-tree-walk-internal (file func args) | |
2534 | (if (not (file-directory-p file)) | |
2535 | (apply func file args) | |
993a1a44 | 2536 | (message "Traversing directory %s..." (abbreviate-file-name file)) |
02da6253 PE |
2537 | (let ((dir (file-name-as-directory file))) |
2538 | (mapcar | |
2539 | (function | |
2540 | (lambda (f) (or | |
2541 | (string-equal f ".") | |
2542 | (string-equal f "..") | |
632e9525 | 2543 | (member f vc-directory-exclusion-list) |
02da6253 PE |
2544 | (let ((dirf (concat dir f))) |
2545 | (or | |
2546 | (file-symlink-p dirf) ;; Avoid possible loops | |
2547 | (vc-file-tree-walk-internal dirf func args)))))) | |
2548 | (directory-files dir))))) | |
594722a8 ER |
2549 | |
2550 | (provide 'vc) | |
2551 | ||
2552 | ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE | |
2553 | ;;; | |
2554 | ;;; These may be useful to anyone who has to debug or extend the package. | |
c6d4f628 RS |
2555 | ;;; (Note that this information corresponds to versions 5.x. Some of it |
2556 | ;;; might have been invalidated by the additions to support branching | |
2557 | ;;; and RCS keyword lookup. AS, 1995/03/24) | |
594722a8 ER |
2558 | ;;; |
2559 | ;;; A fundamental problem in VC is that there are time windows between | |
2560 | ;;; vc-next-action's computations of the file's version-control state and | |
2561 | ;;; the actions that change it. This is a window open to lossage in a | |
2562 | ;;; multi-user environment; someone else could nip in and change the state | |
2563 | ;;; of the master during it. | |
2564 | ;;; | |
2565 | ;;; The performance problem is that rlog/prs calls are very expensive; we want | |
2566 | ;;; to avoid them as much as possible. | |
2567 | ;;; | |
2568 | ;;; ANALYSIS: | |
2569 | ;;; | |
2570 | ;;; The performance problem, it turns out, simplifies in practice to the | |
2571 | ;;; problem of making vc-locking-user fast. The two other functions that call | |
2572 | ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one | |
2573 | ;;; makes snapshots, the other deletes the calling user's last change in the | |
2574 | ;;; master. | |
2575 | ;;; | |
2576 | ;;; The race condition implies that we have to either (a) lock the master | |
2577 | ;;; during the entire execution of vc-next-action, or (b) detect and | |
2578 | ;;; recover from errors resulting from dispatch on an out-of-date state. | |
2579 | ;;; | |
a7acbbe4 | 2580 | ;;; Alternative (a) appears to be infeasible. The problem is that we can't |
594722a8 ER |
2581 | ;;; guarantee that the lock will ever be removed. Suppose a user starts a |
2582 | ;;; checkin, the change message buffer pops up, and the user, having wandered | |
2583 | ;;; off to do something else, simply forgets about it? | |
2584 | ;;; | |
2585 | ;;; Alternative (b), on the other hand, works well with a cheap way to speed up | |
2586 | ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/ | |
2587 | ;;; unlocked state and its current owner from its permissions. | |
2588 | ;;; | |
2589 | ;;; This shortcut will fail if someone has manually changed the workfile's | |
2590 | ;;; permissions; also if developers are munging the workfile in several | |
2591 | ;;; directories, with symlinks to a master (in this latter case, the | |
2592 | ;;; permissions shortcut will fail to detect a lock asserted from another | |
2593 | ;;; directory). | |
2594 | ;;; | |
2595 | ;;; Note that these cases correspond exactly to the errors which could happen | |
2596 | ;;; because of a competing checkin/checkout race in between two instances of | |
2597 | ;;; vc-next-action. | |
2598 | ;;; | |
2599 | ;;; For VC's purposes, a workfile/master pair may have the following states: | |
2600 | ;;; | |
2601 | ;;; A. Unregistered. There is a workfile, there is no master. | |
2602 | ;;; | |
2603 | ;;; B. Registered and not locked by anyone. | |
2604 | ;;; | |
2605 | ;;; C. Locked by calling user and unchanged. | |
2606 | ;;; | |
2607 | ;;; D. Locked by the calling user and changed. | |
2608 | ;;; | |
2609 | ;;; E. Locked by someone other than the calling user. | |
2610 | ;;; | |
2611 | ;;; This makes for 25 states and 20 error conditions. Here's the matrix: | |
2612 | ;;; | |
2613 | ;;; VC's idea of state | |
2614 | ;;; | | |
2615 | ;;; V Actual state RCS action SCCS action Effect | |
2616 | ;;; A B C D E | |
2617 | ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin | |
2618 | ;;; B 5 . 6 7 8 co -l get -e checkout | |
2619 | ;;; C 9 10 . 11 12 co -u unget; get revert | |
2620 | ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin | |
b0c9bc8c | 2621 | ;;; E 17 18 19 20 . rcs -u -M -l unget -n ; get -g steal lock |
594722a8 ER |
2622 | ;;; |
2623 | ;;; All commands take the master file name as a last argument (not shown). | |
2624 | ;;; | |
2625 | ;;; In the discussion below, a "self-race" is a pathological situation in | |
2626 | ;;; which VC operations are being attempted simultaneously by two or more | |
2627 | ;;; Emacsen running under the same username. | |
2628 | ;;; | |
2629 | ;;; The vc-next-action code has the following windows: | |
2630 | ;;; | |
2631 | ;;; Window P: | |
2632 | ;;; Between the check for existence of a master file and the call to | |
2633 | ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may | |
2634 | ;;; never close if the initial-comment feature is on. | |
2635 | ;;; | |
2636 | ;;; Window Q: | |
2637 | ;;; Between the call to vc-workfile-unchanged-p in and the immediately | |
2638 | ;;; following revert (apparent state C). | |
2639 | ;;; | |
2640 | ;;; Window R: | |
2641 | ;;; Between the call to vc-workfile-unchanged-p in and the following | |
2642 | ;;; checkin (apparent state D). This window may never close. | |
2643 | ;;; | |
2644 | ;;; Window S: | |
2645 | ;;; Between the unlock and the immediately following checkout during a | |
2646 | ;;; revert operation (apparent state C). Included in window Q. | |
2647 | ;;; | |
2648 | ;;; Window T: | |
2649 | ;;; Between vc-locking-user and the following checkout (apparent state B). | |
2650 | ;;; | |
2651 | ;;; Window U: | |
2652 | ;;; Between vc-locking-user and the following revert (apparent state C). | |
2653 | ;;; Includes windows Q and S. | |
2654 | ;;; | |
2655 | ;;; Window V: | |
2656 | ;;; Between vc-locking-user and the following checkin (apparent state | |
2657 | ;;; D). This window may never be closed if the user fails to complete the | |
2658 | ;;; checkin message. Includes window R. | |
2659 | ;;; | |
2660 | ;;; Window W: | |
2661 | ;;; Between vc-locking-user and the following steal-lock (apparent | |
34291cd2 | 2662 | ;;; state E). This window may never close if the user fails to complete |
594722a8 ER |
2663 | ;;; the steal-lock message. Includes window X. |
2664 | ;;; | |
2665 | ;;; Window X: | |
2666 | ;;; Between the unlock and the immediately following re-lock during a | |
2667 | ;;; steal-lock operation (apparent state E). This window may never cloce | |
2668 | ;;; if the user fails to complete the steal-lock message. | |
2669 | ;;; | |
2670 | ;;; Errors: | |
2671 | ;;; | |
2672 | ;;; Apparent state A --- | |
2673 | ;;; | |
2674 | ;;; 1. File looked unregistered but is actually registered and not locked. | |
2675 | ;;; | |
2676 | ;;; Potential cause: someone else's admin during window P, with | |
2677 | ;;; caller's admin happening before their checkout. | |
2678 | ;;; | |
b0c9bc8c AS |
2679 | ;;; RCS: Prior to version 5.6.4, ci fails with message |
2680 | ;;; "no lock set by <user>". From 5.6.4 onwards, VC uses the new | |
2681 | ;;; ci -i option and the message is "<file>,v: already exists". | |
594722a8 ER |
2682 | ;;; SCCS: admin will fail with error (ad19). |
2683 | ;;; | |
2684 | ;;; We can let these errors be passed up to the user. | |
2685 | ;;; | |
2686 | ;;; 2. File looked unregistered but is actually locked by caller, unchanged. | |
2687 | ;;; | |
2688 | ;;; Potential cause: self-race during window P. | |
2689 | ;;; | |
b0c9bc8c AS |
2690 | ;;; RCS: Prior to version 5.6.4, reverts the file to the last saved |
2691 | ;;; version and unlocks it. From 5.6.4 onwards, VC uses the new | |
2692 | ;;; ci -i option, failing with message "<file>,v: already exists". | |
594722a8 ER |
2693 | ;;; SCCS: will fail with error (ad19). |
2694 | ;;; | |
2695 | ;;; Either of these consequences is acceptable. | |
2696 | ;;; | |
2697 | ;;; 3. File looked unregistered but is actually locked by caller, changed. | |
2698 | ;;; | |
2699 | ;;; Potential cause: self-race during window P. | |
2700 | ;;; | |
b0c9bc8c AS |
2701 | ;;; RCS: Prior to version 5.6.4, VC registers the caller's workfile as |
2702 | ;;; a delta with a null change comment (the -t- switch will be | |
2703 | ;;; ignored). From 5.6.4 onwards, VC uses the new ci -i option, | |
2704 | ;;; failing with message "<file>,v: already exists". | |
594722a8 ER |
2705 | ;;; SCCS: will fail with error (ad19). |
2706 | ;;; | |
2707 | ;;; 4. File looked unregistered but is locked by someone else. | |
2708 | ;;; | |
2709 | ;;; Potential cause: someone else's admin during window P, with | |
2710 | ;;; caller's admin happening *after* their checkout. | |
2711 | ;;; | |
b0c9bc8c AS |
2712 | ;;; RCS: Prior to version 5.6.4, ci fails with a |
2713 | ;;; "no lock set by <user>" message. From 5.6.4 onwards, | |
2714 | ;;; VC uses the new ci -i option, failing with message | |
2715 | ;;; "<file>,v: already exists". | |
594722a8 ER |
2716 | ;;; SCCS: will fail with error (ad19). |
2717 | ;;; | |
2718 | ;;; We can let these errors be passed up to the user. | |
2719 | ;;; | |
2720 | ;;; Apparent state B --- | |
2721 | ;;; | |
2722 | ;;; 5. File looked registered and not locked, but is actually unregistered. | |
2723 | ;;; | |
2724 | ;;; Potential cause: master file got nuked during window P. | |
2725 | ;;; | |
2726 | ;;; RCS: will fail with "RCS/<file>: No such file or directory" | |
2727 | ;;; SCCS: will fail with error ut4. | |
2728 | ;;; | |
2729 | ;;; We can let these errors be passed up to the user. | |
2730 | ;;; | |
2731 | ;;; 6. File looked registered and not locked, but is actually locked by the | |
2732 | ;;; calling user and unchanged. | |
2733 | ;;; | |
2734 | ;;; Potential cause: self-race during window T. | |
2735 | ;;; | |
2736 | ;;; RCS: in the same directory as the previous workfile, co -l will fail | |
2737 | ;;; with "co error: writable foo exists; checkout aborted". In any other | |
2738 | ;;; directory, checkout will succeed. | |
2739 | ;;; SCCS: will fail with ge17. | |
2740 | ;;; | |
2741 | ;;; Either of these consequences is acceptable. | |
2742 | ;;; | |
2743 | ;;; 7. File looked registered and not locked, but is actually locked by the | |
2744 | ;;; calling user and changed. | |
2745 | ;;; | |
2746 | ;;; As case 6. | |
2747 | ;;; | |
2748 | ;;; 8. File looked registered and not locked, but is actually locked by another | |
2749 | ;;; user. | |
2750 | ;;; | |
2751 | ;;; Potential cause: someone else checks it out during window T. | |
2752 | ;;; | |
2753 | ;;; RCS: co error: revision 1.3 already locked by <user> | |
2754 | ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it). | |
2755 | ;;; | |
2756 | ;;; We can let these errors be passed up to the user. | |
2757 | ;;; | |
2758 | ;;; Apparent state C --- | |
2759 | ;;; | |
2760 | ;;; 9. File looks locked by calling user and unchanged, but is unregistered. | |
2761 | ;;; | |
2762 | ;;; As case 5. | |
2763 | ;;; | |
2764 | ;;; 10. File looks locked by calling user and unchanged, but is actually not | |
2765 | ;;; locked. | |
2766 | ;;; | |
2767 | ;;; Potential cause: a self-race in window U, or by the revert's | |
2768 | ;;; landing during window X of some other user's steal-lock or window S | |
2769 | ;;; of another user's revert. | |
2770 | ;;; | |
2771 | ;;; RCS: succeeds, refreshing the file from the identical version in | |
2772 | ;;; the master. | |
2773 | ;;; SCCS: fails with error ut4 (p file nonexistent). | |
2774 | ;;; | |
2775 | ;;; Either of these consequences is acceptable. | |
2776 | ;;; | |
2777 | ;;; 11. File is locked by calling user. It looks unchanged, but is actually | |
2778 | ;;; changed. | |
2779 | ;;; | |
2780 | ;;; Potential cause: the file would have to be touched by a self-race | |
2781 | ;;; during window Q. | |
2782 | ;;; | |
2783 | ;;; The revert will succeed, removing whatever changes came with | |
2784 | ;;; the touch. It is theoretically possible that work could be lost. | |
2785 | ;;; | |
2786 | ;;; 12. File looks like it's locked by the calling user and unchanged, but | |
2787 | ;;; it's actually locked by someone else. | |
2788 | ;;; | |
2789 | ;;; Potential cause: a steal-lock in window V. | |
2790 | ;;; | |
2791 | ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u | |
2792 | ;;; SCCS: fails with error un2 | |
2793 | ;;; | |
2794 | ;;; We can pass these errors up to the user. | |
2795 | ;;; | |
2796 | ;;; Apparent state D --- | |
2797 | ;;; | |
2798 | ;;; 13. File looks like it's locked by the calling user and changed, but it's | |
2799 | ;;; actually unregistered. | |
2800 | ;;; | |
2801 | ;;; Potential cause: master file got nuked during window P. | |
2802 | ;;; | |
b0c9bc8c AS |
2803 | ;;; RCS: Prior to version 5.6.4, checks in the user's version as an |
2804 | ;;; initial delta. From 5.6.4 onwards, VC uses the new ci -j | |
2805 | ;;; option, failing with message "no such file or directory". | |
594722a8 ER |
2806 | ;;; SCCS: will fail with error ut4. |
2807 | ;;; | |
b0c9bc8c AS |
2808 | ;;; This case is kind of nasty. Under RCS prior to version 5.6.4, |
2809 | ;;; VC may fail to detect the loss of previous version information. | |
594722a8 ER |
2810 | ;;; |
2811 | ;;; 14. File looks like it's locked by the calling user and changed, but it's | |
2812 | ;;; actually unlocked. | |
2813 | ;;; | |
2814 | ;;; Potential cause: self-race in window V, or the checkin happening | |
2815 | ;;; during the window X of someone else's steal-lock or window S of | |
2816 | ;;; someone else's revert. | |
2817 | ;;; | |
2818 | ;;; RCS: ci will fail with "no lock set by <user>". | |
2819 | ;;; SCCS: delta will fail with error ut4. | |
2820 | ;;; | |
2821 | ;;; 15. File looks like it's locked by the calling user and changed, but it's | |
2822 | ;;; actually locked by the calling user and unchanged. | |
2823 | ;;; | |
2824 | ;;; Potential cause: another self-race --- a whole checkin/checkout | |
2825 | ;;; sequence by the calling user would have to land in window R. | |
2826 | ;;; | |
2827 | ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual. | |
2828 | ;;; RCS: reverts to the file state as of the second user's checkin, leaving | |
2829 | ;;; the file unlocked. | |
2830 | ;;; | |
2831 | ;;; It is theoretically possible that work could be lost under RCS. | |
2832 | ;;; | |
2833 | ;;; 16. File looks like it's locked by the calling user and changed, but it's | |
2834 | ;;; actually locked by a different user. | |
2835 | ;;; | |
2836 | ;;; RCS: ci error: no lock set by <user> | |
2837 | ;;; SCCS: unget will fail with error un2 | |
2838 | ;;; | |
2839 | ;;; We can pass these errors up to the user. | |
2840 | ;;; | |
2841 | ;;; Apparent state E --- | |
2842 | ;;; | |
2843 | ;;; 17. File looks like it's locked by some other user, but it's actually | |
2844 | ;;; unregistered. | |
2845 | ;;; | |
2846 | ;;; As case 13. | |
2847 | ;;; | |
2848 | ;;; 18. File looks like it's locked by some other user, but it's actually | |
2849 | ;;; unlocked. | |
2850 | ;;; | |
2851 | ;;; Potential cause: someone released a lock during window W. | |
2852 | ;;; | |
2853 | ;;; RCS: The calling user will get the lock on the file. | |
2854 | ;;; SCCS: unget -n will fail with cm4. | |
2855 | ;;; | |
2856 | ;;; Either of these consequences will be OK. | |
2857 | ;;; | |
2858 | ;;; 19. File looks like it's locked by some other user, but it's actually | |
2859 | ;;; locked by the calling user and unchanged. | |
2860 | ;;; | |
2861 | ;;; Potential cause: the other user relinquishing a lock followed by | |
2862 | ;;; a self-race, both in window W. | |
2863 | ;;; | |
2864 | ;;; Under both RCS and SCCS, both unlock and lock will succeed, making | |
2865 | ;;; the sequence a no-op. | |
2866 | ;;; | |
2867 | ;;; 20. File looks like it's locked by some other user, but it's actually | |
2868 | ;;; locked by the calling user and changed. | |
2869 | ;;; | |
2870 | ;;; As case 19. | |
2871 | ;;; | |
2872 | ;;; PROBLEM CASES: | |
2873 | ;;; | |
2874 | ;;; In order of decreasing severity: | |
2875 | ;;; | |
b0c9bc8c | 2876 | ;;; Cases 11 and 15 are the only ones that potentially lose work. |
594722a8 ER |
2877 | ;;; They would require a self-race for this to happen. |
2878 | ;;; | |
2879 | ;;; Case 13 in RCS loses information about previous deltas, retaining | |
2880 | ;;; only the information in the current workfile. This can only happen | |
2881 | ;;; if the master file gets nuked in window P. | |
2882 | ;;; | |
2883 | ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with | |
2884 | ;;; no change comment in the master. This would require a self-race in | |
2885 | ;;; window P or R respectively. | |
2886 | ;;; | |
2887 | ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes. | |
2888 | ;;; | |
2889 | ;;; Unfortunately, it appears to me that no recovery is possible in these | |
2890 | ;;; cases. They don't yield error messages, so there's no way to tell that | |
2891 | ;;; a race condition has occurred. | |
2892 | ;;; | |
2893 | ;;; All other cases don't change either the workfile or the master, and | |
2894 | ;;; trigger command errors which the user will see. | |
2895 | ;;; | |
2896 | ;;; Thus, there is no explicit recovery code. | |
2897 | ||
2898 | ;;; vc.el ends here |