* log-view.el (log-view-diff-changeset): New function.
[bpt/emacs.git] / lisp / vc-hg.el
index b3482dd..663609d 100644 (file)
@@ -1,16 +1,16 @@
 ;;; vc-hg.el --- VC backend for the mercurial version control system
 
-;; Copyright (C) 2006, 2007 Free Software Foundation, Inc.
+;; Copyright (C) 2006, 2007, 2008 Free Software Foundation, Inc.
 
 ;; Author: Ivan Kanis
 ;; Keywords: tools
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, 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
@@ -18,9 +18,7 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; 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.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
@@ -34,7 +32,7 @@
 
 ;;; Todo:
 
-;; Implement the rest of the vc interface. See the comment at the
+;; 1) Implement the rest of the vc interface. See the comment at the
 ;; beginning of vc.el. The current status is:
 
 ;; FUNCTION NAME                               STATUS
 ;; STATE-QUERYING FUNCTIONS
 ;; * registered (file)                         OK
 ;; * state (file)                              OK
-;; - state-heuristic (file)                    ?? PROBABLY NOT NEEDED
-;; - dir-state (dir)                           OK
+;; - state-heuristic (file)                    NOT NEEDED
 ;; * working-revision (file)                   OK
 ;; - latest-on-branch-p (file)                 ??
-;; * checkout-model (file                    OK
+;; * checkout-model (files)                    OK
 ;; - workfile-unchanged-p (file)               OK
 ;; - mode-line-string (file)                   NOT NEEDED
-;; - dired-state-info (file)                   OK
+;; - prettify-state-info (file)                OK
 ;; STATE-CHANGING FUNCTIONS
 ;; * register (files &optional rev comment)    OK
 ;; * create-repo ()                            OK
-;; - init-revision ()                           NOT NEEDED
+;; - init-revision ()                          NOT NEEDED
 ;; - responsible-p (file)                      OK
 ;; - could-register (file)                     OK
 ;; - receive-file (file rev)                   ?? PROBABLY NOT NEEDED
 ;; - unregister (file)                         COMMENTED OUT, MAY BE INCORRECT
 ;; * checkin (files rev comment)               OK
-;; * find-revision (file rev buffer)            OK
+;; * find-revision (file rev buffer)           OK
 ;; * checkout (file &optional editable rev)    OK
 ;; * revert (file &optional contents-done)     OK
-;; - rollback (files)                          ?? PROBABLY NOT NEEDED   
+;; - rollback (files)                          ?? PROBABLY NOT NEEDED
 ;; - merge (file rev1 rev2)                    NEEDED
 ;; - merge-news (file)                         NEEDED
-;; - steal-lock (file &optional revision)       NOT NEEDED
+;; - steal-lock (file &optional revision)      NOT NEEDED
 ;; HISTORY FUNCTIONS
 ;; * print-log (files &optional buffer)        OK
 ;; - log-view-mode ()                          OK
-;; - show-log-entry (revision)                  NOT NEEDED, DEFAULT IS GOOD
-;; - wash-log (file)                           ??
-;; - logentry-check ()                         NOT NEEDED
+;; - show-log-entry (revision)                 NOT NEEDED, DEFAULT IS GOOD
 ;; - comment-history (file)                    NOT NEEDED
 ;; - update-changelog (files)                  NOT NEEDED
 ;; * diff (files &optional rev1 rev2 buffer)   OK
 ;; - revision-completion-table (files)         OK?
 ;; - annotate-command (file buf &optional rev) OK
 ;; - annotate-time ()                          OK
-;; - annotate-current-time ()                  ?? NOT NEEDED
+;; - annotate-current-time ()                  NOT NEEDED
 ;; - annotate-extract-revision-at-line ()      OK
-;; SNAPSHOT SYSTEM
-;; - create-snapshot (dir name branchp)        NEEDED (probably branch?)
-;; - assign-name (file name)                   NOT NEEDED
-;; - retrieve-snapshot (dir name update)       ?? NEEDED??
+;; TAG SYSTEM
+;; - create-tag (dir name branchp)       NEEDED
+;; - retrieve-tag (dir name update)       NEEDED
 ;; MISCELLANEOUS
 ;; - make-version-backups-p (file)             ??
-;; - repository-hostname (dirname)             ?? 
-;; - previous-revision (file rev)               OK
-;; - next-revision (file rev)                   OK
+;; - repository-hostname (dirname)             ??
+;; - previous-revision (file rev)              OK
+;; - next-revision (file rev)                  OK
 ;; - check-headers ()                          ??
 ;; - clear-headers ()                          ??
 ;; - delete-file (file)                        TEST IT
@@ -97,7 +91,7 @@
 ;; - find-file-hook ()                         PROBABLY NOT NEEDED
 ;; - find-file-not-found-hook ()               PROBABLY NOT NEEDED
 
-;; Implement Stefan Monnier's advice:
+;; 2) 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 reason this is important is that any error
 \f
 ;;; Properties of the backend
 
-(defun vc-hg-revision-granularity ()
-     'repository)
+(defun vc-hg-revision-granularity () 'repository)
+(defun vc-hg-checkout-model (files) 'implicit)
 
 ;;; State querying functions
 
   (when (vc-hg-root file)           ; short cut
     (let ((state (vc-hg-state file)))  ; expensive
       (vc-file-setprop file 'vc-state state)
-      (not (memq state '(ignored unregistered))))))
+      (and state (not (memq state '(ignored unregistered)))))))
 
 (defun vc-hg-state (file)
   "Hg-specific version of `vc-state'."
-  (let* 
+  (let*
       ((status nil)
        (out
        (with-output-to-string
        (when (null (string-match ".*: No such file or directory$" out))
          (let ((state (aref out 0)))
            (cond
-            ((eq state ?C) 'up-to-date)
-            ((eq state ?A) 'edited)
+            ((eq state ?=) 'up-to-date)
+            ((eq state ?A) 'added)
             ((eq state ?M) 'edited)
             ((eq state ?I) 'ignored)
-            ((eq state ?R) 'unregistered)
+            ((eq state ?R) 'removed)
+            ((eq state ?!) 'missing)
             ((eq state ??) 'unregistered)
+            ((eq state ?C) 'up-to-date) ;; Older mercurials use this
             (t 'up-to-date)))))))
 
-(defun vc-hg-dir-state (dir)
-  (with-temp-buffer
-    (buffer-disable-undo)              ;; Because these buffers can get huge
-    (vc-hg-command (current-buffer) nil nil "status" "-A")
-    (goto-char (point-min))
-    (let ((status-char nil)
-         (file nil))
-      (while (not (eobp))
-       (setq status-char (char-after))
-       (setq file 
-             (expand-file-name
-              (buffer-substring-no-properties (+ (point) 2) 
-                                              (line-end-position))))
-       (cond
-        ;; The rest of the possible states in "hg status" output:
-        ;;      R = removed
-        ;;      ! = deleted, but still tracked
-        ;; should not show up in vc-dired, so don't deal with them
-        ;; here.
-        ((eq status-char ?C)
-         (vc-file-setprop file 'vc-state 'up-to-date))
-        ((eq status-char ?A)
-         (vc-file-setprop file 'vc-working-revision "0")
-         (vc-file-setprop file 'vc-state 'edited))
-        ((eq status-char ?M)
-         (vc-file-setprop file 'vc-state 'edited))
-        ((eq status-char ?I)
-         (vc-file-setprop file 'vc-state 'ignored))
-        ((eq status-char ??)
-         (vc-file-setprop file 'vc-backend 'none)
-         (vc-file-setprop file 'vc-state 'unregistered)))
-       (forward-line)))))
-
 (defun vc-hg-working-revision (file)
   "Hg-specific version of `vc-working-revision'."
-  (let* 
+  (let*
       ((status nil)
        (out
        (with-output-to-string
   ;; If the buffer exists from a previous invocation it might be
   ;; read-only.
   (let ((inhibit-read-only t))
-    ;; We need to loop and call "hg log" on each file separately. 
-    ;; "hg log" with multiple file arguments mashes all the logs
-    ;; together.  Ironically enough, this puts us back near CVS
-    ;; which can't generate proper fileset logs either.
-    (dolist (file files)
-      (with-current-buffer
-         buffer
-       (insert "Working file: " file "\n"))    ;; Like RCS/CVS.
-      (vc-hg-command buffer 0 file "log"))))
+    (with-current-buffer
+       buffer
+      (vc-hg-command buffer 0 files "log"))))
 
 (defvar log-view-message-re)
 (defvar log-view-file-re)
 (defvar log-view-font-lock-keywords)
+(defvar log-view-per-file-logs)
 
 (define-derived-mode vc-hg-log-view-mode log-view-mode "Hg-Log-View"
   (require 'add-log) ;; we need the add-log faces
-  (set (make-local-variable 'log-view-file-re) "^Working file:[ \t]+\\(.+\\)")
+  (set (make-local-variable 'log-view-file-re) "\\`a\\`")
+  (set (make-local-variable 'log-view-per-file-logs) nil)
   (set (make-local-variable 'log-view-message-re)
        "^changeset:[ \t]*\\([0-9]+\\):\\(.+\\)")
   (set (make-local-variable 'log-view-font-lock-keywords)
        (append
        log-view-font-lock-keywords
-       ;; 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))
+         ;; Handle the cases:
+         ;; user: foo@bar
+         ;; and
+         ;; user: foo
+         ("^user:[ \t]+\\([A-Za-z0-9_.+-]+\\(?:@[A-Za-z0-9_.-]+\\)?\\)"
+          (1 'change-log-email))
          ("^date: \\(.+\\)" (1 'change-log-date))
          ("^summary:[ \t]+\\(.+\\)" (1 'log-view-message))))))
 
 (defun vc-hg-diff (files &optional oldvers newvers buffer)
   "Get a difference report using hg between two revisions of FILES."
-  (let ((working (vc-working-revision (car files))))
-    (if (and (equal oldvers working) (not newvers))
-       (setq oldvers nil))
-    (if (and (not oldvers) newvers)
-       (setq oldvers working))
+  (let* ((firstfile (car files))
+        (working (and firstfile (vc-working-revision firstfile))))
+    (when (and (equal oldvers working) (not newvers))
+      (setq oldvers nil))
+    (when (and (not oldvers) newvers)
+      (setq oldvers working))
     (apply #'vc-hg-command (or buffer "*vc-diff*") nil
           (mapcar (lambda (file) (file-name-nondirectory file)) files)
-          "--cwd" (file-name-directory (car files))
+          "--cwd" (or (when firstfile (file-name-directory firstfile))
+                      (expand-file-name default-directory))
           "diff"
           (append
-           (if oldvers
-               (if newvers
-                   (list "-r" oldvers "-r" newvers)
-                 (list "-r" oldvers))
-             (list ""))))))
+           (when oldvers
+             (if newvers
+                 (list "-r" oldvers "-r" newvers)
+               (list "-r" oldvers)))))))
 
 (defun vc-hg-revision-table (files)
   (let ((default-directory (file-name-directory (car files))))
     (with-temp-buffer
       (vc-hg-command t nil files "log" "--template" "{rev} ")
-      (split-string 
+      (split-string
        (buffer-substring-no-properties (point-min) (point-max))))))
 
 ;; Modelled after the similar function in vc-cvs.el
 (defun vc-hg-annotate-command (file buffer &optional revision)
   "Execute \"hg annotate\" on FILE, inserting the contents in BUFFER.
 Optional arg REVISION is a revision to annotate from."
-  (vc-hg-command buffer 0 file "annotate" "-d" "-n" (if revision (concat "-r" revision)))
+  (vc-hg-command buffer 0 file "annotate" "-d" "-n"
+                (when revision (concat "-r" revision)))
   (with-current-buffer buffer
     (goto-char (point-min))
-    (re-search-forward "^[0-9]")
-    (delete-region (point-min) (1- (point)))))
+    (re-search-forward "^[ \t]*[0-9]")
+    (delete-region (point-min) (match-beginning 0))))
 
 
 ;; 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\\}\\): ")
+;; If the user has set the "--follow" option, the output looks like:
+;;215 Wed Jun 20 21:22:58 2007 -0700 foo.c: CONTENTS
+;; i.e. VERSION_NUMBER DATE FILENAME: CONTENTS
+(defconst vc-hg-annotate-re
+  "^[ \t]*\\([0-9]+\\) \\(.\\{30\\}\\)[^:\n]*\\(:[^ \n][^:\n]*\\)*: ")
 
 (defun vc-hg-annotate-time ()
   (when (looking-at vc-hg-annotate-re)
@@ -340,7 +308,7 @@ Optional arg REVISION is a revision to annotate from."
 (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))))
+    (when (looking-at vc-hg-annotate-re) (match-string-no-properties 1))))
 
 (defun vc-hg-previous-revision (file rev)
   (let ((newrev (1- (string-to-number rev))))
@@ -349,7 +317,7 @@ Optional arg REVISION is a revision to annotate from."
 
 (defun vc-hg-next-revision (file rev)
   (let ((newrev (1+ (string-to-number rev)))
-       (tip-revision 
+       (tip-revision
         (with-temp-buffer
           (vc-hg-command t 0 nil "tip")
           (goto-char (point-min))
@@ -371,7 +339,7 @@ Optional arg REVISION is a revision to annotate from."
 ;; Modelled after the similar function in vc-bzr.el
 (defun vc-hg-rename-file (old new)
   "Rename file from OLD to NEW using `hg mv'."
-  (vc-hg-command nil 0 new old "mv"))
+  (vc-hg-command nil 0 new "mv" old))
 
 (defun vc-hg-register (files &optional rev comment)
   "Register FILES under hg.
@@ -425,22 +393,10 @@ REV is the revision to check out into WORKFILE."
         (vc-hg-command t 0 file "cat" "-r" rev)
       (vc-hg-command t 0 file "cat")))))
 
-(defun vc-hg-checkout-model (file)
-  'implicit)
-
 ;; Modelled after the similar function in vc-bzr.el
 (defun vc-hg-workfile-unchanged-p (file)
   (eq 'up-to-date (vc-hg-state file)))
 
-(defun vc-hg-dired-state-info (file)
-  "Hg-specific version of `vc-dired-state-info'."
-  (let ((hg-state (vc-state file)))
-    (if (eq hg-state 'edited)
-       (if (equal (vc-working-revision file) "0")
-           "(added)" "(modified)")
-      ;; fall back to the default VC representation
-      (vc-default-dired-state-info 'Hg file))))
-
 ;; Modelled after the similar function in vc-bzr.el
 (defun vc-hg-revert (file &optional contents-done)
   (unless contents-done
@@ -448,8 +404,6 @@ REV is the revision to check out into WORKFILE."
 
 ;;; Hg specific functionality.
 
-;;; XXX This functionality is experimental/work in progress. It might
-;;; change without notice.
 (defvar vc-hg-extra-menu-map
   (let ((map (make-sparse-keymap)))
     (define-key map [incoming] '(menu-item "Show incoming" vc-hg-incoming))
@@ -458,10 +412,110 @@ REV is the revision to check out into WORKFILE."
 
 (defun vc-hg-extra-menu () vc-hg-extra-menu-map)
 
+(defun vc-hg-extra-status-menu () vc-hg-extra-menu-map)
+
 (define-derived-mode vc-hg-outgoing-mode vc-hg-log-view-mode "Hg-Outgoing")
 
 (define-derived-mode vc-hg-incoming-mode vc-hg-log-view-mode "Hg-Incoming")
 
+(defstruct (vc-hg-extra-fileinfo
+            (:copier nil)
+            (:constructor vc-hg-create-extra-fileinfo (rename-state extra-name))
+            (:conc-name vc-hg-extra-fileinfo->))
+  rename-state        ;; rename or copy state
+  extra-name)         ;; original name for copies and rename targets, new name for
+
+(defun vc-hg-status-printer (info)
+  "Pretty-printer for the vc-dir-fileinfo structure."
+  (let ((extra (vc-dir-fileinfo->extra info)))
+    (vc-default-status-printer 'Hg info)
+    (when extra
+      (insert (propertize
+              (format "   (%s %s)"
+                      (case (vc-hg-extra-fileinfo->rename-state extra)
+                        ('copied "copied from")
+                        ('renamed-from "renamed from")
+                        ('renamed-to "renamed to"))
+                      (vc-hg-extra-fileinfo->extra-name extra))
+              'face 'font-lock-comment-face)))))
+
+(defun vc-hg-after-dir-status (update-function)
+  (let ((status-char nil)
+       (file nil)
+       (translation '((?= . up-to-date)
+                      (?C . up-to-date)
+                      (?A . added)
+                      (?R . removed)
+                      (?M . edited)
+                      (?I . ignored)
+                      (?! . missing)
+                      (?  . copy-rename-line)
+                      (?? . unregistered)))
+       (translated nil)
+       (result nil)
+       (last-added nil)
+       (last-line-copy nil))
+      (goto-char (point-min))
+      (while (not (eobp))
+       (setq translated (cdr (assoc (char-after) translation)))
+       (setq file
+             (buffer-substring-no-properties (+ (point) 2)
+                                             (line-end-position)))
+       (cond ((not translated)
+              (setq last-line-copy nil))
+             ((eq translated 'up-to-date)
+              (setq last-line-copy nil))
+             ((eq translated 'copy-rename-line)
+              ;; For copied files the output looks like this:
+              ;; A COPIED_FILE_NAME
+              ;;   ORIGINAL_FILE_NAME
+              (setf (nth 2 last-added)
+                    (vc-hg-create-extra-fileinfo 'copied file))
+              (setq last-line-copy t))
+             ((and last-line-copy (eq translated 'removed))
+              ;; For renamed files the output looks like this:
+              ;; A NEW_FILE_NAME
+              ;;   ORIGINAL_FILE_NAME
+              ;; R ORIGINAL_FILE_NAME
+              ;; We need to adjust the previous entry to not think it is a copy.
+              (setf (vc-hg-extra-fileinfo->rename-state (nth 2 last-added))
+                    'renamed-from)
+              (push (list file translated
+                          (vc-hg-create-extra-fileinfo
+                           'renamed-to (nth 0 last-added))) result)
+              (setq last-line-copy nil))
+             (t
+              (setq last-added (list file translated nil))
+              (push last-added result)
+              (setq last-line-copy nil)))
+       (forward-line))
+      (funcall update-function result)))
+
+(defun vc-hg-dir-status (dir update-function)
+  (vc-hg-command (current-buffer) 'async dir "status" "-C")
+  (vc-exec-after
+   `(vc-hg-after-dir-status (quote ,update-function))))
+
+(defun vc-hg-status-extra-header (name &rest commands)
+  (concat (propertize name 'face 'font-lock-type-face)
+          (propertize
+           (with-temp-buffer
+             (apply 'vc-hg-command (current-buffer) 0 nil commands)
+             (buffer-substring-no-properties (point-min) (1- (point-max))))
+           'face 'font-lock-variable-name-face)))
+
+(defun vc-hg-status-extra-headers (dir)
+  "Generate extra status headers for a Mercurial tree."
+  (let ((default-directory dir))
+    (concat
+     (vc-hg-status-extra-header "Root       : " "root") "\n"
+     (vc-hg-status-extra-header "Branch     : " "id" "-b") "\n"
+     (vc-hg-status-extra-header "Tags       : " "id" "-t") ; "\n"
+     ;; these change after each commit
+     ;; (vc-hg-status-extra-header "Local num  : " "id" "-n") "\n"
+     ;; (vc-hg-status-extra-header "Global id  : " "id" "-i")
+     )))
+
 ;; XXX this adds another top level menu, instead figure out how to
 ;; replace the Log-View menu.
 (easy-menu-define log-view-mode-menu vc-hg-outgoing-mode-map
@@ -495,7 +549,7 @@ REV is the revision to check out into WORKFILE."
   (interactive)
   (let ((marked-list (log-view-get-marked)))
     (if marked-list
-       (vc-hg-command 
+       (vc-hg-command
         nil 0 nil
         (cons "push"
               (apply 'nconc
@@ -506,7 +560,7 @@ REV is the revision to check out into WORKFILE."
   (interactive)
   (let ((marked-list (log-view-get-marked)))
     (if marked-list
-       (vc-hg-command 
+       (vc-hg-command
         nil 0 nil
         (cons "pull"
               (apply 'nconc
@@ -519,7 +573,7 @@ REV is the revision to check out into WORKFILE."
   "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-or-list
+  (apply 'vc-do-command (or buffer "*vc*") okstatus "hg" file-or-list
          (if (stringp vc-hg-global-switches)
              (cons vc-hg-global-switches flags)
            (append vc-hg-global-switches