stgit.el: Refactor: use mapc to set all local variables in stgit-mode
[stgit] / contrib / stgit.el
... / ...
CommitLineData
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(when (< emacs-major-version 22)
13 (error "Emacs older than 22 is not supported by stgit.el"))
14
15(require 'git nil t)
16(require 'cl)
17(require 'comint)
18(require 'ewoc)
19(require 'easymenu)
20(require 'format-spec)
21
22(defun stgit-set-default (symbol value)
23 "Set default value of SYMBOL to VALUE using `set-default' and
24reload all StGit buffers."
25 (set-default symbol value)
26 (dolist (buf (buffer-list))
27 (with-current-buffer buf
28 (when (eq major-mode 'stgit-mode)
29 (stgit-reload)))))
30
31(defgroup stgit nil
32 "A user interface for the StGit patch maintenance tool."
33 :group 'tools
34 :link '(function-link stgit)
35 :link '(url-link "http://www.procode.org/stgit/"))
36
37(defcustom stgit-abbreviate-copies-and-renames t
38 "If non-nil, abbreviate copies and renames as \"dir/{old -> new}/file\"
39instead of \"dir/old/file -> dir/new/file\"."
40 :type 'boolean
41 :group 'stgit
42 :set 'stgit-set-default)
43
44(defcustom stgit-default-show-worktree t
45 "Set to non-nil to by default show the working tree in a new stgit buffer.
46
47Use \\<stgit-mode-map>\\[stgit-toggle-worktree] to toggle this \
48setting in an already-started StGit buffer."
49 :type 'boolean
50 :group 'stgit
51 :link '(variable-link stgit-show-worktree))
52
53(defcustom stgit-default-show-unknown nil
54 "Set to non-nil to by default show unknown files a new stgit buffer.
55
56Use \\<stgit-mode-map>\\[stgit-toggle-unknown] to toggle this \
57setting in an already-started StGit buffer."
58 :type 'boolean
59 :group 'stgit
60 :link '(variable-link stgit-show-unknown))
61
62(defcustom stgit-default-show-ignored nil
63 "Set to non-nil to by default show ignored files a new stgit buffer.
64
65Use \\<stgit-mode-map>\\[stgit-toggle-ignored] to toggle this \
66setting in an already-started StGit buffer."
67 :type 'boolean
68 :group 'stgit
69 :link '(variable-link stgit-show-ignored))
70
71(defcustom stgit-find-copies-harder nil
72 "Try harder to find copied files when listing patches.
73
74When not nil, runs git diff-tree with the --find-copies-harder
75flag, which reduces performance."
76 :type 'boolean
77 :group 'stgit
78 :set 'stgit-set-default)
79
80(defcustom stgit-show-worktree-mode 'center
81 "This variable controls where the \"Index\" and \"Work tree\"
82will be shown on in the buffer.
83
84It can be set to 'top (above all patches), 'center (show between
85applied and unapplied patches), and 'bottom (below all patches)."
86 :type '(radio (const :tag "above all patches (top)" top)
87 (const :tag "between applied and unapplied patches (center)"
88 center)
89 (const :tag "below all patches (bottom)" bottom))
90 :group 'stgit
91 :link '(variable-link stgit-show-worktree)
92 :set 'stgit-set-default)
93
94(defcustom stgit-patch-line-format "%s%m%-30n %e%d"
95 "The format string used to format patch lines.
96The format string is passed to `format-spec' and the following
97format characters are recognized:
98
99 %s - A '+', '-', '>' or space, depending on whether the patch is
100 applied, unapplied, top, or something else.
101
102 %m - An asterisk if the patch is marked, and a space otherwise.
103
104 %n - The patch name.
105
106 %e - The string \"(empty) \" if the patch is empty.
107
108 %d - The short patch description.
109
110 %D - The short patch description, or the patch name.
111
112When `stgit-show-patch-names' is non-nil, the `stgit-noname-patch-line-format'
113variable is used instead."
114 :type 'string
115 :group 'stgit
116 :set 'stgit-set-default)
117
118(defcustom stgit-noname-patch-line-format "%s%m%e%D"
119 "The alternate format string used to format patch lines.
120It has the same semantics as `stgit-patch-line-format', and the
121display can be toggled between the two formats using
122\\<stgit-mode-map>>\\[stgit-toggle-patch-names].
123
124The alternate form is used when the patch name is hidden."
125 :type 'string
126 :group 'stgit
127 :set 'stgit-set-default)
128
129(defcustom stgit-default-show-patch-names t
130 "If non-nil, default to showing patch names in a new stgit buffer.
131
132Use \\<stgit-mode-map>\\[stgit-toggle-patch-names] to toggle the
133this setting in an already-started StGit buffer."
134 :type 'boolean
135 :group 'stgit
136 :link '(variable-link stgit-show-patch-names))
137
138(defcustom stgit-file-line-format " %-11s %-2m %n %c"
139 "The format string used to format file lines.
140The format string is passed to `format-spec' and the following
141format characters are recognized:
142
143 %s - A string describing the status of the file.
144
145 %m - Mode change information
146
147 %n - The file name.
148
149 %c - A description of file changes."
150 :type 'string
151 :group 'stgit
152 :set 'stgit-set-default)
153
154(defface stgit-branch-name-face
155 '((t :inherit bold))
156 "The face used for the StGit branch name"
157 :group 'stgit)
158
159(defface stgit-top-patch-face
160 '((((background dark)) (:weight bold :foreground "yellow"))
161 (((background light)) (:weight bold :foreground "purple"))
162 (t (:weight bold)))
163 "The face used for the top patch names"
164 :group 'stgit)
165
166(defface stgit-applied-patch-face
167 '((((background dark)) (:foreground "light yellow"))
168 (((background light)) (:foreground "purple"))
169 (t ()))
170 "The face used for applied patch names"
171 :group 'stgit)
172
173(defface stgit-unapplied-patch-face
174 '((((background dark)) (:foreground "gray80"))
175 (((background light)) (:foreground "orchid"))
176 (t ()))
177 "The face used for unapplied patch names"
178 :group 'stgit)
179
180(defface stgit-description-face
181 '((((background dark)) (:foreground "tan"))
182 (((background light)) (:foreground "dark red")))
183 "The face used for StGit descriptions"
184 :group 'stgit)
185
186(defface stgit-index-work-tree-title-face
187 '((((supports :slant italic)) :slant italic)
188 (t :inherit bold))
189 "StGit mode face used for the \"Index\" and \"Work tree\" titles"
190 :group 'stgit)
191
192(defface stgit-unmerged-file-face
193 '((((class color) (background light)) (:foreground "red" :bold t))
194 (((class color) (background dark)) (:foreground "red" :bold t)))
195 "StGit mode face used for unmerged file status"
196 :group 'stgit)
197
198(defface stgit-unknown-file-face
199 '((((class color) (background light)) (:foreground "goldenrod" :bold t))
200 (((class color) (background dark)) (:foreground "goldenrod" :bold t)))
201 "StGit mode face used for unknown file status"
202 :group 'stgit)
203
204(defface stgit-ignored-file-face
205 '((((class color) (background light)) (:foreground "grey60"))
206 (((class color) (background dark)) (:foreground "grey40")))
207 "StGit mode face used for ignored files")
208
209(defface stgit-file-permission-face
210 '((((class color) (background light)) (:foreground "green" :bold t))
211 (((class color) (background dark)) (:foreground "green" :bold t)))
212 "StGit mode face used for permission changes."
213 :group 'stgit)
214
215(defface stgit-modified-file-face
216 '((((class color) (background light)) (:foreground "purple"))
217 (((class color) (background dark)) (:foreground "salmon")))
218 "StGit mode face used for modified file status"
219 :group 'stgit)
220
221(defun stgit (dir)
222 "Manage StGit patches for the tree in DIR.
223
224See `stgit-mode' for commands available."
225 (interactive "DDirectory: \n")
226 (switch-to-stgit-buffer (git-get-top-dir dir))
227 (stgit-reload))
228
229(defun stgit-assert-mode ()
230 "Signal an error if not in an StGit buffer."
231 (assert (derived-mode-p 'stgit-mode) nil "Not an StGit buffer"))
232
233(unless (fboundp 'git-get-top-dir)
234 (defun git-get-top-dir (dir)
235 "Retrieve the top-level directory of a git tree."
236 (let ((cdup (with-output-to-string
237 (with-current-buffer standard-output
238 (cd dir)
239 (unless (eq 0 (call-process "git" nil t nil
240 "rev-parse" "--show-cdup"))
241 (error "Cannot find top-level git tree for %s" dir))))))
242 (expand-file-name (concat (file-name-as-directory dir)
243 (car (split-string cdup "\n")))))))
244
245(defun stgit-refresh-git-status (&optional dir)
246 "If it exists, refresh the `git-status' buffer belonging to
247directory DIR or `default-directory'"
248 (when (and (fboundp 'git-find-status-buffer)
249 (fboundp 'git-refresh-status))
250 (let* ((top-dir (git-get-top-dir (or dir default-directory)))
251 (git-status-buffer (and top-dir (git-find-status-buffer top-dir))))
252 (when git-status-buffer
253 (with-current-buffer git-status-buffer
254 (git-refresh-status))))))
255
256(defun stgit-find-buffer (dir)
257 "Return the buffer displaying StGit patches for DIR, or nil if none."
258 (setq dir (file-name-as-directory dir))
259 (let ((buffers (buffer-list)))
260 (while (and buffers
261 (not (with-current-buffer (car buffers)
262 (and (eq major-mode 'stgit-mode)
263 (string= default-directory dir)))))
264 (setq buffers (cdr buffers)))
265 (and buffers (car buffers))))
266
267(defun switch-to-stgit-buffer (dir)
268 "Switch to a (possibly new) buffer displaying StGit patches for DIR."
269 (setq dir (file-name-as-directory dir))
270 (let ((buffer (stgit-find-buffer dir)))
271 (switch-to-buffer (or buffer
272 (create-stgit-buffer dir)))))
273
274(defstruct (stgit-patch
275 (:conc-name stgit-patch->))
276 status name desc empty files-ewoc)
277
278(defun stgit-patch-display-name (patch)
279 (let ((name (stgit-patch->name patch)))
280 (case name
281 (:index "Index")
282 (:work "Work Tree")
283 (t (symbol-name name)))))
284
285(defun stgit-insert-without-trailing-whitespace (text)
286 "Insert TEXT in buffer using `insert', without trailing whitespace.
287A newline is appended."
288 (unless (string-match "\\(.*?\\) *$" text)
289 (error))
290 (insert (match-string 1 text) ?\n))
291
292(defun stgit-patch-pp (patch)
293 (let* ((status (stgit-patch->status patch))
294 (start (point))
295 (name (stgit-patch->name patch))
296 (face (cdr (assq status stgit-patch-status-face-alist)))
297 (fmt (if stgit-show-patch-names
298 stgit-patch-line-format
299 stgit-noname-patch-line-format))
300 (spec (format-spec-make
301 ?s (case status
302 ('applied "+")
303 ('top ">")
304 ('unapplied "-")
305 (t " "))
306 ?m (if (memq name stgit-marked-patches)
307 "*" " ")
308 ?n (propertize (stgit-patch-display-name patch)
309 'face face
310 'syntax-table (string-to-syntax "w"))
311 ?e (if (stgit-patch->empty patch) "(empty) " "")
312 ?d (propertize (or (stgit-patch->desc patch) "")
313 'face 'stgit-description-face)
314 ?D (propertize (let ((desc (stgit-patch->desc patch)))
315 (if (zerop (length desc))
316 (stgit-patch-display-name patch)
317 desc))
318 'face face)))
319 (text (format-spec fmt spec)))
320
321 (stgit-insert-without-trailing-whitespace text)
322 (put-text-property start (point) 'entry-type 'patch)
323 (when (memq name stgit-expanded-patches)
324 (stgit-insert-patch-files patch))
325 (put-text-property start (point) 'patch-data patch)))
326
327(defun create-stgit-buffer (dir)
328 "Create a buffer for showing StGit patches.
329Argument DIR is the repository path."
330 (let ((buf (create-file-buffer (concat dir "*stgit*")))
331 (inhibit-read-only t))
332 (with-current-buffer buf
333 (setq default-directory dir)
334 (stgit-mode)
335 (set (make-local-variable 'stgit-ewoc)
336 (ewoc-create #'stgit-patch-pp "Branch:\n\n" "--\n" t))
337 (setq buffer-read-only t))
338 buf))
339
340(def-edebug-spec stgit-capture-output
341 (form body))
342(defmacro stgit-capture-output (name &rest body)
343 "Capture StGit output and, if there was any output, show it in a window
344at the end.
345Returns nil if there was no output."
346 (declare (debug ([&or stringp null] body))
347 (indent 1))
348 `(let ((output-buf (get-buffer-create ,(or name "*StGit output*")))
349 (stgit-dir default-directory)
350 (inhibit-read-only t))
351 (with-current-buffer output-buf
352 (buffer-disable-undo)
353 (erase-buffer)
354 (setq default-directory stgit-dir)
355 (setq buffer-read-only t))
356 (let ((standard-output output-buf))
357 ,@body)
358 (with-current-buffer output-buf
359 (set-buffer-modified-p nil)
360 (setq buffer-read-only t)
361 (if (< (point-min) (point-max))
362 (display-buffer output-buf t)))))
363
364(defun stgit-make-run-args (args)
365 "Return a copy of ARGS with its elements converted to strings."
366 (mapcar (lambda (x)
367 ;; don't use (format "%s" ...) to limit type errors
368 (cond ((stringp x) x)
369 ((integerp x) (number-to-string x))
370 ((symbolp x) (symbol-name x))
371 (t
372 (error "Bad element in stgit-make-run-args args: %S" x))))
373 args))
374
375(defun stgit-run-silent (&rest args)
376 (setq args (stgit-make-run-args args))
377 (apply 'call-process "stg" nil standard-output nil args))
378
379(defun stgit-run (&rest args)
380 (setq args (stgit-make-run-args args))
381 (let ((msgcmd (mapconcat #'identity args " ")))
382 (message "Running stg %s..." msgcmd)
383 (apply 'call-process "stg" nil standard-output nil args)
384 (message "Running stg %s...done" msgcmd)))
385
386(defun stgit-run-git (&rest args)
387 (setq args (stgit-make-run-args args))
388 (let ((msgcmd (mapconcat #'identity args " ")))
389 (message "Running git %s..." msgcmd)
390 (apply 'call-process "git" nil standard-output nil args)
391 (message "Running git %s...done" msgcmd)))
392
393(defun stgit-run-git-silent (&rest args)
394 (setq args (stgit-make-run-args args))
395 (apply 'call-process "git" nil standard-output nil args))
396
397(defun stgit-index-empty-p ()
398 "Returns non-nil if the index contains no changes from HEAD."
399 (zerop (stgit-run-git-silent "diff-index" "--cached" "--quiet" "HEAD")))
400
401(defun stgit-work-tree-empty-p ()
402 "Returns non-nil if the work tree contains no changes from index."
403 (zerop (stgit-run-git-silent "diff-files" "--quiet")))
404
405(defvar stgit-index-node)
406(defvar stgit-worktree-node)
407
408(defvar stgit-did-advise nil
409 "Set to non-nil if appropriate (non-stgit) git functions have
410been advised to update the stgit status when necessary.")
411
412(defconst stgit-allowed-branch-name-re
413 ;; Disallow control characters, space, del, and "/:@^{}~" in
414 ;; "/"-separated parts; parts may not start with a period (.)
415 "^[^\0- ./:@^{}~\177][^\0- /:@^{}~\177]*\
416\\(/[^\0- ./:@^{}~\177][^\0- /:@^{}~\177]*\\)*$"
417 "Regular expression that (new) branch names must match.")
418
419(defun stgit-refresh-index ()
420 (when stgit-index-node
421 (ewoc-invalidate (car stgit-index-node) (cdr stgit-index-node))))
422
423(defun stgit-refresh-worktree ()
424 (when stgit-worktree-node
425 (ewoc-invalidate (car stgit-worktree-node) (cdr stgit-worktree-node))))
426
427(defun stgit-run-series-insert-index (ewoc)
428 (setq index-node (cons ewoc (ewoc-enter-last ewoc
429 (make-stgit-patch
430 :status 'index
431 :name :index
432 :desc nil
433 :empty nil)))
434 worktree-node (cons ewoc (ewoc-enter-last ewoc
435 (make-stgit-patch
436 :status 'work
437 :name :work
438 :desc nil
439 :empty nil)))))
440
441(defun stgit-run-series (ewoc)
442 (setq stgit-index-node nil
443 stgit-worktree-node nil)
444 (let ((inserted-index (not stgit-show-worktree))
445 index-node
446 worktree-node
447 all-patchsyms)
448 (with-temp-buffer
449 (let* ((standard-output (current-buffer))
450 (exit-status (stgit-run-silent "series"
451 "--description" "--empty")))
452 (goto-char (point-min))
453 (if (not (zerop exit-status))
454 (cond ((looking-at "stg series: \\(.*\\)")
455 (setq inserted-index t)
456 (ewoc-set-hf ewoc (car (ewoc-get-hf ewoc))
457 (substitute-command-keys
458 "-- not initialized; run \\[stgit-init]")))
459 ((looking-at ".*")
460 (error "Error running stg: %s"
461 (match-string 0))))
462 (while (not (eobp))
463 (unless (looking-at
464 "\\([0 ]\\)\\([>+-]\\)\\( \\)\\([^ ]+\\) *[|#] \\(.*\\)")
465 (error "Syntax error in output from stg series"))
466 (let* ((state-str (match-string 2))
467 (state (cond ((string= state-str ">") 'top)
468 ((string= state-str "+") 'applied)
469 ((string= state-str "-") 'unapplied)))
470 (name (intern (match-string 4)))
471 (desc (match-string 5))
472 (empty (string= (match-string 1) "0")))
473 (unless inserted-index
474 (when (or (eq stgit-show-worktree-mode 'top)
475 (and (eq stgit-show-worktree-mode 'center)
476 (eq state 'unapplied)))
477 (setq inserted-index t)
478 (stgit-run-series-insert-index ewoc)))
479 (setq all-patchsyms (cons name all-patchsyms))
480 (ewoc-enter-last ewoc
481 (make-stgit-patch
482 :status state
483 :name name
484 :desc desc
485 :empty empty)))
486 (forward-line 1))))
487 (unless inserted-index
488 (stgit-run-series-insert-index ewoc)))
489 (setq stgit-index-node index-node
490 stgit-worktree-node worktree-node
491 stgit-marked-patches (intersection stgit-marked-patches
492 all-patchsyms))))
493
494(defun stgit-current-branch ()
495 "Return the name of the current branch."
496 (substring (with-output-to-string
497 (stgit-run-silent "branch"))
498 0 -1))
499
500(defun stgit-reload ()
501 "Update the contents of the StGit buffer."
502 (interactive)
503 (stgit-assert-mode)
504 (let ((inhibit-read-only t)
505 (curline (line-number-at-pos))
506 (curpatch (stgit-patch-name-at-point))
507 (curfile (stgit-patched-file-at-point)))
508 (ewoc-filter stgit-ewoc #'(lambda (x) nil))
509 (ewoc-set-hf stgit-ewoc
510 (concat "Branch: "
511 (propertize (stgit-current-branch)
512 'face 'stgit-branch-name-face)
513 "\n\n")
514 (if stgit-show-worktree
515 "--"
516 (propertize
517 (substitute-command-keys "--\n\"\\[stgit-toggle-worktree]\"\
518 shows the working tree\n")
519 'face 'stgit-description-face)))
520 (stgit-run-series stgit-ewoc)
521 (if curpatch
522 (stgit-goto-patch curpatch (and curfile (stgit-file->file curfile)))
523 (goto-line curline)))
524 (stgit-refresh-git-status))
525
526(defconst stgit-file-status-code-strings
527 (mapcar (lambda (arg)
528 (cons (car arg)
529 (propertize (cadr arg) 'face (car (cddr arg)))))
530 '((add "Added" stgit-modified-file-face)
531 (copy "Copied" stgit-modified-file-face)
532 (delete "Deleted" stgit-modified-file-face)
533 (modify "Modified" stgit-modified-file-face)
534 (rename "Renamed" stgit-modified-file-face)
535 (mode-change "Mode change" stgit-modified-file-face)
536 (unmerged "Unmerged" stgit-unmerged-file-face)
537 (unknown "Unknown" stgit-unknown-file-face)
538 (ignore "Ignored" stgit-ignored-file-face)))
539 "Alist of code symbols to description strings")
540
541(defconst stgit-patch-status-face-alist
542 '((applied . stgit-applied-patch-face)
543 (top . stgit-top-patch-face)
544 (unapplied . stgit-unapplied-patch-face)
545 (index . stgit-index-work-tree-title-face)
546 (work . stgit-index-work-tree-title-face))
547 "Alist of face to use for a given patch status")
548
549(defun stgit-file-status-code-as-string (file)
550 "Return stgit status code for FILE as a string"
551 (let* ((code (assq (stgit-file->status file)
552 stgit-file-status-code-strings))
553 (score (stgit-file->cr-score file)))
554 (when code
555 (if (and score (/= score 100))
556 (format "%s %s" (cdr code)
557 (propertize (format "%d%%" score)
558 'face 'stgit-description-face))
559 (cdr code)))))
560
561(defun stgit-file-status-code (str &optional score)
562 "Return stgit status code from git status string"
563 (let ((code (assoc str '(("A" . add)
564 ("C" . copy)
565 ("D" . delete)
566 ("I" . ignore)
567 ("M" . modify)
568 ("R" . rename)
569 ("T" . mode-change)
570 ("U" . unmerged)
571 ("X" . unknown)))))
572 (setq code (if code (cdr code) 'unknown))
573 (when (stringp score)
574 (if (> (length score) 0)
575 (setq score (string-to-number score))
576 (setq score nil)))
577 (if score (cons code score) code)))
578
579(defconst stgit-file-type-strings
580 '((#o100 . "file")
581 (#o120 . "symlink")
582 (#o160 . "subproject"))
583 "Alist of names of file types")
584
585(defun stgit-file-type-string (type)
586 "Return string describing file type TYPE (the high bits of file permission).
587Cf. `stgit-file-type-strings' and `stgit-file-type-change-string'."
588 (let ((type-str (assoc type stgit-file-type-strings)))
589 (or (and type-str (cdr type-str))
590 (format "unknown type %o" type))))
591
592(defun stgit-file-type-change-string (old-perm new-perm)
593 "Return string describing file type change from OLD-PERM to NEW-PERM.
594Cf. `stgit-file-type-string'."
595 (let ((old-type (lsh old-perm -9))
596 (new-type (lsh new-perm -9)))
597 (cond ((= old-type new-type) "")
598 ((zerop new-type) "")
599 ((zerop old-type)
600 (if (= new-type #o100)
601 ""
602 (format "(%s)" (stgit-file-type-string new-type))))
603 (t (format "(%s -> %s)"
604 (stgit-file-type-string old-type)
605 (stgit-file-type-string new-type))))))
606
607(defun stgit-file-mode-change-string (old-perm new-perm)
608 "Return string describing file mode change from OLD-PERM to NEW-PERM.
609Cf. `stgit-file-type-change-string'."
610 (setq old-perm (logand old-perm #o777)
611 new-perm (logand new-perm #o777))
612 (if (or (= old-perm new-perm)
613 (zerop old-perm)
614 (zerop new-perm))
615 ""
616 (let* ((modified (logxor old-perm new-perm))
617 (not-x-modified (logand (logxor old-perm new-perm) #o666)))
618 (cond ((zerop modified) "")
619 ((and (zerop not-x-modified)
620 (or (and (eq #o111 (logand old-perm #o111))
621 (propertize "-x" 'face 'stgit-file-permission-face))
622 (and (eq #o111 (logand new-perm #o111))
623 (propertize "+x" 'face
624 'stgit-file-permission-face)))))
625 (t (concat (propertize (format "%o" old-perm)
626 'face 'stgit-file-permission-face)
627 (propertize " -> "
628 'face 'stgit-description-face)
629 (propertize (format "%o" new-perm)
630 'face 'stgit-file-permission-face)))))))
631
632(defstruct (stgit-file
633 (:conc-name stgit-file->))
634 old-perm new-perm copy-or-rename cr-score cr-from cr-to status file)
635
636(defun stgit-describe-copy-or-rename (file)
637 (let ((arrow (concat " " (propertize "->" 'face 'stgit-description-face) " "))
638 from to common-head common-tail)
639
640 (when stgit-abbreviate-copies-and-renames
641 (setq from (split-string (stgit-file->cr-from file) "/")
642 to (split-string (stgit-file->cr-to file) "/"))
643
644 (while (and from to (cdr from) (cdr to)
645 (string-equal (car from) (car to)))
646 (setq common-head (cons (car from) common-head)
647 from (cdr from)
648 to (cdr to)))
649 (setq common-head (nreverse common-head)
650 from (nreverse from)
651 to (nreverse to))
652 (while (and from to (cdr from) (cdr to)
653 (string-equal (car from) (car to)))
654 (setq common-tail (cons (car from) common-tail)
655 from (cdr from)
656 to (cdr to)))
657 (setq from (nreverse from)
658 to (nreverse to)))
659
660 (if (or common-head common-tail)
661 (concat (if common-head
662 (mapconcat #'identity common-head "/")
663 "")
664 (if common-head "/" "")
665 (propertize "{" 'face 'stgit-description-face)
666 (mapconcat #'identity from "/")
667 arrow
668 (mapconcat #'identity to "/")
669 (propertize "}" 'face 'stgit-description-face)
670 (if common-tail "/" "")
671 (if common-tail
672 (mapconcat #'identity common-tail "/")
673 ""))
674 (concat (stgit-file->cr-from file) arrow (stgit-file->cr-to file)))))
675
676(defun stgit-file-pp (file)
677 (let ((start (point))
678 (spec (format-spec-make
679 ?s (stgit-file-status-code-as-string file)
680 ?m (stgit-file-mode-change-string
681 (stgit-file->old-perm file)
682 (stgit-file->new-perm file))
683 ?n (if (stgit-file->copy-or-rename file)
684 (stgit-describe-copy-or-rename file)
685 (stgit-file->file file))
686 ?c (propertize (stgit-file-type-change-string
687 (stgit-file->old-perm file)
688 (stgit-file->new-perm file))
689 'face 'stgit-description-face))))
690 (stgit-insert-without-trailing-whitespace
691 (format-spec stgit-file-line-format spec))
692 (add-text-properties start (point)
693 (list 'entry-type 'file
694 'file-data file))))
695
696(defun stgit-find-copies-harder-diff-arg ()
697 "Return the flag to use with `git-diff' depending on the
698`stgit-find-copies-harder' flag."
699 (if stgit-find-copies-harder "--find-copies-harder" "-C"))
700
701(defun stgit-insert-ls-files (args file-flag)
702 (let ((start (point)))
703 (apply 'stgit-run-git
704 (append '("ls-files" "--exclude-standard" "-z") args))
705 (goto-char start)
706 (while (looking-at "\\([^\0]*\\)\0")
707 (let ((name-len (- (match-end 0) (match-beginning 0))))
708 (insert ":0 0 0000000000000000000000000000000000000000 0000000000000000000000000000000000000000 " file-flag "\0")
709 (forward-char name-len)))))
710
711(defun stgit-process-files (callback)
712 (goto-char (point-min))
713 (when (looking-at "[0-9A-Fa-f]\\{40\\}\0")
714 (goto-char (match-end 0)))
715 (while (looking-at ":\\([0-7]+\\) \\([0-7]+\\) [0-9A-Fa-f]\\{40\\} [0-9A-Fa-f]\\{40\\} ")
716 (let ((old-perm (string-to-number (match-string 1) 8))
717 (new-perm (string-to-number (match-string 2) 8)))
718 (goto-char (match-end 0))
719 (let ((file
720 (cond ((looking-at
721 "\\([CR]\\)\\([0-9]*\\)\0\\([^\0]*\\)\0\\([^\0]*\\)\0")
722 (let* ((patch-status (stgit-patch->status patch))
723 (file-subexp (if (eq patch-status 'unapplied)
724 3
725 4))
726 (file (match-string file-subexp)))
727 (make-stgit-file
728 :old-perm old-perm
729 :new-perm new-perm
730 :copy-or-rename t
731 :cr-score (string-to-number (match-string 2))
732 :cr-from (match-string 3)
733 :cr-to (match-string 4)
734 :status (stgit-file-status-code
735 (match-string 1))
736 :file file)))
737 ((looking-at "\\([ABD-QS-Z]\\)\0\\([^\0]*\\)\0")
738 (make-stgit-file
739 :old-perm old-perm
740 :new-perm new-perm
741 :copy-or-rename nil
742 :cr-score nil
743 :cr-from nil
744 :cr-to nil
745 :status (stgit-file-status-code
746 (match-string 1))
747 :file (match-string 2))))))
748 (goto-char (match-end 0))
749 (funcall callback file)))))
750
751
752(defun stgit-insert-patch-files (patch)
753 "Expand (show modification of) the patch PATCH after the line
754at point."
755 (let* ((patchsym (stgit-patch->name patch))
756 (end (point-marker))
757 (args (list "-z" (stgit-find-copies-harder-diff-arg)))
758 (ewoc (ewoc-create #'stgit-file-pp nil nil t))
759 (show-ignored stgit-show-ignored)
760 (show-unknown stgit-show-unknown))
761 (set-marker-insertion-type end t)
762 (setf (stgit-patch->files-ewoc patch) ewoc)
763 (with-temp-buffer
764 (let ((standard-output (current-buffer)))
765 (apply 'stgit-run-git
766 (cond ((eq patchsym :work)
767 (let (standard-output)
768 (stgit-run-git "update-index" "--refresh"))
769 `("diff-files" "-0" ,@args))
770 ((eq patchsym :index)
771 `("diff-index" ,@args "--cached" "HEAD"))
772 (t
773 `("diff-tree" ,@args "-r" ,(stgit-id patchsym)))))
774
775 (when (and (eq patchsym :work))
776 (when show-ignored
777 (stgit-insert-ls-files '("--ignored" "--others") "I"))
778 (when show-unknown
779 (stgit-insert-ls-files '("--directory" "--no-empty-directory"
780 "--others")
781 "X"))
782 (sort-regexp-fields nil ":[^\0]*\0\\([^\0]*\\)\0" "\\1"
783 (point-min) (point-max)))
784
785 (stgit-process-files (lambda (file) (ewoc-enter-last ewoc file)))
786
787 (unless (ewoc-nth ewoc 0)
788 (ewoc-set-hf ewoc ""
789 (concat " "
790 (propertize "<no files>"
791 'face 'stgit-description-face)
792 "\n")))))
793 (goto-char end)))
794
795(defun stgit-find-file (&optional other-window)
796 (let* ((file (or (stgit-patched-file-at-point)
797 (error "No file at point")))
798 (filename (expand-file-name (stgit-file->file file))))
799 (unless (file-exists-p filename)
800 (error "File does not exist"))
801 (funcall (if other-window 'find-file-other-window 'find-file)
802 filename)
803 (when (eq (stgit-file->status file) 'unmerged)
804 (smerge-mode 1))))
805
806(defun stgit-expand (&optional patches collapse)
807 "Show the contents of marked patches, or the patch at point.
808
809See also `stgit-collapse'.
810
811Non-interactively, operate on PATCHES, and collapse instead of
812expand if COLLAPSE is not nil."
813 (interactive (list (stgit-patches-marked-or-at-point t)))
814 (stgit-assert-mode)
815 (let ((patches-diff (funcall (if collapse #'intersection #'set-difference)
816 patches stgit-expanded-patches)))
817 (setq stgit-expanded-patches
818 (if collapse
819 (set-difference stgit-expanded-patches patches-diff)
820 (append stgit-expanded-patches patches-diff)))
821 (ewoc-map #'(lambda (patch)
822 (memq (stgit-patch->name patch) patches-diff))
823 stgit-ewoc))
824 (move-to-column (stgit-goal-column)))
825
826(defun stgit-collapse (&optional patches)
827 "Hide the contents of marked patches, or the patch at point.
828
829See also `stgit-expand'."
830 (interactive (list (stgit-patches-marked-or-at-point t)))
831 (stgit-assert-mode)
832 (stgit-expand patches t))
833
834(defun stgit-select-patch ()
835 (let ((patchname (stgit-patch-name-at-point)))
836 (stgit-expand (list patchname)
837 (memq patchname stgit-expanded-patches))))
838
839(defun stgit-expand-directory (file)
840 (let* ((patch (stgit-patch-at-point))
841 (ewoc (stgit-patch->files-ewoc patch))
842 (node (ewoc-locate ewoc))
843 (filename (stgit-file->file file))
844 (start (make-marker))
845 (end (make-marker)))
846
847 (save-excursion
848 (forward-line 1)
849 (set-marker start (point))
850 (set-marker end (point))
851 (set-marker-insertion-type end t))
852
853 (assert (string-match "/$" filename))
854 ;; remove trailing "/"
855 (setf (stgit-file->file file) (substring filename 0 -1))
856 (ewoc-invalidate ewoc node)
857
858 (with-temp-buffer
859 (let ((standard-output (current-buffer)))
860 (stgit-insert-ls-files (list "--directory" "--others"
861 "--no-empty-directory" "--"
862 filename)
863 "X")
864 (stgit-process-files (lambda (f)
865 (setq node (ewoc-enter-after ewoc node f))))))
866
867 (move-to-column (stgit-goal-column))
868
869 (let ((inhibit-read-only t))
870 (put-text-property start end 'patch-data patch))))
871
872(defun stgit-select-file ()
873 (let* ((file (or (stgit-patched-file-at-point)
874 (error "No file at point")))
875 (filename (stgit-file->file file)))
876 (if (string-match "/$" filename)
877 (stgit-expand-directory file)
878 (stgit-find-file))))
879
880(defun stgit-select ()
881 "With point on a patch, toggle showing files in the patch.
882
883With point on a file, open the associated file. Opens the target
884file for (applied) copies and renames."
885 (interactive)
886 (stgit-assert-mode)
887 (case (get-text-property (point) 'entry-type)
888 ('patch
889 (stgit-select-patch))
890 ('file
891 (stgit-select-file))
892 (t
893 (error "No patch or file on line"))))
894
895(defun stgit-find-file-other-window ()
896 "Open file at point in other window"
897 (interactive)
898 (stgit-assert-mode)
899 (stgit-find-file t))
900
901(defun stgit-find-file-merge ()
902 "Open file at point and merge it using `smerge-ediff'."
903 (interactive)
904 (stgit-assert-mode)
905 (stgit-find-file t)
906 (smerge-ediff))
907
908(defun stgit-quit ()
909 "Hide the stgit buffer."
910 (interactive)
911 (stgit-assert-mode)
912 (bury-buffer))
913
914(defun stgit-git-status ()
915 "Show status using `git-status'."
916 (interactive)
917 (stgit-assert-mode)
918 (unless (fboundp 'git-status)
919 (error "The stgit-git-status command requires git-status"))
920 (let ((dir default-directory))
921 (save-selected-window
922 (pop-to-buffer nil)
923 (git-status dir))))
924
925(defun stgit-goal-column ()
926 "Return goal column for the current line"
927 (case (get-text-property (point) 'entry-type)
928 ('patch 2)
929 ('file 4)
930 (t 0)))
931
932(defun stgit-next-line (&optional arg)
933 "Move cursor vertically down ARG lines"
934 (interactive "p")
935 (stgit-assert-mode)
936 (next-line arg)
937 (move-to-column (stgit-goal-column)))
938
939(defun stgit-previous-line (&optional arg)
940 "Move cursor vertically up ARG lines"
941 (interactive "p")
942 (stgit-assert-mode)
943 (previous-line arg)
944 (move-to-column (stgit-goal-column)))
945
946(defun stgit-next-patch (&optional arg)
947 "Move cursor down ARG patches."
948 (interactive "p")
949 (stgit-assert-mode)
950 (ewoc-goto-next stgit-ewoc (or arg 1))
951 (move-to-column goal-column))
952
953(defun stgit-previous-patch (&optional arg)
954 "Move cursor up ARG patches."
955 (interactive "p")
956 (stgit-assert-mode)
957 (ewoc-goto-prev stgit-ewoc (or arg 1))
958 (move-to-column goal-column))
959
960(defvar stgit-mode-hook nil
961 "Run after `stgit-mode' is setup.")
962
963(defvar stgit-mode-map nil
964 "Keymap for StGit major mode.")
965
966(unless stgit-mode-map
967 (let ((diff-map (make-sparse-keymap))
968 (toggle-map (make-sparse-keymap)))
969 (mapc (lambda (arg) (define-key diff-map (car arg) (cdr arg)))
970 '(("b" . stgit-diff-base)
971 ("c" . stgit-diff-combined)
972 ("m" . stgit-find-file-merge)
973 ("o" . stgit-diff-ours)
974 ("r" . stgit-diff-range)
975 ("t" . stgit-diff-theirs)))
976 (mapc (lambda (arg) (define-key toggle-map (car arg) (cdr arg)))
977 '(("n" . stgit-toggle-patch-names)
978 ("t" . stgit-toggle-worktree)
979 ("i" . stgit-toggle-ignored)
980 ("u" . stgit-toggle-unknown)))
981 (setq stgit-mode-map (make-keymap))
982 (suppress-keymap stgit-mode-map)
983 (mapc (lambda (arg) (define-key stgit-mode-map (car arg) (cdr arg)))
984 `((" " . stgit-mark-down)
985 ("m" . stgit-mark-down)
986 ("\d" . stgit-unmark-up)
987 ("u" . stgit-unmark-down)
988 ("?" . stgit-help)
989 ("h" . stgit-help)
990 ("\C-p" . stgit-previous-line)
991 ("\C-n" . stgit-next-line)
992 ([up] . stgit-previous-line)
993 ([down] . stgit-next-line)
994 ("p" . stgit-previous-patch)
995 ("n" . stgit-next-patch)
996 ("\M-{" . stgit-previous-patch)
997 ("\M-}" . stgit-next-patch)
998 ("s" . stgit-git-status)
999 ("g" . stgit-reload-or-repair)
1000 ("r" . stgit-refresh)
1001 ("\C-c\C-r" . stgit-rename)
1002 ("e" . stgit-edit)
1003 ("M" . stgit-move-patches)
1004 ("S" . stgit-squash)
1005 ("N" . stgit-new)
1006 ("c" . stgit-new-and-refresh)
1007 ("\C-c\C-c" . stgit-commit)
1008 ("\C-c\C-u" . stgit-uncommit)
1009 ("U" . stgit-revert)
1010 ("R" . stgit-resolve-file)
1011 ("\r" . stgit-select)
1012 ("+" . stgit-expand)
1013 ("-" . stgit-collapse)
1014 ("o" . stgit-find-file-other-window)
1015 ("i" . stgit-toggle-index)
1016 (">" . stgit-push-next)
1017 ("<" . stgit-pop-next)
1018 ("P" . stgit-push-or-pop)
1019 ("G" . stgit-goto)
1020 ("=" . stgit-diff)
1021 ("D" . stgit-delete)
1022 ([?\C-/] . stgit-undo)
1023 ("\C-_" . stgit-undo)
1024 ([?\C-c ?\C-/] . stgit-redo)
1025 ("\C-c\C-_" . stgit-redo)
1026 ("B" . stgit-branch)
1027 ("\C-c\C-b" . stgit-rebase)
1028 ("t" . ,toggle-map)
1029 ("d" . ,diff-map)
1030 ("q" . stgit-quit)
1031 ("!" . stgit-execute))))
1032
1033 (let ((at-unmerged-file '(let ((file (stgit-patched-file-at-point)))
1034 (and file (eq (stgit-file->status file)
1035 'unmerged))))
1036 (patch-collapsed-p '(lambda (p) (not (memq p stgit-expanded-patches)))))
1037 (easy-menu-define stgit-menu stgit-mode-map
1038 "StGit Menu"
1039 `("StGit"
1040 ["Reload" stgit-reload-or-repair
1041 :help "Reload StGit status from disk"]
1042 ["Repair" stgit-repair
1043 :keys "\\[universal-argument] \\[stgit-reload-or-repair]"
1044 :help "Repair StGit metadata"]
1045 "-"
1046 ["Undo" stgit-undo t]
1047 ["Redo" stgit-redo t]
1048 "-"
1049 ["Git status" stgit-git-status :active (fboundp 'git-status)]
1050 "-"
1051 ["New patch" stgit-new-and-refresh
1052 :help "Create a new patch from changes in index or work tree"
1053 :active (not (and (stgit-index-empty-p) (stgit-work-tree-empty-p)))]
1054 ["New empty patch" stgit-new
1055 :help "Create a new, empty patch"]
1056 ["(Un)mark patch" stgit-toggle-mark
1057 :label (if (memq (stgit-patch-name-at-point nil t)
1058 stgit-marked-patches)
1059 "Unmark patch" "Mark patch")
1060 :active (stgit-patch-name-at-point nil t)]
1061 ["Expand/collapse patch"
1062 (let ((patches (stgit-patches-marked-or-at-point)))
1063 (if (member-if ,patch-collapsed-p patches)
1064 (stgit-expand patches)
1065 (stgit-collapse patches)))
1066 :label (if (member-if ,patch-collapsed-p
1067 (stgit-patches-marked-or-at-point))
1068 "Expand patches"
1069 "Collapse patches")
1070 :active (stgit-patches-marked-or-at-point)]
1071 ["Edit patch" stgit-edit
1072 :help "Edit patch comment"
1073 :active (stgit-patch-name-at-point nil t)]
1074 ["Rename patch" stgit-rename :active (stgit-patch-name-at-point nil t)]
1075 ["Push/pop patch" stgit-push-or-pop
1076 :label (if (subsetp (stgit-patches-marked-or-at-point nil t)
1077 (stgit-applied-patchsyms t))
1078 "Pop patches" "Push patches")]
1079 ["Delete patches" stgit-delete
1080 :active (stgit-patches-marked-or-at-point nil t)]
1081 "-"
1082 ["Move patches" stgit-move-patches
1083 :active stgit-marked-patches
1084 :help "Move marked patch(es) to point"]
1085 ["Squash patches" stgit-squash
1086 :active (> (length stgit-marked-patches) 1)
1087 :help "Merge marked patches into one"]
1088 "-"
1089 ["Refresh top patch" stgit-refresh
1090 :active (not (and (stgit-index-empty-p) (stgit-work-tree-empty-p)))
1091 :help "Refresh the top patch with changes in index or work tree"]
1092 ["Refresh this patch" (stgit-refresh t)
1093 :keys "\\[universal-argument] \\[stgit-refresh]"
1094 :help "Refresh marked patch with changes in index or work tree"
1095 :active (and (not (and (stgit-index-empty-p)
1096 (stgit-work-tree-empty-p)))
1097 (stgit-patch-name-at-point nil t))]
1098 "-"
1099 ["Find file" stgit-select
1100 :active (eq (get-text-property (point) 'entry-type) 'file)]
1101 ["Open file" stgit-find-file-other-window
1102 :active (eq (get-text-property (point) 'entry-type) 'file)]
1103 ["Toggle file index" stgit-toggle-index
1104 :active (and (eq (get-text-property (point) 'entry-type) 'file)
1105 (memq (stgit-patch-name-at-point) '(:work :index)))
1106 :label (if (eq (stgit-patch-name-at-point) :work)
1107 "Move change to index"
1108 "Move change to work tree")]
1109 "-"
1110 ["Show diff" stgit-diff
1111 :active (get-text-property (point) 'entry-type)]
1112 ["Show diff for range of applied patches" stgit-diff-range
1113 :active (= (length stgit-marked-patches) 1)]
1114 ("Merge"
1115 :active (stgit-git-index-unmerged-p)
1116 ["Combined diff" stgit-diff-combined
1117 :active (memq (stgit-patch-name-at-point nil nil) '(:work :index))]
1118 ["Diff against base" stgit-diff-base
1119 :help "Show diff against the common base"
1120 :active (memq (stgit-patch-name-at-point nil nil) '(:work :index))]
1121 ["Diff against ours" stgit-diff-ours
1122 :help "Show diff against our branch"
1123 :active (memq (stgit-patch-name-at-point nil nil) '(:work :index))]
1124 ["Diff against theirs" stgit-diff-theirs
1125 :help "Show diff against their branch"
1126 :active (memq (stgit-patch-name-at-point nil nil) '(:work :index))]
1127 "-"
1128 ["Interactive merge" stgit-find-file-merge
1129 :help "Interactively merge the file"
1130 :active ,at-unmerged-file]
1131 ["Resolve file" stgit-resolve-file
1132 :help "Mark file conflict as resolved"
1133 :active ,at-unmerged-file]
1134 )
1135 "-"
1136 ["Show index & work tree" stgit-toggle-worktree :style toggle
1137 :selected stgit-show-worktree]
1138 ["Show unknown files" stgit-toggle-unknown :style toggle
1139 :selected stgit-show-unknown :active stgit-show-worktree]
1140 ["Show ignored files" stgit-toggle-ignored :style toggle
1141 :selected stgit-show-ignored :active stgit-show-worktree]
1142 ["Show patch names" stgit-toggle-patch-names :style toggle
1143 :selected stgit-show-patch-names]
1144 "-"
1145 ["Switch branches" stgit-branch t
1146 :help "Switch to or create another branch"]
1147 ["Rebase branch" stgit-rebase t
1148 :help "Rebase the current branch"]
1149 ))))
1150
1151;; disable tool bar editing buttons
1152(put 'stgit-mode 'mode-class 'special)
1153
1154(defun stgit-mode ()
1155 "Major mode for interacting with StGit.
1156
1157Start StGit using \\[stgit].
1158
1159Basic commands:
1160\\<stgit-mode-map>\
1161\\[stgit-help] Show this help text
1162\\[stgit-quit] Hide the StGit buffer
1163\\[describe-bindings] Show all key bindings
1164
1165\\[stgit-reload-or-repair] Reload the StGit buffer
1166\\[universal-argument] \\[stgit-reload-or-repair] Repair StGit metadata
1167
1168\\[stgit-undo] Undo most recent StGit operation
1169\\[stgit-redo] Undo recent undo
1170
1171\\[stgit-git-status] Run `git-status' (if available)
1172
1173\\[stgit-execute] Run an stg shell command
1174
1175Movement commands:
1176\\[stgit-previous-line] Move to previous line
1177\\[stgit-next-line] Move to next line
1178\\[stgit-previous-patch] Move to previous patch
1179\\[stgit-next-patch] Move to next patch
1180
1181\\[stgit-mark-down] Mark patch and move down
1182\\[stgit-unmark-up] Unmark patch and move up
1183\\[stgit-unmark-down] Unmark patch and move down
1184
1185Commands for patches:
1186\\[stgit-select] Toggle showing changed files in patch
1187\\[stgit-refresh] Refresh patch with changes in index or work tree
1188\\[stgit-diff] Show the patch log and diff
1189
1190\\[stgit-expand] Show changes in marked patches
1191\\[stgit-collapse] Hide changes in marked patches
1192
1193\\[stgit-new-and-refresh] Create a new patch from index or work tree
1194\\[stgit-new] Create a new, empty patch
1195
1196\\[stgit-rename] Rename patch
1197\\[stgit-edit] Edit patch description
1198\\[stgit-delete] Delete patch(es)
1199
1200\\[stgit-revert] Revert all changes in index or work tree
1201\\[stgit-toggle-index] Toggle all changes between index and work tree
1202
1203\\[stgit-push-next] Push next patch onto stack
1204\\[stgit-pop-next] Pop current patch from stack
1205\\[stgit-push-or-pop] Push or pop marked patches
1206\\[stgit-goto] Make patch at point current by popping or pushing
1207
1208\\[stgit-squash] Squash (meld together) patches
1209\\[stgit-move-patches] Move marked patches to point
1210
1211\\[stgit-commit] Commit patch(es)
1212\\[stgit-uncommit] Uncommit patch(es)
1213
1214Commands for files:
1215\\[stgit-select] Open the file in this window
1216\\[stgit-find-file-other-window] Open the file in another window
1217\\[stgit-diff] Show the file's diff
1218
1219\\[stgit-toggle-index] Toggle change between index and work tree
1220\\[stgit-revert] Revert changes to file
1221
1222Display commands:
1223\\[stgit-toggle-patch-names] Toggle showing patch names
1224\\[stgit-toggle-worktree] Toggle showing index and work tree
1225\\[stgit-toggle-unknown] Toggle showing unknown files
1226\\[stgit-toggle-ignored] Toggle showing ignored files
1227
1228Commands for diffs:
1229\\[stgit-diff] Show diff of patch or file
1230\\[stgit-diff-range] Show diff for range of patches
1231\\[stgit-diff-base] Show diff against the merge base
1232\\[stgit-diff-ours] Show diff against our branch
1233\\[stgit-diff-theirs] Show diff against their branch
1234
1235 With one prefix argument (e.g., \\[universal-argument] \\[stgit-diff]), \
1236ignore space changes.
1237 With two prefix arguments (e.g., \\[universal-argument] \
1238\\[universal-argument] \\[stgit-diff]), ignore all space changes.
1239
1240Commands for merge conflicts:
1241\\[stgit-find-file-merge] Resolve conflicts using `smerge-ediff'
1242\\[stgit-resolve-file] Mark unmerged file as resolved
1243
1244Commands for branches:
1245\\[stgit-branch] Switch to or create another branch
1246\\[stgit-rebase] Rebase the current branch
1247
1248Customization variables:
1249`stgit-abbreviate-copies-and-renames'
1250`stgit-default-show-ignored'
1251`stgit-default-show-patch-names'
1252`stgit-default-show-unknown'
1253`stgit-default-show-worktree'
1254`stgit-find-copies-harder'
1255`stgit-show-worktree-mode'
1256
1257See also \\[customize-group] for the \"stgit\" group."
1258 (kill-all-local-variables)
1259 (buffer-disable-undo)
1260 (setq mode-name "StGit"
1261 major-mode 'stgit-mode
1262 goal-column 2)
1263 (use-local-map stgit-mode-map)
1264 (mapc (lambda (x) (set (make-local-variable (car x)) (cdr x)))
1265 `((list-buffers-directory . ,default-directory)
1266 (parse-sexp-lookup-properties . t)
1267 (stgit-expanded-patches . (:work :index))
1268 (stgit-index-node . nil)
1269 (stgit-worktree-node . nil)
1270 (stgit-marked-patches . nil)
1271 (stgit-show-ignored . ,stgit-default-show-ignored)
1272 (stgit-show-patch-names . ,stgit-default-show-patch-names)
1273 (stgit-show-unknown . ,stgit-default-show-unknown)
1274 (stgit-show-worktree . ,stgit-default-show-worktree)))
1275 (set-variable 'truncate-lines 't)
1276 (add-hook 'after-save-hook 'stgit-update-stgit-for-buffer)
1277 (unless stgit-did-advise
1278 (stgit-advise)
1279 (setq stgit-did-advise t))
1280 (run-hooks 'stgit-mode-hook))
1281
1282(defun stgit-advise-funlist (funlist)
1283 "Add advice to the functions in FUNLIST so we can refresh the
1284stgit buffers as the git status of files change."
1285 (mapc (lambda (sym)
1286 (when (fboundp sym)
1287 (eval `(defadvice ,sym (after stgit-update-stgit-for-buffer)
1288 (stgit-update-stgit-for-buffer t)))
1289 (ad-activate sym)))
1290 funlist))
1291
1292(defun stgit-advise ()
1293 "Add advice to appropriate (non-stgit) git functions so we can
1294refresh the stgit buffers as the git status of files change."
1295 (mapc (lambda (arg)
1296 (let ((feature (car arg))
1297 (funlist (cdr arg)))
1298 (if (featurep feature)
1299 (stgit-advise-funlist funlist)
1300 (add-to-list 'after-load-alist
1301 `(,feature (stgit-advise-funlist
1302 (quote ,funlist)))))))
1303 '((vc-git vc-git-rename-file vc-git-revert vc-git-register)
1304 (git git-add-file git-checkout git-revert-file git-remove-file))))
1305
1306(defun stgit-update-stgit-for-buffer (&optional refresh-index)
1307 "Refresh worktree status in any `stgit-mode' buffer that shows
1308the status of the current buffer.
1309
1310If REFRESH-INDEX is not-nil, also update the index."
1311 (let* ((dir (cond ((eq major-mode 'git-status-mode)
1312 default-directory)
1313 (buffer-file-name
1314 (file-name-directory
1315 (expand-file-name buffer-file-name)))))
1316 (gitdir (and dir (condition-case nil (git-get-top-dir dir)
1317 (error nil))))
1318 (buffer (and gitdir (stgit-find-buffer gitdir))))
1319 (when buffer
1320 (with-current-buffer buffer
1321 (stgit-refresh-worktree)
1322 (when refresh-index (stgit-refresh-index))))))
1323
1324(defun stgit-add-mark (patchsym)
1325 "Mark the patch PATCHSYM."
1326 (setq stgit-marked-patches (cons patchsym stgit-marked-patches)))
1327
1328(defun stgit-remove-mark (patchsym)
1329 "Unmark the patch PATCHSYM."
1330 (setq stgit-marked-patches (delq patchsym stgit-marked-patches)))
1331
1332(defun stgit-clear-marks ()
1333 "Unmark all patches."
1334 (setq stgit-marked-patches '()))
1335
1336(defun stgit-patch-at-point (&optional cause-error)
1337 (get-text-property (point) 'patch-data))
1338
1339(defun stgit-patch-name-at-point (&optional cause-error only-patches)
1340 "Return the patch name on the current line as a symbol.
1341If CAUSE-ERROR is not nil, signal an error if none found.
1342If ONLY-PATCHES is not nil, only allow real patches, and not
1343index or work tree."
1344 (let ((patch (stgit-patch-at-point)))
1345 (and patch
1346 only-patches
1347 (memq (stgit-patch->status patch) '(work index))
1348 (setq patch nil))
1349 (cond (patch
1350 (stgit-patch->name patch))
1351 (cause-error
1352 (error "No patch on this line")))))
1353
1354(defun stgit-patched-file-at-point ()
1355 (get-text-property (point) 'file-data))
1356
1357(defun stgit-patches-marked-or-at-point (&optional cause-error only-patches)
1358 "Return the symbols of the marked patches, or the patch on the current line.
1359If CAUSE-ERRROR is not nil, signal an error if none found.
1360If ONLY-PATCHES is not nil, do not include index or work tree."
1361 (if stgit-marked-patches
1362 stgit-marked-patches
1363 (let ((patch (stgit-patch-name-at-point nil only-patches)))
1364 (cond (patch (list patch))
1365 (cause-error (error "No patches marked or at this line"))
1366 (t nil)))))
1367
1368(defun stgit-goto-patch (patchsym &optional file)
1369 "Move point to the line containing patch PATCHSYM.
1370If that patch cannot be found, do nothing.
1371
1372If the patch was found and FILE is not nil, instead move to that
1373file's line. If FILE cannot be found, stay on the line of
1374PATCHSYM."
1375 (let ((node (ewoc-nth stgit-ewoc 0)))
1376 (while (and node (not (eq (stgit-patch->name (ewoc-data node))
1377 patchsym)))
1378 (setq node (ewoc-next stgit-ewoc node)))
1379 (when (and node file)
1380 (let* ((file-ewoc (stgit-patch->files-ewoc (ewoc-data node)))
1381 (file-node (ewoc-nth file-ewoc 0)))
1382 (while (and file-node
1383 (not (equal (stgit-file->file (ewoc-data file-node))
1384 file)))
1385 (setq file-node (ewoc-next file-ewoc file-node)))
1386 (when file-node
1387 (ewoc-goto-node file-ewoc file-node)
1388 (move-to-column (stgit-goal-column))
1389 (setq node nil))))
1390 (when node
1391 (ewoc-goto-node stgit-ewoc node)
1392 (move-to-column goal-column))))
1393
1394(defun stgit-init ()
1395 "Run stg init."
1396 (interactive)
1397 (stgit-assert-mode)
1398 (stgit-capture-output nil
1399 (stgit-run "init"))
1400 (stgit-reload))
1401
1402(defun stgit-toggle-mark ()
1403 "Toggle mark on the patch under point."
1404 (interactive)
1405 (stgit-assert-mode)
1406 (if (memq (stgit-patch-name-at-point t t) stgit-marked-patches)
1407 (stgit-unmark)
1408 (stgit-mark)))
1409
1410(defun stgit-mark ()
1411 "Mark the patch under point."
1412 (interactive)
1413 (stgit-assert-mode)
1414 (let* ((node (ewoc-locate stgit-ewoc))
1415 (patch (ewoc-data node))
1416 (name (stgit-patch->name patch)))
1417 (when (eq name :work)
1418 (error "Cannot mark the work tree"))
1419 (when (eq name :index)
1420 (error "Cannot mark the index"))
1421 (stgit-add-mark (stgit-patch->name patch))
1422 (let ((column (current-column)))
1423 (ewoc-invalidate stgit-ewoc node)
1424 (move-to-column column))))
1425
1426(defun stgit-mark-down ()
1427 "Mark the patch under point and move to the next patch."
1428 (interactive)
1429 (stgit-mark)
1430 (stgit-next-patch))
1431
1432(defun stgit-unmark ()
1433 "Remove mark from the patch on the current line."
1434 (interactive)
1435 (stgit-assert-mode)
1436 (let* ((node (ewoc-locate stgit-ewoc))
1437 (patch (ewoc-data node)))
1438 (stgit-remove-mark (stgit-patch->name patch))
1439 (let ((column (current-column)))
1440 (ewoc-invalidate stgit-ewoc node)
1441 (move-to-column column))))
1442
1443(defun stgit-unmark-up ()
1444 "Remove mark from the patch on the previous line."
1445 (interactive)
1446 (stgit-assert-mode)
1447 (stgit-previous-patch)
1448 (stgit-unmark))
1449
1450(defun stgit-unmark-down ()
1451 "Remove mark from the patch on the current line."
1452 (interactive)
1453 (stgit-assert-mode)
1454 (stgit-unmark)
1455 (stgit-next-patch))
1456
1457(defun stgit-rename (name)
1458 "Rename the patch under point to NAME."
1459 (interactive (list
1460 (read-string "Patch name: "
1461 (symbol-name (stgit-patch-name-at-point t t)))))
1462 (stgit-assert-mode)
1463 (let ((old-patchsym (stgit-patch-name-at-point t t)))
1464 (stgit-capture-output nil
1465 (stgit-run "rename" "--" old-patchsym name))
1466 (let ((name-sym (intern name)))
1467 (when (memq old-patchsym stgit-expanded-patches)
1468 (setq stgit-expanded-patches
1469 (cons name-sym (delq old-patchsym stgit-expanded-patches))))
1470 (when (memq old-patchsym stgit-marked-patches)
1471 (setq stgit-marked-patches
1472 (cons name-sym (delq old-patchsym stgit-marked-patches))))
1473 (stgit-reload)
1474 (stgit-goto-patch name-sym))))
1475
1476(defun stgit-reload-or-repair (repair)
1477 "Update the contents of the StGit buffer (`stgit-reload').
1478
1479With a prefix argument, repair the StGit metadata if the branch
1480was modified with git commands (`stgit-repair')."
1481 (interactive "P")
1482 (stgit-assert-mode)
1483 (if repair
1484 (stgit-repair)
1485 (stgit-reload)))
1486
1487(defun stgit-repair ()
1488 "Run stg repair."
1489 (interactive)
1490 (stgit-assert-mode)
1491 (stgit-capture-output nil
1492 (stgit-run "repair"))
1493 (stgit-reload))
1494
1495(defun stgit-available-branches (&optional all)
1496 "Returns a list of the names of the available stg branches as strings.
1497
1498If ALL is not nil, also return non-stgit branches."
1499 (let ((output (with-output-to-string
1500 (stgit-run "branch" "--list")))
1501 (pattern (format "^>?\\s-+%c\\s-+\\(\\S-+\\)"
1502 (if all ?. ?s)))
1503 (start 0)
1504 result)
1505 (while (string-match pattern output start)
1506 (setq result (cons (match-string 1 output) result))
1507 (setq start (match-end 0)))
1508 result))
1509
1510(defun stgit-branch (branch)
1511 "Switch to or create branch BRANCH."
1512 (interactive (list (completing-read "Switch to branch: "
1513 (stgit-available-branches))))
1514 (stgit-assert-mode)
1515 (when (cond ((equal branch (stgit-current-branch))
1516 (error "Branch is already current"))
1517 ((member branch (stgit-available-branches t))
1518 (stgit-capture-output nil (stgit-run "branch" "--" branch))
1519 t)
1520 ((not (string-match stgit-allowed-branch-name-re branch))
1521 (error "Invalid branch name"))
1522 ((yes-or-no-p (format "Create branch \"%s\"? " branch))
1523 (let ((branch-point (completing-read
1524 "Branch from (default current branch): "
1525 (stgit-available-branches))))
1526 (stgit-capture-output nil
1527 (apply 'stgit-run
1528 `("branch" "--create" "--"
1529 ,branch
1530 ,@(unless (zerop (length branch-point))
1531 (list branch-point)))))
1532 t)))
1533 (stgit-reload)))
1534
1535(defun stgit-available-refs (&optional omit-stgit)
1536 "Returns a list of the available git refs.
1537If OMIT-STGIT is not nil, filter out \"resf/heads/*.stgit\"."
1538 (let* ((output (with-output-to-string
1539 (stgit-run-git-silent "for-each-ref" "--format=%(refname)"
1540 "refs/tags" "refs/heads"
1541 "refs/remotes")))
1542 (result (split-string output "\n" t)))
1543 (mapcar (lambda (s)
1544 (if (string-match "^refs/\\(heads\\|tags\\|remotes\\)/" s)
1545 (substring s (match-end 0))
1546 s))
1547 (if omit-stgit
1548 (delete-if (lambda (s)
1549 (string-match "^refs/heads/.*\\.stgit$" s))
1550 result)
1551 result))))
1552
1553(defun stgit-parent-branch ()
1554 "Return the parent branch of the current stg branch as per
1555git-config setting branch.<branch>.stgit.parentbranch."
1556 (let ((output (with-output-to-string
1557 (stgit-run-git-silent "config"
1558 (format "branch.%s.stgit.parentbranch"
1559 (stgit-current-branch))))))
1560 (when (string-match ".*" output)
1561 (match-string 0 output))))
1562
1563(defun stgit-rebase (new-base)
1564 "Rebase the current branch to NEW-BASE.
1565
1566Interactively, first ask which branch to rebase to. Defaults to
1567what git-config branch.<branch>.stgit.parentbranch is set to."
1568 (interactive (list (completing-read "Rebase to: "
1569 (stgit-available-refs t)
1570 nil nil
1571 (stgit-parent-branch))))
1572 (stgit-assert-mode)
1573 (stgit-capture-output nil (stgit-run "rebase" "--" new-base))
1574 (stgit-reload))
1575
1576(defun stgit-commit (count)
1577 "Run stg commit on COUNT commits.
1578Interactively, the prefix argument is used as COUNT.
1579A negative COUNT will uncommit instead."
1580 (interactive "p")
1581 (stgit-assert-mode)
1582 (if (< count 0)
1583 (stgit-uncommit (- count))
1584 (stgit-capture-output nil (stgit-run "commit" "-n" count))
1585 (stgit-reload)))
1586
1587(defun stgit-uncommit (count)
1588 "Run stg uncommit on COUNT commits.
1589Interactively, the prefix argument is used as COUNT.
1590A negative COUNT will commit instead."
1591 (interactive "p")
1592 (stgit-assert-mode)
1593 (if (< count 0)
1594 (stgit-commit (- count))
1595 (stgit-capture-output nil (stgit-run "uncommit" "-n" count))
1596 (stgit-reload)))
1597
1598(defun stgit-neighbour-file ()
1599 "Return the file name of the next file after point, or the
1600previous file if point is at the last file within a patch."
1601 (let ((old-point (point))
1602 neighbour-file)
1603 (and (zerop (forward-line 1))
1604 (let ((f (stgit-patched-file-at-point)))
1605 (and f (setq neighbour-file (stgit-file->file f)))))
1606 (goto-char old-point)
1607 (unless neighbour-file
1608 (and (zerop (forward-line -1))
1609 (let ((f (stgit-patched-file-at-point)))
1610 (and f (setq neighbour-file (stgit-file->file f)))))
1611 (goto-char old-point))
1612 neighbour-file))
1613
1614(defun stgit-revert-file ()
1615 "Revert the file at point, which must be in the index or the
1616working tree."
1617 (interactive)
1618 (stgit-assert-mode)
1619 (let* ((patched-file (or (stgit-patched-file-at-point)
1620 (error "No file on the current line")))
1621 (patch-name (stgit-patch-name-at-point))
1622 (file-status (stgit-file->status patched-file))
1623 (rm-file (cond ((stgit-file->copy-or-rename patched-file)
1624 (stgit-file->cr-to patched-file))
1625 ((eq file-status 'add)
1626 (stgit-file->file patched-file))))
1627 (co-file (cond ((eq file-status 'rename)
1628 (stgit-file->cr-from patched-file))
1629 ((not (memq file-status '(copy add)))
1630 (stgit-file->file patched-file))))
1631 (next-file (stgit-neighbour-file)))
1632
1633 (unless (memq patch-name '(:work :index))
1634 (error "No index or working tree file on this line"))
1635
1636 (when (eq file-status 'ignore)
1637 (error "Cannot revert ignored files"))
1638
1639 (when (eq file-status 'unknown)
1640 (error "Cannot revert unknown files"))
1641
1642 (let ((nfiles (+ (if rm-file 1 0) (if co-file 1 0))))
1643 (when (yes-or-no-p (format "Revert %d file%s? "
1644 nfiles
1645 (if (= nfiles 1) "" "s")))
1646 (stgit-capture-output nil
1647 (when rm-file
1648 (stgit-run-git "rm" "-f" "-q" "--" rm-file))
1649 (when co-file
1650 (stgit-run-git "checkout" "HEAD" co-file)))
1651 (stgit-reload)
1652 (stgit-goto-patch patch-name next-file)))))
1653
1654(defun stgit-revert ()
1655 "Revert the change at point, which must be the index, the work
1656tree, or a single change in either."
1657 (interactive)
1658 (stgit-assert-mode)
1659 (let ((patched-file (stgit-patched-file-at-point)))
1660 (if patched-file
1661 (stgit-revert-file)
1662 (let* ((patch-name (or (stgit-patch-name-at-point)
1663 (error "No patch or file at point")))
1664 (patch-desc (case patch-name
1665 (:index "index")
1666 (:work "work tree")
1667 (t (error (substitute-command-keys
1668 "Use \\[stgit-delete] to delete a patch"))))))
1669 (when (if (eq patch-name :work)
1670 (stgit-work-tree-empty-p)
1671 (stgit-index-empty-p))
1672 (error (format "There are no changes in the %s to revert"
1673 patch-desc)))
1674 (and (eq patch-name :index)
1675 (not (stgit-work-tree-empty-p))
1676 (error "Cannot revert index as work tree contains unstaged changes"))
1677
1678 (when (yes-or-no-p (format "Revert all changes in the %s? "
1679 patch-desc))
1680 (if (eq patch-name :index)
1681 (stgit-run-git-silent "reset" "--hard" "-q")
1682 (stgit-run-git-silent "checkout" "--" "."))
1683 (stgit-refresh-index)
1684 (stgit-refresh-worktree)
1685 (stgit-goto-patch patch-name))))))
1686
1687(defun stgit-resolve-file ()
1688 "Resolve conflict in the file at point."
1689 (interactive)
1690 (stgit-assert-mode)
1691 (let* ((patched-file (stgit-patched-file-at-point))
1692 (patch (stgit-patch-at-point))
1693 (patch-name (and patch (stgit-patch->name patch)))
1694 (status (and patched-file (stgit-file->status patched-file))))
1695
1696 (unless (memq patch-name '(:work :index))
1697 (error "No index or working tree file on this line"))
1698
1699 (unless (eq status 'unmerged)
1700 (error "No conflict to resolve at the current line"))
1701
1702 (stgit-capture-output nil
1703 (stgit-move-change-to-index (stgit-file->file patched-file)))
1704
1705 (stgit-reload)))
1706
1707(defun stgit-push-or-pop-patches (do-push npatches)
1708 "Push (if DO-PUSH is not nil) or pop (if DO-PUSH is nil)
1709NPATCHES patches, or all patches if NPATCHES is t."
1710 (stgit-assert-mode)
1711 (stgit-capture-output nil
1712 (apply 'stgit-run
1713 (if do-push "push" "pop")
1714 (if (eq npatches t)
1715 '("--all")
1716 (list "-n" npatches))))
1717 (stgit-reload)
1718 (stgit-refresh-git-status))
1719
1720(defun stgit-push-next (npatches)
1721 "Push the first unapplied patch.
1722With numeric prefix argument, push that many patches."
1723 (interactive "p")
1724 (stgit-push-or-pop-patches t npatches))
1725
1726(defun stgit-pop-next (npatches)
1727 "Pop the topmost applied patch.
1728With numeric prefix argument, pop that many patches.
1729
1730If NPATCHES is t, pop all patches."
1731 (interactive "p")
1732 (stgit-push-or-pop-patches nil npatches))
1733
1734(defun stgit-applied-patches (&optional only-patches)
1735 "Return a list of the applied patches.
1736
1737If ONLY-PATCHES is not nil, exclude index and work tree."
1738 (let ((states (if only-patches
1739 '(applied top)
1740 '(applied top index work)))
1741 result)
1742 (ewoc-map (lambda (patch)
1743 (when (memq (stgit-patch->status patch) states)
1744 (setq result (cons patch result)))
1745 nil)
1746 stgit-ewoc)
1747 result))
1748
1749(defun stgit-applied-patchsyms (&optional only-patches)
1750 "Return a list of the symbols of the applied patches.
1751
1752If ONLY-PATCHES is not nil, exclude index and work tree."
1753 (mapcar #'stgit-patch->name (stgit-applied-patches only-patches)))
1754
1755(defun stgit-push-or-pop ()
1756 "Push or pop the marked patches."
1757 (interactive)
1758 (stgit-assert-mode)
1759 (let* ((patchsyms (stgit-patches-marked-or-at-point t t))
1760 (applied-syms (stgit-applied-patchsyms t))
1761 (unapplied (set-difference patchsyms applied-syms)))
1762 (stgit-capture-output nil
1763 (apply 'stgit-run
1764 (if unapplied "push" "pop")
1765 "--"
1766 (stgit-sort-patches (if unapplied unapplied patchsyms)))))
1767 (stgit-reload))
1768
1769(defun stgit-goto-target ()
1770 "Return the goto target a point; either a patchsym, :top,
1771or :bottom."
1772 (let ((patchsym (stgit-patch-name-at-point)))
1773 (cond ((memq patchsym '(:work :index)) nil)
1774 (patchsym)
1775 ((not (next-single-property-change (point) 'patch-data))
1776 :top)
1777 ((not (previous-single-property-change (point) 'patch-data))
1778 :bottom))))
1779
1780(defun stgit-goto ()
1781 "Go to the patch on the current line.
1782
1783Push or pop patches to make this patch topmost. Push or pop all
1784patches if used on a line after or before all patches."
1785 (interactive)
1786 (stgit-assert-mode)
1787 (let ((patchsym (stgit-goto-target)))
1788 (unless patchsym
1789 (error "No patch to go to on this line"))
1790 (case patchsym
1791 (:top (stgit-push-or-pop-patches t t))
1792 (:bottom (stgit-push-or-pop-patches nil t))
1793 (t (stgit-capture-output nil
1794 (stgit-run "goto" "--" patchsym))
1795 (stgit-reload)))))
1796
1797(defun stgit-id (patchsym)
1798 "Return the git commit id for PATCHSYM.
1799If PATCHSYM is a keyword, returns PATCHSYM unmodified."
1800 (if (keywordp patchsym)
1801 patchsym
1802 (let ((result (with-output-to-string
1803 (stgit-run-silent "id" "--" patchsym))))
1804 (unless (string-match "^\\([0-9A-Fa-f]\\{40\\}\\)$" result)
1805 (error "Cannot find commit id for %s" patchsym))
1806 (match-string 1 result))))
1807
1808(defun stgit-whitespace-diff-arg (arg)
1809 (when (numberp arg)
1810 (cond ((> arg 4) "--ignore-all-space")
1811 ((> arg 1) "--ignore-space-change"))))
1812
1813(defun stgit-show-patch (unmerged-stage ignore-whitespace)
1814 "Show the patch on the current line.
1815
1816UNMERGED-STAGE is the argument to `git-diff' that that selects
1817which stage to diff against in the case of unmerged files."
1818 (let ((space-arg (stgit-whitespace-diff-arg ignore-whitespace))
1819 (patch-name (stgit-patch-name-at-point t)))
1820 (stgit-capture-output "*StGit patch*"
1821 (case (get-text-property (point) 'entry-type)
1822 ('file
1823 (let* ((patched-file (stgit-patched-file-at-point))
1824 (patch-id (let ((id (stgit-id patch-name)))
1825 (if (and (eq id :index)
1826 (eq (stgit-file->status patched-file)
1827 'unmerged))
1828 :work
1829 id)))
1830 (args (append (and space-arg (list space-arg))
1831 (and (stgit-file->cr-from patched-file)
1832 (list (stgit-find-copies-harder-diff-arg)))
1833 (cond ((eq patch-id :index)
1834 '("--cached"))
1835 ((eq patch-id :work)
1836 (list unmerged-stage))
1837 (t
1838 (list (concat patch-id "^") patch-id)))
1839 '("--")
1840 (if (stgit-file->copy-or-rename patched-file)
1841 (list (stgit-file->cr-from patched-file)
1842 (stgit-file->cr-to patched-file))
1843 (list (stgit-file->file patched-file))))))
1844 (apply 'stgit-run-git "diff" args)))
1845 ('patch
1846 (let* ((patch-id (stgit-id patch-name)))
1847 (if (or (eq patch-id :index) (eq patch-id :work))
1848 (apply 'stgit-run-git "diff"
1849 (stgit-find-copies-harder-diff-arg)
1850 (append (and space-arg (list space-arg))
1851 (if (eq patch-id :index)
1852 '("--cached")
1853 (list unmerged-stage))))
1854 (let ((args (append '("show" "-O" "--patch-with-stat" "-O" "-M")
1855 (and space-arg (list "-O" space-arg))
1856 '("--")
1857 (list (stgit-patch-name-at-point)))))
1858 (apply 'stgit-run args)))))
1859 (t
1860 (error "No patch or file at point")))
1861 (with-current-buffer standard-output
1862 (goto-char (point-min))
1863 (diff-mode)))))
1864
1865(defmacro stgit-define-diff (name diff-arg &optional unmerged-action)
1866 `(defun ,name (&optional ignore-whitespace)
1867 ,(format "Show the patch on the current line.
1868
1869%sWith a prefix argument, ignore whitespace. With a prefix argument
1870greater than four (e.g., \\[universal-argument] \
1871\\[universal-argument] \\[%s]), ignore all whitespace."
1872 (if unmerged-action
1873 (format "For unmerged files, %s.\n\n" unmerged-action)
1874 "")
1875 name)
1876 (interactive "p")
1877 (stgit-assert-mode)
1878 (stgit-show-patch ,diff-arg ignore-whitespace)))
1879
1880(stgit-define-diff stgit-diff
1881 "--ours" nil)
1882(stgit-define-diff stgit-diff-ours
1883 "--ours"
1884 "diff against our branch")
1885(stgit-define-diff stgit-diff-theirs
1886 "--theirs"
1887 "diff against their branch")
1888(stgit-define-diff stgit-diff-base
1889 "--base"
1890 "diff against the merge base")
1891(stgit-define-diff stgit-diff-combined
1892 "--cc"
1893 "show a combined diff")
1894
1895(defun stgit-diff-range (&optional ignore-whitespace)
1896 "Show diff for the range of patches between point and the marked patch.
1897
1898With a prefix argument, ignore whitespace. With a prefix argument
1899greater than four (e.g., \\[universal-argument] \
1900\\[universal-argument] \\[stgit-diff-range]), ignore all whitespace."
1901 (interactive "p")
1902 (stgit-assert-mode)
1903 (unless (= (length stgit-marked-patches) 1)
1904 (error "Need exactly one patch marked"))
1905 (let* ((patches (stgit-sort-patches (cons (stgit-patch-name-at-point t t)
1906 stgit-marked-patches)
1907 t))
1908 (first-patch (car patches))
1909 (second-patch (if (cdr patches) (cadr patches) first-patch))
1910 (whitespace-arg (stgit-whitespace-diff-arg ignore-whitespace))
1911 (applied (stgit-applied-patchsyms t)))
1912 (unless (and (memq first-patch applied) (memq second-patch applied))
1913 (error "Can only show diff range for applied patches"))
1914 (stgit-capture-output (format "*StGit diff %s..%s*"
1915 first-patch second-patch)
1916 (apply 'stgit-run-git (append '("diff" "--patch-with-stat")
1917 (and whitespace-arg (list whitespace-arg))
1918 (list (format "%s^" (stgit-id first-patch))
1919 (stgit-id second-patch))))
1920 (with-current-buffer standard-output
1921 (goto-char (point-min))
1922 (diff-mode)))))
1923
1924(defun stgit-move-change-to-index (file &optional force)
1925 "Copies the work tree state of FILE to index, using git add or git rm.
1926
1927If FORCE is not nil, use --force."
1928 (let ((op (if (or (file-exists-p file) (file-symlink-p file))
1929 '("add") '("rm" "-q"))))
1930 (stgit-capture-output "*git output*"
1931 (apply 'stgit-run-git (append op (and force '("--force"))
1932 '("--") (list file))))))
1933
1934(defun stgit-remove-change-from-index (file)
1935 "Unstages the change in FILE from the index"
1936 (stgit-capture-output "*git output*"
1937 (stgit-run-git "reset" "-q" "--" file)))
1938
1939(defun stgit-git-index-unmerged-p ()
1940 (let (result)
1941 (with-output-to-string
1942 (setq result (not (zerop (stgit-run-git-silent "diff-index" "--cached"
1943 "--diff-filter=U"
1944 "--quiet" "HEAD")))))
1945 result))
1946
1947(defun stgit-file-toggle-index ()
1948 "Move modified file in or out of the index.
1949
1950Leaves the point where it is, but moves the mark to where the
1951file ended up. You can then jump to the file with \
1952\\[exchange-point-and-mark]."
1953 (interactive)
1954 (stgit-assert-mode)
1955 (let* ((patched-file (or (stgit-patched-file-at-point)
1956 (error "No file on the current line")))
1957 (patched-status (stgit-file->status patched-file)))
1958 (when (eq patched-status 'unmerged)
1959 (error (substitute-command-keys "Use \\[stgit-resolve-file] to move an unmerged file to the index")))
1960 (let* ((patch (stgit-patch-at-point))
1961 (patch-name (stgit-patch->name patch))
1962 (mark-file (if (eq patched-status 'rename)
1963 (stgit-file->cr-to patched-file)
1964 (stgit-file->file patched-file)))
1965 (point-file (if (eq patched-status 'rename)
1966 (stgit-file->cr-from patched-file)
1967 (stgit-neighbour-file))))
1968
1969 (cond ((eq patch-name :work)
1970 (stgit-move-change-to-index (stgit-file->file patched-file)
1971 (eq patched-status 'ignore)))
1972 ((eq patch-name :index)
1973 (stgit-remove-change-from-index (stgit-file->file patched-file)))
1974 (t
1975 (error "Can only move files between working tree and index")))
1976 (stgit-refresh-worktree)
1977 (stgit-refresh-index)
1978 (stgit-goto-patch (if (eq patch-name :index) :work :index) mark-file)
1979 (push-mark nil t t)
1980 (stgit-goto-patch patch-name point-file))))
1981
1982(defun stgit-toggle-index ()
1983 "Move change in or out of the index.
1984
1985Works on index and work tree, as well as files in either.
1986
1987Leaves the point where it is, but moves the mark to where the
1988file ended up. You can then jump to the file with \
1989\\[exchange-point-and-mark]."
1990 (interactive)
1991 (stgit-assert-mode)
1992 (if (stgit-patched-file-at-point)
1993 (stgit-file-toggle-index)
1994 (let ((patch-name (stgit-patch-name-at-point)))
1995 (unless (memq patch-name '(:index :work))
1996 (error "Can only move changes between working tree and index"))
1997 (when (stgit-git-index-unmerged-p)
1998 (error "Resolve unmerged changes with \\[stgit-resolve-file] first"))
1999 (if (if (eq patch-name :index)
2000 (stgit-index-empty-p)
2001 (stgit-work-tree-empty-p))
2002 (message "No changes to be moved")
2003 (stgit-capture-output nil
2004 (if (eq patch-name :work)
2005 (stgit-run-git "add" "--update")
2006 (stgit-run-git "reset" "--mixed" "-q")))
2007 (stgit-refresh-worktree)
2008 (stgit-refresh-index))
2009 (stgit-goto-patch (if (eq patch-name :index) :work :index)))))
2010
2011(defun stgit-edit ()
2012 "Edit the patch on the current line."
2013 (interactive)
2014 (stgit-assert-mode)
2015 (let ((patchsym (stgit-patch-name-at-point t t))
2016 (edit-buf (get-buffer-create "*StGit edit*"))
2017 (dir default-directory))
2018 (log-edit 'stgit-confirm-edit t nil edit-buf)
2019 (set (make-local-variable 'stgit-edit-patchsym) patchsym)
2020 (setq default-directory dir)
2021 (let ((standard-output edit-buf))
2022 (save-excursion
2023 (stgit-run-silent "edit" "--save-template=-" "--" patchsym)))))
2024
2025(defun stgit-confirm-edit ()
2026 (interactive)
2027 (let ((file (make-temp-file "stgit-edit-")))
2028 (write-region (point-min) (point-max) file)
2029 (stgit-capture-output nil
2030 (stgit-run "edit" "-f" file "--" stgit-edit-patchsym))
2031 (with-current-buffer log-edit-parent-buffer
2032 (stgit-reload))))
2033
2034(defun stgit-new (add-sign &optional refresh)
2035 "Create a new patch.
2036With a prefix argument, include a \"Signed-off-by:\" line at the
2037end of the patch."
2038 (interactive "P")
2039 (stgit-assert-mode)
2040 (let ((edit-buf (get-buffer-create "*StGit edit*"))
2041 (dir default-directory))
2042 (log-edit 'stgit-confirm-new t nil edit-buf)
2043 (setq default-directory dir)
2044 (set (make-local-variable 'stgit-refresh-after-new) refresh)
2045 (when add-sign
2046 (save-excursion
2047 (let ((standard-output (current-buffer)))
2048 (stgit-run-silent "new" "--sign" "--save-template=-"))))))
2049
2050(defun stgit-confirm-new ()
2051 (interactive)
2052 (let ((file (make-temp-file "stgit-edit-"))
2053 (refresh stgit-refresh-after-new))
2054 (write-region (point-min) (point-max) file)
2055 (stgit-capture-output nil
2056 (stgit-run "new" "-f" file))
2057 (with-current-buffer log-edit-parent-buffer
2058 (if refresh
2059 (stgit-refresh)
2060 (stgit-reload)))))
2061
2062(defun stgit-new-and-refresh (add-sign)
2063 "Create a new patch and refresh it with the current changes.
2064
2065With a prefix argument, include a \"Signed-off-by:\" line at the
2066end of the patch.
2067
2068This works just like running `stgit-new' followed by `stgit-refresh'."
2069 (interactive "P")
2070 (stgit-assert-mode)
2071 (stgit-new add-sign t))
2072
2073(defun stgit-create-patch-name (description)
2074 "Create a patch name from a long description"
2075 (let ((patch ""))
2076 (while (> (length description) 0)
2077 (cond ((string-match "\\`[a-zA-Z_-]+" description)
2078 (setq patch (downcase (concat patch
2079 (match-string 0 description))))
2080 (setq description (substring description (match-end 0))))
2081 ((string-match "\\` +" description)
2082 (setq patch (concat patch "-"))
2083 (setq description (substring description (match-end 0))))
2084 ((string-match "\\`[^a-zA-Z_-]+" description)
2085 (setq description (substring description (match-end 0))))))
2086 (cond ((= (length patch) 0)
2087 "patch")
2088 ((> (length patch) 20)
2089 (substring patch 0 20))
2090 (t patch))))
2091
2092(defun stgit-delete (patchsyms &optional spill-p)
2093 "Delete the patches in PATCHSYMS.
2094Interactively, delete the marked patches, or the patch at point.
2095
2096With a prefix argument, or SPILL-P, spill the patch contents to
2097the work tree and index."
2098 (interactive (list (stgit-patches-marked-or-at-point t t)
2099 current-prefix-arg))
2100 (stgit-assert-mode)
2101 (unless patchsyms
2102 (error "No patches to delete"))
2103 (when (memq :index patchsyms)
2104 (error "Cannot delete the index"))
2105 (when (memq :work patchsyms)
2106 (error "Cannot delete the work tree"))
2107
2108 (let ((npatches (length patchsyms)))
2109 (when (yes-or-no-p (format "Really delete %d patch%s%s? "
2110 npatches
2111 (if (= 1 npatches) "" "es")
2112 (if spill-p
2113 " (spilling contents to index)"
2114 "")))
2115 (let ((args (append (when spill-p '("--spill"))
2116 '("--")
2117 patchsyms)))
2118 (stgit-capture-output nil
2119 (apply 'stgit-run "delete" args))
2120 (stgit-reload)))))
2121
2122(defun stgit-move-patches-target ()
2123 "Return the patchsym indicating a target patch for
2124`stgit-move-patches'.
2125
2126This is either the first unmarked patch at or after point, or one
2127of :top and :bottom if the point is after or before the applied
2128patches."
2129
2130 (save-excursion
2131 (let (result)
2132 (while (not result)
2133 (let ((patchsym (stgit-patch-name-at-point)))
2134 (cond ((memq patchsym '(:work :index)) (setq result :top))
2135 (patchsym (if (memq patchsym stgit-marked-patches)
2136 (stgit-next-patch)
2137 (setq result patchsym)))
2138 ((re-search-backward "^>" nil t) (setq result :top))
2139 (t (setq result :bottom)))))
2140 result)))
2141
2142(defun stgit-sort-patches (patchsyms &optional allow-duplicates)
2143 "Returns the list of patches in PATCHSYMS sorted according to
2144their position in the patch series, bottommost first.
2145
2146PATCHSYMS must not contain duplicate entries, unless
2147ALLOW-DUPLICATES is not nil."
2148 (let (sorted-patchsyms
2149 (series (with-output-to-string
2150 (with-current-buffer standard-output
2151 (stgit-run-silent "series" "--noprefix"))))
2152 start)
2153 (while (string-match "^\\(.+\\)" series start)
2154 (let ((patchsym (intern (match-string 1 series))))
2155 (when (memq patchsym patchsyms)
2156 (setq sorted-patchsyms (cons patchsym sorted-patchsyms))))
2157 (setq start (match-end 0)))
2158 (setq sorted-patchsyms (nreverse sorted-patchsyms))
2159
2160 (unless allow-duplicates
2161 (unless (= (length patchsyms) (length sorted-patchsyms))
2162 (error "Internal error")))
2163
2164 sorted-patchsyms))
2165
2166(defun stgit-move-patches (patchsyms target-patch)
2167 "Move the patches in PATCHSYMS to below TARGET-PATCH.
2168If TARGET-PATCH is :bottom or :top, move the patches to the
2169bottom or top of the stack, respectively.
2170
2171Interactively, move the marked patches to where the point is."
2172 (interactive (list stgit-marked-patches
2173 (stgit-move-patches-target)))
2174 (stgit-assert-mode)
2175 (unless patchsyms
2176 (error "Need at least one patch to move"))
2177
2178 (unless target-patch
2179 (error "Point not at a patch"))
2180
2181 ;; need to have patchsyms sorted by position in the stack
2182 (let ((sorted-patchsyms (stgit-sort-patches patchsyms)))
2183 (stgit-capture-output nil
2184 (if (eq target-patch :top)
2185 (apply 'stgit-run "float" "--" sorted-patchsyms)
2186 (apply 'stgit-run
2187 "sink"
2188 (append (unless (eq target-patch :bottom)
2189 (list "--to" target-patch))
2190 '("--")
2191 sorted-patchsyms)))))
2192 (stgit-reload))
2193
2194(defun stgit-squash (patchsyms)
2195 "Squash the patches in PATCHSYMS.
2196Interactively, squash the marked patches.
2197
2198Unless there are any conflicts, the patches will be merged into
2199one patch, which will occupy the same spot in the series as the
2200deepest patch had before the squash."
2201 (interactive (list stgit-marked-patches))
2202 (stgit-assert-mode)
2203 (when (< (length patchsyms) 2)
2204 (error "Need at least two patches to squash"))
2205 (let ((stgit-buffer (current-buffer))
2206 (edit-buf (get-buffer-create "*StGit edit*"))
2207 (dir default-directory)
2208 (sorted-patchsyms (stgit-sort-patches patchsyms)))
2209 (log-edit 'stgit-confirm-squash t nil edit-buf)
2210 (set (make-local-variable 'stgit-patchsyms) sorted-patchsyms)
2211 (setq default-directory dir)
2212 (let ((result (let ((standard-output edit-buf))
2213 (save-excursion
2214 (apply 'stgit-run-silent "squash"
2215 "--save-template=-" "--" sorted-patchsyms)))))
2216
2217 ;; stg squash may have reordered the patches or caused conflicts
2218 (with-current-buffer stgit-buffer
2219 (stgit-reload))
2220
2221 (unless (eq 0 result)
2222 (fundamental-mode)
2223 (rename-buffer "*StGit error*")
2224 (resize-temp-buffer-window)
2225 (switch-to-buffer-other-window stgit-buffer)
2226 (error "stg squash failed")))))
2227
2228(defun stgit-confirm-squash ()
2229 (interactive)
2230 (let ((file (make-temp-file "stgit-edit-")))
2231 (write-region (point-min) (point-max) file)
2232 (stgit-capture-output nil
2233 (apply 'stgit-run "squash" "-f" file "--" stgit-patchsyms))
2234 (with-current-buffer log-edit-parent-buffer
2235 (stgit-clear-marks)
2236 ;; Go to first marked patch and stay there
2237 (goto-char (point-min))
2238 (re-search-forward (concat "^[>+-]\\*") nil t)
2239 (move-to-column goal-column)
2240 (let ((pos (point)))
2241 (stgit-reload)
2242 (goto-char pos)))))
2243
2244(defun stgit-help ()
2245 "Display help for the StGit mode."
2246 (interactive)
2247 (describe-function 'stgit-mode))
2248
2249(defun stgit-execute-process-sentinel (process sentinel)
2250 (let (old-sentinel stgit-buf)
2251 (with-current-buffer (process-buffer process)
2252 (setq old-sentinel old-process-sentinel
2253 stgit-buf stgit-buffer))
2254 (and (memq (process-status process) '(exit signal))
2255 (buffer-live-p stgit-buf)
2256 (with-current-buffer stgit-buf
2257 (stgit-reload)))
2258 (funcall old-sentinel process sentinel)))
2259
2260(defun stgit-execute-process-filter (process output)
2261 (with-current-buffer (process-buffer process)
2262 (let* ((old-point (point))
2263 (pmark (process-mark process))
2264 (insert-at (marker-position pmark))
2265 (at-pmark (= insert-at old-point)))
2266 (goto-char insert-at)
2267 (insert-before-markers output)
2268 (comint-carriage-motion insert-at (point))
2269 (set-marker pmark (point))
2270 (unless at-pmark
2271 (goto-char old-point)))))
2272
2273(defun stgit-execute ()
2274 "Prompt for an stg command to execute in a shell.
2275
2276The names of any marked patches or the patch at point are
2277inserted in the command to be executed.
2278
2279If the command ends in an ampersand, run it asynchronously.
2280
2281When the command has finished, reload the stgit buffer."
2282 (interactive)
2283 (stgit-assert-mode)
2284 (let* ((patches (stgit-patches-marked-or-at-point nil t))
2285 (patch-names (mapcar 'symbol-name patches))
2286 (hyphens (find-if (lambda (s) (string-match "^-" s)) patch-names))
2287 (defaultcmd (if patches
2288 (concat "stg "
2289 (and hyphens "-- ")
2290 (mapconcat 'identity patch-names " "))
2291 "stg "))
2292 (cmd (read-from-minibuffer "Shell command: " (cons defaultcmd 5)
2293 nil nil 'shell-command-history))
2294 (async (string-match "&[ \t]*\\'" cmd))
2295 (buffer (get-buffer-create
2296 (if async
2297 "*Async Shell Command*"
2298 "*Shell Command Output*"))))
2299 ;; cannot use minibuffer as stgit-reload would overwrite it; if we
2300 ;; show the buffer, shell-command will not use the minibuffer
2301 (display-buffer buffer)
2302 (shell-command cmd)
2303 (if async
2304 (let ((old-buffer (current-buffer)))
2305 (with-current-buffer buffer
2306 (let ((process (get-buffer-process buffer)))
2307 (set (make-local-variable 'old-process-sentinel)
2308 (process-sentinel process))
2309 (set (make-local-variable 'stgit-buffer)
2310 old-buffer)
2311 (set-process-filter process 'stgit-execute-process-filter)
2312 (set-process-sentinel process 'stgit-execute-process-sentinel))))
2313 (with-current-buffer buffer
2314 (comint-carriage-motion (point-min) (point-max)))
2315 (shrink-window-if-larger-than-buffer (get-buffer-window buffer))
2316 (stgit-reload))))
2317
2318(defun stgit-undo-or-redo (redo hard)
2319 "Run stg undo or, if REDO is non-nil, stg redo.
2320
2321If HARD is non-nil, use the --hard flag."
2322 (stgit-assert-mode)
2323 (let ((cmd (if redo "redo" "undo")))
2324 (stgit-capture-output nil
2325 (if arg
2326 (when (or (and (stgit-index-empty-p)
2327 (stgit-work-tree-empty-p))
2328 (y-or-n-p (format "Hard %s may overwrite index/work tree changes. Continue? "
2329 cmd)))
2330 (stgit-run cmd "--hard"))
2331 (stgit-run cmd))))
2332 (stgit-reload))
2333
2334(defun stgit-undo (&optional arg)
2335 "Run stg undo.
2336With prefix argument, run it with the --hard flag.
2337
2338See also `stgit-redo'."
2339 (interactive "P")
2340 (stgit-undo-or-redo nil arg))
2341
2342(defun stgit-redo (&optional arg)
2343 "Run stg redo.
2344With prefix argument, run it with the --hard flag.
2345
2346See also `stgit-undo'."
2347 (interactive "P")
2348 (stgit-undo-or-redo t arg))
2349
2350(defun stgit-refresh (&optional arg)
2351 "Run stg refresh.
2352If the index contains any changes, only refresh from index.
2353
2354With prefix argument, refresh the marked patch or the patch under point."
2355 (interactive "P")
2356 (stgit-assert-mode)
2357 (let ((patchargs (if arg
2358 (let ((patches (stgit-patches-marked-or-at-point nil t)))
2359 (when (> (length patches) 1)
2360 (error "Too many patches marked"))
2361 (cons "-p" patches))
2362 nil)))
2363 (unless (stgit-index-empty-p)
2364 (setq patchargs (cons "--index" patchargs)))
2365 (stgit-capture-output nil
2366 (apply 'stgit-run "refresh" patchargs))
2367 (stgit-refresh-git-status))
2368 (stgit-reload))
2369
2370(defvar stgit-show-worktree nil
2371 "If nil, inhibit showing work tree and index in the stgit buffer.
2372
2373See also `stgit-show-worktree-mode'.")
2374
2375(defvar stgit-show-ignored nil
2376 "If nil, inhibit showing files ignored by git.")
2377
2378(defvar stgit-show-unknown nil
2379 "If nil, inhibit showing files not registered with git.")
2380
2381(defvar stgit-show-patch-names t
2382 "If nil, inhibit showing patch names.")
2383
2384(defun stgit-toggle-worktree (&optional arg)
2385 "Toggle the visibility of the work tree.
2386With ARG, show the work tree if ARG is positive.
2387
2388Its initial setting is controlled by `stgit-default-show-worktree'.
2389
2390`stgit-show-worktree-mode' controls where on screen the index and
2391work tree will show up."
2392 (interactive)
2393 (stgit-assert-mode)
2394 (setq stgit-show-worktree
2395 (if (numberp arg)
2396 (> arg 0)
2397 (not stgit-show-worktree)))
2398 (stgit-reload))
2399
2400(defun stgit-toggle-ignored (&optional arg)
2401 "Toggle the visibility of files ignored by git in the work
2402tree. With ARG, show these files if ARG is positive.
2403
2404Its initial setting is controlled by `stgit-default-show-ignored'.
2405
2406Use \\[stgit-toggle-worktree] to show the work tree."
2407 (interactive)
2408 (stgit-assert-mode)
2409 (setq stgit-show-ignored
2410 (if (numberp arg)
2411 (> arg 0)
2412 (not stgit-show-ignored)))
2413 (stgit-reload))
2414
2415(defun stgit-toggle-unknown (&optional arg)
2416 "Toggle the visibility of files not registered with git in the
2417work tree. With ARG, show these files if ARG is positive.
2418
2419Its initial setting is controlled by `stgit-default-show-unknown'.
2420
2421Use \\[stgit-toggle-worktree] to show the work tree."
2422 (interactive)
2423 (stgit-assert-mode)
2424 (setq stgit-show-unknown
2425 (if (numberp arg)
2426 (> arg 0)
2427 (not stgit-show-unknown)))
2428 (stgit-reload))
2429
2430(defun stgit-toggle-patch-names (&optional arg)
2431 "Toggle the visibility of patch names. With ARG, show patch names
2432if ARG is positive.
2433
2434The initial setting is controlled by `stgit-default-show-patch-names'."
2435 (interactive)
2436 (stgit-assert-mode)
2437 (setq stgit-show-patch-names
2438 (if (numberp arg)
2439 (> arg 0)
2440 (not stgit-show-patch-names)))
2441 (stgit-reload))
2442
2443(provide 'stgit)