1 ;;; vc-mcvs.el --- VC backend for the Meta-CVS version-control system
3 ;; Copyright (C) 2003, 2004, 2005, 2006 Free Software Foundation, Inc.
5 ;; Author: FSF (see vc.el for full credits)
6 ;; Maintainer: Stefan Monnier <monnier@gnu.org>
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
27 ;; The home page of the Meta-CVS version control system is at
29 ;; http://users.footprints.net/~kaz/mcvs.html
31 ;; This is derived from vc-cvs.el as follows:
32 ;; - cp vc-cvs.el vc-mcvs.el
33 ;; - Replace CVS/ with MCVS/CVS/
34 ;; - Replace 'CVS with 'MCVS
35 ;; - Replace -cvs- with -mcvs-
36 ;; - Replace most of the rest of CVS to Meta-CVS
38 ;; Then of course started the hacking. Only a small part of the code
39 ;; has been touched and not much more than that was tested, so if
40 ;; you bump into a bug, don't be surprised: just report it to me.
42 ;; What has been partly tested:
43 ;; - C-x v v to start editing a file that was checked out with CVSREAD on.
44 ;; - C-x v v to commit a file
49 ;; - M-x vc-rename-file RET
53 ;; - Retrieving snapshots doesn't filter `cvs update' output and thus
54 ;; parses bogus filenames. Don't know if it harms.
58 (eval-when-compile (require 'vc))
62 ;;; Customization options
65 (defcustom vc-mcvs-global-switches nil
66 "*Global switches to pass to any Meta-CVS command."
67 :type '(choice (const :tag "None" nil)
68 (string :tag "Argument String")
69 (repeat :tag "Argument List"
75 (defcustom vc-mcvs-register-switches nil
76 "*Extra switches for registering a file into Meta-CVS.
77 A string or list of strings passed to the checkin program by
79 :type '(choice (const :tag "None" nil)
80 (string :tag "Argument String")
81 (repeat :tag "Argument List"
87 (defcustom vc-mcvs-diff-switches nil
88 "*A string or list of strings specifying extra switches for cvs diff under VC."
89 :type '(choice (const :tag "None" nil)
90 (string :tag "Argument String")
91 (repeat :tag "Argument List"
97 (defcustom vc-mcvs-header (or (cdr (assoc 'MCVS vc-header-alist))
99 "*Header keywords to be inserted by `vc-insert-headers'."
101 :type '(repeat string)
104 (defcustom vc-mcvs-use-edit vc-cvs-use-edit
105 "*Non-nil means to use `cvs edit' to \"check out\" a file.
106 This is only meaningful if you don't use the implicit checkout model
107 \(i.e. if you have $CVSREAD set)."
113 ;;; State-querying functions
116 ;;;###autoload (defun vc-mcvs-registered (file)
117 ;;;###autoload (if (vc-find-root file "MCVS/CVS")
118 ;;;###autoload (progn
119 ;;;###autoload (load "vc-mcvs")
120 ;;;###autoload (vc-mcvs-registered file))))
122 (defun vc-mcvs-root (file)
123 "Return the root directory of a Meta-CVS project, if any."
124 (or (vc-file-getprop file 'mcvs-root)
125 (vc-file-setprop file 'mcvs-root (vc-find-root file "MCVS/CVS"))))
127 (defun vc-mcvs-read (file)
128 (if (file-readable-p file)
130 (insert-file-contents file)
131 (goto-char (point-min))
132 (read (current-buffer)))))
134 (defun vc-mcvs-map-file (dir file)
135 (let ((map (vc-mcvs-read (expand-file-name "MCVS/MAP" dir)))
137 (dolist (x map inode)
138 (if (equal (nth 2 x) file) (setq inode (nth 1 x))))))
140 (defun vc-mcvs-registered (file)
141 (let (root inode cvsfile)
142 (when (and (setq root (vc-mcvs-root file))
143 (setq inode (vc-mcvs-map-file
144 root (file-relative-name file root))))
145 (vc-file-setprop file 'mcvs-inode inode)
146 ;; Avoid calling `mcvs diff' in vc-workfile-unchanged-p.
147 (vc-file-setprop file 'vc-checkout-time
148 (if (vc-cvs-registered
149 (setq cvsfile (expand-file-name inode root)))
150 (vc-file-getprop cvsfile 'vc-checkout-time)
151 ;; The file might not be registered yet because
156 (defun vc-mcvs-state (file)
157 ;; This would assume the Meta-CVS sandbox is synchronized.
158 ;; (vc-mcvs-cvs state file))
159 "Meta-CVS-specific version of `vc-state'."
160 (if (vc-stay-local-p file)
161 (let ((state (vc-file-getprop file 'vc-state)))
162 ;; If we should stay local, use the heuristic but only if
163 ;; we don't have a more precise state already available.
164 (if (memq state '(up-to-date edited))
165 (vc-mcvs-state-heuristic file)
168 (setq default-directory (vc-mcvs-root file))
169 (vc-mcvs-command t 0 file "status")
170 (vc-cvs-parse-status t))))
173 (defalias 'vc-mcvs-state-heuristic 'vc-cvs-state-heuristic)
175 (defun vc-mcvs-dir-state (dir)
176 "Find the Meta-CVS state of all files in DIR."
177 ;; if DIR is not under Meta-CVS control, don't do anything.
178 (when (file-readable-p (expand-file-name "MCVS/CVS/Entries" dir))
179 (if (vc-stay-local-p dir)
180 (vc-mcvs-dir-state-heuristic dir)
181 (let ((default-directory dir))
182 ;; Don't specify DIR in this command, the default-directory is
183 ;; enough. Otherwise it might fail with remote repositories.
185 (setq default-directory (vc-mcvs-root dir))
186 (vc-mcvs-command t 0 nil "status" "-l")
187 (goto-char (point-min))
188 (while (re-search-forward "^=+\n\\([^=\n].*\n\\|\n\\)+" nil t)
189 (narrow-to-region (match-beginning 0) (match-end 0))
190 (vc-cvs-parse-status)
191 (goto-char (point-max))
194 (defun vc-mcvs-workfile-version (file)
195 (vc-cvs-workfile-version
196 (expand-file-name (vc-file-getprop file 'mcvs-inode)
197 (vc-file-getprop file 'mcvs-root))))
199 (defalias 'vc-mcvs-checkout-model 'vc-cvs-checkout-model)
202 ;;; State-changing functions
205 (defun vc-mcvs-register (file &optional rev comment)
206 "Register FILE into the Meta-CVS version-control system.
207 COMMENT can be used to provide an initial description of FILE.
209 `vc-register-switches' and `vc-mcvs-register-switches' are passed to
210 the Meta-CVS command (in that order)."
211 (let* ((filename (file-name-nondirectory file))
212 (extpos (string-match "\\." filename))
213 (ext (if extpos (substring filename (1+ extpos))))
214 (root (vc-mcvs-root file))
215 (types-file (expand-file-name "MCVS/TYPES" root))
216 (map-file (expand-file-name "MCVS/MAP" root))
217 (types (vc-mcvs-read types-file)))
218 ;; Make sure meta files like MCVS/MAP are not read-only (happens with
219 ;; CVSREAD) since Meta-CVS doesn't pay attention to it at all and goes
221 (unless (file-writable-p map-file)
222 (vc-checkout map-file t))
223 (unless (or (file-writable-p types-file) (not (file-exists-p types-file)))
224 (vc-checkout types-file t))
225 ;; Make sure the `mcvs add' will not fire up the CVSEDITOR
226 ;; to add a rule for the given file's extension.
227 (when (and ext (not (assoc ext types)))
228 (let ((type (completing-read "Type to use (default): "
229 '("default" "name-only" "keep-old"
230 "binary" "value-only")
231 nil t nil nil "default")))
232 (push (list ext (make-symbol (upcase (concat ":" type)))) types)
233 (setq types (sort types (lambda (x y) (string< (car x) (car y)))))
234 (with-current-buffer (find-file-noselect types-file)
236 (pp types (current-buffer))
238 (unless (get-buffer-window (current-buffer) t)
239 (kill-buffer (current-buffer)))))))
241 (prog1 (apply 'vc-mcvs-command nil 0 file
243 (and comment (string-match "[^\t\n ]" comment)
244 (concat "-m" comment))
245 (vc-switches 'MCVS 'register))
246 ;; I'm not sure exactly why, but if we don't setup the inode and root
247 ;; prop of the file, things break later on in vc-mode-line that
248 ;; ends up calling vc-mcvs-workfile-version.
249 ;; We also need to set vc-checkout-time so that vc-workfile-unchanged-p
250 ;; doesn't try to call `mcvs diff' on the file.
251 (vc-mcvs-registered file)))
253 (defalias 'vc-mcvs-responsible-p 'vc-mcvs-root
254 "Return non-nil if CVS thinks it is responsible for FILE.")
256 (defalias 'vc-cvs-could-register 'vc-cvs-responsible-p
257 "Return non-nil if FILE could be registered in Meta-CVS.
258 This is only possible if Meta-CVS is responsible for FILE's directory.")
260 (defun vc-mcvs-checkin (file rev comment)
261 "Meta-CVS-specific version of `vc-backend-checkin'."
262 (unless (or (not rev) (vc-mcvs-valid-version-number-p rev))
263 (if (not (vc-mcvs-valid-symbolic-tag-name-p rev))
264 (error "%s is not a valid symbolic tag name" rev)
265 ;; If the input revision is a valid symbolic tag name, we create it
266 ;; as a branch, commit and switch to it.
267 ;; This file-specific form of branching is deprecated.
268 ;; We can't use `mcvs branch' and `mcvs switch' because they cannot
269 ;; be applied just to this one file.
270 (apply 'vc-mcvs-command nil 0 file "tag" "-b" (list rev))
271 (apply 'vc-mcvs-command nil 0 file "update" "-r" (list rev))
272 (vc-file-setprop file 'vc-mcvs-sticky-tag rev)
274 ;; This commit might cvs-commit several files (e.g. MAP and TYPES)
275 ;; so using numbered revs here is dangerous and somewhat meaningless.
276 (when rev (error "Cannot commit to a specific revision number"))
277 (let ((status (apply 'vc-mcvs-command nil 1 file
279 (vc-switches 'MCVS 'checkin))))
281 (goto-char (point-min))
282 (when (not (zerop status))
283 ;; Check checkin problem.
285 ((re-search-forward "Up-to-date check failed" nil t)
286 (vc-file-setprop file 'vc-state 'needs-merge)
287 (error (substitute-command-keys
288 (concat "Up-to-date check failed: "
289 "type \\[vc-next-action] to merge in changes"))))
291 (pop-to-buffer (current-buffer))
292 (goto-char (point-min))
293 (shrink-window-if-larger-than-buffer)
294 (error "Check-in failed"))))
295 ;; Update file properties
297 file 'vc-workfile-version
298 (vc-parse-buffer "^\\(new\\|initial\\) revision: \\([0-9.]+\\)" 2))
299 ;; Forget the checkout model of the file, because we might have
300 ;; guessed wrong when we found the file. After commit, we can
301 ;; tell it from the permissions of the file (see
302 ;; vc-mcvs-checkout-model).
303 (vc-file-setprop file 'vc-checkout-model nil)
305 ;; if this was an explicit check-in (does not include creation of
306 ;; a branch), remove the sticky tag.
307 (if (and rev (not (vc-mcvs-valid-symbolic-tag-name-p rev)))
308 (vc-mcvs-command nil 0 file "update" "-A"))))
310 (defun vc-mcvs-find-version (file rev buffer)
311 (apply 'vc-mcvs-command
313 "-Q" ; suppress diagnostic output
315 (and rev (not (string= rev ""))
318 (vc-switches 'MCVS 'checkout)))
320 (defun vc-mcvs-checkout (file &optional editable rev)
321 (message "Checking out %s..." file)
322 (with-current-buffer (or (get-file-buffer file) (current-buffer))
323 (vc-call update file editable rev (vc-switches 'MCVS 'checkout)))
325 (message "Checking out %s...done" file))
327 (defun vc-mcvs-update (file editable rev switches)
328 (if (and (file-exists-p file) (not rev))
329 ;; If no revision was specified, just make the file writable
330 ;; if necessary (using `cvs-edit' if requested).
331 (and editable (not (eq (vc-mcvs-checkout-model file) 'implicit))
333 (vc-mcvs-command nil 0 file "edit")
334 (set-file-modes file (logior (file-modes file) 128))
335 (if (equal file buffer-file-name) (toggle-read-only -1))))
336 ;; Check out a particular version (or recreate the file).
337 (vc-file-setprop file 'vc-workfile-version nil)
338 (apply 'vc-mcvs-command nil 0 file
341 ;; default for verbose checkout: clear the sticky tag so
342 ;; that the actual update will get the head of the trunk
343 (if (or (not rev) (string= rev ""))
348 (defun vc-mcvs-rename-file (old new)
349 (vc-mcvs-command nil 0 new "move" (file-relative-name old)))
351 (defun vc-mcvs-revert (file &optional contents-done)
352 "Revert FILE to the version it was based on."
353 (vc-default-revert 'MCVS file contents-done)
354 (unless (eq (vc-checkout-model file) 'implicit)
356 (vc-mcvs-command nil 0 file "unedit")
357 ;; Make the file read-only by switching off all w-bits
358 (set-file-modes file (logand (file-modes file) 3950)))))
360 (defun vc-mcvs-merge (file first-version &optional second-version)
361 "Merge changes into current working copy of FILE.
362 The changes are between FIRST-VERSION and SECOND-VERSION."
363 (vc-mcvs-command nil 0 file
365 (concat "-j" first-version)
366 (concat "-j" second-version))
367 (vc-file-setprop file 'vc-state 'edited)
368 (with-current-buffer (get-buffer "*vc*")
369 (goto-char (point-min))
370 (if (re-search-forward "conflicts during merge" nil t)
372 0))) ; signal success
374 (defun vc-mcvs-merge-news (file)
375 "Merge in any new changes made to FILE."
376 (message "Merging changes into %s..." file)
377 ;; (vc-file-setprop file 'vc-workfile-version nil)
378 (vc-file-setprop file 'vc-checkout-time 0)
379 (vc-mcvs-command nil 0 file "update")
380 ;; Analyze the merge result reported by Meta-CVS, and set
381 ;; file properties accordingly.
382 (with-current-buffer (get-buffer "*vc*")
383 (goto-char (point-min))
384 ;; get new workfile version
385 (if (re-search-forward
386 "^Merging differences between [0-9.]* and \\([0-9.]*\\) into" nil t)
387 (vc-file-setprop file 'vc-workfile-version (match-string 1))
388 (vc-file-setprop file 'vc-workfile-version nil))
391 (if (eq (buffer-size) 0)
392 0 ;; there were no news; indicate success
393 (if (re-search-forward
394 (concat "^\\([CMUP] \\)?"
396 "\\( already contains the differences between \\)?")
399 ;; Merge successful, we are in sync with repository now
400 ((or (match-string 2)
401 (string= (match-string 1) "U ")
402 (string= (match-string 1) "P "))
403 (vc-file-setprop file 'vc-state 'up-to-date)
404 (vc-file-setprop file 'vc-checkout-time
405 (nth 5 (file-attributes file)))
406 0);; indicate success to the caller
407 ;; Merge successful, but our own changes are still in the file
408 ((string= (match-string 1) "M ")
409 (vc-file-setprop file 'vc-state 'edited)
410 0);; indicate success to the caller
411 ;; Conflicts detected!
413 (vc-file-setprop file 'vc-state 'edited)
414 1);; signal the error to the caller
416 (pop-to-buffer "*vc*")
417 (error "Couldn't analyze mcvs update result")))
418 (message "Merging changes into %s...done" file))))
421 ;;; History functions
424 (defun vc-mcvs-print-log (file &optional buffer)
425 "Get change log associated with FILE."
426 (let ((default-directory (vc-mcvs-root file)))
427 ;; Run the command from the root dir so that `mcvs filt' returns
428 ;; valid relative names.
431 (if (and (vc-stay-local-p file) (fboundp 'start-process)) 'async 0)
434 (defun vc-mcvs-diff (file &optional oldvers newvers buffer)
435 "Get a difference report using Meta-CVS between two versions of FILE."
436 (if (string= (vc-workfile-version file) "0")
437 ;; This file is added but not yet committed; there is no master file.
438 (if (or oldvers newvers)
439 (error "No revisions of %s exist" file)
440 ;; We regard this as "changed".
441 ;; Diff it against /dev/null.
442 ;; Note: this is NOT a "mcvs diff".
443 (apply 'vc-do-command (or buffer "*vc-diff*")
445 (append (vc-switches nil 'diff) '("/dev/null")))
446 ;; Even if it's empty, it's locally modified.
448 (let* ((async (and (not vc-disable-async-diff)
449 (vc-stay-local-p file)
450 (fboundp 'start-process)))
451 ;; Run the command from the root dir so that `mcvs filt' returns
452 ;; valid relative names.
453 (default-directory (vc-mcvs-root file))
455 (apply 'vc-mcvs-command (or buffer "*vc-diff*")
458 (and oldvers (concat "-r" oldvers))
459 (and newvers (concat "-r" newvers))
460 (vc-switches 'MCVS 'diff))))
461 (if async 1 status)))) ; async diff, pessimistic assumption.
463 (defun vc-mcvs-diff-tree (dir &optional rev1 rev2)
464 "Diff all files at and below DIR."
465 (with-current-buffer "*vc-diff*"
466 ;; Run the command from the root dir so that `mcvs filt' returns
467 ;; valid relative names.
468 (setq default-directory (vc-mcvs-root dir))
469 ;; cvs diff: use a single call for the entire tree
470 (let ((coding-system-for-read (or coding-system-for-read 'undecided)))
471 (apply 'vc-mcvs-command "*vc-diff*" 1 dir "diff"
472 (and rev1 (concat "-r" rev1))
473 (and rev2 (concat "-r" rev2))
474 (vc-switches 'MCVS 'diff)))))
476 (defun vc-mcvs-annotate-command (file buffer &optional version)
477 "Execute \"mcvs annotate\" on FILE, inserting the contents in BUFFER.
478 Optional arg VERSION is a version to annotate from."
481 (if (and (vc-stay-local-p file) (fboundp 'start-process)) 'async 0)
482 file "annotate" (if version (concat "-r" version)))
483 (with-current-buffer buffer
484 (goto-char (point-min))
485 (re-search-forward "^[0-9]")
486 (delete-region (point-min) (1- (point)))))
488 (defalias 'vc-mcvs-annotate-current-time 'vc-cvs-annotate-current-time)
489 (defalias 'vc-mcvs-annotate-time 'vc-cvs-annotate-time)
495 (defun vc-mcvs-create-snapshot (dir name branchp)
496 "Assign to DIR's current version a given NAME.
497 If BRANCHP is non-nil, the name is created as a branch (and the current
498 workspace is immediately moved to that new branch)."
500 (vc-mcvs-command nil 0 dir "tag" "-c" name)
501 (vc-mcvs-command nil 0 dir "branch" name)
502 (vc-mcvs-command nil 0 dir "switch" name)))
504 (defun vc-mcvs-retrieve-snapshot (dir name update)
505 "Retrieve a snapshot at and below DIR.
506 NAME is the name of the snapshot; if it is empty, do a `cvs update'.
507 If UPDATE is non-nil, then update (resynch) any affected buffers."
508 (with-current-buffer (get-buffer-create "*vc*")
509 (let ((default-directory dir)
512 (if (or (not name) (string= name ""))
513 (vc-mcvs-command t 0 nil "update")
514 (vc-mcvs-command t 0 nil "update" "-r" name)
515 (setq sticky-tag name))
517 (goto-char (point-min))
519 (if (looking-at "\\([CMUP]\\) \\(.*\\)")
520 (let* ((file (expand-file-name (match-string 2) dir))
521 (state (match-string 1))
522 (buffer (find-buffer-visiting file)))
525 ((or (string= state "U")
527 (vc-file-setprop file 'vc-state 'up-to-date)
528 (vc-file-setprop file 'vc-workfile-version nil)
529 (vc-file-setprop file 'vc-checkout-time
530 (nth 5 (file-attributes file))))
531 ((or (string= state "M")
533 (vc-file-setprop file 'vc-state 'edited)
534 (vc-file-setprop file 'vc-workfile-version nil)
535 (vc-file-setprop file 'vc-checkout-time 0)))
536 (vc-file-setprop file 'vc-mcvs-sticky-tag sticky-tag)
537 (vc-resynch-buffer file t t))))
538 (forward-line 1))))))
545 (defalias 'vc-mcvs-make-version-backups-p 'vc-stay-local-p
546 "Return non-nil if version backups should be made for FILE.")
547 (defalias 'vc-mcvs-check-headers 'vc-cvs-check-headers)
551 ;;; Internal functions
554 (defun vc-mcvs-command (buffer okstatus file &rest flags)
555 "A wrapper around `vc-do-command' for use in vc-mcvs.el.
556 The difference to vc-do-command is that this function always invokes `mcvs',
557 and that it passes `vc-mcvs-global-switches' to it before FLAGS."
558 (let ((args (append '("--error-terminate")
559 (if (stringp vc-mcvs-global-switches)
560 (cons vc-mcvs-global-switches flags)
561 (append vc-mcvs-global-switches flags)))))
562 (if (not (member (car flags) '("diff" "log" "status")))
563 ;; No need to filter: do it the easy way.
564 (apply 'vc-do-command buffer okstatus "mcvs" file args)
565 ;; We need to filter the output.
566 ;; The output of the filter uses filenames relative to the root,
567 ;; so we need to change the default-directory.
568 ;; (assert (equal default-directory (vc-mcvs-root file)))
570 buffer okstatus "sh" nil "-c"
573 'shell-quote-argument
574 (append (remq nil args)
575 (if file (list (file-relative-name file))))
579 (defun vc-mcvs-repository-hostname (dirname)
580 (vc-cvs-repository-hostname (vc-mcvs-root dirname)))
582 (defun vc-mcvs-dir-state-heuristic (dir)
583 "Find the Meta-CVS state of all files in DIR, using only local information."
585 (vc-cvs-get-entries dir)
586 (goto-char (point-min))
588 ;; Meta-MCVS-removed files are not taken under VC control.
589 (when (looking-at "/\\([^/]*\\)/[^/-]")
590 (let ((file (expand-file-name (match-string 1) dir)))
591 (unless (vc-file-getprop file 'vc-state)
592 (vc-cvs-parse-entry file t))))
595 (defalias 'vc-mcvs-valid-symbolic-tag-name-p 'vc-cvs-valid-symbolic-tag-name-p)
596 (defalias 'vc-mcvs-valid-version-number-p 'vc-cvs-valid-version-number-p)
600 ;; arch-tag: a39c7c1c-5247-429d-88df-dd7187d2e704
601 ;;; vc-mcvs.el ends here