1 ;;; vc-mcvs.el --- VC backend for the Meta-CVS version-control system
3 ;; Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008 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 3, 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)."
112 ;;; Properties of the backend
114 (defun vc-mcvs-revision-granularity ()
118 ;;; State-querying functions
121 ;;;###autoload (defun vc-mcvs-registered (file)
122 ;;;###autoload (if (vc-find-root file "MCVS/CVS")
123 ;;;###autoload (progn
124 ;;;###autoload (load "vc-mcvs")
125 ;;;###autoload (vc-mcvs-registered file))))
127 (defun vc-mcvs-root (file)
128 "Return the root directory of a Meta-CVS project, if any."
129 (or (vc-file-getprop file
'mcvs-root
)
130 (vc-file-setprop file
'mcvs-root
(vc-find-root file
"MCVS/CVS"))))
132 (defun vc-mcvs-read (file)
133 (if (file-readable-p file
)
135 (insert-file-contents file
)
136 (goto-char (point-min))
137 (read (current-buffer)))))
139 (defun vc-mcvs-map-file (dir file
)
140 (let ((map (vc-mcvs-read (expand-file-name "MCVS/MAP" dir
)))
142 (dolist (x map inode
)
143 (if (equal (nth 2 x
) file
) (setq inode
(nth 1 x
))))))
145 (defun vc-mcvs-registered (file)
146 (let (root inode cvsfile
)
147 (when (and (setq root
(vc-mcvs-root file
))
148 (setq inode
(vc-mcvs-map-file
149 root
(file-relative-name file root
))))
150 (vc-file-setprop file
'mcvs-inode inode
)
151 ;; Avoid calling `mcvs diff' in vc-workfile-unchanged-p.
152 (vc-file-setprop file
'vc-checkout-time
153 (if (vc-cvs-registered
154 (setq cvsfile
(expand-file-name inode root
)))
155 (vc-file-getprop cvsfile
'vc-checkout-time
)
156 ;; The file might not be registered yet because
161 (defun vc-mcvs-state (file)
162 ;; This would assume the Meta-CVS sandbox is synchronized.
163 ;; (vc-mcvs-cvs state file))
164 "Meta-CVS-specific version of `vc-state'."
165 (if (vc-stay-local-p file
)
166 (let ((state (vc-file-getprop file
'vc-state
)))
167 ;; If we should stay local, use the heuristic but only if
168 ;; we don't have a more precise state already available.
169 (if (memq state
'(up-to-date edited
))
170 (vc-mcvs-state-heuristic file
)
173 (setq default-directory
(vc-mcvs-root file
))
174 (vc-mcvs-command t
0 file
"status")
175 (vc-cvs-parse-status t
))))
178 (defalias 'vc-mcvs-state-heuristic
'vc-cvs-state-heuristic
)
180 (defun vc-mcvs-dir-state (dir)
181 "Find the Meta-CVS state of all files in DIR and subdirectories."
182 ;; if DIR is not under Meta-CVS control, don't do anything.
183 (when (file-readable-p (expand-file-name "MCVS/CVS/Entries" dir
))
184 (if (vc-stay-local-p dir
)
185 (vc-mcvs-dir-state-heuristic dir
)
186 (let ((default-directory dir
))
187 ;; Don't specify DIR in this command, the default-directory is
188 ;; enough. Otherwise it might fail with remote repositories.
190 (buffer-disable-undo) ;; Because these buffers can get huge
191 (setq default-directory
(vc-mcvs-root dir
))
192 (vc-mcvs-command t
0 nil
"status")
193 (goto-char (point-min))
194 (while (re-search-forward "^=+\n\\([^=\n].*\n\\|\n\\)+" nil t
)
195 (narrow-to-region (match-beginning 0) (match-end 0))
196 (vc-cvs-parse-status)
197 (goto-char (point-max))
200 (defun vc-mcvs-working-revision (file)
201 (vc-cvs-working-revision
202 (expand-file-name (vc-file-getprop file
'mcvs-inode
)
203 (vc-file-getprop file
'mcvs-root
))))
205 (defalias 'vc-mcvs-checkout-model
'vc-cvs-checkout-model
)
208 ;;; State-changing functions
211 (defun vc-mcvs-register (files &optional rev comment
)
212 "Register FILES into the Meta-CVS version-control system.
213 COMMENT can be used to provide an initial description of FILE.
215 `vc-register-switches' and `vc-mcvs-register-switches' are passed to
216 the Meta-CVS command (in that order)."
217 ;; FIXME: multiple-file case should be made to work
218 (if (> (length files
) 1) (error "Registering filesets is not yet supported."))
219 (let* ((file (car files
))
220 (filename (file-name-nondirectory file
))
221 (extpos (string-match "\\." filename
))
222 (ext (if extpos
(substring filename
(1+ extpos
))))
223 (root (vc-mcvs-root file
))
224 (types-file (expand-file-name "MCVS/TYPES" root
))
225 (map-file (expand-file-name "MCVS/MAP" root
))
226 (types (vc-mcvs-read types-file
)))
227 ;; Make sure meta files like MCVS/MAP are not read-only (happens with
228 ;; CVSREAD) since Meta-CVS doesn't pay attention to it at all and goes
230 (unless (file-writable-p map-file
)
231 (vc-checkout map-file t
))
232 (unless (or (file-writable-p types-file
) (not (file-exists-p types-file
)))
233 (vc-checkout types-file t
))
234 ;; Make sure the `mcvs add' will not fire up the CVSEDITOR
235 ;; to add a rule for the given file's extension.
236 (when (and ext
(not (assoc ext types
)))
237 (let ((type (completing-read "Type to use (default): "
238 '("default" "name-only" "keep-old"
239 "binary" "value-only")
240 nil t nil nil
"default")))
241 (push (list ext
(make-symbol (upcase (concat ":" type
)))) types
)
242 (setq types
(sort types
(lambda (x y
) (string< (car x
) (car y
)))))
243 (with-current-buffer (find-file-noselect types-file
)
245 (pp types
(current-buffer))
247 (unless (get-buffer-window (current-buffer) t
)
248 (kill-buffer (current-buffer))))))
250 (prog1 (apply 'vc-mcvs-command nil
0 file
252 (and comment
(string-match "[^\t\n ]" comment
)
253 (concat "-m" comment
))
254 (vc-switches 'MCVS
'register
))
255 ;; I'm not sure exactly why, but if we don't setup the inode and root
256 ;; prop of the file, things break later on in vc-mode-line that
257 ;; ends up calling vc-mcvs-working-revision.
258 ;; We also need to set vc-checkout-time so that vc-workfile-unchanged-p
259 ;; doesn't try to call `mcvs diff' on the file.
260 (vc-mcvs-registered file
))))
262 (defalias 'vc-mcvs-responsible-p
'vc-mcvs-root
263 "Return non-nil if CVS thinks it is responsible for FILE.")
265 (defalias 'vc-cvs-could-register
'vc-cvs-responsible-p
266 "Return non-nil if FILE could be registered in Meta-CVS.
267 This is only possible if Meta-CVS is responsible for FILE's directory.")
269 (defun vc-mcvs-checkin (files rev comment
)
270 "Meta-CVS-specific version of `vc-backend-checkin'."
271 (unless (or (not rev
) (vc-mcvs-valid-revision-number-p rev
))
272 (if (not (vc-mcvs-valid-symbolic-tag-name-p rev
))
273 (error "%s is not a valid symbolic tag name" rev
)
274 ;; If the input revision is a valid symbolic tag name, we create it
275 ;; as a branch, commit and switch to it.
276 ;; This file-specific form of branching is deprecated.
277 ;; We can't use `mcvs branch' and `mcvs switch' because they cannot
278 ;; be applied just to this one file.
279 (apply 'vc-mcvs-command nil
0 files
"tag" "-b" (list rev
))
280 (apply 'vc-mcvs-command nil
0 files
"update" "-r" (list rev
))
281 (mapc (lambda (file) (vc-file-setprop file
'vc-mcvs-sticky-tag rev
))
284 ;; This commit might cvs-commit several files (e.g. MAP and TYPES)
285 ;; so using numbered revs here is dangerous and somewhat meaningless.
286 (when rev
(error "Cannot commit to a specific revision number"))
287 (let ((status (apply 'vc-mcvs-command nil
1 files
289 (vc-switches 'MCVS
'checkin
))))
291 (goto-char (point-min))
292 (when (not (zerop status
))
293 ;; Check checkin problem.
295 ((re-search-forward "Up-to-date check failed" nil t
)
296 (mapc (lambda (file) (vc-file-setprop file
'vc-state
'needs-merge
))
298 (error "%s" (substitute-command-keys
299 (concat "Up-to-date check failed: "
300 "type \\[vc-next-action] to merge in changes"))))
302 (pop-to-buffer (current-buffer))
303 (goto-char (point-min))
304 (shrink-window-if-larger-than-buffer)
305 (error "Check-in failed"))))
306 ;; Single-file commit? Then update the revision by parsing the buffer.
307 ;; Otherwise we can't necessarily tell what goes with what; clear
308 ;; its properties so they have to be refetched.
309 (if (= (length files
) 1)
311 (car files
) 'vc-working-revision
312 (vc-parse-buffer "^\\(new\\|initial\\) revision: \\([0-9.]+\\)" 2))
313 (mapc (lambda (file) (vc-file-clearprops file
)) files
))
314 ;; Anyway, forget the checkout model of the file, because we might have
315 ;; guessed wrong when we found the file. After commit, we can
316 ;; tell it from the permissions of the file (see
317 ;; vc-mcvs-checkout-model).
318 (mapc (lambda (file) (vc-file-setprop file
'vc-checkout-model nil
))
321 ;; if this was an explicit check-in (does not include creation of
322 ;; a branch), remove the sticky tag.
323 (if (and rev
(not (vc-mcvs-valid-symbolic-tag-name-p rev
)))
324 (vc-mcvs-command nil
0 files
"update" "-A"))))
326 (defun vc-mcvs-find-revision (file rev buffer
)
327 (apply 'vc-mcvs-command
329 "-Q" ; suppress diagnostic output
331 (and rev
(not (string= rev
""))
334 (vc-switches 'MCVS
'checkout
)))
336 (defun vc-mcvs-checkout (file &optional editable rev
)
337 (message "Checking out %s..." file
)
338 (with-current-buffer (or (get-file-buffer file
) (current-buffer))
339 (vc-call update file editable rev
(vc-switches 'MCVS
'checkout
)))
341 (message "Checking out %s...done" file
))
343 (defun vc-mcvs-update (file editable rev switches
)
344 (if (and (file-exists-p file
) (not rev
))
345 ;; If no revision was specified, just make the file writable
346 ;; if necessary (using `cvs-edit' if requested).
347 (and editable
(not (eq (vc-mcvs-checkout-model file
) 'implicit
))
349 (vc-mcvs-command nil
0 file
"edit")
350 (set-file-modes file
(logior (file-modes file
) 128))
351 (if (equal file buffer-file-name
) (toggle-read-only -
1))))
352 ;; Check out a particular revision (or recreate the file).
353 (vc-file-setprop file
'vc-working-revision nil
)
354 (apply 'vc-mcvs-command nil
0 file
357 ;; default for verbose checkout: clear the sticky tag so
358 ;; that the actual update will get the head of the trunk
359 (if (or (not rev
) (string= rev
""))
364 (defun vc-mcvs-rename-file (old new
)
365 (vc-mcvs-command nil
0 new
"move" (file-relative-name old
)))
367 (defun vc-mcvs-revert (file &optional contents-done
)
368 "Revert FILE to the working revision it was based on."
369 (vc-default-revert 'MCVS file contents-done
)
370 (unless (eq (vc-mcvs-checkout-model file
) 'implicit
)
372 (vc-mcvs-command nil
0 file
"unedit")
373 ;; Make the file read-only by switching off all w-bits
374 (set-file-modes file
(logand (file-modes file
) 3950)))))
376 (defun vc-mcvs-merge (file first-revision
&optional second-revision
)
377 "Merge changes into current working copy of FILE.
378 The changes are between FIRST-REVISION and SECOND-REVISION."
379 (vc-mcvs-command nil
0 file
381 (concat "-j" first-revision
)
382 (concat "-j" second-revision
))
383 (vc-file-setprop file
'vc-state
'edited
)
384 (with-current-buffer (get-buffer "*vc*")
385 (goto-char (point-min))
386 (if (re-search-forward "conflicts during merge" nil t
)
388 0))) ; signal success
390 (defun vc-mcvs-merge-news (file)
391 "Merge in any new changes made to FILE."
392 (message "Merging changes into %s..." file
)
393 ;; (vc-file-setprop file 'vc-working-revision nil)
394 (vc-file-setprop file
'vc-checkout-time
0)
395 (vc-mcvs-command nil
0 file
"update")
396 ;; Analyze the merge result reported by Meta-CVS, and set
397 ;; file properties accordingly.
398 (with-current-buffer (get-buffer "*vc*")
399 (goto-char (point-min))
400 ;; get new working revision
401 (if (re-search-forward
402 "^Merging differences between [0-9.]* and \\([0-9.]*\\) into" nil t
)
403 (vc-file-setprop file
'vc-working-revision
(match-string 1))
404 (vc-file-setprop file
'vc-working-revision nil
))
407 (if (eq (buffer-size) 0)
408 0 ;; there were no news; indicate success
409 (if (re-search-forward
410 (concat "^\\([CMUP] \\)?"
412 "\\( already contains the differences between \\)?")
415 ;; Merge successful, we are in sync with repository now
416 ((or (match-string 2)
417 (string= (match-string 1) "U ")
418 (string= (match-string 1) "P "))
419 (vc-file-setprop file
'vc-state
'up-to-date
)
420 (vc-file-setprop file
'vc-checkout-time
421 (nth 5 (file-attributes file
)))
422 0);; indicate success to the caller
423 ;; Merge successful, but our own changes are still in the file
424 ((string= (match-string 1) "M ")
425 (vc-file-setprop file
'vc-state
'edited
)
426 0);; indicate success to the caller
427 ;; Conflicts detected!
429 (vc-file-setprop file
'vc-state
'edited
)
430 1);; signal the error to the caller
432 (pop-to-buffer "*vc*")
433 (error "Couldn't analyze mcvs update result")))
434 (message "Merging changes into %s...done" file
))))
436 (defun vc-mcvs-modify-change-comment (files rev comment
)
437 "Modify the change comments for FILES on a specified REV.
438 Will fail unless you have administrative privileges on the repo."
439 (vc-mcvs-command nil
0 files
"rcs" (concat "-m" comment
":" rev
)))
443 ;;; History functions
446 (defun vc-mcvs-print-log (files &optional buffer
)
447 "Get change log associated with FILES."
448 (let ((default-directory (vc-mcvs-root (car files
))))
449 ;; Run the command from the root dir so that `mcvs filt' returns
450 ;; valid relative names.
453 (if (vc-stay-local-p files
) 'async
0)
456 (defun vc-mcvs-diff (files &optional oldvers newvers buffer
)
457 "Get a difference report using Meta-CVS between two revisions of FILES."
458 (let* ((async (and (not vc-disable-async-diff
)
459 (vc-stay-local-p files
)))
460 ;; Run the command from the root dir so that `mcvs filt' returns
461 ;; valid relative names.
462 (default-directory (vc-mcvs-root (car files
)))
464 (apply 'vc-mcvs-command
(or buffer
"*vc-diff*")
467 (and oldvers
(concat "-r" oldvers
))
468 (and newvers
(concat "-r" newvers
))
469 (vc-switches 'MCVS
'diff
))))
470 (if async
1 status
))) ; async diff, pessimistic assumption.
472 (defun vc-mcvs-annotate-command (file buffer
&optional revision
)
473 "Execute \"mcvs annotate\" on FILE, inserting the contents in BUFFER.
474 Optional arg REVISION is a revision to annotate from."
477 (if (vc-stay-local-p file
) 'async
0)
478 file
"annotate" (if revision
(concat "-r" revision
)))
479 (with-current-buffer buffer
480 (goto-char (point-min))
481 (re-search-forward "^[0-9]")
482 (delete-region (point-min) (1- (point)))))
484 (defalias 'vc-mcvs-annotate-current-time
'vc-cvs-annotate-current-time
)
485 (defalias 'vc-mcvs-annotate-time
'vc-cvs-annotate-time
)
491 (defun vc-mcvs-create-snapshot (dir name branchp
)
492 "Assign to DIR's current revision a given NAME.
493 If BRANCHP is non-nil, the name is created as a branch (and the current
494 workspace is immediately moved to that new branch)."
496 (vc-mcvs-command nil
0 dir
"tag" "-c" name
)
497 (vc-mcvs-command nil
0 dir
"branch" name
)
498 (vc-mcvs-command nil
0 dir
"switch" name
)))
500 (defun vc-mcvs-retrieve-snapshot (dir name update
)
501 "Retrieve a snapshot at and below DIR.
502 NAME is the name of the snapshot; if it is empty, do a `cvs update'.
503 If UPDATE is non-nil, then update (resynch) any affected buffers."
504 (with-current-buffer (get-buffer-create "*vc*")
505 (let ((default-directory dir
)
508 (if (or (not name
) (string= name
""))
509 (vc-mcvs-command t
0 nil
"update")
510 (vc-mcvs-command t
0 nil
"update" "-r" name
)
511 (setq sticky-tag name
))
513 (goto-char (point-min))
515 (if (looking-at "\\([CMUP]\\) \\(.*\\)")
516 (let* ((file (expand-file-name (match-string 2) dir
))
517 (state (match-string 1))
518 (buffer (find-buffer-visiting file
)))
521 ((or (string= state
"U")
523 (vc-file-setprop file
'vc-state
'up-to-date
)
524 (vc-file-setprop file
'vc-working-revision nil
)
525 (vc-file-setprop file
'vc-checkout-time
526 (nth 5 (file-attributes file
))))
527 ((or (string= state
"M")
529 (vc-file-setprop file
'vc-state
'edited
)
530 (vc-file-setprop file
'vc-working-revision nil
)
531 (vc-file-setprop file
'vc-checkout-time
0)))
532 (vc-file-setprop file
'vc-mcvs-sticky-tag sticky-tag
)
533 (vc-resynch-buffer file t t
))))
534 (forward-line 1))))))
541 (defalias 'vc-mcvs-make-version-backups-p
'vc-stay-local-p
542 "Return non-nil if version backups should be made for FILE.")
543 (defalias 'vc-mcvs-check-headers
'vc-cvs-check-headers
)
547 ;;; Internal functions
550 (defun vc-mcvs-command (buffer okstatus file
&rest flags
)
551 "A wrapper around `vc-do-command' for use in vc-mcvs.el.
552 The difference to vc-do-command is that this function always invokes `mcvs',
553 and that it passes `vc-mcvs-global-switches' to it before FLAGS."
554 (let ((args (append '("--error-terminate")
555 (if (stringp vc-mcvs-global-switches
)
556 (cons vc-mcvs-global-switches flags
)
557 (append vc-mcvs-global-switches flags
)))))
558 (if (not (member (car flags
) '("diff" "log" "status")))
559 ;; No need to filter: do it the easy way.
560 (apply 'vc-do-command buffer okstatus
"mcvs" file args
)
561 ;; We need to filter the output.
562 ;; The output of the filter uses filenames relative to the root,
563 ;; so we need to change the default-directory.
564 ;; (assert (equal default-directory (vc-mcvs-root file)))
566 buffer okstatus
"sh" nil
"-c"
569 'shell-quote-argument
570 (append (remq nil args
)
571 (if file
(list (file-relative-name file
))))
575 (defun vc-mcvs-repository-hostname (dirname)
576 (vc-cvs-repository-hostname (vc-mcvs-root dirname
)))
578 (defun vc-mcvs-dir-state-heuristic (dir)
579 "Find the Meta-CVS state of all files in DIR, using only local information."
581 (vc-cvs-get-entries dir
)
582 (goto-char (point-min))
584 ;; Meta-MCVS-removed files are not taken under VC control.
585 (when (looking-at "/\\([^/]*\\)/[^/-]")
586 (let ((file (expand-file-name (match-string 1) dir
)))
587 (unless (vc-file-getprop file
'vc-state
)
588 (vc-cvs-parse-entry file t
))))
591 (defalias 'vc-mcvs-valid-symbolic-tag-name-p
'vc-cvs-valid-symbolic-tag-name-p
)
592 (defalias 'vc-mcvs-valid-revision-number-p
'vc-cvs-valid-revision-number-p
)
596 ;; arch-tag: a39c7c1c-5247-429d-88df-dd7187d2e704
597 ;;; vc-mcvs.el ends here