chiark - git - mdw - stgit/blob - contrib/stgit.el

   1 ;; stgit.el: An emacs mode for StGit
   2 ;;
   3 ;; Copyright (C) 2007 David Kågedal <davidk@lysator.liu.se>
   4 ;;
   5 ;; To install: put this file on the load-path and place the following
   6 ;; in your .emacs file:
   7 ;;
   8 ;;    (require 'stgit)
   9 ;;
  10 ;; To start: `M-x stgit'
  11
  12 (require 'git nil t)
  13 (require 'cl)
  14 (require 'ewoc)
  15
  16 (defun stgit (dir)
  17   "Manage StGit patches for the tree in DIR."
  18   (interactive "DDirectory: \n")
  19   (switch-to-stgit-buffer (git-get-top-dir dir))
  20   (stgit-reload))
  21
  22 (unless (fboundp 'git-get-top-dir)
  23   (defun git-get-top-dir (dir)
  24     "Retrieve the top-level directory of a git tree."
  25     (let ((cdup (with-output-to-string
  26                   (with-current-buffer standard-output
  27                     (cd dir)
  28                     (unless (eq 0 (call-process "git" nil t nil
  29                                                 "rev-parse" "--show-cdup"))
  30                       (error "Cannot find top-level git tree for %s" dir))))))
  31       (expand-file-name (concat (file-name-as-directory dir)
  32                                 (car (split-string cdup "\n")))))))
  33
  34 (defun stgit-refresh-git-status (&optional dir)
  35   "If it exists, refresh the `git-status' buffer belonging to
  36 directory DIR or `default-directory'"
  37   (when (and (fboundp 'git-find-status-buffer)
  38              (fboundp 'git-refresh-status))
  39     (let* ((top-dir (git-get-top-dir (or dir default-directory)))
  40            (git-status-buffer (and top-dir (git-find-status-buffer top-dir))))
  41       (when git-status-buffer
  42         (with-current-buffer git-status-buffer
  43           (git-refresh-status))))))
  44
  45 (defun stgit-find-buffer (dir)
  46   "Return the buffer displaying StGit patches for DIR, or nil if none."
  47   (setq dir (file-name-as-directory dir))
  48   (let ((buffers (buffer-list)))
  49     (while (and buffers
  50                 (not (with-current-buffer (car buffers)
  51                        (and (eq major-mode 'stgit-mode)
  52                             (string= default-directory dir)))))
  53       (setq buffers (cdr buffers)))
  54     (and buffers (car buffers))))
  55
  56 (defun switch-to-stgit-buffer (dir)
  57   "Switch to a (possibly new) buffer displaying StGit patches for DIR."
  58   (setq dir (file-name-as-directory dir))
  59   (let ((buffer (stgit-find-buffer dir)))
  60     (switch-to-buffer (or buffer
  61                           (create-stgit-buffer dir)))))
  62
  63 (defstruct (stgit-patch)
  64   status name desc empty files-ewoc)
  65
  66 (defun stgit-patch-pp (patch)
  67   (let* ((status (stgit-patch-status patch))
  68          (start (point))
  69          (name (stgit-patch-name patch))
  70          (face (cdr (assq status stgit-patch-status-face-alist))))
  71     (insert (case status
  72               ('applied "+")
  73               ('top ">")
  74               ('unapplied "-")
  75               (t " "))
  76             (if (memq name stgit-marked-patches)
  77                 "*" " "))
  78     (if (memq status '(index work))
  79         (insert (propertize (if (eq status 'index) "Index" "Work tree")
  80                             'face face))
  81       (insert (format "%-30s"
  82                       (propertize (symbol-name name) 'face face))
  83               "  "
  84               (if (stgit-patch-empty patch) "(empty) " "")
  85               (propertize (or (stgit-patch-desc patch) "")
  86                           'face 'stgit-description-face)))
  87     (insert "\n")
  88     (put-text-property start (point) 'entry-type 'patch)
  89     (when (memq name stgit-expanded-patches)
  90       (stgit-insert-patch-files patch))
  91     (put-text-property start (point) 'patch-data patch)))
  92
  93 (defun create-stgit-buffer (dir)
  94   "Create a buffer for showing StGit patches.
  95 Argument DIR is the repository path."
  96   (let ((buf (create-file-buffer (concat dir "*stgit*")))
  97         (inhibit-read-only t))
  98     (with-current-buffer buf
  99       (setq default-directory dir)
 100       (stgit-mode)
 101       (set (make-local-variable 'stgit-ewoc)
 102            (ewoc-create #'stgit-patch-pp "Branch:\n\n" "--\n" t))
 103       (setq buffer-read-only t))
 104     buf))
 105
 106 (defmacro stgit-capture-output (name &rest body)
 107   "Capture StGit output and, if there was any output, show it in a window
 108 at the end.
 109 Returns nil if there was no output."
 110   (declare (debug ([&or stringp null] body))
 111            (indent 1))
 112   `(let ((output-buf (get-buffer-create ,(or name "*StGit output*")))
 113          (stgit-dir default-directory)
 114          (inhibit-read-only t))
 115      (with-current-buffer output-buf
 116        (erase-buffer)
 117        (setq default-directory stgit-dir)
 118        (setq buffer-read-only t))
 119      (let ((standard-output output-buf))
 120        ,@body)
 121      (with-current-buffer output-buf
 122        (set-buffer-modified-p nil)
 123        (setq buffer-read-only t)
 124        (if (< (point-min) (point-max))
 125            (display-buffer output-buf t)))))
 126
 127 (defun stgit-make-run-args (args)
 128   "Return a copy of ARGS with its elements converted to strings."
 129   (mapcar (lambda (x)
 130             ;; don't use (format "%s" ...) to limit type errors
 131             (cond ((stringp x) x)
 132                   ((integerp x) (number-to-string x))
 133                   ((symbolp x) (symbol-name x))
 134                   (t
 135                    (error "Bad element in stgit-make-run-args args: %S" x))))
 136           args))
 137
 138 (defun stgit-run-silent (&rest args)
 139   (setq args (stgit-make-run-args args))
 140   (apply 'call-process "stg" nil standard-output nil args))
 141
 142 (defun stgit-run (&rest args)
 143   (setq args (stgit-make-run-args args))
 144   (let ((msgcmd (mapconcat #'identity args " ")))
 145     (message "Running stg %s..." msgcmd)
 146     (apply 'call-process "stg" nil standard-output nil args)
 147     (message "Running stg %s...done" msgcmd)))
 148
 149 (defun stgit-run-git (&rest args)
 150   (setq args (stgit-make-run-args args))
 151   (let ((msgcmd (mapconcat #'identity args " ")))
 152     (message "Running git %s..." msgcmd)
 153     (apply 'call-process "git" nil standard-output nil args)
 154     (message "Running git %s...done" msgcmd)))
 155
 156 (defun stgit-run-git-silent (&rest args)
 157   (setq args (stgit-make-run-args args))
 158   (apply 'call-process "git" nil standard-output nil args))
 159
 160 (defun stgit-index-empty-p ()
 161   "Returns non-nil if the index contains no changes from HEAD."
 162   (zerop (stgit-run-git-silent "diff-index" "--cached" "--quiet" "HEAD")))
 163
 164 (defvar stgit-index-node)
 165 (defvar stgit-worktree-node)
 166
 167 (defun stgit-refresh-index ()
 168   (when stgit-index-node
 169     (ewoc-invalidate (car stgit-index-node) (cdr stgit-index-node))))
 170
 171 (defun stgit-refresh-worktree ()
 172   (when stgit-worktree-node
 173     (ewoc-invalidate (car stgit-worktree-node) (cdr stgit-worktree-node))))
 174
 175 (defun stgit-run-series-insert-index (ewoc)
 176   (setq index-node    (cons ewoc (ewoc-enter-last ewoc
 177                                                   (make-stgit-patch
 178                                                    :status 'index
 179                                                    :name :index
 180                                                    :desc nil
 181                                                    :empty nil)))
 182         worktree-node (cons ewoc (ewoc-enter-last ewoc
 183                                                   (make-stgit-patch
 184                                                    :status 'work
 185                                                    :name :work
 186                                                    :desc nil
 187                                                    :empty nil)))))
 188
 189 (defun stgit-run-series (ewoc)
 190   (setq stgit-index-node nil
 191         stgit-worktree-node nil)
 192   (let ((inserted-index (not stgit-show-worktree))
 193         index-node
 194         worktree-node
 195         all-patchsyms)
 196     (with-temp-buffer
 197       (let ((exit-status (stgit-run-silent "series" "--description" "--empty")))
 198         (goto-char (point-min))
 199         (if (not (zerop exit-status))
 200             (cond ((looking-at "stg series: \\(.*\\)")
 201                    (setq inserted-index t)
 202                    (ewoc-set-hf ewoc (car (ewoc-get-hf ewoc))
 203                                 (substitute-command-keys
 204                                  "-- not initialized; run \\[stgit-init]")))
 205                   ((looking-at ".*")
 206                    (error "Error running stg: %s"
 207                           (match-string 0))))
 208           (while (not (eobp))
 209             (unless (looking-at
 210                      "\\([0 ]\\)\\([>+-]\\)\\( \\)\\([^ ]+\\) *[|#] \\(.*\\)")
 211               (error "Syntax error in output from stg series"))
 212             (let* ((state-str (match-string 2))
 213                    (state (cond ((string= state-str ">") 'top)
 214                                 ((string= state-str "+") 'applied)
 215                                 ((string= state-str "-") 'unapplied)))
 216                    (name (intern (match-string 4)))
 217                    (desc (match-string 5))
 218                    (empty (string= (match-string 1) "0")))
 219               (unless inserted-index
 220                 (when (or (eq stgit-show-worktree-mode 'top)
 221                           (and (eq stgit-show-worktree-mode 'center)
 222                                (eq state 'unapplied)))
 223                   (setq inserted-index t)
 224                   (stgit-run-series-insert-index ewoc)))
 225               (setq all-patchsyms (cons name all-patchsyms))
 226               (ewoc-enter-last ewoc
 227                                (make-stgit-patch
 228                                 :status state
 229                                 :name   name
 230                                 :desc   desc
 231                                 :empty  empty)))
 232             (forward-line 1))))
 233       (unless inserted-index
 234         (stgit-run-series-insert-index ewoc)))
 235     (setq stgit-index-node    index-node
 236           stgit-worktree-node worktree-node
 237           stgit-marked-patches (intersection stgit-marked-patches
 238                                              all-patchsyms))))
 239
 240 (defun stgit-reload ()
 241   "Update the contents of the StGit buffer."
 242   (interactive)
 243   (let ((inhibit-read-only t)
 244         (curline (line-number-at-pos))
 245         (curpatch (stgit-patch-name-at-point))
 246         (curfile (stgit-patched-file-at-point)))
 247     (ewoc-filter stgit-ewoc #'(lambda (x) nil))
 248     (ewoc-set-hf stgit-ewoc
 249                  (concat "Branch: "
 250                          (propertize
 251                           (with-temp-buffer
 252                             (stgit-run-silent "branch")
 253                             (buffer-substring (point-min) (1- (point-max))))
 254                           'face 'stgit-branch-name-face)
 255                          "\n\n")
 256                  (if stgit-show-worktree
 257                      "--"
 258                    (propertize
 259                     (substitute-command-keys "--\n\"\\[stgit-toggle-worktree]\"\
 260  shows the working tree\n")
 261                    'face 'stgit-description-face)))
 262     (stgit-run-series stgit-ewoc)
 263     (if curpatch
 264         (stgit-goto-patch curpatch (and curfile (stgit-file-file curfile)))
 265       (goto-line curline)))
 266   (stgit-refresh-git-status))
 267
 268 (defgroup stgit nil
 269   "A user interface for the StGit patch maintenance tool."
 270   :group 'tools)
 271
 272 (defface stgit-description-face
 273   '((((background dark)) (:foreground "tan"))
 274     (((background light)) (:foreground "dark red")))
 275   "The face used for StGit descriptions"
 276   :group 'stgit)
 277
 278 (defface stgit-branch-name-face
 279   '((t :inherit bold))
 280   "The face used for the StGit branch name"
 281   :group 'stgit)
 282
 283 (defface stgit-top-patch-face
 284   '((((background dark)) (:weight bold :foreground "yellow"))
 285     (((background light)) (:weight bold :foreground "purple"))
 286     (t (:weight bold)))
 287   "The face used for the top patch names"
 288   :group 'stgit)
 289
 290 (defface stgit-applied-patch-face
 291   '((((background dark)) (:foreground "light yellow"))
 292     (((background light)) (:foreground "purple"))
 293     (t ()))
 294   "The face used for applied patch names"
 295   :group 'stgit)
 296
 297 (defface stgit-unapplied-patch-face
 298   '((((background dark)) (:foreground "gray80"))
 299     (((background light)) (:foreground "orchid"))
 300     (t ()))
 301   "The face used for unapplied patch names"
 302   :group 'stgit)
 303
 304 (defface stgit-modified-file-face
 305   '((((class color) (background light)) (:foreground "purple"))
 306     (((class color) (background dark)) (:foreground "salmon")))
 307   "StGit mode face used for modified file status"
 308   :group 'stgit)
 309
 310 (defface stgit-unmerged-file-face
 311   '((((class color) (background light)) (:foreground "red" :bold t))
 312     (((class color) (background dark)) (:foreground "red" :bold t)))
 313   "StGit mode face used for unmerged file status"
 314   :group 'stgit)
 315
 316 (defface stgit-unknown-file-face
 317   '((((class color) (background light)) (:foreground "goldenrod" :bold t))
 318     (((class color) (background dark)) (:foreground "goldenrod" :bold t)))
 319   "StGit mode face used for unknown file status"
 320   :group 'stgit)
 321
 322 (defface stgit-ignored-file-face
 323   '((((class color) (background light)) (:foreground "grey60"))
 324     (((class color) (background dark)) (:foreground "grey40")))
 325   "StGit mode face used for ignored files")
 326
 327 (defface stgit-file-permission-face
 328   '((((class color) (background light)) (:foreground "green" :bold t))
 329     (((class color) (background dark)) (:foreground "green" :bold t)))
 330   "StGit mode face used for permission changes."
 331   :group 'stgit)
 332
 333 (defface stgit-index-work-tree-title-face
 334   '((((supports :slant italic)) :slant italic)
 335     (t :inherit bold))
 336   "StGit mode face used for the \"Index\" and \"Work tree\" titles"
 337   :group 'stgit)
 338
 339
 340 (defcustom stgit-find-copies-harder
 341   nil
 342   "Try harder to find copied files when listing patches.
 343
 344 When not nil, runs git diff-tree with the --find-copies-harder
 345 flag, which reduces performance."
 346   :type 'boolean
 347   :group 'stgit)
 348
 349 (defconst stgit-file-status-code-strings
 350   (mapcar (lambda (arg)
 351             (cons (car arg)
 352                   (propertize (cadr arg) 'face (car (cddr arg)))))
 353           '((add         "Added"       stgit-modified-file-face)
 354             (copy        "Copied"      stgit-modified-file-face)
 355             (delete      "Deleted"     stgit-modified-file-face)
 356             (modify      "Modified"    stgit-modified-file-face)
 357             (rename      "Renamed"     stgit-modified-file-face)
 358             (mode-change "Mode change" stgit-modified-file-face)
 359             (unmerged    "Unmerged"    stgit-unmerged-file-face)
 360             (unknown     "Unknown"     stgit-unknown-file-face)
 361             (ignore      "Ignored"     stgit-ignored-file-face)))
 362   "Alist of code symbols to description strings")
 363
 364 (defconst stgit-patch-status-face-alist
 365   '((applied   . stgit-applied-patch-face)
 366     (top       . stgit-top-patch-face)
 367     (unapplied . stgit-unapplied-patch-face)
 368     (index     . stgit-index-work-tree-title-face)
 369     (work      . stgit-index-work-tree-title-face))
 370   "Alist of face to use for a given patch status")
 371
 372 (defun stgit-file-status-code-as-string (file)
 373   "Return stgit status code for FILE as a string"
 374   (let* ((code (assq (stgit-file-status file)
 375                      stgit-file-status-code-strings))
 376          (score (stgit-file-cr-score file)))
 377     (when code
 378       (format "%-11s  "
 379               (if (and score (/= score 100))
 380                   (format "%s %s" (cdr code)
 381                           (propertize (format "%d%%" score)
 382                                       'face 'stgit-description-face))
 383                 (cdr code))))))
 384
 385 (defun stgit-file-status-code (str &optional score)
 386   "Return stgit status code from git status string"
 387   (let ((code (assoc str '(("A" . add)
 388                            ("C" . copy)
 389                            ("D" . delete)
 390                            ("I" . ignore)
 391                            ("M" . modify)
 392                            ("R" . rename)
 393                            ("T" . mode-change)
 394                            ("U" . unmerged)
 395                            ("X" . unknown)))))
 396     (setq code (if code (cdr code) 'unknown))
 397     (when (stringp score)
 398       (if (> (length score) 0)
 399           (setq score (string-to-number score))
 400         (setq score nil)))
 401     (if score (cons code score) code)))
 402
 403 (defconst stgit-file-type-strings
 404   '((#o100 . "file")
 405     (#o120 . "symlink")
 406     (#o160 . "subproject"))
 407   "Alist of names of file types")
 408
 409 (defun stgit-file-type-string (type)
 410   "Return string describing file type TYPE (the high bits of file permission).
 411 Cf. `stgit-file-type-strings' and `stgit-file-type-change-string'."
 412   (let ((type-str (assoc type stgit-file-type-strings)))
 413     (or (and type-str (cdr type-str))
 414         (format "unknown type %o" type))))
 415
 416 (defun stgit-file-type-change-string (old-perm new-perm)
 417   "Return string describing file type change from OLD-PERM to NEW-PERM.
 418 Cf. `stgit-file-type-string'."
 419   (let ((old-type (lsh old-perm -9))
 420         (new-type (lsh new-perm -9)))
 421     (cond ((= old-type new-type) "")
 422           ((zerop new-type) "")
 423           ((zerop old-type)
 424            (if (= new-type #o100)
 425                ""
 426              (format "   (%s)" (stgit-file-type-string new-type))))
 427           (t (format "   (%s -> %s)"
 428                      (stgit-file-type-string old-type)
 429                      (stgit-file-type-string new-type))))))
 430
 431 (defun stgit-file-mode-change-string (old-perm new-perm)
 432   "Return string describing file mode change from OLD-PERM to NEW-PERM.
 433 Cf. `stgit-file-type-change-string'."
 434   (setq old-perm (logand old-perm #o777)
 435         new-perm (logand new-perm #o777))
 436   (if (or (= old-perm new-perm)
 437           (zerop old-perm)
 438           (zerop new-perm))
 439       ""
 440     (let* ((modified       (logxor old-perm new-perm))
 441            (not-x-modified (logand (logxor old-perm new-perm) #o666)))
 442       (cond ((zerop modified) "")
 443             ((and (zerop not-x-modified)
 444                   (or (and (eq #o111 (logand old-perm #o111))
 445                            (propertize "-x" 'face 'stgit-file-permission-face))
 446                       (and (eq #o111 (logand new-perm #o111))
 447                            (propertize "+x" 'face
 448                                        'stgit-file-permission-face)))))
 449             (t (concat (propertize (format "%o" old-perm)
 450                                    'face 'stgit-file-permission-face)
 451                        (propertize " -> "
 452                                    'face 'stgit-description-face)
 453                        (propertize (format "%o" new-perm)
 454                                    'face 'stgit-file-permission-face)))))))
 455
 456 (defstruct (stgit-file)
 457   old-perm new-perm copy-or-rename cr-score cr-from cr-to status file)
 458
 459 (defun stgit-file-pp (file)
 460   (let ((status (stgit-file-status file))
 461         (name (if (stgit-file-copy-or-rename file)
 462                   (concat (stgit-file-cr-from file)
 463                           (propertize " -> "
 464                                       'face 'stgit-description-face)
 465                           (stgit-file-cr-to file))
 466                 (stgit-file-file file)))
 467         (mode-change (stgit-file-mode-change-string
 468                       (stgit-file-old-perm file)
 469                       (stgit-file-new-perm file)))
 470         (start (point)))
 471     (insert (format "    %-12s%1s%s%s\n"
 472                     (stgit-file-status-code-as-string file)
 473                     mode-change
 474                     name
 475                     (propertize (stgit-file-type-change-string
 476                                  (stgit-file-old-perm file)
 477                                  (stgit-file-new-perm file))
 478                                 'face 'stgit-description-face)))
 479     (add-text-properties start (point)
 480                          (list 'entry-type 'file
 481                                'file-data file))))
 482
 483 (defun stgit-find-copies-harder-diff-arg ()
 484   "Return the flag to use with `git-diff' depending on the
 485 `stgit-find-copies-harder' flag."
 486   (if stgit-find-copies-harder "--find-copies-harder" "-C"))
 487
 488 (defun stgit-insert-ls-files (args file-flag)
 489   (let ((start (point)))
 490     (apply 'stgit-run-git
 491            (append '("ls-files" "--exclude-standard" "-z") args))
 492     (goto-char start)
 493     (while (looking-at "\\([^\0]*\\)\0")
 494       (let ((name-len (- (match-end 0) (match-beginning 0))))
 495         (insert ":0 0 0000000000000000000000000000000000000000 0000000000000000000000000000000000000000 " file-flag "\0")
 496         (forward-char name-len)))))
 497
 498 (defun stgit-insert-patch-files (patch)
 499   "Expand (show modification of) the patch PATCH after the line
 500 at point."
 501   (let* ((patchsym (stgit-patch-name patch))
 502          (end      (point-marker))
 503          (args     (list "-z" (stgit-find-copies-harder-diff-arg)))
 504          (ewoc     (ewoc-create #'stgit-file-pp nil nil t)))
 505     (set-marker-insertion-type end t)
 506     (setf (stgit-patch-files-ewoc patch) ewoc)
 507     (with-temp-buffer
 508       (apply 'stgit-run-git
 509              (cond ((eq patchsym :work)
 510                     `("diff-files" "-0" ,@args))
 511                    ((eq patchsym :index)
 512                     `("diff-index" ,@args "--cached" "HEAD"))
 513                    (t
 514                     `("diff-tree" ,@args "-r" ,(stgit-id patchsym)))))
 515
 516       (when (and (eq patchsym :work))
 517         (when stgit-show-ignored
 518           (stgit-insert-ls-files '("--ignored" "--others") "I"))
 519         (when stgit-show-unknown
 520           (stgit-insert-ls-files '("--others") "X"))
 521         (sort-regexp-fields nil ":[^\0]*\0\\([^\0]*\\)\0" "\\1"
 522                             (point-min) (point-max)))
 523
 524       (goto-char (point-min))
 525       (unless (or (eobp) (memq patchsym '(:work :index)))
 526         (forward-char 41))
 527       (while (looking-at ":\\([0-7]+\\) \\([0-7]+\\) [0-9A-Fa-f]\\{40\\} [0-9A-Fa-f]\\{40\\} ")
 528         (let ((old-perm (string-to-number (match-string 1) 8))
 529               (new-perm (string-to-number (match-string 2) 8)))
 530           (goto-char (match-end 0))
 531           (let ((file
 532                  (cond ((looking-at
 533                          "\\([CR]\\)\\([0-9]*\\)\0\\([^\0]*\\)\0\\([^\0]*\\)\0")
 534                         (let* ((patch-status (stgit-patch-status patch))
 535                                (file-subexp  (if (eq patch-status 'unapplied)
 536                                                  3
 537                                                4))
 538                                (file         (match-string file-subexp)))
 539                           (make-stgit-file
 540                            :old-perm       old-perm
 541                            :new-perm       new-perm
 542                            :copy-or-rename t
 543                            :cr-score       (string-to-number (match-string 2))
 544                            :cr-from        (match-string 3)
 545                            :cr-to          (match-string 4)
 546                            :status         (stgit-file-status-code
 547                                             (match-string 1))
 548                            :file           file)))
 549                        ((looking-at "\\([ABD-QS-Z]\\)\0\\([^\0]*\\)\0")
 550                         (make-stgit-file
 551                          :old-perm       old-perm
 552                          :new-perm       new-perm
 553                          :copy-or-rename nil
 554                          :cr-score       nil
 555                          :cr-from        nil
 556                          :cr-to          nil
 557                          :status         (stgit-file-status-code
 558                                           (match-string 1))
 559                          :file           (match-string 2))))))
 560             (ewoc-enter-last ewoc file))
 561           (goto-char (match-end 0))))
 562       (unless (ewoc-nth ewoc 0)
 563         (ewoc-set-hf ewoc ""
 564                      (concat "    "
 565                              (propertize "<no files>"
 566                                          'face 'stgit-description-face)
 567                              "\n"))))
 568     (goto-char end)))
 569
 570 (defun stgit-find-file (&optional other-window)
 571   (let* ((file (or (stgit-patched-file-at-point)
 572                    (error "No file at point")))
 573          (filename (expand-file-name (stgit-file-file file))))
 574     (unless (file-exists-p filename)
 575       (error "File does not exist"))
 576     (funcall (if other-window 'find-file-other-window 'find-file)
 577              filename)
 578     (when (eq (stgit-file-status file) 'unmerged)
 579       (smerge-mode 1))))
 580
 581 (defun stgit-select-patch ()
 582   (let ((patchname (stgit-patch-name-at-point)))
 583     (if (memq patchname stgit-expanded-patches)
 584         (setq stgit-expanded-patches (delq patchname stgit-expanded-patches))
 585       (setq stgit-expanded-patches (cons patchname stgit-expanded-patches)))
 586     (ewoc-invalidate stgit-ewoc (ewoc-locate stgit-ewoc)))
 587   (move-to-column (stgit-goal-column)))
 588
 589 (defun stgit-select ()
 590   "With point on a patch, toggle showing files in the patch.
 591
 592 With point on a file, open the associated file. Opens the target
 593 file for (applied) copies and renames."
 594   (interactive)
 595   (case (get-text-property (point) 'entry-type)
 596     ('patch
 597      (stgit-select-patch))
 598     ('file
 599      (stgit-find-file))
 600     (t
 601      (error "No patch or file on line"))))
 602
 603 (defun stgit-find-file-other-window ()
 604   "Open file at point in other window"
 605   (interactive)
 606   (stgit-find-file t))
 607
 608 (defun stgit-find-file-merge ()
 609   "Open file at point and merge it using `smerge-ediff'."
 610   (interactive)
 611   (stgit-find-file t)
 612   (smerge-ediff))
 613
 614 (defun stgit-quit ()
 615   "Hide the stgit buffer."
 616   (interactive)
 617   (bury-buffer))
 618
 619 (defun stgit-git-status ()
 620   "Show status using `git-status'."
 621   (interactive)
 622   (unless (fboundp 'git-status)
 623     (error "The stgit-git-status command requires git-status"))
 624   (let ((dir default-directory))
 625     (save-selected-window
 626       (pop-to-buffer nil)
 627       (git-status dir))))
 628
 629 (defun stgit-goal-column ()
 630   "Return goal column for the current line"
 631   (case (get-text-property (point) 'entry-type)
 632     ('patch 2)
 633     ('file 4)
 634     (t 0)))
 635
 636 (defun stgit-next-line (&optional arg)
 637   "Move cursor vertically down ARG lines"
 638   (interactive "p")
 639   (next-line arg)
 640   (move-to-column (stgit-goal-column)))
 641
 642 (defun stgit-previous-line (&optional arg)
 643   "Move cursor vertically up ARG lines"
 644   (interactive "p")
 645   (previous-line arg)
 646   (move-to-column (stgit-goal-column)))
 647
 648 (defun stgit-next-patch (&optional arg)
 649   "Move cursor down ARG patches."
 650   (interactive "p")
 651   (ewoc-goto-next stgit-ewoc (or arg 1))
 652   (move-to-column goal-column))
 653
 654 (defun stgit-previous-patch (&optional arg)
 655   "Move cursor up ARG patches."
 656   (interactive "p")
 657   (ewoc-goto-prev stgit-ewoc (or arg 1))
 658   (move-to-column goal-column))
 659
 660 (defvar stgit-mode-hook nil
 661   "Run after `stgit-mode' is setup.")
 662
 663 (defvar stgit-mode-map nil
 664   "Keymap for StGit major mode.")
 665
 666 (unless stgit-mode-map
 667   (let ((diff-map   (make-keymap))
 668         (toggle-map (make-keymap)))
 669     (suppress-keymap diff-map)
 670     (mapc (lambda (arg) (define-key diff-map (car arg) (cdr arg)))
 671           '(("b" .        stgit-diff-base)
 672             ("c" .        stgit-diff-combined)
 673             ("m" .        stgit-find-file-merge)
 674             ("o" .        stgit-diff-ours)
 675             ("t" .        stgit-diff-theirs)))
 676     (suppress-keymap toggle-map)
 677     (mapc (lambda (arg) (define-key toggle-map (car arg) (cdr arg)))
 678           '(("t" .        stgit-toggle-worktree)
 679             ("i" .        stgit-toggle-ignored)
 680             ("u" .        stgit-toggle-unknown)))
 681     (setq stgit-mode-map (make-keymap))
 682     (suppress-keymap stgit-mode-map)
 683     (mapc (lambda (arg) (define-key stgit-mode-map (car arg) (cdr arg)))
 684           `((" " .        stgit-mark)
 685             ("m" .        stgit-mark)
 686             ("\d" .       stgit-unmark-up)
 687             ("u" .        stgit-unmark-down)
 688             ("?" .        stgit-help)
 689             ("h" .        stgit-help)
 690             ("\C-p" .     stgit-previous-line)
 691             ("\C-n" .     stgit-next-line)
 692             ([up] .       stgit-previous-line)
 693             ([down] .     stgit-next-line)
 694             ("p" .        stgit-previous-patch)
 695             ("n" .        stgit-next-patch)
 696             ("\M-{" .     stgit-previous-patch)
 697             ("\M-}" .     stgit-next-patch)
 698             ("s" .        stgit-git-status)
 699             ("g" .        stgit-reload-or-repair)
 700             ("r" .        stgit-refresh)
 701             ("\C-c\C-r" . stgit-rename)
 702             ("e" .        stgit-edit)
 703             ("M" .        stgit-move-patches)
 704             ("S" .        stgit-squash)
 705             ("N" .        stgit-new)
 706             ("\C-c\C-c" . stgit-commit)
 707             ("\C-c\C-u" . stgit-uncommit)
 708             ("U" .        stgit-revert-file)
 709             ("R" .        stgit-resolve-file)
 710             ("\r" .       stgit-select)
 711             ("o" .        stgit-find-file-other-window)
 712             ("i" .        stgit-file-toggle-index)
 713             (">" .        stgit-push-next)
 714             ("<" .        stgit-pop-next)
 715             ("P" .        stgit-push-or-pop)
 716             ("G" .        stgit-goto)
 717             ("=" .        stgit-diff)
 718             ("D" .        stgit-delete)
 719             ([(control ?/)] . stgit-undo)
 720             ("\C-_" .     stgit-undo)
 721             ("B" .        stgit-branch)
 722             ("t" .        ,toggle-map)
 723             ("d" .        ,diff-map)
 724             ("q" .        stgit-quit)))))
 725
 726 (defun stgit-mode ()
 727   "Major mode for interacting with StGit.
 728 Commands:
 729 \\{stgit-mode-map}"
 730   (kill-all-local-variables)
 731   (buffer-disable-undo)
 732   (setq mode-name "StGit"
 733         major-mode 'stgit-mode
 734         goal-column 2)
 735   (use-local-map stgit-mode-map)
 736   (set (make-local-variable 'list-buffers-directory) default-directory)
 737   (set (make-local-variable 'stgit-marked-patches) nil)
 738   (set (make-local-variable 'stgit-expanded-patches) (list :work :index))
 739   (set (make-local-variable 'stgit-show-worktree) stgit-default-show-worktree)
 740   (set (make-local-variable 'stgit-index-node) nil)
 741   (set (make-local-variable 'stgit-worktree-node) nil)
 742   (set-variable 'truncate-lines 't)
 743   (add-hook 'after-save-hook 'stgit-update-saved-file)
 744   (run-hooks 'stgit-mode-hook))
 745
 746 (defun stgit-update-saved-file ()
 747   (let* ((file (expand-file-name buffer-file-name))
 748          (dir (file-name-directory file))
 749          (gitdir (condition-case nil (git-get-top-dir dir)
 750                    (error nil)))
 751          (buffer (and gitdir (stgit-find-buffer gitdir))))
 752     (when buffer
 753       (with-current-buffer buffer
 754         (stgit-refresh-worktree)))))
 755
 756 (defun stgit-add-mark (patchsym)
 757   "Mark the patch PATCHSYM."
 758   (setq stgit-marked-patches (cons patchsym stgit-marked-patches)))
 759
 760 (defun stgit-remove-mark (patchsym)
 761   "Unmark the patch PATCHSYM."
 762   (setq stgit-marked-patches (delq patchsym stgit-marked-patches)))
 763
 764 (defun stgit-clear-marks ()
 765   "Unmark all patches."
 766   (setq stgit-marked-patches '()))
 767
 768 (defun stgit-patch-at-point (&optional cause-error)
 769   (get-text-property (point) 'patch-data))
 770
 771 (defun stgit-patch-name-at-point (&optional cause-error only-patches)
 772   "Return the patch name on the current line as a symbol.
 773 If CAUSE-ERROR is not nil, signal an error if none found.
 774 If ONLY-PATCHES is not nil, only allow real patches, and not
 775 index or work tree."
 776   (let ((patch (stgit-patch-at-point)))
 777     (and patch
 778          only-patches
 779          (memq (stgit-patch-status patch) '(work index))
 780          (setq patch nil))
 781     (cond (patch
 782            (stgit-patch-name patch))
 783           (cause-error
 784            (error "No patch on this line")))))
 785
 786 (defun stgit-patched-file-at-point ()
 787   (get-text-property (point) 'file-data))
 788
 789 (defun stgit-patches-marked-or-at-point ()
 790   "Return the symbols of the marked patches, or the patch on the current line."
 791   (if stgit-marked-patches
 792       stgit-marked-patches
 793     (let ((patch (stgit-patch-name-at-point)))
 794       (if patch
 795           (list patch)
 796         '()))))
 797
 798 (defun stgit-goto-patch (patchsym &optional file)
 799   "Move point to the line containing patch PATCHSYM.
 800 If that patch cannot be found, do nothing.
 801
 802 If the patch was found and FILE is not nil, instead move to that
 803 file's line. If FILE cannot be found, stay on the line of
 804 PATCHSYM."
 805   (let ((node (ewoc-nth stgit-ewoc 0)))
 806     (while (and node (not (eq (stgit-patch-name (ewoc-data node))
 807                               patchsym)))
 808       (setq node (ewoc-next stgit-ewoc node)))
 809     (when (and node file)
 810       (let* ((file-ewoc (stgit-patch-files-ewoc (ewoc-data node)))
 811              (file-node (ewoc-nth file-ewoc 0)))
 812         (while (and file-node (not (equal (stgit-file-file (ewoc-data file-node)) file)))
 813           (setq file-node (ewoc-next file-ewoc file-node)))
 814         (when file-node
 815           (ewoc-goto-node file-ewoc file-node)
 816           (move-to-column (stgit-goal-column))
 817           (setq node nil))))
 818     (when node
 819       (ewoc-goto-node stgit-ewoc node)
 820       (move-to-column goal-column))))
 821
 822 (defun stgit-init ()
 823   "Run stg init."
 824   (interactive)
 825   (stgit-capture-output nil
 826     (stgit-run "init"))
 827   (stgit-reload))
 828
 829 (defun stgit-mark ()
 830   "Mark the patch under point."
 831   (interactive)
 832   (let* ((node (ewoc-locate stgit-ewoc))
 833          (patch (ewoc-data node))
 834          (name (stgit-patch-name patch)))
 835     (when (eq name :work)
 836       (error "Cannot mark the work tree"))
 837     (when (eq name :index)
 838       (error "Cannot mark the index"))
 839     (stgit-add-mark (stgit-patch-name patch))
 840     (ewoc-invalidate stgit-ewoc node))
 841   (stgit-next-patch))
 842
 843 (defun stgit-unmark-up ()
 844   "Remove mark from the patch on the previous line."
 845   (interactive)
 846   (stgit-previous-patch)
 847   (let* ((node (ewoc-locate stgit-ewoc))
 848          (patch (ewoc-data node)))
 849     (stgit-remove-mark (stgit-patch-name patch))
 850     (ewoc-invalidate stgit-ewoc node))
 851   (move-to-column (stgit-goal-column)))
 852
 853 (defun stgit-unmark-down ()
 854   "Remove mark from the patch on the current line."
 855   (interactive)
 856   (let* ((node (ewoc-locate stgit-ewoc))
 857          (patch (ewoc-data node)))
 858     (stgit-remove-mark (stgit-patch-name patch))
 859     (ewoc-invalidate stgit-ewoc node))
 860   (stgit-next-patch))
 861
 862 (defun stgit-rename (name)
 863   "Rename the patch under point to NAME."
 864   (interactive (list
 865                 (read-string "Patch name: "
 866                              (symbol-name (stgit-patch-name-at-point t t)))))
 867   (let ((old-patchsym (stgit-patch-name-at-point t t)))
 868     (stgit-capture-output nil
 869       (stgit-run "rename" old-patchsym name))
 870     (let ((name-sym (intern name)))
 871       (when (memq old-patchsym stgit-expanded-patches)
 872         (setq stgit-expanded-patches
 873             (cons name-sym (delq old-patchsym stgit-expanded-patches))))
 874       (when (memq old-patchsym stgit-marked-patches)
 875         (setq stgit-marked-patches
 876             (cons name-sym (delq old-patchsym stgit-marked-patches))))
 877       (stgit-reload)
 878       (stgit-goto-patch name-sym))))
 879
 880 (defun stgit-reload-or-repair (repair)
 881   "Update the contents of the StGit buffer (`stgit-reload').
 882
 883 With a prefix argument, repair the StGit metadata if the branch
 884 was modified with git commands (`stgit-repair')."
 885   (interactive "P")
 886   (if repair
 887       (stgit-repair)
 888     (stgit-reload)))
 889
 890 (defun stgit-repair ()
 891   "Run stg repair."
 892   (interactive)
 893   (stgit-capture-output nil
 894     (stgit-run "repair"))
 895   (stgit-reload))
 896
 897 (defun stgit-available-branches ()
 898   "Returns a list of the available stg branches"
 899   (let ((output (with-output-to-string
 900                   (stgit-run "branch" "--list")))
 901         (start 0)
 902         result)
 903     (while (string-match "^>?\\s-+s\\s-+\\(\\S-+\\)" output start)
 904       (setq result (cons (match-string 1 output) result))
 905       (setq start (match-end 0)))
 906     result))
 907
 908 (defun stgit-branch (branch)
 909   "Switch to branch BRANCH."
 910   (interactive (list (completing-read "Switch to branch: "
 911                                       (stgit-available-branches))))
 912   (stgit-capture-output nil (stgit-run "branch" "--" branch))
 913   (stgit-reload))
 914
 915 (defun stgit-commit (count)
 916   "Run stg commit on COUNT commits.
 917 Interactively, the prefix argument is used as COUNT.
 918 A negative COUNT will uncommit instead."
 919   (interactive "p")
 920   (if (< count 0)
 921       (stgit-uncommit (- count))
 922     (stgit-capture-output nil (stgit-run "commit" "-n" count))
 923     (stgit-reload)))
 924
 925 (defun stgit-uncommit (count)
 926   "Run stg uncommit on COUNT commits.
 927 Interactively, the prefix argument is used as COUNT.
 928 A negative COUNT will commit instead."
 929   (interactive "p")
 930   (if (< count 0)
 931       (stgit-commit (- count))
 932     (stgit-capture-output nil (stgit-run "uncommit" "-n" count))
 933     (stgit-reload)))
 934
 935 (defun stgit-revert-file ()
 936   "Revert the file at point, which must be in the index or the
 937 working tree."
 938   (interactive)
 939   (let* ((patched-file (or (stgit-patched-file-at-point)
 940                            (error "No file on the current line")))
 941          (patch-name   (stgit-patch-name-at-point))
 942          (file-status  (stgit-file-status patched-file))
 943          (rm-file      (cond ((stgit-file-copy-or-rename patched-file)
 944                               (stgit-file-cr-to patched-file))
 945                              ((eq file-status 'add)
 946                               (stgit-file-file patched-file))))
 947          (co-file      (cond ((eq file-status 'rename)
 948                               (stgit-file-cr-from patched-file))
 949                              ((not (memq file-status '(copy add)))
 950                               (stgit-file-file patched-file)))))
 951
 952     (unless (memq patch-name '(:work :index))
 953       (error "No index or working tree file on this line"))
 954
 955     (when (eq file-status 'ignore)
 956       (error "Cannot revert ignored files"))
 957
 958     (when (eq file-status 'unknown)
 959       (error "Cannot revert unknown files"))
 960
 961     (let ((nfiles (+ (if rm-file 1 0) (if co-file 1 0))))
 962       (when (yes-or-no-p (format "Revert %d file%s? "
 963                                  nfiles
 964                                  (if (= nfiles 1) "" "s")))
 965         (stgit-capture-output nil
 966           (when rm-file
 967             (stgit-run-git "rm" "-f" "-q" "--" rm-file))
 968           (when co-file
 969             (stgit-run-git "checkout" "HEAD" co-file)))
 970         (stgit-reload)))))
 971
 972 (defun stgit-resolve-file ()
 973   "Resolve conflict in the file at point."
 974   (interactive)
 975   (let* ((patched-file (stgit-patched-file-at-point))
 976          (patch        (stgit-patch-at-point))
 977          (patch-name   (and patch (stgit-patch-name patch)))
 978          (status       (and patched-file (stgit-file-status patched-file))))
 979
 980     (unless (memq patch-name '(:work :index))
 981       (error "No index or working tree file on this line"))
 982
 983     (unless (eq status 'unmerged)
 984       (error "No conflict to resolve at the current line"))
 985
 986     (stgit-capture-output nil
 987       (stgit-move-change-to-index (stgit-file-file patched-file)))
 988
 989     (stgit-reload)))
 990
 991 (defun stgit-push-next (npatches)
 992   "Push the first unapplied patch.
 993 With numeric prefix argument, push that many patches."
 994   (interactive "p")
 995   (stgit-capture-output nil (stgit-run "push" "-n" npatches))
 996   (stgit-reload)
 997   (stgit-refresh-git-status))
 998
 999 (defun stgit-pop-next (npatches)
1000   "Pop the topmost applied patch.
1001 With numeric prefix argument, pop that many patches."
1002   (interactive "p")
1003   (stgit-capture-output nil (stgit-run "pop" "-n" npatches))
1004   (stgit-reload)
1005   (stgit-refresh-git-status))
1006
1007 (defun stgit-applied-at-point ()
1008   "Is the patch on the current line applied?"
1009   (save-excursion
1010     (beginning-of-line)
1011     (looking-at "[>+]")))
1012
1013 (defun stgit-push-or-pop ()
1014   "Push or pop the patch on the current line."
1015   (interactive)
1016   (let ((patchsym (stgit-patch-name-at-point t))
1017         (applied (stgit-applied-at-point)))
1018     (stgit-capture-output nil
1019       (stgit-run (if applied "pop" "push") patchsym))
1020     (stgit-reload)))
1021
1022 (defun stgit-goto ()
1023   "Go to the patch on the current line."
1024   (interactive)
1025   (let ((patchsym (stgit-patch-name-at-point t)))
1026     (stgit-capture-output nil
1027       (stgit-run "goto" patchsym))
1028     (stgit-reload)))
1029
1030 (defun stgit-id (patchsym)
1031   "Return the git commit id for PATCHSYM.
1032 If PATCHSYM is a keyword, returns PATCHSYM unmodified."
1033   (if (keywordp patchsym)
1034       patchsym
1035     (let ((result (with-output-to-string
1036                     (stgit-run-silent "id" patchsym))))
1037       (unless (string-match "^\\([0-9A-Fa-f]\\{40\\}\\)$" result)
1038         (error "Cannot find commit id for %s" patchsym))
1039       (match-string 1 result))))
1040
1041 (defun stgit-show-patch (unmerged-stage ignore-whitespace)
1042   "Show the patch on the current line.
1043
1044 UNMERGED-STAGE is the argument to `git-diff' that that selects
1045 which stage to diff against in the case of unmerged files."
1046   (let ((space-arg (when (numberp ignore-whitespace)
1047                      (cond ((> ignore-whitespace 4)
1048                             "--ignore-all-space")
1049                            ((> ignore-whitespace 1)
1050                             "--ignore-space-change"))))
1051         (patch-name (stgit-patch-name-at-point t)))
1052     (stgit-capture-output "*StGit patch*"
1053       (case (get-text-property (point) 'entry-type)
1054         ('file
1055          (let* ((patched-file (stgit-patched-file-at-point))
1056                 (patch-id (let ((id (stgit-id patch-name)))
1057                             (if (and (eq id :index)
1058                                      (eq (stgit-file-status patched-file)
1059                                          'unmerged))
1060                                 :work
1061                               id)))
1062                 (args (append (and space-arg (list space-arg))
1063                               (and (stgit-file-cr-from patched-file)
1064                                    (list (stgit-find-copies-harder-diff-arg)))
1065                               (cond ((eq patch-id :index)
1066                                      '("--cached"))
1067                                     ((eq patch-id :work)
1068                                      (list unmerged-stage))
1069                                     (t
1070                                      (list (concat patch-id "^") patch-id)))
1071                               '("--")
1072                               (if (stgit-file-copy-or-rename patched-file)
1073                                   (list (stgit-file-cr-from patched-file)
1074                                         (stgit-file-cr-to patched-file))
1075                                 (list (stgit-file-file patched-file))))))
1076            (apply 'stgit-run-git "diff" args)))
1077         ('patch
1078          (let* ((patch-id (stgit-id patch-name)))
1079            (if (or (eq patch-id :index) (eq patch-id :work))
1080                (apply 'stgit-run-git "diff"
1081                       (stgit-find-copies-harder-diff-arg)
1082                       (append (and space-arg (list space-arg))
1083                               (if (eq patch-id :index)
1084                                   '("--cached")
1085                                 (list unmerged-stage))))
1086              (let ((args (append '("show" "-O" "--patch-with-stat" "-O" "-M")
1087                                  (and space-arg (list "-O" space-arg))
1088                                  (list (stgit-patch-name-at-point)))))
1089                (apply 'stgit-run args)))))
1090          (t
1091           (error "No patch or file at point")))
1092       (with-current-buffer standard-output
1093         (goto-char (point-min))
1094         (diff-mode)))))
1095
1096 (defmacro stgit-define-diff (name diff-arg &optional unmerged-action)
1097   `(defun ,name (&optional ignore-whitespace)
1098      ,(format "Show the patch on the current line.
1099
1100 %sWith a prefix argument, ignore whitespace. With a prefix argument
1101 greater than four (e.g., \\[universal-argument] \
1102 \\[universal-argument] \\[%s]), ignore all whitespace."
1103               (if unmerged-action
1104                   (format "For unmerged files, %s.\n\n" unmerged-action)
1105                 "")
1106               name)
1107      (interactive "p")
1108      (stgit-show-patch ,diff-arg ignore-whitespace)))
1109
1110 (stgit-define-diff stgit-diff
1111                    "--ours" nil)
1112 (stgit-define-diff stgit-diff-ours
1113                    "--ours"
1114                    "diff against our branch")
1115 (stgit-define-diff stgit-diff-theirs
1116                    "--theirs"
1117                    "diff against their branch")
1118 (stgit-define-diff stgit-diff-base
1119                    "--base"
1120                    "diff against the merge base")
1121 (stgit-define-diff stgit-diff-combined
1122                    "--cc"
1123                    "show a combined diff")
1124
1125 (defun stgit-move-change-to-index (file)
1126   "Copies the workspace state of FILE to index, using git add or git rm"
1127   (let ((op (if (or (file-exists-p file) (file-symlink-p file))
1128                 '("add") '("rm" "-q"))))
1129     (stgit-capture-output "*git output*"
1130       (apply 'stgit-run-git (append op '("--") (list file))))))
1131
1132 (defun stgit-remove-change-from-index (file)
1133   "Unstages the change in FILE from the index"
1134   (stgit-capture-output "*git output*"
1135     (stgit-run-git "reset" "-q" "--" file)))
1136
1137 (defun stgit-file-toggle-index ()
1138   "Move modified file in or out of the index.
1139
1140 Leaves the point where it is, but moves the mark to where the
1141 file ended up. You can then jump to the file with \
1142 \\[exchange-point-and-mark]."
1143   (interactive)
1144   (let ((patched-file (stgit-patched-file-at-point)))
1145     (unless patched-file
1146       (error "No file on the current line"))
1147     (when (eq (stgit-file-status patched-file) 'unmerged)
1148       (error (substitute-command-keys "Use \\[stgit-resolve-file] to move an unmerged file to the index")))
1149     (when (eq (stgit-file-status patched-file) 'ignore)
1150       (error "You cannot add ignored files to the index"))
1151     (let* ((patch      (stgit-patch-at-point))
1152            (patch-name (stgit-patch-name patch))
1153            (old-point  (point))
1154            next-file)
1155
1156       ;; find the next file in the patch, or the previous one if this
1157       ;; was the last file
1158       (and (zerop (forward-line 1))
1159            (let ((f (stgit-patched-file-at-point)))
1160              (and f (setq next-file (stgit-file-file f)))))
1161       (goto-char old-point)
1162       (unless next-file
1163         (and (zerop (forward-line -1))
1164              (let ((f (stgit-patched-file-at-point)))
1165                (and f (setq next-file (stgit-file-file f)))))
1166         (goto-char old-point))
1167
1168       (cond ((eq patch-name :work)
1169              (stgit-move-change-to-index (stgit-file-file patched-file)))
1170             ((eq patch-name :index)
1171              (stgit-remove-change-from-index (stgit-file-file patched-file)))
1172             (t
1173              (error "Can only move files in the working tree to index")))
1174       (stgit-refresh-worktree)
1175       (stgit-refresh-index)
1176       (stgit-goto-patch (if (eq patch-name :index) :work :index)
1177                         (stgit-file-file patched-file))
1178       (push-mark nil t t)
1179       (stgit-goto-patch patch-name next-file))))
1180
1181 (defun stgit-edit ()
1182   "Edit the patch on the current line."
1183   (interactive)
1184   (let ((patchsym (stgit-patch-name-at-point t t))
1185         (edit-buf (get-buffer-create "*StGit edit*"))
1186         (dir default-directory))
1187     (log-edit 'stgit-confirm-edit t nil edit-buf)
1188     (set (make-local-variable 'stgit-edit-patchsym) patchsym)
1189     (setq default-directory dir)
1190     (let ((standard-output edit-buf))
1191       (stgit-run-silent "edit" "--save-template=-" patchsym))))
1192
1193 (defun stgit-confirm-edit ()
1194   (interactive)
1195   (let ((file (make-temp-file "stgit-edit-")))
1196     (write-region (point-min) (point-max) file)
1197     (stgit-capture-output nil
1198       (stgit-run "edit" "-f" file stgit-edit-patchsym))
1199     (with-current-buffer log-edit-parent-buffer
1200       (stgit-reload))))
1201
1202 (defun stgit-new (add-sign)
1203   "Create a new patch.
1204 With a prefix argument, include a \"Signed-off-by:\" line at the
1205 end of the patch."
1206   (interactive "P")
1207   (let ((edit-buf (get-buffer-create "*StGit edit*"))
1208         (dir default-directory))
1209     (log-edit 'stgit-confirm-new t nil edit-buf)
1210     (setq default-directory dir)
1211     (when add-sign
1212       (save-excursion
1213         (let ((standard-output (current-buffer)))
1214           (stgit-run-silent "new" "--sign" "--save-template=-"))))))
1215
1216 (defun stgit-confirm-new ()
1217   (interactive)
1218   (let ((file (make-temp-file "stgit-edit-")))
1219     (write-region (point-min) (point-max) file)
1220     (stgit-capture-output nil
1221       (stgit-run "new" "-f" file))
1222     (with-current-buffer log-edit-parent-buffer
1223       (stgit-reload))))
1224
1225 (defun stgit-create-patch-name (description)
1226   "Create a patch name from a long description"
1227   (let ((patch ""))
1228     (while (> (length description) 0)
1229       (cond ((string-match "\\`[a-zA-Z_-]+" description)
1230              (setq patch (downcase (concat patch
1231                                            (match-string 0 description))))
1232              (setq description (substring description (match-end 0))))
1233             ((string-match "\\` +" description)
1234              (setq patch (concat patch "-"))
1235              (setq description (substring description (match-end 0))))
1236             ((string-match "\\`[^a-zA-Z_-]+" description)
1237              (setq description (substring description (match-end 0))))))
1238     (cond ((= (length patch) 0)
1239            "patch")
1240           ((> (length patch) 20)
1241            (substring patch 0 20))
1242           (t patch))))
1243
1244 (defun stgit-delete (patchsyms &optional spill-p)
1245   "Delete the patches in PATCHSYMS.
1246 Interactively, delete the marked patches, or the patch at point.
1247
1248 With a prefix argument, or SPILL-P, spill the patch contents to
1249 the work tree and index."
1250   (interactive (list (stgit-patches-marked-or-at-point)
1251                      current-prefix-arg))
1252   (unless patchsyms
1253     (error "No patches to delete"))
1254   (when (memq :index patchsyms)
1255     (error "Cannot delete the index"))
1256   (when (memq :work  patchsyms)
1257     (error "Cannot delete the work tree"))
1258
1259   (let ((npatches (length patchsyms)))
1260     (when (yes-or-no-p (format "Really delete %d patch%s%s? "
1261                                npatches
1262                                (if (= 1 npatches) "" "es")
1263                                (if spill-p
1264                                    " (spilling contents to index)"
1265                                  "")))
1266       (let ((args (if spill-p
1267                       (cons "--spill" patchsyms)
1268                     patchsyms)))
1269         (stgit-capture-output nil
1270           (apply 'stgit-run "delete" args))
1271         (stgit-reload)))))
1272
1273 (defun stgit-move-patches-target ()
1274   "Return the patchsym indicating a target patch for
1275 `stgit-move-patches'.
1276
1277 This is either the patch at point, or one of :top and :bottom, if
1278 the point is after or before the applied patches."
1279
1280   (let ((patchsym (stgit-patch-name-at-point)))
1281     (cond (patchsym patchsym)
1282           ((save-excursion (re-search-backward "^>" nil t)) :top)
1283           (t :bottom))))
1284
1285 (defun stgit-sort-patches (patchsyms)
1286   "Returns the list of patches in PATCHSYMS sorted according to
1287 their position in the patch series, bottommost first.
1288
1289 PATCHSYMS may not contain duplicate entries."
1290   (let (sorted-patchsyms
1291         (series (with-output-to-string
1292                   (with-current-buffer standard-output
1293                     (stgit-run-silent "series" "--noprefix"))))
1294         start)
1295     (while (string-match "^\\(.+\\)" series start)
1296       (let ((patchsym (intern (match-string 1 series))))
1297         (when (memq patchsym patchsyms)
1298           (setq sorted-patchsyms (cons patchsym sorted-patchsyms))))
1299       (setq start (match-end 0)))
1300     (setq sorted-patchsyms (nreverse sorted-patchsyms))
1301
1302     (unless (= (length patchsyms) (length sorted-patchsyms))
1303       (error "Internal error"))
1304
1305     sorted-patchsyms))
1306
1307 (defun stgit-move-patches (patchsyms target-patch)
1308   "Move the patches in PATCHSYMS to below TARGET-PATCH.
1309 If TARGET-PATCH is :bottom or :top, move the patches to the
1310 bottom or top of the stack, respectively.
1311
1312 Interactively, move the marked patches to where the point is."
1313   (interactive (list stgit-marked-patches
1314                      (stgit-move-patches-target)))
1315   (unless patchsyms
1316     (error "Need at least one patch to move"))
1317
1318   (unless target-patch
1319     (error "Point not at a patch"))
1320
1321   (if (eq target-patch :top)
1322       (stgit-capture-output nil
1323         (apply 'stgit-run "float" patchsyms))
1324
1325     ;; need to have patchsyms sorted by position in the stack
1326     (let ((sorted-patchsyms (stgit-sort-patches patchsyms)))
1327       (while sorted-patchsyms
1328         (setq sorted-patchsyms
1329               (and (stgit-capture-output nil
1330                      (if (eq target-patch :bottom)
1331                          (stgit-run "sink" "--" (car sorted-patchsyms))
1332                        (stgit-run "sink" "--to" target-patch "--"
1333                                   (car sorted-patchsyms))))
1334                    (cdr sorted-patchsyms))))))
1335   (stgit-reload))
1336
1337 (defun stgit-squash (patchsyms)
1338   "Squash the patches in PATCHSYMS.
1339 Interactively, squash the marked patches.
1340
1341 Unless there are any conflicts, the patches will be merged into
1342 one patch, which will occupy the same spot in the series as the
1343 deepest patch had before the squash."
1344   (interactive (list stgit-marked-patches))
1345   (when (< (length patchsyms) 2)
1346     (error "Need at least two patches to squash"))
1347   (let ((stgit-buffer (current-buffer))
1348         (edit-buf (get-buffer-create "*StGit edit*"))
1349         (dir default-directory)
1350         (sorted-patchsyms (stgit-sort-patches patchsyms)))
1351     (log-edit 'stgit-confirm-squash t nil edit-buf)
1352     (set (make-local-variable 'stgit-patchsyms) sorted-patchsyms)
1353     (setq default-directory dir)
1354     (let ((result (let ((standard-output edit-buf))
1355                     (apply 'stgit-run-silent "squash"
1356                            "--save-template=-" sorted-patchsyms))))
1357
1358       ;; stg squash may have reordered the patches or caused conflicts
1359       (with-current-buffer stgit-buffer
1360         (stgit-reload))
1361
1362       (unless (eq 0 result)
1363         (fundamental-mode)
1364         (rename-buffer "*StGit error*")
1365         (resize-temp-buffer-window)
1366         (switch-to-buffer-other-window stgit-buffer)
1367         (error "stg squash failed")))))
1368
1369 (defun stgit-confirm-squash ()
1370   (interactive)
1371   (let ((file (make-temp-file "stgit-edit-")))
1372     (write-region (point-min) (point-max) file)
1373     (stgit-capture-output nil
1374       (apply 'stgit-run "squash" "-f" file stgit-patchsyms))
1375     (with-current-buffer log-edit-parent-buffer
1376       (stgit-clear-marks)
1377       ;; Go to first marked patch and stay there
1378       (goto-char (point-min))
1379       (re-search-forward (concat "^[>+-]\\*") nil t)
1380       (move-to-column goal-column)
1381       (let ((pos (point)))
1382         (stgit-reload)
1383         (goto-char pos)))))
1384
1385 (defun stgit-help ()
1386   "Display help for the StGit mode."
1387   (interactive)
1388   (describe-function 'stgit-mode))
1389
1390 (defun stgit-undo (&optional arg)
1391   "Run stg undo.
1392 With prefix argument, run it with the --hard flag."
1393   (interactive "P")
1394   (stgit-capture-output nil
1395     (if arg
1396         (stgit-run "undo" "--hard")
1397       (stgit-run "undo")))
1398   (stgit-reload))
1399
1400 (defun stgit-refresh (&optional arg)
1401   "Run stg refresh.
1402 If the index contains any changes, only refresh from index.
1403
1404 With prefix argument, refresh the marked patch or the patch under point."
1405   (interactive "P")
1406   (let ((patchargs (if arg
1407                        (let ((patches (stgit-patches-marked-or-at-point)))
1408                          (cond ((null patches)
1409                                 (error "No patch to update"))
1410                                ((> (length patches) 1)
1411                                 (error "Too many patches selected"))
1412                                (t
1413                                 (cons "-p" patches))))
1414                      nil)))
1415     (unless (stgit-index-empty-p)
1416       (setq patchargs (cons "--index" patchargs)))
1417     (stgit-capture-output nil
1418       (apply 'stgit-run "refresh" patchargs))
1419     (stgit-refresh-git-status))
1420   (stgit-reload))
1421
1422 (defcustom stgit-show-worktree-mode 'center
1423   "This variable controls where the \"Index\" and \"Work tree\"
1424 will be shown on in the buffer.
1425
1426 It can be set to 'top (above all patches), 'center (show between
1427 applied and unapplied patches), and 'bottom (below all patches).
1428
1429 See also `stgit-show-worktree'."
1430   :type '(radio (const :tag "above all patches (top)" top)
1431                 (const :tag "between applied and unapplied patches (center)"
1432                        center)
1433                 (const :tag "below all patches (bottom)" bottom))
1434   :group 'stgit)
1435
1436 (defcustom stgit-default-show-worktree
1437   nil
1438   "Set to non-nil to by default show the working tree in a new stgit buffer.
1439
1440 This value is used as the default value for `stgit-show-worktree'."
1441   :type 'boolean
1442   :group 'stgit)
1443
1444 (defvar stgit-show-worktree nil
1445   "If nil, inhibit showing work tree and index in the stgit buffer.
1446
1447 See also `stgit-show-worktree-mode'.")
1448
1449 (defvar stgit-show-ignored nil
1450   "If nil, inhibit showing files ignored by git.")
1451
1452 (defvar stgit-show-unknown nil
1453   "If nil, inhibit showing files not registered with git.")
1454
1455 (defun stgit-toggle-worktree (&optional arg)
1456   "Toggle the visibility of the work tree.
1457 With arg, show the work tree if arg is positive.
1458
1459 Its initial setting is controlled by `stgit-default-show-worktree'.
1460
1461 `stgit-show-worktree-mode' controls where on screen the index and
1462 work tree will show up."
1463   (interactive)
1464   (setq stgit-show-worktree
1465         (if (numberp arg)
1466             (> arg 0)
1467           (not stgit-show-worktree)))
1468   (stgit-reload))
1469
1470 (defun stgit-toggle-ignored (&optional arg)
1471   "Toggle the visibility of files ignored by git in the work
1472 tree. With ARG, show these files if ARG is positive.
1473
1474 Use \\[stgit-toggle-worktree] to show the work tree."
1475   (interactive)
1476   (setq stgit-show-ignored
1477         (if (numberp arg)
1478             (> arg 0)
1479           (not stgit-show-ignored)))
1480   (stgit-reload))
1481
1482 (defun stgit-toggle-unknown (&optional arg)
1483   "Toggle the visibility of files not registered with git in the
1484 work tree. With ARG, show these files if ARG is positive.
1485
1486 Use \\[stgit-toggle-worktree] to show the work tree."
1487   (interactive)
1488   (setq stgit-show-unknown
1489         (if (numberp arg)
1490             (> arg 0)
1491           (not stgit-show-unknown)))
1492   (stgit-reload))
1493
1494 (provide 'stgit)