tg.sh

   1 #!/bin/sh
   2 # TopGit - A different patch queue manager
   3 # Copyright (C) 2008 Petr Baudis <pasky@suse.cz>
   4 # Copyright (C) 2014-2019 Kyle J. McKay <mackyle@gmail.com>
   5 # All rights reserved.
   6 # GPLv2
   7
   8 TG_VERSION="0.19.13-PRE"
   9
  10 # Update in Makefile if you add any code that requires a newer version of git
  11 GIT_MINIMUM_VERSION="@mingitver@"
  12
  13 ## SHA-1 pattern
  14
  15 octet='[0-9a-f][0-9a-f]'
  16 octet4="$octet$octet$octet$octet"
  17 octet19="$octet4$octet4$octet4$octet4$octet$octet$octet"
  18 octet20="$octet4$octet4$octet4$octet4$octet4"
  19 nullsha="0000000000000000000000000000000000000000" # :|git mktree|tr 0-9a-f 0
  20 mtblob="e69de29bb2d1d6434b8b29ae775ad8c2e48c5391" # :|git hash-object --stdin -w
  21 tab='   '
  22 lf='
  23 '
  24
  25 ## Auxiliary functions
  26
  27 # some ridiculous sh implementations require 'trap ... EXIT' to be executed
  28 # OUTSIDE ALL FUNCTIONS to work in a sane fashion.  Always trap it and eval
  29 # "${TRAPEXIT_:-exit}" as a substitute.
  30 trapexit_()
  31 {
  32         EXITCODE_=${1:-$?}
  33         trap - EXIT
  34         eval "${TRAPEXIT_:-exit $EXITCODE_}"
  35         exit $EXITCODE_
  36 }
  37 trap 'trapexit_ $?' EXIT
  38
  39 # unset that ignores error code that shouldn't be produced according to POSIX
  40 unset_()
  41 {
  42         { unset "$@"; } >/dev/null 2>&1 || :
  43 }
  44
  45 # Preserves current $? value while triggering a non-zero set -e exit if active
  46 # This works even for shells that sometimes fail to correctly trigger a -e exit
  47 check_exit_code()
  48 {
  49         return $?
  50 }
  51
  52 # This is the POSIX equivalent of which
  53 cmd_path()
  54 (
  55         { "unset" -f command unset unalias "$1"; } >/dev/null 2>&1 || :
  56         { "unalias" -a || unalias -m "*"; } >/dev/null 2>&1 || :
  57         command -v "$1"
  58 )
  59
  60 # helper for wrappers
  61 # note deliberate use of '(' ... ')' rather than '{' ... '}'
  62 exec_lc_all_c()
  63 (
  64         { "unset" -f "$1" || :; } >/dev/null 2>&1 &&
  65         shift &&
  66         LC_ALL="C" &&
  67         export LC_ALL &&
  68         exec "$@"
  69 )
  70
  71 # These tools work better for us with LC_ALL=C and by using these little
  72 # convenience functions LC_ALL=C does not have to appear in the code but
  73 # any Git translations will still appear for Git commands
  74 awk()   { exec_lc_all_c awk @AWK_PATH@  "$@"; }
  75 cat()   { exec_lc_all_c cat cat         "$@"; }
  76 cmp()   { exec_lc_all_c cmp cmp         "$@"; }
  77 cut()   { exec_lc_all_c cut cut         "$@"; }
  78 find()  { exec_lc_all_c find find       "$@"; }
  79 grep()  { exec_lc_all_c grep grep       "$@"; }
  80 join()  { exec_lc_all_c join join       "$@"; }
  81 paste() { exec_lc_all_c paste paste     "$@"; }
  82 sed()   { exec_lc_all_c sed sed         "$@"; }
  83 sort()  { exec_lc_all_c sort sort       "$@"; }
  84 tr()    { exec_lc_all_c tr tr           "$@"; }
  85 wc()    { exec_lc_all_c wc wc           "$@"; }
  86 xargs() { exec_lc_all_c xargs xargs     "$@"; }
  87
  88 # Output arguments without any possible interpretation
  89 # (Avoid misinterpretation of '\' characters or leading "-n", "-E" or "-e")
  90 echol()
  91 {
  92         printf '%s\n' "$*"
  93 }
  94
  95 info()
  96 {
  97         echol "${TG_RECURSIVE}${tgname:-tg}: $*"
  98 }
  99
 100 warn()
 101 {
 102         info "warning: $*" >&2
 103 }
 104
 105 err()
 106 {
 107         info "error: $*" >&2
 108 }
 109
 110 fatal()
 111 {
 112         info "fatal: $*" >&2
 113 }
 114
 115 die()
 116 {
 117         fatal "$@"
 118         exit 1
 119 }
 120
 121 # shift off first arg then return "$*" properly quoted in single-quotes
 122 # if $1 was '' output goes to stdout otherwise it's assigned to $1
 123 # the final \n, if any, is omitted from the result but any others are included
 124 v_quotearg()
 125 {
 126         _quotearg_v="$1"
 127         shift
 128         set -- "$_quotearg_v" \
 129         "sed \"s/'/'\\\\\\''/g;1s/^/'/;\\\$s/\\\$/'/;s/'''/'/g;1s/^''\\(.\\)/\\1/\"" "$*"
 130         unset_ _quotearg_v
 131         if [ -z "$3" ]; then
 132                 if [ -z "$1" ]; then
 133                         echo "''"
 134                 else
 135                         eval "$1=\"''\""
 136                 fi
 137         else
 138                 if [ -z "$1" ]; then
 139                         printf "%s$4" "$3" | eval "$2"
 140                 else
 141                         eval "$1="'"$(printf "%s$4" "$3" | eval "$2")"'
 142                 fi
 143         fi
 144 }
 145
 146 # same as v_quotearg except there's no extra $1 so output always goes to stdout
 147 quotearg()
 148 {
 149         v_quotearg '' "$@"
 150 }
 151
 152 vcmp()
 153 {
 154         # Compare $1 to $3 each of which must match ^[^0-9]*\d*(\.\d*)*.*$
 155         # where only the "\d*" parts in the regex participate in the comparison
 156         # Since EVERY string matches that regex this function is easy to use
 157         # An empty string ('') for $1 or $3 or any "\d*" part is treated as 0
 158         # $2 is a compare op '<', '<=', '=', '==', '!=', '>=', '>'
 159         # Return code is 0 for true, 1 for false (or unknown compare op)
 160         # There is NO difference in behavior between '=' and '=='
 161         # Note that "vcmp 1.8 == 1.8.0.0.0.0" correctly returns 0
 162         set -- "$1" "$2" "$3" "${1%%[0-9]*}" "${3%%[0-9]*}"
 163         set -- "${1#"$4"}" "$2" "${3#"$5"}"
 164         set -- "${1%%[!0-9.]*}" "$2" "${3%%[!0-9.]*}"
 165         while
 166                 vcmp_a_="${1%%.*}"
 167                 vcmp_b_="${3%%.*}"
 168                 [ "z$vcmp_a_" != "z" ] || [ "z$vcmp_b_" != "z" ]
 169         do
 170                 if [ "${vcmp_a_:-0}" -lt "${vcmp_b_:-0}" ]; then
 171                         unset_ vcmp_a_ vcmp_b_
 172                         case "$2" in "<"|"<="|"!=") return 0; esac
 173                         return 1
 174                 elif [ "${vcmp_a_:-0}" -gt "${vcmp_b_:-0}" ]; then
 175                         unset_ vcmp_a_ vcmp_b_
 176                         case "$2" in ">"|">="|"!=") return 0; esac
 177                         return 1;
 178                 fi
 179                 vcmp_a_="${1#$vcmp_a_}"
 180                 vcmp_b_="${3#$vcmp_b_}"
 181                 set -- "${vcmp_a_#.}" "$2" "${vcmp_b_#.}"
 182         done
 183         unset_ vcmp_a_ vcmp_b_
 184         case "$2" in "="|"=="|"<="|">=") return 0; esac
 185         return 1
 186 }
 187
 188 # true if "$1" is an existing dir and is empty except for
 189 # any additional files given as extra arguments.  If "$2"
 190 # is the single character "." then all ".*" files will be
 191 # ignored for the test (plus any further args, if any)
 192 is_empty_dir() {
 193         test -n "$1" && test -d "$1" || return 1
 194         iedd_="$1"
 195         shift
 196         ieddnok_='\.?$'
 197         if [ z"$1" = z"." ]; then
 198                 ieddnok_=
 199                 shift
 200                 while ! case "$1" in "."*) ! :; esac; do shift; done
 201         fi
 202         if [ $# -eq 0 ]; then
 203                 ! \ls -a1 "$iedd_" | grep -q -E -v '^\.'"$ieddnok_"
 204         else
 205                 # we only handle ".git" right now for efficiency
 206                 [ z"$*" = z".git" ] || {
 207                         fatal "[BUG] is_empty_dir not implemented for arguments: $*"
 208                         exit 70
 209                 }
 210                 ! \ls -a1 "$iedd_" | grep -q -E -v -i -e '^\.\.?$' -e '^\.git$'
 211         fi
 212 }
 213
 214 precheck() {
 215         if ! git_version="$(git version)"; then
 216                 die "'git version' failed"
 217         fi
 218         case "$git_version" in [Gg]"it version "*);;*)
 219                 die "'git version' output does not start with 'git version '"
 220         esac
 221
 222         vcmp "$git_version" '>=' "$GIT_MINIMUM_VERSION" ||
 223                 die "git version >= $GIT_MINIMUM_VERSION required but found $git_version instead"
 224 }
 225
 226 case "$1" in version|--version|-V)
 227         echo "TopGit version $TG_VERSION"
 228         exit 0
 229 esac
 230
 231 [ $# -eq 1 ] && [ "$1" = "--make-empty-blob" ] || precheck
 232 [ $# -ne 1 ] || [ "$1" != "precheck" ] || exit 0
 233
 234 cat_depsmsg_internal()
 235 {
 236         v_ref_exists_rev _rev "refs/heads/$1" || return 0
 237         if [ -s "$tg_cache_dir/refs/heads/$1/.$2" ]; then
 238                 if read _rev_match && [ "$_rev" = "$_rev_match" ]; then
 239                         _line=
 240                         while IFS= read -r _line || [ -n "$_line" ]; do
 241                                 printf '%s\n' "$_line"
 242                         done
 243                         return 0
 244                 fi <"$tg_cache_dir/refs/heads/$1/.$2"
 245         fi
 246         [ -d "$tg_cache_dir/refs/heads/$1" ] || mkdir -p "$tg_cache_dir/refs/heads/$1" 2>/dev/null || :
 247         if [ -d "$tg_cache_dir/refs/heads/$1" ]; then
 248                 printf '%s\n' "$_rev" >"$tg_cache_dir/refs/heads/$1/.$2"
 249                 _line=
 250                 git cat-file blob "$_rev:.$2" 2>/dev/null |
 251                 while IFS= read -r _line || [ -n "$_line" ]; do
 252                         printf '%s\n' "$_line" >&3
 253                         printf '%s\n' "$_line"
 254                 done 3>>"$tg_cache_dir/refs/heads/$1/.$2"
 255         else
 256                 git cat-file blob "$_rev:.$2" 2>/dev/null
 257         fi
 258 }
 259
 260 # cat_deps BRANCHNAME
 261 # Caches result
 262 cat_deps()
 263 {
 264         cat_depsmsg_internal "$1" topdeps
 265 }
 266
 267 # cat_msg BRANCHNAME
 268 # Caches result
 269 cat_msg()
 270 {
 271         cat_depsmsg_internal "$1" topmsg
 272 }
 273
 274 # cat_file TOPIC:PATH [FROM]
 275 # cat the file PATH from branch TOPIC when FROM is empty.
 276 # FROM can be -i or -w, than the file will be from the index or worktree,
 277 # respectively. The caller should than ensure that HEAD is TOPIC, to make sense.
 278 cat_file()
 279 {
 280         path="$1"
 281         case "$2" in
 282         -w)
 283                 cat "$root_dir/${path#*:}"
 284                 ;;
 285         -i)
 286                 # ':file' means cat from index
 287                 git cat-file blob ":${path#*:}" 2>/dev/null
 288                 ;;
 289         '')
 290                 case "$path" in
 291                 refs/heads/*:.topdeps)
 292                         _temp="${path%:.topdeps}"
 293                         cat_deps "${_temp#refs/heads/}"
 294                         ;;
 295                 refs/heads/*:.topmsg)
 296                         _temp="${path%:.topmsg}"
 297                         cat_msg "${_temp#refs/heads/}"
 298                         ;;
 299                 *)
 300                         git cat-file blob "$path" 2>/dev/null
 301                         ;;
 302                 esac
 303                 ;;
 304         *)
 305                 die "Wrong argument to cat_file: '$2'"
 306                 ;;
 307         esac
 308 }
 309
 310 # if use_alt_temp_odb and tg_use_alt_odb are true try to write the object(s)
 311 # into the temporary alt odb area instead of the usual location
 312 git_temp_alt_odb_cmd()
 313 {
 314         if [ -n "$use_alt_temp_odb" ] && [ -n "$tg_use_alt_odb" ] &&
 315            [ -n "$TG_OBJECT_DIRECTORY" ] &&
 316            [ -f "$TG_OBJECT_DIRECTORY/info/alternates" ]; then
 317                 (
 318                         GIT_ALTERNATE_OBJECT_DIRECTORIES="$TG_PRESERVED_ALTERNATES"
 319                         GIT_OBJECT_DIRECTORY="$TG_OBJECT_DIRECTORY"
 320                         unset_ TG_OBJECT_DIRECTORY TG_PRESERVED_ALTERNATES
 321                         export GIT_ALTERNATE_OBJECT_DIRECTORIES GIT_OBJECT_DIRECTORY
 322                         git "$@"
 323                 )
 324         else
 325                 git "$@"
 326         fi
 327 }
 328
 329 git_write_tree() { git_temp_alt_odb_cmd write-tree "$@"; }
 330 git_mktree() { git_temp_alt_odb_cmd mktree "$@"; }
 331
 332 make_mtblob() {
 333         use_alt_temp_odb=1
 334         tg_use_alt_odb=1
 335         git_temp_alt_odb_cmd hash-object -t blob -w --stdin </dev/null >/dev/null 2>&1
 336 }
 337 # short-circuit this for speed
 338 [ $# -ne 1 ] || [ "$1" != "--make-empty-blob" ] || { make_mtblob || :; exit 0; }
 339
 340 # get tree for the committed topic (second arg)
 341 # store result in variable named by first arg
 342 v_get_tree_()
 343 {
 344         eval "$1="'"refs/heads/$2"'
 345 }
 346
 347 # get tree for the base (second arg)
 348 # store result in variable named by first arg
 349 v_get_tree_b()
 350 {
 351         eval "$1="'"refs/$topbases/$2"'
 352 }
 353
 354 # get tree for the index
 355 # store result in variable named by first arg
 356 v_get_tree_i()
 357 {
 358         eval "$1="'"$(git_write_tree)"'
 359 }
 360
 361 # get tree for the worktree
 362 # store result in variable named by first arg
 363 v_get_tree_w()
 364 {
 365         eval "$1="'"$(
 366                 i_tree="$(git_write_tree)"
 367                 # the file for --index-output needs to sit next to the
 368                 # current index file
 369                 cd "$root_dir"
 370                 : ${GIT_INDEX_FILE:="$git_dir/index"}
 371                 TMP_INDEX="$(mktemp "${GIT_INDEX_FILE}-tg.XXXXXX")"
 372                 git read-tree -m "$i_tree" --index-output="$TMP_INDEX" &&
 373                 GIT_INDEX_FILE="$TMP_INDEX" &&
 374                 export GIT_INDEX_FILE &&
 375                 git diff --name-only -z HEAD |
 376                         git update-index -z --add --remove --stdin &&
 377                 git_write_tree &&
 378                 rm -f "$TMP_INDEX"
 379         )"'
 380 }
 381
 382 # get tree for arbitrary ref (second arg)
 383 # store result in variable named by first arg
 384 v_get_tree_r()
 385 {
 386         eval "$1="'"$2"'
 387 }
 388
 389 # v_strip_ref answer "$(git symbolic-ref HEAD)"
 390 # Output will have a leading refs/heads/ or refs/$topbases/ stripped if present
 391 # store result in variable named by first arg
 392 v_strip_ref()
 393 {
 394         case "$2" in
 395                 refs/"$topbases"/*)
 396                         eval "$1="'"${2#refs/$topbases/}"'
 397                         ;;
 398                 refs/heads/*)
 399                         eval "$1="'"${2#refs/heads/}"'
 400                         ;;
 401                 *)
 402                         eval "$1="'"$2"'
 403         esac
 404 }
 405
 406 # v_pretty_tree answer [-t] NAME [-b | -i | -w | -r]
 407 # Output tree ID of a cleaned-up tree without tg's artifacts.
 408 # NAME will be ignored for -i and -w, but needs to be present
 409 # With -r NAME must be a full ref name to a treeish (it's used as-is)
 410 # If -t is used the tree is written into the alternate temporary objects area
 411 # store result in variable named by first arg
 412 v_pretty_tree()
 413 {
 414         _vname="$1"
 415         shift
 416         use_alt_temp_odb=
 417         [ "$1" != "-t" ] || { shift; use_alt_temp_odb=1; }
 418         eval "v_get_tree_${2#?}" _tree '"$1"'
 419         eval "$_vname=\"\$(
 420                 git ls-tree --full-tree \"\$_tree\" |
 421                 sed -ne '/      \.top.*\$/!p' |
 422                 git_mktree
 423         )\""
 424 }
 425
 426 # return an empty-tree root commit -- date is either passed in or current
 427 # If passed in "$*" must be epochsecs followed by optional hhmm offset (+0000 default)
 428 # An invalid secs causes the current date to be used, an invalid zone offset
 429 # causes +0000 to be used
 430 make_empty_commit()
 431 (
 432         # the empty tree is guaranteed to always be there even in a repo with
 433         # zero objects, but for completeness we force it to exist as a real object
 434         SECS=
 435         read -r SECS ZONE JUNK <<-EOT || :
 436                 $*
 437                 EOT
 438         case "$SECS" in *[!0-9]*) SECS=; esac
 439         if [ -z "$SECS" ]; then
 440                 MTDATE="$(date '+%s %z')"
 441         else
 442                 case "$ZONE" in
 443                         -[01][0-9][0-5][0-9]|+[01][0-9][0-5][0-9])
 444                                 ;;
 445                         [01][0-9][0-5][0-9])
 446                                 ZONE="+$ZONE"
 447                                 ;;
 448                         *)
 449                                 ZONE="+0000"
 450                 esac
 451                 MTDATE="$SECS $ZONE"
 452         fi
 453         EMPTYID="- <-> $MTDATE"
 454         EMPTYTREE="$(git hash-object -t tree -w --stdin < /dev/null)"
 455         printf '%s\n' "tree $EMPTYTREE" "author $EMPTYID" "committer $EMPTYID" '' |
 456         git hash-object -t commit -w --stdin
 457 )
 458
 459 # standard input is a diff
 460 # standard output is the "+" lines with leading "+ " removed
 461 # beware that old lines followed by the dreaded '\ No newline at end of file'
 462 # will appear to be new lines if lines are added after them
 463 # the git diff --ignore-space-at-eol option can be used to prevent this
 464 diff_added_lines()
 465 {
 466         awk '
 467 BEGIN      { in_hunk = 0; }
 468 /^@@ /     { in_hunk = 1; }
 469 /^\+/      { if (in_hunk == 1) printf("%s\n", substr($0, 2)); }
 470 !/^\\ No newline at end of file/ &&
 471 /^[^@ +-]/ { in_hunk = 0; }
 472 '
 473 }
 474
 475 # $1 is name of new branch to create locally if all of these are true:
 476 #   a) exists as a remote TopGit branch for "$base_remote"
 477 #   b) the branch "name" does not have any invalid characters in it
 478 #   c) neither of the two branch refs (branch or base) exist locally
 479 # returns success only if a new local branch was created (and dumps message)
 480 auto_create_local_remote()
 481 {
 482         case "$1" in ""|*[" $tab$lf~^:\\*?["]*|.*|*/.*|*.|*./|/*|*/|*//*) return 1; esac
 483         [ -n "$base_remote" ] &&
 484         git update-ref --stdin <<-EOT >/dev/null 2>&1 &&
 485                 verify refs/remotes/$base_remote/${topbases#heads/}/$1 refs/remotes/$base_remote/${topbases#heads/}/$1
 486                 verify refs/remotes/$base_remote/$1 refs/remotes/$base_remote/$1
 487                 create refs/$topbases/$1 refs/remotes/$base_remote/${topbases#heads/}/$1^0
 488                 create refs/heads/$1 refs/remotes/$base_remote/$1^0
 489         EOT
 490         { init_reflog "refs/$topbases/$1" || :; } &&
 491         info "topic branch '$1' automatically set up from remote '$base_remote'"
 492 }
 493
 494 is_writable_hook()
 495 {
 496         if [ -n "$1" ] && [ -e "$1" ] && [ ! -L "$1" ] && [ -f "$1" ] && [ -r "$1" ] && [ -w "$1" ] && [ -x "$1" ]; then
 497                 hook_links="$(ls -ld "$1" 2>/dev/null | awk '{print $2}')" || :
 498                 [ "$hook_links" != "1" ] || return 0
 499         fi
 500         return 1
 501 }
 502
 503 # setup_hook NAME
 504 setup_hook()
 505 {
 506         setup_git_dir_is_bare
 507         [ -z "$git_dir_is_bare" ] || return 0
 508         setup_git_hooks_dir
 509         tgname="${0##*/}"
 510         hook_call="\"\$(\"$tgname\" --hooks-path)\"/$1 \"\$@\""
 511         if [ -f "$git_hooks_dir/$1" ] && grep -Fq "$hook_call" "$git_hooks_dir/$1"; then
 512                 # Another job well done!
 513                 return
 514         fi
 515         # Prepare incantation
 516         hook_chain=
 517         if [ -e "$git_hooks_dir/$1" ] || [ -L "$git_hooks_dir/$1" ]; then
 518                 hook_call="$hook_call"' || exit $?'
 519                 if
 520                         ! is_writable_hook "$git_hooks_dir/$1" ||
 521                         ! sed -n 1p <"$git_hooks_dir/$1" | grep -Fqx "#!@SHELL_PATH@"
 522                 then
 523                         chain_num=
 524                         while [ -e "$git_hooks_dir/$1-chain$chain_num" ] || [ -L "$git_hooks_dir/$1-chain$chain_num" ]; do
 525                                 chain_num=$(( $chain_num + 1 ))
 526                         done
 527                         mv -f "$git_hooks_dir/$1" "$git_hooks_dir/$1-chain$chain_num"
 528                         hook_chain=1
 529                 fi
 530         else
 531                 hook_call="exec $hook_call"
 532                 [ -d "$git_hooks_dir" ] || mkdir -p "$git_hooks_dir" || :
 533         fi
 534         # Don't call hook if tg is not installed
 535         hook_call="if command -v \"$tgname\" >/dev/null 2>&1; then $hook_call; fi"
 536         # Insert call into the hook
 537         {
 538                 echol "#!@SHELL_PATH@"
 539                 echol "$hook_call"
 540                 if [ -n "$hook_chain" ]; then
 541                         echol "test -f \"\$0-chain$chain_num\" &&"
 542                         echol "test -x \"\$0-chain$chain_num\" &&"
 543                         echol "exec \"\$0-chain$chain_num\" \"\$@\" || :"
 544                 else
 545                         [ ! -s "$git_hooks_dir/$1" ] || cat "$git_hooks_dir/$1"
 546                 fi
 547         } >"$git_hooks_dir/$1+"
 548         chmod a+x "$git_hooks_dir/$1+"
 549         mv "$git_hooks_dir/$1+" "$git_hooks_dir/$1"
 550 }
 551
 552 # setup_ours (no arguments)
 553 setup_ours()
 554 {
 555         setup_git_dir_is_bare
 556         [ -z "$git_dir_is_bare" ] || return 0
 557         if [ ! -s "$git_common_dir/info/attributes" ] || ! grep -q topmsg "$git_common_dir/info/attributes"; then
 558                 [ -d "$git_common_dir/info" ] || mkdir "$git_common_dir/info"
 559                 {
 560                         echo ".topmsg   merge=ours"
 561                         echo ".topdeps  merge=ours"
 562                 } >>"$git_common_dir/info/attributes"
 563         fi
 564         if ! git config merge.ours.driver >/dev/null; then
 565                 git config merge.ours.name '"always keep ours" merge driver'
 566                 git config merge.ours.driver 'touch %A'
 567         fi
 568 }
 569
 570 # measure_branch NAME [BASE] [EXTRAHEAD...]
 571 measure_branch()
 572 {
 573         _bname="$1"; _base="$2"
 574         shift; shift
 575         if [ -z "$_base" ]; then
 576                 v_strip_ref _base "$_bname"
 577                 _base="refs/$topbases/$_base"
 578         fi
 579         # The caller should've verified $name is valid
 580         _commits="$(git rev-list --count "$_bname" "$@" ^"$_base" --)"
 581         _nmcommits="$(git rev-list --count --no-merges "$_bname" "$@" ^"$_base" --)"
 582         if [ $_commits -ne 1 ]; then
 583                 _suffix="commits"
 584         else
 585                 _suffix="commit"
 586         fi
 587         echo "$_commits/$_nmcommits $_suffix"
 588 }
 589
 590 # true if $1 is contained by (or the same as) $2
 591 # this is never slower than merge-base --is-ancestor and is often slightly faster
 592 contained_by()
 593 {
 594         [ "$(git rev-list --count --max-count=1 "$1" --not "$2" --)" = "0" ]
 595 }
 596
 597 # branch_contains B1 B2
 598 # Whether B1 is a superset of B2.
 599 branch_contains()
 600 {
 601         v_ref_exists_rev _revb1 "$1" || return 0
 602         v_ref_exists_rev _revb2 "$2" || return 0
 603         if [ -s "$tg_cache_dir/$1/.bc/$2/.d" ]; then
 604                 if read _result _rev_matchb1 _rev_matchb2 &&
 605                         [ "$_revb1" = "$_rev_matchb1" ] && [ "$_revb2" = "$_rev_matchb2" ]; then
 606                         return $_result
 607                 fi <"$tg_cache_dir/$1/.bc/$2/.d"
 608         fi
 609         [ -d "$tg_cache_dir/$1/.bc/$2" ] || mkdir -p "$tg_cache_dir/$1/.bc/$2" 2>/dev/null || :
 610         _result=0
 611         contained_by "$_revb2" "$_revb1" || _result=1
 612         if [ -d "$tg_cache_dir/$1/.bc/$2" ]; then
 613                 echo "$_result" "$_revb1" "$_revb2" >"$tg_cache_dir/$1/.bc/$2/.d"
 614         fi
 615         return $_result
 616 }
 617
 618 create_ref_dirs()
 619 {
 620         [ ! -s "$tg_tmp_dir/tg~ref-dirs-created" ] && [ -s "$tg_ref_cache" ] || return 0
 621         mkdir -p "$tg_tmp_dir/cached/refs"
 622         awk '{x=$1; sub(/^refs\//,"",x); if (x != "") {gsub(/[^A-Za-z0-9\/_.+-]/,"\\\\&",x); print x;}}' <"$tg_ref_cache" |
 623         {
 624                 cd "$tg_tmp_dir/cached/refs" &&
 625                 xargs mkdir -p
 626         }
 627         awk -v p="$tg_tmp_dir/cached/" '
 628                 NF == 2 &&
 629                 $1 ~ /^refs\/./ &&
 630                 $2 ~ /^[0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F]+$/ {
 631                         fn = p $1 "/.ref"
 632                         print "0 " $2 >fn
 633                         close(fn)
 634                 }
 635         ' <"$tg_ref_cache"
 636         echo 1 >"$tg_tmp_dir/tg~ref-dirs-created"
 637 }
 638
 639 # If the first argument is non-empty, stores "1" there if this call created the cache
 640 v_create_ref_cache()
 641 {
 642         [ -n "$tg_ref_cache" ] && ! [ -s "$tg_ref_cache" ] || return 0
 643         _remotespec=
 644         [ -z "$base_remote" ] || _remotespec="refs/remotes/$base_remote"
 645         [ -z "$1" ] || eval "$1=1"
 646         git for-each-ref --format='%(refname) %(objectname)' \
 647                 refs/heads "refs/$topbases" $_remotespec >"$tg_ref_cache"
 648         create_ref_dirs
 649 }
 650
 651 remove_ref_cache()
 652 {
 653         [ -n "$tg_ref_cache" ] && [ -s "$tg_ref_cache" ] || return 0
 654         >"$tg_ref_cache"
 655         >"$tg_ref_cache_br"
 656         >"$tg_ref_cache_rbr"
 657         >"$tg_ref_cache_ann"
 658         >"$tg_ref_cache_dep"
 659 }
 660
 661 core_abbrev_val=
 662 core_abbrev_is_setup=
 663 v_get_core_abbrev()
 664 {
 665         if [ -z "$core_abbrev_is_setup" ]; then
 666                 core_abbrev_val="$(git config --int --get core.abbrev 2>/dev/null)" || :
 667                 : "${core_abbrev_val:=7}"
 668                 [ "$core_abbrev_val" -ge 4 ] || core_abbrev_val=4
 669                 core_abbrev_is_setup=1
 670         fi
 671         eval "$1="'"$core_abbrev_val"'
 672 }
 673
 674 # setting tg_ref_cache_only to non-empty will force non-$tg_ref_cache lookups to fail
 675 rev_parse()
 676 {
 677         rev_parse_code_=1
 678         if [ -n "$tg_ref_cache" ] && [ -s "$tg_ref_cache" ]; then
 679                 rev_parse_code_=0
 680                 awk -v r="$1" 'BEGIN {e=1}; $1 == r {print $2; e=0; exit}; END {exit e}' <"$tg_ref_cache" ||
 681                 rev_parse_code_=$?
 682         fi
 683         [ $rev_parse_code_ -ne 0 ] && [ -z "$tg_ref_cache_only" ] || return $rev_parse_code_
 684         git rev-parse --quiet --verify "$1^0" -- 2>/dev/null
 685 }
 686
 687 # v_ref_exists_rev answer REF
 688 # Whether REF (second arg) is a valid ref name
 689 # REF must be fully qualified and start with refs/heads/, refs/$topbases/
 690 # or, if $base_remote is set, refs/remotes/$base_remote/
 691 # Caches result if $tg_read_only and outputs HASH on success
 692 # store result in variable named by first arg
 693 v_ref_exists_rev()
 694 {
 695         case "$2" in
 696                 refs/*)
 697                         ;;
 698                 $octet20)
 699                         eval "$1="'"$2"'
 700                         return;;
 701                 *)
 702                         die "v_ref_exists_rev requires fully-qualified ref name (given: $2)"
 703         esac
 704         [ -n "$tg_read_only" ] || { eval "$1="'"$(git rev-parse --quiet --verify "$2^0" -- 2>/dev/null)"'; return; }
 705         _result=
 706         _result_rev=
 707         { read -r _result _result_rev <"$tg_tmp_dir/cached/$2/.ref"; } 2>/dev/null || :
 708         [ -z "$_result" ] || { eval "$1="'"$_result_rev"'; return $_result; }
 709         _result=0
 710         _result_rev="$(rev_parse "$2")" || _result=$?
 711         [ -d "$tg_tmp_dir/cached/$2" ] || mkdir -p "$tg_tmp_dir/cached/$2" 2>/dev/null
 712         [ ! -d "$tg_tmp_dir/cached/$2" ] ||
 713         echo $_result $_result_rev >"$tg_tmp_dir/cached/$2/.ref" 2>/dev/null || :
 714         eval "$1="'"$_result_rev"'
 715         return $_result
 716 }
 717
 718 # Same as v_ref_exists_rev but output is abbreviated hash
 719 # Optional third argument defaults to --short but may be any --short=.../--no-short option
 720 v_ref_exists_rev_short()
 721 {
 722         case "$2" in
 723                 refs/*)
 724                         ;;
 725                 $octet20)
 726                         ;;
 727                 *)
 728                         die "v_ref_exists_rev_short requires fully-qualified ref name (given: $2)"
 729         esac
 730         if [ "${3:---short}" = "--short" ]; then
 731                 v_get_core_abbrev _shortval
 732                 set -- "$1" "$2" "--short=$_shortval"
 733         fi
 734         [ -n "$tg_read_only" ] || { eval "$1="'"$(git rev-parse --quiet --verify ${3:---short} "$2^0" -- 2>/dev/null)"'; return; }
 735         _result=
 736         _result_rev=
 737         _result_arg=
 738         { read -r _result _result_rev _result_arg <"$tg_tmp_dir/cached/$2/.rfs"; } 2>/dev/null || :
 739         [ -z "$_result" ] || [ "${_result_arg:-missing}" != "${3:---short}" ] || { eval "$1="'"$_result_rev"'; return $_result; }
 740         _result=0
 741         _result_rev="$(rev_parse "$2")" || _result=$?
 742         if [ $_result -eq 0 ]; then
 743                 _result_rev="$(git rev-parse --verify ${3:---short} --quiet "$_result_rev^0" --)"
 744                 _result=$?
 745         fi
 746         [ -d "$tg_tmp_dir/cached/$2" ] || mkdir -p "$tg_tmp_dir/cached/$2" 2>/dev/null
 747         [ ! -d "$tg_tmp_dir/cached/$2" ] ||
 748         echo $_result $_result_rev "${3:---short}" >"$tg_tmp_dir/cached/$2/.rfs" 2>/dev/null || :
 749         eval "$1="'"$_result_rev"'
 750         return $_result
 751 }
 752
 753 # ref_exists REF
 754 # Whether REF is a valid ref name
 755 # REF must be fully qualified and start with refs/heads/, refs/$topbases/
 756 # or, if $base_remote is set, refs/remotes/$base_remote/
 757 # Caches result
 758 ref_exists()
 759 {
 760         v_ref_exists_rev _dummy "$1"
 761 }
 762
 763 # v_rev_parse_tree answer REF
 764 # Runs git rev-parse REF^{tree}
 765 # Caches result if $tg_read_only
 766 # store result in variable named by first arg
 767 v_rev_parse_tree()
 768 {
 769         [ -n "$tg_read_only" ] || { eval "$1="'"$(git rev-parse --verify "$2^{tree}" -- 2>/dev/null)"'; return; }
 770         if [ -f "$tg_tmp_dir/cached/$2/.rpt" ]; then
 771                 if IFS= read -r _result <"$tg_tmp_dir/cached/$2/.rpt" && [ -n "$_result" ]; then
 772                         eval "$1="'"$_result"'
 773                         return 0
 774                 fi
 775                 return 1
 776         fi
 777         [ -d "$tg_tmp_dir/cached/$2" ] || mkdir -p "$tg_tmp_dir/cached/$2" 2>/dev/null || :
 778         if [ -d "$tg_tmp_dir/cached/$2" ]; then
 779                 git rev-parse --verify "$2^{tree}" -- >"$tg_tmp_dir/cached/$2/.rpt" 2>/dev/null || :
 780                 if IFS= read -r _result <"$tg_tmp_dir/cached/$2/.rpt" && [ -n "$_result" ]; then
 781                         eval "$1="'"$_result"'
 782                         return 0
 783                 fi
 784                 return 1
 785         fi
 786         eval "$1="'"$(git rev-parse --verify "$2^{tree}" -- 2>/dev/null)"'
 787 }
 788
 789 # has_remote BRANCH
 790 # Whether BRANCH has a remote equivalent (accepts ${topbases#heads/}/ too)
 791 has_remote()
 792 {
 793         [ -n "$base_remote" ] && ref_exists "refs/remotes/$base_remote/$1"
 794 }
 795
 796 # Return the verified TopGit branch name for "$2" in "$1" or die with an error.
 797 # If -z "$1" still set return code but do not return result
 798 # As a convenience, if HEAD or @ is given and HEAD is a symbolic ref to
 799 # refs/heads/... then ... will be verified instead.
 800 # if "$3" = "-f" (for fail) then return an error rather than dying.
 801 v_verify_topgit_branch()
 802 {
 803         if [ "$2" = "HEAD" ] || [ "$2" = "@" ]; then
 804                 _verifyname="$(git symbolic-ref HEAD 2>/dev/null)" || :
 805                 [ -n "$_verifyname" ] || [ "$3" = "-f" ] || die "HEAD is not a symbolic ref"
 806                 case "$_verifyname" in refs/"$topbases"/*|refs/heads/*);;*)
 807                         [ "$3" != "-f" ] || return 1
 808                         die "HEAD is not a symbolic ref to the refs/heads namespace"
 809                 esac
 810                 set -- "$1" "$_verifyname" "$3"
 811         fi
 812         case "$2" in
 813                 refs/"$topbases"/*)
 814                         _verifyname="${2#refs/$topbases/}"
 815                         ;;
 816                 refs/heads/*)
 817                         _verifyname="${2#refs/heads/}"
 818                         ;;
 819                 *)
 820                         _verifyname="$2"
 821                         ;;
 822         esac
 823         if ! ref_exists "refs/heads/$_verifyname"; then
 824                 [ "$3" != "-f" ] || return 1
 825                 die "no such branch: $_verifyname"
 826         fi
 827         if ! ref_exists "refs/$topbases/$_verifyname"; then
 828                 [ "$3" != "-f" ] || return 1
 829                 die "not a TopGit-controlled branch: $_verifyname"
 830         fi
 831         [ -z "$1" ] || eval "$1="'"$_verifyname"'
 832 }
 833
 834 # Caches result
 835 # $1 = branch name (i.e. "t/foo/bar")
 836 # $2 = optional result of rev-parse "refs/heads/$1"
 837 # $3 = optional result of rev-parse "refs/$topbases/$1"
 838 branch_annihilated()
 839 {
 840         _branch_name="$1"
 841         _rev="$2"
 842         [ -n "$_rev" ] || v_ref_exists_rev _rev "refs/heads/$_branch_name"
 843         _rev_base="$3"
 844         [ -n "$_rev_base" ] || v_ref_exists_rev _rev_base "refs/$topbases/$_branch_name"
 845
 846         _result=
 847         _result_rev=
 848         _result_rev_base=
 849         { read -r _result _result_rev _result_rev_base <"$tg_cache_dir/refs/heads/$_branch_name/.ann"; } 2>/dev/null || :
 850         [ -z "$_result" ] || [ "$_result_rev" != "$_rev" ] || [ "$_result_rev_base" != "$_rev_base" ] || return $_result
 851
 852         # use the merge base in case the base is ahead.
 853         _mb="$(git merge-base "$_rev_base" "$_rev" 2>/dev/null)" || :
 854
 855         _result=0
 856         if [ -n "$_mb" ]; then
 857                 v_rev_parse_tree _mbtree "$_mb"
 858                 v_rev_parse_tree _revtree "$_rev"
 859                 test "$_mbtree" = "$_revtree" || _result=1
 860         fi
 861         [ -d "$tg_cache_dir/refs/heads/$_branch_name" ] || mkdir -p "$tg_cache_dir/refs/heads/$_branch_name" 2>/dev/null
 862         [ ! -d "$tg_cache_dir/refs/heads/$_branch_name" ] ||
 863         echo $_result $_rev $_rev_base >"$tg_cache_dir/refs/heads/$_branch_name/.ann" 2>/dev/null || :
 864         return $_result
 865 }
 866
 867 non_annihilated_branches()
 868 {
 869         refscacheopt="${TG_DEBUG:+-p=\"\$tg_ref_cache.pre\" }"
 870         if [ -n "$tg_read_only" ] && [ -n "$tg_ref_cache" ] && [ -s "$tg_ref_cache" ]; then
 871                 refscacheopt="$refscacheopt"'-r="$tg_ref_cache" "refs/$topbases"'
 872         fi
 873         eval run_awk_topgit_branches -n "$refscacheopt" '"refs/$topbases" "$@"'
 874 }
 875
 876 # Make sure our tree is clean
 877 # if optional "$1" given also verify that a checkout to "$1" would succeed
 878 ensure_clean_tree()
 879 {
 880         check_status
 881         [ -z "$tg_state$git_state" ] || { do_status; exit 1; }
 882         git update-index --ignore-submodules --refresh ||
 883                 die "the working directory has uncommitted changes (see above) - first commit or reset them"
 884         [ -z "$(git diff-index --cached --name-status -r --ignore-submodules HEAD --)" ] ||
 885                 die "the index has uncommited changes"
 886         [ -z "$1" ] || git read-tree -n -u -m "$1" ||
 887                 die "git checkout \"$1\" would fail"
 888 }
 889
 890 # Make sure .topdeps and .topmsg are "clean"
 891 # They are considered "clean" if each is identical in worktree, index and HEAD
 892 # With "-u" as the argument skip the HEAD check (-u => unborn)
 893 # untracked .topdeps and/or .topmsg files are always considered "dirty" as well
 894 # with -u them just existing constitutes "dirty"
 895 ensure_clean_topfiles()
 896 {
 897         _dirtw=0
 898         _dirti=0
 899         _dirtu=0
 900         _check="$(git diff-files --ignore-submodules --name-only -- :/.topdeps :/.topmsg)" &&
 901         [ -z "$_check" ] || _dirtw=1
 902         if [ "$1" != "-u" ]; then
 903                 _check="$(git diff-index --cached --ignore-submodules --name-only HEAD -- :/.topdeps :/.topmsg)" &&
 904                 [ -z "$_check" ] || _dirti=1
 905         fi
 906         if [ "$_dirti$_dirtw" = "00" ]; then
 907                 v_get_show_cdup
 908                 if [ -e "${git_cdup_result}.topdeps" ] || [ -e "${git_cdup_result}.topmsg" ]; then
 909                         [ "$1" != "-u" ] &&
 910                         _check="$(git status --porcelain --ignored --untracked-files --ignore-submodules -- :/.topdeps :/.topmsg)" &&
 911                         [ -z "$_check" ] || _dirtu=1
 912                 fi
 913         fi
 914         if [ "$_dirtu$_dirti$_dirtw" != "000" ]; then
 915                 git status --ignored --untracked-files --ignore-submodules -- :/.topdeps :/.topmsg || :
 916                 case "$_dirtu$_dirti$_dirtw" in
 917                 001) die "the working directory has uncommitted changes (see above) - first commit or reset them";;
 918                 010) die "the index has uncommited changes (see above)";;
 919                 011) die "the working directory and index have uncommitted changes (see above) - first commit or reset them";;
 920                 100) die "the working directory has untracked files that would be overwritten (see above)";;
 921                 esac
 922         fi
 923 }
 924
 925 # is_sha1 REF
 926 # Whether REF is a SHA1 (compared to a symbolic name).
 927 is_sha1()
 928 {
 929         case "$1" in $octet20) return 0;; esac
 930         return 1
 931 }
 932
 933 # navigate_deps <run_awk_topgit_navigate options and arguments>
 934 # all options and arguments are passed through to run_awk_topgit_navigate
 935 # except for a leading -td= option, if any, which is picked off for deps
 936 # after arranging to feed it a suitable deps list
 937 navigate_deps()
 938 {
 939         dogfer=
 940         dorad=1
 941         userc=
 942         tmpdep=
 943         ratd_opts="${TG_DEBUG:+-p=\"\$tg_ref_cache.pre\" }"
 944         ratn_opts=
 945         if [ -n "$tg_read_only" ] && [ -n "$tg_ref_cache" ]; then
 946                 userc=1
 947                 tmprfs="$tg_ref_cache"
 948                 tmptgbr="$tg_ref_cache_br"
 949                 tmpann="$tg_ref_cache_ann"
 950                 tmpdep="$tg_ref_cache_dep"
 951                 [ -s "$tg_ref_cache" ] || dogfer=1
 952                 [ -n "$dogfer" ] || ! [ -s "$tmptgbr" ] || ! [ -f "$tmpann" ] || ! [ -s "$tmpdep" ] || dorad=
 953         else
 954                 ratd_opts="${ratd_opts}-rmr"
 955                 ratn_opts="-rma -rmb"
 956                 tmprfs="$tg_tmp_dir/refs.$$"
 957                 tmpann="$tg_tmp_dir/ann.$$"
 958                 tmptgbr="$tg_tmp_dir/tgbr.$$"
 959                 dogfer=1
 960         fi
 961         refpats="\"refs/heads\" \"refs/\$topbases\""
 962         [ -z "$base_remote" ] || refpats="$refpats \"refs/remotes/\$base_remote\""
 963         [ -z "$dogfer" ] ||
 964         eval git for-each-ref '--format="%(refname) %(objectname)"' "$refpats" >"$tmprfs"
 965         depscmd="run_awk_topgit_deps $ratd_opts"
 966         case "$1" in -td=*)
 967                 userc=
 968                 depscmd="$depscmd $1"
 969                 shift
 970         esac
 971         depscmd="$depscmd"' -a="$tmpann" -b="$tmptgbr" -r="$tmprfs" -s "refs/$topbases"'
 972         if [ -n "$userc" ]; then
 973                 if [ -n "$dorad" ]; then
 974                         eval "$depscmd" >"$tmpdep"
 975                 fi
 976                 depscmd='<"$tmpdep" '
 977         else
 978                 depscmd="$depscmd |"
 979         fi
 980         eval "$depscmd" run_awk_topgit_navigate '-a="$tmpann" -b="$tmptgbr"' "$ratn_opts" '"$@"'
 981 }
 982
 983 # recurse_deps_internal NAME [BRANCHPATH...]
 984 # get recursive list of dependencies with leading 0 if branch exists 1 if missing
 985 # followed by a 1 if the branch is "tgish" (2 if it also has a remote); 0 if not
 986 # followed by a 0 for a non-leaf, 1 for a leaf or 2 for annihilated tgish
 987 # (but missing and remotes are always "0")
 988 # followed by a 0 for no excess visits or a positive number of excess visits
 989 # then the branch name followed by its depedency chain (which might be empty)
 990 # An output line might look like this:
 991 #   0 1 1 0 t/foo/leaf t/foo/int t/stage
 992 # If no_remotes is non-empty, exclude remotes
 993 # If recurse_preorder is non-empty, do a preorder rather than postorder traversal
 994 # If with_top_level is non-empty, include the top-level that's normally omitted
 995 # If with_deps_opts is non-empty, always run_awk_topgit_deps with those extra opts
 996 # any branch names in the space-separated recurse_deps_exclude variable
 997 # are skipped (along with their dependencies)
 998 unset_ no_remotes recurse_preorder with_top_level with_deps_opts
 999 recurse_deps_internal()
1000 {
1001         case " $recurse_deps_exclude " in *" $1 "*) return 0; esac
1002         ratr_opts="${recurse_preorder:+-f} ${with_top_level:+-s}"
1003         dogfer=
1004         dorad=1
1005         userc=
1006         tmpdep=
1007         if [ -n "$tg_read_only" ] && [ -n "$tg_ref_cache" ]; then
1008                 userc=1
1009                 tmprfs="$tg_ref_cache"
1010                 tmptgbr="$tg_ref_cache_br"
1011                 tmpann="$tg_ref_cache_ann"
1012                 tmpdep="$tg_ref_cache_dep"
1013                 [ -s "$tg_ref_cache" ] || dogfer=1
1014                 [ -n "$dogfer" ] || ! [ -s "$tmptgbr" ] || ! [ -f "$tmpann" ] || ! [ -s "$tmpdep" ] || dorad=
1015         else
1016                 ratr_opts="$ratr_opts -rmh -rma -rmb"
1017                 tmprfs="$tg_tmp_dir/refs.$$"
1018                 tmpann="$tg_tmp_dir/ann.$$"
1019                 tmptgbr="$tg_tmp_dir/tgbr.$$"
1020                 dogfer=1
1021         fi
1022         refpats="\"refs/heads\" \"refs/\$topbases\""
1023         [ -z "$base_remote" ] || refpats="$refpats \"refs/remotes/\$base_remote\""
1024         tmptgrmtbr=
1025         dorab=1
1026         if [ -z "$no_remotes" ] && [ -n "$base_remote" ]; then
1027                 if [ -n "$userc" ]; then
1028                         tmptgrmtbr="$tg_ref_cache_rbr"
1029                         [ -n "$dogfer" ] || ! [ -s "$tmptgrmtbr" ] || dorab=
1030                 else
1031                         tmptgrmtbr="$tg_tmp_dir/tgrmtbr.$$"
1032                         ratr_opts="$ratr_opts -rmr"
1033                 fi
1034                 ratr_opts="$ratr_opts -r=\"\$tmptgrmtbr\" -u=\":refs/remotes/\$base_remote/\${topbases#heads/}\""
1035         fi
1036         [ -z "$dogfer" ] ||
1037         eval git for-each-ref '--format="%(refname) %(objectname)"' "$refpats" >"$tmprfs"
1038         if [ -n "$tmptgrmtbr" ] && [ -n "$dorab" ]; then
1039                 run_awk_topgit_branches -n -h="refs/remotes/$base_remote" -r="$tmprfs" \
1040                         "refs/remotes/$base_remote/${topbases#heads/}" >"$tmptgrmtbr"
1041         fi
1042         depscmd="run_awk_topgit_deps -s${with_deps_opts:+ $with_deps_opts}${TG_DEBUG:+ -p=\"\$tg_ref_cache.pre\"}"
1043         depscmd="$depscmd"' -a="$tmpann" -b="$tmptgbr" -r="$tmprfs" "refs/$topbases"'
1044         if [ -z "$with_deps_opts" ] && [ -n "$userc" ]; then
1045                 if [ -n "$dorad" ]; then
1046                         eval "$depscmd" >"$tmpdep"
1047                 fi
1048                 depscmd='<"$tmpdep" '
1049         else
1050                 depscmd="$depscmd |"
1051         fi
1052         eval "$depscmd" run_awk_topgit_recurse '-a="$tmpann" -b="$tmptgbr"' \
1053                 '-c=1 -h="$tmprfs"' "$ratr_opts" '-x="$recurse_deps_exclude"' '"$@"'
1054 }
1055
1056 # do_eval CMD
1057 # helper for recurse_deps so that a return statement executed inside CMD
1058 # does not return from recurse_deps.  This shouldn't be necessary, but it
1059 # seems that it actually is.
1060 do_eval()
1061 {
1062         eval "$@"
1063 }
1064
1065 # becomes read-only for caching purposes
1066 # assigns new value to tg_read_only
1067 # become_cacheable/undo_become_cacheable calls may be nested
1068 become_cacheable()
1069 {
1070         _old_tg_read_only="$tg_read_only"
1071         if [ -z "$tg_read_only" ]; then
1072                 ! [ -e "$tg_tmp_dir/cached" ] && ! [ -e "$tg_tmp_dir/tg~ref-dirs-created" ] ||
1073                 rm -rf "$tg_tmp_dir/cached" "$tg_tmp_dir/tg~ref-dirs-created"
1074                 tg_read_only=1
1075         fi
1076         _my_ref_cache=
1077         v_create_ref_cache _my_ref_cache
1078         _my_ref_cache="${_my_ref_cache:+1}"
1079         tg_read_only="undo${_my_ref_cache:-0}-$_old_tg_read_only"
1080 }
1081
1082 # restores tg_read_only and ref_cache to state before become_cacheable call
1083 # become_cacheable/undo_bocome_cacheable calls may be nested
1084 undo_become_cacheable()
1085 {
1086         case "$tg_read_only" in
1087                 "undo"[01]"-"*)
1088                         _suffix="${tg_read_only#undo?-}"
1089                         [ "${tg_read_only%$_suffix}" = "undo0-" ] || remove_ref_cache
1090                         tg_read_only="$_suffix"
1091         esac
1092 }
1093
1094 # just call this, no undo, sets tg_read_only= and removes ref cache and cached results
1095 become_non_cacheable()
1096 {
1097         remove_ref_cache
1098         tg_read_only=
1099         ! [ -e "$tg_tmp_dir/cached" ] && ! [ -e "$tg_tmp_dir/tg~ref-dirs-created" ] ||
1100         rm -rf "$tg_tmp_dir/cached" "$tg_tmp_dir/tg~ref-dirs-created"
1101 }
1102
1103 # call this to make sure the current Git repository has an associated work tree
1104 # also make sure we are not in wayback mode
1105 ensure_work_tree()
1106 {
1107         [ -z "$wayback" ] ||
1108         die "the wayback machine cannot be used with the specified options"
1109         setup_git_dir_is_bare
1110         [ -n "$git_dir_is_bare" ] || return 0
1111         die "This operation must be run in a work tree"
1112 }
1113
1114 # call this to make sure Git will not complain about a missing user/email
1115 # result is cached in TG_IDENT_CHECKED and a non-empty value suppresses the check
1116 ensure_ident_available()
1117 {
1118         [ -z "$TG_IDENT_CHECKED" ] || return 0
1119         git var GIT_AUTHOR_IDENT >/dev/null &&
1120         git var GIT_COMMITTER_IDENT >/dev/null || exit
1121         TG_IDENT_CHECKED=1
1122         export TG_IDENT_CHECKED
1123         return 0
1124 }
1125
1126 # recurse_deps [-o=<options string>] CMD NAME [BRANCHPATH...]
1127 # Recursively eval CMD on all dependencies of NAME.
1128 # Dependencies are visited in topological order.
1129 # If <options string> is given, it's eval'd into the recurse_deps_internal
1130 # call just before the "--" that's passed just before NAME
1131 # CMD can refer to the following variables:
1132 #
1133 #   _ret              starts as 0; CMD can change; will be final return result
1134 #   _dep              bare branch name or ":refs/remotes/..." for a remote
1135 #   _name             has $_dep in its .topdeps ("" for top and $with_top_level)
1136 #   _depchain         0+ space-sep branch names (_name first) form a path to top
1137 #   _dep_missing      boolean "1" if no such $_dep ref; "" if ref present
1138 #   _dep_is_leaf      boolean "1" if leaf; "" if not
1139 #   _dep_is_tgish     boolean "1" if tgish; "" if not (which implies no remote)
1140 #   _dep_has_remote   boolean "1" if $_dep has_remote; "" if not
1141 #   _dep_annihilated  boolean "1" if $_dep annihilated; "" if not
1142 #   _dep_xvisits      non-negative integer number of excess visits (often 0)
1143 #
1144 # CMD may use a "return" statement without issue; its return value is ignored,
1145 # but if CMD sets _ret to a negative value, e.g. "-0" or "-1" the enumeration
1146 # will stop immediately and the value with the leading "-" stripped off will
1147 # be the final result code
1148 #
1149 # CMD can refer to $_name for queried branch name,
1150 # $_dep for dependency name,
1151 # $_depchain for space-seperated branch backtrace,
1152 # $_dep_missing boolean to check whether $_dep is present
1153 # and the $_dep_is_tgish and $_dep_annihilated booleans.
1154 # If recurse_preorder is NOT set then the $_dep_is_leaf boolean is also valid.
1155 # It can modify $_ret to affect the return value
1156 # of the whole function.
1157 # If recurse_deps() hits missing dependencies, it will append
1158 # them to space-separated $missing_deps list and skip them
1159 # after calling CMD with _dep_missing set.
1160 # remote dependencies are processed if no_remotes is unset.
1161 # any branch names in the space-separated recurse_deps_exclude variable
1162 # are skipped (along with their dependencies)
1163 #
1164 # If no_remotes is non-empty, exclude remotes
1165 # If recurse_preorder is non-empty, do a preorder rather than postorder traversal
1166 # If with_top_level is non-empty, include the top-level that's normally omitted
1167 # If with_deps_opts is non-empty, always run_awk_topgit_deps with those extra opts
1168 # any branch names in the space-separated recurse_deps_exclude variable
1169 # are skipped (along with their dependencies)
1170 recurse_deps()
1171 {
1172         _opts=
1173         case "$1" in -o=*) _opts="${1#-o=}"; shift; esac
1174         _cmd="$1"; shift
1175
1176         _depsfile="$(get_temp tg-depsfile)"
1177         eval recurse_deps_internal "$_opts" -- '"$@"' >"$_depsfile" || :
1178
1179         _ret=0
1180         while read _ismissing _istgish _isleaf _dep_xvisits _dep _name _deppath; do
1181                 _depchain="$_name${_deppath:+ $_deppath}"
1182                 _dep_is_tgish=
1183                 [ "$_istgish" = "0" ] || _dep_is_tgish=1
1184                 _dep_has_remote=
1185                 [ "$_istgish" != "2" ] || _dep_has_remote=1
1186                 _dep_missing=
1187                 if [ "$_ismissing" != "0" ]; then
1188                         _dep_missing=1
1189                         case " $missing_deps " in *" $_dep "*);;*)
1190                                 missing_deps="${missing_deps:+$missing_deps }$_dep"
1191                         esac
1192                 fi
1193                 _dep_annihilated=
1194                 _dep_is_leaf=
1195                 if [ "$_isleaf" = "1" ]; then
1196                         _dep_is_leaf=1
1197                 elif [ "$_isleaf" = "2" ]; then
1198                         _dep_annihilated=1
1199                 fi
1200                 do_eval "$_cmd" || :
1201                 if [ "${_ret#-}" != "$_ret" ]; then
1202                         _ret="${_ret#-}"
1203                         break
1204                 fi
1205         done <"$_depsfile"
1206         rm -f "$_depsfile"
1207         return ${_ret:-0}
1208 }
1209
1210 # find_leaves NAME
1211 # output (one per line) the unique leaves of NAME
1212 # a leaf is either
1213 #   1) a non-tgish dependency
1214 #   2) the base of a tgish dependency with no non-annihilated dependencies
1215 # duplicates are suppressed (by commit rev) and remotes are always ignored
1216 # if a leaf has an exact tag match that will be output
1217 # note that recurse_deps_exclude IS honored for this operation
1218 # if with_deps_opts is set it will take effect here
1219 find_leaves()
1220 {
1221         no_remotes=1
1222         with_top_level=1
1223         recurse_preorder=
1224         seen_leaf_refs=
1225         seen_leaf_revs=
1226         while read _ismissing _istgish _isleaf _xvsts _dep _name _deppath; do
1227                 [ "$_isleaf" = "1" ] && [ "$_ismissing" = "0" ] || continue
1228                 if [ "$_istgish" != "0" ]; then
1229                         fulldep="refs/$topbases/$_dep"
1230                 else
1231                         fulldep="refs/heads/$_dep"
1232                 fi
1233                 case " $seen_leaf_refs " in *" $fulldep "*);;*)
1234                         seen_leaf_refs="${seen_leaf_refs:+$seen_leaf_refs }$fulldep"
1235                         if v_ref_exists_rev fullrev "$fulldep"; then
1236                                 case " $seen_leaf_revs " in *" $fullrev "*);;*)
1237                                         seen_leaf_revs="${seen_leaf_revs:+$seen_leaf_revs }$fullrev"
1238                                         # See if Git knows it by another name
1239                                         if tagname="$(git describe --exact-match "$fullrev" 2>/dev/null)" && [ -n "$tagname" ]; then
1240                                                 echo "refs/tags/$tagname"
1241                                         else
1242                                                 echo "$fulldep"
1243                                         fi
1244                                 esac
1245                         fi
1246                 esac
1247         done <<-EOT
1248         $(recurse_deps_internal -l -o=1 -- "$1")
1249         EOT
1250         with_top_level=
1251 }
1252
1253 # branch_needs_update
1254 # This is a helper function for determining whether given branch
1255 # is up-to-date wrt. its dependencies. It expects input as if it
1256 # is called as a recurse_deps() helper.
1257 # In case the branch does need update, it will echo it together
1258 # with the branch backtrace on the output (see needs_update()
1259 # description for details) and set $_ret to non-zero.
1260 branch_needs_update()
1261 {
1262         if [ -n "$_dep_missing" ]; then
1263                 echo "! $_dep $_depchain"
1264                 return 0
1265         fi
1266
1267         if [ -n "$_dep_is_tgish" ]; then
1268                 [ -z "$_dep_annihilated" ] || return 0
1269
1270                 if [ -n "$_dep_has_remote" ]; then
1271                         branch_contains "refs/heads/$_dep" "refs/remotes/$base_remote/$_dep" || {
1272                                 echo ":refs/remotes/$base_remote/$_dep $_dep $_depchain"
1273                                 _ret=1
1274                         }
1275                 fi
1276                 # We want to sync with our base first and should output this before
1277                 # the remote branch, but the order does not actually matter to tg-update
1278                 # as it just recurses regardless, but it does matter for tg-info (which
1279                 # treats out-of-date bases as though they were already merged in) so
1280                 # we output the remote before the base.
1281                 branch_contains "refs/heads/$_dep" "refs/$topbases/$_dep" || {
1282                         echo ": $_dep $_depchain"
1283                         _ret=1
1284                         return
1285                 }
1286         fi
1287
1288         if [ -n "$_name" ]; then
1289                 case "$_dep" in :*) _fulldep="${_dep#:}";; *) _fulldep="refs/heads/$_dep";; esac
1290                 if ! branch_contains "refs/$topbases/$_name" "$_fulldep"; then
1291                         # Some new commits in _dep
1292                         echo "$_dep $_depchain"
1293                         _ret=1
1294                 fi
1295         fi
1296 }
1297
1298 # needs_update NAME
1299 # This function is recursive; it outputs reverse path from NAME
1300 # to the branch (e.g. B_DIRTY B1 B2 NAME), one path per line,
1301 # inner paths first. Innermost name can be :refs/remotes/<remote>/<name>
1302 # if the head is not in sync with the <remote> branch <name>, ':' if
1303 # the head is not in sync with the base (in this order of priority)
1304 # or '!' if dependency is missing.  Note that the remote branch, base
1305 # order is reversed from the order they will actually be updated in
1306 # order to accomodate tg info which treats out-of-date items that are
1307 # only in the base as already being in the head for status purposes.
1308 # It will also return non-zero status if NAME needs update (seems backwards
1309 # but think of it as non-zero status if any non-missing output lines produced)
1310 # If needs_update() hits missing dependencies, it will append
1311 # them to space-separated $missing_deps list and skip them.
1312 # if with_deps_opts is set it will take effect here
1313 needs_update()
1314 {
1315         recurse_deps branch_needs_update "$1"
1316 }
1317
1318 # append second arg to first arg variable gluing with space if first already set
1319 vplus()
1320 {
1321         eval "$1=\"\${$1:+\$$1 }\$2\""
1322 }
1323
1324 # true if whitespace separated first var name list contains second arg
1325 # use `vcontains 3 "value" "some list"` for a literal list
1326 vcontains()
1327 {
1328         eval case "\" \${$1} \"" in '*" $2 "*) return 0; esac; return 1'
1329 }
1330
1331 # if the $1 var does not already contain $2 it's appended
1332 vsetadd()
1333 {
1334         vcontains "$1" "$2" || vplus "$1" "$2"
1335 }
1336
1337 # reset needs_update_check results to empty
1338 needs_update_check_clear()
1339 {
1340         unset_ needs_update_processed needs_update_behind needs_update_ahead needs_update_partial
1341 }
1342
1343 # needs_update_check NAME...
1344 #
1345 # A faster version of needs_update that always succeeds
1346 # No output and unsuitable for actually performing updates themselves
1347 # If any of NAME... are NOT up-to-date AND they were not already processed
1348 # return status always will be zero however a simple check of
1349 # needs_update_behind after the call will answer the:
1350 #   "are any out of date?": test -n "$needs_update_behind"
1351 #   "is <x> out of date?":  vcontains needs_update_behind "<x>"
1352 #
1353 # Note that results are cumulative and "no_remotes" is honored as well as other
1354 # variables that modify recurse_deps_internal behavior.  See the preceding
1355 # function to reset the results to empty when accumulation should start over.
1356 #
1357 # Unlike needs_update, the branch names are themselves also checked to see if
1358 # they are out-of-date with respect to their bases or remote branches (not just
1359 # their remote bases).  However, this can muddy some status results so this
1360 # can be disabled by setting needs_update_check_no_self to a non-empty value.
1361 #
1362 # Unlike needs_update, here the remote base check is handled together with the
1363 # remote head check so if one is modified the other is too in the same way.
1364 #
1365 # Dependencies are normally considered "behind" if they need an update from
1366 # their base or remote but this can be suppressed by setting the
1367 # needs_update_check_no_same to a non-empty value.  This will NOT prevent
1368 # parents of those dependencies from still being considered behind in such a
1369 # case even though the dependency itself will not be.  Note that setting
1370 # needs_update_check_no_same also implies needs_update_check_no_self.
1371 #
1372 # The following whitespace-separated lists are updated with the results:
1373 #
1374 # if with_deps_opts is set it will take effect here
1375 #
1376 # The "no_remotes" setting is obeyed but remote names themselves will never
1377 # appear in any of the lists
1378 #
1379 #   needs_update_processed
1380 #       The branch names in here have been processed and will be skipped
1381 #
1382 #   needs_update_behind
1383 #       Any branch named in here needs an update from one or more of its
1384 #       direct or indirect dependencies (i.e. it's "out-of-date")
1385 #
1386 #   needs_update_ahead
1387 #       Any branch named in here is NOT fully contained by at least one of
1388 #       its dependents (i.e. it's a source of "out-of-date (aka dirty)"ness
1389 #
1390 #   needs_update_partial
1391 #       Any branch names in here are either missing themselves or have one
1392 #       or more detected missing dependencies (a completely missing remote
1393 #       branch is never "detected")
1394 needs_update_check()
1395 {
1396         # each head must be processed independently or else there will be
1397         # confusion about who's missing what and which branches actually are
1398         # out of date
1399         tmptgrdi="$tg_tmp_dir/tgrdi.$$"
1400         for nucname in "$@"; do
1401                 ! vcontains needs_update_processed "$nucname" || continue
1402                 # no need to fuss with recurse_deps, just use
1403                 # recurse_deps_internal directly
1404                 recurse_deps_internal -s -o=-1 "$nucname" >"$tmptgrdi"
1405                 while read -r _rdi_m _rdi_t _rdi_l _rdi_v _rdi_node _rdi_parent _rdi_chain; do
1406                         case "$_rdi_node" in ""|:*) continue; esac # empty or checked with remote
1407                         vsetadd needs_update_processed "$_rdi_node"
1408                         if [ "$_rdi_m" != "0" ]; then # missing
1409                                 vsetadd needs_update_partial "$_rdi_node"
1410                                 [ -z "$_rdi_parent" ] || vsetadd needs_update_partial "$_rdi_parent"
1411                                 continue
1412                         fi
1413                         [ "$_rdi_t$_rdi_l" != "12" ] || continue # always skip annihilated
1414                         _rdi_dertee= # :)
1415                         if [ -n "$_rdi_parent" ]; then # not a "self" line
1416                                 ! vcontains needs_update_partial "$_rdi_node" || vsetadd needs_update_partial "$_rdi_parent"
1417                                 ! vcontains needs_update_behind "$_rdi_node" || _rdi_dertee=2
1418                         else
1419                                 [ -z "$needs_update_check_no_self$needs_update_check_no_same" ] || continue # skip self
1420                         fi
1421                         if [ -z "$_rdi_dertee" ]; then
1422                                 if [ "$_rdi_t" != "0" ]; then # tgish
1423                                         if branch_contains "refs/heads/$_rdi_node" "refs/$topbases/$_rdi_node"; then
1424                                                 if [ "$_rdi_t" = "2" ]; then # will never be "2" when no_remotes is set
1425                                                         branch_contains "refs/heads/$_rdi_node" "refs/remotes/$base_remote/$_rdi_node" &&
1426                                                         branch_contains "refs/$topbases/$_rdi_node" "refs/remotes/$base_remote/${topbases#heads/}/$_rdi_node" ||
1427                                                         _rdi_dertee=3
1428                                                 fi
1429                                         else
1430                                                 _rdi_dertee=3
1431                                         fi
1432                                         [ -z "$_rdi_dertee" ] || [ -n "$needs_update_check_no_same" ] || _rdi_dertee=1
1433                                 fi
1434                         fi
1435                         [ z"$_rdi_dertee" != z"1" ] || vsetadd needs_update_behind "$_rdi_node"
1436                         [ -n "$_rdi_parent" ] || continue # self line
1437                         if ! branch_contains "refs/$topbases/$_rdi_parent" "refs/heads/$_rdi_node"; then
1438                                 _rdi_dertee=1
1439                                 vsetadd needs_update_ahead "$_rdi_node"
1440                         fi
1441                         [ -z "$_rdi_dertee" ] || vsetadd needs_update_behind "$_rdi_parent"
1442                 done <"$tmptgrdi"
1443         done
1444 }
1445
1446 # branch_empty NAME [-i | -w]
1447 branch_empty()
1448 {
1449         if [ -z "$2" ]; then
1450                 v_ref_exists_rev _rev "refs/heads/$1" || return 0
1451                 _result=
1452                 _result_rev=
1453                 { read -r _result _result_rev <"$tg_cache_dir/refs/heads/$1/.mt"; } 2>/dev/null || :
1454                 [ -z "$_result" ] || [ "$_result_rev" != "$_rev" ] || return $_result
1455                 _result=0
1456                 v_pretty_tree _pretty1 -t "$1" -b
1457                 v_pretty_tree _pretty2 -t "$1" $2
1458                 [ "$_pretty1" = "$_pretty2" ] || _result=$?
1459                 [ -d "$tg_cache_dir/refs/heads/$1" ] || mkdir -p "$tg_cache_dir/refs/heads/$1" 2>/dev/null
1460                 [ ! -d "$tg_cache_dir/refs/heads/$1" ] || echo $_result $_rev >"$tg_cache_dir/refs/heads/$1/.mt"
1461                 return $_result
1462         else
1463                 v_pretty_tree _pretty1 -t "$1" -b
1464                 v_pretty_tree _pretty2 -t "$1" $2
1465                 [ "$_pretty1" = "$_pretty2" ]
1466         fi
1467 }
1468
1469 v_get_tdmopt_internal()
1470 {
1471         [ -n "$1" ] && [ -n "$3" ] || return 0
1472         [ "$2" = "-i" ] || [ "$2" = "-w" ] || return 0
1473         ensure_work_tree
1474         _optval=
1475         if v_verify_topgit_branch _tghead "HEAD" -f; then
1476                 if [ "$2" = "-w" ] && [ -f "$root_dir/$3" ] && [ -r "$root_dir/$3" ]; then
1477                         _opthash=
1478                         if _opthash="$(git hash-object -w -t blob --stdin <"$root_dir/$3")" && [ -n "$_opthash" ]; then
1479                                 _optval="$4\"$_tghead:$_opthash\""
1480                         fi
1481                 elif [ "$2" = "-i" ]; then
1482                         if _opthash="$(git rev-parse --quiet --verify ":0:$3" --)" && [ -n "$_opthash" ]; then
1483                                 _optval="$4\"$_tghead:$_opthash\""
1484                         fi
1485                 fi
1486         fi
1487         eval "$1="'"$_optval"'
1488 }
1489
1490 # set var $1 to the correct -td= option for use in an eval for $2 -i or -w mode
1491 v_get_tdopt() { v_get_tdmopt_internal "$1" "$2" ".topdeps" "-td="; }
1492
1493 # set var $1 to the correct -tm= option for use in an eval for $2 -i or -w mode
1494 v_get_tmopt() { v_get_tdmopt_internal "$1" "$2" ".topmsg" "-tm="; }
1495
1496 # checkout_symref_full [-f] FULLREF [SEED]
1497 # Just like git checkout $iowopt -b FULLREF [SEED] except that FULLREF MUST start with
1498 # refs/ and HEAD is ALWAYS set to a symref to it and [SEED] (default is FULLREF)
1499 # MUST be a committish which if present will be used instead of current FULLREF
1500 # (and FULLREF will be updated to it as well in that case)
1501 # Any merge state is always cleared by this function
1502 # With -f it's like git checkout $iowopt -f -b FULLREF (uses read-tree --reset
1503 # instead of -m) but it will clear out any unmerged entries
1504 # As an extension, FULLREF may also be a full hash to create a detached HEAD instead
1505 checkout_symref_full()
1506 {
1507         _mode=-m
1508         _head="HEAD"
1509         if [ "$1" = "-f" ]; then
1510                 _mode="--reset"
1511                 _head=
1512                 shift
1513         fi
1514         _ishash=
1515         case "$1" in
1516                 refs/?*)
1517                         ;;
1518                 $octet20)
1519                         _ishash=1
1520                         [ -z "$2" ] || [ "$1" = "$2" ] ||
1521                                 die "programmer error: invalid checkout_symref_full \"$1\" \"$2\""
1522                         set -- HEAD "$1"
1523                         ;;
1524                 *)
1525                         die "programmer error: invalid checkout_symref_full \"$1\""
1526                         ;;
1527         esac
1528         _seedrev="$(git rev-parse --quiet --verify "${2:-$1}^0" --)" ||
1529                 die "invalid committish: \"${2:-$1}\""
1530         # Clear out any MERGE_HEAD kruft
1531         rm -f "$git_dir/MERGE_HEAD" || :
1532         # We have to do all the hard work ourselves :/
1533         # This is like git checkout -b "$1" "$2"
1534         # (or just git checkout "$1"),
1535         # but never creates a detached HEAD (unless $1 is a hash)
1536         git read-tree -u $_mode $_head "$_seedrev" &&
1537         {
1538                 [ -z "$2" ] && [ "$(git cat-file -t "$1")" = "commit" ] ||
1539                 git update-ref ${_ishash:+--no-deref} "$1" "$_seedrev"
1540         } && {
1541                 [ -n "$_ishash" ] || git symbolic-ref HEAD "$1"
1542         }
1543 }
1544
1545 # switch_to_base NAME [SEED]
1546 switch_to_base()
1547 {
1548         checkout_symref_full "refs/$topbases/$1" "$2"
1549 }
1550
1551 # run editor with arguments
1552 # the editor setting will be cached in $tg_editor (which is eval'd)
1553 # result non-zero if editor fails or GIT_EDITOR cannot be determined
1554 # just in case, noalt_setup will be in effect while the editor is running
1555 run_editor()
1556 {
1557         tg_editor="$GIT_EDITOR"
1558         [ -n "$tg_editor" ] || tg_editor="$(git var GIT_EDITOR)" || return $?
1559         (
1560                 noalt_setup
1561                 eval "$tg_editor" '"$@"'
1562         )
1563 }
1564
1565 # Show the help messages.
1566 do_help()
1567 {
1568         _www=
1569         if [ "$1" = "-w" ]; then
1570                 _www=1
1571                 shift
1572         fi
1573         if [ "$1" = "st" ]; then
1574                 shift
1575                 set -- "status" "$@"
1576         fi
1577         if [ -z "$1" ] ; then
1578                 # This is currently invoked in all kinds of circumstances,
1579                 # including when the user made a usage error. Should we end up
1580                 # providing more than a short help message, then we should
1581                 # differentiate.
1582                 # Petr's comment: http://marc.info/?l=git&m=122718711327376&w=2
1583
1584                 ## Build available commands list for help output
1585
1586                 cmds=
1587                 sep=
1588                 for cmd in "$TG_INST_CMDDIR"/tg-[!-]*; do
1589                         ! [ -r "$cmd" ] && continue
1590                         # strip directory part and "tg-" prefix
1591                         cmd="${cmd##*/}"
1592                         cmd="${cmd#tg-}"
1593                         [ "$cmd" != "migrate-bases" ] || continue
1594                         [ "$cmd" != "summary" ] || cmd="st[atus]|$cmd"
1595                         cmds="$cmds$sep$cmd"
1596                         sep="|"
1597                 done
1598
1599                 echo "TopGit version $TG_VERSION - A different patch queue manager"
1600                 echo "Usage: $tgname [-C <dir>] [-r <remote> | -u]" \
1601                         "[-c <name>=<val>] [--[no-]pager|-p] [-w [:]<tgtag>] ($cmds) ..."
1602                 echo "   Or: $tgname help [-w] [<command>]"
1603                 echo "Use \"$tgdisplaydir$tgname help tg\" for overview of TopGit"
1604         elif [ -r "$TG_INST_CMDDIR"/tg-$1 ] || [ -r "$TG_INST_SHAREDIR/tg-$1.txt" ] ; then
1605                 if [ -n "$_www" ]; then
1606                         nohtml=
1607                         if ! [ -r "$TG_INST_SHAREDIR/topgit.html" ]; then
1608                                 echo "${0##*/}: missing html help file:" \
1609                                         "$TG_INST_SHAREDIR/topgit.html" 1>&2
1610                                 nohtml=1
1611                         fi
1612                         if ! [ -r "$TG_INST_SHAREDIR/tg-$1.html" ]; then
1613                                 echo "${0##*/}: missing html help file:" \
1614                                         "$TG_INST_SHAREDIR/tg-$1.html" 1>&2
1615                                 nohtml=1
1616                         fi
1617                         if [ -n "$nohtml" ]; then
1618                                 echo "${0##*/}: use" \
1619                                         "\"${0##*/} help $1\" instead" 1>&2
1620                                 exit 1
1621                         fi
1622                         git web--browse -c help.browser "$TG_INST_SHAREDIR/tg-$1.html"
1623                         exit
1624                 fi
1625                 output()
1626                 {
1627                         if [ -r "$TG_INST_CMDDIR"/tg-$1 ] ; then
1628                                 "$TG_INST_CMDDIR"/tg-$1 -h 2>&1 || :
1629                                 echo
1630                         elif [ "$1" = "help" ]; then
1631                                 echo "Usage: ${tgname:-tg} help [-w] [<command>]"
1632                                 echo
1633                         elif [ "$1" = "status" ] || [ "$1" = "st" ]; then
1634                                 echo "Usage: ${tgname:-tg} @tgsthelpusage@"
1635                                 echo
1636                         fi
1637                         if [ -r "$TG_INST_SHAREDIR/tg-$1.txt" ] ; then
1638                                 cat "$TG_INST_SHAREDIR/tg-$1.txt"
1639                         fi
1640                 }
1641                 page output "$1"
1642         else
1643                 echo "${0##*/}: no help for $1" 1>&2
1644                 do_help
1645                 exit 1
1646         fi
1647 }
1648
1649 check_status()
1650 {
1651         git_state=
1652         git_remove=
1653         tg_state=
1654         tg_remove=
1655         tg_topmerge=
1656         setup_git_dir_is_bare
1657         [ -z "$git_dir_is_bare" ] || return 0
1658
1659         if [ -e "$git_dir/MERGE_HEAD" ]; then
1660                 git_state="merge"
1661         elif [ -e "$git_dir/rebase-apply/applying" ]; then
1662                 git_state="am"
1663                 git_remove="$git_dir/rebase-apply"
1664         elif [ -e "$git_dir/rebase-apply" ]; then
1665                 git_state="rebase"
1666                 git_remove="$git_dir/rebase-apply"
1667         elif [ -e "$git_dir/rebase-merge" ]; then
1668                 git_state="rebase"
1669                 git_remove="$git_dir/rebase-merge"
1670         elif [ -e "$git_dir/CHERRY_PICK_HEAD" ]; then
1671                 git_state="cherry-pick"
1672         elif [ -e "$git_dir/BISECT_LOG" ]; then
1673                 git_state="bisect"
1674         elif [ -e "$git_dir/REVERT_HEAD" ]; then
1675                 git_state="revert"
1676         fi
1677         git_remove="${git_remove#./}"
1678
1679         if [ -e "$git_dir/tg-update" ]; then
1680                 tg_state="update"
1681                 tg_remove="$git_dir/tg-update"
1682                 ! [ -s "$git_dir/tg-update/merging_topfiles" ] || tg_topmerge=1
1683         fi
1684         tg_remove="${tg_remove#./}"
1685 }
1686
1687 # Show status information
1688 do_status()
1689 {
1690         do_status_result=0
1691         do_status_verbose=
1692         do_status_help=
1693         abbrev=refs
1694         pfx=
1695         while [ $# -gt 0 ] && case "$1" in
1696                 --help|-h)
1697                         do_status_help=1
1698                         break;;
1699                 -vv)
1700                         # kludge in this common bundling option
1701                         abbrev=
1702                         do_status_verbose=1
1703                         pfx="## "
1704                         ;;
1705                 --verbose|-v)
1706                         [ -z "$do_status_verbose" ] || abbrev=
1707                         do_status_verbose=1
1708                         pfx="## "
1709                         ;;
1710                 --exit-code)
1711                         do_status_result=2
1712                         ;;
1713                 *)
1714                         die "unknown status argument: $1"
1715                         ;;
1716         esac; do shift; done
1717         if [ -n "$do_status_help" ]; then
1718                 echo "Usage: ${tgname:-tg} @tgsthelpusage@"
1719                 return
1720         fi
1721         check_status
1722         symref="$(git symbolic-ref --quiet HEAD)" || :
1723         headrv="$(git rev-parse --quiet --verify ${abbrev:+--short} HEAD --)" || :
1724         if [ -n "$symref" ]; then
1725                 uprefpart=
1726                 if [ -n "$headrv" ]; then
1727                         upref="$(git rev-parse --revs-only --symbolic-full-name @{upstream} -- 2>/dev/null)" || :
1728                         if [ -n "$upref" ]; then
1729                                 uprefpart=" ... ${upref#$abbrev/remotes/}"
1730                                 mbase="$(git merge-base HEAD "$upref")" || :
1731                                 ahead="$(git rev-list --count HEAD ${mbase:+--not} $mbase)" || ahead=0
1732                                 behind="$(git rev-list --count "$upref" ${mbase:+--not} $mbase)" || behind=0
1733                                 [ "$ahead$behind" = "00" ] || uprefpart="$uprefpart ["
1734                                 [ "$ahead" = "0" ] || uprefpart="${uprefpart}ahead $ahead"
1735                                 [ "$ahead" = "0" ] || [ "$behind" = "0" ] || uprefpart="$uprefpart, "
1736                                 [ "$behind" = "0" ] || uprefpart="${uprefpart}behind $behind"
1737                                 [ "$ahead$behind" = "00" ] || uprefpart="$uprefpart]"
1738                         fi
1739                 fi
1740                 echol "${pfx}HEAD -> ${symref#$abbrev/heads/} [${headrv:-unborn}]$uprefpart"
1741         else
1742                 echol "${pfx}HEAD -> ${headrv:-?}"
1743         fi
1744         if [ -n "$tg_state" ]; then
1745                 extra=
1746                 if [ "$tg_state" = "update" ]; then
1747                         IFS= read -r uname <"$git_dir/tg-update/name" || :
1748                         [ -z "$uname" ] ||
1749                         extra="; currently updating branch '$uname'"
1750                 fi
1751                 echol "${pfx}tg $tg_state in progress$extra"
1752                 if [ -s "$git_dir/tg-update/fullcmd" ] && [ -s "$git_dir/tg-update/names" ]; then
1753                         printf "${pfx}You are currently updating as a result of:\n${pfx}  "
1754                         cat "$git_dir/tg-update/fullcmd"
1755                         bcnt="$(( $(wc -w < "$git_dir/tg-update/names") ))"
1756                         if [ $bcnt -gt 1 ]; then
1757                                 pcnt=0
1758                                 ! [ -s "$git_dir/tg-update/processed" ] ||
1759                                 pcnt="$(( $(wc -w < "$git_dir/tg-update/processed") ))"
1760                                 echo "${pfx}$pcnt of $bcnt branches updated so far"
1761                         fi
1762                 fi
1763                 if [ "$tg_state" = "update" ]; then
1764                         echol "${pfx}  (use \"$tgdisplayac update --continue\" to continue)"
1765                         echol "${pfx}  (use \"$tgdisplayac update --skip\" to skip this branch and continue)"
1766                         echol "${pfx}  (use \"$tgdisplayac update --stop\" to stop and retain changes so far)"
1767                         echol "${pfx}  (use \"$tgdisplayac update --abort\" to restore pre-update state)"
1768                 fi
1769         fi
1770         [ -z "$git_state" ] || echo "${pfx}git $git_state in progress"
1771         if [ "$git_state" = "merge" ]; then
1772                 ucnt="$(( $(git ls-files --unmerged --full-name --abbrev :/ | wc -l) ))"
1773                 if [ $ucnt -gt 0 ]; then
1774                         echo "${pfx}"'fix conflicts and then "git commit" the result'
1775                 else
1776                         echo "${pfx}"'all conflicts fixed; run "git commit" to record result'
1777                 fi
1778         fi
1779         if [ -z "$git_state" ]; then
1780                 setup_git_dir_is_bare
1781                 [ -z "$git_dir_is_bare" ] || return 0
1782                 gsp="$(git status --porcelain 2>/dev/null)" || return 0 # bare repository???
1783                 gspcnt=0
1784                 [ -z "$gsp" ] ||
1785                 gspcnt="$(( $(printf '%s\n' "$gsp" | sed -n '/^??/!p' | wc -l) ))"
1786                 untr=
1787                 if [ "$gspcnt" -eq 0 ]; then
1788                         [ -z "$gsp" ] || untr="; non-ignored, untracked files present"
1789                         echo "${pfx}working directory is clean$untr"
1790                         [ -n "$tg_state" ] || do_status_result=0
1791                 else
1792                         echo "${pfx}working directory is DIRTY"
1793                         [ -z "$do_status_verbose" ] || git status --short --untracked-files=no
1794                 fi
1795         fi
1796 }
1797
1798 ## Pager stuff
1799
1800 # isatty FD
1801 isatty()
1802 {
1803         test -t $1
1804 }
1805
1806 # pass "diff" to get pager.diff
1807 # if pager.$1 is a boolean false returns cat
1808 # if set to true or unset fails
1809 # otherwise succeeds and returns the value
1810 get_pager()
1811 {
1812         if _x="$(git config --bool "pager.$1" 2>/dev/null)"; then
1813                 [ "$_x" != "true" ] || return 1
1814                 echo "cat"
1815                 return 0
1816         fi
1817         if _x="$(git config "pager.$1" 2>/dev/null)"; then
1818                 echol "$_x"
1819                 return 0
1820         fi
1821         return 1
1822 }
1823
1824 # setup_pager
1825 # Set TG_PAGER to a valid executable
1826 # After calling, code to be paged should be surrounded with {...} | eval "$TG_PAGER"
1827 # See also the following "page" function for ease of use
1828 # emptypager will be set to 1 (otherwise empty) if TG_PAGER was set to "cat" to not be empty
1829 # Preference is (same as Git):
1830 #   1. GIT_PAGER
1831 #   2. pager.$USE_PAGER_TYPE (but only if USE_PAGER_TYPE is set and so is pager.$USE_PAGER_TYPE)
1832 #   3. core.pager (only if set)
1833 #   4. PAGER
1834 #   5. git var GIT_PAGER
1835 #   6. less
1836 setup_pager()
1837 {
1838         isatty 1 || { emptypager=1; TG_PAGER=cat; return 0; }
1839
1840         emptypager=
1841         if [ -z "$TG_PAGER_IN_USE" ]; then
1842                 # TG_PAGER = GIT_PAGER | PAGER | less
1843                 # NOTE: GIT_PAGER='' is significant
1844                 if [ -n "${GIT_PAGER+set}" ]; then
1845                         TG_PAGER="$GIT_PAGER"
1846                 elif [ -n "$USE_PAGER_TYPE" ] && _dp="$(get_pager "$USE_PAGER_TYPE")"; then
1847                         TG_PAGER="$_dp"
1848                 elif _cp="$(git config core.pager 2>/dev/null)"; then
1849                         TG_PAGER="$_cp"
1850                 elif [ -n "${PAGER+set}" ]; then
1851                         TG_PAGER="$PAGER"
1852                 else
1853                         _gp="$(git var GIT_PAGER 2>/dev/null)" || :
1854                         [ "$_gp" != ":" ] || _gp=
1855                         TG_PAGER="${_gp:-less}"
1856                 fi
1857                 if [ -z "$TG_PAGER" ]; then
1858                         emptypager=1
1859                         TG_PAGER=cat
1860                 fi
1861         else
1862                 emptypager=1
1863                 TG_PAGER=cat
1864         fi
1865
1866         # Set pager default environment variables
1867         # see pager.c:setup_pager
1868         if [ -z "${LESS+set}" ]; then
1869                 LESS="-FRX"
1870                 export LESS
1871         fi
1872         if [ -z "${LV+set}" ]; then
1873                 LV="-c"
1874                 export LV
1875         fi
1876
1877         # this is needed so e.g. $(git diff) will still colorize it's output if
1878         # requested in ~/.gitconfig with color.diff=auto
1879         GIT_PAGER_IN_USE=1
1880         export GIT_PAGER_IN_USE
1881
1882         # this is needed so we don't get nested pagers
1883         TG_PAGER_IN_USE=1
1884         export TG_PAGER_IN_USE
1885 }
1886
1887 # page eval_arg [arg ...]
1888 #
1889 # Calls setup_pager then evals the first argument passing it all the rest
1890 # where the output is piped through eval "$TG_PAGER" unless emptypager is set
1891 # by setup_pager (in which case the output is left as-is).
1892 #
1893 # To handle arbitrary paging duties, collect lines to be paged into a
1894 # function and then call page with the function name or perhaps func_name "$@".
1895 #
1896 # If no arguments at all are passed in do nothing (return with success).
1897 page()
1898 {
1899         [ $# -gt 0 ] || return 0
1900         setup_pager
1901         _evalarg="$1"; shift
1902         if [ -n "$emptypager" ]; then
1903                 eval "$_evalarg" '"$@"'
1904         else
1905                 { eval "$_evalarg" '"$@"';} | eval "$TG_PAGER"
1906         fi
1907 }
1908
1909 # get_temp NAME [-d]
1910 # creates a new temporary file (or directory with -d) in the global
1911 # temporary directory $tg_tmp_dir with pattern prefix NAME
1912 get_temp()
1913 {
1914         mktemp $2 "$tg_tmp_dir/$1.XXXXXX"
1915 }
1916
1917 # automatically called by strftime
1918 # does nothing if already setup
1919 # may be called explicitly if the first call would otherwise be in a subshell
1920 # so that the setup is only done once before subshells start being spawned
1921 setup_strftime()
1922 {
1923         [ -z "$strftime_is_setup" ] || return 0
1924
1925         # date option to format raw epoch seconds values
1926         daterawopt=
1927         _testes='951807788'
1928         _testdt='2000-02-29 07:03:08 UTC'
1929         _testfm='%Y-%m-%d %H:%M:%S %Z'
1930         if [ "$(TZ=UTC date "-d@$_testes" "+$_testfm" 2>/dev/null)" = "$_testdt" ]; then
1931                 daterawopt='-d@'
1932         elif [ "$(TZ=UTC date "-r$_testes" "+$_testfm" 2>/dev/null)" = "$_testdt" ]; then
1933                 daterawopt='-r'
1934         fi
1935         strftime_is_setup=1
1936 }
1937
1938 # $1 => strftime format string to use
1939 # $2 => raw timestamp as seconds since epoch
1940 # $3 => optional time zone string (empty/absent for local time zone)
1941 strftime()
1942 {
1943         setup_strftime
1944         if [ -n "$daterawopt" ]; then
1945                 if [ -n "$3" ]; then
1946                         TZ="$3" date "$daterawopt$2" "+$1"
1947                 else
1948                         date "$daterawopt$2" "+$1"
1949                 fi
1950         else
1951                 if [ -n "$3" ]; then
1952                         TZ="$3" perl -MPOSIX=strftime -le 'print strftime($ARGV[0],localtime($ARGV[1]))' "$1" "$2"
1953                 else
1954                         perl -MPOSIX=strftime -le 'print strftime($ARGV[0],localtime($ARGV[1]))' "$1" "$2"
1955                 fi
1956         fi
1957 }
1958
1959 got_cdup_result=
1960 git_cdup_result=
1961 v_get_show_cdup()
1962 {
1963         if [ -z "$got_cdup_result" ]; then
1964                 git_cdup_result="$(git rev-parse --show-cdup)"
1965                 got_cdup_result=1
1966         fi
1967         [ -z "$1" ] || eval "$1="'"$git_cdup_result"'
1968 }
1969
1970 git_dir_is_bare_setup=
1971 setup_git_dir_is_bare()
1972 {
1973         if [ -z "$git_dir_is_bare_setup" ]; then
1974                 git_dir_is_bare="$(git rev-parse --is-bare-repository)"
1975                 [ z"$git_dir_is_bare" = z"true" ] || git_dir_is_bare=
1976                 git_dir_is_bare_setup=1
1977         fi
1978 }
1979
1980 git_hooks_pat_list="\
1981 [a]pplypatch-ms[g] [p]re-applypatc[h] [p]ost-applypatc[h] [p]re-commi[t] \
1982 [p]repare-commit-ms[g] [c]ommit-ms[g] [p]ost-commi[t] [p]re-rebas[e] \
1983 [p]ost-checkou[t] [p]ost-merg[e] [p]re-pus[h] [p]re-receiv[e] [u]pdat[e] \
1984 [p]ost-receiv[e] [p]ost-updat[e] [p]ush-to-checkou[t] [p]re-auto-g[c] \
1985 [p]ost-rewrit[e]"
1986
1987 # git_hooks_dir must already be set to the value of core.hooksPath which
1988 # exists and is an absolute path.  The first and only argument is the
1989 # "pwd -P" of the $git_hooks_dir directory.  If the core.hooksPath setting
1990 # appears to be "friendly" attempt to alter it to be an absolute path to
1991 # "$git_common_dir/hooks" instead.  A "friendly" core.hooksPath setting
1992 # points to a directory for which "$git_common_dir/hooks" already has
1993 # entries which are symbolic links to the same core.hooksPath items.
1994 # There's no POSIX readlink utility, but there is a 'cmp -s' utility so we
1995 # use that instead to check.  Also the "friendly" core.hooksPath must be
1996 # something that's recognizable as belonging to a "friendly".
1997 maybe_adjust_friendly_hooks_path()
1998 {
1999         case "$1" in */_global/hooks);;*) return 0; esac
2000         [ -n "$1" ] && [ -d "$1" ] && [ -d "$git_common_dir/hooks" ] || return 0
2001         [ -w "$git_common_dir" ] || return 0
2002         ! [ -e "$git_common_dir/config" ] || {
2003         [ -f "$git_common_dir/config" ] && [ -w "$git_common_dir/config" ]
2004         } || return 0
2005         oktoswitch=1
2006         for ghook in $(cd "$1" && eval "echo $git_hooks_pat_list"); do
2007                 case "$ghook" in "["*) continue; esac
2008                 [ -x "$1/$ghook" ] &&
2009                 [ -f "$1/$ghook" ] || continue
2010                 [ -x "$git_common_dir/hooks/$ghook" ] &&
2011                 [ -f "$git_common_dir/hooks/$ghook" ] &&
2012                 cmp -s "$1/$ghook" "$git_common_dir/hooks/$ghook" || {
2013                         oktoswitch=
2014                         break
2015                 }
2016         done
2017         if [ -n "$oktoswitch" ]; then
2018                 # a known "friendly" was detected and the hooks match;
2019                 # go ahead and silently switch the path
2020                 ! git config core.hooksPath "$git_common_dir/hooks" >/dev/null 2>&1 ||
2021                 git_hooks_dir="$git_common_dir/hooks"
2022         fi
2023         unset_ oktoswitch
2024         return 0
2025 }
2026
2027 git_hooks_dir=
2028 setup_git_hooks_dir()
2029 {
2030         [ -z "$git_hooks_dir" ] || return 0
2031         git_hooks_dir="$git_common_dir/hooks"
2032         if vcmp "$git_version" '>=' "2.9" && gchp="$(git config --path --get core.hooksPath 2>/dev/null)" && [ -n "$gchp" ]; then
2033                 case "$gchp" in
2034                         /[!/]*)
2035                                 if [ -d "$gchp" ]; then
2036                                         # if core.hooksPath is just another name for
2037                                         # $git_common_dir/hooks, keep referring to it
2038                                         # by $git_common_dir/hooks
2039                                         abscdh="$(cd "$git_common_dir" && pwd -P)/hooks"
2040                                         abshpd="$(cd "$gchp" && pwd -P)"
2041                                         if [ "$abshpd" != "$abscdh" ]; then
2042                                                 git_hooks_dir="$gchp"
2043                                                 maybe_adjust_friendly_hooks_path "$abshpd"
2044                                         fi
2045                                         unset_ abscdh abshpd
2046                                 else
2047                                         [ -n "$1" ] || warn "ignoring non-existent core.hooksPath: $gchp"
2048                                 fi
2049                                 ;;
2050                         *)
2051                                 [ -n "$1" ] || warn "ignoring non-absolute core.hooksPath: $gchp"
2052                                 ;;
2053                 esac
2054                 unset_ gchp
2055         fi
2056 }
2057
2058 setup_git_dirs()
2059 {
2060         [ -n "$git_dir" ] || git_dir="$(git rev-parse --git-dir)"
2061         if [ -n "$git_dir" ] && [ -d "$git_dir" ]; then
2062                 git_dir="$(cd "$git_dir" && pwd)"
2063         fi
2064         if [ -z "$git_common_dir" ]; then
2065                 if vcmp "$git_version" '>=' "2.5"; then
2066                         # rev-parse --git-common-dir is broken and may give
2067                         # an incorrect result unless the current directory is
2068                         # already set to the top level directory
2069                         v_get_show_cdup
2070                         git_common_dir="$(cd "./$git_cdup_result" && cd "$(git rev-parse --git-common-dir)" && pwd)"
2071                 else
2072                         git_common_dir="$git_dir"
2073                 fi
2074         fi
2075         [ -n "$git_dir" ] && [ -n "$git_common_dir" ] &&
2076         [ -d "$git_dir" ] && [ -d "$git_common_dir" ] || die "Not a git repository"
2077 }
2078
2079 basic_setup_remote()
2080 {
2081         if [ -z "$base_remote" ]; then
2082                 if [ "${TG_EXPLICIT_REMOTE+set}" = "set" ]; then
2083                         base_remote="$TG_EXPLICIT_REMOTE"
2084                 else
2085                         base_remote="$(git config topgit.remote 2>/dev/null)" || :
2086                 fi
2087         fi
2088 }
2089
2090 basic_setup()
2091 {
2092         setup_git_dirs $1
2093         basic_setup_remote
2094         tgsequester="$(git config --bool topgit.sequester 2>/dev/null)" || :
2095         tgnosequester=
2096         [ "$tgsequester" != "false" ] || tgnosequester=1
2097         unset_ tgsequester
2098
2099         # catch errors if topbases is used without being set
2100         unset_ tg_topbases_set
2101         topbases="programmer*:error"
2102         topbasesrx="programmer*:error}"
2103         oldbases="$topbases"
2104 }
2105
2106 tmpdir_cleanup()
2107 {
2108         test -z "$tg_tmp_dir" || ! test -d "$tg_tmp_dir" || ${TG_DEBUG:+echo} rm -rf "$tg_tmp_dir" >&2 || :
2109 }
2110
2111 tmpdir_setup()
2112 {
2113         [ -z "$tg_tmp_dir" ] || return 0
2114         if [ -n "$TG_TMPDIR" ] && [ -d "$TG_TMPDIR" ] && [ -w "$TG_TMPDIR" ] &&
2115            { >"$TG_TMPDIR/.check"; } >/dev/null 2>&1; then
2116                 tg_tmp_dir="$TG_TMPDIR"
2117         else
2118                 tg_tmp_dir=
2119                 TRAPEXIT_='tmpdir_cleanup'
2120                 trap 'trapexit_ 129' HUP
2121                 trap 'trapexit_ 130' INT
2122                 trap 'trapexit_ 131' QUIT
2123                 trap 'trapexit_ 134' ABRT
2124                 trap 'trapexit_ 141' PIPE
2125                 trap 'trapexit_ 143' TERM
2126                 tg_tmp_dir="$(mktemp -d "$git_dir/tg-tmp.XXXXXX" 2>/dev/null)" || tg_tmp_dir=
2127                 [ -n "$tg_tmp_dir" ] || tg_tmp_dir="$(mktemp -d "${TMPDIR:-/tmp}/tg-tmp.XXXXXX" 2>/dev/null)" || tg_tmp_dir=
2128                 [ -n "$tg_tmp_dir" ] || [ -z "$TMPDIR" ] || tg_tmp_dir="$(mktemp -d "/tmp/tg-tmp.XXXXXX" 2>/dev/null)" || tg_tmp_dir=
2129                 [ -z "$tg_tmp_dir" ] || tg_tmp_dir="$(cd "$tg_tmp_dir" && pwd -P)"
2130         fi
2131         [ -n "$tg_tmp_dir" ] && [ -w "$tg_tmp_dir" ] && { >"$tg_tmp_dir/.check"; } >/dev/null 2>&1 ||
2132                 die "could not create a writable temporary directory"
2133
2134         # whenever tg_tmp_dir is != "" these must always be set
2135         tg_ref_cache="$tg_tmp_dir/tg~ref-cache"
2136         tg_ref_cache_br="$tg_ref_cache.br"
2137         tg_ref_cache_rbr="$tg_ref_cache.rbr"
2138         tg_ref_cache_ann="$tg_ref_cache.ann"
2139         tg_ref_cache_dep="$tg_ref_cache.dep"
2140 }
2141
2142 cachedir_setup()
2143 {
2144         [ -z "$tg_cache_dir" ] || return 0
2145         user_id_no="$(id -u)" || :
2146         : "${user_id_no:=_99_}"
2147         tg_cache_dir="$git_common_dir/tg-cache"
2148         [ -d "$tg_cache_dir" ] || mkdir "$tg_cache_dir" >/dev/null 2>&1 || tg_cache_dir=
2149         [ -z "$tg_cache_dir" ] || tg_cache_dir="$tg_cache_dir/$user_id_no"
2150         [ -z "$tg_cache_dir" ] || [ -d "$tg_cache_dir" ] || mkdir "$tg_cache_dir" >/dev/null 2>&1 || tg_cache_dir=
2151         [ -z "$tg_cache_dir" ] || { >"$tg_cache_dir/.tgcache"; } >/dev/null 2>&1 || tg_cache_dir=
2152         if [ -z "$tg_cache_dir" ]; then
2153                 tg_cache_dir="$tg_tmp_dir/tg-cache"
2154                 [ -d "$tg_cache_dir" ] || mkdir "$tg_cache_dir" >/dev/null 2>&1 || tg_cache_dir=
2155                 [ -z "$tg_cache_dir" ] || { >"$tg_cache_dir/.tgcache"; } >/dev/null 2>&1 || tg_cache_dir=
2156         fi
2157         [ -n "$tg_cache_dir" ] ||
2158                 die "could not create a writable tg-cache directory (even a temporary one)"
2159
2160         if [ -n "$2" ]; then
2161                 # allow the wayback machine to share a separate cache
2162                 [ -d "$tg_cache_dir/wayback" ] || mkdir "$tg_cache_dir/wayback" >/dev/null 2>&1 || :
2163                 ! [ -d "$tg_cache_dir/wayback" ] || ! { >"$tg_cache_dir/wayback/.tgcache"; } >/dev/null 2>&1 ||
2164                 tg_cache_dir="$tg_cache_dir/wayback"
2165         fi
2166 }
2167
2168 # set up alternate deb dirs
2169 altodb_setup()
2170 {
2171         # GIT_ALTERNATE_OBJECT_DIRECTORIES can contain double-quoted entries
2172         # since Git v2.11.1; however, it's only necessary for : (or perhaps ;)
2173         # so we avoid it if possible and require v2.11.1 to do it at all
2174         # otherwise just don't make an alternates temporary store in that case;
2175         # it's okay to not have one; everything will still work; the nicety of
2176         # making the temporary tree objects vanish when tg exits just won't
2177         # happen in that case but nothing will break also be sure to reuse
2178         # the parent's if we've been recursively invoked and it's for the
2179         # same repository we were invoked on
2180
2181         tg_use_alt_odb=1
2182         _fullodbdir=
2183         _odbdir="${GIT_OBJECT_DIRECTORY:-$git_common_dir/objects}"
2184         [ -n "$_odbdir" ] && [ -d "$_odbdir" ] && _fullodbdir="$(cd "$_odbdir" && pwd -P)" ||
2185                 die "could not find objects directory"
2186         if [ -n "$TG_OBJECT_DIRECTORY" ] && [ -d "$TG_OBJECT_DIRECTORY/info" ] &&
2187            [ -f "$TG_OBJECT_DIRECTORY/info/alternates" ] && [ -r "$TG_OBJECT_DIRECTORY/info/alternates" ]; then
2188                 if IFS= read -r _otherodbdir <"$TG_OBJECT_DIRECTORY/info/alternates" &&
2189                    [ -n "$_otherodbdir" ] && [ "$_otherodbdir" = "$_fullodbdir" ]; then
2190                         tg_use_alt_odb=2
2191                 fi
2192         fi
2193         _fulltmpdir="$(cd "$tg_tmp_dir" && pwd -P)"
2194         if [ "$tg_use_alt_odb" = "1" ]; then
2195                 # create an alternate objects database to keep the ephemeral objects in
2196                 mkdir -p "$tg_tmp_dir/objects/info"
2197                 TG_OBJECT_DIRECTORY="$_fulltmpdir/objects"
2198                 [ "$_fullodbdir" = "$TG_OBJECT_DIRECTORY" ] ||
2199                 echol "$_fullodbdir" >"$tg_tmp_dir/objects/info/alternates"
2200         fi
2201         case "$_fulltmpdir" in *[";:"]*|'"'*) vcmp "$git_version" '>=' "2.11.1" || tg_use_alt_odb=; esac
2202         if [ "$tg_use_alt_odb" = "1" ]; then
2203                 case "$TG_OBJECT_DIRECTORY" in
2204                         *[";:"]*|'"'*)
2205                                 # surround in "..." and backslash-escape internal '"' and '\\'
2206                                 _altodbdq="\"$(printf '%s\n' "$TG_OBJECT_DIRECTORY" |
2207                                         sed 's/\([""\\]\)/\\\1/g')\""
2208                                 ;;
2209                         *)
2210                                 _altodbdq="$TG_OBJECT_DIRECTORY"
2211                                 ;;
2212                 esac
2213                 TG_PRESERVED_ALTERNATES="$GIT_ALTERNATE_OBJECT_DIRECTORIES"
2214                 if [ -n "$GIT_ALTERNATE_OBJECT_DIRECTORIES" ]; then
2215                         GIT_ALTERNATE_OBJECT_DIRECTORIES="$_altodbdq:$GIT_ALTERNATE_OBJECT_DIRECTORIES"
2216                 else
2217                         GIT_ALTERNATE_OBJECT_DIRECTORIES="$_altodbdq"
2218                 fi
2219                 export TG_PRESERVED_ALTERNATES TG_OBJECT_DIRECTORY GIT_ALTERNATE_OBJECT_DIRECTORIES
2220                 if [ -n "$GIT_OBJECT_DIRECTORY" ]; then
2221                         export GIT_OBJECT_DIRECTORY
2222                 else
2223                         unset_ GIT_OBJECT_DIRECTORY
2224                 fi
2225         fi
2226 }
2227
2228 noalt_setup()
2229 {
2230         if [ "${TG_PRESERVED_ALTERNATES+set}" = "set" ]; then
2231                 GIT_ALTERNATE_OBJECT_DIRECTORIES="$TG_PRESERVED_ALTERNATES"
2232                 if [ -n "$GIT_ALTERNATE_OBJECT_DIRECTORIES" ]; then
2233                         export GIT_ALTERNATE_OBJECT_DIRECTORIES
2234                 else
2235                         unset_ GIT_ALTERNATE_OBJECT_DIRECTORIES
2236                 fi
2237         fi
2238         unset_ TG_TMPDIR TG_OBJECT_DIRECTORY TG_PRESERVED_ALTERNATES tg_use_alt_odb
2239 }
2240
2241 ## Initial setup
2242 initial_setup()
2243 {
2244         # suppress the merge log editor feature since git 1.7.10
2245
2246         GIT_MERGE_AUTOEDIT=no
2247         export GIT_MERGE_AUTOEDIT
2248
2249         basic_setup $1
2250         iowopt=
2251         ! vcmp "$git_version" '>=' "2.5" || iowopt="--ignore-other-worktrees"
2252         gcfbopt=
2253         ! vcmp "$git_version" '>=' "2.6" || gcfbopt="--buffer"
2254         auhopt=
2255         ! vcmp "$git_version" '>=' "2.9" || auhopt="--allow-unrelated-histories"
2256         crlopt=
2257         ! vcmp "$git_version" '>=' "2.10" || crlopt="--create-reflog"
2258         v_get_show_cdup root_dir
2259         root_dir="${root_dir:-.}"
2260         logrefupdates="$(git config --bool core.logallrefupdates 2>/dev/null)" || :
2261         [ "$logrefupdates" = "true" ] || logrefupdates=
2262
2263         # make sure root_dir doesn't end with a trailing slash.
2264
2265         root_dir="${root_dir%/}"
2266
2267         # create global temporary and cache directories, usually inside GIT_DIR
2268
2269         tmpdir_setup
2270         unset_ TG_TMPDIR
2271         cachedir_setup
2272
2273         # the wayback machine directory serves as its own "altodb"
2274         [ -n "$wayback" ] || altodb_setup
2275 }
2276
2277 activate_wayback_machine()
2278 {
2279         [ -n "${1#:}" ] || [ -n "$2" ] || { wayback=; return 0; }
2280         setup_git_dirs
2281         tmpdir_setup
2282         altodb_setup
2283         tgwbr=
2284         tgwbr2=
2285         if [ -n "${1#:}" ]; then
2286                 tgwbr="$(get_temp wbinfo)"
2287                 tgwbr2="${tgwbr}2"
2288                 tg revert --list --no-short "${1#:}" >"$tgwbr" && test -s "$tgwbr" || return 1
2289                 # tg revert will likely leave a revert-tag-only cache which is not what we want
2290                 remove_ref_cache
2291         fi
2292         cachedir_setup "" 1 # use a separate wayback cache dir
2293         # but don't step on the normal one if the separate one could not be set up
2294         case "$tg_cache_dir" in */wayback);;*) tg_cache_dir=; esac
2295         altodb="$TG_OBJECT_DIRECTORY"
2296         if [ -n "$3" ] && [ -n "$2" ]; then
2297                 [ -d "$3" ] || { mkdir -p "$3" && [ -d "$3" ]; } ||
2298                         die "could not create wayback directory: $3"
2299                 tg_wayback_dir="$(cd "$3" && pwd -P)" || die "could not get wayback directory full path"
2300                 [ -d "$tg_wayback_dir/.git" ] || { mkdir -p "$tg_wayback_dir/.git" && [ -d "$tg_wayback_dir/.git" ]; } ||
2301                         die "could not initialize wayback directory: $3"
2302                 is_empty_dir "$tg_wayback_dir" ".git" && is_empty_dir "$tg_wayback_dir/.git" "." ||
2303                         die "wayback directory is not empty: $3"
2304                 mkdir "$tg_wayback_dir/.git/objects"
2305                 mkdir "$tg_wayback_dir/.git/objects/info"
2306                 cat "$altodb/info/alternates" >"$tg_wayback_dir/.git/objects/info/alternates"
2307         else
2308                 tg_wayback_dir="$tg_tmp_dir/wayback"
2309                 mkdir "$tg_wayback_dir"
2310                 mkdir "$tg_wayback_dir/.git"
2311                 ln -s "$altodb" "$tg_wayback_dir/.git/objects"
2312         fi
2313         mkdir "$tg_wayback_dir/.git/refs"
2314         printf '0 Wayback Machine' >"$tg_wayback_dir/.git/gc.pid"
2315         qpesc="$(printf '%s\n' "$git_common_dir" | sed -e 's/\([\\""]\)/\\\1/g' -e '$!s/$/\\n/' | tr -d '\n')"
2316         laru="false"
2317         [ -z "$2" ] || laru="true"
2318         printf '%s' "\
2319 [include]
2320         path = \"$qpesc/config\"
2321 [core]
2322         bare = false
2323         logAllRefUpdates = $laru
2324         repositoryFormatVersion = 0
2325 [extensions]
2326         preciousObjects = true
2327 [gc]
2328         auto = 0
2329         autoDetach = false
2330         autoPackLimit = 0
2331         packRefs = false
2332 [remote \"wayback\"]
2333         url = \"$qpesc\"
2334 [push]
2335         default = nothing
2336         followTags = true
2337 [alias]
2338         wayback-updates = fetch -u --force --no-tags --dry-run wayback refs/*:refs/*
2339 " >"$tg_wayback_dir/.git/config"
2340         cat "$git_dir/HEAD" >"$tg_wayback_dir/.git/HEAD"
2341         case "$1" in ":"?*);;*)
2342                 git show-ref >"$tg_wayback_dir/.git/packed-refs"
2343                 git --git-dir="$tg_wayback_dir/.git" pack-refs --all
2344         esac
2345         noalt_setup
2346         TG_OBJECT_DIRECTORY="$altodb" && export TG_OBJECT_DIRECTORY
2347         if [ -n "${1#:}" ]; then
2348                 <"$tgwbr" sed 's/^\([^ ][^ ]*\) \([^ ][^ ]*\)$/update \2 \1/' |
2349                 git --git-dir="$tg_wayback_dir/.git" update-ref -m "wayback to $1" ${2:+$crlopt} --stdin
2350         fi
2351         if test -n "$2"; then
2352                 # extra setup for potential shell
2353                 qpesc2="$(printf '%s\n' "$git_common_dir" | sed -e 's/\([\\""]\)/\\\\\1/g' -e '$!s/$/\\n/' | tr -d '\n')"
2354                 printf '\twayback-repository = "!printf '\''%%s\\\\n'\'' \\"%s\\""\n' "$qpesc2" >>"$tg_wayback_dir/.git/config"
2355                 qtesc="$(printf '%s\n' "${1:-:}" | sed 's/\([""]\)/\\\1/g')"
2356                 printf '\twayback-tag = "!printf '\''%%s\\\\n'\'' \\"%s\\""\n' "$qtesc" >>"$tg_wayback_dir/.git/config"
2357                 if [ -d "$git_common_dir/rr-cache" ]; then
2358                         ln -s "$git_common_dir/rr-cache" "$tg_wayback_dir/.git/rr-cache"
2359                         printf "[rerere]\n\tenabled = true\n" >>"$tg_wayback_dir/.git/config"
2360                 fi
2361                 if [ z"$2" != z"2" ]; then
2362                         wbauth=
2363                         wbprnt=
2364                         if [ -n "${1#:}" ]; then
2365                                 [ -n "$tgwbr2" ] || tgwbr2="$(get_temp wbtag)"
2366                                 git --git-dir="$git_common_dir" cat-file tag "${1#:}" >"$tgwbr2" || return 1
2367                                 wbprnt="${lf}parent $(git --git-dir="$git_common_dir" rev-parse --verify --quiet "${1#:}"^0 -- 2>/dev/null)" || wbprnt=
2368                                 wbauth="$(<"$tgwbr2" awk '{if(!$0)exit;if($1=="tagger")print "author" substr($0,7)}')"
2369                         fi
2370                         wbcmtr="committer Wayback Machine <-> $(date "+%s %z")"
2371                         [ -n "$wbauth" ] || wbauth="author${wbcmtr#committer}"
2372                         wbtree="$(git --git-dir="$tg_wayback_dir/.git" mktree </dev/null)"
2373                         wbcmt="$({
2374                                 printf '%s\n' "tree $wbtree$wbprnt" "$wbauth" "$wbcmtr" ""
2375                                 if [ -n "$tgwbr2" ]; then
2376                                         <"$tgwbr2" sed -e '1,/^$/d' -e '/^-----BEGIN/,$d' | git stripspace
2377                                 else
2378                                         echo "Wayback Machine"
2379                                 fi
2380                         } | git --git-dir="$tg_wayback_dir/.git" hash-object -t commit -w --stdin)"
2381                         test -n "$wbcmt" || return 1
2382                         echo "$wbcmt" >"$tg_wayback_dir/.git/HEAD"
2383                 fi
2384         fi
2385         cd "$tg_wayback_dir"
2386         unset git_dir git_common_dir
2387 }
2388
2389 set_topbases()
2390 {
2391         # refer to "top-bases" in a refname with $topbases
2392
2393         [ -z "$tg_topbases_set" ] || return 0
2394
2395         topbases_implicit_default=1
2396         # See if topgit.top-bases is set to heads or refs
2397         tgtb="$(git config "topgit.top-bases" 2>/dev/null)" || :
2398         if [ -n "$tgtb" ] && [ "$tgtb" != "heads" ] && [ "$tgtb" != "refs" ]; then
2399                 if [ -n "$1" ]; then
2400                         # never die on the hook script
2401                         unset_ tgtb
2402                 else
2403                         die "invalid \"topgit.top-bases\" setting (must be \"heads\" or \"refs\")"
2404                 fi
2405         fi
2406         if [ -n "$tgtb" ]; then
2407                 case "$tgtb" in
2408                 heads)
2409                         topbases="heads/{top-bases}"
2410                         topbasesrx="heads/[{]top-bases[}]"
2411                         oldbases="top-bases";;
2412                 refs)
2413                         topbases="top-bases"
2414                         topbasesrx="top-bases"
2415                         oldbases="heads/{top-bases}";;
2416                 esac
2417                 # MUST NOT be exported
2418                 unset_ tgtb tg_topbases_set topbases_implicit_default
2419                 tg_topbases_set=1
2420                 return 0
2421         fi
2422         unset_ tgtb
2423
2424         # check heads and top-bases and see what state the current
2425         # repository is in.  remotes are ignored.
2426
2427         rc=0 activebases=
2428         activebases="$(
2429                 git for-each-ref --format='%(refname)' "refs/heads" "refs/top-bases" 2>/dev/null |
2430                 run_awk_ref_prefixes ${1:+-e} -n -- "refs/heads/{top-bases}" "refs/top-bases" "refs/heads")" ||
2431                 rc=$?
2432         if [ "$rc" = "65" ]; then
2433                 # Complain and die
2434                 err "repository contains existing TopGit branches"
2435                 err "but some use refs/top-bases/... for the base"
2436                 err "and some use refs/heads/{top-bases}/... for the base"
2437                 err "with the latter being the new, preferred location"
2438                 err "set \"topgit.top-bases\" to either \"heads\" to use"
2439                 err "the new heads/{top-bases} location or \"refs\" to use"
2440                 err "the old top-bases location."
2441                 err "(the tg migrate-bases command can also resolve this issue)"
2442                 die "schizophrenic repository requires topgit.top-bases setting"
2443         fi
2444         [ -z "$activebases" ] || unset_ topbases_implicit_default
2445         if [ "$activebases" = "refs/heads/{top-bases}" ]; then
2446                 topbases="heads/{top-bases}"
2447                 topbasesrx="heads/[{]top-bases[}]"
2448                 oldbases="top-bases"
2449         else
2450                 # default is still top-bases for now
2451                 topbases="top-bases"
2452                 topbasesrx="top-bases"
2453                 oldbases="heads/{top-bases}"
2454         fi
2455         # MUST NOT be exported
2456         unset_ rc activebases tg_topases_set
2457         tg_topbases_set=1
2458         return 0
2459 }
2460
2461 # $1 is remote name to check
2462 # $2 is optional variable name to set to result of check
2463 # $3 is optional command name to use in message (defaults to $cmd)
2464 # Fatal error if remote has schizophrenic top-bases
2465 # No error (and $2, if provided, will be set to empty) if remote has no top-bases at all
2466 check_remote_topbases()
2467 {
2468         [ -n "$1" ] || die "programmer error: check_remote_topbases called with no remote argument"
2469         _crrc=0 _crremotebases=
2470         _crremotebases="$(
2471                 git for-each-ref --format='%(refname)' "refs/remotes/$1" 2>/dev/null |
2472                 run_awk_ref_prefixes -n -- "refs/remotes/$1/{top-bases}" "refs/remotes/$1/top-bases" "refs/remotes/$1")" ||
2473                 _crrc=$?
2474         if [ "$_crrc" = "65" ]; then
2475                 err "remote \"$1\" has top-bases in both locations:"
2476                 err "  refs/remotes/$1/{top-bases}/..."
2477                 err "  refs/remotes/$1/top-bases/..."
2478                 err "set \"topgit.top-bases\" to \"heads\" for the first, preferred location"
2479                 err "or set \"topgit.top-bases\" to \"refs\" for the second, old location"
2480                 err "(the \"-c topgit.top-bases=<val>\" option can be used for this)"
2481                 err "then re-run the tg ${3:-$cmd} command"
2482                 err "(the tg migrate-bases command can also help with this problem)"
2483                 die "schizophrenic remote \"$1\" requires topgit.top-bases setting"
2484         fi
2485         [ "$_crrc" != "66" ] || _crremotebases= # just to be sure
2486         [ -z "$2" ] || eval "$2="'"$_crremotebases"'
2487         unset _crrc _crremotebases
2488         return 0
2489 }
2490
2491 # init_reflog "ref"
2492 # if "$logrefupdates" is set and ref is not under refs/heads/ then force
2493 # an empty log file to exist so that ref changes will be logged
2494 # "$1" must be a fully-qualified refname (i.e. start with "refs/")
2495 # However, if "$1" is "refs/tgstash" then always make the reflog
2496 # The only ref not under refs/ that Git will write a reflog for is HEAD;
2497 # no matter what, it will NOT update a reflog for any other bare refs so
2498 # just quietly succeed when passed TG_STASH without doing anything.
2499 init_reflog()
2500 {
2501         [ -n "$1" ] && [ "$1" != "TG_STASH" ] || return 0
2502         [ -n "$logrefupdates" ] || [ "$1" = "refs/tgstash" ] || return 0
2503         case "$1" in refs/heads/*|HEAD) return 0;; refs/*[!/]);; *) return 1; esac
2504         mkdir -p "$git_common_dir/logs/${1%/*}" 2>/dev/null || :
2505         { >>"$git_common_dir/logs/$1" || :; } 2>/dev/null
2506  }
2507
2508 # store the "realpath" for "$2" in "$1" except the leaf is not resolved if it's
2509 # a symbolic link.  The directory part must exist, but the basename need not.
2510 v_get_abs_path()
2511 {
2512         [ -n "$1" ] && [ -n "$2" ] || return 1
2513         set -- "$1" "$2" "${2%/}"
2514         case "$3" in
2515                 */*) set -- "$1" "$2" "${3%/*}";;
2516                 *  ) set -- "$1" "$2" ".";;
2517         esac
2518         case "$2" in */)
2519                 set -- "$1" "${2%/}" "$3" "/"
2520         esac
2521         [ -d "$3" ] || return 1
2522         eval "$1="'"$(cd "$3" && pwd -P)/${2##*/}$4"'
2523 }
2524
2525 ## Startup
2526
2527 : "${TG_INST_CMDDIR:=@cmddir@}"
2528 : "${TG_INST_SHAREDIR:=@sharedir@}"
2529 : "${TG_INST_HOOKSDIR:=@hooksdir@}"
2530
2531 [ -d "$TG_INST_CMDDIR" ] ||
2532         die "No command directory: '$TG_INST_CMDDIR'"
2533
2534 ## Include awk scripts and their utility functions (separated for easier debugging)
2535
2536 [ -f "$TG_INST_CMDDIR/tg--awksome" ] && [ -r "$TG_INST_CMDDIR/tg--awksome" ] ||
2537         die "Missing awk scripts: '$TG_INST_CMDDIR/tg--awksome'"
2538 . "$TG_INST_CMDDIR/tg--awksome"
2539
2540 if [ -n "$tg__include" ]; then
2541
2542         # We were sourced from another script for our utility functions;
2543         # this is set by hooks.  Skip the rest of the file.  A simple return doesn't
2544         # work as expected in every shell.  See http://bugs.debian.org/516188
2545
2546         # ensure setup happens
2547
2548         initial_setup 1
2549         set_topbases 1
2550         noalt_setup
2551
2552 else
2553
2554         set -e
2555
2556         tgbin="$0"
2557         tgdir="${tgbin%/}"
2558         case "$tgdir" in */*);;*) tgdir="./$tgdir"; esac
2559         tgdir="${tgdir%/*}/"
2560         tgname="${tgbin##*/}"
2561         [ "$0" != "$tgname" ] || tgdir=""
2562
2563         # If tg contains a '/' but does not start with one then replace it with an absolute path
2564
2565         case "$0" in /*) ;; */*)
2566                 tgdir="$(cd "${0%/*}" && pwd -P)/"
2567                 tgbin="$tgdir$tgname"
2568         esac
2569
2570         # tgdisplay will include any explicit -C <dir> etc. options whereas tgname will not
2571         # tgdisplayac is the same as tgdisplay but without any -r or -u options (ac => abort/continue)
2572
2573         tgdisplaydir="$tgdir"
2574         tgdisplay="$tgbin"
2575         tgdisplayac="$tgdisplay"
2576         if
2577             v_get_abs_path _tgnameabs "$(cmd_path "$tgname")" &&
2578             _tgabs="$_tgnameabs" &&
2579             { [ "$tgbin" = "$tgname" ] || v_get_abs_path _tgabs "$tgbin"; } &&
2580             [ "$_tgabs" = "$_tgnameabs" ]
2581         then
2582                 tgdisplaydir=""
2583                 tgdisplay="$tgname"
2584                 tgdisplayac="$tgdisplay"
2585         fi
2586         [ -z "$_tgabs" ] || tgbin="$_tgabs"
2587         unset_ _tgabs _tgnameabs
2588
2589         tg() (
2590                 TG_TMPDIR="$tg_tmp_dir" && export TG_TMPDIR &&
2591                 exec "$tgbin" "$@"
2592         )
2593
2594         explicit_remote=
2595         explicit_dir=
2596         gitcdopt=
2597         noremote=
2598         forcepager=
2599         wayback=
2600
2601         cmd=
2602         while :; do case "$1" in
2603
2604                 help|--help|-h)
2605                         cmd=help
2606                         shift
2607                         break;;
2608
2609                 status|--status)
2610                         cmd=status
2611                         shift
2612                         break;;
2613
2614                 --hooks-path)
2615                         cmd=hooks-path
2616                         shift
2617                         break;;
2618
2619                 --exec-path)
2620                         cmd=exec-path
2621                         shift
2622                         break;;
2623
2624                 --awk-path)
2625                         cmd=awk-path
2626                         shift
2627                         break;;
2628
2629                 --top-bases)
2630                         cmd=top-bases
2631                         shift
2632                         break;;
2633
2634                 --no-pager)
2635                         forcepager=0
2636                         shift;;
2637
2638                 --pager|-p|--paginate)
2639                         forcepager=1
2640                         shift;;
2641
2642                 -r)
2643                         shift
2644                         if [ -z "$1" ]; then
2645                                 echo "Option -r requires an argument." >&2
2646                                 do_help
2647                                 exit 1
2648                         fi
2649                         unset_ noremote
2650                         base_remote="$1"
2651                         explicit_remote="$base_remote"
2652                         tgdisplay="$tgdisplaydir$tgname$gitcdopt -r $explicit_remote"
2653                         TG_EXPLICIT_REMOTE="$base_remote" && export TG_EXPLICIT_REMOTE
2654                         shift;;
2655
2656                 -u)
2657                         unset_ base_remote explicit_remote
2658                         noremote=1
2659                         tgdisplay="$tgdisplaydir$tgname$gitcdopt -u"
2660                         TG_EXPLICIT_REMOTE= && export TG_EXPLICIT_REMOTE
2661                         shift;;
2662
2663                 -C)
2664                         shift
2665                         if [ -z "$1" ]; then
2666                                 echo "Option -C requires an argument." >&2
2667                                 do_help
2668                                 exit 1
2669                         fi
2670                         cd "$1"
2671                         unset_ GIT_DIR GIT_COMMON_DIR
2672                         if [ -z "$explicit_dir" ]; then
2673                                 explicit_dir="$1"
2674                         else
2675                                 explicit_dir="$PWD"
2676                         fi
2677                         gitcdopt=" -C \"$explicit_dir\""
2678                         [ "$explicit_dir" != "." ] || explicit_dir="." gitcdopt=" -C ."
2679                         tgdisplay="$tgdisplaydir$tgname$gitcdopt"
2680                         tgdisplayac="$tgdisplay"
2681                         [ -z "$explicit_remote" ] || tgdisplay="$tgdisplay -r $explicit_remote"
2682                         [ -z "$noremote" ] || tgdisplay="$tgdisplay -u"
2683                         shift;;
2684
2685                 -c)
2686                         shift
2687                         if [ -z "$1" ]; then
2688                                 echo "Option -c requires an argument." >&2
2689                                 do_help
2690                                 exit 1
2691                         fi
2692                         param="'$(printf '%s\n' "$1" | sed "s/[']/'\\\\''/g")'"
2693                         GIT_CONFIG_PARAMETERS="${GIT_CONFIG_PARAMETERS:+$GIT_CONFIG_PARAMETERS }$param"
2694                         export GIT_CONFIG_PARAMETERS
2695                         shift;;
2696
2697                 -w)
2698                         if [ -n "$wayback" ]; then
2699                                 echo "Option -w may be used at most once." >&2
2700                                 do_help
2701                                 exit 1
2702                         fi
2703                         shift
2704                         if [ -z "$1" ]; then
2705                                 echo "Option -w requires an argument." >&2
2706                                 do_help
2707                                 exit 1
2708                         fi
2709                         wayback="$1"
2710                         shift;;
2711
2712                 --)
2713                         shift
2714                         break;;
2715
2716                 -*)
2717                         echo "Invalid option $1 (subcommand options must appear AFTER the subcommand)." >&2
2718                         do_help
2719                         exit 1;;
2720
2721                 *)
2722                         break;;
2723
2724         esac; done
2725         if [ z"$forcepager" = z"0" ]; then
2726                 GIT_PAGER_IN_USE=1 TG_PAGER_IN_USE=1 &&
2727                 export GIT_PAGER_IN_USE TG_PAGER_IN_USE
2728         fi
2729
2730         [ -n "$cmd" ] || [ $# -lt 1 ] || { cmd="$1"; shift; }
2731
2732         ## Dispatch
2733
2734         [ -n "$cmd" ] || { do_help; exit 1; }
2735
2736         case "$cmd" in
2737
2738                 help)
2739                         do_help "$@"
2740                         exit 0;;
2741
2742                 status|st)
2743                         unset_ base_remote
2744                         basic_setup
2745                         set_topbases
2746                         do_status "$@"
2747                         exit ${do_status_result:-0};;
2748
2749                 hooks-path)
2750                         # Internal command
2751                         echol "$TG_INST_HOOKSDIR";;
2752
2753                 exec-path)
2754                         # Internal command
2755                         echol "$TG_INST_CMDDIR";;
2756
2757                 awk-path)
2758                         # Internal command
2759                         echol "$TG_INST_CMDDIR/awk";;
2760
2761                 top-bases)
2762                         # Maintenance command
2763                         do_topbases_help=
2764                         show_remote_topbases=
2765                         case "$1" in
2766                                 --help|-h)
2767                                         do_topbases_help=0;;
2768                                 -r|--remote)
2769                                         if [ $# -eq 2 ] && [ -n "$2" ]; then
2770                                                 # unadvertised, but make it work
2771                                                 base_remote="$2"
2772                                                 shift
2773                                         fi
2774                                         show_remote_topbases=1;;
2775                                 *)
2776                                         [ $# -eq 0 ] || do_topbases_help=1;;
2777                         esac
2778                         [ $# -le 1 ] || do_topbases_help=1
2779                         if [ -n "$do_topbases_help" ]; then
2780                                 helpcmd='echo "Usage: ${tgname:-tg} [-r <remote>] --top-bases [-r]"'
2781                                 [ $do_topbases_help -eq 0 ] || helpcmd="$helpcmd >&2"
2782                                 eval "$helpcmd"
2783                                 exit $do_topbases_help
2784                         fi
2785                         git_dir=
2786                         if git_dir="$(git rev-parse --git-dir 2>&1)"; then
2787                                 [ -z "$wayback" ] || activate_wayback_machine "$wayback"
2788                                 setup_git_dirs
2789                         fi
2790                         set_topbases
2791                         if [ -n "$show_remote_topbases" ]; then
2792                                 basic_setup_remote
2793                                 [ -n "$base_remote" ] ||
2794                                 die "no remote location given. Either use -r <remote> option or set topgit.remote"
2795                                 rbases=
2796                                 [ -z "$topbases_implicit_default" ] ||
2797                                 check_remote_topbases "$base_remote" rbases "--top-bases"
2798                                 if [ -n "$rbases" ]; then
2799                                         echol "$rbases"
2800                                 else
2801                                         echol "refs/remotes/$base_remote/${topbases#heads/}"
2802                                 fi
2803                         else
2804                                 echol "refs/$topbases"
2805                         fi;;
2806
2807                 *)
2808                         isutil=
2809                         case "$cmd" in index-merge-one-file)
2810                                 isutil="-"
2811                         esac
2812                         [ -r "$TG_INST_CMDDIR/tg-$isutil$cmd" ] || {
2813                                 looplevel="$TG_ALIAS_DEPTH"
2814                                 [ "${looplevel#[1-9]}" != "$looplevel" ] &&
2815                                 [ "${looplevel%%[!0-9]*}" = "$looplevel" ] ||
2816                                 looplevel=0
2817                                 tgalias="$(git config "topgit.alias.$cmd" 2>/dev/null)" || :
2818                                 [ -n "$tgalias" ] || {
2819                                         echo "Unknown subcommand: $cmd" >&2
2820                                         do_help
2821                                         exit 1
2822                                 }
2823                                 looplevel=$(( $looplevel + 1 ))
2824                                 [ $looplevel -le 10 ] || die "topgit.alias nesting level 10 exceeded"
2825                                 TG_ALIAS_DEPTH="$looplevel"
2826                                 export TG_ALIAS_DEPTH
2827                                 if [ "!${tgalias#?}" = "$tgalias" ]; then
2828                                         [ -z "$wayback" ] ||
2829                                         die "-w is not allowed before an '!' alias command"
2830                                         unset_ GIT_PREFIX
2831                                         if pfx="$(git rev-parse --show-prefix 2>/dev/null)"; then
2832                                                 GIT_PREFIX="$pfx"
2833                                                 export GIT_PREFIX
2834                                         fi
2835                                         cd "./$(git rev-parse --show-cdup 2>/dev/null)"
2836                                         if [ $# -gt 0 ]; then
2837                                                 exec @SHELL_PATH@ -c "${tgalias#?} \"\$@\"" @SHELL_PATH@ "$@"
2838                                         else
2839                                                 exec @SHELL_PATH@ -c "${tgalias#?}" @SHELL_PATH@
2840                                         fi
2841                                 else
2842                                         eval 'exec "$tgbin"' "${wayback:+-w \"\$wayback\"}" "$tgalias" '"$@"'
2843                                 fi
2844                                 die "alias execution failed for: $tgalias"
2845                         }
2846                         unset_ TG_ALIAS_DEPTH
2847
2848                         showing_help=
2849                         if [ "$*" = "-h" ] || [ "$*" = "--help" ]; then
2850                                 showing_help=1
2851                         fi
2852
2853                         nomergesetup="$showing_help"
2854                         case "$cmd" in base|contains|export|files|info|log|mail|next|patch|prev|rebase|revert|shell|summary|tag)
2855                                 # avoid merge setup where not necessary
2856
2857                                 nomergesetup=1
2858                         esac
2859
2860                         if [ -n "$wayback" ] && [ -z "$showing_help" ]; then
2861                                 [ -n "$nomergesetup" ] ||
2862                                 die "the wayback machine cannot be used with the \"$cmd\" subcommand"
2863                                 if [ "$cmd" = "shell" ]; then
2864                                         # this is ugly; `tg shell` should handle this but it's too
2865                                         # late there so we have to do it here
2866                                         wayback_dir=
2867                                         case "$1" in
2868                                                 "--directory="?*)
2869                                                         wayback_dir="${1#--directory=}" && shift;;
2870                                                 "--directory=")
2871                                                         die "--directory requires an argument";;
2872                                                 "--directory")
2873                                                         [ $# -ge 2 ] || die "--directory requires an argument"
2874                                                         wayback_dir="$2" && shift 2;;
2875                                         esac
2876                                         activate_wayback_machine "$wayback" 1 "$wayback_dir"
2877                                 else
2878                                         _fullwb=
2879                                         # export might drop out into a shell for conflict resolution
2880                                         [ "$cmd" != "export" ] || _fullwb=2
2881                                         activate_wayback_machine "$wayback" "$_fullwb"
2882                                 fi ||
2883                                 die "failed to set the wayback machine to target \"$wayback\""
2884                         fi
2885
2886                         [ -n "$showing_help" ] || initial_setup
2887                         [ -z "$noremote" ] || unset_ base_remote
2888
2889                         if [ -z "$nomergesetup" ]; then
2890                                 # make sure merging the .top* files will always behave sanely
2891
2892                                 setup_ours
2893                                 setup_hook "pre-commit"
2894                         fi
2895
2896                         # everything but rebase needs topbases set
2897                         carefully="$showing_help"
2898                         [ "$cmd" != "migrate-bases" ] || carefully=1
2899                         [ "$cmd" = "rebase" ] || set_topbases $carefully
2900
2901                         _use_ref_cache=
2902                         tg_read_only=1
2903                         _suppress_alt=
2904                         case "$cmd$showing_help" in
2905                                 contains|info|summary|tag)
2906                                         _use_ref_cache=1;;
2907                                 "export")
2908                                         _use_ref_cache=1
2909                                         _suppress_alt=1;;
2910                                 annihilate|create|delete|depend|import|update)
2911                                         tg_read_only=
2912                                         _suppress_alt=1;;
2913                         esac
2914                         [ -z "$_suppress_alt" ] || noalt_setup
2915                         [ -z "$_use_ref_cache" ] || v_create_ref_cache
2916
2917                         fullcmd="${tgname:-tg} $cmd $*"
2918                         fullcmd="${fullcmd% }"
2919                         if [ z"$forcepager" = z"1" ]; then
2920                                 page '. "$TG_INST_CMDDIR"/tg-$isutil$cmd' "$@"
2921                         else
2922                                 . "$TG_INST_CMDDIR"/tg-$isutil$cmd
2923                         fi;;
2924         esac
2925
2926 fi