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)
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 of the License, or
13 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
25 ;; The home page of the Meta-CVS version control system is at
27 ;; http://users.footprints.net/~kaz/mcvs.html
29 ;; This is derived from vc-cvs.el as follows:
30 ;; - cp vc-cvs.el vc-mcvs.el
31 ;; - Replace CVS/ with MCVS/CVS/
32 ;; - Replace 'CVS with 'MCVS
33 ;; - Replace -cvs- with -mcvs-
34 ;; - Replace most of the rest of CVS to Meta-CVS
36 ;; Then of course started the hacking. Only a small part of the code
37 ;; has been touched and not much more than that was tested, so if
38 ;; you bump into a bug, don't be surprised: just report it to me.
40 ;; What has been partly tested:
41 ;; - C-x v v to start editing a file that was checked out with CVSREAD on.
42 ;; - C-x v v to commit a file
47 ;; - M-x vc-rename-file RET
51 ;; - Retrieving tags doesn't filter `cvs update' output and thus
52 ;; parses bogus filenames. Don't know if it harms.
56 (eval-when-compile (require 'vc
))
60 ;;; Customization options
63 (defcustom vc-mcvs-global-switches nil
64 "*Global switches to pass to any Meta-CVS command."
65 :type
'(choice (const :tag
"None" nil
)
66 (string :tag
"Argument String")
67 (repeat :tag
"Argument List"
73 (defcustom vc-mcvs-register-switches nil
74 "*Extra switches for registering a file into Meta-CVS.
75 A string or list of strings passed to the checkin program by
77 :type
'(choice (const :tag
"None" nil
)
78 (string :tag
"Argument String")
79 (repeat :tag
"Argument List"
85 (defcustom vc-mcvs-diff-switches nil
86 "*A string or list of strings specifying extra switches for cvs diff under VC."
87 :type
'(choice (const :tag
"None" nil
)
88 (string :tag
"Argument String")
89 (repeat :tag
"Argument List"
95 (defcustom vc-mcvs-header
(or (cdr (assoc 'MCVS vc-header-alist
))
97 "*Header keywords to be inserted by `vc-insert-headers'."
99 :type
'(repeat string
)
102 (defcustom vc-mcvs-use-edit vc-cvs-use-edit
103 "*Non-nil means to use `cvs edit' to \"check out\" a file.
104 This is only meaningful if you don't use the implicit checkout model
105 \(i.e. if you have $CVSREAD set)."
110 ;;; Properties of the backend
112 (defalias 'vc-mcvs-revision-granularity
'vc-cvs-revision-granularity
)
113 (defalias 'vc-mcvs-checkout-model
'vc-cvs-checkout-model
)
116 ;;; State-querying functions
119 ;;;###autoload (defun vc-mcvs-registered (file)
120 ;;;###autoload (if (vc-find-root file "MCVS/CVS")
121 ;;;###autoload (progn
122 ;;;###autoload (load "vc-mcvs")
123 ;;;###autoload (vc-mcvs-registered file))))
125 (defun vc-mcvs-root (file)
126 "Return the root directory of a Meta-CVS project, if any."
127 (or (vc-file-getprop file
'mcvs-root
)
128 (vc-file-setprop file
'mcvs-root
(vc-find-root file
"MCVS/CVS"))))
130 (defun vc-mcvs-read (file)
131 (if (file-readable-p file
)
133 (insert-file-contents file
)
134 (goto-char (point-min))
135 (read (current-buffer)))))
137 (defun vc-mcvs-map-file (dir file
)
138 (let ((map (vc-mcvs-read (expand-file-name "MCVS/MAP" dir
)))
140 (dolist (x map inode
)
141 (if (equal (nth 2 x
) file
) (setq inode
(nth 1 x
))))))
143 (defun vc-mcvs-registered (file)
144 (let (root inode cvsfile
)
145 (when (and (setq root
(vc-mcvs-root file
))
146 (setq inode
(vc-mcvs-map-file
147 root
(file-relative-name file root
))))
148 (vc-file-setprop file
'mcvs-inode inode
)
149 ;; Avoid calling `mcvs diff' in vc-workfile-unchanged-p.
150 (vc-file-setprop file
'vc-checkout-time
151 (if (vc-cvs-registered
152 (setq cvsfile
(expand-file-name inode root
)))
153 (vc-file-getprop cvsfile
'vc-checkout-time
)
154 ;; The file might not be registered yet because
159 (defun vc-mcvs-state (file)
160 ;; This would assume the Meta-CVS sandbox is synchronized.
161 ;; (vc-mcvs-cvs state file))
162 "Meta-CVS-specific version of `vc-state'."
163 (if (vc-stay-local-p file
)
164 (let ((state (vc-file-getprop file
'vc-state
)))
165 ;; If we should stay local, use the heuristic but only if
166 ;; we don't have a more precise state already available.
167 (if (memq state
'(up-to-date edited
))
168 (vc-mcvs-state-heuristic file
)
171 (setq default-directory
(vc-mcvs-root file
))
172 (vc-mcvs-command t
0 file
"status")
173 (vc-cvs-parse-status t
))))
176 (defalias 'vc-mcvs-state-heuristic
'vc-cvs-state-heuristic
)
178 (defun vc-mcvs-working-revision (file)
179 (vc-cvs-working-revision
180 (expand-file-name (vc-file-getprop file
'mcvs-inode
)
181 (vc-file-getprop file
'mcvs-root
))))
184 ;;; State-changing functions
187 (defun vc-mcvs-register (files &optional rev comment
)
188 "Register FILES into the Meta-CVS version-control system.
189 COMMENT can be used to provide an initial description of FILE.
191 `vc-register-switches' and `vc-mcvs-register-switches' are passed to
192 the Meta-CVS command (in that order)."
193 ;; FIXME: multiple-file case should be made to work
194 (if (> (length files
) 1) (error "Registering filesets is not yet supported."))
195 (let* ((file (car files
))
196 (filename (file-name-nondirectory file
))
197 (extpos (string-match "\\." filename
))
198 (ext (if extpos
(substring filename
(1+ extpos
))))
199 (root (vc-mcvs-root file
))
200 (types-file (expand-file-name "MCVS/TYPES" root
))
201 (map-file (expand-file-name "MCVS/MAP" root
))
202 (types (vc-mcvs-read types-file
)))
203 ;; Make sure meta files like MCVS/MAP are not read-only (happens with
204 ;; CVSREAD) since Meta-CVS doesn't pay attention to it at all and goes
206 (unless (file-writable-p map-file
)
207 (vc-checkout map-file t
))
208 (unless (or (file-writable-p types-file
) (not (file-exists-p types-file
)))
209 (vc-checkout types-file t
))
210 ;; Make sure the `mcvs add' will not fire up the CVSEDITOR
211 ;; to add a rule for the given file's extension.
212 (when (and ext
(not (assoc ext types
)))
213 (let ((type (completing-read "Type to use (default): "
214 '("default" "name-only" "keep-old"
215 "binary" "value-only")
216 nil t nil nil
"default")))
217 (push (list ext
(make-symbol (upcase (concat ":" type
)))) types
)
218 (setq types
(sort types
(lambda (x y
) (string< (car x
) (car y
)))))
219 (with-current-buffer (find-file-noselect types-file
)
221 (pp types
(current-buffer))
223 (unless (get-buffer-window (current-buffer) t
)
224 (kill-buffer (current-buffer))))))
226 (prog1 (apply 'vc-mcvs-command nil
0 file
228 (and comment
(string-match "[^\t\n ]" comment
)
229 (concat "-m" comment
))
230 (vc-switches 'MCVS
'register
))
231 ;; I'm not sure exactly why, but if we don't setup the inode and root
232 ;; prop of the file, things break later on in vc-mode-line that
233 ;; ends up calling vc-mcvs-working-revision.
234 ;; We also need to set vc-checkout-time so that vc-workfile-unchanged-p
235 ;; doesn't try to call `mcvs diff' on the file.
236 (vc-mcvs-registered file
))))
238 (defalias 'vc-mcvs-responsible-p
'vc-mcvs-root
239 "Return non-nil if CVS thinks it is responsible for FILE.")
241 (defalias 'vc-cvs-could-register
'vc-cvs-responsible-p
242 "Return non-nil if FILE could be registered in Meta-CVS.
243 This is only possible if Meta-CVS is responsible for FILE's directory.")
245 (defun vc-mcvs-checkin (files rev comment
)
246 "Meta-CVS-specific version of `vc-backend-checkin'."
247 (unless (or (not rev
) (vc-mcvs-valid-revision-number-p rev
))
248 (if (not (vc-mcvs-valid-symbolic-tag-name-p rev
))
249 (error "%s is not a valid symbolic tag name" rev
)
250 ;; If the input revision is a valid symbolic tag name, we create it
251 ;; as a branch, commit and switch to it.
252 ;; This file-specific form of branching is deprecated.
253 ;; We can't use `mcvs branch' and `mcvs switch' because they cannot
254 ;; be applied just to this one file.
255 (apply 'vc-mcvs-command nil
0 files
"tag" "-b" (list rev
))
256 (apply 'vc-mcvs-command nil
0 files
"update" "-r" (list rev
))
257 (mapc (lambda (file) (vc-file-setprop file
'vc-mcvs-sticky-tag rev
))
260 ;; This commit might cvs-commit several files (e.g. MAP and TYPES)
261 ;; so using numbered revs here is dangerous and somewhat meaningless.
262 (when rev
(error "Cannot commit to a specific revision number"))
263 (let ((status (apply 'vc-mcvs-command nil
1 files
265 (vc-switches 'MCVS
'checkin
))))
267 (goto-char (point-min))
268 (when (not (zerop status
))
269 ;; Check checkin problem.
271 ((re-search-forward "Up-to-date check failed" nil t
)
272 (mapc (lambda (file) (vc-file-setprop file
'vc-state
'needs-merge
))
274 (error "%s" (substitute-command-keys
275 (concat "Up-to-date check failed: "
276 "type \\[vc-next-action] to merge in changes"))))
278 (pop-to-buffer (current-buffer))
279 (goto-char (point-min))
280 (shrink-window-if-larger-than-buffer)
281 (error "Check-in failed"))))
282 ;; Single-file commit? Then update the revision by parsing the buffer.
283 ;; Otherwise we can't necessarily tell what goes with what; clear
284 ;; its properties so they have to be refetched.
285 (if (= (length files
) 1)
287 (car files
) 'vc-working-revision
288 (vc-parse-buffer "^\\(new\\|initial\\) revision: \\([0-9.]+\\)" 2))
289 (mapc (lambda (file) (vc-file-clearprops file
)) files
))
290 ;; Anyway, forget the checkout model of the file, because we might have
291 ;; guessed wrong when we found the file. After commit, we can
292 ;; tell it from the permissions of the file (see
293 ;; vc-mcvs-checkout-model).
294 (mapc (lambda (file) (vc-file-setprop file
'vc-checkout-model nil
))
297 ;; if this was an explicit check-in (does not include creation of
298 ;; a branch), remove the sticky tag.
299 (if (and rev
(not (vc-mcvs-valid-symbolic-tag-name-p rev
)))
300 (vc-mcvs-command nil
0 files
"update" "-A"))))
302 (defun vc-mcvs-find-revision (file rev buffer
)
303 (apply 'vc-mcvs-command
305 "-Q" ; suppress diagnostic output
307 (and rev
(not (string= rev
""))
310 (vc-switches 'MCVS
'checkout
)))
312 (defun vc-mcvs-checkout (file &optional editable rev
)
313 (message "Checking out %s..." file
)
314 (with-current-buffer (or (get-file-buffer file
) (current-buffer))
315 (vc-mcvs-update file editable rev
(vc-switches 'MCVS
'checkout
)))
317 (message "Checking out %s...done" file
))
319 (defun vc-mcvs-update (file editable rev switches
)
320 (if (and (file-exists-p file
) (not rev
))
321 ;; If no revision was specified, just make the file writable
322 ;; if necessary (using `cvs-edit' if requested).
323 (and editable
(not (eq (vc-mcvs-checkout-model (list file
)) 'implicit
))
325 (vc-mcvs-command nil
0 file
"edit")
326 (set-file-modes file
(logior (file-modes file
) 128))
327 (if (equal file buffer-file-name
) (toggle-read-only -
1))))
328 ;; Check out a particular revision (or recreate the file).
329 (vc-file-setprop file
'vc-working-revision nil
)
330 (apply 'vc-mcvs-command nil
0 file
333 ;; default for verbose checkout: clear the sticky tag so
334 ;; that the actual update will get the head of the trunk
335 (if (or (not rev
) (string= rev
""))
340 (defun vc-mcvs-rename-file (old new
)
341 (vc-mcvs-command nil
0 new
"move" (file-relative-name old
)))
343 (defun vc-mcvs-revert (file &optional contents-done
)
344 "Revert FILE to the working revision it was based on."
345 (vc-default-revert 'MCVS file contents-done
)
346 (unless (eq (vc-mcvs-checkout-model (list file
)) 'implicit
)
348 (vc-mcvs-command nil
0 file
"unedit")
349 ;; Make the file read-only by switching off all w-bits
350 (set-file-modes file
(logand (file-modes file
) 3950)))))
352 (defun vc-mcvs-merge (file first-revision
&optional second-revision
)
353 "Merge changes into current working copy of FILE.
354 The changes are between FIRST-REVISION and SECOND-REVISION."
355 (vc-mcvs-command nil
0 file
357 (concat "-j" first-revision
)
358 (concat "-j" second-revision
))
359 (vc-file-setprop file
'vc-state
'edited
)
360 (with-current-buffer (get-buffer "*vc*")
361 (goto-char (point-min))
362 (if (re-search-forward "conflicts during merge" nil t
)
364 0))) ; signal success
366 (defun vc-mcvs-merge-news (file)
367 "Merge in any new changes made to FILE."
368 (message "Merging changes into %s..." file
)
369 ;; (vc-file-setprop file 'vc-working-revision nil)
370 (vc-file-setprop file
'vc-checkout-time
0)
371 (vc-mcvs-command nil
0 file
"update")
372 ;; Analyze the merge result reported by Meta-CVS, and set
373 ;; file properties accordingly.
374 (with-current-buffer (get-buffer "*vc*")
375 (goto-char (point-min))
376 ;; get new working revision
377 (if (re-search-forward
378 "^Merging differences between [0-9.]* and \\([0-9.]*\\) into" nil t
)
379 (vc-file-setprop file
'vc-working-revision
(match-string 1))
380 (vc-file-setprop file
'vc-working-revision nil
))
383 (if (eq (buffer-size) 0)
384 0 ;; there were no news; indicate success
385 (if (re-search-forward
386 (concat "^\\([CMUP] \\)?"
388 "\\( already contains the differences between \\)?")
391 ;; Merge successful, we are in sync with repository now
392 ((or (match-string 2)
393 (string= (match-string 1) "U ")
394 (string= (match-string 1) "P "))
395 (vc-file-setprop file
'vc-state
'up-to-date
)
396 (vc-file-setprop file
'vc-checkout-time
397 (nth 5 (file-attributes file
)))
398 0);; indicate success to the caller
399 ;; Merge successful, but our own changes are still in the file
400 ((string= (match-string 1) "M ")
401 (vc-file-setprop file
'vc-state
'edited
)
402 0);; indicate success to the caller
403 ;; Conflicts detected!
405 (vc-file-setprop file
'vc-state
'edited
)
406 1);; signal the error to the caller
408 (pop-to-buffer "*vc*")
409 (error "Couldn't analyze mcvs update result")))
410 (message "Merging changes into %s...done" file
))))
412 (defun vc-mcvs-modify-change-comment (files rev comment
)
413 "Modify the change comments for FILES on a specified REV.
414 Will fail unless you have administrative privileges on the repo."
415 (vc-mcvs-command nil
0 files
"rcs" (concat "-m" comment
":" rev
)))
419 ;;; History functions
422 (defun vc-mcvs-print-log (files &optional buffer
)
423 "Get change log associated with FILES."
424 (let ((default-directory (vc-mcvs-root (car files
))))
425 ;; Run the command from the root dir so that `mcvs filt' returns
426 ;; valid relative names.
429 (if (vc-stay-local-p files
) 'async
0)
432 (defun vc-mcvs-diff (files &optional oldvers newvers buffer
)
433 "Get a difference report using Meta-CVS between two revisions of FILES."
434 (let* ((async (and (not vc-disable-async-diff
)
435 (vc-stay-local-p files
)))
436 ;; Run the command from the root dir so that `mcvs filt' returns
437 ;; valid relative names.
438 (default-directory (vc-mcvs-root (car files
)))
440 (apply 'vc-mcvs-command
(or buffer
"*vc-diff*")
443 (and oldvers
(concat "-r" oldvers
))
444 (and newvers
(concat "-r" newvers
))
445 (vc-switches 'MCVS
'diff
))))
446 (if async
1 status
))) ; async diff, pessimistic assumption.
448 (defun vc-mcvs-annotate-command (file buffer
&optional revision
)
449 "Execute \"mcvs annotate\" on FILE, inserting the contents in BUFFER.
450 Optional arg REVISION is a revision to annotate from."
453 (if (vc-stay-local-p file
) 'async
0)
454 file
"annotate" (if revision
(concat "-r" revision
)))
455 (with-current-buffer buffer
456 (goto-char (point-min))
457 (re-search-forward "^[0-9]")
458 (delete-region (point-min) (1- (point)))))
460 (defalias 'vc-mcvs-annotate-current-time
'vc-cvs-annotate-current-time
)
461 (defalias 'vc-mcvs-annotate-time
'vc-cvs-annotate-time
)
467 (defun vc-mcvs-create-tag (dir name branchp
)
468 "Assign to DIR's current revision a given NAME.
469 If BRANCHP is non-nil, the name is created as a branch (and the current
470 workspace is immediately moved to that new branch)."
472 (vc-mcvs-command nil
0 dir
"tag" "-c" name
)
473 (vc-mcvs-command nil
0 dir
"branch" name
)
474 (vc-mcvs-command nil
0 dir
"switch" name
)))
476 (defun vc-mcvs-retrieve-tag (dir name update
)
477 "Retrieve a tag at and below DIR.
478 NAME is the name of the tag; if it is empty, do a `cvs update'.
479 If UPDATE is non-nil, then update (resynch) any affected buffers."
480 (with-current-buffer (get-buffer-create "*vc*")
481 (let ((default-directory dir
)
484 (if (or (not name
) (string= name
""))
485 (vc-mcvs-command t
0 nil
"update")
486 (vc-mcvs-command t
0 nil
"update" "-r" name
)
487 (setq sticky-tag name
))
489 (goto-char (point-min))
491 (if (looking-at "\\([CMUP]\\) \\(.*\\)")
492 (let* ((file (expand-file-name (match-string 2) dir
))
493 (state (match-string 1))
494 (buffer (find-buffer-visiting file
)))
497 ((or (string= state
"U")
499 (vc-file-setprop file
'vc-state
'up-to-date
)
500 (vc-file-setprop file
'vc-working-revision nil
)
501 (vc-file-setprop file
'vc-checkout-time
502 (nth 5 (file-attributes file
))))
503 ((or (string= state
"M")
505 (vc-file-setprop file
'vc-state
'edited
)
506 (vc-file-setprop file
'vc-working-revision nil
)
507 (vc-file-setprop file
'vc-checkout-time
0)))
508 (vc-file-setprop file
'vc-mcvs-sticky-tag sticky-tag
)
509 (vc-resynch-buffer file t t
))))
510 (forward-line 1))))))
517 (defalias 'vc-mcvs-make-version-backups-p
'vc-stay-local-p
518 "Return non-nil if version backups should be made for FILE.")
519 (defalias 'vc-mcvs-check-headers
'vc-cvs-check-headers
)
523 ;;; Internal functions
526 (defun vc-mcvs-command (buffer okstatus file
&rest flags
)
527 "A wrapper around `vc-do-command' for use in vc-mcvs.el.
528 The difference to vc-do-command is that this function always invokes `mcvs',
529 and that it passes `vc-mcvs-global-switches' to it before FLAGS."
530 (let ((args (append '("--error-terminate")
531 (if (stringp vc-mcvs-global-switches
)
532 (cons vc-mcvs-global-switches flags
)
533 (append vc-mcvs-global-switches flags
)))))
534 (if (not (member (car flags
) '("diff" "log" "status")))
535 ;; No need to filter: do it the easy way.
536 (apply 'vc-do-command
(or buffer
"*vc*") okstatus
"mcvs" file args
)
537 ;; We need to filter the output.
538 ;; The output of the filter uses filenames relative to the root,
539 ;; so we need to change the default-directory.
540 ;; (assert (equal default-directory (vc-mcvs-root file)))
542 (or buffer
"*vc*") okstatus
"sh" nil
"-c"
545 'shell-quote-argument
546 (append (remq nil args
)
547 (if file
(list (file-relative-name file
))))
551 (defun vc-mcvs-repository-hostname (dirname)
552 (vc-cvs-repository-hostname (vc-mcvs-root dirname
)))
554 (defun vc-mcvs-dir-state-heuristic (dir)
555 "Find the Meta-CVS state of all files in DIR, using only local information."
557 (vc-cvs-get-entries dir
)
558 (goto-char (point-min))
560 ;; Meta-MCVS-removed files are not taken under VC control.
561 (when (looking-at "/\\([^/]*\\)/[^/-]")
562 (let ((file (expand-file-name (match-string 1) dir
)))
563 (unless (vc-file-getprop file
'vc-state
)
564 (vc-cvs-parse-entry file t
))))
567 (defalias 'vc-mcvs-valid-symbolic-tag-name-p
'vc-cvs-valid-symbolic-tag-name-p
)
568 (defalias 'vc-mcvs-valid-revision-number-p
'vc-cvs-valid-revision-number-p
)
572 ;; arch-tag: a39c7c1c-5247-429d-88df-dd7187d2e704
573 ;;; vc-mcvs.el ends here