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