1 ;;; vc-mcvs.el --- VC backend for the Meta-CVS version-control system
3 ;; Copyright (C) 1995,98,99,2000,01,02,2003 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., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, 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 (let ((dir file))
118 ;;;###autoload (while (and (stringp dir)
119 ;;;###autoload (not (equal
120 ;;;###autoload dir (setq dir (file-name-directory dir))))
122 ;;;###autoload (setq dir (if (file-directory-p
123 ;;;###autoload (expand-file-name "MCVS/CVS" dir))
124 ;;;###autoload t (directory-file-name dir))))
125 ;;;###autoload (if (eq dir t)
126 ;;;###autoload (progn
127 ;;;###autoload (load "vc-mcvs")
128 ;;;###autoload (vc-mcvs-registered file)))))
130 (defun vc-mcvs-root (file)
131 "Return the root directory of a Meta-CVS project, if any."
132 (or (vc-file-getprop file
'mcvs-root
)
137 (equal file
(setq file
(file-name-directory file
)))
139 (if (file-directory-p (expand-file-name "MCVS/CVS" file
))
141 (setq file
(directory-file-name file
))))
144 (defun vc-mcvs-read (file)
145 (if (file-readable-p file
)
147 (insert-file-contents file
)
148 (goto-char (point-min))
149 (read (current-buffer)))))
151 (defun vc-mcvs-map-file (dir file
)
152 (let ((map (vc-mcvs-read (expand-file-name "MCVS/MAP" dir
)))
154 (dolist (x map inode
)
155 (if (equal (nth 2 x
) file
) (setq inode
(nth 1 x
))))))
157 (defun vc-mcvs-registered (file)
158 (let (root inode cvsfile
)
159 (when (and (setq root
(vc-mcvs-root file
))
160 (setq inode
(vc-mcvs-map-file
161 root
(file-relative-name file root
))))
162 (vc-file-setprop file
'mcvs-inode inode
)
163 ;; Avoid calling `mcvs diff' in vc-workfile-unchanged-p.
164 (vc-file-setprop file
'vc-checkout-time
165 (if (vc-cvs-registered
166 (setq cvsfile
(expand-file-name inode root
)))
167 (vc-file-getprop cvsfile
'vc-checkout-time
)
168 ;; The file might not be registered yet because
173 (defmacro vc-mcvs-cvs
(op file
&rest args
)
175 `(,(intern (concat "vc-cvs-" (symbol-name op
)))
176 (expand-file-name (vc-file-getprop ,file
'mcvs-inode
)
177 (vc-file-getprop ,file
'mcvs-root
))
180 (defun vc-mcvs-state (file)
181 ;; This would assume the Meta-CVS sandbox is synchronized.
182 ;; (vc-mcvs-cvs state file))
183 "Meta-CVS-specific version of `vc-state'."
184 (if (vc-stay-local-p file
)
185 (let ((state (vc-file-getprop file
'vc-state
)))
186 ;; If we should stay local, use the heuristic but only if
187 ;; we don't have a more precise state already available.
188 (if (memq state
'(up-to-date edited
))
189 (vc-mcvs-state-heuristic file
)
192 (setq default-directory
(vc-mcvs-root file
))
193 (vc-mcvs-command t
0 file
"status")
194 (vc-cvs-parse-status t
))))
197 (defalias 'vc-mcvs-state-heuristic
'vc-cvs-state-heuristic
)
199 (defun vc-mcvs-dir-state (dir)
200 "Find the Meta-CVS state of all files in DIR."
201 ;; if DIR is not under Meta-CVS control, don't do anything.
202 (when (file-readable-p (expand-file-name "MCVS/CVS/Entries" dir
))
203 (if (vc-stay-local-p dir
)
204 (vc-mcvs-dir-state-heuristic dir
)
205 (let ((default-directory dir
))
206 ;; Don't specify DIR in this command, the default-directory is
207 ;; enough. Otherwise it might fail with remote repositories.
209 (setq default-directory
(vc-mcvs-root dir
))
210 (vc-mcvs-command t
0 nil
"status" "-l")
211 (goto-char (point-min))
212 (while (re-search-forward "^=+\n\\([^=\n].*\n\\|\n\\)+" nil t
)
213 (narrow-to-region (match-beginning 0) (match-end 0))
214 (vc-cvs-parse-status)
215 (goto-char (point-max))
218 (defun vc-mcvs-workfile-version (file) (vc-mcvs-cvs workfile-version file
))
220 (defalias 'vc-mcvs-checkout-model
'vc-cvs-checkout-model
)
222 (defun vc-mcvs-mode-line-string (file)
223 (let ((s (vc-mcvs-cvs mode-line-string file
)))
225 (if (and (not (memq (vc-state file
) '(up-to-date needs-patch
)))
226 (string-match "\\`CVS-" s
))
227 ;; The CVS file is not in sync, so we need to adjust the state.
228 (concat "MCVS:" (substring s
4))
232 ;;; State-changing functions
235 (defun vc-mcvs-register (file &optional rev comment
)
236 "Register FILE into the Meta-CVS version-control system.
237 COMMENT can be used to provide an initial description of FILE.
239 `vc-register-switches' and `vc-mcvs-register-switches' are passed to
240 the Meta-CVS command (in that order)."
241 (let* ((filename (file-name-nondirectory file
))
242 (extpos (string-match "\\." filename
))
243 (ext (if extpos
(substring filename
(1+ extpos
))))
244 (root (vc-mcvs-root file
))
245 (types-file (expand-file-name "MCVS/TYPES" root
))
246 (map-file (expand-file-name "MCVS/MAP" root
))
247 (types (vc-mcvs-read types-file
)))
248 ;; Make sure meta files like MCVS/MAP are not read-only (happens with
249 ;; CVSREAD) since Meta-CVS doesn't pay attention to it at all and goes
251 (unless (file-writable-p map-file
)
252 (vc-checkout map-file t
))
253 (unless (or (file-writable-p types-file
) (not (file-exists-p types-file
)))
254 (vc-checkout types-file t
))
255 ;; Make sure the `mcvs add' will not fire up the CVSEDITOR
256 ;; to add a rule for the given file's extension.
257 (when (and ext
(not (assoc ext types
)))
258 (let ((type (completing-read "Type to use [default]: "
259 '("default" "name-only" "keep-old"
260 "binary" "value-only")
261 nil t nil nil
"default")))
262 (push (list ext
(make-symbol (upcase (concat ":" type
)))) types
)
263 (setq types
(sort types
(lambda (x y
) (string< (car x
) (car y
)))))
264 (with-current-buffer (find-file-noselect types-file
)
266 (pp types
(current-buffer))
268 (unless (get-buffer-window (current-buffer) t
)
269 (kill-buffer (current-buffer)))))))
271 (prog1 (apply 'vc-mcvs-command nil
0 file
273 (and comment
(string-match "[^\t\n ]" comment
)
274 (concat "-m" comment
))
275 (vc-switches 'MCVS
'register
))
276 ;; I'm not sure exactly why, but if we don't setup the inode and root
277 ;; prop of the file, things break later on in vc-mode-line that
278 ;; ends up calling vc-mcvs-workfile-version.
279 ;; We also need to set vc-checkout-time so that vc-workfile-unchanged-p
280 ;; doesn't try to call `mcvs diff' on the file.
281 (vc-mcvs-registered file
)))
283 (defalias 'vc-mcvs-responsible-p
'vc-mcvs-root
284 "Return non-nil if CVS thinks it is responsible for FILE.")
286 (defalias 'vc-cvs-could-register
'vc-cvs-responsible-p
287 "Return non-nil if FILE could be registered in Meta-CVS.
288 This is only possible if Meta-CVS is responsible for FILE's directory.")
290 (defun vc-mcvs-checkin (file rev comment
)
291 "Meta-CVS-specific version of `vc-backend-checkin'."
292 (unless (or (not rev
) (vc-mcvs-valid-version-number-p rev
))
293 (if (not (vc-mcvs-valid-symbolic-tag-name-p rev
))
294 (error "%s is not a valid symbolic tag name" rev
)
295 ;; If the input revision is a valid symbolic tag name, we create it
296 ;; as a branch, commit and switch to it.
297 ;; This file-specific form of branching is deprecated.
298 ;; We can't use `mcvs branch' and `mcvs switch' because they cannot
299 ;; be applied just to this one file.
300 (apply 'vc-mcvs-command nil
0 file
"tag" "-b" (list rev
))
301 (apply 'vc-mcvs-command nil
0 file
"update" "-r" (list rev
))
302 (vc-file-setprop file
'vc-mcvs-sticky-tag rev
)
304 ;; This commit might cvs-commit several files (e.g. MAP and TYPES)
305 ;; so using numbered revs here is dangerous and somewhat meaningless.
306 (when rev
(error "Cannot commit to a specific revision number"))
307 (let ((status (apply 'vc-mcvs-command nil
1 file
309 (vc-switches 'MCVS
'checkin
))))
311 (goto-char (point-min))
312 (when (not (zerop status
))
313 ;; Check checkin problem.
315 ((re-search-forward "Up-to-date check failed" nil t
)
316 (vc-file-setprop file
'vc-state
'needs-merge
)
317 (error (substitute-command-keys
318 (concat "Up-to-date check failed: "
319 "type \\[vc-next-action] to merge in changes"))))
321 (pop-to-buffer (current-buffer))
322 (goto-char (point-min))
323 (shrink-window-if-larger-than-buffer)
324 (error "Check-in failed"))))
325 ;; Update file properties
327 file
'vc-workfile-version
328 (vc-parse-buffer "^\\(new\\|initial\\) revision: \\([0-9.]+\\)" 2))
329 ;; Forget the checkout model of the file, because we might have
330 ;; guessed wrong when we found the file. After commit, we can
331 ;; tell it from the permissions of the file (see
332 ;; vc-mcvs-checkout-model).
333 (vc-file-setprop file
'vc-checkout-model nil
)
335 ;; if this was an explicit check-in (does not include creation of
336 ;; a branch), remove the sticky tag.
337 (if (and rev
(not (vc-mcvs-valid-symbolic-tag-name-p rev
)))
338 (vc-mcvs-command nil
0 file
"update" "-A"))))
340 (defun vc-mcvs-find-version (file rev buffer
)
341 (apply 'vc-mcvs-command
343 "-Q" ; suppress diagnostic output
345 (and rev
(not (string= rev
""))
348 (vc-switches 'MCVS
'checkout
)))
350 (defun vc-mcvs-checkout (file &optional editable rev
)
351 (message "Checking out %s..." file
)
352 (with-current-buffer (or (get-file-buffer file
) (current-buffer))
353 (vc-call update file editable rev
(vc-switches 'MCVS
'checkout
)))
355 (message "Checking out %s...done" file
))
357 (defun vc-mcvs-update (file editable rev switches
)
358 (if (and (file-exists-p file
) (not rev
))
359 ;; If no revision was specified, just make the file writable
360 ;; if necessary (using `cvs-edit' if requested).
361 (and editable
(not (eq (vc-mcvs-checkout-model file
) 'implicit
))
363 (vc-mcvs-command nil
0 file
"edit")
364 (set-file-modes file
(logior (file-modes file
) 128))
365 (if (equal file buffer-file-name
) (toggle-read-only -
1))))
366 ;; Check out a particular version (or recreate the file).
367 (vc-file-setprop file
'vc-workfile-version nil
)
368 (apply 'vc-mcvs-command nil
0 file
371 ;; default for verbose checkout: clear the sticky tag so
372 ;; that the actual update will get the head of the trunk
373 (if (or (not rev
) (string= rev
""))
378 (defun vc-mcvs-rename-file (old new
)
379 (vc-mcvs-command nil
0 new
"move" (file-relative-name old
)))
381 (defun vc-mcvs-revert (file &optional contents-done
)
382 "Revert FILE to the version it was based on."
383 (vc-default-revert file contents-done
)
384 (unless (eq (vc-checkout-model file
) 'implicit
)
386 (vc-mcvs-command nil
0 file
"unedit")
387 ;; Make the file read-only by switching off all w-bits
388 (set-file-modes file
(logand (file-modes file
) 3950)))))
390 (defun vc-mcvs-merge (file first-version
&optional second-version
)
391 "Merge changes into current working copy of FILE.
392 The changes are between FIRST-VERSION and SECOND-VERSION."
393 (vc-mcvs-command nil
0 file
395 (concat "-j" first-version
)
396 (concat "-j" second-version
))
397 (vc-file-setprop file
'vc-state
'edited
)
398 (with-current-buffer (get-buffer "*vc*")
399 (goto-char (point-min))
400 (if (re-search-forward "conflicts during merge" nil t
)
402 0))) ; signal success
404 (defun vc-mcvs-merge-news (file)
405 "Merge in any new changes made to FILE."
406 (message "Merging changes into %s..." file
)
407 ;; (vc-file-setprop file 'vc-workfile-version nil)
408 (vc-file-setprop file
'vc-checkout-time
0)
409 (vc-mcvs-command nil
0 file
"update")
410 ;; Analyze the merge result reported by Meta-CVS, and set
411 ;; file properties accordingly.
412 (with-current-buffer (get-buffer "*vc*")
413 (goto-char (point-min))
414 ;; get new workfile version
415 (if (re-search-forward
416 "^Merging differences between [0-9.]* and \\([0-9.]*\\) into" nil t
)
417 (vc-file-setprop file
'vc-workfile-version
(match-string 1))
418 (vc-file-setprop file
'vc-workfile-version nil
))
421 (if (eq (buffer-size) 0)
422 0 ;; there were no news; indicate success
423 (if (re-search-forward
424 (concat "^\\([CMUP] \\)?"
426 "\\( already contains the differences between \\)?")
429 ;; Merge successful, we are in sync with repository now
430 ((or (match-string 2)
431 (string= (match-string 1) "U ")
432 (string= (match-string 1) "P "))
433 (vc-file-setprop file
'vc-state
'up-to-date
)
434 (vc-file-setprop file
'vc-checkout-time
435 (nth 5 (file-attributes file
)))
436 0);; indicate success to the caller
437 ;; Merge successful, but our own changes are still in the file
438 ((string= (match-string 1) "M ")
439 (vc-file-setprop file
'vc-state
'edited
)
440 0);; indicate success to the caller
441 ;; Conflicts detected!
443 (vc-file-setprop file
'vc-state
'edited
)
444 1);; signal the error to the caller
446 (pop-to-buffer "*vc*")
447 (error "Couldn't analyze mcvs update result")))
448 (message "Merging changes into %s...done" file
))))
451 ;;; History functions
454 (defun vc-mcvs-print-log (file)
455 "Get change log associated with FILE."
456 (let ((default-directory (vc-mcvs-root file
)))
457 ;; Run the command from the root dir so that `mcvs filt' returns
458 ;; valid relative names.
461 (if (and (vc-stay-local-p file
) (fboundp 'start-process
)) 'async
0)
464 (defun vc-mcvs-diff (file &optional oldvers newvers
)
465 "Get a difference report using Meta-CVS between two versions of FILE."
466 (if (string= (vc-workfile-version file
) "0")
467 ;; This file is added but not yet committed; there is no master file.
468 (if (or oldvers newvers
)
469 (error "No revisions of %s exist" file
)
470 ;; We regard this as "changed".
471 ;; Diff it against /dev/null.
472 ;; Note: this is NOT a "mcvs diff".
473 (apply 'vc-do-command
"*vc-diff*"
475 (append (vc-switches nil
'diff
) '("/dev/null")))
476 ;; Even if it's empty, it's locally modified.
478 (let* ((async (and (vc-stay-local-p file
) (fboundp 'start-process
)))
479 ;; Run the command from the root dir so that `mcvs filt' returns
480 ;; valid relative names.
481 (default-directory (vc-mcvs-root file
))
483 (apply 'vc-mcvs-command
"*vc-diff*"
486 (and oldvers
(concat "-r" oldvers
))
487 (and newvers
(concat "-r" newvers
))
488 (vc-switches 'MCVS
'diff
))))
489 (if async
1 status
)))) ; async diff, pessimistic assumption.
491 (defun vc-mcvs-diff-tree (dir &optional rev1 rev2
)
492 "Diff all files at and below DIR."
493 (with-current-buffer "*vc-diff*"
494 ;; Run the command from the root dir so that `mcvs filt' returns
495 ;; valid relative names.
496 (setq default-directory
(vc-mcvs-root dir
))
497 ;; cvs diff: use a single call for the entire tree
498 (let ((coding-system-for-read (or coding-system-for-read
'undecided
)))
499 (apply 'vc-mcvs-command
"*vc-diff*" 1 dir
"diff"
500 (and rev1
(concat "-r" rev1
))
501 (and rev2
(concat "-r" rev2
))
502 (vc-switches 'MCVS
'diff
)))))
504 (defun vc-mcvs-annotate-command (file buffer
&optional version
)
505 "Execute \"mcvs annotate\" on FILE, inserting the contents in BUFFER.
506 Optional arg VERSION is a version to annotate from."
509 (if (and (vc-stay-local-p file
) (fboundp 'start-process
)) 'async
0)
510 file
"annotate" (if version
(concat "-r" version
))))
512 (defalias 'vc-mcvs-annotate-current-time
'vc-cvs-annotate-current-time
)
513 (defalias 'vc-mcvs-annotate-time
'vc-cvs-annotate-time
)
519 (defun vc-mcvs-create-snapshot (dir name branchp
)
520 "Assign to DIR's current version a given NAME.
521 If BRANCHP is non-nil, the name is created as a branch (and the current
522 workspace is immediately moved to that new branch)."
524 (vc-mcvs-command nil
0 dir
"tag" "-c" name
)
525 (vc-mcvs-command nil
0 dir
"branch" name
)
526 (vc-mcvs-command nil
0 dir
"switch" name
)))
528 (defun vc-mcvs-retrieve-snapshot (dir name update
)
529 "Retrieve a snapshot at and below DIR.
530 NAME is the name of the snapshot; if it is empty, do a `cvs update'.
531 If UPDATE is non-nil, then update (resynch) any affected buffers."
532 (with-current-buffer (get-buffer-create "*vc*")
533 (let ((default-directory dir
)
536 (if (or (not name
) (string= name
""))
537 (vc-mcvs-command t
0 nil
"update")
538 (vc-mcvs-command t
0 nil
"update" "-r" name
)
539 (setq sticky-tag name
))
541 (goto-char (point-min))
543 (if (looking-at "\\([CMUP]\\) \\(.*\\)")
544 (let* ((file (expand-file-name (match-string 2) dir
))
545 (state (match-string 1))
546 (buffer (find-buffer-visiting file
)))
549 ((or (string= state
"U")
551 (vc-file-setprop file
'vc-state
'up-to-date
)
552 (vc-file-setprop file
'vc-workfile-version nil
)
553 (vc-file-setprop file
'vc-checkout-time
554 (nth 5 (file-attributes file
))))
555 ((or (string= state
"M")
557 (vc-file-setprop file
'vc-state
'edited
)
558 (vc-file-setprop file
'vc-workfile-version nil
)
559 (vc-file-setprop file
'vc-checkout-time
0)))
560 (vc-file-setprop file
'vc-mcvs-sticky-tag sticky-tag
)
561 (vc-resynch-buffer file t t
))))
562 (forward-line 1))))))
569 (defalias 'vc-mcvs-make-version-backups-p
'vc-stay-local-p
570 "Return non-nil if version backups should be made for FILE.")
571 (defalias 'vc-mcvs-check-headers
'vc-cvs-check-headers
)
575 ;;; Internal functions
578 (defun vc-mcvs-command (buffer okstatus file
&rest flags
)
579 "A wrapper around `vc-do-command' for use in vc-mcvs.el.
580 The difference to vc-do-command is that this function always invokes `mcvs',
581 and that it passes `vc-mcvs-global-switches' to it before FLAGS."
582 (let ((args (append '("--error-terminate")
583 (if (stringp vc-mcvs-global-switches
)
584 (cons vc-mcvs-global-switches flags
)
585 (append vc-mcvs-global-switches flags
)))))
586 (if (not (member (car flags
) '("diff" "log" "status")))
587 ;; No need to filter: do it the easy way.
588 (apply 'vc-do-command buffer okstatus
"mcvs" file args
)
589 ;; We need to filter the output.
590 ;; The output of the filter uses filenames relative to the root,
591 ;; so we need to change the default-directory.
592 (assert (equal default-directory
(vc-mcvs-root file
)))
594 buffer okstatus
"sh" nil
"-c"
597 'shell-quote-argument
598 (append (remq nil args
)
599 (if file
(list (file-relative-name file
))))
603 (defun vc-mcvs-repository-hostname (dirname)
604 (vc-cvs-repository-hostname (vc-mcvs-root dirname
)))
606 (defun vc-mcvs-dir-state-heuristic (dir)
607 "Find the Meta-CVS state of all files in DIR, using only local information."
609 (vc-cvs-get-entries dir
)
610 (goto-char (point-min))
612 ;; Meta-MCVS-removed files are not taken under VC control.
613 (when (looking-at "/\\([^/]*\\)/[^/-]")
614 (let ((file (expand-file-name (match-string 1) dir
)))
615 (unless (vc-file-getprop file
'vc-state
)
616 (vc-cvs-parse-entry file t
))))
619 (defalias 'vc-mcvs-valid-symbolic-tag-name-p
'vc-cvs-valid-symbolic-tag-name-p
)
620 (defalias 'vc-mcvs-valid-version-number-p
'vc-cvs-valid-version-number-p
)
623 ;;; vc-mcvs.el ends here