1 ;;; vc-hg.el --- VC backend for the mercurial version control system
3 ;; Copyright (C) 2006, 2007 Free Software Foundation, Inc.
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, or (at your option)
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; see the file COPYING. If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
27 ;; This is a mercurial version control backend
37 ;; Implement the rest of the vc interface. See the comment at the
38 ;; beginning of vc.el. The current status is:
40 ;; FUNCTION NAME STATUS
42 ;; * revision-granularity OK
43 ;; STATE-QUERYING FUNCTIONS
44 ;; * registered (file) OK
46 ;; - state-heuristic (file) ?? PROBABLY NOT NEEDED
47 ;; - dir-state (dir) OK
48 ;; * working-revision (file) OK
49 ;; - latest-on-branch-p (file) ??
50 ;; * checkout-model (file) OK
51 ;; - workfile-unchanged-p (file) OK
52 ;; - mode-line-string (file) NOT NEEDED
53 ;; - dired-state-info (file) OK
54 ;; STATE-CHANGING FUNCTIONS
55 ;; * register (files &optional rev comment) OK
56 ;; * create-repo () OK
57 ;; - init-revision () NOT NEEDED
58 ;; - responsible-p (file) OK
59 ;; - could-register (file) OK
60 ;; - receive-file (file rev) ?? PROBABLY NOT NEEDED
61 ;; - unregister (file) COMMENTED OUT, MAY BE INCORRECT
62 ;; * checkin (files rev comment) OK
63 ;; * find-revision (file rev buffer) OK
64 ;; * checkout (file &optional editable rev) OK
65 ;; * revert (file &optional contents-done) OK
66 ;; - rollback (files) ?? PROBABLY NOT NEEDED
67 ;; - merge (file rev1 rev2) NEEDED
68 ;; - merge-news (file) NEEDED
69 ;; - steal-lock (file &optional revision) NOT NEEDED
71 ;; * print-log (files &optional buffer) OK
72 ;; - log-view-mode () OK
73 ;; - show-log-entry (revision) NOT NEEDED, DEFAULT IS GOOD
74 ;; - wash-log (file) ??
75 ;; - logentry-check () NOT NEEDED
76 ;; - comment-history (file) NOT NEEDED
77 ;; - update-changelog (files) NOT NEEDED
78 ;; * diff (files &optional rev1 rev2 buffer) OK
79 ;; - revision-completion-table (files) OK?
80 ;; - annotate-command (file buf &optional rev) OK
81 ;; - annotate-time () OK
82 ;; - annotate-current-time () ?? NOT NEEDED
83 ;; - annotate-extract-revision-at-line () OK
85 ;; - create-snapshot (dir name branchp) NEEDED (probably branch?)
86 ;; - assign-name (file name) NOT NEEDED
87 ;; - retrieve-snapshot (dir name update) ?? NEEDED??
89 ;; - make-version-backups-p (file) ??
90 ;; - repository-hostname (dirname) ??
91 ;; - previous-revision (file rev) OK
92 ;; - next-revision (file rev) OK
93 ;; - check-headers () ??
94 ;; - clear-headers () ??
95 ;; - delete-file (file) TEST IT
96 ;; - rename-file (old new) OK
97 ;; - find-file-hook () PROBABLY NOT NEEDED
98 ;; - find-file-not-found-hook () PROBABLY NOT NEEDED
100 ;; Implement Stefan Monnier's advice:
101 ;; vc-hg-registered and vc-hg-state
102 ;; Both of those functions should be super extra careful to fail gracefully in
103 ;; unexpected circumstances. The reason this is important is that any error
104 ;; there will prevent the user from even looking at the file :-(
105 ;; Ideally, just like in vc-arch and vc-cvs, checking that the file is under
106 ;; mercurial's control and extracting the current revision should be done
107 ;; without even using `hg' (this way even if you don't have `hg' installed,
108 ;; Emacs is able to tell you this file is under mercurial's control).
119 ;;; Customization options
121 (defcustom vc-hg-global-switches nil
122 "*Global switches to pass to any Hg command."
123 :type
'(choice (const :tag
"None" nil
)
124 (string :tag
"Argument String")
125 (repeat :tag
"Argument List"
132 ;;; Properties of the backend
134 (defun vc-hg-revision-granularity ()
137 ;;; State querying functions
139 ;;;###autoload (defun vc-hg-registered (file)
140 ;;;###autoload "Return non-nil if FILE is registered with hg."
141 ;;;###autoload (if (vc-find-root file ".hg") ; short cut
142 ;;;###autoload (progn
143 ;;;###autoload (load "vc-hg")
144 ;;;###autoload (vc-hg-registered file))))
146 ;; Modelled after the similar function in vc-bzr.el
147 (defun vc-hg-registered (file)
148 "Return non-nil if FILE is registered with hg."
149 (when (vc-hg-root file
) ; short cut
150 (vc-file-setprop file
'vc-state
(vc-hg-state file
)))) ; expensive
152 (defun vc-hg-state (file)
153 "Hg-specific version of `vc-state'."
157 (with-output-to-string
162 ;; Ignore all errors.
164 "hg" nil t nil
"--cwd" (file-name-directory file
)
165 "status" (file-name-nondirectory file
))
166 ;; Some problem happened. E.g. We can't find an `hg'
170 (if (eq 0 (length out
)) 'up-to-date
171 (when (null (string-match ".*: No such file or directory$" out
))
172 (let ((state (aref out
0)))
174 ((eq state ?A
) 'edited
)
175 ((eq state ?M
) 'edited
)
178 (t 'up-to-date
))))))))
180 (defun vc-hg-dir-state (dir)
182 (vc-hg-command (current-buffer) nil nil
"status")
183 (goto-char (point-min))
184 (let ((status-char nil
)
187 (setq status-char
(char-after))
190 (buffer-substring-no-properties (+ (point) 2)
191 (line-end-position))))
193 ;; The rest of the possible states in "hg status" output:
195 ;; ! = deleted, but still tracked
197 ;; should not show up in vc-dired, so don't deal with them
200 (vc-file-setprop file
'vc-working-revision
"0")
201 (vc-file-setprop file
'vc-state
'edited
))
203 (vc-file-setprop file
'vc-state
'edited
))
205 (vc-file-setprop file
'vc-backend
'none
)
206 (vc-file-setprop file
'vc-state
'nil
)))
209 (defun vc-hg-working-revision (file)
210 "Hg-specific version of `vc-working-revision'."
214 (with-output-to-string
219 ;; Ignore all errors.
221 "hg" nil t nil
"--cwd" (file-name-directory file
)
222 "log" "-l1" (file-name-nondirectory file
))
223 ;; Some problem happened. E.g. We can't find an `hg'
227 (if (string-match "changeset: *\\([0-9]*\\)" out
)
231 ;;; History functions
233 (defun vc-hg-print-log(files &optional buffer
)
234 "Get change log associated with FILES."
235 ;; `log-view-mode' needs to have the file name in order to function
236 ;; correctly. "hg log" does not print it, so we insert it here by
239 ;; `vc-do-command' creates the buffer, but we need it before running
241 (vc-setup-buffer buffer
)
242 ;; If the buffer exists from a previous invocation it might be
244 (let ((inhibit-read-only t
))
245 ;; We need to loop and call "hg log" on each file separately.
246 ;; "hg log" with multiple file arguments mashes all the logs
251 (insert "File: " (file-name-nondirectory file
) "\n"))
252 (vc-hg-command buffer
0 file
"log"))))
254 (defvar log-view-message-re
)
255 (defvar log-view-file-re
)
256 (defvar log-view-font-lock-keywords
)
258 (define-derived-mode vc-hg-log-view-mode log-view-mode
"Hg-Log-View"
259 (require 'add-log
) ;; we need the add-log faces
260 (set (make-local-variable 'log-view-file-re
) "^File:[ \t]+\\(.+\\)")
261 (set (make-local-variable 'log-view-message-re
)
262 "^changeset:[ \t]*\\([0-9]+\\):\\(.+\\)")
263 (set (make-local-variable 'log-view-font-lock-keywords
)
265 log-view-font-lock-keywords
268 '(("^user:[ \t]+\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)"
269 (1 'change-log-email
))
271 ;; user: FirstName LastName <foo@bar>
272 ("^user:[ \t]+\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]"
274 (2 'change-log-email
))
275 ("^date: \\(.+\\)" (1 'change-log-date
))
276 ("^summary:[ \t]+\\(.+\\)" (1 'log-view-message
))))))
278 (defun vc-hg-diff (files &optional oldvers newvers buffer
)
279 "Get a difference report using hg between two revisions of FILES."
280 (let ((working (vc-working-revision (car files
))))
281 (if (and (equal oldvers working
) (not newvers
))
283 (if (and (not oldvers
) newvers
)
284 (setq oldvers working
))
285 (apply #'vc-hg-command
(or buffer
"*vc-diff*") nil
286 (mapcar (lambda (file) (file-name-nondirectory file
)) files
)
287 "--cwd" (file-name-directory (car files
))
292 (list "-r" oldvers
"-r" newvers
)
296 (defun vc-hg-revision-table (files)
297 (let ((default-directory (file-name-directory (car files
))))
299 (vc-hg-command t nil files
"log" "--template" "{rev} ")
301 (buffer-substring-no-properties (point-min) (point-max))))))
303 ;; Modelled after the similar function in vc-cvs.el
304 (defun vc-hg-revision-completion-table (files)
305 (lexical-let ((files files
)
307 (setq table
(lazy-completion-table
308 table
(lambda () (vc-hg-revision-table files
))))
311 (defun vc-hg-annotate-command (file buffer
&optional revision
)
312 "Execute \"hg annotate\" on FILE, inserting the contents in BUFFER.
313 Optional arg REVISION is a revision to annotate from."
314 (vc-hg-command buffer
0 file
"annotate" "-d" "-n" (if revision
(concat "-r" revision
)))
315 (with-current-buffer buffer
316 (goto-char (point-min))
317 (re-search-forward "^[0-9]")
318 (delete-region (point-min) (1- (point)))))
321 ;; The format for one line output by "hg annotate -d -n" looks like this:
322 ;;215 Wed Jun 20 21:22:58 2007 -0700: CONTENTS
323 ;; i.e: VERSION_NUMBER DATE: CONTENTS
324 (defconst vc-hg-annotate-re
"^[ \t]*\\([0-9]+\\) \\(.\\{30\\}\\): ")
326 (defun vc-hg-annotate-time ()
327 (when (looking-at vc-hg-annotate-re
)
328 (goto-char (match-end 0))
329 (vc-annotate-convert-time
330 (date-to-time (match-string-no-properties 2)))))
332 (defun vc-hg-annotate-extract-revision-at-line ()
335 (if (looking-at vc-hg-annotate-re
) (match-string-no-properties 1))))
337 (defun vc-hg-previous-revision (file rev
)
338 (let ((newrev (1- (string-to-number rev
))))
340 (number-to-string newrev
))))
342 (defun vc-hg-next-revision (file rev
)
343 (let ((newrev (1+ (string-to-number rev
)))
346 (vc-hg-command t
0 nil
"tip")
347 (goto-char (point-min))
348 (re-search-forward "^changeset:[ \t]*\\([0-9]+\\):")
349 (string-to-number (match-string-no-properties 1)))))
350 ;; We don't want to exceed the maximum possible revision number, ie
352 (when (<= newrev tip-revision
)
353 (number-to-string newrev
))))
355 ;; Modelled after the similar function in vc-bzr.el
356 (defun vc-hg-delete-file (file)
357 "Delete FILE and delete it in the hg repository."
361 (vc-hg-command nil
0 file
"remove" "--after" "--force"))
363 ;; Modelled after the similar function in vc-bzr.el
364 (defun vc-hg-rename-file (old new
)
365 "Rename file from OLD to NEW using `hg mv'."
366 (vc-hg-command nil
0 new old
"mv"))
368 (defun vc-hg-register (files &optional rev comment
)
369 "Register FILES under hg.
372 (vc-hg-command nil
0 files
"add"))
374 (defun vc-hg-create-repo ()
375 "Create a new Mercurial repository."
376 (vc-hg-command nil
0 nil
"init"))
378 (defalias 'vc-hg-responsible-p
'vc-hg-root
)
380 ;; Modelled after the similar function in vc-bzr.el
381 (defun vc-hg-could-register (file)
382 "Return non-nil if FILE could be registered under hg."
383 (and (vc-hg-responsible-p file
) ; shortcut
386 (vc-hg-command t nil file
"add" "--dry-run"))
387 ;; The command succeeds with no output if file is
391 ;; XXX This would remove the file. Is that correct?
392 ;; (defun vc-hg-unregister (file)
393 ;; "Unregister FILE from hg."
394 ;; (vc-hg-command nil nil file "remove"))
396 (defun vc-hg-checkin (files rev comment
)
397 "Hg-specific version of `vc-backend-checkin'.
399 (vc-hg-command nil
0 files
"commit" "-m" comment
))
401 (defun vc-hg-find-revision (file rev buffer
)
402 (let ((coding-system-for-read 'binary
)
403 (coding-system-for-write 'binary
))
405 (vc-hg-command buffer
0 file
"cat" "-r" rev
)
406 (vc-hg-command buffer
0 file
"cat"))))
408 ;; Modelled after the similar function in vc-bzr.el
409 (defun vc-hg-checkout (file &optional editable rev
)
410 "Retrieve a revision of FILE.
412 REV is the revision to check out into WORKFILE."
413 (let ((coding-system-for-read 'binary
)
414 (coding-system-for-write 'binary
))
415 (with-current-buffer (or (get-file-buffer file
) (current-buffer))
417 (vc-hg-command t
0 file
"cat" "-r" rev
)
418 (vc-hg-command t
0 file
"cat")))))
420 (defun vc-hg-checkout-model (file)
423 ;; Modelled after the similar function in vc-bzr.el
424 (defun vc-hg-workfile-unchanged-p (file)
425 (eq 'up-to-date
(vc-hg-state file
)))
427 (defun vc-hg-dired-state-info (file)
428 "Hg-specific version of `vc-dired-state-info'."
429 (let ((hg-state (vc-state file
)))
430 (if (eq hg-state
'edited
)
431 (if (equal (vc-working-revision file
) "0")
432 "(added)" "(modified)")
433 ;; fall back to the default VC representation
434 (vc-default-dired-state-info 'Hg file
))))
436 ;; Modelled after the similar function in vc-bzr.el
437 (defun vc-hg-revert (file &optional contents-done
)
438 (unless contents-done
439 (with-temp-buffer (vc-hg-command t
0 file
"revert"))))
441 ;;; Hg specific functionality.
443 ;;; XXX This functionality is experimental/work in progress. It might
444 ;;; change without notice.
445 (defvar vc-hg-extra-menu-map
446 (let ((map (make-sparse-keymap)))
447 (define-key map
[incoming] '(menu-item "Show incoming" vc-hg-incoming))
448 (define-key map [outgoing] '(menu-item "Show outgoing" vc-hg-outgoing))
451 (defun vc-hg-extra-menu () vc-hg-extra-menu-map)
453 (define-derived-mode vc-hg-outgoing-mode vc-hg-log-view-mode "Hg-Outgoing")
455 (define-derived-mode vc-hg-incoming-mode vc-hg-log-view-mode "Hg-Incoming")
457 ;; XXX this adds another top level menu, instead figure out how to
458 ;; replace the Log-View menu.
459 (easy-menu-define log-view-mode-menu vc-hg-outgoing-mode-map
460 "Hg-outgoing Display Menu"
462 ["Push selected" vc-hg-push]))
464 (easy-menu-define log-view-mode-menu vc-hg-incoming-mode-map
465 "Hg-incoming Display Menu"
467 ["Pull selected" vc-hg-pull]))
469 (defun vc-hg-outgoing ()
471 (let ((bname "*Hg outgoing*"))
472 (vc-hg-command bname 0 nil "outgoing" "-n")
473 (pop-to-buffer bname)
474 (vc-hg-outgoing-mode)))
476 (defun vc-hg-incoming ()
478 (let ((bname "*Hg incoming*"))
479 (vc-hg-command bname 0 nil "incoming" "-n")
480 (pop-to-buffer bname)
481 (vc-hg-incoming-mode)))
483 (declare-function log-view-get-marked "log-view" ())
485 ;; XXX maybe also add key bindings for these functions.
488 (let ((marked-list (log-view-get-marked)))
494 (mapcar (lambda (arg) (list "-r" arg)) marked-list))))
495 (error "No log entries selected for push"))))
499 (let ((marked-list (log-view-get-marked)))
505 (mapcar (lambda (arg) (list "-r" arg)) marked-list))))
506 (error "No log entries selected for pull"))))
508 ;;; Internal functions
510 (defun vc-hg-command (buffer okstatus file-or-list &rest flags)
511 "A wrapper around `vc-do-command' for use in vc-hg.el.
512 The difference to vc-do-command is that this function always invokes `hg',
513 and that it passes `vc-hg-global-switches' to it before FLAGS."
514 (apply 'vc-do-command buffer okstatus "hg" file-or-list
515 (if (stringp vc-hg-global-switches)
516 (cons vc-hg-global-switches flags)
517 (append vc-hg-global-switches
520 (defun vc-hg-root (file)
521 (vc-find-root file ".hg"))
525 ;; arch-tag: bd094dc5-715a-434f-a331-37b9fb7cd954
526 ;;; vc-hg.el ends here