vc-hg.el 8.49 KB
Newer Older
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1 2
;;; vc-hg.el --- VC backend for the mercurial version control system

3 4
;; Copyright (C) 2006, 2007 Free Software Foundation, Inc.

Dan Nicolaescu's avatar
Dan Nicolaescu committed
5
;; Author: Ivan Kanis
6 7
;; Keywords: tools
;; Version: 1889
8 9 10 11

;; This file is part of GNU Emacs.

;; GNU Emacs is free software; you can redistribute it and/or modify
Dan Nicolaescu's avatar
Dan Nicolaescu committed
12
;; it under the terms of the GNU General Public License as published by
13 14 15 16 17 18 19 20
;; the Free Software Foundation; either version 2, or (at your option)
;; any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

Dan Nicolaescu's avatar
Dan Nicolaescu committed
21
;; You should have received a copy of the GNU General Public License
22 23 24
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.
Dan Nicolaescu's avatar
Dan Nicolaescu committed
25 26 27 28 29

;;; Commentary:

;; This is a mercurial version control backend

30 31 32 33 34 35 36 37
;;; Thanks:

;;; Bugs:

;;; Installation:

;;; Todo:

Dan Nicolaescu's avatar
Dan Nicolaescu committed
38 39 40
;; Implement the rest of the vc interface:
;; - dired
;; - snapshot?
Dan Nicolaescu's avatar
Dan Nicolaescu committed
41

42 43 44 45 46 47 48 49 50 51
;; Implement Stefan Monnier's advice: 
;; vc-hg-registered and vc-hg-state
;; Both of those functions should be super extra careful to fail gracefully in
;; unexpected circumstances.  The most important such case is when the `hg'
;; executable is not available.  The reason this is important is that any error
;; there will prevent the user from even looking at the file :-(
;; Ideally, just like in vc-arch and vc-cvs, checking that the file is under
;; mercurial's control and extracting the current revision should be done
;; without even using `hg' (this way even if you don't have `hg' installed,
;; Emacs is able to tell you this file is under mercurial's control).
Dan Nicolaescu's avatar
Dan Nicolaescu committed
52

53 54
;;; History:
;; 
Dan Nicolaescu's avatar
Dan Nicolaescu committed
55 56 57 58 59 60

;;; Code:

(eval-when-compile
  (require 'vc))

61 62 63
;; XXX This should be moved to vc-hooks when the full vc interface is
;; implemented.
(add-to-list 'vc-handled-backends 'HG)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
64 65 66 67 68 69 70 71 72 73

;;; Customization options

(defcustom vc-hg-global-switches nil
  "*Global switches to pass to any Hg command."
  :type '(choice (const :tag "None" nil)
         (string :tag "Argument String")
         (repeat :tag "Argument List"
             :value ("")
             string))
74
;;  :version "22.2"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
75 76 77 78
  :group 'vc)

;;; State querying functions

79
;;; Modelled after the similar function in vc-bzr.el
Dan Nicolaescu's avatar
Dan Nicolaescu committed
80
(defun vc-hg-registered (file)
81 82 83
  "Return non-nil if FILE is registered with hg."
  (if (vc-find-root file ".hg")       ; short cut
      (vc-hg-state file)))            ; expensive
Dan Nicolaescu's avatar
Dan Nicolaescu committed
84 85

(defun vc-hg-state (file)
86
  "Hg-specific version of `vc-state'."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
87 88 89 90 91
  (let ((out (vc-hg-internal-status file)))
    (if (eq 0 (length out)) 'up-to-date
      (let ((state (aref out 0)))
        (cond
         ((eq state ?M) 'edited)
92
         ((eq state ?A) 'edited)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
93
         ((eq state ?P) 'needs-patch)
94
	 ((eq state ??) nil)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
95 96 97
         (t 'up-to-date))))))

(defun vc-hg-workfile-version (file)
98
  "Hg-specific version of `vc-workfile-version'."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
99 100 101 102 103 104 105 106 107
  (let ((out (vc-hg-internal-log file)))
    (if (string-match "changeset: *\\([0-9]*\\)" out)
        (match-string 1 out)
      "0")))

;;; History functions

(defun vc-hg-print-log(file &optional buffer)
  "Get change log associated with FILE."
108 109 110 111 112 113 114 115 116 117 118 119 120
  ;; `log-view-mode' needs to have the file name in order to function
  ;; correctly. "hg log" does not print it, so we insert it here by
  ;; hand.

  ;; `vc-do-command' creates the buffer, but we need it before running
  ;; the command.
  (vc-setup-buffer buffer)
  ;; If the buffer exists from a previous invocation it might be
  ;; read-only.
  (let ((inhibit-read-only t))
    (with-current-buffer
	buffer
      (insert "File:        " (file-name-nondirectory file) "\n")))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
121 122 123 124 125
  (vc-hg-command
   buffer
   (if (and (vc-stay-local-p file) (fboundp 'start-process)) 'async 0)
   file "log"))

126 127 128 129 130 131 132 133
(defvar log-view-message-re)
(defvar log-view-file-re)
(defvar log-view-font-lock-keywords)
(defvar log-view-current-tag-function)

(define-derived-mode vc-hg-log-view-mode log-view-mode "HG-Log-View"
  (require 'add-log) ;; we need the faces add-log
  ;; Don't have file markers, so use impossible regexp.
134
  (set (make-local-variable 'log-view-file-re) "^File:[ \t]+\\(.+\\)")
135 136 137 138 139
  (set (make-local-variable 'log-view-message-re)
       "^changeset:[ \t]*\\([0-9]+\\):\\(.+\\)")
  (set (make-local-variable 'log-view-font-lock-keywords)
       (append 
	;; XXX maybe use a different face for the version number
140 141
	`((,log-view-message-re  (1 'change-log-acknowledgement))
	  (,log-view-file-re (1 'change-log-file-face)))
142 143 144 145 146 147 148 149 150 151 152 153
	;; Handle the case:
	;; user: foo@bar
	'(("^user:[ \t]+\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)"
	   (1 'change-log-email))
	  ;; Handle the case:
	  ;; user: FirstName LastName <foo@bar>
	  ("^user:[ \t]+\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]"
	   (1 'change-log-name)
	   (2 'change-log-email))
	  ("^date: \\(.+\\)" (1 'change-log-date))
	  ("^summary:[ \t]+\\(.+\\)" (1 'log-view-message))))))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
154
(defun vc-hg-diff (file &optional oldvers newvers buffer)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
155
  "Get a difference report using hg between two versions of FILE."
Dan Nicolaescu's avatar
Dan Nicolaescu committed
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
  (let ((working (vc-workfile-version file)))
    (if (and (equal oldvers working) (not newvers))
	(setq oldvers nil))
    (if (and (not oldvers) newvers)
	(setq oldvers working))
    (apply 'call-process "hg" nil (or buffer "*vc-diff*") nil
	   "--cwd" (file-name-directory file) "diff" 
	   (append 
	    (if oldvers
		(if newvers
		    (list "-r" oldvers "-r" newvers)
		  (list "-r" oldvers))
	      (list ""))
	   (list (file-name-nondirectory file))))))

(defun vc-hg-annotate-command (file buffer &optional version)
  "Execute \"hg annotate\" on FILE, inserting the contents in BUFFER.
Optional arg VERSION is a version to annotate from."
  (vc-hg-command buffer 0 file "annotate" "-d" "-n" (if version (concat "-r" version)))
  (with-current-buffer buffer
    (goto-char (point-min))
    (re-search-forward "^[0-9]")
    (delete-region (point-min) (1- (point)))))


;;; The format for one line output by "hg annotate -d -n" looks like this:
;;;215 Wed Jun 20 21:22:58 2007 -0700: CONTENTS
;;; i.e: VERSION_NUMBER DATE: CONTENTS
(defconst vc-hg-annotate-re "^[ \t]*\\([0-9]+\\) \\(.\\{30\\}\\): ")

(defun vc-hg-annotate-time ()
  (when (looking-at vc-hg-annotate-re)
    (goto-char (match-end 0))
    (vc-annotate-convert-time 
     (date-to-time (match-string-no-properties 2)))))

(defun vc-hg-annotate-extract-revision-at-line ()
  (save-excursion
    (beginning-of-line)
    (if (looking-at vc-hg-annotate-re) (match-string-no-properties 1))))

(defun vc-hg-previous-version (file rev)
  (let ((newrev (1- (string-to-number rev))))
    (when (>= newrev 0)
      (number-to-string newrev))))
Dan Nicolaescu's avatar
Dan Nicolaescu committed
201

202 203 204 205 206 207
(defun vc-hg-register (file &optional rev comment)
  "Register FILE under hg.
REV is ignored.
COMMENT is ignored."
  (vc-hg-command nil nil file "add"))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
208 209 210 211 212
(defun vc-hg-checkin (file rev comment)
  "HG-specific version of `vc-backend-checkin'.
REV is ignored."
  (vc-hg-command nil nil file  "commit" "-m" comment))

213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
;;; Modelled after the similar function in vc-bzr.el
(defun vc-hg-checkout (file &optional editable rev workfile)
  "Retrieve a revision of FILE into a WORKFILE.
EDITABLE is ignored.
REV is the revision to check out into WORKFILE."
  (unless workfile
    (setq workfile (vc-version-backup-file-name file rev)))
  (let ((coding-system-for-read 'binary)
        (coding-system-for-write 'binary))
  (with-temp-file workfile
    (if rev
        (vc-hg-command t nil file "cat" "-r" rev)
      (vc-hg-command t nil file "cat")))))

(defun vc-hg-checkout-model (file)
  'implicit)

Dan Nicolaescu's avatar
Dan Nicolaescu committed
230 231 232 233 234 235 236 237 238 239 240 241
;;; Internal functions

(defun vc-hg-command (buffer okstatus file &rest flags)
  "A wrapper around `vc-do-command' for use in vc-hg.el.
The difference to vc-do-command is that this function always invokes `hg',
and that it passes `vc-hg-global-switches' to it before FLAGS."
  (apply 'vc-do-command buffer okstatus "hg" file
         (if (stringp vc-hg-global-switches)
             (cons vc-hg-global-switches flags)
           (append vc-hg-global-switches
                   flags))))

242
(defun vc-hg-internal-log (file &optional buffer)
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
  "Return log of FILE."
  (with-output-to-string
    (with-current-buffer
        standard-output
      (call-process
       "hg" nil t nil "--cwd" (file-name-directory file)
       "log" "-l1" (file-name-nondirectory file)))))

(defun vc-hg-internal-status(file)
  "Return status of FILE."
  (with-output-to-string
    (with-current-buffer
        standard-output
      (call-process
       "hg" nil t nil "--cwd" (file-name-directory file)
       "status" (file-name-nondirectory file)))))

Dan Nicolaescu's avatar
Dan Nicolaescu committed
260 261
(provide 'vc-hg)

262
;;; vc-hg.el ends here