1 ;;; vc-hg.el --- VC backend for the mercurial version control system
3 ;; Copyright (C) 2006, 2007, 2008, 2009, 2010 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 of the License, or
13 ;; (at your option) any later version.
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. If not, see <http://www.gnu.org/licenses/>.
25 ;; This is a mercurial version control backend
35 ;; 1) Implement the rest of the vc interface. See the comment at the
36 ;; beginning of vc.el. The current status is:
38 ;; FUNCTION NAME STATUS
40 ;; * revision-granularity OK
41 ;; STATE-QUERYING FUNCTIONS
42 ;; * registered (file) OK
44 ;; - state-heuristic (file) NOT NEEDED
45 ;; - dir-status (dir update-function) OK
46 ;; - dir-status-files (dir files ds uf) OK
47 ;; - dir-extra-headers (dir) OK
48 ;; - dir-printer (fileinfo) OK
49 ;; * working-revision (file) OK
50 ;; - latest-on-branch-p (file) ??
51 ;; * checkout-model (files) OK
52 ;; - workfile-unchanged-p (file) OK
53 ;; - mode-line-string (file) NOT NEEDED
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 buffer &optional shortlog start-revision limit) OK
72 ;; - log-view-mode () OK
73 ;; - show-log-entry (revision) NOT NEEDED, DEFAULT IS GOOD
74 ;; - comment-history (file) NOT NEEDED
75 ;; - update-changelog (files) NOT NEEDED
76 ;; * diff (files &optional rev1 rev2 buffer) OK
77 ;; - revision-completion-table (files) OK?
78 ;; - annotate-command (file buf &optional rev) OK
79 ;; - annotate-time () OK
80 ;; - annotate-current-time () NOT NEEDED
81 ;; - annotate-extract-revision-at-line () OK
83 ;; - create-tag (dir name branchp) NEEDED
84 ;; - retrieve-tag (dir name update) NEEDED
86 ;; - make-version-backups-p (file) ??
87 ;; - repository-hostname (dirname) ??
88 ;; - previous-revision (file rev) OK
89 ;; - next-revision (file rev) OK
90 ;; - check-headers () ??
91 ;; - clear-headers () ??
92 ;; - delete-file (file) TEST IT
93 ;; - rename-file (old new) OK
94 ;; - find-file-hook () PROBABLY NOT NEEDED
96 ;; 2) Implement Stefan Monnier's advice:
97 ;; vc-hg-registered and vc-hg-state
98 ;; Both of those functions should be super extra careful to fail gracefully in
99 ;; unexpected circumstances. The reason this is important is that any error
100 ;; there will prevent the user from even looking at the file :-(
101 ;; Ideally, just like in vc-arch and vc-cvs, checking that the file is under
102 ;; mercurial's control and extracting the current revision should be done
103 ;; without even using `hg' (this way even if you don't have `hg' installed,
104 ;; Emacs is able to tell you this file is under mercurial's control).
116 ;;; Customization options
118 (defcustom vc-hg-global-switches nil
119 "Global switches to pass to any Hg command."
120 :type '(choice (const :tag "None" nil)
121 (string :tag "Argument String")
122 (repeat :tag "Argument List" :value ("") string))
126 (defcustom vc-hg-diff-switches t ; Hg doesn't support common args like -u
127 "String or list of strings specifying switches for Hg diff under VC.
128 If nil, use the value of `vc-diff-switches'. If t, use no switches."
129 :type '(choice (const :tag "Unspecified" nil)
130 (const :tag "None" t)
131 (string :tag "Argument String")
132 (repeat :tag "Argument List" :value ("") string))
137 ;;; Properties of the backend
139 (defun vc-hg-revision-granularity () 'repository)
140 (defun vc-hg-checkout-model (files) 'implicit)
142 ;;; State querying functions
144 ;;;###autoload (defun vc-hg-registered (file)
145 ;;;###autoload "Return non-nil if FILE is registered with hg."
146 ;;;###autoload (if (vc-find-root file ".hg") ; short cut
147 ;;;###autoload (progn
148 ;;;###autoload (load "vc-hg")
149 ;;;###autoload (vc-hg-registered file))))
151 ;; Modeled after the similar function in vc-bzr.el
152 (defun vc-hg-registered (file)
153 "Return non-nil if FILE is registered with hg."
154 (when (vc-hg-root file) ; short cut
155 (let ((state (vc-hg-state file))) ; expensive
156 (and state (not (memq state '(ignored unregistered)))))))
158 (defun vc-hg-state (file)
159 "Hg-specific version of `vc-state'."
162 (default-directory (file-name-directory file))
164 (with-output-to-string
169 ;; Ignore all errors.
170 (let ((process-environment
171 ;; Avoid localization of messages so we
172 ;; can parse the output.
173 (append (list "TERM=dumb" "LANGUAGE=C" "HGRCPATH=")
174 process-environment)))
177 "status" "-A" (file-relative-name file)))
178 ;; Some problem happened. E.g. We can't find an `hg'
182 (when (null (string-match ".*: No such file or directory$" out))
183 (let ((state (aref out 0)))
185 ((eq state ?=) 'up-to-date)
186 ((eq state ?A) 'added)
187 ((eq state ?M) 'edited)
188 ((eq state ?I) 'ignored)
189 ((eq state ?R) 'removed)
190 ((eq state ?!) 'missing)
191 ((eq state ??) 'unregistered)
192 ((eq state ?C) 'up-to-date) ;; Older mercurials use this
193 (t 'up-to-date)))))))
195 (defun vc-hg-working-revision (file)
196 "Hg-specific version of `vc-working-revision'."
199 (default-directory (file-name-directory file))
200 ;; Avoid localization of messages so we can parse the output.
201 (avoid-local-env (append (list "TERM=dumb" "LANGUAGE=C" "HGRCPATH=")
202 process-environment))
204 (with-output-to-string
209 (let ((process-environment avoid-local-env))
210 ;; Ignore all errors.
213 "parents" "--template" "{rev}" (file-relative-name file)))
214 ;; Some problem happened. E.g. We can't find an `hg'
219 ;; Check if the file is in the 'added state, the above hg
220 ;; command does not distinguish between 'added and 'unregistered.
223 (let ((process-environment avoid-local-env))
226 ;; We use "log" here, if there's a faster command
227 ;; that returns true for an 'added file and false
228 ;; for an 'unregistered one, we could use that.
229 "log" "-l1" (file-relative-name file)))
230 ;; Some problem happened. E.g. We can't find an `hg'
233 (when (eq 0 status) "0"))))
235 ;;; History functions
237 (defcustom vc-hg-log-switches nil
238 "String or list of strings specifying switches for hg log under VC."
239 :type '(choice (const :tag "None" nil)
240 (string :tag "Argument String")
241 (repeat :tag "Argument List" :value ("") string))
244 (defun vc-hg-print-log (files buffer &optional shortlog start-revision limit)
245 "Get change log associated with FILES."
246 ;; `vc-do-command' creates the buffer, but we need it before running
248 (vc-setup-buffer buffer)
249 ;; If the buffer exists from a previous invocation it might be
251 (let ((inhibit-read-only t))
254 (apply 'vc-hg-command buffer 0 files "log"
256 (when start-revision (list (format "-r%s:" start-revision)))
257 (when limit (list "-l" (format "%s" limit)))
258 (when shortlog (list "--style" "compact"))
259 vc-hg-log-switches)))))
261 (defvar log-view-message-re)
262 (defvar log-view-file-re)
263 (defvar log-view-font-lock-keywords)
264 (defvar log-view-per-file-logs)
266 (define-derived-mode vc-hg-log-view-mode log-view-mode "Hg-Log-View"
267 (require 'add-log) ;; we need the add-log faces
268 (set (make-local-variable 'log-view-file-re) "\\`a\\`")
269 (set (make-local-variable 'log-view-per-file-logs) nil)
270 (set (make-local-variable 'log-view-message-re)
271 (if (eq vc-log-view-type 'short)
272 "^\\([0-9]+\\)\\(\\[.*\\]\\)? +\\([0-9a-z]\\{12\\}\\) +\\(\\(?:[0-9]+\\)-\\(?:[0-9]+\\)-\\(?:[0-9]+\\) \\(?:[0-9]+\\):\\(?:[0-9]+\\) \\(?:[-+0-9]+\\)\\) +\\(.*\\)$"
273 "^changeset:[ \t]*\\([0-9]+\\):\\(.+\\)"))
274 (set (make-local-variable 'log-view-font-lock-keywords)
275 (if (eq vc-log-view-type 'short)
276 (append `((,log-view-message-re
277 (1 'log-view-message-face)
278 (2 'highlight nil lax)
279 (3 'log-view-message-face)
281 (5 'change-log-name))))
283 log-view-font-lock-keywords
286 ;; user: FirstName LastName <foo@bar>
287 ("^user:[ \t]+\\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]"
289 (2 'change-log-email))
294 ("^user:[ \t]+\\([A-Za-z0-9_.+-]+\\(?:@[A-Za-z0-9_.-]+\\)?\\)"
295 (1 'change-log-email))
296 ("^date: \\(.+\\)" (1 'change-log-date))
297 ("^tag: +\\([^ ]+\\)$" (1 'highlight))
298 ("^summary:[ \t]+\\(.+\\)" (1 'log-view-message)))))))
300 (defun vc-hg-diff (files &optional oldvers newvers buffer)
301 "Get a difference report using hg between two revisions of FILES."
302 (let* ((firstfile (car files))
303 (working (and firstfile (vc-working-revision firstfile))))
304 (when (and (equal oldvers working) (not newvers))
306 (when (and (not oldvers) newvers)
307 (setq oldvers working))
308 (apply #'vc-hg-command (or buffer "*vc-diff*") nil files "diff"
310 (vc-switches 'hg 'diff)
313 (list "-r" oldvers "-r" newvers)
314 (list "-r" oldvers)))))))
316 (defun vc-hg-revision-table (files)
317 (let ((default-directory (file-name-directory (car files))))
319 (vc-hg-command t nil files "log" "--template" "{rev} ")
321 (buffer-substring-no-properties (point-min) (point-max))))))
323 ;; Modeled after the similar function in vc-cvs.el
324 (defun vc-hg-revision-completion-table (files)
325 (lexical-let ((files files)
327 (setq table (lazy-completion-table
328 table (lambda () (vc-hg-revision-table files))))
331 (defun vc-hg-annotate-command (file buffer &optional revision)
332 "Execute \"hg annotate\" on FILE, inserting the contents in BUFFER.
333 Optional arg REVISION is a revision to annotate from."
334 (vc-hg-command buffer 0 file "annotate" "-d" "-n" "--follow"
335 (when revision (concat "-r" revision))))
337 (declare-function vc-annotate-convert-time "vc-annotate" (time))
339 ;; The format for one line output by "hg annotate -d -n" looks like this:
340 ;;215 Wed Jun 20 21:22:58 2007 -0700: CONTENTS
341 ;; i.e: VERSION_NUMBER DATE: CONTENTS
342 ;; If the user has set the "--follow" option, the output looks like:
343 ;;215 Wed Jun 20 21:22:58 2007 -0700 foo.c: CONTENTS
344 ;; i.e. VERSION_NUMBER DATE FILENAME: CONTENTS
345 (defconst vc-hg-annotate-re
346 "^[ \t]*\\([0-9]+\\) \\(.\\{30\\}\\)\\(?:\\(: \\)\\|\\(?: +\\(.+\\): \\)\\)")
348 (defun vc-hg-annotate-time ()
349 (when (looking-at vc-hg-annotate-re)
350 (goto-char (match-end 0))
351 (vc-annotate-convert-time
352 (date-to-time (match-string-no-properties 2)))))
354 (defun vc-hg-annotate-extract-revision-at-line ()
357 (when (looking-at vc-hg-annotate-re)
358 (if (match-beginning 3)
359 (match-string-no-properties 1)
360 (cons (match-string-no-properties 1)
361 (expand-file-name (match-string-no-properties 4)
362 (vc-hg-root default-directory)))))))
364 (defun vc-hg-previous-revision (file rev)
365 (let ((newrev (1- (string-to-number rev))))
367 (number-to-string newrev))))
369 (defun vc-hg-next-revision (file rev)
370 (let ((newrev (1+ (string-to-number rev)))
373 (vc-hg-command t 0 nil "tip")
374 (goto-char (point-min))
375 (re-search-forward "^changeset:[ \t]*\\([0-9]+\\):")
376 (string-to-number (match-string-no-properties 1)))))
377 ;; We don't want to exceed the maximum possible revision number, ie
379 (when (<= newrev tip-revision)
380 (number-to-string newrev))))
382 ;; Modeled after the similar function in vc-bzr.el
383 (defun vc-hg-delete-file (file)
384 "Delete FILE and delete it in the hg repository."
388 (vc-hg-command nil 0 file "remove" "--after" "--force"))
390 ;; Modeled after the similar function in vc-bzr.el
391 (defun vc-hg-rename-file (old new)
392 "Rename file from OLD to NEW using `hg mv'."
393 (vc-hg-command nil 0 new "mv" old))
395 (defun vc-hg-register (files &optional rev comment)
396 "Register FILES under hg.
399 (vc-hg-command nil 0 files "add"))
401 (defun vc-hg-create-repo ()
402 "Create a new Mercurial repository."
403 (vc-hg-command nil 0 nil "init"))
405 (defalias 'vc-hg-responsible-p 'vc-hg-root)
407 ;; Modeled after the similar function in vc-bzr.el
408 (defun vc-hg-could-register (file)
409 "Return non-nil if FILE could be registered under hg."
410 (and (vc-hg-responsible-p file) ; shortcut
413 (vc-hg-command t nil file "add" "--dry-run"))
414 ;; The command succeeds with no output if file is
418 ;; FIXME: This would remove the file. Is that correct?
419 ;; (defun vc-hg-unregister (file)
420 ;; "Unregister FILE from hg."
421 ;; (vc-hg-command nil nil file "remove"))
423 (declare-function log-edit-extract-headers "log-edit" (headers string))
425 (defun vc-hg-checkin (files rev comment)
426 "Hg-specific version of `vc-backend-checkin'.
428 (apply 'vc-hg-command nil 0 files
429 (nconc (list "commit" "-m")
430 (log-edit-extract-headers '(("Author" . "--user")
434 (defun vc-hg-find-revision (file rev buffer)
435 (let ((coding-system-for-read 'binary)
436 (coding-system-for-write 'binary))
438 (vc-hg-command buffer 0 file "cat" "-r" rev)
439 (vc-hg-command buffer 0 file "cat"))))
441 ;; Modeled after the similar function in vc-bzr.el
442 (defun vc-hg-checkout (file &optional editable rev)
443 "Retrieve a revision of FILE.
445 REV is the revision to check out into WORKFILE."
446 (let ((coding-system-for-read 'binary)
447 (coding-system-for-write 'binary))
448 (with-current-buffer (or (get-file-buffer file) (current-buffer))
450 (vc-hg-command t 0 file "cat" "-r" rev)
451 (vc-hg-command t 0 file "cat")))))
453 ;; Modeled after the similar function in vc-bzr.el
454 (defun vc-hg-workfile-unchanged-p (file)
455 (eq 'up-to-date (vc-hg-state file)))
457 ;; Modeled after the similar function in vc-bzr.el
458 (defun vc-hg-revert (file &optional contents-done)
459 (unless contents-done
460 (with-temp-buffer (vc-hg-command t 0 file "revert"))))
462 ;;; Hg specific functionality.
464 (defvar vc-hg-extra-menu-map
465 (let ((map (make-sparse-keymap)))
468 (defun vc-hg-extra-menu () vc-hg-extra-menu-map)
470 (defun vc-hg-extra-status-menu () vc-hg-extra-menu-map)
472 (defvar log-view-vc-backend)
474 (defstruct (vc-hg-extra-fileinfo
476 (:constructor vc-hg-create-extra-fileinfo (rename-state extra-name))
477 (:conc-name vc-hg-extra-fileinfo->))
478 rename-state ;; rename or copy state
479 extra-name) ;; original name for copies and rename targets, new name for
481 (declare-function vc-default-dir-printer "vc-dir" (backend fileentry))
483 (defun vc-hg-dir-printer (info)
484 "Pretty-printer for the vc-dir-fileinfo structure."
485 (let ((extra (vc-dir-fileinfo->extra info)))
486 (vc-default-dir-printer 'Hg info)
490 (case (vc-hg-extra-fileinfo->rename-state extra)
491 ('copied "copied from")
492 ('renamed-from "renamed from")
493 ('renamed-to "renamed to"))
494 (vc-hg-extra-fileinfo->extra-name extra))
495 'face 'font-lock-comment-face)))))
497 (defun vc-hg-after-dir-status (update-function)
498 (let ((status-char nil)
500 (translation '((?= . up-to-date)
507 (? . copy-rename-line)
508 (?? . unregistered)))
512 (last-line-copy nil))
513 (goto-char (point-min))
515 (setq translated (cdr (assoc (char-after) translation)))
517 (buffer-substring-no-properties (+ (point) 2)
518 (line-end-position)))
519 (cond ((not translated)
520 (setq last-line-copy nil))
521 ((eq translated 'up-to-date)
522 (setq last-line-copy nil))
523 ((eq translated 'copy-rename-line)
524 ;; For copied files the output looks like this:
525 ;; A COPIED_FILE_NAME
526 ;; ORIGINAL_FILE_NAME
527 (setf (nth 2 last-added)
528 (vc-hg-create-extra-fileinfo 'copied file))
529 (setq last-line-copy t))
530 ((and last-line-copy (eq translated 'removed))
531 ;; For renamed files the output looks like this:
533 ;; ORIGINAL_FILE_NAME
534 ;; R ORIGINAL_FILE_NAME
535 ;; We need to adjust the previous entry to not think it is a copy.
536 (setf (vc-hg-extra-fileinfo->rename-state (nth 2 last-added))
538 (push (list file translated
539 (vc-hg-create-extra-fileinfo
540 'renamed-to (nth 0 last-added))) result)
541 (setq last-line-copy nil))
543 (setq last-added (list file translated nil))
544 (push last-added result)
545 (setq last-line-copy nil)))
547 (funcall update-function result)))
549 (defun vc-hg-dir-status (dir update-function)
550 (vc-hg-command (current-buffer) 'async dir "status" "-C")
552 `(vc-hg-after-dir-status (quote ,update-function))))
554 (defun vc-hg-dir-status-files (dir files default-state update-function)
555 (apply 'vc-hg-command (current-buffer) 'async dir "status" "-C" files)
557 `(vc-hg-after-dir-status (quote ,update-function))))
559 (defun vc-hg-dir-extra-header (name &rest commands)
560 (concat (propertize name 'face 'font-lock-type-face)
563 (apply 'vc-hg-command (current-buffer) 0 nil commands)
564 (buffer-substring-no-properties (point-min) (1- (point-max))))
565 'face 'font-lock-variable-name-face)))
567 (defun vc-hg-dir-extra-headers (dir)
568 "Generate extra status headers for a Mercurial tree."
569 (let ((default-directory dir))
571 (vc-hg-dir-extra-header "Root : " "root") "\n"
572 (vc-hg-dir-extra-header "Branch : " "id" "-b") "\n"
573 (vc-hg-dir-extra-header "Tags : " "id" "-t") ; "\n"
574 ;; these change after each commit
575 ;; (vc-hg-dir-extra-header "Local num : " "id" "-n") "\n"
576 ;; (vc-hg-dir-extra-header "Global id : " "id" "-i")
579 (defun vc-hg-log-incoming (buffer remote-location)
580 (vc-hg-command buffer 1 nil "incoming" "-n" (unless (string= remote-location "")
583 (defun vc-hg-log-outgoing (buffer remote-location)
584 (vc-hg-command buffer 1 nil "outgoing" "-n" (unless (string= remote-location "")
587 (declare-function log-view-get-marked "log-view" ())
589 ;; XXX maybe also add key bindings for these functions.
592 (let ((marked-list (log-view-get-marked)))
594 (apply #'vc-hg-command
598 (mapcar (lambda (arg) (list "-r" arg)) marked-list)))
599 (error "No log entries selected for push"))))
603 (let ((marked-list (log-view-get-marked)))
605 (apply #'vc-hg-command
609 (mapcar (lambda (arg) (list "-r" arg)) marked-list)))
610 (error "No log entries selected for pull"))))
612 ;;; Internal functions
614 (defun vc-hg-command (buffer okstatus file-or-list &rest flags)
615 "A wrapper around `vc-do-command' for use in vc-hg.el.
616 The difference to vc-do-command is that this function always invokes `hg',
617 and that it passes `vc-hg-global-switches' to it before FLAGS."
618 (apply 'vc-do-command (or buffer "*vc*") okstatus "hg" file-or-list
619 (if (stringp vc-hg-global-switches)
620 (cons vc-hg-global-switches flags)
621 (append vc-hg-global-switches
624 (defun vc-hg-root (file)
625 (vc-find-root file ".hg"))
629 ;; arch-tag: bd094dc5-715a-434f-a331-37b9fb7cd954
630 ;;; vc-hg.el ends here