Commit | Line | Data |
---|---|---|
594722a8 ER |
1 | ;;; vc.el --- drive a version-control system from within Emacs |
2 | ||
69268c78 | 3 | ;; Copyright (C) 1992, 1993 Free Software Foundation, Inc. |
594722a8 ER |
4 | |
5 | ;; Author: Eric S. Raymond <esr@snark.thyrsus.com> | |
e1f297e6 | 6 | ;; Version: 5.4 |
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 | |
21 | ;; along with GNU Emacs; see the file COPYING. If not, write to | |
22 | ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
23 | ||
24 | ;;; Commentary: | |
25 | ||
1a2f456b ER |
26 | ;; This mode is fully documented in the Emacs user's manual. |
27 | ;; | |
594722a8 ER |
28 | ;; This was designed and implemented by Eric Raymond <esr@snark.thyrsus.com>. |
29 | ;; Paul Eggert <eggert@twinsun.com>, Sebastian Kremer <sk@thp.uni-koeln.de>, | |
30 | ;; and Richard Stallman contributed valuable criticism, support, and testing. | |
31 | ;; | |
32 | ;; Supported version-control systems presently include SCCS and RCS; | |
33 | ;; your RCS version should be 5.6.2 or later for proper operation of | |
34 | ;; the lock-breaking code. | |
35 | ;; | |
36 | ;; The RCS code assumes strict locking. You can support the RCS -x option | |
37 | ;; by adding pairs to the vc-master-templates list. | |
38 | ;; | |
39 | ;; Proper function of the SCCS diff commands requires the shellscript vcdiff | |
40 | ;; to be installed somewhere on Emacs's path for executables. | |
41 | ;; | |
1a2f456b | 42 | ;; If your site uses the ChangeLog convention supported by Emacs, the |
594be62e | 43 | ;; function vc-comment-to-change-log should prove a useful checkin hook. |
1a2f456b | 44 | ;; |
594722a8 | 45 | ;; This code depends on call-process passing back the subprocess exit |
e1f297e6 | 46 | ;; status. Thus, you need Emacs 18.58 or later to run it. For the |
6ed5075c | 47 | ;; vc-directory command to work properly as documented, you need 19. |
7ef84cf9 | 48 | ;; You also need Emacs 19's ring.el. |
594722a8 ER |
49 | ;; |
50 | ;; The vc code maintains some internal state in order to reduce expensive | |
51 | ;; version-control operations to a minimum. Some names are only computed | |
34291cd2 | 52 | ;; once. If you perform version control operations with RCS/SCCS/CVS while |
594722a8 ER |
53 | ;; vc's back is turned, or move/rename master files while vc is running, |
54 | ;; vc may get seriously confused. Don't do these things! | |
55 | ;; | |
56 | ;; Developer's notes on some concurrency issues are included at the end of | |
57 | ;; the file. | |
58 | ||
59 | ;;; Code: | |
60 | ||
61 | (require 'vc-hooks) | |
8c0aaf40 | 62 | (require 'ring) |
8c0aaf40 ER |
63 | |
64 | (if (not (assoc 'vc-parent-buffer minor-mode-alist)) | |
65 | (setq minor-mode-alist | |
66 | (cons '(vc-parent-buffer vc-parent-buffer-name) | |
67 | minor-mode-alist))) | |
594722a8 ER |
68 | |
69 | ;; General customization | |
70 | ||
71 | (defvar vc-default-back-end nil | |
72 | "*Back-end actually used by this interface; may be SCCS or RCS. | |
73 | The value is only computed when needed to avoid an expensive search.") | |
594722a8 | 74 | (defvar vc-suppress-confirm nil |
34291cd2 | 75 | "*If non-nil, treat user as expert; suppress yes-no prompts on some things.") |
594722a8 ER |
76 | (defvar vc-keep-workfiles t |
77 | "*If non-nil, don't delete working files after registering changes.") | |
78 | (defvar vc-initial-comment nil | |
79 | "*Prompt for initial comment when a file is registered.") | |
80 | (defvar vc-command-messages nil | |
81 | "*Display run messages from back-end commands.") | |
82 | (defvar vc-mistrust-permissions 'file-symlink-p | |
83 | "*Don't assume that permissions and ownership track version-control status.") | |
666a0ebb RM |
84 | (defvar vc-checkin-switches nil |
85 | "*Extra switches passed to the checkin program by \\[vc-checkin].") | |
282aa6a2 RS |
86 | (defvar vc-path |
87 | (if (file-exists-p "/usr/sccs") | |
88 | '("/usr/sccs") nil) | |
89 | "*List of extra directories to search for version control commands.") | |
666a0ebb | 90 | |
8c0aaf40 ER |
91 | (defconst vc-maximum-comment-ring-size 32 |
92 | "Maximum number of saved comments in the comment ring.") | |
93 | ||
2e810285 RS |
94 | ;;; This is duplicated in diff.el. |
95 | (defvar diff-switches "-c" | |
96 | "*A string or list of strings specifying switches to be be passed to diff.") | |
97 | ||
67242a23 RM |
98 | ;;;###autoload |
99 | (defvar vc-checkin-hook nil | |
34291cd2 | 100 | "*List of functions called after a checkin is done. See `run-hooks'.") |
67242a23 | 101 | |
594722a8 ER |
102 | ;; Header-insertion hair |
103 | ||
104 | (defvar vc-header-alist | |
105 | '((SCCS "\%W\%") (RCS "\$Id\$")) | |
820bde8d | 106 | "*Header keywords to be inserted when `vc-insert-headers' is executed.") |
ba5c3004 | 107 | (defvar vc-static-header-alist |
594722a8 ER |
108 | '(("\\.c$" . |
109 | "\n#ifndef lint\nstatic char vcid[] = \"\%s\";\n#endif /* lint */\n")) | |
110 | "*Associate static header string templates with file types. A \%s in the | |
111 | template is replaced with the first string associated with the file's | |
34291cd2 | 112 | version-control type in `vc-header-alist'.") |
7b4f934d | 113 | |
594722a8 ER |
114 | (defvar vc-comment-alist |
115 | '((nroff-mode ".\\\"" "")) | |
116 | "*Special comment delimiters to be used in generating vc headers only. | |
117 | Add an entry in this list if you need to override the normal comment-start | |
118 | and comment-end variables. This will only be necessary if the mode language | |
119 | is sensitive to blank lines.") | |
120 | ||
121 | ;; Variables the user doesn't need to know about. | |
122 | (defvar vc-log-entry-mode nil) | |
123 | (defvar vc-log-operation nil) | |
67242a23 | 124 | (defvar vc-log-after-operation-hook nil) |
34291cd2 | 125 | (defvar vc-checkout-writable-buffer-hook 'vc-checkout-writable-buffer) |
1a2f456b | 126 | (defvar vc-parent-buffer nil) |
8c0aaf40 | 127 | (defvar vc-parent-buffer-name nil) |
594722a8 | 128 | |
db59472c RS |
129 | (defvar vc-log-file) |
130 | (defvar vc-log-version) | |
131 | ||
594722a8 ER |
132 | (defconst vc-name-assoc-file "VC-names") |
133 | ||
8c0aaf40 | 134 | (defvar vc-dired-mode nil) |
e1f297e6 ER |
135 | (make-variable-buffer-local 'vc-dired-mode) |
136 | ||
8c0aaf40 ER |
137 | (defvar vc-comment-ring nil) |
138 | (defvar vc-comment-ring-index nil) | |
139 | (defvar vc-last-comment-match nil) | |
140 | ||
594722a8 ER |
141 | ;; File property caching |
142 | ||
143 | (defun vc-file-clearprops (file) | |
144 | ;; clear all properties of a given file | |
145 | (setplist (intern file vc-file-prop-obarray) nil)) | |
146 | ||
8c0aaf40 ER |
147 | (defun vc-clear-context () |
148 | "Clear all cached file properties and the comment ring." | |
149 | (interactive) | |
150 | (fillarray vc-file-prop-obarray nil) | |
151 | ;; Note: there is potential for minor lossage here if there is an open | |
152 | ;; log buffer with a nonzero local value of vc-comment-ring-index. | |
153 | (setq vc-comment-ring nil)) | |
154 | ||
594722a8 ER |
155 | ;; Random helper functions |
156 | ||
7ef84cf9 RS |
157 | (defun vc-registration-error (file) |
158 | (if file | |
590cc449 RS |
159 | (error "File %s is not under version control" file) |
160 | (error "Buffer %s is not associated with a file" (buffer-name)))) | |
7ef84cf9 | 161 | |
594722a8 ER |
162 | (defvar vc-binary-assoc nil) |
163 | ||
164 | (defun vc-find-binary (name) | |
165 | "Look for a command anywhere on the subprocess-command search path." | |
166 | (or (cdr (assoc name vc-binary-assoc)) | |
deb9ebc6 PE |
167 | (catch 'found |
168 | (mapcar | |
169 | (function | |
170 | (lambda (s) | |
171 | (if s | |
172 | (let ((full (concat s "/" name))) | |
173 | (if (file-executable-p full) | |
174 | (progn | |
175 | (setq vc-binary-assoc | |
176 | (cons (cons name full) vc-binary-assoc)) | |
177 | (throw 'found full))))))) | |
178 | exec-path) | |
179 | nil))) | |
594722a8 ER |
180 | |
181 | (defun vc-do-command (okstatus command file &rest flags) | |
182 | "Execute a version-control command, notifying user and checking for errors. | |
183 | The command is successful if its exit status does not exceed OKSTATUS. | |
184 | Output from COMMAND goes to buffer *vc*. The last argument of the command is | |
185 | the master name of FILE; this is appended to an optional list of FLAGS." | |
186 | (setq file (expand-file-name file)) | |
187 | (if vc-command-messages | |
02da6253 | 188 | (message "Running %s on %s..." command file)) |
1a2f456b | 189 | (let ((obuf (current-buffer)) (camefrom (current-buffer)) |
594722a8 ER |
190 | (squeezed nil) |
191 | (vc-file (and file (vc-name file))) | |
192 | status) | |
193 | (set-buffer (get-buffer-create "*vc*")) | |
8c0aaf40 ER |
194 | (set (make-local-variable 'vc-parent-buffer) camefrom) |
195 | (set (make-local-variable 'vc-parent-buffer-name) | |
196 | (concat " from " (buffer-name camefrom))) | |
197 | ||
594722a8 | 198 | (erase-buffer) |
315e49ed JB |
199 | |
200 | ;; This is so that command arguments typed in the *vc* buffer will | |
201 | ;; have reasonable defaults. | |
202 | (setq default-directory (file-name-directory file)) | |
203 | ||
594722a8 ER |
204 | (mapcar |
205 | (function (lambda (s) (and s (setq squeezed (append squeezed (list s)))))) | |
206 | flags) | |
207 | (if vc-file | |
208 | (setq squeezed (append squeezed (list vc-file)))) | |
282aa6a2 RS |
209 | (let ((default-directory (file-name-directory (or file "./"))) |
210 | (exec-path (if vc-path (append exec-path vc-path) exec-path))) | |
1a2f456b | 211 | (setq status (apply 'call-process command nil t nil squeezed))) |
594722a8 | 212 | (goto-char (point-max)) |
4805f679 | 213 | (forward-line -1) |
594722a8 ER |
214 | (if (or (not (integerp status)) (< okstatus status)) |
215 | (progn | |
594722a8 | 216 | (pop-to-buffer "*vc*") |
594722a8 | 217 | (goto-char (point-min)) |
4c2d8cf9 | 218 | (shrink-window-if-larger-than-buffer) |
02da6253 PE |
219 | (error "Running %s...FAILED (%s)" command |
220 | (if (integerp status) | |
221 | (format "status %d" status) | |
222 | status)) | |
594722a8 ER |
223 | ) |
224 | (if vc-command-messages | |
02da6253 | 225 | (message "Running %s...OK" command)) |
594722a8 ER |
226 | ) |
227 | (set-buffer obuf) | |
228 | status) | |
229 | ) | |
230 | ||
c4ae7096 JB |
231 | ;;; Save a bit of the text around POSN in the current buffer, to help |
232 | ;;; us find the corresponding position again later. This works even | |
233 | ;;; if all markers are destroyed or corrupted. | |
234 | (defun vc-position-context (posn) | |
235 | (list posn | |
236 | (buffer-size) | |
237 | (buffer-substring posn | |
238 | (min (point-max) (+ posn 100))))) | |
239 | ||
240 | ;;; Return the position of CONTEXT in the current buffer, or nil if we | |
241 | ;;; couldn't find it. | |
242 | (defun vc-find-position-by-context (context) | |
243 | (let ((context-string (nth 2 context))) | |
244 | (if (equal "" context-string) | |
245 | (point-max) | |
246 | (save-excursion | |
247 | (let ((diff (- (nth 1 context) (buffer-size)))) | |
248 | (if (< diff 0) (setq diff (- diff))) | |
249 | (goto-char (nth 0 context)) | |
250 | (if (or (search-forward context-string nil t) | |
251 | ;; Can't use search-backward since the match may continue | |
252 | ;; after point. | |
253 | (progn (goto-char (- (point) diff (length context-string))) | |
254 | ;; goto-char doesn't signal an error at | |
255 | ;; beginning of buffer like backward-char would | |
256 | (search-forward context-string nil t))) | |
257 | ;; to beginning of OSTRING | |
258 | (- (point) (length context-string)))))))) | |
259 | ||
594722a8 | 260 | (defun vc-revert-buffer1 (&optional arg no-confirm) |
7b4f934d | 261 | ;; Most of this was shamelessly lifted from Sebastian Kremer's rcs.el mode. |
c4ae7096 | 262 | ;; Revert buffer, try to keep point and mark where user expects them in spite |
594722a8 ER |
263 | ;; of changes because of expanded version-control key words. |
264 | ;; This is quite important since otherwise typeahead won't work as expected. | |
265 | (interactive "P") | |
266 | (widen) | |
c4ae7096 | 267 | (let ((point-context (vc-position-context (point))) |
cfadef63 RS |
268 | ;; Use mark-marker to avoid confusion in transient-mark-mode. |
269 | (mark-context (if (eq (marker-buffer (mark-marker)) (current-buffer)) | |
270 | (vc-position-context (mark-marker)))) | |
271 | ;; Make the right thing happen in transient-mark-mode. | |
ab877583 RM |
272 | (mark-active nil) |
273 | ;; We may want to reparse the compilation buffer after revert | |
274 | (reparse (and (boundp 'compilation-error-list) ;compile loaded | |
275 | (let ((curbuf (current-buffer))) | |
276 | ;; Construct a list; each elt is nil or a buffer | |
277 | ;; iff that buffer is a compilation output buffer | |
278 | ;; that contains markers into the current buffer. | |
279 | (save-excursion | |
7ef84cf9 RS |
280 | (mapcar (function |
281 | (lambda (buffer) | |
ab877583 RM |
282 | (set-buffer buffer) |
283 | (let ((errors (or | |
284 | compilation-old-error-list | |
285 | compilation-error-list)) | |
286 | (buffer-error-marked-p nil)) | |
6fb6ab11 | 287 | (while (and (consp errors) |
ab877583 | 288 | (not buffer-error-marked-p)) |
a1bda481 | 289 | (and (markerp (cdr (car errors))) |
e9c8e248 RM |
290 | (eq buffer |
291 | (marker-buffer | |
a1bda481 | 292 | (cdr (car errors)))) |
e9c8e248 | 293 | (setq buffer-error-marked-p t)) |
ab877583 | 294 | (setq errors (cdr errors))) |
7ef84cf9 | 295 | (if buffer-error-marked-p buffer)))) |
ab877583 | 296 | (buffer-list))))))) |
7b4f934d ER |
297 | |
298 | ;; the actual revisit | |
594722a8 | 299 | (revert-buffer arg no-confirm) |
7b4f934d | 300 | |
ab877583 RM |
301 | ;; Reparse affected compilation buffers. |
302 | (while reparse | |
303 | (if (car reparse) | |
304 | (save-excursion | |
305 | (set-buffer (car reparse)) | |
306 | (let ((compilation-last-buffer (current-buffer)) ;select buffer | |
307 | ;; Record the position in the compilation buffer of | |
308 | ;; the last error next-error went to. | |
309 | (error-pos (marker-position | |
310 | (car (car-safe compilation-error-list))))) | |
311 | ;; Reparse the error messages as far as they were parsed before. | |
312 | (compile-reinitialize-errors '(4) compilation-parsing-end) | |
313 | ;; Move the pointer up to find the error we were at before | |
314 | ;; reparsing. Now next-error should properly go to the next one. | |
315 | (while (and compilation-error-list | |
27f2f10b | 316 | (/= error-pos (car (car compilation-error-list)))) |
ab877583 RM |
317 | (setq compilation-error-list (cdr compilation-error-list)))))) |
318 | (setq reparse (cdr reparse))) | |
e1f297e6 | 319 | |
7b4f934d | 320 | ;; Restore point and mark |
c4ae7096 JB |
321 | (let ((new-point (vc-find-position-by-context point-context))) |
322 | (if new-point (goto-char new-point))) | |
323 | (if mark-context | |
324 | (let ((new-mark (vc-find-position-by-context mark-context))) | |
325 | (if new-mark (set-mark new-mark)))))) | |
326 | ||
594722a8 ER |
327 | |
328 | (defun vc-buffer-sync () | |
329 | ;; Make sure the current buffer and its working file are in sync | |
330 | (if (and (buffer-modified-p) | |
331 | (or | |
332 | vc-suppress-confirm | |
333 | (y-or-n-p (format "%s has been modified. Write it out? " | |
334 | (buffer-name))))) | |
335 | (save-buffer))) | |
336 | ||
337 | (defun vc-workfile-unchanged-p (file) | |
338 | ;; Has the given workfile changed since last checkout? | |
339 | (let ((checkout-time (vc-file-getprop file 'vc-checkout-time)) | |
340 | (lastmod (nth 5 (file-attributes file)))) | |
341 | (if checkout-time | |
342 | (equal lastmod checkout-time) | |
343 | (if (zerop (vc-backend-diff file nil)) | |
344 | (progn | |
345 | (vc-file-setprop file 'vc-checkout-time lastmod) | |
346 | t) | |
347 | (progn | |
348 | (vc-file-setprop file 'vc-checkout-time '(0 . 0)) | |
349 | nil | |
350 | )) | |
351 | ))) | |
352 | ||
e1f297e6 ER |
353 | (defun vc-next-action-on-file (file verbose &optional comment) |
354 | ;;; If comment is specified, it will be used as an admin or checkin comment. | |
355 | (let (owner version (vc-file (vc-name file))) | |
356 | (cond | |
357 | ||
358 | ;; if there is no master file corresponding, create one | |
359 | ((not vc-file) | |
360 | (vc-register verbose comment) | |
361 | (if vc-initial-comment | |
362 | (setq vc-log-after-operation-hook | |
34291cd2 RS |
363 | 'vc-checkout-writable-buffer-hook) |
364 | (vc-checkout-writable-buffer file))) | |
e1f297e6 ER |
365 | |
366 | ;; if there is no lock on the file, assert one and get it | |
367 | ((not (setq owner (vc-locking-user file))) | |
34291cd2 | 368 | (vc-checkout-writable-buffer file)) |
e1f297e6 ER |
369 | |
370 | ;; a checked-out version exists, but the user may not own the lock | |
371 | ((not (string-equal owner (user-login-name))) | |
372 | (if comment | |
590cc449 | 373 | (error "Sorry, you can't steal the lock on %s this way" file)) |
e1f297e6 ER |
374 | (vc-steal-lock |
375 | file | |
376 | (and verbose (read-string "Version to steal: ")) | |
377 | owner)) | |
378 | ||
379 | ;; OK, user owns the lock on the file | |
8c0aaf40 | 380 | (t |
e1f297e6 ER |
381 | (find-file file) |
382 | ||
383 | ;; give luser a chance to save before checking in. | |
384 | (vc-buffer-sync) | |
385 | ||
386 | ;; Revert if file is unchanged and buffer is too. | |
387 | ;; If buffer is modified, that means the user just said no | |
388 | ;; to saving it; in that case, don't revert, | |
389 | ;; because the user might intend to save | |
390 | ;; after finishing the log entry. | |
391 | (if (and (vc-workfile-unchanged-p file) | |
392 | (not (buffer-modified-p))) | |
393 | (progn | |
394 | (vc-backend-revert file) | |
395 | ;; DO NOT revert the file without asking the user! | |
396 | (vc-resynch-window file t nil)) | |
397 | ||
398 | ;; user may want to set nonstandard parameters | |
399 | (if verbose | |
400 | (setq version (read-string "New version level: "))) | |
401 | ||
402 | ;; OK, let's do the checkin | |
403 | (vc-checkin file version comment) | |
8c0aaf40 | 404 | ))))) |
e1f297e6 ER |
405 | |
406 | (defun vc-next-action-dired (file rev comment) | |
407 | ;; We've accepted a log comment, now do a vc-next-action using it on all | |
408 | ;; marked files. | |
409 | (set-buffer vc-parent-buffer) | |
410 | (dired-map-over-marks | |
411 | (save-window-excursion | |
8c0aaf40 ER |
412 | (let ((file (dired-get-filename))) |
413 | (message "Processing %s..." file) | |
414 | (vc-next-action-on-file file nil comment) | |
415 | (message "Processing %s...done" file))) | |
416 | nil t) | |
e1f297e6 ER |
417 | ) |
418 | ||
637a8ae9 | 419 | ;; Here's the major entry point. |
594722a8 | 420 | |
637a8ae9 | 421 | ;;;###autoload |
594722a8 ER |
422 | (defun vc-next-action (verbose) |
423 | "Do the next logical checkin or checkout operation on the current file. | |
424 | If the file is not already registered, this registers it for version | |
34291cd2 | 425 | control and then retrieves a writable, locked copy for editing. |
594722a8 | 426 | If the file is registered and not locked by anyone, this checks out |
34291cd2 | 427 | a writable and locked file ready for editing. |
594722a8 ER |
428 | If the file is checked out and locked by the calling user, this |
429 | first checks to see if the file has changed since checkout. If not, | |
430 | it performs a revert. | |
e1f297e6 ER |
431 | If the file has been changed, this pops up a buffer for entry |
432 | of a log message; when the message has been entered, it checks in the | |
594722a8 | 433 | resulting changes along with the log message as change commentary. If |
34291cd2 | 434 | the variable `vc-keep-workfiles' is non-nil (which is its default), a |
594722a8 ER |
435 | read-only copy of the changed file is left in place afterwards. |
436 | If the file is registered and locked by someone else, you are given | |
e1f297e6 ER |
437 | the option to steal the lock. |
438 | If you call this from within a VC dired buffer with no files marked, | |
439 | it will operate on the file in the current line. | |
440 | If you call this from within a VC dired buffer, and one or more | |
441 | files are marked, it will accept a log message and then operate on | |
442 | each one. The log message will be used as a comment for any register | |
443 | or checkin operations, but ignored when doing checkouts. Attempted | |
444 | lock steals will raise an error." | |
594722a8 | 445 | (interactive "P") |
8c0aaf40 ER |
446 | (catch 'nogo |
447 | (if vc-dired-mode | |
448 | (let ((files (dired-get-marked-files))) | |
449 | (if (= (length files) 1) | |
450 | (find-file-other-window (dired-get-filename)) | |
451 | (vc-start-entry nil nil nil | |
452 | "Enter a change comment for the marked files." | |
453 | 'vc-next-action-dired) | |
9a47d40b | 454 | (throw 'nogo nil)))) |
e1f297e6 | 455 | (while vc-parent-buffer |
1a2f456b | 456 | (pop-to-buffer vc-parent-buffer)) |
e1f297e6 ER |
457 | (if buffer-file-name |
458 | (vc-next-action-on-file buffer-file-name verbose) | |
7ef84cf9 | 459 | (vc-registration-error nil)))) |
594722a8 ER |
460 | |
461 | ;;; These functions help the vc-next-action entry point | |
462 | ||
34291cd2 RS |
463 | (defun vc-checkout-writable-buffer (&optional file) |
464 | "Retrieve a writable copy of the latest version of the current buffer's file." | |
8c0aaf40 | 465 | (vc-checkout (or file (buffer-file-name)) t) |
02da6253 PE |
466 | ) |
467 | ||
637a8ae9 | 468 | ;;;###autoload |
e1f297e6 | 469 | (defun vc-register (&optional override comment) |
594722a8 ER |
470 | "Register the current file into your version-control system." |
471 | (interactive "P") | |
472 | (if (vc-name buffer-file-name) | |
590cc449 | 473 | (error "This file is already registered")) |
02da6253 PE |
474 | ;; Watch out for new buffers of size 0: the corresponding file |
475 | ;; does not exist yet, even though buffer-modified-p is nil. | |
476 | (if (and (not (buffer-modified-p)) | |
477 | (zerop (buffer-size)) | |
478 | (not (file-exists-p buffer-file-name))) | |
479 | (set-buffer-modified-p t)) | |
594722a8 ER |
480 | (vc-buffer-sync) |
481 | (vc-admin | |
482 | buffer-file-name | |
e1f297e6 ER |
483 | (and override |
484 | (read-string | |
485 | (format "Initial version level for %s: " buffer-file-name)))) | |
594722a8 ER |
486 | ) |
487 | ||
624b4662 | 488 | (defun vc-resynch-window (file &optional keep noquery) |
594722a8 ER |
489 | ;; If the given file is in the current buffer, |
490 | ;; either revert on it so we see expanded keyworks, | |
491 | ;; or unvisit it (depending on vc-keep-workfiles) | |
624b4662 RS |
492 | ;; NOQUERY if non-nil inhibits confirmation for reverting. |
493 | ;; NOQUERY should be t *only* if it is known the only difference | |
494 | ;; between the buffer and the file is due to RCS rather than user editing! | |
594722a8 ER |
495 | (and (string= buffer-file-name file) |
496 | (if keep | |
497 | (progn | |
1ab31687 | 498 | (vc-revert-buffer1 t noquery) |
594722a8 ER |
499 | (vc-mode-line buffer-file-name)) |
500 | (progn | |
501 | (delete-window) | |
502 | (kill-buffer (current-buffer)))))) | |
503 | ||
e1f297e6 ER |
504 | (defun vc-start-entry (file rev comment msg action) |
505 | ;; Accept a comment for an operation on FILE revision REV. If COMMENT | |
506 | ;; is nil, pop up a VC-log buffer, emit MSG, and set the | |
507 | ;; action on close to ACTION; otherwise, do action immediately. | |
508 | ;; Remember the file's buffer in parent-buffer (current one if no file). | |
509 | (let ((parent (if file (find-file-noselect file) (current-buffer)))) | |
510 | (if comment | |
511 | (set-buffer (get-buffer-create "*VC-log*")) | |
512 | (pop-to-buffer (get-buffer-create "*VC-log*"))) | |
8c0aaf40 ER |
513 | (set (make-local-variable 'vc-parent-buffer) parent) |
514 | (set (make-local-variable 'vc-parent-buffer-name) | |
515 | (concat " from " (buffer-name vc-parent-buffer))) | |
cf50f717 | 516 | (vc-mode-line (or file " (no file)")) |
e1f297e6 ER |
517 | (vc-log-mode) |
518 | (setq vc-log-operation action) | |
519 | (setq vc-log-file file) | |
520 | (setq vc-log-version rev) | |
521 | (if comment | |
522 | (progn | |
523 | (erase-buffer) | |
8c0aaf40 ER |
524 | (if (eq comment t) |
525 | (vc-finish-logentry t) | |
526 | (insert comment) | |
527 | (vc-finish-logentry nil))) | |
e1f297e6 | 528 | (message "%s Type C-c C-c when done." msg)))) |
594722a8 | 529 | |
e1f297e6 | 530 | (defun vc-admin (file rev &optional comment) |
624b4662 | 531 | "Check a file into your version-control system. |
594722a8 | 532 | FILE is the unmodified name of the file. REV should be the base version |
e1f297e6 ER |
533 | level to check it in under. COMMENT, if specified, is the checkin comment." |
534 | (vc-start-entry file rev | |
535 | (or comment (not vc-initial-comment)) | |
536 | "Enter initial comment." 'vc-backend-admin)) | |
537 | ||
34291cd2 | 538 | (defun vc-checkout (file &optional writable) |
e1f297e6 ER |
539 | "Retrieve a copy of the latest version of the given file." |
540 | ;; If ftp is on this system and the name matches the ange-ftp format | |
541 | ;; for a remote file, the user is trying something that won't work. | |
542 | (if (and (string-match "^/[^/:]+:" file) (vc-find-binary "ftp")) | |
543 | (error "Sorry, you can't check out files over FTP")) | |
34291cd2 | 544 | (vc-backend-checkout file writable) |
e1f297e6 ER |
545 | (if (string-equal file buffer-file-name) |
546 | (vc-resynch-window file t t)) | |
547 | ) | |
594722a8 ER |
548 | |
549 | (defun vc-steal-lock (file rev &optional owner) | |
550 | "Steal the lock on the current workfile." | |
551 | (interactive) | |
552 | (if (not owner) | |
553 | (setq owner (vc-locking-user file))) | |
820bde8d | 554 | (if (not (y-or-n-p (format "Take the lock on %s:%s from %s? " file rev owner))) |
590cc449 | 555 | (error "Steal cancelled")) |
ad014629 RS |
556 | (pop-to-buffer (get-buffer-create "*VC-mail*")) |
557 | (setq default-directory (expand-file-name "~/")) | |
558 | (auto-save-mode auto-save-default) | |
559 | (mail-mode) | |
560 | (erase-buffer) | |
00b3f57b | 561 | (mail-setup owner (format "%s:%s" file rev) nil nil nil |
ad014629 RS |
562 | (list (list 'vc-finish-steal file rev))) |
563 | (goto-char (point-max)) | |
594722a8 | 564 | (insert |
ad014629 | 565 | (format "I stole the lock on %s:%s, " file rev) |
594722a8 | 566 | (current-time-string) |
ad014629 RS |
567 | ".\n") |
568 | (message "Please explain why you stole the lock. Type C-c C-c when done.")) | |
594722a8 | 569 | |
ad014629 | 570 | ;; This is called when the notification has been sent. |
594722a8 | 571 | (defun vc-finish-steal (file version) |
594722a8 | 572 | (vc-backend-steal file version) |
624b4662 | 573 | (vc-resynch-window file t t)) |
594722a8 | 574 | |
594722a8 ER |
575 | (defun vc-checkin (file &optional rev comment) |
576 | "Check in the file specified by FILE. | |
577 | The optional argument REV may be a string specifying the new version level | |
67242a23 | 578 | \(if nil increment the current level). The file is either retained with write |
34291cd2 | 579 | permissions zeroed, or deleted (according to the value of `vc-keep-workfiles'). |
594722a8 ER |
580 | COMMENT is a comment string; if omitted, a buffer is |
581 | popped up to accept a comment." | |
e1f297e6 ER |
582 | (setq vc-log-after-operation-hook 'vc-checkin-hook) |
583 | (vc-start-entry file rev comment "Enter a change comment." 'vc-backend-checkin)) | |
594722a8 | 584 | |
1a2f456b ER |
585 | ;;; Here is a checkin hook that may prove useful to sites using the |
586 | ;;; ChangeLog facility supported by Emacs. | |
3b4dd9a9 RM |
587 | (defun vc-comment-to-change-log (&optional whoami file-name) |
588 | "Enter last VC comment into change log file for current buffer's file. | |
589 | Optional arg (interactive prefix) non-nil means prompt for user name and site. | |
590 | Second arg is file name of change log. \ | |
591 | If nil, uses `change-log-default-name'." | |
43cea1ab RM |
592 | (interactive (if current-prefix-arg |
593 | (list current-prefix-arg | |
594 | (prompt-for-change-log-name)))) | |
3b4dd9a9 RM |
595 | (let (;; Extract the comment first so we get any error before doing anything. |
596 | (comment (ring-ref vc-comment-ring 0)) | |
43cea1ab | 597 | ;; Don't let add-change-log-entry insert a defun name. |
3b4dd9a9 RM |
598 | (add-log-current-defun-function 'ignore) |
599 | end) | |
600 | ;; Call add-log to do half the work. | |
43cea1ab | 601 | (add-change-log-entry whoami file-name t t) |
3b4dd9a9 RM |
602 | ;; Insert the VC comment, leaving point before it. |
603 | (setq end (save-excursion (insert comment) (point-marker))) | |
604 | (if (looking-at "\\s *\\s(") | |
605 | ;; It starts with an open-paren, as in "(foo): Frobbed." | |
43cea1ab | 606 | ;; So remove the ": " add-log inserted. |
3b4dd9a9 RM |
607 | (delete-char -2)) |
608 | ;; Canonicalize the white space between the file name and comment. | |
609 | (just-one-space) | |
610 | ;; Indent rest of the text the same way add-log indented the first line. | |
611 | (let ((indentation (current-indentation))) | |
612 | (save-excursion | |
613 | (while (< (point) end) | |
614 | (forward-line 1) | |
615 | (indent-to indentation)) | |
c124b1b4 | 616 | (setq end (point)))) |
3b4dd9a9 RM |
617 | ;; Fill the inserted text, preserving open-parens at bol. |
618 | (let ((paragraph-separate (concat paragraph-separate "\\|^\\s *\\s(")) | |
619 | (paragraph-start (concat paragraph-start "\\|^\\s *\\s("))) | |
43cea1ab | 620 | (beginning-of-line) |
c124b1b4 RM |
621 | (fill-region (point) end)) |
622 | ;; Canonicalize the white space at the end of the entry so it is | |
623 | ;; separated from the next entry by a single blank line. | |
624 | (skip-syntax-forward " " end) | |
625 | (delete-char (- (skip-syntax-backward " "))) | |
626 | (or (eobp) (looking-at "\n\n") | |
627 | (insert "\n")))) | |
3b4dd9a9 | 628 | |
1a2f456b | 629 | |
8c0aaf40 | 630 | (defun vc-finish-logentry (&optional nocomment) |
594722a8 ER |
631 | "Complete the operation implied by the current log entry." |
632 | (interactive) | |
8c0aaf40 ER |
633 | ;; Check and record the comment, if any. |
634 | (if (not nocomment) | |
635 | (progn | |
636 | (goto-char (point-max)) | |
637 | (if (not (bolp)) | |
638 | (newline)) | |
639 | ;; Comment too long? | |
640 | (vc-backend-logentry-check vc-log-file) | |
641 | ;; Record the comment in the comment ring | |
642 | (if (null vc-comment-ring) | |
643 | (setq vc-comment-ring (make-ring vc-maximum-comment-ring-size))) | |
644 | (ring-insert vc-comment-ring (buffer-string)) | |
645 | )) | |
594722a8 ER |
646 | ;; OK, do it to it |
647 | (if vc-log-operation | |
e1f297e6 ER |
648 | (save-excursion |
649 | (funcall vc-log-operation | |
650 | vc-log-file | |
651 | vc-log-version | |
652 | (buffer-string))) | |
590cc449 | 653 | (error "No log operation is pending")) |
594722a8 | 654 | ;; Return to "parent" buffer of this checkin and remove checkin window |
e1f297e6 | 655 | (pop-to-buffer vc-parent-buffer) |
9a47d40b ER |
656 | (let ((logbuf (get-buffer "*VC-log*"))) |
657 | (delete-windows-on logbuf) | |
658 | (kill-buffer logbuf)) | |
594722a8 | 659 | ;; Now make sure we see the expanded headers |
e1f297e6 ER |
660 | (if buffer-file-name |
661 | (vc-resynch-window buffer-file-name vc-keep-workfiles t)) | |
662 | (run-hooks vc-log-after-operation-hook)) | |
594722a8 ER |
663 | |
664 | ;; Code for access to the comment ring | |
665 | ||
8c0aaf40 ER |
666 | (defun vc-previous-comment (arg) |
667 | "Cycle backwards through comment history." | |
668 | (interactive "*p") | |
669 | (let ((len (ring-length vc-comment-ring))) | |
670 | (cond ((<= len 0) | |
671 | (message "Empty comment ring") | |
672 | (ding)) | |
673 | (t | |
674 | (erase-buffer) | |
675 | ;; Initialize the index on the first use of this command | |
676 | ;; so that the first M-p gets index 0, and the first M-n gets | |
677 | ;; index -1. | |
678 | (if (null vc-comment-ring-index) | |
679 | (setq vc-comment-ring-index | |
680 | (if (> arg 0) -1 | |
681 | (if (< arg 0) 1 0)))) | |
682 | (setq vc-comment-ring-index | |
c6bfcd12 | 683 | (mod (+ vc-comment-ring-index arg) len)) |
8c0aaf40 ER |
684 | (message "%d" (1+ vc-comment-ring-index)) |
685 | (insert (ring-ref vc-comment-ring vc-comment-ring-index)))))) | |
686 | ||
687 | (defun vc-next-comment (arg) | |
688 | "Cycle forwards through comment history." | |
689 | (interactive "*p") | |
690 | (vc-previous-comment (- arg))) | |
691 | ||
692 | (defun vc-comment-search-reverse (str) | |
693 | "Searches backwards through comment history for substring match." | |
694 | (interactive "sComment substring: ") | |
695 | (if (string= str "") | |
696 | (setq str vc-last-comment-match) | |
697 | (setq vc-last-comment-match str)) | |
698 | (if (null vc-comment-ring-index) | |
699 | (setq vc-comment-ring-index -1)) | |
700 | (let ((str (regexp-quote str)) | |
701 | (len (ring-length vc-comment-ring)) | |
702 | (n (1+ vc-comment-ring-index))) | |
703 | (while (and (< n len) (not (string-match str (ring-ref vc-comment-ring n)))) | |
704 | (setq n (+ n 1))) | |
705 | (cond ((< n len) | |
706 | (vc-previous-comment (- n vc-comment-ring-index))) | |
707 | (t (error "Not found"))))) | |
708 | ||
709 | (defun vc-comment-search-forward (str) | |
710 | "Searches forwards through comment history for substring match." | |
711 | (interactive "sComment substring: ") | |
712 | (if (string= str "") | |
713 | (setq str vc-last-comment-match) | |
714 | (setq vc-last-comment-match str)) | |
715 | (if (null vc-comment-ring-index) | |
716 | (setq vc-comment-ring-index 0)) | |
717 | (let ((str (regexp-quote str)) | |
718 | (len (ring-length vc-comment-ring)) | |
719 | (n vc-comment-ring-index)) | |
720 | (while (and (>= n 0) (not (string-match str (ring-ref vc-comment-ring n)))) | |
721 | (setq n (- n 1))) | |
722 | (cond ((>= n 0) | |
723 | (vc-next-comment (- n vc-comment-ring-index))) | |
724 | (t (error "Not found"))))) | |
594722a8 ER |
725 | |
726 | ;; Additional entry points for examining version histories | |
727 | ||
637a8ae9 | 728 | ;;;###autoload |
594722a8 | 729 | (defun vc-diff (historic) |
e8ee1ccf RS |
730 | "Display diffs between file versions. |
731 | Normally this compares the current file and buffer with the most recent | |
732 | checked in version of that file. This uses no arguments. | |
733 | With a prefix argument, it reads the file name to use | |
734 | and two version designators specifying which versions to compare." | |
594722a8 | 735 | (interactive "P") |
e1f297e6 ER |
736 | (if vc-dired-mode |
737 | (set-buffer (find-file-noselect (dired-get-filename)))) | |
8ac8c82f | 738 | (while vc-parent-buffer |
1a2f456b | 739 | (pop-to-buffer vc-parent-buffer)) |
594722a8 ER |
740 | (if historic |
741 | (call-interactively 'vc-version-diff) | |
8c0aaf40 | 742 | (if (or (null buffer-file-name) (null (vc-name buffer-file-name))) |
064726ac JB |
743 | (error |
744 | "There is no version-control master associated with this buffer")) | |
02da6253 | 745 | (let ((file buffer-file-name) |
594722a8 | 746 | unchanged) |
7ef84cf9 RS |
747 | (or (and file (vc-name file)) |
748 | (vc-registration-error file)) | |
594722a8 ER |
749 | (vc-buffer-sync) |
750 | (setq unchanged (vc-workfile-unchanged-p buffer-file-name)) | |
751 | (if unchanged | |
02da6253 | 752 | (message "No changes to %s since latest version." file) |
594722a8 | 753 | (vc-backend-diff file nil) |
8c0aaf40 ER |
754 | ;; Ideally, we'd like at this point to parse the diff so that |
755 | ;; the buffer effectively goes into compilation mode and we | |
756 | ;; can visit the old and new change locations via next-error. | |
757 | ;; Unfortunately, this is just too painful to do. The basic | |
758 | ;; problem is that the `old' file doesn't exist to be | |
759 | ;; visited. This plays hell with numerous assumptions in | |
760 | ;; the diff.el and compile.el machinery. | |
761 | (pop-to-buffer "*vc*") | |
b246f571 RS |
762 | (pop-to-buffer "*vc*") |
763 | (if (= 0 (buffer-size)) | |
764 | (progn | |
765 | (setq unchanged t) | |
766 | (message "No changes to %s since latest version." file)) | |
4c2d8cf9 | 767 | (goto-char (point-min)) |
064726ac JB |
768 | (shrink-window-if-larger-than-buffer))) |
769 | (not unchanged)))) | |
594722a8 ER |
770 | |
771 | (defun vc-version-diff (file rel1 rel2) | |
772 | "For FILE, report diffs between two stored versions REL1 and REL2 of it. | |
773 | If FILE is a directory, generate diffs between versions for all registered | |
774 | files in or below it." | |
3234e2a3 | 775 | (interactive "FFile or directory to diff: \nsOlder version: \nsNewer version: ") |
594722a8 ER |
776 | (if (string-equal rel1 "") (setq rel1 nil)) |
777 | (if (string-equal rel2 "") (setq rel2 nil)) | |
778 | (if (file-directory-p file) | |
1a2f456b | 779 | (let ((camefrom (current-buffer))) |
594722a8 | 780 | (set-buffer (get-buffer-create "*vc-status*")) |
8c0aaf40 ER |
781 | (set (make-local-variable 'vc-parent-buffer) camefrom) |
782 | (set (make-local-variable 'vc-parent-buffer-name) | |
783 | (concat " from " (buffer-name camefrom))) | |
594722a8 | 784 | (erase-buffer) |
3234e2a3 ER |
785 | (insert "Diffs between " |
786 | (or rel1 "last version checked in") | |
787 | " and " | |
788 | (or rel2 "current workfile(s)") | |
789 | ":\n\n") | |
594722a8 | 790 | (set-buffer (get-buffer-create "*vc*")) |
e1f297e6 | 791 | (cd file) |
594722a8 ER |
792 | (vc-file-tree-walk |
793 | (function (lambda (f) | |
a9a59766 | 794 | (message "Looking at %s" f) |
594722a8 | 795 | (and |
3234e2a3 ER |
796 | (not (file-directory-p f)) |
797 | (vc-registered f) | |
02da6253 PE |
798 | (vc-backend-diff f rel1 rel2) |
799 | (append-to-buffer "*vc-status*" (point-min) (point-max))) | |
800 | ))) | |
594722a8 ER |
801 | (pop-to-buffer "*vc-status*") |
802 | (insert "\nEnd of diffs.\n") | |
803 | (goto-char (point-min)) | |
804 | (set-buffer-modified-p nil) | |
805 | ) | |
36bed8bc RS |
806 | (if (zerop (vc-backend-diff file rel1 rel2)) |
807 | (message "No changes to %s between %s and %s." file rel1 rel2) | |
24f1977f | 808 | (pop-to-buffer "*vc*")))) |
594722a8 | 809 | |
f1818994 PE |
810 | ;;;###autoload |
811 | (defun vc-version-other-window (rev) | |
812 | "Visit version REV of the current buffer in another window. | |
813 | If the current buffer is named `F', the version is named `F.~REV~'. | |
814 | If `F.~REV~' already exists, it is used instead of being re-created." | |
815 | (interactive "sVersion to visit (default is latest version): ") | |
816 | (if vc-dired-mode | |
817 | (set-buffer (find-file-noselect (dired-get-filename)))) | |
818 | (while vc-parent-buffer | |
819 | (pop-to-buffer vc-parent-buffer)) | |
820 | (if (and buffer-file-name (vc-name buffer-file-name)) | |
821 | (let* ((version (if (string-equal rev "") | |
822 | (vc-latest-version buffer-file-name) | |
823 | rev)) | |
824 | (filename (concat buffer-file-name ".~" version "~"))) | |
825 | (or (file-exists-p filename) | |
826 | (vc-backend-checkout buffer-file-name nil version filename)) | |
827 | (find-file-other-window filename)) | |
828 | (vc-registration-error buffer-file-name))) | |
829 | ||
594722a8 ER |
830 | ;; Header-insertion code |
831 | ||
637a8ae9 | 832 | ;;;###autoload |
594722a8 ER |
833 | (defun vc-insert-headers () |
834 | "Insert headers in a file for use with your version-control system. | |
835 | Headers desired are inserted at the start of the buffer, and are pulled from | |
34291cd2 | 836 | the variable `vc-header-alist'." |
594722a8 | 837 | (interactive) |
e1f297e6 ER |
838 | (if vc-dired-mode |
839 | (find-file-other-window (dired-get-filename))) | |
8ac8c82f | 840 | (while vc-parent-buffer |
1a2f456b | 841 | (pop-to-buffer vc-parent-buffer)) |
594722a8 ER |
842 | (save-excursion |
843 | (save-restriction | |
844 | (widen) | |
845 | (if (or (not (vc-check-headers)) | |
820bde8d | 846 | (y-or-n-p "Version headers already exist. Insert another set? ")) |
594722a8 ER |
847 | (progn |
848 | (let* ((delims (cdr (assq major-mode vc-comment-alist))) | |
849 | (comment-start-vc (or (car delims) comment-start "#")) | |
850 | (comment-end-vc (or (car (cdr delims)) comment-end "")) | |
851 | (hdstrings (cdr (assoc (vc-backend-deduce (buffer-file-name)) vc-header-alist)))) | |
852 | (mapcar (function (lambda (s) | |
853 | (insert comment-start-vc "\t" s "\t" | |
854 | comment-end-vc "\n"))) | |
855 | hdstrings) | |
856 | (if vc-static-header-alist | |
857 | (mapcar (function (lambda (f) | |
858 | (if (string-match (car f) buffer-file-name) | |
859 | (insert (format (cdr f) (car hdstrings)))))) | |
860 | vc-static-header-alist)) | |
861 | ) | |
862 | ))))) | |
863 | ||
e1f297e6 ER |
864 | ;; The VC directory submode. Coopt Dired for this. |
865 | ;; All VC commands get mapped into logical equivalents. | |
866 | ||
ee7e9c88 RS |
867 | (defvar vc-dired-prefix-map (make-sparse-keymap)) |
868 | (define-key vc-dired-prefix-map "\C-xv" vc-prefix-map) | |
869 | ||
1434b7aa RS |
870 | (or (not (boundp 'minor-mode-map-alist)) |
871 | (assq 'vc-dired-mode minor-mode-map-alist) | |
e1f297e6 | 872 | (setq minor-mode-map-alist |
4f6e4ad6 | 873 | (cons (cons 'vc-dired-mode vc-dired-prefix-map) |
ee7e9c88 | 874 | minor-mode-map-alist))) |
e1f297e6 ER |
875 | |
876 | (defun vc-dired-mode () | |
877 | "The augmented Dired minor mode used in VC directory buffers. | |
878 | All Dired commands operate normally. Users currently locking listed files | |
ee7e9c88 | 879 | are listed in place of the file's owner and group. |
e1f297e6 ER |
880 | Keystrokes bound to VC commands will execute as though they had been called |
881 | on a buffer attached to the file named in the current Dired buffer line." | |
882 | (setq vc-dired-mode t) | |
883 | (setq vc-mode " under VC")) | |
594722a8 | 884 | |
8c0aaf40 ER |
885 | (defun vc-dired-reformat-line (x) |
886 | ;; Hack a directory-listing line, plugging in locking-user info in | |
34291cd2 RS |
887 | ;; place of the user and group info. Should have the beneficial |
888 | ;; side-effect of shortening the listing line. Each call starts with | |
8c0aaf40 ER |
889 | ;; point immediately following the dired mark area on the line to be |
890 | ;; hacked. | |
891 | ;; | |
892 | ;; Simplest possible one: | |
893 | ;; (insert (concat x "\t"))) | |
894 | ;; | |
895 | ;; This code, like dired, assumes UNIX -l format. | |
896 | (forward-word 1) ;; skip over any extra field due to -ibs options | |
897 | (if x (setq x (concat "(" x ")"))) | |
898 | (if (re-search-forward "\\([0-9]+ \\).................\\( .*\\)" nil 0) | |
899 | (let ((rep (substring (concat x " ") 0 9))) | |
900 | (replace-match (concat "\\1" rep "\\2") t))) | |
901 | ) | |
902 | ||
6ed5075c RS |
903 | ;;; Note in Emacs 18 the following defun gets overridden |
904 | ;;; with the symbol 'vc-directory-18. See below. | |
637a8ae9 | 905 | ;;;###autoload |
594722a8 ER |
906 | (defun vc-directory (verbose) |
907 | "Show version-control status of all files under the current directory." | |
908 | (interactive "P") | |
e1f297e6 ER |
909 | (let (nonempty |
910 | (dl (length default-directory)) | |
911 | (filelist nil) (userlist nil) | |
8c0aaf40 ER |
912 | dired-buf |
913 | dired-buf-mod-count) | |
e1f297e6 ER |
914 | (vc-file-tree-walk |
915 | (function (lambda (f) | |
916 | (if (vc-registered f) | |
917 | (let ((user (vc-locking-user f))) | |
918 | (and (or verbose user) | |
919 | (setq filelist (cons (substring f dl) filelist)) | |
920 | (setq userlist (cons user userlist)))))))) | |
594722a8 | 921 | (save-excursion |
34291cd2 | 922 | ;; This uses a semi-documented feature of dired; giving a switch |
8c0aaf40 ER |
923 | ;; argument forces the buffer to refresh each time. |
924 | (dired | |
925 | (cons default-directory (nreverse filelist)) | |
926 | dired-listing-switches) | |
927 | (setq dired-buf (current-buffer)) | |
928 | (setq nonempty (not (zerop (buffer-size))))) | |
594722a8 ER |
929 | (if nonempty |
930 | (progn | |
e1f297e6 ER |
931 | (pop-to-buffer dired-buf) |
932 | (vc-dired-mode) | |
933 | (goto-char (point-min)) | |
934 | (setq buffer-read-only nil) | |
8c0aaf40 | 935 | (forward-line 1) ;; Skip header line |
e1f297e6 | 936 | (mapcar |
7ef84cf9 RS |
937 | (function |
938 | (lambda (x) | |
8c0aaf40 ER |
939 | (forward-char 2) ;; skip dired's mark area |
940 | (vc-dired-reformat-line x) | |
7ef84cf9 | 941 | (forward-line 1))) ;; go to next line |
8c0aaf40 | 942 | (nreverse userlist)) |
e1f297e6 ER |
943 | (setq buffer-read-only t) |
944 | (goto-char (point-min)) | |
945 | ) | |
02da6253 PE |
946 | (message "No files are currently %s under %s" |
947 | (if verbose "registered" "locked") default-directory)) | |
594722a8 ER |
948 | )) |
949 | ||
6ed5075c RS |
950 | ;; Emacs 18 version |
951 | (defun vc-directory-18 (verbose) | |
952 | "Show version-control status of all files under the current directory." | |
953 | (interactive "P") | |
0ee7d623 | 954 | (let (nonempty (dir default-directory)) |
6ed5075c RS |
955 | (save-excursion |
956 | (set-buffer (get-buffer-create "*vc-status*")) | |
957 | (erase-buffer) | |
0ee7d623 | 958 | (cd dir) |
6ed5075c RS |
959 | (vc-file-tree-walk |
960 | (function (lambda (f) | |
961 | (if (vc-registered f) | |
962 | (let ((user (vc-locking-user f))) | |
963 | (if (or user verbose) | |
964 | (insert (format | |
965 | "%s %s\n" | |
966 | (concat user) f)))))))) | |
967 | (setq nonempty (not (zerop (buffer-size))))) | |
968 | (if nonempty | |
969 | (progn | |
970 | (pop-to-buffer "*vc-status*" t) | |
4c2d8cf9 RS |
971 | (goto-char (point-min)) |
972 | (shrink-window-if-larger-than-buffer))) | |
6ed5075c RS |
973 | (message "No files are currently %s under %s" |
974 | (if verbose "registered" "locked") default-directory)) | |
064726ac | 975 | ) |
6ed5075c RS |
976 | |
977 | (or (boundp 'minor-mode-map-alist) | |
978 | (fset 'vc-directory 'vc-directory-18)) | |
979 | ||
7ef84cf9 RS |
980 | ; Emacs 18 also lacks these. |
981 | (or (boundp 'compilation-old-error-list) | |
982 | (setq compilation-old-error-list nil)) | |
983 | ||
594722a8 ER |
984 | ;; Named-configuration support for SCCS |
985 | ||
986 | (defun vc-add-triple (name file rev) | |
987 | (save-excursion | |
988 | (find-file (concat (vc-backend-subdirectory-name file) "/" vc-name-assoc-file)) | |
989 | (goto-char (point-max)) | |
990 | (insert name "\t:\t" file "\t" rev "\n") | |
991 | (basic-save-buffer) | |
992 | (kill-buffer (current-buffer)) | |
993 | )) | |
994 | ||
995 | (defun vc-record-rename (file newname) | |
996 | (save-excursion | |
997 | (find-file (concat (vc-backend-subdirectory-name file) "/" vc-name-assoc-file)) | |
998 | (goto-char (point-min)) | |
999 | (replace-regexp (concat ":" (regexp-quote file) "$") (concat ":" newname)) | |
1000 | (basic-save-buffer) | |
1001 | (kill-buffer (current-buffer)) | |
1002 | )) | |
1003 | ||
1004 | (defun vc-lookup-triple (file name) | |
7b4f934d ER |
1005 | ;; Return the numeric version corresponding to a named snapshot of file |
1006 | ;; If name is nil or a version number string it's just passed through | |
1007 | (cond ((null name) "") | |
1008 | ((let ((firstchar (aref name 0))) | |
1009 | (and (>= firstchar ?0) (<= firstchar ?9))) | |
1010 | name) | |
1011 | (t | |
1012 | (car (vc-master-info | |
1013 | (concat (vc-backend-subdirectory-name file) "/" vc-name-assoc-file) | |
1014 | (list (concat name "\t:\t" file "\t\\(.+\\)")))) | |
1015 | ))) | |
594722a8 ER |
1016 | |
1017 | ;; Named-configuration entry points | |
1018 | ||
1dabb4e6 PE |
1019 | (defun vc-locked-example () |
1020 | ;; Return an example of why the current directory is not ready to be snapshot | |
1021 | ;; or nil if no such example exists. | |
1022 | (catch 'vc-locked-example | |
02da6253 PE |
1023 | (vc-file-tree-walk |
1024 | (function (lambda (f) | |
1025 | (if (and (vc-registered f) (vc-locking-user f)) | |
1dabb4e6 PE |
1026 | (throw 'vc-locked-example f))))) |
1027 | nil)) | |
594722a8 | 1028 | |
637a8ae9 | 1029 | ;;;###autoload |
594722a8 ER |
1030 | (defun vc-create-snapshot (name) |
1031 | "Make a snapshot called NAME. | |
1032 | The snapshot is made from all registered files at or below the current | |
1033 | directory. For each file, the version level of its latest | |
1034 | version becomes part of the named configuration." | |
1035 | (interactive "sNew snapshot name: ") | |
1dabb4e6 PE |
1036 | (let ((locked (vc-locked-example))) |
1037 | (if locked | |
1038 | (error "File %s is locked" locked) | |
1039 | (vc-file-tree-walk | |
1040 | (function (lambda (f) (and | |
1041 | (vc-name f) | |
1042 | (vc-backend-assign-name f name))))) | |
1043 | ))) | |
594722a8 | 1044 | |
637a8ae9 | 1045 | ;;;###autoload |
594722a8 ER |
1046 | (defun vc-retrieve-snapshot (name) |
1047 | "Retrieve the snapshot called NAME. | |
1048 | This function fails if any files are locked at or below the current directory | |
1049 | Otherwise, all registered files are checked out (unlocked) at their version | |
1050 | levels in the snapshot." | |
1051 | (interactive "sSnapshot name to retrieve: ") | |
1dabb4e6 PE |
1052 | (let ((locked (vc-locked-example))) |
1053 | (if locked | |
1054 | (error "File %s is locked" locked) | |
1055 | (vc-file-tree-walk | |
1056 | (function (lambda (f) (and | |
1057 | (vc-name f) | |
1058 | (vc-error-occurred | |
1059 | (vc-backend-checkout f nil name)))))) | |
1060 | ))) | |
594722a8 ER |
1061 | |
1062 | ;; Miscellaneous other entry points | |
1063 | ||
637a8ae9 | 1064 | ;;;###autoload |
594722a8 ER |
1065 | (defun vc-print-log () |
1066 | "List the change log of the current buffer in a window." | |
1067 | (interactive) | |
e1f297e6 ER |
1068 | (if vc-dired-mode |
1069 | (set-buffer (find-file-noselect (dired-get-filename)))) | |
8ac8c82f | 1070 | (while vc-parent-buffer |
1a2f456b | 1071 | (pop-to-buffer vc-parent-buffer)) |
594722a8 ER |
1072 | (if (and buffer-file-name (vc-name buffer-file-name)) |
1073 | (progn | |
1074 | (vc-backend-print-log buffer-file-name) | |
1075 | (pop-to-buffer (get-buffer-create "*vc*")) | |
4805f679 BF |
1076 | (while (looking-at "=*\n") |
1077 | (delete-char (- (match-end 0) (match-beginning 0))) | |
1078 | (forward-line -1)) | |
594722a8 | 1079 | (goto-char (point-min)) |
4805f679 BF |
1080 | (if (looking-at "[\b\t\n\v\f\r ]+") |
1081 | (delete-char (- (match-end 0) (match-beginning 0)))) | |
4c2d8cf9 | 1082 | (shrink-window-if-larger-than-buffer) |
594722a8 | 1083 | ) |
7ef84cf9 | 1084 | (vc-registration-error buffer-file-name) |
594722a8 ER |
1085 | ) |
1086 | ) | |
1087 | ||
637a8ae9 | 1088 | ;;;###autoload |
594722a8 | 1089 | (defun vc-revert-buffer () |
9c95ac44 RS |
1090 | "Revert the current buffer's file back to the latest checked-in version. |
1091 | This asks for confirmation if the buffer contents are not identical | |
1092 | to that version." | |
594722a8 | 1093 | (interactive) |
e1f297e6 ER |
1094 | (if vc-dired-mode |
1095 | (find-file-other-window (dired-get-filename))) | |
8ac8c82f | 1096 | (while vc-parent-buffer |
1a2f456b | 1097 | (pop-to-buffer vc-parent-buffer)) |
594722a8 ER |
1098 | (let ((file buffer-file-name) |
1099 | (obuf (current-buffer)) (changed (vc-diff nil))) | |
9c95ac44 RS |
1100 | (if (and changed (or vc-suppress-confirm |
1101 | (not (yes-or-no-p "Discard changes? ")))) | |
594722a8 ER |
1102 | (progn |
1103 | (delete-window) | |
590cc449 | 1104 | (error "Revert cancelled")) |
594722a8 ER |
1105 | (set-buffer obuf)) |
1106 | (if changed | |
1107 | (delete-window)) | |
1108 | (vc-backend-revert file) | |
624b4662 | 1109 | (vc-resynch-window file t t) |
594722a8 ER |
1110 | ) |
1111 | ) | |
1112 | ||
637a8ae9 | 1113 | ;;;###autoload |
594722a8 | 1114 | (defun vc-cancel-version (norevert) |
34291cd2 RS |
1115 | "Get rid of most recently checked in version of this file. |
1116 | A prefix argument means do not revert the buffer afterwards." | |
594722a8 | 1117 | (interactive "P") |
e1f297e6 ER |
1118 | (if vc-dired-mode |
1119 | (find-file-other-window (dired-get-filename))) | |
8ac8c82f ER |
1120 | (while vc-parent-buffer |
1121 | (pop-to-buffer vc-parent-buffer)) | |
1122 | (let* ((target (concat (vc-latest-version (buffer-file-name)))) | |
1123 | (yours (concat (vc-your-latest-version (buffer-file-name)))) | |
7b4f934d | 1124 | (prompt (if (string-equal yours target) |
590cc449 RS |
1125 | "Remove your version %s from master? " |
1126 | "Version %s was not your change. Remove it anyway? "))) | |
7b4f934d ER |
1127 | (if (null (yes-or-no-p (format prompt target))) |
1128 | nil | |
1129 | (vc-backend-uncheck (buffer-file-name) target) | |
34291cd2 RS |
1130 | (if (or norevert |
1131 | (not (yes-or-no-p "Revert buffer to most recent remaining version? "))) | |
7b4f934d ER |
1132 | (vc-mode-line (buffer-file-name)) |
1133 | (vc-checkout (buffer-file-name) nil))) | |
8ac8c82f | 1134 | )) |
594722a8 ER |
1135 | |
1136 | (defun vc-rename-file (old new) | |
34291cd2 RS |
1137 | "Rename file OLD to NEW, and rename its master file likewise." |
1138 | (interactive "fVC rename file: \nFRename to: ") | |
594722a8 | 1139 | (let ((oldbuf (get-file-buffer old))) |
d52f0de9 | 1140 | (if (and oldbuf (buffer-modified-p oldbuf)) |
590cc449 | 1141 | (error "Please save files before moving them")) |
594722a8 | 1142 | (if (get-file-buffer new) |
590cc449 | 1143 | (error "Already editing new file name")) |
d52f0de9 RS |
1144 | (if (file-exists-p new) |
1145 | (error "New file already exists")) | |
594722a8 ER |
1146 | (let ((oldmaster (vc-name old))) |
1147 | (if oldmaster | |
d52f0de9 RS |
1148 | (progn |
1149 | (if (vc-locking-user old) | |
1150 | (error "Please check in files before moving them")) | |
1151 | (if (or (file-symlink-p oldmaster) | |
1152 | ;; This had FILE, I changed it to OLD. -- rms. | |
1153 | (file-symlink-p (vc-backend-subdirectory-name old))) | |
1154 | (error "This is not a safe thing to do in the presence of symbolic links")) | |
1155 | (rename-file | |
1156 | oldmaster | |
1157 | (let ((backend (vc-backend-deduce old)) | |
1158 | (newdir (or (file-name-directory new) "")) | |
1159 | (newbase (file-name-nondirectory new))) | |
1160 | (catch 'found | |
1161 | (mapcar | |
1162 | (function | |
1163 | (lambda (s) | |
1164 | (if (eq backend (cdr s)) | |
1165 | (let* ((newmaster (format (car s) newdir newbase)) | |
1166 | (newmasterdir (file-name-directory newmaster))) | |
1167 | (if (or (not newmasterdir) | |
1168 | (file-directory-p newmasterdir)) | |
1169 | (throw 'found newmaster)))))) | |
1170 | vc-master-templates) | |
1171 | (error "New file lacks a version control directory")))))) | |
594722a8 ER |
1172 | (if (or (not oldmaster) (file-exists-p old)) |
1173 | (rename-file old new))) | |
1174 | ; ?? Renaming a file might change its contents due to keyword expansion. | |
1175 | ; We should really check out a new copy if the old copy was precisely equal | |
1176 | ; to some checked in version. However, testing for this is tricky.... | |
1177 | (if oldbuf | |
1178 | (save-excursion | |
1179 | (set-buffer oldbuf) | |
1180 | (set-visited-file-name new) | |
1181 | (set-buffer-modified-p nil)))) | |
60213ed0 RS |
1182 | ;; This had FILE, I changed it to OLD. -- rms. |
1183 | (vc-backend-dispatch old | |
594722a8 ER |
1184 | (vc-record-rename old new) |
1185 | nil) | |
1186 | ) | |
1187 | ||
637a8ae9 | 1188 | ;;;###autoload |
f35ecf88 RM |
1189 | (defun vc-update-change-log (&rest args) |
1190 | "Find change log file and add entries from recent RCS logs. | |
1191 | The mark is left at the end of the text prepended to the change log. | |
1192 | With prefix arg of C-u, only find log entries for the current buffer's file. | |
1193 | With any numeric prefix arg, find log entries for all files currently visited. | |
4b40fdea | 1194 | Otherwise, find log entries for all registered files in the default directory. |
f35ecf88 | 1195 | From a program, any arguments are passed to the `rcs2log' script." |
67242a23 RM |
1196 | (interactive |
1197 | (cond ((consp current-prefix-arg) ;C-u | |
1198 | (list buffer-file-name)) | |
1199 | (current-prefix-arg ;Numeric argument. | |
1200 | (let ((files nil) | |
1201 | (buffers (buffer-list)) | |
1202 | file) | |
1203 | (while buffers | |
1204 | (setq file (buffer-file-name (car buffers))) | |
1205 | (and file (vc-backend-deduce file) | |
4b40fdea | 1206 | (setq files (cons file files))) |
67242a23 | 1207 | (setq buffers (cdr buffers))) |
4b40fdea PE |
1208 | files)) |
1209 | (t | |
1210 | (let ((RCS (concat default-directory "RCS"))) | |
1211 | (and (file-directory-p RCS) | |
1212 | (mapcar (function | |
1213 | (lambda (f) | |
1214 | (if (string-match "\\(.*\\),v$" f) | |
1215 | (substring f 0 (match-end 1)) | |
1216 | f))) | |
1217 | (directory-files RCS nil "...\\|^[^.]\\|^.[^.]"))))))) | |
41dfb835 RS |
1218 | (let ((odefault default-directory)) |
1219 | (find-file-other-window (find-change-log)) | |
1220 | (barf-if-buffer-read-only) | |
1221 | (vc-buffer-sync) | |
1222 | (undo-boundary) | |
1223 | (goto-char (point-min)) | |
1224 | (push-mark) | |
1225 | (message "Computing change log entries...") | |
4b40fdea PE |
1226 | (message "Computing change log entries... %s" |
1227 | (if (or (null args) | |
1228 | (eq 0 (apply 'call-process "rcs2log" nil t nil | |
1229 | (mapcar (function | |
1230 | (lambda (f) | |
1231 | (file-relative-name | |
1232 | (if (file-name-absolute-p f) | |
1233 | f | |
1234 | (concat odefault f))))) | |
1235 | args)))) | |
1236 | "done" "failed")))) | |
594722a8 ER |
1237 | |
1238 | ;; Functions for querying the master and lock files. | |
1239 | ||
caf15d4f | 1240 | (defun vc-match-substring (bn) |
594722a8 ER |
1241 | (buffer-substring (match-beginning bn) (match-end bn))) |
1242 | ||
1243 | (defun vc-parse-buffer (patterns &optional file properties) | |
1244 | ;; Use PATTERNS to parse information out of the current buffer | |
1245 | ;; by matching each regular expression in the list and returning \\1. | |
1246 | ;; If a regexp has two tag brackets, assume the second is a date | |
1247 | ;; field and we want the most recent entry matching the template. | |
1248 | ;; If FILE and PROPERTIES are given, the latter must be a list of | |
1249 | ;; properties of the same length as PATTERNS; each property is assigned | |
1250 | ;; the corresponding value. | |
1251 | (mapcar (function (lambda (p) | |
1252 | (goto-char (point-min)) | |
1253 | (if (string-match "\\\\(.*\\\\(" p) | |
1254 | (let ((latest-date "") (latest-val)) | |
1255 | (while (re-search-forward p nil t) | |
caf15d4f | 1256 | (let ((date (vc-match-substring 2))) |
594722a8 ER |
1257 | (if (string< latest-date date) |
1258 | (progn | |
1259 | (setq latest-date date) | |
1260 | (setq latest-val | |
caf15d4f | 1261 | (vc-match-substring 1)))))) |
594722a8 ER |
1262 | latest-val)) |
1263 | (prog1 | |
1264 | (and (re-search-forward p nil t) | |
caf15d4f | 1265 | (let ((value (vc-match-substring 1))) |
594722a8 ER |
1266 | (if file |
1267 | (vc-file-setprop file (car properties) value)) | |
1268 | value)) | |
1269 | (setq properties (cdr properties))))) | |
1270 | patterns) | |
1271 | ) | |
1272 | ||
1273 | (defun vc-master-info (file fields &optional rfile properties) | |
1274 | ;; Search for information in a master file. | |
1275 | (if (and file (file-exists-p file)) | |
1276 | (save-excursion | |
1277 | (let ((buf)) | |
1278 | (setq buf (create-file-buffer file)) | |
1279 | (set-buffer buf)) | |
1280 | (erase-buffer) | |
1281 | (insert-file-contents file nil) | |
1282 | (set-buffer-modified-p nil) | |
1283 | (auto-save-mode nil) | |
1284 | (prog1 | |
1285 | (vc-parse-buffer fields rfile properties) | |
1286 | (kill-buffer (current-buffer))) | |
1287 | ) | |
1288 | (if rfile | |
1289 | (mapcar | |
1290 | (function (lambda (p) (vc-file-setprop rfile p nil))) | |
1291 | properties)) | |
1292 | ) | |
1293 | ) | |
1294 | ||
1295 | (defun vc-log-info (command file patterns &optional properties) | |
1296 | ;; Search for information in log program output | |
1297 | (if (and file (file-exists-p file)) | |
1298 | (save-excursion | |
1299 | (let ((buf)) | |
1300 | (setq buf (get-buffer-create "*vc*")) | |
1301 | (set-buffer buf)) | |
1302 | (apply 'vc-do-command 0 command file nil) | |
1303 | (set-buffer-modified-p nil) | |
1304 | (prog1 | |
1305 | (vc-parse-buffer patterns file properties) | |
1306 | (kill-buffer (current-buffer)) | |
1307 | ) | |
1308 | ) | |
1309 | (if file | |
1310 | (mapcar | |
1311 | (function (lambda (p) (vc-file-setprop file p nil))) | |
1312 | properties)) | |
1313 | ) | |
1314 | ) | |
1315 | ||
1316 | (defun vc-locking-user (file) | |
1317 | "Return the name of the person currently holding a lock on FILE. | |
1318 | Return nil if there is no such person." | |
e1f297e6 | 1319 | (setq file (expand-file-name file)) ;; ??? Work around bug in 19.0.4 |
594722a8 ER |
1320 | (if (or (not vc-keep-workfiles) |
1321 | (eq vc-mistrust-permissions 't) | |
1322 | (and vc-mistrust-permissions | |
1323 | (funcall vc-mistrust-permissions (vc-backend-subdirectory-name file)))) | |
1324 | (vc-true-locking-user file) | |
1325 | ;; This implementation assumes that any file which is under version | |
1326 | ;; control and has -rw-r--r-- is locked by its owner. This is true | |
1327 | ;; for both RCS and SCCS, which keep unlocked files at -r--r--r--. | |
1328 | ;; We have to be careful not to exclude files with execute bits on; | |
1329 | ;; scripts can be under version control too. The advantage of this | |
1330 | ;; hack is that calls to the very expensive vc-fetch-properties | |
1331 | ;; function only have to be made if (a) the file is locked by someone | |
1332 | ;; other than the current user, or (b) some untoward manipulation | |
e1f297e6 ER |
1333 | ;; behind vc's back has changed the owner or the `group' or `other' |
1334 | ;; write bits. | |
594722a8 ER |
1335 | (let ((attributes (file-attributes file))) |
1336 | (cond ((string-match ".r-.r-.r-." (nth 8 attributes)) | |
1337 | nil) | |
1338 | ((and (= (nth 2 attributes) (user-uid)) | |
1339 | (string-match ".rw.r-.r-." (nth 8 attributes))) | |
1340 | (user-login-name)) | |
1341 | (t | |
1342 | (vc-true-locking-user file)))))) | |
1343 | ||
1344 | (defun vc-true-locking-user (file) | |
1345 | ;; The slow but reliable version | |
1346 | (vc-fetch-properties file) | |
1347 | (vc-file-getprop file 'vc-locking-user)) | |
1348 | ||
1349 | (defun vc-latest-version (file) | |
1350 | ;; Return version level of the latest version of FILE | |
1351 | (vc-fetch-properties file) | |
1352 | (vc-file-getprop file 'vc-latest-version)) | |
1353 | ||
1354 | (defun vc-your-latest-version (file) | |
1355 | ;; Return version level of the latest version of FILE checked in by you | |
1356 | (vc-fetch-properties file) | |
1357 | (vc-file-getprop file 'vc-your-latest-version)) | |
1358 | ||
1359 | ;; Collect back-end-dependent stuff here | |
1360 | ;; | |
1361 | ;; Everything eventually funnels through these functions. To implement | |
1362 | ;; support for a new version-control system, add another branch to the | |
7b4f934d ER |
1363 | ;; vc-backend-dispatch macro and fill it in in each call. The variable |
1364 | ;; vc-master-templates in vc-hooks.el will also have to change. | |
594722a8 ER |
1365 | |
1366 | (defmacro vc-backend-dispatch (f s r) | |
1367 | "Execute FORM1 or FORM2 depending on whether we're using SCCS or RCS." | |
1368 | (list 'let (list (list 'type (list 'vc-backend-deduce f))) | |
1369 | (list 'cond | |
1370 | (list (list 'eq 'type (quote 'SCCS)) s) ;; SCCS | |
1371 | (list (list 'eq 'type (quote 'RCS)) r) ;; RCS | |
1372 | ))) | |
1373 | ||
1374 | (defun vc-lock-file (file) | |
1375 | ;; Generate lock file name corresponding to FILE | |
1376 | (let ((master (vc-name file))) | |
1377 | (and | |
1378 | master | |
1379 | (string-match "\\(.*/\\)s\\.\\(.*\\)" master) | |
1380 | (concat | |
1381 | (substring master (match-beginning 1) (match-end 1)) | |
1382 | "p." | |
1383 | (substring master (match-beginning 2) (match-end 2)))))) | |
1384 | ||
1385 | ||
1386 | (defun vc-fetch-properties (file) | |
1387 | ;; Re-fetch all properties associated with the given file. | |
1388 | ;; Currently these properties are: | |
1389 | ;; vc-locking-user | |
1390 | ;; vc-locked-version | |
1391 | ;; vc-latest-version | |
1392 | ;; vc-your-latest-version | |
1393 | (vc-backend-dispatch | |
1394 | file | |
1395 | ;; SCCS | |
1396 | (progn | |
1397 | (vc-master-info (vc-lock-file file) | |
1398 | (list | |
1399 | "^[^ ]+ [^ ]+ \\([^ ]+\\)" | |
1400 | "^\\([^ ]+\\)") | |
1401 | file | |
1402 | '(vc-locking-user vc-locked-version)) | |
1403 | (vc-master-info (vc-name file) | |
1404 | (list | |
1405 | "^\001d D \\([^ ]+\\)" | |
1406 | (concat "^\001d D \\([^ ]+\\) .* " | |
1407 | (regexp-quote (user-login-name)) " ") | |
1408 | ) | |
1409 | file | |
1410 | '(vc-latest-version vc-your-latest-version)) | |
1411 | ) | |
1412 | ;; RCS | |
1413 | (vc-log-info "rlog" file | |
1414 | (list | |
1415 | "^locks: strict\n\t\\([^:]+\\)" | |
1416 | "^locks: strict\n\t[^:]+: \\(.+\\)" | |
1417 | "^revision[\t ]+\\([0-9.]+\\).*\ndate: \\([ /0-9:]+\\);" | |
1418 | (concat | |
3234e2a3 | 1419 | "^revision[\t ]+\\([0-9.]+\\)\n.*author: " |
594722a8 | 1420 | (regexp-quote (user-login-name)) |
3234e2a3 | 1421 | ";")) |
594722a8 ER |
1422 | '(vc-locking-user vc-locked-version |
1423 | vc-latest-version vc-your-latest-version)) | |
1424 | )) | |
1425 | ||
1426 | (defun vc-backend-subdirectory-name (&optional file) | |
1427 | ;; Where the master and lock files for the current directory are kept | |
1428 | (symbol-name | |
1429 | (or | |
1430 | (and file (vc-backend-deduce file)) | |
1431 | vc-default-back-end | |
1432 | (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS))))) | |
1433 | ||
1434 | (defun vc-backend-admin (file &optional rev comment) | |
1435 | ;; Register a file into the version-control system | |
1436 | ;; Automatically retrieves a read-only version of the file with | |
1437 | ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise | |
1438 | ;; it deletes the workfile. | |
1439 | (vc-file-clearprops file) | |
1440 | (or vc-default-back-end | |
1441 | (setq vc-default-back-end (if (vc-find-binary "rcs") 'RCS 'SCCS))) | |
1442 | (message "Registering %s..." file) | |
1443 | (let ((backend | |
1444 | (cond | |
1445 | ((file-exists-p (vc-backend-subdirectory-name)) vc-default-back-end) | |
1446 | ((file-exists-p "RCS") 'RCS) | |
1447 | ((file-exists-p "SCCS") 'SCCS) | |
1448 | (t vc-default-back-end)))) | |
1449 | (cond ((eq backend 'SCCS) | |
1450 | (vc-do-command 0 "admin" file ;; SCCS | |
1451 | (and rev (concat "-r" rev)) | |
1452 | "-fb" | |
1453 | (concat "-i" file) | |
1454 | (and comment (concat "-y" comment)) | |
1455 | (format | |
1456 | (car (rassq 'SCCS vc-master-templates)) | |
1457 | (or (file-name-directory file) "") | |
1458 | (file-name-nondirectory file))) | |
1459 | (delete-file file) | |
1460 | (if vc-keep-workfiles | |
1461 | (vc-do-command 0 "get" file))) | |
1462 | ((eq backend 'RCS) | |
1463 | (vc-do-command 0 "ci" file ;; RCS | |
1464 | (concat (if vc-keep-workfiles "-u" "-r") rev) | |
1465 | (and comment (concat "-t-" comment)) | |
1466 | file) | |
1467 | ))) | |
1468 | (message "Registering %s...done" file) | |
1469 | ) | |
1470 | ||
f1818994 | 1471 | (defun vc-backend-checkout (file &optional writable rev workfile) |
594722a8 | 1472 | ;; Retrieve a copy of a saved version into a workfile |
f1818994 PE |
1473 | (let ((filename (or workfile file))) |
1474 | (message "Checking out %s..." filename) | |
1475 | (vc-backend-dispatch file | |
594722a8 | 1476 | (vc-do-command 0 "get" file ;; SCCS |
34291cd2 | 1477 | (if writable "-e") |
f1818994 | 1478 | (if workfile (concat "-G" workfile)) |
594722a8 | 1479 | (and rev (concat "-r" (vc-lookup-triple file rev)))) |
f1818994 PE |
1480 | (if workfile ;; RCS |
1481 | ;; RCS doesn't let us check out into arbitrary file names directly. | |
1482 | ;; Use `co -p' and make stdout point to the correct file. | |
219a7d3f | 1483 | (let ((vc-modes (logior (file-modes (vc-name file)) |
f1818994 PE |
1484 | (if writable 128 0))) |
1485 | (failed t)) | |
1486 | (unwind-protect | |
1487 | (progn | |
f1818994 PE |
1488 | (vc-do-command |
1489 | 0 "/bin/sh" file "-c" | |
219a7d3f PE |
1490 | (format "umask %o; exec >\"$1\" || exit; shift; umask %o; exec co \"$@\"" |
1491 | (logand 511 (lognot vc-modes)) | |
1492 | (logand 511 (lognot (default-file-modes)))) | |
f1818994 PE |
1493 | "" ; dummy argument for shell's $0 |
1494 | filename | |
1495 | (if writable "-l") | |
1496 | (concat "-p" rev)) | |
1497 | (setq failed nil)) | |
f1818994 PE |
1498 | (and failed (file-exists-p filename) (delete-file filename)))) |
1499 | (vc-do-command 0 "co" file | |
1500 | (if writable "-l") | |
1501 | (and rev (concat "-r" rev)))) | |
594722a8 | 1502 | ) |
f1818994 PE |
1503 | (or workfile |
1504 | (vc-file-setprop file 'vc-checkout-time (nth 5 (file-attributes file)))) | |
1505 | (message "Checking out %s...done" filename)) | |
594722a8 ER |
1506 | ) |
1507 | ||
1508 | (defun vc-backend-logentry-check (file) | |
1509 | (vc-backend-dispatch file | |
8c0aaf40 | 1510 | (if (>= (buffer-size) 512) ;; SCCS |
594722a8 ER |
1511 | (progn |
1512 | (goto-char 512) | |
1513 | (error | |
590cc449 | 1514 | "Log must be less than 512 characters; point is now at pos 512"))) |
594722a8 ER |
1515 | nil) |
1516 | ) | |
1517 | ||
1518 | (defun vc-backend-checkin (file &optional rev comment) | |
1519 | ;; Register changes to FILE as level REV with explanatory COMMENT. | |
1520 | ;; Automatically retrieves a read-only version of the file with | |
1521 | ;; keywords expanded if vc-keep-workfiles is non-nil, otherwise | |
1522 | ;; it deletes the workfile. | |
1523 | (message "Checking in %s..." file) | |
2ea8ce47 RM |
1524 | (save-excursion |
1525 | ;; Change buffers to get local value of vc-checkin-switches. | |
1526 | (set-buffer (or (get-file-buffer file) (current-buffer))) | |
1527 | (vc-backend-dispatch file | |
1528 | (progn | |
1529 | (apply 'vc-do-command 0 "delta" file | |
1530 | (if rev (concat "-r" rev)) | |
1531 | (concat "-y" comment) | |
1532 | vc-checkin-switches) | |
1533 | (if vc-keep-workfiles | |
1534 | (vc-do-command 0 "get" file)) | |
1535 | ) | |
1536 | (apply 'vc-do-command 0 "ci" file | |
1537 | (concat (if vc-keep-workfiles "-u" "-r") rev) | |
1538 | (concat "-m" comment) | |
1539 | vc-checkin-switches) | |
1540 | )) | |
594722a8 ER |
1541 | (vc-file-setprop file 'vc-locking-user nil) |
1542 | (message "Checking in %s...done" file) | |
1543 | ) | |
1544 | ||
1545 | (defun vc-backend-revert (file) | |
1546 | ;; Revert file to latest checked-in version. | |
1547 | (message "Reverting %s..." file) | |
1548 | (vc-backend-dispatch | |
1549 | file | |
1550 | (progn ;; SCCS | |
1551 | (vc-do-command 0 "unget" file nil) | |
1552 | (vc-do-command 0 "get" file nil)) | |
d76b8d38 | 1553 | (vc-do-command 0 "co" file "-f" "-u")) ;; RCS. This deletes the work file. |
594722a8 ER |
1554 | (vc-file-setprop file 'vc-locking-user nil) |
1555 | (message "Reverting %s...done" file) | |
1556 | ) | |
1557 | ||
1558 | (defun vc-backend-steal (file &optional rev) | |
1559 | ;; Steal the lock on the current workfile. Needs RCS 5.6.2 or later for -M. | |
1560 | (message "Stealing lock on %s..." file) | |
af1b8606 | 1561 | (vc-backend-dispatch file |
d76b8d38 PE |
1562 | (progn |
1563 | (vc-do-command 0 "unget" file "-n" (if rev (concat "-r" rev))) | |
1564 | (vc-do-command 0 "get" file "-g" (if rev (concat "-r" rev))) | |
1565 | ) | |
fd6217ac | 1566 | (vc-do-command 0 "rcs" file "-M" (concat "-u" rev) (concat "-l" rev))) |
594722a8 ER |
1567 | (vc-file-setprop file 'vc-locking-user (user-login-name)) |
1568 | (message "Stealing lock on %s...done" file) | |
1569 | ) | |
1570 | ||
1571 | (defun vc-backend-uncheck (file target) | |
1572 | ;; Undo the latest checkin. Note: this code will have to get a lot | |
1573 | ;; smarter when we support multiple branches. | |
1574 | (message "Removing last change from %s..." file) | |
1575 | (vc-backend-dispatch file | |
1576 | (vc-do-command 0 "rmdel" file (concat "-r" target)) | |
1577 | (vc-do-command 0 "rcs" file (concat "-o" target)) | |
1578 | ) | |
1579 | (message "Removing last change from %s...done" file) | |
1580 | ) | |
1581 | ||
1582 | (defun vc-backend-print-log (file) | |
1583 | ;; Print change log associated with FILE to buffer *vc*. | |
1584 | (vc-do-command 0 | |
1585 | (vc-backend-dispatch file "prs" "rlog") | |
1586 | file) | |
1587 | ) | |
1588 | ||
1589 | (defun vc-backend-assign-name (file name) | |
1590 | ;; Assign to a FILE's latest version a given NAME. | |
1591 | (vc-backend-dispatch file | |
1592 | (vc-add-triple name file (vc-latest-version file)) ;; SCCS | |
1593 | (vc-do-command 0 "rcs" file (concat "-n" name ":")) ;; RCS | |
3234e2a3 | 1594 | ) |
3234e2a3 | 1595 | ) |
594722a8 ER |
1596 | |
1597 | (defun vc-backend-diff (file oldvers &optional newvers) | |
1598 | ;; Get a difference report between two versions | |
7b4f934d ER |
1599 | (if (eq (vc-backend-deduce file) 'SCCS) |
1600 | (setq oldvers (vc-lookup-triple file oldvers)) | |
1601 | (setq newvers (vc-lookup-triple file newvers))) | |
594722a8 ER |
1602 | (apply 'vc-do-command 1 |
1603 | (or (vc-backend-dispatch file "vcdiff" "rcsdiff") | |
7ef84cf9 | 1604 | (vc-registration-error file)) |
594722a8 | 1605 | file |
d64ca902 | 1606 | "-q" |
594722a8 ER |
1607 | (and oldvers (concat "-r" oldvers)) |
1608 | (and newvers (concat "-r" newvers)) | |
4c2c1de1 RS |
1609 | (if (listp diff-switches) |
1610 | diff-switches | |
1611 | (list diff-switches)) | |
594722a8 ER |
1612 | )) |
1613 | ||
1614 | (defun vc-check-headers () | |
1615 | "Check if the current file has any headers in it." | |
1616 | (interactive) | |
1617 | (save-excursion | |
1618 | (goto-char (point-min)) | |
1619 | (vc-backend-dispatch buffer-file-name | |
1620 | (re-search-forward "%[MIRLBSDHTEGUYFPQCZWA]%" nil t) ;; SCCS | |
1621 | (re-search-forward "\\$[A-Za-z\300-\326\330-\366\370-\377]+\\(: [\t -#%-\176\240-\377]*\\)?\\$" nil t) ;; RCS | |
1622 | ) | |
1623 | )) | |
1624 | ||
1625 | ;; Back-end-dependent stuff ends here. | |
1626 | ||
1627 | ;; Set up key bindings for use while editing log messages | |
1628 | ||
1629 | (defun vc-log-mode () | |
1630 | "Minor mode for driving version-control tools. | |
1631 | These bindings are added to the global keymap when you enter this mode: | |
1632 | \\[vc-next-action] perform next logical version-control operation on current file | |
1633 | \\[vc-register] register current file | |
1634 | \\[vc-toggle-read-only] like next-action, but won't register files | |
1635 | \\[vc-insert-headers] insert version-control headers in current file | |
1636 | \\[vc-print-log] display change history of current file | |
1637 | \\[vc-revert-buffer] revert buffer to latest version | |
1638 | \\[vc-cancel-version] undo latest checkin | |
1639 | \\[vc-diff] show diffs between file versions | |
f1818994 | 1640 | \\[vc-version-other-window] visit old version in another window |
594722a8 ER |
1641 | \\[vc-directory] show all files locked by any user in or below . |
1642 | \\[vc-update-change-log] add change log entry from recent checkins | |
1643 | ||
1644 | While you are entering a change log message for a version, the following | |
1645 | additional bindings will be in effect. | |
1646 | ||
1647 | \\[vc-finish-logentry] proceed with check in, ending log message entry | |
1648 | ||
1649 | Whenever you do a checkin, your log comment is added to a ring of | |
1650 | saved comments. These can be recalled as follows: | |
1651 | ||
1652 | \\[vc-next-comment] replace region with next message in comment ring | |
1653 | \\[vc-previous-comment] replace region with previous message in comment ring | |
8c0aaf40 ER |
1654 | \\[vc-comment-search-reverse] search backward for regexp in the comment ring |
1655 | \\[vc-comment-search-forward] search backward for regexp in the comment ring | |
594722a8 ER |
1656 | |
1657 | Entry to the change-log submode calls the value of text-mode-hook, then | |
1658 | the value of vc-log-mode-hook. | |
1659 | ||
1660 | Global user options: | |
1661 | vc-initial-comment If non-nil, require user to enter a change | |
1662 | comment upon first checkin of the file. | |
1663 | ||
1664 | vc-keep-workfiles Non-nil value prevents workfiles from being | |
1665 | deleted when changes are checked in | |
1666 | ||
1667 | vc-suppress-confirm Suppresses some confirmation prompts, | |
1668 | notably for reversions. | |
1669 | ||
7b4f934d | 1670 | vc-header-alist Which keywords to insert when adding headers |
594722a8 ER |
1671 | with \\[vc-insert-headers]. Defaults to |
1672 | '(\"\%\W\%\") under SCCS, '(\"\$Id\$\") under RCS. | |
1673 | ||
1674 | vc-static-header-alist By default, version headers inserted in C files | |
1675 | get stuffed in a static string area so that | |
1676 | ident(RCS) or what(SCCS) can see them in the | |
1677 | compiled object code. You can override this | |
1678 | by setting this variable to nil, or change | |
1679 | the header template by changing it. | |
1680 | ||
1681 | vc-command-messages if non-nil, display run messages from the | |
1682 | actual version-control utilities (this is | |
1683 | intended primarily for people hacking vc | |
1684 | itself). | |
1685 | " | |
1686 | (interactive) | |
1687 | (set-syntax-table text-mode-syntax-table) | |
1688 | (use-local-map vc-log-entry-mode) | |
1689 | (setq local-abbrev-table text-mode-abbrev-table) | |
1690 | (setq major-mode 'vc-log-mode) | |
1691 | (setq mode-name "VC-Log") | |
1692 | (make-local-variable 'vc-log-file) | |
1693 | (make-local-variable 'vc-log-version) | |
8c0aaf40 | 1694 | (make-local-variable 'vc-comment-ring-index) |
594722a8 ER |
1695 | (set-buffer-modified-p nil) |
1696 | (setq buffer-file-name nil) | |
1697 | (run-hooks 'text-mode-hook 'vc-log-mode-hook) | |
1698 | ) | |
1699 | ||
1700 | ;; Initialization code, to be done just once at load-time | |
1701 | (if vc-log-entry-mode | |
1702 | nil | |
1703 | (setq vc-log-entry-mode (make-sparse-keymap)) | |
1704 | (define-key vc-log-entry-mode "\M-n" 'vc-next-comment) | |
1705 | (define-key vc-log-entry-mode "\M-p" 'vc-previous-comment) | |
8c0aaf40 | 1706 | (define-key vc-log-entry-mode "\M-r" 'vc-comment-search-reverse) |
594722a8 ER |
1707 | (define-key vc-log-entry-mode "\M-s" 'vc-comment-search-forward) |
1708 | (define-key vc-log-entry-mode "\C-c\C-c" 'vc-finish-logentry) | |
1709 | ) | |
1710 | ||
1711 | ;;; These things should probably be generally available | |
1712 | ||
02da6253 | 1713 | (defun vc-file-tree-walk (func &rest args) |
34291cd2 RS |
1714 | "Walk recursively through default directory. |
1715 | Invoke FUNC f ARGS on each non-directory file f underneath it." | |
02da6253 PE |
1716 | (vc-file-tree-walk-internal default-directory func args) |
1717 | (message "Traversing directory %s...done" default-directory)) | |
1718 | ||
1719 | (defun vc-file-tree-walk-internal (file func args) | |
1720 | (if (not (file-directory-p file)) | |
1721 | (apply func file args) | |
1722 | (message "Traversing directory %s..." file) | |
1723 | (let ((dir (file-name-as-directory file))) | |
1724 | (mapcar | |
1725 | (function | |
1726 | (lambda (f) (or | |
1727 | (string-equal f ".") | |
1728 | (string-equal f "..") | |
1729 | (let ((dirf (concat dir f))) | |
1730 | (or | |
1731 | (file-symlink-p dirf) ;; Avoid possible loops | |
1732 | (vc-file-tree-walk-internal dirf func args)))))) | |
1733 | (directory-files dir))))) | |
594722a8 ER |
1734 | |
1735 | (provide 'vc) | |
1736 | ||
1737 | ;;; DEVELOPER'S NOTES ON CONCURRENCY PROBLEMS IN THIS CODE | |
1738 | ;;; | |
1739 | ;;; These may be useful to anyone who has to debug or extend the package. | |
1740 | ;;; | |
1741 | ;;; A fundamental problem in VC is that there are time windows between | |
1742 | ;;; vc-next-action's computations of the file's version-control state and | |
1743 | ;;; the actions that change it. This is a window open to lossage in a | |
1744 | ;;; multi-user environment; someone else could nip in and change the state | |
1745 | ;;; of the master during it. | |
1746 | ;;; | |
1747 | ;;; The performance problem is that rlog/prs calls are very expensive; we want | |
1748 | ;;; to avoid them as much as possible. | |
1749 | ;;; | |
1750 | ;;; ANALYSIS: | |
1751 | ;;; | |
1752 | ;;; The performance problem, it turns out, simplifies in practice to the | |
1753 | ;;; problem of making vc-locking-user fast. The two other functions that call | |
1754 | ;;; prs/rlog will not be so commonly used that the slowdown is a problem; one | |
1755 | ;;; makes snapshots, the other deletes the calling user's last change in the | |
1756 | ;;; master. | |
1757 | ;;; | |
1758 | ;;; The race condition implies that we have to either (a) lock the master | |
1759 | ;;; during the entire execution of vc-next-action, or (b) detect and | |
1760 | ;;; recover from errors resulting from dispatch on an out-of-date state. | |
1761 | ;;; | |
1762 | ;;; Alternative (a) appears to be unfeasible. The problem is that we can't | |
1763 | ;;; guarantee that the lock will ever be removed. Suppose a user starts a | |
1764 | ;;; checkin, the change message buffer pops up, and the user, having wandered | |
1765 | ;;; off to do something else, simply forgets about it? | |
1766 | ;;; | |
1767 | ;;; Alternative (b), on the other hand, works well with a cheap way to speed up | |
1768 | ;;; vc-locking-user. Usually, if a file is registered, we can read its locked/ | |
1769 | ;;; unlocked state and its current owner from its permissions. | |
1770 | ;;; | |
1771 | ;;; This shortcut will fail if someone has manually changed the workfile's | |
1772 | ;;; permissions; also if developers are munging the workfile in several | |
1773 | ;;; directories, with symlinks to a master (in this latter case, the | |
1774 | ;;; permissions shortcut will fail to detect a lock asserted from another | |
1775 | ;;; directory). | |
1776 | ;;; | |
1777 | ;;; Note that these cases correspond exactly to the errors which could happen | |
1778 | ;;; because of a competing checkin/checkout race in between two instances of | |
1779 | ;;; vc-next-action. | |
1780 | ;;; | |
1781 | ;;; For VC's purposes, a workfile/master pair may have the following states: | |
1782 | ;;; | |
1783 | ;;; A. Unregistered. There is a workfile, there is no master. | |
1784 | ;;; | |
1785 | ;;; B. Registered and not locked by anyone. | |
1786 | ;;; | |
1787 | ;;; C. Locked by calling user and unchanged. | |
1788 | ;;; | |
1789 | ;;; D. Locked by the calling user and changed. | |
1790 | ;;; | |
1791 | ;;; E. Locked by someone other than the calling user. | |
1792 | ;;; | |
1793 | ;;; This makes for 25 states and 20 error conditions. Here's the matrix: | |
1794 | ;;; | |
1795 | ;;; VC's idea of state | |
1796 | ;;; | | |
1797 | ;;; V Actual state RCS action SCCS action Effect | |
1798 | ;;; A B C D E | |
1799 | ;;; A . 1 2 3 4 ci -u -t- admin -fb -i<file> initial admin | |
1800 | ;;; B 5 . 6 7 8 co -l get -e checkout | |
1801 | ;;; C 9 10 . 11 12 co -u unget; get revert | |
1802 | ;;; D 13 14 15 . 16 ci -u -m<comment> delta -y<comment>; get checkin | |
1803 | ;;; E 17 18 19 20 . rcs -u -M ; rcs -l unget -n ; get -g steal lock | |
1804 | ;;; | |
1805 | ;;; All commands take the master file name as a last argument (not shown). | |
1806 | ;;; | |
1807 | ;;; In the discussion below, a "self-race" is a pathological situation in | |
1808 | ;;; which VC operations are being attempted simultaneously by two or more | |
1809 | ;;; Emacsen running under the same username. | |
1810 | ;;; | |
1811 | ;;; The vc-next-action code has the following windows: | |
1812 | ;;; | |
1813 | ;;; Window P: | |
1814 | ;;; Between the check for existence of a master file and the call to | |
1815 | ;;; admin/checkin in vc-buffer-admin (apparent state A). This window may | |
1816 | ;;; never close if the initial-comment feature is on. | |
1817 | ;;; | |
1818 | ;;; Window Q: | |
1819 | ;;; Between the call to vc-workfile-unchanged-p in and the immediately | |
1820 | ;;; following revert (apparent state C). | |
1821 | ;;; | |
1822 | ;;; Window R: | |
1823 | ;;; Between the call to vc-workfile-unchanged-p in and the following | |
1824 | ;;; checkin (apparent state D). This window may never close. | |
1825 | ;;; | |
1826 | ;;; Window S: | |
1827 | ;;; Between the unlock and the immediately following checkout during a | |
1828 | ;;; revert operation (apparent state C). Included in window Q. | |
1829 | ;;; | |
1830 | ;;; Window T: | |
1831 | ;;; Between vc-locking-user and the following checkout (apparent state B). | |
1832 | ;;; | |
1833 | ;;; Window U: | |
1834 | ;;; Between vc-locking-user and the following revert (apparent state C). | |
1835 | ;;; Includes windows Q and S. | |
1836 | ;;; | |
1837 | ;;; Window V: | |
1838 | ;;; Between vc-locking-user and the following checkin (apparent state | |
1839 | ;;; D). This window may never be closed if the user fails to complete the | |
1840 | ;;; checkin message. Includes window R. | |
1841 | ;;; | |
1842 | ;;; Window W: | |
1843 | ;;; Between vc-locking-user and the following steal-lock (apparent | |
34291cd2 | 1844 | ;;; state E). This window may never close if the user fails to complete |
594722a8 ER |
1845 | ;;; the steal-lock message. Includes window X. |
1846 | ;;; | |
1847 | ;;; Window X: | |
1848 | ;;; Between the unlock and the immediately following re-lock during a | |
1849 | ;;; steal-lock operation (apparent state E). This window may never cloce | |
1850 | ;;; if the user fails to complete the steal-lock message. | |
1851 | ;;; | |
1852 | ;;; Errors: | |
1853 | ;;; | |
1854 | ;;; Apparent state A --- | |
1855 | ;;; | |
1856 | ;;; 1. File looked unregistered but is actually registered and not locked. | |
1857 | ;;; | |
1858 | ;;; Potential cause: someone else's admin during window P, with | |
1859 | ;;; caller's admin happening before their checkout. | |
1860 | ;;; | |
1861 | ;;; RCS: ci will fail with a "no lock set by <user>" message. | |
1862 | ;;; SCCS: admin will fail with error (ad19). | |
1863 | ;;; | |
1864 | ;;; We can let these errors be passed up to the user. | |
1865 | ;;; | |
1866 | ;;; 2. File looked unregistered but is actually locked by caller, unchanged. | |
1867 | ;;; | |
1868 | ;;; Potential cause: self-race during window P. | |
1869 | ;;; | |
1870 | ;;; RCS: will revert the file to the last saved version and unlock it. | |
1871 | ;;; SCCS: will fail with error (ad19). | |
1872 | ;;; | |
1873 | ;;; Either of these consequences is acceptable. | |
1874 | ;;; | |
1875 | ;;; 3. File looked unregistered but is actually locked by caller, changed. | |
1876 | ;;; | |
1877 | ;;; Potential cause: self-race during window P. | |
1878 | ;;; | |
1879 | ;;; RCS: will register the caller's workfile as a delta with a | |
1880 | ;;; null change comment (the -t- switch will be ignored). | |
1881 | ;;; SCCS: will fail with error (ad19). | |
1882 | ;;; | |
1883 | ;;; 4. File looked unregistered but is locked by someone else. | |
1884 | ;;; | |
1885 | ;;; Potential cause: someone else's admin during window P, with | |
1886 | ;;; caller's admin happening *after* their checkout. | |
1887 | ;;; | |
1888 | ;;; RCS: will fail with a "no lock set by <user>" message. | |
1889 | ;;; SCCS: will fail with error (ad19). | |
1890 | ;;; | |
1891 | ;;; We can let these errors be passed up to the user. | |
1892 | ;;; | |
1893 | ;;; Apparent state B --- | |
1894 | ;;; | |
1895 | ;;; 5. File looked registered and not locked, but is actually unregistered. | |
1896 | ;;; | |
1897 | ;;; Potential cause: master file got nuked during window P. | |
1898 | ;;; | |
1899 | ;;; RCS: will fail with "RCS/<file>: No such file or directory" | |
1900 | ;;; SCCS: will fail with error ut4. | |
1901 | ;;; | |
1902 | ;;; We can let these errors be passed up to the user. | |
1903 | ;;; | |
1904 | ;;; 6. File looked registered and not locked, but is actually locked by the | |
1905 | ;;; calling user and unchanged. | |
1906 | ;;; | |
1907 | ;;; Potential cause: self-race during window T. | |
1908 | ;;; | |
1909 | ;;; RCS: in the same directory as the previous workfile, co -l will fail | |
1910 | ;;; with "co error: writable foo exists; checkout aborted". In any other | |
1911 | ;;; directory, checkout will succeed. | |
1912 | ;;; SCCS: will fail with ge17. | |
1913 | ;;; | |
1914 | ;;; Either of these consequences is acceptable. | |
1915 | ;;; | |
1916 | ;;; 7. File looked registered and not locked, but is actually locked by the | |
1917 | ;;; calling user and changed. | |
1918 | ;;; | |
1919 | ;;; As case 6. | |
1920 | ;;; | |
1921 | ;;; 8. File looked registered and not locked, but is actually locked by another | |
1922 | ;;; user. | |
1923 | ;;; | |
1924 | ;;; Potential cause: someone else checks it out during window T. | |
1925 | ;;; | |
1926 | ;;; RCS: co error: revision 1.3 already locked by <user> | |
1927 | ;;; SCCS: fails with ge4 (in directory) or ut7 (outside it). | |
1928 | ;;; | |
1929 | ;;; We can let these errors be passed up to the user. | |
1930 | ;;; | |
1931 | ;;; Apparent state C --- | |
1932 | ;;; | |
1933 | ;;; 9. File looks locked by calling user and unchanged, but is unregistered. | |
1934 | ;;; | |
1935 | ;;; As case 5. | |
1936 | ;;; | |
1937 | ;;; 10. File looks locked by calling user and unchanged, but is actually not | |
1938 | ;;; locked. | |
1939 | ;;; | |
1940 | ;;; Potential cause: a self-race in window U, or by the revert's | |
1941 | ;;; landing during window X of some other user's steal-lock or window S | |
1942 | ;;; of another user's revert. | |
1943 | ;;; | |
1944 | ;;; RCS: succeeds, refreshing the file from the identical version in | |
1945 | ;;; the master. | |
1946 | ;;; SCCS: fails with error ut4 (p file nonexistent). | |
1947 | ;;; | |
1948 | ;;; Either of these consequences is acceptable. | |
1949 | ;;; | |
1950 | ;;; 11. File is locked by calling user. It looks unchanged, but is actually | |
1951 | ;;; changed. | |
1952 | ;;; | |
1953 | ;;; Potential cause: the file would have to be touched by a self-race | |
1954 | ;;; during window Q. | |
1955 | ;;; | |
1956 | ;;; The revert will succeed, removing whatever changes came with | |
1957 | ;;; the touch. It is theoretically possible that work could be lost. | |
1958 | ;;; | |
1959 | ;;; 12. File looks like it's locked by the calling user and unchanged, but | |
1960 | ;;; it's actually locked by someone else. | |
1961 | ;;; | |
1962 | ;;; Potential cause: a steal-lock in window V. | |
1963 | ;;; | |
1964 | ;;; RCS: co error: revision <rev> locked by <user>; use co -r or rcs -u | |
1965 | ;;; SCCS: fails with error un2 | |
1966 | ;;; | |
1967 | ;;; We can pass these errors up to the user. | |
1968 | ;;; | |
1969 | ;;; Apparent state D --- | |
1970 | ;;; | |
1971 | ;;; 13. File looks like it's locked by the calling user and changed, but it's | |
1972 | ;;; actually unregistered. | |
1973 | ;;; | |
1974 | ;;; Potential cause: master file got nuked during window P. | |
1975 | ;;; | |
1976 | ;;; RCS: Checks in the user's version as an initial delta. | |
1977 | ;;; SCCS: will fail with error ut4. | |
1978 | ;;; | |
1979 | ;;; This case is kind of nasty. It means VC may fail to detect the | |
1980 | ;;; loss of previous version information. | |
1981 | ;;; | |
1982 | ;;; 14. File looks like it's locked by the calling user and changed, but it's | |
1983 | ;;; actually unlocked. | |
1984 | ;;; | |
1985 | ;;; Potential cause: self-race in window V, or the checkin happening | |
1986 | ;;; during the window X of someone else's steal-lock or window S of | |
1987 | ;;; someone else's revert. | |
1988 | ;;; | |
1989 | ;;; RCS: ci will fail with "no lock set by <user>". | |
1990 | ;;; SCCS: delta will fail with error ut4. | |
1991 | ;;; | |
1992 | ;;; 15. File looks like it's locked by the calling user and changed, but it's | |
1993 | ;;; actually locked by the calling user and unchanged. | |
1994 | ;;; | |
1995 | ;;; Potential cause: another self-race --- a whole checkin/checkout | |
1996 | ;;; sequence by the calling user would have to land in window R. | |
1997 | ;;; | |
1998 | ;;; SCCS: checks in a redundant delta and leaves the file unlocked as usual. | |
1999 | ;;; RCS: reverts to the file state as of the second user's checkin, leaving | |
2000 | ;;; the file unlocked. | |
2001 | ;;; | |
2002 | ;;; It is theoretically possible that work could be lost under RCS. | |
2003 | ;;; | |
2004 | ;;; 16. File looks like it's locked by the calling user and changed, but it's | |
2005 | ;;; actually locked by a different user. | |
2006 | ;;; | |
2007 | ;;; RCS: ci error: no lock set by <user> | |
2008 | ;;; SCCS: unget will fail with error un2 | |
2009 | ;;; | |
2010 | ;;; We can pass these errors up to the user. | |
2011 | ;;; | |
2012 | ;;; Apparent state E --- | |
2013 | ;;; | |
2014 | ;;; 17. File looks like it's locked by some other user, but it's actually | |
2015 | ;;; unregistered. | |
2016 | ;;; | |
2017 | ;;; As case 13. | |
2018 | ;;; | |
2019 | ;;; 18. File looks like it's locked by some other user, but it's actually | |
2020 | ;;; unlocked. | |
2021 | ;;; | |
2022 | ;;; Potential cause: someone released a lock during window W. | |
2023 | ;;; | |
2024 | ;;; RCS: The calling user will get the lock on the file. | |
2025 | ;;; SCCS: unget -n will fail with cm4. | |
2026 | ;;; | |
2027 | ;;; Either of these consequences will be OK. | |
2028 | ;;; | |
2029 | ;;; 19. File looks like it's locked by some other user, but it's actually | |
2030 | ;;; locked by the calling user and unchanged. | |
2031 | ;;; | |
2032 | ;;; Potential cause: the other user relinquishing a lock followed by | |
2033 | ;;; a self-race, both in window W. | |
2034 | ;;; | |
2035 | ;;; Under both RCS and SCCS, both unlock and lock will succeed, making | |
2036 | ;;; the sequence a no-op. | |
2037 | ;;; | |
2038 | ;;; 20. File looks like it's locked by some other user, but it's actually | |
2039 | ;;; locked by the calling user and changed. | |
2040 | ;;; | |
2041 | ;;; As case 19. | |
2042 | ;;; | |
2043 | ;;; PROBLEM CASES: | |
2044 | ;;; | |
2045 | ;;; In order of decreasing severity: | |
2046 | ;;; | |
2047 | ;;; Cases 11 and 15 under RCS are the only one that potentially lose work. | |
2048 | ;;; They would require a self-race for this to happen. | |
2049 | ;;; | |
2050 | ;;; Case 13 in RCS loses information about previous deltas, retaining | |
2051 | ;;; only the information in the current workfile. This can only happen | |
2052 | ;;; if the master file gets nuked in window P. | |
2053 | ;;; | |
2054 | ;;; Case 3 in RCS and case 15 under SCCS insert a redundant delta with | |
2055 | ;;; no change comment in the master. This would require a self-race in | |
2056 | ;;; window P or R respectively. | |
2057 | ;;; | |
2058 | ;;; Cases 2, 10, 19 and 20 do extra work, but make no changes. | |
2059 | ;;; | |
2060 | ;;; Unfortunately, it appears to me that no recovery is possible in these | |
2061 | ;;; cases. They don't yield error messages, so there's no way to tell that | |
2062 | ;;; a race condition has occurred. | |
2063 | ;;; | |
2064 | ;;; All other cases don't change either the workfile or the master, and | |
2065 | ;;; trigger command errors which the user will see. | |
2066 | ;;; | |
2067 | ;;; Thus, there is no explicit recovery code. | |
2068 | ||
2069 | ;;; vc.el ends here |