stgit.el: Automatically update git-status buffer when necessary
[stgit] / contrib / stgit.el
index 5aaf311..61a0e76 100644 (file)
@@ -9,25 +9,39 @@
 ;;
 ;; To start: `M-x stgit'
 
+(require 'git nil t)
+
 (defun stgit (dir)
-  "Manage stgit patches"
+  "Manage StGit patches for the tree in DIR."
   (interactive "DDirectory: \n")
   (switch-to-stgit-buffer (git-get-top-dir dir))
-  (stgit-refresh))
-
-(defun git-get-top-dir (dir)
-  "Retrieve the top-level directory of a git tree."
-  (let ((cdup (with-output-to-string
-                (with-current-buffer standard-output
-                  (cd dir)
-                  (unless (eq 0 (call-process "git" nil t nil
-                                              "rev-parse" "--show-cdup"))
-                    (error "cannot find top-level git tree for %s." dir))))))
-    (expand-file-name (concat (file-name-as-directory dir)
-                              (car (split-string cdup "\n"))))))
+  (stgit-reload))
+
+(unless (fboundp 'git-get-top-dir)
+  (defun git-get-top-dir (dir)
+    "Retrieve the top-level directory of a git tree."
+    (let ((cdup (with-output-to-string
+                  (with-current-buffer standard-output
+                    (cd dir)
+                    (unless (eq 0 (call-process "git" nil t nil
+                                                "rev-parse" "--show-cdup"))
+                      (error "cannot find top-level git tree for %s." dir))))))
+      (expand-file-name (concat (file-name-as-directory dir)
+                                (car (split-string cdup "\n")))))))
+
+(defun stgit-refresh-git-status (&optional dir)
+  "If it exists, refresh the `git-status' buffer belonging to
+directory DIR or `default-directory'"
+  (when (and (fboundp 'git-find-status-buffer)
+             (fboundp 'git-refresh-status))
+    (let* ((top-dir (git-get-top-dir (or dir default-directory)))
+           (git-status-buffer (and top-dir (git-find-status-buffer top-dir))))
+      (when git-status-buffer
+        (with-current-buffer git-status-buffer
+          (git-refresh-status))))))
 
 (defun switch-to-stgit-buffer (dir)
-  "Switch to a (possibly new) buffer displaying StGit patches for DIR"
+  "Switch to a (possibly new) buffer displaying StGit patches for DIR."
   (setq dir (file-name-as-directory dir))
   (let ((buffers (buffer-list)))
     (while (and buffers
@@ -51,7 +65,7 @@ Argument DIR is the repository path."
     buf))
 
 (defmacro stgit-capture-output (name &rest body)
-  "Capture StGit output and show it in a window at the end"
+  "Capture StGit output and show it in a window at the end."
   `(let ((output-buf (get-buffer-create ,(or name "*StGit output*")))
          (stgit-dir default-directory)
          (inhibit-read-only t))
@@ -68,23 +82,30 @@ Argument DIR is the repository path."
            (display-buffer output-buf t)))))
 (put 'stgit-capture-output 'lisp-indent-function 1)
 
-(defun stgit-run (&rest args)
+(defun stgit-run-silent (&rest args)
   (apply 'call-process "stg" nil standard-output nil args))
 
-(defun stgit-refresh ()
-  "Update the contents of the stgit buffer"
+(defun stgit-run (&rest args)
+  (let ((msgcmd (mapconcat #'identity args " ")))
+    (message "Running stg %s..." msgcmd)
+    (apply 'call-process "stg" nil standard-output nil args)
+    (message "Running stg %s...done" msgcmd)))
+
+(defun stgit-reload ()
+  "Update the contents of the StGit buffer."
   (interactive)
   (let ((inhibit-read-only t)
         (curline (line-number-at-pos))
         (curpatch (stgit-patch-at-point)))
     (erase-buffer)
     (insert "Branch: ")
-    (stgit-run "branch")
-    (stgit-run "series" "--description")
+    (stgit-run-silent "branch")
+    (stgit-run-silent "series" "--description")
     (stgit-rescan)
     (if curpatch
         (stgit-goto-patch curpatch)
-      (goto-line curline))))
+      (goto-line curline)))
+  (stgit-refresh-git-status))
 
 (defface stgit-description-face
   '((((background dark)) (:foreground "tan"))
@@ -130,10 +151,29 @@ Argument DIR is the repository path."
                                     'face 'stgit-description-face)
                  (when (memq patchsym stgit-marked-patches)
                    (replace-match "*" nil nil nil 2)
-                   (setq marked (cons patchsym marked))))))
+                   (setq marked (cons patchsym marked)))))
+              ((or (looking-at "stg series: Branch \".*\" not initialised")
+                   (looking-at "stg series: .*: branch not initialized"))
+               (forward-line 1)
+               (insert "Run M-x stgit-init to initialise")))
         (forward-line 1))
       (setq stgit-marked-patches (nreverse marked)))))
 
+(defun stgit-quit ()
+  "Hide the stgit buffer."
+  (interactive)
+  (bury-buffer))
+
+(defun stgit-git-status ()
+  "Show status using `git-status'."
+  (interactive)
+  (unless (fboundp 'git-status)
+    (error "stgit-git-status requires git-status"))
+  (let ((dir default-directory))
+    (save-selected-window
+      (pop-to-buffer nil)
+      (git-status dir))))
+
 (defvar stgit-mode-hook nil
   "Run after `stgit-mode' is setup.")
 
@@ -143,26 +183,34 @@ Argument DIR is the repository path."
 (unless stgit-mode-map
   (setq stgit-mode-map (make-keymap))
   (suppress-keymap stgit-mode-map)
-  (define-key stgit-mode-map " "   'stgit-mark)
-  (define-key stgit-mode-map "\d" 'stgit-unmark)
-  (define-key stgit-mode-map "?"   'stgit-help)
-  (define-key stgit-mode-map "h"   'stgit-help)
-  (define-key stgit-mode-map "p"   'previous-line)
-  (define-key stgit-mode-map "n"   'next-line)
-  (define-key stgit-mode-map "g"   'stgit-refresh)
-  (define-key stgit-mode-map "r"   'stgit-rename)
-  (define-key stgit-mode-map "e"   'stgit-edit)
-  (define-key stgit-mode-map "c"   'stgit-coalesce)
-  (define-key stgit-mode-map "N"   'stgit-new)
-  (define-key stgit-mode-map "R"   'stgit-repair)
-  (define-key stgit-mode-map "C"   'stgit-commit)
-  (define-key stgit-mode-map "U"   'stgit-uncommit)
-  (define-key stgit-mode-map ">"   'stgit-push-next)
-  (define-key stgit-mode-map "<"   'stgit-pop-next)
-  (define-key stgit-mode-map "P"   'stgit-push-or-pop)
-  (define-key stgit-mode-map "G"   'stgit-goto)
-  (define-key stgit-mode-map "="   'stgit-show)
-  (define-key stgit-mode-map "D"   'stgit-delete))
+  (mapc (lambda (arg) (define-key stgit-mode-map (car arg) (cdr arg)))
+        '((" " .        stgit-mark)
+          ("m" .        stgit-mark)
+          ("\d" .       stgit-unmark-up)
+          ("u" .        stgit-unmark-down)
+          ("?" .        stgit-help)
+          ("h" .        stgit-help)
+          ("p" .        previous-line)
+          ("n" .        next-line)
+          ("s" .        stgit-git-status)
+          ("g" .        stgit-reload)
+          ("r" .        stgit-refresh)
+          ("\C-c\C-r" . stgit-rename)
+          ("e" .        stgit-edit)
+          ("c" .        stgit-coalesce)
+          ("N" .        stgit-new)
+          ("R" .        stgit-repair)
+          ("C" .        stgit-commit)
+          ("U" .        stgit-uncommit)
+          (">" .        stgit-push-next)
+          ("<" .        stgit-pop-next)
+          ("P" .        stgit-push-or-pop)
+          ("G" .        stgit-goto)
+          ("=" .        stgit-show)
+          ("D" .        stgit-delete)
+          ([(control ?/)] . stgit-undo)
+          ("\C-_" .     stgit-undo)
+          ("q" . stgit-quit))))
 
 (defun stgit-mode ()
   "Major mode for interacting with StGit.
@@ -187,17 +235,22 @@ Commands:
   (let ((patchsym (intern patch)))
     (setq stgit-marked-patches (delq patchsym stgit-marked-patches))))
 
+(defun stgit-clear-marks ()
+  (setq stgit-marked-patches '()))
+
 (defun stgit-marked-patches ()
   "Return the names of the marked patches."
   (mapcar 'symbol-name stgit-marked-patches))
 
-(defun stgit-patch-at-point ()
-  "Return the patch name on the current line"
+(defun stgit-patch-at-point (&optional cause-error)
+  "Return the patch name on the current line. If CAUSE-ERROR is
+not nil, signal an error if none found."
   (save-excursion
     (beginning-of-line)
-    (if (looking-at "[>+-][ *]\\([^ ]*\\)")
-        (match-string-no-properties 1)
-      nil)))
+    (cond ((looking-at "[>+-][ *]\\([^ ]*\\)")
+           (match-string-no-properties 1))
+          (cause-error
+           (error "No patch on this line")))))
 
 (defun stgit-patches-marked-or-at-point ()
   "Return the names of the marked patches, or the patch on the current line."
@@ -209,7 +262,7 @@ Commands:
         '()))))
 
 (defun stgit-goto-patch (patch)
-  "Move point to the line containing PATCH"
+  "Move point to the line containing PATCH."
   (let ((p (point)))
     (goto-char (point-min))
     (if (re-search-forward (concat "^[>+-][ *]" (regexp-quote patch) " ") nil t)
@@ -218,63 +271,79 @@ Commands:
       (goto-char p)
       nil)))
 
+(defun stgit-init ()
+  "Run stg init."
+  (interactive)
+  (stgit-capture-output nil
+    (stgit-run "init"))
+  (stgit-reload))
+
 (defun stgit-mark ()
-  "Mark the patch under point"
+  "Mark the patch under point."
   (interactive)
-  (let ((patch (stgit-patch-at-point)))
+  (let ((patch (stgit-patch-at-point t)))
     (stgit-add-mark patch)
-    (stgit-refresh))
+    (stgit-reload))
   (next-line))
 
-(defun stgit-unmark ()
-  "Mark the patch on the previous line"
+(defun stgit-unmark-up ()
+  "Remove mark from the patch on the previous line."
   (interactive)
   (forward-line -1)
-  (let ((patch (stgit-patch-at-point)))
-    (stgit-remove-mark patch)
-    (stgit-refresh)))
+  (stgit-remove-mark (stgit-patch-at-point t))
+  (stgit-reload))
+
+(defun stgit-unmark-down ()
+  "Remove mark from the patch on the current line."
+  (interactive)
+  (stgit-remove-mark (stgit-patch-at-point t))
+  (forward-line)
+  (stgit-reload))
 
 (defun stgit-rename (name)
-  "Rename the patch under point"
-  (interactive (list (read-string "Patch name: " (stgit-patch-at-point))))
-  (let ((old-name (stgit-patch-at-point)))
-    (unless old-name
-      (error "No patch on this line"))
+  "Rename the patch under point to NAME."
+  (interactive (list (read-string "Patch name: " (stgit-patch-at-point t))))
+  (let ((old-name (stgit-patch-at-point t)))
     (stgit-capture-output nil
       (stgit-run "rename" old-name name))
-    (stgit-refresh)
+    (stgit-reload)
     (stgit-goto-patch name)))
 
 (defun stgit-repair ()
-  "Run stg repair"
+  "Run stg repair."
   (interactive)
   (stgit-capture-output nil
-   (stgit-run "repair"))
-  (stgit-refresh))
+    (stgit-run "repair"))
+  (stgit-reload))
 
 (defun stgit-commit ()
   "Run stg commit."
   (interactive)
   (stgit-capture-output nil (stgit-run "commit"))
-  (stgit-refresh))
+  (stgit-reload))
 
 (defun stgit-uncommit (arg)
   "Run stg uncommit. Numeric arg determines number of patches to uncommit."
   (interactive "p")
   (stgit-capture-output nil (stgit-run "uncommit" "-n" (number-to-string arg)))
-  (stgit-refresh))
-
-(defun stgit-push-next ()
-  "Push the first unapplied patch"
-  (interactive)
-  (stgit-capture-output nil (stgit-run "push"))
-  (stgit-refresh))
+  (stgit-reload))
 
-(defun stgit-pop-next ()
-  "Pop the topmost applied patch"
-  (interactive)
-  (stgit-capture-output nil (stgit-run "pop"))
-  (stgit-refresh))
+(defun stgit-push-next (npatches)
+  "Push the first unapplied patch.
+With numeric prefix argument, push that many patches."
+  (interactive "p")
+  (stgit-capture-output nil (stgit-run "push" "-n"
+                                       (number-to-string npatches)))
+  (stgit-reload)
+  (stgit-refresh-git-status))
+
+(defun stgit-pop-next (npatches)
+  "Pop the topmost applied patch.
+With numeric prefix argument, pop that many patches."
+  (interactive "p")
+  (stgit-capture-output nil (stgit-run "pop" "-n" (number-to-string npatches)))
+  (stgit-reload)
+  (stgit-refresh-git-status))
 
 (defun stgit-applied-at-point ()
   "Is the patch on the current line applied?"
@@ -283,42 +352,42 @@ Commands:
     (looking-at "[>+]")))
 
 (defun stgit-push-or-pop ()
-  "Push or pop the patch on the current line"
+  "Push or pop the patch on the current line."
   (interactive)
-  (let ((patch (stgit-patch-at-point))
+  (let ((patch (stgit-patch-at-point t))
         (applied (stgit-applied-at-point)))
     (stgit-capture-output nil
-       (stgit-run (if applied "pop" "push") patch))
-    (stgit-refresh)))
+      (stgit-run (if applied "pop" "push") patch))
+    (stgit-reload)))
 
 (defun stgit-goto ()
-  "Go to the patch on the current line"
+  "Go to the patch on the current line."
   (interactive)
-  (let ((patch (stgit-patch-at-point)))
+  (let ((patch (stgit-patch-at-point t)))
     (stgit-capture-output nil
-       (stgit-run "goto" patch))
-    (stgit-refresh)))
+      (stgit-run "goto" patch))
+    (stgit-reload)))
 
 (defun stgit-show ()
-  "Show the patch on the current line"
+  "Show the patch on the current line."
   (interactive)
   (stgit-capture-output "*StGit patch*"
-    (stgit-run "show" (stgit-patch-at-point))
+    (stgit-run "show" (stgit-patch-at-point t))
     (with-current-buffer standard-output
       (goto-char (point-min))
       (diff-mode))))
 
 (defun stgit-edit ()
-  "Edit the patch on the current line"
+  "Edit the patch on the current line."
   (interactive)
-  (let ((patch (stgit-patch-at-point))
+  (let ((patch (stgit-patch-at-point t))
         (edit-buf (get-buffer-create "*StGit edit*"))
         (dir default-directory))
     (log-edit 'stgit-confirm-edit t nil edit-buf)
     (set (make-local-variable 'stgit-edit-patch) patch)
     (setq default-directory dir)
     (let ((standard-output edit-buf))
-      (stgit-run "edit" "--save-template=-" patch))))
+      (stgit-run-silent "edit" "--save-template=-" patch))))
 
 (defun stgit-confirm-edit ()
   (interactive)
@@ -327,13 +396,15 @@ Commands:
     (stgit-capture-output nil
       (stgit-run "edit" "-f" file stgit-edit-patch))
     (with-current-buffer log-edit-parent-buffer
-      (stgit-refresh))))
+      (stgit-reload))))
 
 (defun stgit-new ()
-  "Create a new patch"
+  "Create a new patch."
   (interactive)
-  (let ((edit-buf (get-buffer-create "*StGit edit*")))
-    (log-edit 'stgit-confirm-new t nil edit-buf)))
+  (let ((edit-buf (get-buffer-create "*StGit edit*"))
+        (dir default-directory))
+    (log-edit 'stgit-confirm-new t nil edit-buf)
+    (setq default-directory dir)))
 
 (defun stgit-confirm-new ()
   (interactive)
@@ -342,7 +413,7 @@ Commands:
     (stgit-capture-output nil
       (stgit-run "new" "-f" file))
     (with-current-buffer log-edit-parent-buffer
-      (stgit-refresh))))
+      (stgit-reload))))
 
 (defun stgit-create-patch-name (description)
   "Create a patch name from a long description"
@@ -363,7 +434,7 @@ Commands:
           (t patch))))
 
 (defun stgit-delete (patch-names)
-  "Delete the named patches"
+  "Delete the named patches."
   (interactive (list (stgit-patches-marked-or-at-point)))
   (if (zerop (length patch-names))
       (error "No patches to delete")
@@ -371,10 +442,10 @@ Commands:
                                (length patch-names)))
       (stgit-capture-output nil
         (apply 'stgit-run "delete" patch-names))
-      (stgit-refresh))))
+      (stgit-reload))))
 
 (defun stgit-coalesce (patch-names)
-  "Run stg coalesce on the named patches"
+  "Run stg coalesce on the named patches."
   (interactive (list (stgit-marked-patches)))
   (let ((edit-buf (get-buffer-create "*StGit edit*"))
         (dir default-directory))
@@ -382,7 +453,7 @@ Commands:
     (set (make-local-variable 'stgit-patches) patch-names)
     (setq default-directory dir)
     (let ((standard-output edit-buf))
-      (apply 'stgit-run "coalesce" "--save-template=-" patch-names))))
+      (apply 'stgit-run-silent "coalesce" "--save-template=-" patch-names))))
 
 (defun stgit-confirm-coalesce ()
   (interactive)
@@ -391,11 +462,46 @@ Commands:
     (stgit-capture-output nil
       (apply 'stgit-run "coalesce" "-f" file stgit-patches))
     (with-current-buffer log-edit-parent-buffer
-      (stgit-refresh))))
+      (stgit-clear-marks)
+      ;; Go to first marked patch and stay there
+      (goto-char (point-min))
+      (re-search-forward (concat "^[>+-]\\*") nil t)
+      (move-to-column goal-column)
+      (let ((pos (point)))
+        (stgit-reload)
+        (goto-char pos)))))
 
 (defun stgit-help ()
   "Display help for the StGit mode."
   (interactive)
   (describe-function 'stgit-mode))
 
+(defun stgit-undo (&optional arg)
+  "Run stg undo.
+With prefix argument, run it with the --hard flag."
+  (interactive "P")
+  (stgit-capture-output nil
+    (if arg
+        (stgit-run "undo" "--hard")
+      (stgit-run "undo")))
+  (stgit-reload))
+
+(defun stgit-refresh (&optional arg)
+  "Run stg refresh.
+With prefix argument, refresh the marked patch or the patch under point."
+  (interactive "P")
+  (let ((patchargs (if arg
+                       (let ((patches (stgit-patches-marked-or-at-point)))
+                         (cond ((null patches)
+                                (error "no patch to update"))
+                               ((> (length patches) 1)
+                                (error "too many patches selected"))
+                               (t
+                                (cons "-p" patches))))
+                     nil)))
+    (stgit-capture-output nil
+      (apply 'stgit-run "refresh" patchargs))
+    (stgit-refresh-git-status))
+  (stgit-reload))
+
 (provide 'stgit)