1#!/bin/sh
2# Copyright (c) 2007, Nanako Shiraishi
3
4dashless=$(basename "$0" | sed -e 's/-/ /')
5USAGE="list [<options>]
6 or: $dashless show [<stash>]
7 or: $dashless drop [-q|--quiet] [<stash>]
8 or: $dashless ( pop | apply ) [--index] [-q|--quiet] [<stash>]
9 or: $dashless branch <branchname> [<stash>]
10 or: $dashless [save [--patch] [-k|--[no-]keep-index] [-q|--quiet] [<message>]]
11 or: $dashless clear"
12
13SUBDIRECTORY_OK=Yes
14OPTIONS_SPEC=
15. git-sh-setup
16require_work_tree
17cd_to_toplevel
18
19TMP="$GIT_DIR/.git-stash.$$"
20trap 'rm -f "$TMP-*"' 0
21
22ref_stash=refs/stash
23
24if git config --get-colorbool color.interactive; then
25 help_color="$(git config --get-color color.interactive.help 'red bold')"
26 reset_color="$(git config --get-color '' reset)"
27else
28 help_color=
29 reset_color=
30fi
31
32no_changes () {
33 git diff-index --quiet --cached HEAD --ignore-submodules -- &&
34 git diff-files --quiet --ignore-submodules
35}
36
37clear_stash () {
38 if test $# != 0
39 then
40 die "git stash clear with parameters is unimplemented"
41 fi
42 if current=$(git rev-parse --verify $ref_stash 2>/dev/null)
43 then
44 git update-ref -d $ref_stash $current
45 fi
46}
47
48create_stash () {
49 stash_msg="$1"
50
51 git update-index -q --refresh
52 if no_changes
53 then
54 exit 0
55 fi
56
57 # state of the base commit
58 if b_commit=$(git rev-parse --verify HEAD)
59 then
60 head=$(git rev-list --oneline -n 1 HEAD --)
61 else
62 die "You do not have the initial commit yet"
63 fi
64
65 if branch=$(git symbolic-ref -q HEAD)
66 then
67 branch=${branch#refs/heads/}
68 else
69 branch='(no branch)'
70 fi
71 msg=$(printf '%s: %s' "$branch" "$head")
72
73 # state of the index
74 i_tree=$(git write-tree) &&
75 i_commit=$(printf 'index on %s\n' "$msg" |
76 git commit-tree $i_tree -p $b_commit) ||
77 die "Cannot save the current index state"
78
79 if test -z "$patch_mode"
80 then
81
82 # state of the working tree
83 w_tree=$( (
84 rm -f "$TMP-index" &&
85 cp -p ${GIT_INDEX_FILE-"$GIT_DIR/index"} "$TMP-index" &&
86 GIT_INDEX_FILE="$TMP-index" &&
87 export GIT_INDEX_FILE &&
88 git read-tree -m $i_tree &&
89 git diff --name-only -z HEAD | git update-index -z --add --remove --stdin &&
90 git write-tree &&
91 rm -f "$TMP-index"
92 ) ) ||
93 die "Cannot save the current worktree state"
94
95 else
96
97 rm -f "$TMP-index" &&
98 GIT_INDEX_FILE="$TMP-index" git read-tree HEAD &&
99
100 # find out what the user wants
101 GIT_INDEX_FILE="$TMP-index" \
102 git add--interactive --patch=stash -- &&
103
104 # state of the working tree
105 w_tree=$(GIT_INDEX_FILE="$TMP-index" git write-tree) ||
106 die "Cannot save the current worktree state"
107
108 git diff-tree -p HEAD $w_tree > "$TMP-patch" &&
109 test -s "$TMP-patch" ||
110 die "No changes selected"
111
112 rm -f "$TMP-index" ||
113 die "Cannot remove temporary index (can't happen)"
114
115 fi
116
117 # create the stash
118 if test -z "$stash_msg"
119 then
120 stash_msg=$(printf 'WIP on %s' "$msg")
121 else
122 stash_msg=$(printf 'On %s: %s' "$branch" "$stash_msg")
123 fi
124 w_commit=$(printf '%s\n' "$stash_msg" |
125 git commit-tree $w_tree -p $b_commit -p $i_commit) ||
126 die "Cannot record working tree state"
127}
128
129save_stash () {
130 keep_index=
131 patch_mode=
132 while test $# != 0
133 do
134 case "$1" in
135 -k|--keep-index)
136 keep_index=t
137 ;;
138 --no-keep-index)
139 keep_index=
140 ;;
141 -p|--patch)
142 patch_mode=t
143 keep_index=t
144 ;;
145 -q|--quiet)
146 GIT_QUIET=t
147 ;;
148 --)
149 shift
150 break
151 ;;
152 -*)
153 echo "error: unknown option for 'stash save': $1"
154 echo " To provide a message, use git stash save -- '$1'"
155 usage
156 ;;
157 *)
158 break
159 ;;
160 esac
161 shift
162 done
163
164 stash_msg="$*"
165
166 git update-index -q --refresh
167 if no_changes
168 then
169 say 'No local changes to save'
170 exit 0
171 fi
172 test -f "$GIT_DIR/logs/$ref_stash" ||
173 clear_stash || die "Cannot initialize stash"
174
175 create_stash "$stash_msg"
176
177 # Make sure the reflog for stash is kept.
178 : >>"$GIT_DIR/logs/$ref_stash"
179
180 git update-ref -m "$stash_msg" $ref_stash $w_commit ||
181 die "Cannot save the current status"
182 say Saved working directory and index state "$stash_msg"
183
184 if test -z "$patch_mode"
185 then
186 git reset --hard ${GIT_QUIET:+-q}
187
188 if test -n "$keep_index" && test -n $i_tree
189 then
190 git read-tree --reset -u $i_tree
191 fi
192 else
193 git apply -R < "$TMP-patch" ||
194 die "Cannot remove worktree changes"
195
196 if test -z "$keep_index"
197 then
198 git reset
199 fi
200 fi
201}
202
203have_stash () {
204 git rev-parse --verify $ref_stash >/dev/null 2>&1
205}
206
207list_stash () {
208 have_stash || return 0
209 git log --format="%gd: %gs" -g "$@" $ref_stash --
210}
211
212show_stash () {
213 assert_stash_like "$@"
214
215 git diff ${FLAGS:---stat} $b_commit $w_commit
216}
217
218#
219# Parses the remaining options looking for flags and
220# at most one revision defaulting to ${ref_stash}@{0}
221# if none found.
222#
223# Derives related tree and commit objects from the
224# revision, if one is found.
225#
226# stash records the work tree, and is a merge between the
227# base commit (first parent) and the index tree (second parent).
228#
229# REV is set to the symbolic version of the specified stash-like commit
230# IS_STASH_LIKE is non-blank if ${REV} looks like a stash
231# IS_STASH_REF is non-blank if the ${REV} looks like a stash ref
232# s is set to the SHA1 of the stash commit
233# w_commit is set to the commit containing the working tree
234# b_commit is set to the base commit
235# i_commit is set to the commit containing the index tree
236# w_tree is set to the working tree
237# b_tree is set to the base tree
238# i_tree is set to the index tree
239#
240# GIT_QUIET is set to t if -q is specified
241# INDEX_OPTION is set to --index if --index is specified.
242# FLAGS is set to the remaining flags
243#
244# dies if:
245# * too many revisions specified
246# * no revision is specified and there is no stash stack
247# * a revision is specified which cannot be resolve to a SHA1
248# * a non-existent stash reference is specified
249#
250
251parse_flags_and_rev()
252{
253 test "$PARSE_CACHE" = "$*" && return 0 # optimisation
254 PARSE_CACHE="$*"
255
256 IS_STASH_LIKE=
257 IS_STASH_REF=
258 INDEX_OPTION=
259 s=
260 w_commit=
261 b_commit=
262 i_commit=
263 w_tree=
264 b_tree=
265 i_tree=
266
267 REV=$(git rev-parse --no-flags --symbolic "$@") || exit 1
268
269 FLAGS=
270 for opt
271 do
272 case "$opt" in
273 -q|--quiet)
274 GIT_QUIET=-t
275 ;;
276 --index)
277 INDEX_OPTION=--index
278 ;;
279 -*)
280 FLAGS="${FLAGS}${FLAGS:+ }$opt"
281 ;;
282 esac
283 done
284
285 set -- $REV
286
287 case $# in
288 0)
289 have_stash || die "No stash found."
290 set -- ${ref_stash}@{0}
291 ;;
292 1)
293 :
294 ;;
295 *)
296 die "Too many revisions specified: $REV"
297 ;;
298 esac
299
300 REV=$(git rev-parse --quiet --symbolic --verify $1 2>/dev/null) || die "$1 is not valid reference"
301
302 i_commit=$(git rev-parse --quiet --verify $REV^2 2>/dev/null) &&
303 set -- $(git rev-parse $REV $REV^1 $REV: $REV^1: $REV^2: 2>/dev/null) &&
304 s=$1 &&
305 w_commit=$1 &&
306 b_commit=$2 &&
307 w_tree=$3 &&
308 b_tree=$4 &&
309 i_tree=$5 &&
310 IS_STASH_LIKE=t &&
311 test "$ref_stash" = "$(git rev-parse --symbolic-full-name "${REV%@*}")" &&
312 IS_STASH_REF=t
313}
314
315is_stash_like()
316{
317 parse_flags_and_rev "$@"
318 test -n "$IS_STASH_LIKE"
319}
320
321assert_stash_like() {
322 is_stash_like "$@" || die "'$*' is not a stash-like commit"
323}
324
325is_stash_ref() {
326 is_stash_like "$@" && test -n "$IS_STASH_REF"
327}
328
329assert_stash_ref() {
330 is_stash_ref "$@" || die "'$*' is not a stash reference"
331}
332
333apply_stash () {
334
335 assert_stash_like "$@"
336
337 git update-index -q --refresh &&
338 git diff-files --quiet --ignore-submodules ||
339 die 'Cannot apply to a dirty working tree, please stage your changes'
340
341 # current index state
342 c_tree=$(git write-tree) ||
343 die 'Cannot apply a stash in the middle of a merge'
344
345 unstashed_index_tree=
346 if test -n "$INDEX_OPTION" && test "$b_tree" != "$i_tree" &&
347 test "$c_tree" != "$i_tree"
348 then
349 git diff-tree --binary $s^2^..$s^2 | git apply --cached
350 test $? -ne 0 &&
351 die 'Conflicts in index. Try without --index.'
352 unstashed_index_tree=$(git write-tree) ||
353 die 'Could not save index tree'
354 git reset
355 fi
356
357 eval "
358 GITHEAD_$w_tree='Stashed changes' &&
359 GITHEAD_$c_tree='Updated upstream' &&
360 GITHEAD_$b_tree='Version stash was based on' &&
361 export GITHEAD_$w_tree GITHEAD_$c_tree GITHEAD_$b_tree
362 "
363
364 if test -n "$GIT_QUIET"
365 then
366 GIT_MERGE_VERBOSITY=0 && export GIT_MERGE_VERBOSITY
367 fi
368 if git merge-recursive $b_tree -- $c_tree $w_tree
369 then
370 # No conflict
371 if test -n "$unstashed_index_tree"
372 then
373 git read-tree "$unstashed_index_tree"
374 else
375 a="$TMP-added" &&
376 git diff-index --cached --name-only --diff-filter=A $c_tree >"$a" &&
377 git read-tree --reset $c_tree &&
378 git update-index --add --stdin <"$a" ||
379 die "Cannot unstage modified files"
380 rm -f "$a"
381 fi
382 squelch=
383 if test -n "$GIT_QUIET"
384 then
385 squelch='>/dev/null 2>&1'
386 fi
387 eval "git status $squelch" || :
388 else
389 # Merge conflict; keep the exit status from merge-recursive
390 status=$?
391 if test -n "$INDEX_OPTION"
392 then
393 echo >&2 'Index was not unstashed.'
394 fi
395 exit $status
396 fi
397}
398
399pop_stash() {
400 assert_stash_ref "$@"
401
402 apply_stash "$@" &&
403 drop_stash "$@"
404}
405
406drop_stash () {
407 assert_stash_ref "$@"
408
409 git reflog delete --updateref --rewrite "${REV}" &&
410 say "Dropped ${REV} ($s)" || die "${REV}: Could not drop stash entry"
411
412 # clear_stash if we just dropped the last stash entry
413 git rev-parse --verify "$ref_stash@{0}" > /dev/null 2>&1 || clear_stash
414}
415
416apply_to_branch () {
417 test -n "$1" || die 'No branch name specified'
418 branch=$1
419 shift 1
420
421 set -- --index "$@"
422 assert_stash_like "$@"
423
424 git checkout -b $branch $REV^ &&
425 apply_stash "$@" && {
426 test -z "$IS_STASH_REF" || drop_stash "$@"
427 }
428}
429
430PARSE_CACHE='--not-parsed'
431# The default command is "save" if nothing but options are given
432seen_non_option=
433for opt
434do
435 case "$opt" in
436 -*) ;;
437 *) seen_non_option=t; break ;;
438 esac
439done
440
441test -n "$seen_non_option" || set "save" "$@"
442
443# Main command set
444case "$1" in
445list)
446 shift
447 list_stash "$@"
448 ;;
449show)
450 shift
451 show_stash "$@"
452 ;;
453save)
454 shift
455 save_stash "$@"
456 ;;
457apply)
458 shift
459 apply_stash "$@"
460 ;;
461clear)
462 shift
463 clear_stash "$@"
464 ;;
465create)
466 if test $# -gt 0 && test "$1" = create
467 then
468 shift
469 fi
470 create_stash "$*" && echo "$w_commit"
471 ;;
472drop)
473 shift
474 drop_stash "$@"
475 ;;
476pop)
477 shift
478 pop_stash "$@"
479 ;;
480branch)
481 shift
482 apply_to_branch "$@"
483 ;;
484*)
485 case $# in
486 0)
487 save_stash &&
488 say '(To restore them type "git stash apply")'
489 ;;
490 *)
491 usage
492 esac
493 ;;
494esac