X-Git-Url: https://git.distorted.org.uk/~mdw/stgit/blobdiff_plain/9b151b27a360a22177b8b5336ead5658ef0bf5e9..ea09f8ce7b1bcea38a7d9f0079a28c6109989342:/contrib/stgit.el diff --git a/contrib/stgit.el b/contrib/stgit.el index 9e92ad7..836c58f 100644 --- a/contrib/stgit.el +++ b/contrib/stgit.el @@ -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-reload)) -(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")))))) +(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)) @@ -77,8 +91,17 @@ Argument DIR is the repository path." (apply 'call-process "stg" nil standard-output nil args) (message "Running stg %s...done" msgcmd))) +(defun stgit-run-git (&rest args) + (let ((msgcmd (mapconcat #'identity args " "))) + (message "Running git %s..." msgcmd) + (apply 'call-process "git" nil standard-output nil args) + (message "Running git %s...done" msgcmd))) + +(defun stgit-run-git-silent (&rest args) + (apply 'call-process "git" nil standard-output nil args)) + (defun stgit-reload () - "Update the contents of the stgit buffer" + "Update the contents of the StGit buffer." (interactive) (let ((inhibit-read-only t) (curline (line-number-at-pos)) @@ -90,30 +113,137 @@ Argument DIR is the repository path." (stgit-rescan) (if curpatch (stgit-goto-patch curpatch) - (goto-line curline)))) + (goto-line curline))) + (stgit-refresh-git-status)) + +(defgroup stgit nil + "A user interface for the StGit patch maintenance tool." + :group 'tools) (defface stgit-description-face '((((background dark)) (:foreground "tan")) (((background light)) (:foreground "dark red"))) - "The face used for StGit desriptions") + "The face used for StGit descriptions" + :group 'stgit) (defface stgit-top-patch-face '((((background dark)) (:weight bold :foreground "yellow")) (((background light)) (:weight bold :foreground "purple")) (t (:weight bold))) - "The face used for the top patch names") + "The face used for the top patch names" + :group 'stgit) (defface stgit-applied-patch-face '((((background dark)) (:foreground "light yellow")) (((background light)) (:foreground "purple")) (t ())) - "The face used for applied patch names") + "The face used for applied patch names" + :group 'stgit) (defface stgit-unapplied-patch-face '((((background dark)) (:foreground "gray80")) (((background light)) (:foreground "orchid")) (t ())) - "The face used for unapplied patch names") + "The face used for unapplied patch names" + :group 'stgit) + +(defface stgit-modified-file-face + '((((class color) (background light)) (:foreground "purple")) + (((class color) (background dark)) (:foreground "salmon"))) + "StGit mode face used for modified file status" + :group 'stgit) + +(defface stgit-unmerged-file-face + '((((class color) (background light)) (:foreground "red" :bold t)) + (((class color) (background dark)) (:foreground "red" :bold t))) + "StGit mode face used for unmerged file status" + :group 'stgit) + +(defface stgit-unknown-file-face + '((((class color) (background light)) (:foreground "goldenrod" :bold t)) + (((class color) (background dark)) (:foreground "goldenrod" :bold t))) + "StGit mode face used for unknown file status" + :group 'stgit) + +(defcustom stgit-expand-find-copies-harder + nil + "Try harder to find copied files when listing patches. + +When not nil, runs git diff-tree with the --find-copies-harder +flag, which reduces performance." + :type 'boolean + :group 'stgit) + +(defconst stgit-file-status-code-strings + (mapcar (lambda (arg) + (cons (car arg) + (format "%-12s" + (propertize (cadr arg) 'face (car (cddr arg)))))) + '((add "Added" stgit-modified-file-face) + (copy "Copied" stgit-modified-file-face) + (delete "Deleted" stgit-modified-file-face) + (modify "Modified" stgit-modified-file-face) + (rename "Renamed" stgit-modified-file-face) + (mode-change "Mode changed" stgit-modified-file-face) + (unmerged "Unmerged" stgit-unmerged-file-face) + (unknown "Unknown" stgit-unknown-file-face))) + "Alist of code symbols to description strings") + +(defun stgit-file-status-code-as-string (code) + "Return stgit status code as string" + (let ((str (assq code stgit-file-status-code-strings))) + (and str (cdr str)))) + +(defun stgit-file-status-code (str) + "Return stgit status code from git status string" + (let ((code (assoc str '(("A" . add) + ("C" . copy) + ("D" . delete) + ("M" . modify) + ("R" . rename) + ("T" . mode-change) + ("U" . unmerged) + ("X" . unknown))))) + (if code (cdr code) 'unknown))) + +(defun stgit-expand-patch (patchsym) + (save-excursion + (forward-line) + (let* ((start (point)) + (result (with-output-to-string + (stgit-run-git "diff-tree" "-r" "-z" + (if stgit-expand-find-copies-harder + "--find-copies-harder" + "-C") + (stgit-id (symbol-name patchsym)))))) + (let (mstart) + (while (string-match "\0:[0-7]+ [0-7]+ [0-9A-Fa-f]\\{40\\} [0-9A-Fa-f]\\{40\\} \\(\\([CR]\\)\\([0-9]*\\)\0\\([^\0]*\\)\0\\([^\0]*\\)\\|\\([ABD-QS-Z]\\)\0\\([^\0]*\\)\\)" + result mstart) + (let ((copy-or-rename (match-string 2 result)) + (line-start (point)) + properties) + (insert " ") + (if copy-or-rename + (let ((cr-score (match-string 3 result)) + (cr-from-file (match-string 4 result)) + (cr-to-file (match-string 5 result))) + (setq properties (list 'stgit-old-file cr-from-file + 'stgit-new-file cr-to-file)) + (insert (stgit-file-status-code-as-string + (if (equal "C" copy-or-rename) 'copy 'rename)) + cr-from-file + (propertize " -> " 'face 'stgit-description-face) + cr-to-file)) + (let ((status (stgit-file-status-code (match-string 6 result))) + (file (match-string 7 result))) + (setq properties (list 'stgit-file file)) + (insert (stgit-file-status-code-as-string status) file))) + (insert ?\n) + (add-text-properties line-start (point) properties)) + (setq mstart (match-end 0)))) + (when (= start (point)) + (insert " \n")) + (put-text-property start (point) 'stgit-patchsym patchsym)))) (defun stgit-rescan () "Rescan the status buffer." @@ -136,7 +266,10 @@ 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))) + (when (memq patchsym stgit-expanded-patches) + (stgit-expand-patch patchsym)) + )) ((or (looking-at "stg series: Branch \".*\" not initialised") (looking-at "stg series: .*: branch not initialized")) (forward-line 1) @@ -144,11 +277,89 @@ Argument DIR is the repository path." (forward-line 1)) (setq stgit-marked-patches (nreverse marked))))) +(defun stgit-select () + "Expand or collapse the current entry" + (interactive) + (let ((curpatch (stgit-patch-at-point))) + (if (not curpatch) + (let ((patched-file (stgit-patched-file-at-point))) + (unless patched-file + (error "No patch or file on the current line")) + (let ((filename (expand-file-name (cdr patched-file)))) + (unless (file-exists-p filename) + (error "File does not exist")) + (find-file filename))) + (setq curpatch (intern curpatch)) + (setq stgit-expanded-patches + (if (memq curpatch stgit-expanded-patches) + (delq curpatch stgit-expanded-patches) + (cons curpatch stgit-expanded-patches))) + (stgit-reload)))) + +(defun stgit-find-file-other-window () + "Open file at point in other window" + (interactive) + (let ((patched-file (stgit-patched-file-at-point))) + (unless patched-file + (error "No file on the current line")) + (let ((filename (expand-file-name (cdr patched-file)))) + (unless (file-exists-p filename) + (error "File does not exist")) + (find-file-other-window filename)))) + (defun stgit-quit () - "Hide the stgit buffer" + "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)))) + +(defun stgit-next-line (&optional arg try-vscroll) + "Move cursor vertically down ARG lines" + (interactive "p\np") + (next-line arg try-vscroll) + (when (looking-at " \\S-") + (forward-char 2))) + +(defun stgit-previous-line (&optional arg try-vscroll) + "Move cursor vertically up ARG lines" + (interactive "p\np") + (previous-line arg try-vscroll) + (when (looking-at " \\S-") + (forward-char 2))) + +(defun stgit-next-patch (&optional arg) + "Move cursor down ARG patches" + (interactive "p") + (unless arg + (setq arg 1)) + (if (< arg 0) + (stgit-previous-patch (- arg)) + (while (not (zerop arg)) + (setq arg (1- arg)) + (while (progn (stgit-next-line) + (not (stgit-patch-at-point))))))) + +(defun stgit-previous-patch (&optional arg) + "Move cursor up ARG patches" + (interactive "p") + (unless arg + (setq arg 1)) + (if (< arg 0) + (stgit-next-patch (- arg)) + (while (not (zerop arg)) + (setq arg (1- arg)) + (while (progn (stgit-previous-line) + (not (stgit-patch-at-point))))))) + (defvar stgit-mode-hook nil "Run after `stgit-mode' is setup.") @@ -165,8 +376,13 @@ Argument DIR is the repository path." ("u" . stgit-unmark-down) ("?" . stgit-help) ("h" . stgit-help) - ("p" . previous-line) - ("n" . next-line) + ("p" . stgit-previous-line) + ("n" . stgit-next-line) + ("\C-p" . stgit-previous-patch) + ("\C-n" . stgit-next-patch) + ("\M-{" . stgit-previous-patch) + ("\M-}" . stgit-next-patch) + ("s" . stgit-git-status) ("g" . stgit-reload) ("r" . stgit-refresh) ("\C-c\C-r" . stgit-rename) @@ -176,6 +392,8 @@ Argument DIR is the repository path." ("R" . stgit-repair) ("C" . stgit-commit) ("U" . stgit-uncommit) + ("\r" . stgit-select) + ("o" . stgit-find-file-other-window) (">" . stgit-push-next) ("<" . stgit-pop-next) ("P" . stgit-push-or-pop) @@ -198,6 +416,7 @@ Commands: (use-local-map stgit-mode-map) (set (make-local-variable 'list-buffers-directory) default-directory) (set (make-local-variable 'stgit-marked-patches) nil) + (set (make-local-variable 'stgit-expanded-patches) nil) (set-variable 'truncate-lines 't) (run-hooks 'stgit-mode-hook)) @@ -216,13 +435,45 @@ Commands: "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" - (save-excursion - (beginning-of-line) - (if (looking-at "[>+-][ *]\\([^ ]*\\)") - (match-string-no-properties 1) - nil))) +(defun stgit-patch-at-point (&optional cause-error allow-file) + "Return the patch name on the current line. +If CAUSE-ERROR is not nil, signal an error if none found. +If ALLOW-FILE is not nil, also handle when point is on a file of +a patch." + (or (and allow-file + (let ((patchsym (get-text-property (point) 'stgit-patchsym))) + (and patchsym + (symbol-name patchsym)))) + (save-excursion + (beginning-of-line) + (and (looking-at "[>+-][ *]\\([^ ]*\\)") + (match-string-no-properties 1))) + (and cause-error + (error "No patch on this line")))) + +(defun stgit-patched-file-at-point (&optional both-files) + "Returns a cons of the patchsym and file name at point. For +copies and renames, return the new file if the patch is either +applied. If BOTH-FILES is non-nil, return a cons of the old and +the new file names instead of just one name." + (let ((patchsym (get-text-property (point) 'stgit-patchsym)) + (file (get-text-property (point) 'stgit-file))) + (cond ((not patchsym) nil) + (file (cons patchsym file)) + (both-files + (cons patchsym (cons (get-text-property (point) 'stgit-old-file) + (get-text-property (point) 'stgit-new-file)))) + (t + (let ((file-sym (save-excursion + (stgit-previous-patch) + (unless (equal (stgit-patch-at-point) + (symbol-name patchsym)) + (error "Cannot find the %s patch" patchsym)) + (beginning-of-line) + (if (= (char-after) ?-) + 'stgit-old-file + 'stgit-new-file)))) + (cons patchsym (get-text-property (point) file-sym))))))) (defun stgit-patches-marked-or-at-point () "Return the names of the marked patches, or the patch on the current line." @@ -234,7 +485,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) @@ -244,50 +495,56 @@ Commands: nil))) (defun stgit-init () - "Run stg init" + "Run stg init." (interactive) (stgit-capture-output nil - (stgit-run "init")) + (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-reload)) - (next-line)) + (stgit-next-patch)) (defun stgit-unmark-up () - "Remove mark from the patch on the previous line" + "Remove mark from the patch on the previous line." (interactive) - (forward-line -1) - (stgit-remove-mark (stgit-patch-at-point)) + (stgit-previous-patch) + (stgit-remove-mark (stgit-patch-at-point t)) (stgit-reload)) (defun stgit-unmark-down () - "Remove mark from the patch on the current line" + "Remove mark from the patch on the current line." (interactive) - (stgit-remove-mark (stgit-patch-at-point)) - (forward-line) + (stgit-remove-mark (stgit-patch-at-point t)) + (stgit-next-patch) (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)) + (let ((old-name-sym (intern old-name)) + (name-sym (intern name))) + (when (memq old-name-sym stgit-expanded-patches) + (setq stgit-expanded-patches + (cons name-sym (delq old-name-sym stgit-expanded-patches)))) + (when (memq old-name-sym stgit-marked-patches) + (setq stgit-marked-patches + (cons name-sym (delq old-name-sym stgit-marked-patches))))) (stgit-reload) (stgit-goto-patch name))) (defun stgit-repair () - "Run stg repair" + "Run stg repair." (interactive) (stgit-capture-output nil - (stgit-run "repair")) + (stgit-run "repair")) (stgit-reload)) (defun stgit-commit () @@ -308,14 +565,16 @@ 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-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-reload) + (stgit-refresh-git-status)) (defun stgit-applied-at-point () "Is the patch on the current line applied?" @@ -324,35 +583,59 @@ With numeric prefix argument, pop that many patches." (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-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-run "goto" patch)) (stgit-reload))) +(defun stgit-id (patch) + "Return the git commit id for PATCH" + (let ((result (with-output-to-string + (stgit-run-silent "id" patch)))) + (unless (string-match "^\\([0-9A-Fa-f]\\{40\\}\\)$" result) + (error "Cannot find commit id for %s" patch)) + (match-string 1 result))) + (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)) - (with-current-buffer standard-output - (goto-char (point-min)) - (diff-mode)))) + (let ((patch (stgit-patch-at-point))) + (if (not patch) + (let ((patched-file (stgit-patched-file-at-point t))) + (unless patched-file + (error "No patch or file at point")) + (let ((id (stgit-id (symbol-name (car patched-file))))) + (with-output-to-temp-buffer "*StGit diff*" + (if (consp (cdr patched-file)) + ;; two files (copy or rename) + (stgit-run-git "diff" "-C" "-C" (concat id "^") id "--" + (cadr patched-file) (cddr patched-file)) + ;; just one file + (stgit-run-git "diff" (concat id "^") id "--" + (cdr patched-file))) + (with-current-buffer standard-output + (diff-mode))))) + (stgit-run "show" (stgit-patch-at-point)) + (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) @@ -371,10 +654,12 @@ With numeric prefix argument, pop that many patches." (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) @@ -404,7 +689,7 @@ With numeric prefix argument, pop that many patches." (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") @@ -415,7 +700,7 @@ With numeric prefix argument, pop that many patches." (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)) @@ -458,19 +743,20 @@ With prefix argument, run it with the --hard flag." (defun stgit-refresh (&optional arg) "Run stg refresh. -With prefix argument, refresh the patch under point." +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))) + (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))) + (apply 'stgit-run "refresh" patchargs)) + (stgit-refresh-git-status)) (stgit-reload)) (provide 'stgit)