1 ;;; vc-mtn.el --- VC backend for Monotone -*- lexical-binding: t -*-
3 ;; Copyright (C) 2007-2013 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" nil t)
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))))
89 (defun vc-mtn-find-admin-dir (file)
90 "Return the administrative directory of FILE."
91 (expand-file-name vc-mtn-admin-dir (vc-mtn-root file)))
93 (defun vc-mtn-registered (file)
94 (let ((root (vc-mtn-root file)))
96 (vc-mtn-state file))))
98 (defun vc-mtn-command (buffer okstatus files &rest flags)
99 "A wrapper around `vc-do-command' for use in vc-mtn.el."
100 (let ((process-environment
101 ;; Avoid localization of messages so we can parse the output.
102 (cons "LC_MESSAGES=C" process-environment)))
103 (apply 'vc-do-command (or buffer "*vc*") okstatus vc-mtn-program
106 (defun vc-mtn-state (file)
107 ;; If `mtn' fails or returns status>0, or if the search files, just
111 (vc-mtn-command t 0 file "status")
112 (goto-char (point-min))
114 "^ \\(?:\\(patched\\)\\|\\(added\\) \\(?:.*\\)\\)\\|no changes$")
115 (cond ((match-end 1) 'edited)
116 ((match-end 2) 'added)
119 (defun vc-mtn-after-dir-status (update-function)
121 (goto-char (point-min))
122 (re-search-forward "\\(?:Current b\\|B\\)ranch: *\\(.*\\)\n?\nChanges against parent \\(.*\\)" nil t)
123 (while (re-search-forward
124 "^ \\(?:\\(patched \\)\\|\\(added \\)\\)\\(.*\\)$" nil t)
125 (cond ((match-end 1) (push (list (match-string 3) 'edited) result))
126 ((match-end 2) (push (list (match-string 3) 'added) result))))
127 (funcall update-function result)))
129 ;; -dir-status called from vc-dir, which loads vc, which loads vc-dispatcher.
130 (declare-function vc-exec-after "vc-dispatcher" (code))
132 (defun vc-mtn-dir-status (dir update-function)
133 (vc-mtn-command (current-buffer) 'async dir "status")
135 (vc-mtn-after-dir-status update-function)))
137 (defun vc-mtn-working-revision (file)
138 ;; If `mtn' fails or returns status>0, or if the search fails, just
142 (vc-mtn-command t 0 file "status")
143 (goto-char (point-min))
144 (re-search-forward "\\(?:Current b\\|B\\)ranch: *\\(.*\\)\n?\nChanges against parent \\(.*\\)")
147 (defun vc-mtn-workfile-branch (file)
148 ;; If `mtn' fails or returns status>0, or if the search files, just
152 (vc-mtn-command t 0 file "status")
153 (goto-char (point-min))
154 (re-search-forward "\\(?:Current b\\|B\\)ranch: *\\(.*\\)\n?\nChanges against parent \\(.*\\)")
157 (defun vc-mtn-workfile-unchanged-p (file)
158 (not (eq (vc-mtn-state file) 'edited)))
160 ;; Mode-line rewrite code copied from vc-arch.el.
162 (defcustom vc-mtn-mode-line-rewrite
163 '(("\\`[^:/#]*[:/#]" . "")) ;Drop the host part.
164 "Rewrite rules to shorten Mtn's revision names on the mode-line."
165 :type '(repeat (cons regexp string))
169 (defun vc-mtn-mode-line-string (file)
170 "Return a string for `vc-mode-line' to put in the mode line for FILE."
171 (let ((branch (vc-mtn-workfile-branch file)))
172 (dolist (rule vc-mtn-mode-line-rewrite)
173 (if (string-match (car rule) branch)
174 (setq branch (replace-match (cdr rule) t nil branch))))
176 (pcase (vc-state file)
177 ((or `up-to-date `needs-update) ?-)
182 (defun vc-mtn-register (files &optional _rev _comment)
183 (vc-mtn-command nil 0 files "add"))
185 (defun vc-mtn-responsible-p (file) (vc-mtn-root file))
186 (defun vc-mtn-could-register (file) (vc-mtn-root file))
188 (declare-function log-edit-extract-headers "log-edit" (headers string))
190 (defun vc-mtn-checkin (files _rev comment)
191 (apply 'vc-mtn-command nil 0 files
192 (nconc (list "commit" "-m")
193 (log-edit-extract-headers '(("Author" . "--author")
197 (defun vc-mtn-find-revision (file rev buffer)
198 (vc-mtn-command buffer 0 file "cat" "-r" rev))
200 ;; (defun vc-mtn-checkout (file &optional editable rev)
203 (defun vc-mtn-revert (file &optional contents-done)
204 (unless contents-done
205 (vc-mtn-command nil 0 file "revert")))
207 ;; (defun vc-mtn-rollback (files)
210 (defun vc-mtn-print-log (files buffer &optional _shortlog start-revision limit)
211 "Print commit logs associated with FILES into specified BUFFER.
212 _SHORTLOG is ignored.
213 If START-REVISION is non-nil, it is the newest revision to show.
214 If LIMIT is non-nil, show no more than this many entries."
215 (apply 'vc-mtn-command buffer 0 files "log"
217 (when start-revision (list "--from" (format "%s" start-revision)))
218 (when limit (list "--last" (format "%s" limit))))))
220 (defvar log-view-message-re)
221 (defvar log-view-file-re)
222 (defvar log-view-font-lock-keywords)
223 (defvar log-view-per-file-logs)
225 (define-derived-mode vc-mtn-log-view-mode log-view-mode "Mtn-Log-View"
226 ;; Don't match anything.
227 (set (make-local-variable 'log-view-file-re) "\\`a\\`")
228 (set (make-local-variable 'log-view-per-file-logs) nil)
229 ;; TODO: Use a more precise regexp than "[ |/]+" to avoid false positives
230 ;; in the ChangeLog text.
231 (set (make-local-variable 'log-view-message-re)
232 "^[ |/]+Revision: \\([0-9a-f]+\\)")
233 (require 'add-log) ;For change-log faces.
234 (set (make-local-variable 'log-view-font-lock-keywords)
235 (append log-view-font-lock-keywords
236 '(("^[ |]+Author: \\(.*\\)" (1 'change-log-email))
237 ("^[ |]+Date: \\(.*\\)" (1 'change-log-date-face))))))
239 ;; (defun vc-mtn-show-log-entry (revision)
242 (autoload 'vc-switches "vc")
244 (defun vc-mtn-diff (files &optional rev1 rev2 buffer)
245 "Get a difference report using monotone between two revisions of FILES."
246 (apply 'vc-mtn-command (or buffer "*vc-diff*") 1 files "diff"
248 (vc-switches 'mtn 'diff)
249 (if rev1 (list "-r" rev1)) (if rev2 (list "-r" rev2)))))
251 (defun vc-mtn-annotate-command (file buf &optional rev)
252 (apply 'vc-mtn-command buf 'async file "annotate"
253 (if rev (list "-r" rev))))
255 (declare-function vc-annotate-convert-time "vc-annotate" (time))
257 (defconst vc-mtn-annotate-full-re
258 "^ *\\([0-9a-f]+\\)\\.* by [^ ]+ \\([0-9]+\\)-\\([0-9]+\\)-\\([0-9]+\\): ")
259 (defconst vc-mtn-annotate-any-re
260 (concat "^\\(?: +: \\|" vc-mtn-annotate-full-re "\\)"))
262 (defun vc-mtn-annotate-time ()
263 (when (looking-at vc-mtn-annotate-any-re)
264 (goto-char (match-end 0))
265 (let ((year (match-string 2)))
267 ;; Look for the date on a previous line.
269 (get-text-property (1- (previous-single-property-change
270 (point) 'vc-mtn-time nil (point-min)))
272 (let ((time (vc-annotate-convert-time
274 (string-to-number (match-string 4))
275 (string-to-number (match-string 3))
276 (string-to-number year)
278 (let ((inhibit-read-only t)
279 (inhibit-modification-hooks t))
280 (put-text-property (match-beginning 0) (match-end 0)
284 (defun vc-mtn-annotate-extract-revision-at-line ()
286 (when (or (looking-at vc-mtn-annotate-full-re)
287 (re-search-backward vc-mtn-annotate-full-re nil t))
290 ;;; Revision completion.
292 (defun vc-mtn-list-tags ()
294 (vc-mtn-command t 0 nil "list" "tags")
295 (goto-char (point-min))
297 (while (re-search-forward "^[^ ]+" nil t)
298 (push (match-string 0) tags))
301 (defun vc-mtn-list-branches ()
303 (vc-mtn-command t 0 nil "list" "branches")
304 (goto-char (point-min))
306 (while (re-search-forward "^.+" nil t)
307 (push (match-string 0) branches))
310 (defun vc-mtn-list-revision-ids (prefix)
312 (vc-mtn-command t 0 nil "complete" "revision" prefix)
313 (goto-char (point-min))
315 (while (re-search-forward "^.+" nil t)
316 (push (match-string 0) ids))
319 (defun vc-mtn-revision-completion-table (_files)
320 ;; What about using `files'?!? --Stef
321 (lambda (string pred action)
323 ;; Special chars for composite selectors.
324 ((string-match ".*[^\\]\\(\\\\\\\\\\)*[/|;(]" string)
325 (completion-table-with-context (substring string 0 (match-end 0))
326 (vc-mtn-revision-completion-table nil)
327 (substring string (match-end 0))
330 ((string-match "\\`t:" string)
331 (complete-with-action action
332 (mapcar (lambda (tag) (concat "t:" tag))
335 ;; "Branch" or "Head" selectors.
336 ((string-match "\\`[hb]:" string)
337 (let ((prefix (match-string 0 string)))
338 (complete-with-action action
339 (mapcar (lambda (tag) (concat prefix tag))
340 (vc-mtn-list-branches))
343 ((string-match "\\`i:" string)
344 (complete-with-action action
345 (mapcar (lambda (tag) (concat "i:" tag))
346 (vc-mtn-list-revision-ids
347 (substring string (match-end 0))))
350 (complete-with-action action
351 '("t:" "b:" "h:" "i:"
352 ;; Completion not implemented for these.
353 "c:" "a:" "k:" "d:" "m:" "e:" "l:" "i:" "p:"
354 ;; These have no arg to complete.
356 ;; Selector functions.
357 "difference(" "lca(" "max(" "ancestors("
358 "descendants(" "parents(" "children("
366 ;;; vc-mtn.el ends here