1 ;;; vc-hg.el --- VC backend for the mercurial version control system
3 ;; Copyright (C) 2006, 2007, 2008 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 (let ((state (vc-hg-state file
))) ; expensive
151 (vc-file-setprop file
'vc-state state
)
152 (and state
(not (memq state
'(ignored unregistered
)))))))
154 (defun vc-hg-state (file)
155 "Hg-specific version of `vc-state'."
159 (with-output-to-string
164 ;; Ignore all errors.
166 "hg" nil t nil
"--cwd" (file-name-directory file
)
167 "status" "-A" (file-name-nondirectory file
))
168 ;; Some problem happened. E.g. We can't find an `hg'
172 (when (null (string-match ".*: No such file or directory$" out
))
173 (let ((state (aref out
0)))
175 ((eq state ?
=) 'up-to-date
)
176 ((eq state ?A
) 'added
)
177 ((eq state ?M
) 'edited
)
178 ((eq state ?I
) 'ignored
)
179 ((eq state ?R
) 'removed
)
180 ((eq state ??
) 'unregistered
)
181 ((eq state ?C
) 'up-to-date
) ;; Older mercurials use this
182 (t 'up-to-date
)))))))
184 (defun vc-hg-dir-state (dir)
186 (buffer-disable-undo) ;; Because these buffers can get huge
187 (vc-hg-command (current-buffer) nil dir
"status" "-A")
188 (goto-char (point-min))
189 (let ((status-char nil
)
192 (setq status-char
(char-after))
195 (buffer-substring-no-properties (+ (point) 2)
196 (line-end-position))))
198 ;; State flag for a clean file is now C, might change to =.
199 ;; The rest of the possible states in "hg status" output:
200 ;; ! = deleted, but still tracked
201 ;; should not show up in vc-dired, so don't deal with them
204 ;; Mercurial up to 0.9.5 used C, = is used now.
205 ((or (eq status-char ?
=) (eq status-char ?C
))
206 (vc-file-setprop file
'vc-backend
'Hg
)
207 (vc-file-setprop file
'vc-state
'up-to-date
))
209 (vc-file-setprop file
'vc-backend
'Hg
)
210 (vc-file-setprop file
'vc-working-revision
"0")
211 (vc-file-setprop file
'vc-state
'added
))
213 (vc-file-setprop file
'vc-backend
'Hg
)
214 (vc-file-setprop file
'vc-state
'removed
))
216 (vc-file-setprop file
'vc-backend
'Hg
)
217 (vc-file-setprop file
'vc-state
'edited
))
219 (vc-file-setprop file
'vc-backend
'Hg
)
220 (vc-file-setprop file
'vc-state
'ignored
))
222 (vc-file-setprop file
'vc-backend
'none
)
223 (vc-file-setprop file
'vc-state
'unregistered
))
226 (t ;; Presently C, might change to = in 0.9.6
227 (vc-file-setprop file
'vc-backend
'Hg
)
228 (vc-file-setprop file
'vc-state
'up-to-date
)))
231 (defun vc-hg-working-revision (file)
232 "Hg-specific version of `vc-working-revision'."
236 (with-output-to-string
241 ;; Ignore all errors.
243 "hg" nil t nil
"--cwd" (file-name-directory file
)
244 "log" "-l1" (file-name-nondirectory file
))
245 ;; Some problem happened. E.g. We can't find an `hg'
249 (if (string-match "changeset: *\\([0-9]*\\)" out
)
253 ;;; History functions
255 (defun vc-hg-print-log (files &optional buffer
)
256 "Get change log associated with FILES."
257 ;; `log-view-mode' needs to have the file names in order to function
258 ;; correctly. "hg log" does not print it, so we insert it here by
261 ;; `vc-do-command' creates the buffer, but we need it before running
263 (vc-setup-buffer buffer
)
264 ;; If the buffer exists from a previous invocation it might be
266 (let ((inhibit-read-only t
))
267 ;; We need to loop and call "hg log" on each file separately.
268 ;; "hg log" with multiple file arguments mashes all the logs
269 ;; together. Ironically enough, this puts us back near CVS
270 ;; which can't generate proper fileset logs either.
274 (insert "Working file: " file
"\n")) ;; Like RCS/CVS.
275 (vc-hg-command buffer
0 file
"log"))))
277 (defvar log-view-message-re
)
278 (defvar log-view-file-re
)
279 (defvar log-view-font-lock-keywords
)
281 (define-derived-mode vc-hg-log-view-mode log-view-mode
"Hg-Log-View"
282 (require 'add-log
) ;; we need the add-log faces
283 (set (make-local-variable 'log-view-file-re
) "^Working file:[ \t]+\\(.+\\)")
284 (set (make-local-variable 'log-view-message-re
)
285 "^changeset:[ \t]*\\([0-9]+\\):\\(.+\\)")
286 (set (make-local-variable 'log-view-font-lock-keywords
)
288 log-view-font-lock-keywords
291 ;; user: FirstName LastName <foo@bar>
292 ("^user:[ \t]+\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]"
294 (2 'change-log-email
))
299 ("^user:[ \t]+\\([A-Za-z0-9_.+-]+\\(?:@[A-Za-z0-9_.-]+\\)?\\)"
300 (1 'change-log-email
))
301 ("^date: \\(.+\\)" (1 'change-log-date
))
302 ("^summary:[ \t]+\\(.+\\)" (1 'log-view-message
))))))
304 (defun vc-hg-diff (files &optional oldvers newvers buffer
)
305 "Get a difference report using hg between two revisions of FILES."
306 (let ((working (vc-working-revision (car files
))))
307 (if (and (equal oldvers working
) (not newvers
))
309 (if (and (not oldvers
) newvers
)
310 (setq oldvers working
))
311 (apply #'vc-hg-command
(or buffer
"*vc-diff*") nil
312 (mapcar (lambda (file) (file-name-nondirectory file
)) files
)
313 "--cwd" (file-name-directory (car files
))
318 (list "-r" oldvers
"-r" newvers
)
319 (list "-r" oldvers
)))))))
321 (defun vc-hg-revision-table (files)
322 (let ((default-directory (file-name-directory (car files
))))
324 (vc-hg-command t nil files
"log" "--template" "{rev} ")
326 (buffer-substring-no-properties (point-min) (point-max))))))
328 ;; Modelled after the similar function in vc-cvs.el
329 (defun vc-hg-revision-completion-table (files)
330 (lexical-let ((files files
)
332 (setq table
(lazy-completion-table
333 table
(lambda () (vc-hg-revision-table files
))))
336 (defun vc-hg-annotate-command (file buffer
&optional revision
)
337 "Execute \"hg annotate\" on FILE, inserting the contents in BUFFER.
338 Optional arg REVISION is a revision to annotate from."
339 (vc-hg-command buffer
0 file
"annotate" "-d" "-n" (if revision
(concat "-r" revision
)))
340 (with-current-buffer buffer
341 (goto-char (point-min))
342 (re-search-forward "^[0-9]")
343 (delete-region (point-min) (1- (point)))))
346 ;; The format for one line output by "hg annotate -d -n" looks like this:
347 ;;215 Wed Jun 20 21:22:58 2007 -0700: CONTENTS
348 ;; i.e: VERSION_NUMBER DATE: CONTENTS
349 (defconst vc-hg-annotate-re
"^[ \t]*\\([0-9]+\\) \\(.\\{30\\}\\): ")
351 (defun vc-hg-annotate-time ()
352 (when (looking-at vc-hg-annotate-re
)
353 (goto-char (match-end 0))
354 (vc-annotate-convert-time
355 (date-to-time (match-string-no-properties 2)))))
357 (defun vc-hg-annotate-extract-revision-at-line ()
360 (if (looking-at vc-hg-annotate-re
) (match-string-no-properties 1))))
362 (defun vc-hg-previous-revision (file rev
)
363 (let ((newrev (1- (string-to-number rev
))))
365 (number-to-string newrev
))))
367 (defun vc-hg-next-revision (file rev
)
368 (let ((newrev (1+ (string-to-number rev
)))
371 (vc-hg-command t
0 nil
"tip")
372 (goto-char (point-min))
373 (re-search-forward "^changeset:[ \t]*\\([0-9]+\\):")
374 (string-to-number (match-string-no-properties 1)))))
375 ;; We don't want to exceed the maximum possible revision number, ie
377 (when (<= newrev tip-revision
)
378 (number-to-string newrev
))))
380 ;; Modelled after the similar function in vc-bzr.el
381 (defun vc-hg-delete-file (file)
382 "Delete FILE and delete it in the hg repository."
386 (vc-hg-command nil
0 file
"remove" "--after" "--force"))
388 ;; Modelled after the similar function in vc-bzr.el
389 (defun vc-hg-rename-file (old new
)
390 "Rename file from OLD to NEW using `hg mv'."
391 (vc-hg-command nil
0 new old
"mv"))
393 (defun vc-hg-register (files &optional rev comment
)
394 "Register FILES under hg.
397 (vc-hg-command nil
0 files
"add"))
399 (defun vc-hg-create-repo ()
400 "Create a new Mercurial repository."
401 (vc-hg-command nil
0 nil
"init"))
403 (defalias 'vc-hg-responsible-p
'vc-hg-root
)
405 ;; Modelled after the similar function in vc-bzr.el
406 (defun vc-hg-could-register (file)
407 "Return non-nil if FILE could be registered under hg."
408 (and (vc-hg-responsible-p file
) ; shortcut
411 (vc-hg-command t nil file
"add" "--dry-run"))
412 ;; The command succeeds with no output if file is
416 ;; XXX This would remove the file. Is that correct?
417 ;; (defun vc-hg-unregister (file)
418 ;; "Unregister FILE from hg."
419 ;; (vc-hg-command nil nil file "remove"))
421 (defun vc-hg-checkin (files rev comment
)
422 "Hg-specific version of `vc-backend-checkin'.
424 (vc-hg-command nil
0 files
"commit" "-m" comment
))
426 (defun vc-hg-find-revision (file rev buffer
)
427 (let ((coding-system-for-read 'binary
)
428 (coding-system-for-write 'binary
))
430 (vc-hg-command buffer
0 file
"cat" "-r" rev
)
431 (vc-hg-command buffer
0 file
"cat"))))
433 ;; Modelled after the similar function in vc-bzr.el
434 (defun vc-hg-checkout (file &optional editable rev
)
435 "Retrieve a revision of FILE.
437 REV is the revision to check out into WORKFILE."
438 (let ((coding-system-for-read 'binary
)
439 (coding-system-for-write 'binary
))
440 (with-current-buffer (or (get-file-buffer file
) (current-buffer))
442 (vc-hg-command t
0 file
"cat" "-r" rev
)
443 (vc-hg-command t
0 file
"cat")))))
445 (defun vc-hg-checkout-model (file)
448 ;; Modelled after the similar function in vc-bzr.el
449 (defun vc-hg-workfile-unchanged-p (file)
450 (eq 'up-to-date
(vc-hg-state file
)))
452 ;; Modelled after the similar function in vc-bzr.el
453 (defun vc-hg-revert (file &optional contents-done
)
454 (unless contents-done
455 (with-temp-buffer (vc-hg-command t
0 file
"revert"))))
457 ;;; Hg specific functionality.
459 ;; XXX This functionality is experimental/work in progress. It might
460 ;; change without notice.
461 (defvar vc-hg-extra-menu-map
462 (let ((map (make-sparse-keymap)))
463 (define-key map
[incoming] '(menu-item "Show incoming" vc-hg-incoming))
464 (define-key map [outgoing] '(menu-item "Show outgoing" vc-hg-outgoing))
467 (defun vc-hg-extra-menu () vc-hg-extra-menu-map)
469 (defun vc-hg-extra-status-menu () vc-hg-extra-menu-map)
471 (define-derived-mode vc-hg-outgoing-mode vc-hg-log-view-mode "Hg-Outgoing")
473 (define-derived-mode vc-hg-incoming-mode vc-hg-log-view-mode "Hg-Incoming")
475 ;; XXX Experimental function for the vc-dired replacement.
476 (defun vc-hg-after-dir-status (update-function status-buffer)
477 (let ((status-char nil)
479 (translation '((?= . up-to-date)
486 (?? . unregistered)))
489 (goto-char (point-min))
491 (setq status-char (char-after))
493 (buffer-substring-no-properties (+ (point) 2)
494 (line-end-position)))
495 (setq translated (assoc status-char translation))
496 (when (and translated (not (eq (cdr translated) 'up-to-date)))
497 (push (cons file (cdr translated)) result))
499 ;; Remove the temporary buffer.
500 (kill-buffer (current-buffer))
501 (funcall update-function result status-buffer)))
503 ;; XXX Experimental function for the vc-dired replacement.
504 (defun vc-hg-dir-status (dir update-function status-buffer)
505 "Return a list of conses (file . state) for DIR."
508 (expand-file-name " *VC-hg* tmp status" dir))
510 (vc-hg-command (current-buffer) 'async dir "status")
512 `(vc-hg-after-dir-status (quote ,update-function) ,status-buffer))
515 ;; XXX this adds another top level menu, instead figure out how to
516 ;; replace the Log-View menu.
517 (easy-menu-define log-view-mode-menu vc-hg-outgoing-mode-map
518 "Hg-outgoing Display Menu"
520 ["Push selected" vc-hg-push]))
522 (easy-menu-define log-view-mode-menu vc-hg-incoming-mode-map
523 "Hg-incoming Display Menu"
525 ["Pull selected" vc-hg-pull]))
527 (defun vc-hg-outgoing ()
529 (let ((bname "*Hg outgoing*"))
530 (vc-hg-command bname 0 nil "outgoing" "-n")
531 (pop-to-buffer bname)
532 (vc-hg-outgoing-mode)))
534 (defun vc-hg-incoming ()
536 (let ((bname "*Hg incoming*"))
537 (vc-hg-command bname 0 nil "incoming" "-n")
538 (pop-to-buffer bname)
539 (vc-hg-incoming-mode)))
541 (declare-function log-view-get-marked "log-view" ())
543 ;; XXX maybe also add key bindings for these functions.
546 (let ((marked-list (log-view-get-marked)))
552 (mapcar (lambda (arg) (list "-r" arg)) marked-list))))
553 (error "No log entries selected for push"))))
557 (let ((marked-list (log-view-get-marked)))
563 (mapcar (lambda (arg) (list "-r" arg)) marked-list))))
564 (error "No log entries selected for pull"))))
566 ;;; Internal functions
568 (defun vc-hg-command (buffer okstatus file-or-list &rest flags)
569 "A wrapper around `vc-do-command' for use in vc-hg.el.
570 The difference to vc-do-command is that this function always invokes `hg',
571 and that it passes `vc-hg-global-switches' to it before FLAGS."
572 (apply 'vc-do-command buffer okstatus "hg" file-or-list
573 (if (stringp vc-hg-global-switches)
574 (cons vc-hg-global-switches flags)
575 (append vc-hg-global-switches
578 (defun vc-hg-root (file)
579 (vc-find-root file ".hg"))
583 ;; arch-tag: bd094dc5-715a-434f-a331-37b9fb7cd954
584 ;;; vc-hg.el ends here