lisp/vc-mtn.el

   1 ;;; vc-mtn.el --- VC backend for Monotone
   2
   3 ;; Copyright (C) 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
   4
   5 ;; Author: Stefan Monnier <monnier@iro.umontreal.ca>
   6 ;; Keywords:
   7
   8 ;; This file is part of GNU Emacs.
   9
  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.
  14
  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.
  19
  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/>.
  22
  23 ;;; Commentary:
  24
  25 ;;
  26
  27 ;;; TODO:
  28
  29 ;; - The `previous-version' VC method needs to be supported, 'D' in
  30 ;;   log-view-mode uses it.
  31
  32 ;;; Code:
  33
  34 (eval-when-compile (require 'cl) (require 'vc))
  35
  36 (defcustom vc-mtn-diff-switches t
  37   "String or list of strings specifying switches for monotone diff under VC.
  38 If nil, use the value of `vc-diff-switches'.  If t, use no switches."
  39   :type '(choice (const :tag "Unspecified" nil)
  40                  (const :tag "None" t)
  41                  (string :tag "Argument String")
  42                  (repeat :tag "Argument List" :value ("") string))
  43   :version "23.1"
  44   :group 'vc)
  45
  46 (define-obsolete-variable-alias 'vc-mtn-command 'vc-mtn-program "23.1")
  47 (defcustom vc-mtn-program "mtn"
  48   "Name of the monotone executable."
  49   :type 'string
  50   :group 'vc)
  51
  52 ;; Clear up the cache to force vc-call to check again and discover
  53 ;; new functions when we reload this file.
  54 (put 'Mtn 'vc-functions nil)
  55
  56 (unless (executable-find vc-mtn-program)
  57   ;; vc-mtn.el is 100% non-functional without the `mtn' executable.
  58   (setq vc-handled-backends (delq 'Mtn vc-handled-backends)))
  59
  60 ;;;###autoload
  61 (defconst vc-mtn-admin-dir "_MTN")
  62 ;;;###autoload
  63 (defconst vc-mtn-admin-format (concat vc-mtn-admin-dir "/format"))
  64
  65 ;;;###autoload (defun vc-mtn-registered (file)
  66 ;;;###autoload   (if (vc-find-root file vc-mtn-admin-format)
  67 ;;;###autoload       (progn
  68 ;;;###autoload         (load "vc-mtn")
  69 ;;;###autoload         (vc-mtn-registered file))))
  70
  71 (defun vc-mtn-revision-granularity () 'repository)
  72 (defun vc-mtn-checkout-model (files) 'implicit)
  73
  74 (defun vc-mtn-root (file)
  75   (setq file (if (file-directory-p file)
  76                  (file-name-as-directory file)
  77                (file-name-directory file)))
  78   (or (vc-file-getprop file 'vc-mtn-root)
  79       (vc-file-setprop file 'vc-mtn-root
  80                        (vc-find-root file vc-mtn-admin-format))))
  81
  82
  83 (defun vc-mtn-registered (file)
  84   (let ((root (vc-mtn-root file)))
  85     (when root
  86       (vc-mtn-state file))))
  87
  88 (defun vc-mtn-command (buffer okstatus files &rest flags)
  89   "A wrapper around `vc-do-command' for use in vc-mtn.el."
  90   (let ((process-environment
  91          ;; Avoid localization of messages so we can parse the output.
  92          (cons "LC_MESSAGES=C" process-environment)))
  93     (apply 'vc-do-command (or buffer "*vc*") okstatus vc-mtn-program
  94            files flags)))
  95
  96 (defun vc-mtn-state (file)
  97   ;; If `mtn' fails or returns status>0, or if the search files, just
  98   ;; return nil.
  99   (ignore-errors
 100     (with-temp-buffer
 101       (vc-mtn-command t 0 file "status")
 102       (goto-char (point-min))
 103       (re-search-forward
 104        "^  \\(?:\\(patched\\)\\|\\(added\\) \\(?:.*\\)\\)\\|no changes$")
 105       (cond  ((match-end 1) 'edited)
 106              ((match-end 2) 'added)
 107              (t 'up-to-date)))))
 108
 109 (defun vc-mtn-after-dir-status (update-function)
 110   (let (result)
 111     (goto-char (point-min))
 112     (re-search-forward "Current branch: \\(.*\\)\nChanges against parent \\(.*\\)" nil t)
 113     (while (re-search-forward
 114             "^  \\(?:\\(patched  \\)\\|\\(added    \\)\\)\\(.*\\)$" nil t)
 115       (cond  ((match-end 1) (push (list (match-string 3) 'edited) result))
 116              ((match-end 2) (push (list (match-string 3) 'added) result))))
 117     (funcall update-function result)))
 118
 119 (defun vc-mtn-dir-status (dir update-function)
 120   (vc-mtn-command (current-buffer) 'async dir "status")
 121   (vc-exec-after
 122    `(vc-mtn-after-dir-status (quote ,update-function))))
 123
 124 (defun vc-mtn-working-revision (file)
 125   ;; If `mtn' fails or returns status>0, or if the search fails, just
 126   ;; return nil.
 127   (ignore-errors
 128     (with-temp-buffer
 129       (vc-mtn-command t 0 file "status")
 130       (goto-char (point-min))
 131       (re-search-forward "Current branch: \\(.*\\)\nChanges against parent \\(.*\\)")
 132       (match-string 2))))
 133
 134 (defun vc-mtn-workfile-branch (file)
 135   ;; If `mtn' fails or returns status>0, or if the search files, just
 136   ;; return nil.
 137   (ignore-errors
 138     (with-temp-buffer
 139       (vc-mtn-command t 0 file "status")
 140       (goto-char (point-min))
 141       (re-search-forward "Current branch: \\(.*\\)\nChanges against parent \\(.*\\)")
 142       (match-string 1))))
 143
 144 (defun vc-mtn-workfile-unchanged-p (file)
 145   (not (eq (vc-mtn-state file) 'edited)))
 146
 147 ;; Mode-line rewrite code copied from vc-arch.el.
 148
 149 (defcustom vc-mtn-mode-line-rewrite
 150   '(("\\`[^:/#]*[:/#]" . ""))           ;Drop the host part.
 151   "Rewrite rules to shorten Mtn's revision names on the mode-line."
 152   :type '(repeat (cons regexp string))
 153   :version "22.2"
 154   :group 'vc)
 155
 156 (defun vc-mtn-mode-line-string (file)
 157   "Return string for placement in modeline by `vc-mode-line' for FILE."
 158   (let ((branch (vc-mtn-workfile-branch file)))
 159     (dolist (rule vc-mtn-mode-line-rewrite)
 160       (if (string-match (car rule) branch)
 161           (setq branch (replace-match (cdr rule) t nil branch))))
 162     (format "Mtn%c%s"
 163             (case (vc-state file)
 164               ((up-to-date needs-update) ?-)
 165               (added ?@)
 166               (t ?:))
 167             branch)))
 168
 169 (defun vc-mtn-register (files &optional rev comment)
 170   (vc-mtn-command nil 0 files "add"))
 171
 172 (defun vc-mtn-responsible-p (file) (vc-mtn-root file))
 173 (defun vc-mtn-could-register (file) (vc-mtn-root file))
 174
 175 (declare-function log-edit-extract-headers "log-edit" (headers string))
 176
 177 (defun vc-mtn-checkin (files rev comment)
 178   (apply 'vc-mtn-command nil 0 files
 179          (nconc (list "commit" "-m")
 180                 (log-edit-extract-headers '(("Author" . "--author")
 181                                             ("Date" . "--date"))
 182                                           comment))))
 183
 184 (defun vc-mtn-find-revision (file rev buffer)
 185   (vc-mtn-command buffer 0 file "cat" "-r" rev))
 186
 187 ;; (defun vc-mtn-checkout (file &optional editable rev)
 188 ;;   )
 189
 190 (defun vc-mtn-revert (file &optional contents-done)
 191   (unless contents-done
 192     (vc-mtn-command nil 0 file "revert")))
 193
 194 ;; (defun vc-mtn-roolback (files)
 195 ;;   )
 196
 197 (defun vc-mtn-print-log (files buffer &optional shortlog start-revision limit)
 198   (apply 'vc-mtn-command buffer 0 files "log"
 199          (append
 200           (when start-revision (list "--from" (format "%s" start-revision)))
 201           (when limit (list "--last" (format "%s" limit))))))
 202
 203 (defvar log-view-message-re)
 204 (defvar log-view-file-re)
 205 (defvar log-view-font-lock-keywords)
 206 (defvar log-view-per-file-logs)
 207
 208 (define-derived-mode vc-mtn-log-view-mode log-view-mode "Mtn-Log-View"
 209   ;; Don't match anything.
 210   (set (make-local-variable 'log-view-file-re) "\\`a\\`")
 211   (set (make-local-variable 'log-view-per-file-logs) nil)
 212   ;; TODO: Use a more precise regexp than "[ |/]+" to avoid false positives
 213   ;; in the ChangeLog text.
 214   (set (make-local-variable 'log-view-message-re)
 215        "^[ |/]+Revision: \\([0-9a-f]+\\)")
 216   (require 'add-log)                    ;For change-log faces.
 217   (set (make-local-variable 'log-view-font-lock-keywords)
 218        (append log-view-font-lock-keywords
 219                '(("^[ |]+Author: \\(.*\\)" (1 'change-log-email))
 220                  ("^[ |]+Date: \\(.*\\)" (1 'change-log-date-face))))))
 221
 222 ;; (defun vc-mtn-show-log-entry (revision)
 223 ;;   )
 224
 225 (defun vc-mtn-diff (files &optional rev1 rev2 buffer)
 226   "Get a difference report using monotone between two revisions of FILES."
 227   (apply 'vc-mtn-command (or buffer "*vc-diff*") 1 files "diff"
 228          (append
 229            (vc-switches 'mtn 'diff)
 230            (if rev1 (list "-r" rev1)) (if rev2 (list "-r" rev2)))))
 231
 232 (defun vc-mtn-annotate-command (file buf &optional rev)
 233   (apply 'vc-mtn-command buf 'async file "annotate"
 234          (if rev (list "-r" rev))))
 235
 236 (declare-function vc-annotate-convert-time "vc-annotate" (time))
 237
 238 (defconst vc-mtn-annotate-full-re
 239   "^ *\\([0-9a-f]+\\)\\.* by [^ ]+ \\([0-9]+\\)-\\([0-9]+\\)-\\([0-9]+\\): ")
 240 (defconst vc-mtn-annotate-any-re
 241   (concat "^\\(?: +: \\|" vc-mtn-annotate-full-re "\\)"))
 242
 243 (defun vc-mtn-annotate-time ()
 244   (when (looking-at vc-mtn-annotate-any-re)
 245     (goto-char (match-end 0))
 246     (let ((year (match-string 2)))
 247       (if (not year)
 248           ;; Look for the date on a previous line.
 249           (save-excursion
 250             (get-text-property (1- (previous-single-property-change
 251                                     (point) 'vc-mtn-time nil (point-min)))
 252                                'vc-mtn-time))
 253         (let ((time (vc-annotate-convert-time
 254                      (encode-time 0 0 0
 255                                   (string-to-number (match-string 4))
 256                                   (string-to-number (match-string 3))
 257                                   (string-to-number year)
 258                                   t))))
 259           (let ((inhibit-read-only t)
 260                 (inhibit-modification-hooks t))
 261             (put-text-property (match-beginning 0) (match-end 0)
 262                                'vc-mtn-time time))
 263           time)))))
 264
 265 (defun vc-mtn-annotate-extract-revision-at-line ()
 266   (save-excursion
 267     (when (or (looking-at vc-mtn-annotate-full-re)
 268               (re-search-backward vc-mtn-annotate-full-re nil t))
 269       (match-string 1))))
 270
 271 ;;; Revision completion.
 272
 273 (defun vc-mtn-list-tags ()
 274   (with-temp-buffer
 275     (vc-mtn-command t 0 nil "list" "tags")
 276     (goto-char (point-min))
 277     (let ((tags ()))
 278       (while (re-search-forward "^[^ ]+" nil t)
 279         (push (match-string 0) tags))
 280       tags)))
 281
 282 (defun vc-mtn-list-branches ()
 283   (with-temp-buffer
 284     (vc-mtn-command t 0 nil "list" "branches")
 285     (goto-char (point-min))
 286     (let ((branches ()))
 287       (while (re-search-forward "^.+" nil t)
 288         (push (match-string 0) branches))
 289       branches)))
 290
 291 (defun vc-mtn-list-revision-ids (prefix)
 292   (with-temp-buffer
 293     (vc-mtn-command t 0 nil "complete" "revision" prefix)
 294     (goto-char (point-min))
 295     (let ((ids ()))
 296       (while (re-search-forward "^.+" nil t)
 297         (push (match-string 0) ids))
 298       ids)))
 299
 300 (defun vc-mtn-revision-completion-table (files)
 301   ;; TODO: Implement completion for for selectors
 302   ;; TODO: Implement completion for composite selectors.
 303   (lexical-let ((files files))
 304     ;; What about using `files'?!?  --Stef
 305     (lambda (string pred action)
 306       (cond
 307        ;; "Tag" selectors.
 308        ((string-match "\\`t:" string)
 309         (complete-with-action action
 310                               (mapcar (lambda (tag) (concat "t:" tag))
 311                                       (vc-mtn-list-tags))
 312                               string pred))
 313        ;; "Branch" selectors.
 314        ((string-match "\\`b:" string)
 315         (complete-with-action action
 316                               (mapcar (lambda (tag) (concat "b:" tag))
 317                                       (vc-mtn-list-branches))
 318                               string pred))
 319        ;; "Head" selectors.  Not sure how they differ from "branch" selectors.
 320        ((string-match "\\`h:" string)
 321         (complete-with-action action
 322                               (mapcar (lambda (tag) (concat "h:" tag))
 323                                       (vc-mtn-list-branches))
 324                               string pred))
 325        ;; "ID" selectors.
 326        ((string-match "\\`i:" string)
 327         (complete-with-action action
 328                               (mapcar (lambda (tag) (concat "i:" tag))
 329                                       (vc-mtn-list-revision-ids
 330                                        (substring string (match-end 0))))
 331                               string pred))
 332        (t
 333         (complete-with-action action
 334                               '("t:" "b:" "h:" "i:"
 335                                 ;; Completion not implemented for these.
 336                                 "a:" "c:" "d:" "e:" "l:")
 337                               string pred))))))
 338
 339
 340
 341 (provide 'vc-mtn)
 342
 343 ;; arch-tag: 2b89ffbc-cbb8-405a-9080-2eafd4becb70
 344 ;;; vc-mtn.el ends here