1 ;;; vc-mtn.el --- VC backend for Monotone -*- lexical-binding: t -*-
3 ;; Copyright (C) 2007-2012 Free Software Foundation, Inc.
5 ;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software: you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation, either version 3 of the License, or
14 ;; (at your option) any later version.
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
30 ;; - The `previous-version' VC method needs to be supported, 'D' in
31 ;; log-view-mode uses it.
35 (eval-when-compile (require 'vc
))
38 "VC Monotone (mtn) backend."
42 (defcustom vc-mtn-diff-switches t
43 "String or list of strings specifying switches for monotone diff under VC.
44 If nil, use the value of `vc-diff-switches'. If t, use no switches."
45 :type
'(choice (const :tag
"Unspecified" nil
)
47 (string :tag
"Argument String")
48 (repeat :tag
"Argument List" :value
("") string
))
52 (define-obsolete-variable-alias 'vc-mtn-command
'vc-mtn-program
"23.1")
53 (defcustom vc-mtn-program
"mtn"
54 "Name of the monotone executable."
58 ;; Clear up the cache to force vc-call to check again and discover
59 ;; new functions when we reload this file.
60 (put 'Mtn
'vc-functions nil
)
62 (unless (executable-find vc-mtn-program
)
63 ;; vc-mtn.el is 100% non-functional without the `mtn' executable.
64 (setq vc-handled-backends
(delq 'Mtn vc-handled-backends
)))
67 (defconst vc-mtn-admin-dir
"_MTN" "Name of the monotone directory.")
69 (defconst vc-mtn-admin-format
(concat vc-mtn-admin-dir
"/format")
70 "Name of the monotone directory's format file.")
72 ;;;###autoload (defun vc-mtn-registered (file)
73 ;;;###autoload (if (vc-find-root file vc-mtn-admin-format)
75 ;;;###autoload (load "vc-mtn")
76 ;;;###autoload (vc-mtn-registered file))))
78 (defun vc-mtn-revision-granularity () 'repository
)
79 (defun vc-mtn-checkout-model (_files) 'implicit
)
81 (defun vc-mtn-root (file)
82 (setq file
(if (file-directory-p file
)
83 (file-name-as-directory file
)
84 (file-name-directory file
)))
85 (or (vc-file-getprop file
'vc-mtn-root
)
86 (vc-file-setprop file
'vc-mtn-root
87 (vc-find-root file vc-mtn-admin-format
))))
90 (defun vc-mtn-registered (file)
91 (let ((root (vc-mtn-root file
)))
93 (vc-mtn-state file
))))
95 (defun vc-mtn-command (buffer okstatus files
&rest flags
)
96 "A wrapper around `vc-do-command' for use in vc-mtn.el."
97 (let ((process-environment
98 ;; Avoid localization of messages so we can parse the output.
99 (cons "LC_MESSAGES=C" process-environment
)))
100 (apply 'vc-do-command
(or buffer
"*vc*") okstatus vc-mtn-program
103 (defun vc-mtn-state (file)
104 ;; If `mtn' fails or returns status>0, or if the search files, just
108 (vc-mtn-command t
0 file
"status")
109 (goto-char (point-min))
111 "^ \\(?:\\(patched\\)\\|\\(added\\) \\(?:.*\\)\\)\\|no changes$")
112 (cond ((match-end 1) 'edited
)
113 ((match-end 2) 'added
)
116 (defun vc-mtn-after-dir-status (update-function)
118 (goto-char (point-min))
119 (re-search-forward "\\(?:Current b\\|B\\)ranch: *\\(.*\\)\n?\nChanges against parent \\(.*\\)" nil t
)
120 (while (re-search-forward
121 "^ \\(?:\\(patched \\)\\|\\(added \\)\\)\\(.*\\)$" nil t
)
122 (cond ((match-end 1) (push (list (match-string 3) 'edited
) result
))
123 ((match-end 2) (push (list (match-string 3) 'added
) result
))))
124 (funcall update-function result
)))
126 (defun vc-mtn-dir-status (dir update-function
)
127 (vc-mtn-command (current-buffer) 'async dir
"status")
129 `(vc-mtn-after-dir-status (quote ,update-function
))))
131 (defun vc-mtn-working-revision (file)
132 ;; If `mtn' fails or returns status>0, or if the search fails, just
136 (vc-mtn-command t
0 file
"status")
137 (goto-char (point-min))
138 (re-search-forward "\\(?:Current b\\|B\\)ranch: *\\(.*\\)\n?\nChanges against parent \\(.*\\)")
141 (defun vc-mtn-workfile-branch (file)
142 ;; If `mtn' fails or returns status>0, or if the search files, just
146 (vc-mtn-command t
0 file
"status")
147 (goto-char (point-min))
148 (re-search-forward "\\(?:Current b\\|B\\)ranch: *\\(.*\\)\n?\nChanges against parent \\(.*\\)")
151 (defun vc-mtn-workfile-unchanged-p (file)
152 (not (eq (vc-mtn-state file
) 'edited
)))
154 ;; Mode-line rewrite code copied from vc-arch.el.
156 (defcustom vc-mtn-mode-line-rewrite
157 '(("\\`[^:/#]*[:/#]" .
"")) ;Drop the host part.
158 "Rewrite rules to shorten Mtn's revision names on the mode-line."
159 :type
'(repeat (cons regexp string
))
163 (defun vc-mtn-mode-line-string (file)
164 "Return a string for `vc-mode-line' to put in the mode line for FILE."
165 (let ((branch (vc-mtn-workfile-branch file
)))
166 (dolist (rule vc-mtn-mode-line-rewrite
)
167 (if (string-match (car rule
) branch
)
168 (setq branch
(replace-match (cdr rule
) t nil branch
))))
170 (pcase (vc-state file
)
171 ((or `up-to-date
`needs-update
) ?-
)
176 (defun vc-mtn-register (files &optional _rev _comment
)
177 (vc-mtn-command nil
0 files
"add"))
179 (defun vc-mtn-responsible-p (file) (vc-mtn-root file
))
180 (defun vc-mtn-could-register (file) (vc-mtn-root file
))
182 (declare-function log-edit-extract-headers
"log-edit" (headers string
))
184 (defun vc-mtn-checkin (files _rev comment
)
185 (apply 'vc-mtn-command nil
0 files
186 (nconc (list "commit" "-m")
187 (log-edit-extract-headers '(("Author" .
"--author")
191 (defun vc-mtn-find-revision (file rev buffer
)
192 (vc-mtn-command buffer
0 file
"cat" "-r" rev
))
194 ;; (defun vc-mtn-checkout (file &optional editable rev)
197 (defun vc-mtn-revert (file &optional contents-done
)
198 (unless contents-done
199 (vc-mtn-command nil
0 file
"revert")))
201 ;; (defun vc-mtn-rollback (files)
204 (defun vc-mtn-print-log (files buffer
&optional _shortlog start-revision limit
)
205 (apply 'vc-mtn-command buffer
0 files
"log"
207 (when start-revision
(list "--from" (format "%s" start-revision
)))
208 (when limit
(list "--last" (format "%s" limit
))))))
210 (defvar log-view-message-re
)
211 (defvar log-view-file-re
)
212 (defvar log-view-font-lock-keywords
)
213 (defvar log-view-per-file-logs
)
215 (define-derived-mode vc-mtn-log-view-mode log-view-mode
"Mtn-Log-View"
216 ;; Don't match anything.
217 (set (make-local-variable 'log-view-file-re
) "\\`a\\`")
218 (set (make-local-variable 'log-view-per-file-logs
) nil
)
219 ;; TODO: Use a more precise regexp than "[ |/]+" to avoid false positives
220 ;; in the ChangeLog text.
221 (set (make-local-variable 'log-view-message-re
)
222 "^[ |/]+Revision: \\([0-9a-f]+\\)")
223 (require 'add-log
) ;For change-log faces.
224 (set (make-local-variable 'log-view-font-lock-keywords
)
225 (append log-view-font-lock-keywords
226 '(("^[ |]+Author: \\(.*\\)" (1 'change-log-email
))
227 ("^[ |]+Date: \\(.*\\)" (1 'change-log-date-face
))))))
229 ;; (defun vc-mtn-show-log-entry (revision)
232 (defun vc-mtn-diff (files &optional rev1 rev2 buffer
)
233 "Get a difference report using monotone between two revisions of FILES."
234 (apply 'vc-mtn-command
(or buffer
"*vc-diff*") 1 files
"diff"
236 (vc-switches 'mtn
'diff
)
237 (if rev1
(list "-r" rev1
)) (if rev2
(list "-r" rev2
)))))
239 (defun vc-mtn-annotate-command (file buf
&optional rev
)
240 (apply 'vc-mtn-command buf
'async file
"annotate"
241 (if rev
(list "-r" rev
))))
243 (declare-function vc-annotate-convert-time
"vc-annotate" (time))
245 (defconst vc-mtn-annotate-full-re
246 "^ *\\([0-9a-f]+\\)\\.* by [^ ]+ \\([0-9]+\\)-\\([0-9]+\\)-\\([0-9]+\\): ")
247 (defconst vc-mtn-annotate-any-re
248 (concat "^\\(?: +: \\|" vc-mtn-annotate-full-re
"\\)"))
250 (defun vc-mtn-annotate-time ()
251 (when (looking-at vc-mtn-annotate-any-re
)
252 (goto-char (match-end 0))
253 (let ((year (match-string 2)))
255 ;; Look for the date on a previous line.
257 (get-text-property (1- (previous-single-property-change
258 (point) 'vc-mtn-time nil
(point-min)))
260 (let ((time (vc-annotate-convert-time
262 (string-to-number (match-string 4))
263 (string-to-number (match-string 3))
264 (string-to-number year
)
266 (let ((inhibit-read-only t
)
267 (inhibit-modification-hooks t
))
268 (put-text-property (match-beginning 0) (match-end 0)
272 (defun vc-mtn-annotate-extract-revision-at-line ()
274 (when (or (looking-at vc-mtn-annotate-full-re
)
275 (re-search-backward vc-mtn-annotate-full-re nil t
))
278 ;;; Revision completion.
280 (defun vc-mtn-list-tags ()
282 (vc-mtn-command t
0 nil
"list" "tags")
283 (goto-char (point-min))
285 (while (re-search-forward "^[^ ]+" nil t
)
286 (push (match-string 0) tags
))
289 (defun vc-mtn-list-branches ()
291 (vc-mtn-command t
0 nil
"list" "branches")
292 (goto-char (point-min))
294 (while (re-search-forward "^.+" nil t
)
295 (push (match-string 0) branches
))
298 (defun vc-mtn-list-revision-ids (prefix)
300 (vc-mtn-command t
0 nil
"complete" "revision" prefix
)
301 (goto-char (point-min))
303 (while (re-search-forward "^.+" nil t
)
304 (push (match-string 0) ids
))
307 (defun vc-mtn-revision-completion-table (_files)
308 ;; TODO: Implement completion for selectors
309 ;; TODO: Implement completion for composite selectors.
310 ;; What about using `files'?!? --Stef
311 (lambda (string pred action
)
314 ((string-match "\\`t:" string
)
315 (complete-with-action action
316 (mapcar (lambda (tag) (concat "t:" tag
))
319 ;; "Branch" selectors.
320 ((string-match "\\`b:" string
)
321 (complete-with-action action
322 (mapcar (lambda (tag) (concat "b:" tag
))
323 (vc-mtn-list-branches))
325 ;; "Head" selectors. Not sure how they differ from "branch" selectors.
326 ((string-match "\\`h:" string
)
327 (complete-with-action action
328 (mapcar (lambda (tag) (concat "h:" tag
))
329 (vc-mtn-list-branches))
332 ((string-match "\\`i:" string
)
333 (complete-with-action action
334 (mapcar (lambda (tag) (concat "i:" tag
))
335 (vc-mtn-list-revision-ids
336 (substring string
(match-end 0))))
339 (complete-with-action action
340 '("t:" "b:" "h:" "i:"
341 ;; Completion not implemented for these.
342 "a:" "c:" "d:" "e:" "l:")
349 ;;; vc-mtn.el ends here