1 ;; stgit.el: An emacs mode for StGit
3 ;; Copyright (C) 2007 David Kågedal <davidk@lysator.liu.se>
5 ;; To install: put this file on the load-path and place the following
6 ;; in your .emacs file:
10 ;; To start: `M-x stgit'
15 "Manage StGit patches for the tree in DIR."
16 (interactive "DDirectory: \n")
17 (switch-to-stgit-buffer (git-get-top-dir dir))
20 (unless (fboundp 'git-get-top-dir)
21 (defun git-get-top-dir (dir)
22 "Retrieve the top-level directory of a git tree."
23 (let ((cdup (with-output-to-string
24 (with-current-buffer standard-output
26 (unless (eq 0 (call-process "git" nil t nil
27 "rev-parse" "--show-cdup"))
28 (error "cannot find top-level git tree for %s." dir))))))
29 (expand-file-name (concat (file-name-as-directory dir)
30 (car (split-string cdup "\n")))))))
32 (defun stgit-refresh-git-status (&optional dir)
33 "If it exists, refresh the `git-status' buffer belonging to
34 directory DIR or `default-directory'"
35 (when (and (fboundp 'git-find-status-buffer)
36 (fboundp 'git-refresh-status))
37 (let* ((top-dir (git-get-top-dir (or dir default-directory)))
38 (git-status-buffer (and top-dir (git-find-status-buffer top-dir))))
39 (when git-status-buffer
40 (with-current-buffer git-status-buffer
41 (git-refresh-status))))))
43 (defun switch-to-stgit-buffer (dir)
44 "Switch to a (possibly new) buffer displaying StGit patches for DIR."
45 (setq dir (file-name-as-directory dir))
46 (let ((buffers (buffer-list)))
48 (not (with-current-buffer (car buffers)
49 (and (eq major-mode 'stgit-mode)
50 (string= default-directory dir)))))
51 (setq buffers (cdr buffers)))
52 (switch-to-buffer (if buffers
54 (create-stgit-buffer dir)))))
56 (defun create-stgit-buffer (dir)
57 "Create a buffer for showing StGit patches.
58 Argument DIR is the repository path."
59 (let ((buf (create-file-buffer (concat dir "*stgit*")))
60 (inhibit-read-only t))
61 (with-current-buffer buf
62 (setq default-directory dir)
64 (setq buffer-read-only t))
67 (defmacro stgit-capture-output (name &rest body)
68 "Capture StGit output and show it in a window at the end."
69 `(let ((output-buf (get-buffer-create ,(or name "*StGit output*")))
70 (stgit-dir default-directory)
71 (inhibit-read-only t))
72 (with-current-buffer output-buf
74 (setq default-directory stgit-dir)
75 (setq buffer-read-only t))
76 (let ((standard-output output-buf))
78 (with-current-buffer output-buf
79 (set-buffer-modified-p nil)
80 (setq buffer-read-only t)
81 (if (< (point-min) (point-max))
82 (display-buffer output-buf t)))))
83 (put 'stgit-capture-output 'lisp-indent-function 1)
85 (defun stgit-run-silent (&rest args)
86 (apply 'call-process "stg" nil standard-output nil args))
88 (defun stgit-run (&rest args)
89 (let ((msgcmd (mapconcat #'identity args " ")))
90 (message "Running stg %s..." msgcmd)
91 (apply 'call-process "stg" nil standard-output nil args)
92 (message "Running stg %s...done" msgcmd)))
94 (defun stgit-run-git (&rest args)
95 (let ((msgcmd (mapconcat #'identity args " ")))
96 (message "Running git %s..." msgcmd)
97 (apply 'call-process "git" nil standard-output nil args)
98 (message "Running git %s...done" msgcmd)))
100 (defun stgit-reload ()
101 "Update the contents of the StGit buffer."
103 (let ((inhibit-read-only t)
104 (curline (line-number-at-pos))
105 (curpatch (stgit-patch-at-point)))
108 (stgit-run-silent "branch")
109 (stgit-run-silent "series" "--description")
112 (stgit-goto-patch curpatch)
113 (goto-line curline)))
114 (stgit-refresh-git-status))
117 "A user interface for the StGit patch maintenance tool."
120 (defface stgit-description-face
121 '((((background dark)) (:foreground "tan"))
122 (((background light)) (:foreground "dark red")))
123 "The face used for StGit descriptions"
126 (defface stgit-top-patch-face
127 '((((background dark)) (:weight bold :foreground "yellow"))
128 (((background light)) (:weight bold :foreground "purple"))
130 "The face used for the top patch names"
133 (defface stgit-applied-patch-face
134 '((((background dark)) (:foreground "light yellow"))
135 (((background light)) (:foreground "purple"))
137 "The face used for applied patch names"
140 (defface stgit-unapplied-patch-face
141 '((((background dark)) (:foreground "gray80"))
142 (((background light)) (:foreground "orchid"))
144 "The face used for unapplied patch names"
147 (defun stgit-expand-patch (patchsym)
150 (let ((start (point)))
151 (stgit-run "files" (symbol-name patchsym))
153 ;; 'stg files' outputs a single newline for empty patches; it
154 ;; must be destroyed!
155 (when (and (= (1+ start) (point))
156 (= (char-before) ?\n))
157 (delete-backward-char 1))
159 (let ((end-marker (point-marker)))
160 (if (= start (point))
161 (insert-string " <no files>\n")
162 (unless (looking-at "^")
164 (while (and (zerop (forward-line -1))
167 (put-text-property start end-marker 'stgit-patchsym patchsym)))))
169 (defun stgit-rescan ()
170 "Rescan the status buffer."
173 (goto-char (point-min))
175 (cond ((looking-at "Branch: \\(.*\\)")
176 (put-text-property (match-beginning 1) (match-end 1)
178 ((looking-at "\\([>+-]\\)\\( \\)\\([^ ]+\\) *[|#] \\(.*\\)")
179 (let ((state (match-string 1))
180 (patchsym (intern (match-string 3))))
182 (match-beginning 3) (match-end 3) 'face
183 (cond ((string= state ">") 'stgit-top-patch-face)
184 ((string= state "+") 'stgit-applied-patch-face)
185 ((string= state "-") 'stgit-unapplied-patch-face)))
186 (put-text-property (match-beginning 4) (match-end 4)
187 'face 'stgit-description-face)
188 (when (memq patchsym stgit-marked-patches)
189 (replace-match "*" nil nil nil 2)
190 (setq marked (cons patchsym marked)))
191 (when (memq patchsym stgit-expanded-patches)
192 (stgit-expand-patch patchsym))
194 ((or (looking-at "stg series: Branch \".*\" not initialised")
195 (looking-at "stg series: .*: branch not initialized"))
197 (insert "Run M-x stgit-init to initialise")))
199 (setq stgit-marked-patches (nreverse marked)))))
201 (defun stgit-select ()
202 "Expand or collapse the current entry"
204 (let ((curpatch (stgit-patch-at-point)))
206 (let ((patched-file (stgit-patched-file-at-point)))
208 (error "No patch or file on the current line"))
209 (let ((filename (expand-file-name (cdr patched-file))))
210 (unless (file-exists-p filename)
211 (error "File does not exist"))
212 (find-file filename)))
213 (setq curpatch (intern curpatch))
214 (setq stgit-expanded-patches
215 (if (memq curpatch stgit-expanded-patches)
216 (delq curpatch stgit-expanded-patches)
217 (cons curpatch stgit-expanded-patches)))
220 (defun stgit-find-file-other-window ()
221 "Open file at point in other window"
223 (let ((patched-file (stgit-patched-file-at-point)))
225 (error "No file on the current line"))
226 (let ((filename (expand-file-name (cdr patched-file))))
227 (unless (file-exists-p filename)
228 (error "File does not exist"))
229 (find-file-other-window filename))))
232 "Hide the stgit buffer."
236 (defun stgit-git-status ()
237 "Show status using `git-status'."
239 (unless (fboundp 'git-status)
240 (error "stgit-git-status requires git-status"))
241 (let ((dir default-directory))
242 (save-selected-window
246 (defun stgit-next-line (&optional arg try-vscroll)
247 "Move cursor vertically down ARG lines"
249 (next-line arg try-vscroll)
250 (when (looking-at " \\S-")
253 (defun stgit-previous-line (&optional arg try-vscroll)
254 "Move cursor vertically up ARG lines"
256 (previous-line arg try-vscroll)
257 (when (looking-at " \\S-")
260 (defun stgit-next-patch (&optional arg)
261 "Move cursor down ARG patches"
266 (stgit-previous-patch (- arg))
267 (while (not (zerop arg))
269 (while (progn (stgit-next-line)
270 (not (stgit-patch-at-point)))))))
272 (defun stgit-previous-patch (&optional arg)
273 "Move cursor up ARG patches"
278 (stgit-next-patch (- arg))
279 (while (not (zerop arg))
281 (while (progn (stgit-previous-line)
282 (not (stgit-patch-at-point)))))))
284 (defvar stgit-mode-hook nil
285 "Run after `stgit-mode' is setup.")
287 (defvar stgit-mode-map nil
288 "Keymap for StGit major mode.")
290 (unless stgit-mode-map
291 (setq stgit-mode-map (make-keymap))
292 (suppress-keymap stgit-mode-map)
293 (mapc (lambda (arg) (define-key stgit-mode-map (car arg) (cdr arg)))
296 ("\d" . stgit-unmark-up)
297 ("u" . stgit-unmark-down)
300 ("p" . stgit-previous-line)
301 ("n" . stgit-next-line)
302 ("\C-p" . stgit-previous-patch)
303 ("\C-n" . stgit-next-patch)
304 ("\M-{" . stgit-previous-patch)
305 ("\M-}" . stgit-next-patch)
306 ("s" . stgit-git-status)
308 ("r" . stgit-refresh)
309 ("\C-c\C-r" . stgit-rename)
311 ("c" . stgit-coalesce)
315 ("U" . stgit-uncommit)
316 ("\r" . stgit-select)
317 ("o" . stgit-find-file-other-window)
318 (">" . stgit-push-next)
319 ("<" . stgit-pop-next)
320 ("P" . stgit-push-or-pop)
324 ([(control ?/)] . stgit-undo)
325 ("\C-_" . stgit-undo)
326 ("q" . stgit-quit))))
329 "Major mode for interacting with StGit.
332 (kill-all-local-variables)
333 (buffer-disable-undo)
334 (setq mode-name "StGit"
335 major-mode 'stgit-mode
337 (use-local-map stgit-mode-map)
338 (set (make-local-variable 'list-buffers-directory) default-directory)
339 (set (make-local-variable 'stgit-marked-patches) nil)
340 (set (make-local-variable 'stgit-expanded-patches) nil)
341 (set-variable 'truncate-lines 't)
342 (run-hooks 'stgit-mode-hook))
344 (defun stgit-add-mark (patch)
345 (let ((patchsym (intern patch)))
346 (setq stgit-marked-patches (cons patchsym stgit-marked-patches))))
348 (defun stgit-remove-mark (patch)
349 (let ((patchsym (intern patch)))
350 (setq stgit-marked-patches (delq patchsym stgit-marked-patches))))
352 (defun stgit-clear-marks ()
353 (setq stgit-marked-patches '()))
355 (defun stgit-marked-patches ()
356 "Return the names of the marked patches."
357 (mapcar 'symbol-name stgit-marked-patches))
359 (defun stgit-patch-at-point (&optional cause-error allow-file)
360 "Return the patch name on the current line.
361 If CAUSE-ERROR is not nil, signal an error if none found.
362 If ALLOW-FILE is not nil, also handle when point is on a file of
365 (let ((patchsym (get-text-property (point) 'stgit-patchsym)))
367 (symbol-name patchsym))))
370 (and (looking-at "[>+-][ *]\\([^ ]*\\)")
371 (match-string-no-properties 1)))
373 (error "No patch on this line"))))
375 (defun stgit-patched-file-at-point ()
376 "Returns a cons of the patchsym and file name at point"
377 (let ((patchsym (get-text-property (point) 'stgit-patchsym)))
381 (when (looking-at " [A-Z] \\(.*\\)")
382 (cons patchsym (match-string-no-properties 1)))))))
384 (defun stgit-patches-marked-or-at-point ()
385 "Return the names of the marked patches, or the patch on the current line."
386 (if stgit-marked-patches
387 (stgit-marked-patches)
388 (let ((patch (stgit-patch-at-point)))
393 (defun stgit-goto-patch (patch)
394 "Move point to the line containing PATCH."
396 (goto-char (point-min))
397 (if (re-search-forward (concat "^[>+-][ *]" (regexp-quote patch) " ") nil t)
398 (progn (move-to-column goal-column)
406 (stgit-capture-output nil
411 "Mark the patch under point."
413 (let ((patch (stgit-patch-at-point t)))
414 (stgit-add-mark patch)
418 (defun stgit-unmark-up ()
419 "Remove mark from the patch on the previous line."
421 (stgit-previous-patch)
422 (stgit-remove-mark (stgit-patch-at-point t))
425 (defun stgit-unmark-down ()
426 "Remove mark from the patch on the current line."
428 (stgit-remove-mark (stgit-patch-at-point t))
432 (defun stgit-rename (name)
433 "Rename the patch under point to NAME."
434 (interactive (list (read-string "Patch name: " (stgit-patch-at-point t))))
435 (let ((old-name (stgit-patch-at-point t)))
436 (stgit-capture-output nil
437 (stgit-run "rename" old-name name))
438 (let ((old-name-sym (intern old-name))
439 (name-sym (intern name)))
440 (when (memq old-name-sym stgit-expanded-patches)
441 (setq stgit-expanded-patches
442 (cons name-sym (delq old-name-sym stgit-expanded-patches))))
443 (when (memq old-name-sym stgit-marked-patches)
444 (setq stgit-marked-patches
445 (cons name-sym (delq old-name-sym stgit-marked-patches)))))
447 (stgit-goto-patch name)))
449 (defun stgit-repair ()
452 (stgit-capture-output nil
453 (stgit-run "repair"))
456 (defun stgit-commit ()
459 (stgit-capture-output nil (stgit-run "commit"))
462 (defun stgit-uncommit (arg)
463 "Run stg uncommit. Numeric arg determines number of patches to uncommit."
465 (stgit-capture-output nil (stgit-run "uncommit" "-n" (number-to-string arg)))
468 (defun stgit-push-next (npatches)
469 "Push the first unapplied patch.
470 With numeric prefix argument, push that many patches."
472 (stgit-capture-output nil (stgit-run "push" "-n"
473 (number-to-string npatches)))
475 (stgit-refresh-git-status))
477 (defun stgit-pop-next (npatches)
478 "Pop the topmost applied patch.
479 With numeric prefix argument, pop that many patches."
481 (stgit-capture-output nil (stgit-run "pop" "-n" (number-to-string npatches)))
483 (stgit-refresh-git-status))
485 (defun stgit-applied-at-point ()
486 "Is the patch on the current line applied?"
489 (looking-at "[>+]")))
491 (defun stgit-push-or-pop ()
492 "Push or pop the patch on the current line."
494 (let ((patch (stgit-patch-at-point t))
495 (applied (stgit-applied-at-point)))
496 (stgit-capture-output nil
497 (stgit-run (if applied "pop" "push") patch))
501 "Go to the patch on the current line."
503 (let ((patch (stgit-patch-at-point t)))
504 (stgit-capture-output nil
505 (stgit-run "goto" patch))
508 (defun stgit-id (patch)
509 "Return the git commit id for PATCH"
510 (let ((result (with-output-to-string
511 (stgit-run-silent "id" patch))))
512 (unless (string-match "^\\([0-9A-Fa-f]\\{40\\}\\)$" result)
513 (error "Cannot find commit id for %s" patch))
514 (match-string 1 result)))
517 "Show the patch on the current line."
519 (stgit-capture-output "*StGit patch*"
520 (let ((patch (stgit-patch-at-point)))
522 (let ((patched-file (stgit-patched-file-at-point)))
524 (error "No patch or file at point"))
525 (let ((id (stgit-id (symbol-name (car patched-file)))))
526 (with-output-to-temp-buffer "*StGit diff*"
527 (stgit-run-git "diff" (concat id "^") id (cdr patched-file))
528 (with-current-buffer standard-output
530 (stgit-run "show" (stgit-patch-at-point))
531 (with-current-buffer standard-output
532 (goto-char (point-min))
536 "Edit the patch on the current line."
538 (let ((patch (stgit-patch-at-point t))
539 (edit-buf (get-buffer-create "*StGit edit*"))
540 (dir default-directory))
541 (log-edit 'stgit-confirm-edit t nil edit-buf)
542 (set (make-local-variable 'stgit-edit-patch) patch)
543 (setq default-directory dir)
544 (let ((standard-output edit-buf))
545 (stgit-run-silent "edit" "--save-template=-" patch))))
547 (defun stgit-confirm-edit ()
549 (let ((file (make-temp-file "stgit-edit-")))
550 (write-region (point-min) (point-max) file)
551 (stgit-capture-output nil
552 (stgit-run "edit" "-f" file stgit-edit-patch))
553 (with-current-buffer log-edit-parent-buffer
557 "Create a new patch."
559 (let ((edit-buf (get-buffer-create "*StGit edit*"))
560 (dir default-directory))
561 (log-edit 'stgit-confirm-new t nil edit-buf)
562 (setq default-directory dir)))
564 (defun stgit-confirm-new ()
566 (let ((file (make-temp-file "stgit-edit-")))
567 (write-region (point-min) (point-max) file)
568 (stgit-capture-output nil
569 (stgit-run "new" "-f" file))
570 (with-current-buffer log-edit-parent-buffer
573 (defun stgit-create-patch-name (description)
574 "Create a patch name from a long description"
576 (while (> (length description) 0)
577 (cond ((string-match "\\`[a-zA-Z_-]+" description)
578 (setq patch (downcase (concat patch (match-string 0 description))))
579 (setq description (substring description (match-end 0))))
580 ((string-match "\\` +" description)
581 (setq patch (concat patch "-"))
582 (setq description (substring description (match-end 0))))
583 ((string-match "\\`[^a-zA-Z_-]+" description)
584 (setq description (substring description (match-end 0))))))
585 (cond ((= (length patch) 0)
587 ((> (length patch) 20)
588 (substring patch 0 20))
591 (defun stgit-delete (patch-names)
592 "Delete the named patches."
593 (interactive (list (stgit-patches-marked-or-at-point)))
594 (if (zerop (length patch-names))
595 (error "No patches to delete")
596 (when (yes-or-no-p (format "Really delete %d patches? "
597 (length patch-names)))
598 (stgit-capture-output nil
599 (apply 'stgit-run "delete" patch-names))
602 (defun stgit-coalesce (patch-names)
603 "Run stg coalesce on the named patches."
604 (interactive (list (stgit-marked-patches)))
605 (let ((edit-buf (get-buffer-create "*StGit edit*"))
606 (dir default-directory))
607 (log-edit 'stgit-confirm-coalesce t nil edit-buf)
608 (set (make-local-variable 'stgit-patches) patch-names)
609 (setq default-directory dir)
610 (let ((standard-output edit-buf))
611 (apply 'stgit-run-silent "coalesce" "--save-template=-" patch-names))))
613 (defun stgit-confirm-coalesce ()
615 (let ((file (make-temp-file "stgit-edit-")))
616 (write-region (point-min) (point-max) file)
617 (stgit-capture-output nil
618 (apply 'stgit-run "coalesce" "-f" file stgit-patches))
619 (with-current-buffer log-edit-parent-buffer
621 ;; Go to first marked patch and stay there
622 (goto-char (point-min))
623 (re-search-forward (concat "^[>+-]\\*") nil t)
624 (move-to-column goal-column)
630 "Display help for the StGit mode."
632 (describe-function 'stgit-mode))
634 (defun stgit-undo (&optional arg)
636 With prefix argument, run it with the --hard flag."
638 (stgit-capture-output nil
640 (stgit-run "undo" "--hard")
644 (defun stgit-refresh (&optional arg)
646 With prefix argument, refresh the marked patch or the patch under point."
648 (let ((patchargs (if arg
649 (let ((patches (stgit-patches-marked-or-at-point)))
650 (cond ((null patches)
651 (error "no patch to update"))
652 ((> (length patches) 1)
653 (error "too many patches selected"))
655 (cons "-p" patches))))
657 (stgit-capture-output nil
658 (apply 'stgit-run "refresh" patchargs))
659 (stgit-refresh-git-status))