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