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-2017 Kyle J. McKay <mackyle@gmail.com>
   5 # All rights reserved.
   6 # GPLv2
   7
   8 TG_VERSION=0.19.8
   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 "$@" || :
  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 cut()   { exec_lc_all_c cut cut         "$@"; }
  77 find()  { exec_lc_all_c find find       "$@"; }
  78 grep()  { exec_lc_all_c grep grep       "$@"; }
  79 join()  { exec_lc_all_c join join       "$@"; }
  80 paste() { exec_lc_all_c paste paste     "$@"; }
  81 sed()   { exec_lc_all_c sed sed         "$@"; }
  82 sort()  { exec_lc_all_c sort sort       "$@"; }
  83 tr()    { exec_lc_all_c tr tr           "$@"; }
  84 wc()    { exec_lc_all_c wc wc           "$@"; }
  85 xargs() { exec_lc_all_c xargs xargs     "$@"; }
  86
  87 # Output arguments without any possible interpretation
  88 # (Avoid misinterpretation of '\' characters or leading "-n", "-E" or "-e")
  89 echol()
  90 {
  91         printf '%s\n' "$*"
  92 }
  93
  94 info()
  95 {
  96         echol "${TG_RECURSIVE}${tgname:-tg}: $*"
  97 }
  98
  99 warn()
 100 {
 101         info "warning: $*" >&2
 102 }
 103
 104 err()
 105 {
 106         info "error: $*" >&2
 107 }
 108
 109 fatal()
 110 {
 111         info "fatal: $*" >&2
 112 }
 113
 114 die()
 115 {
 116         fatal "$@"
 117         exit 1
 118 }
 119
 120 # shift off first arg then return "$*" properly quoted in single-quotes
 121 # if $1 was '' output goes to stdout otherwise it's assigned to $1
 122 # the final \n, if any, is omitted from the result but any others are included
 123 v_quotearg()
 124 {
 125         _quotearg_v="$1"
 126         shift
 127         set -- "$_quotearg_v" \
 128         "sed \"s/'/'\\\\\\''/g;1s/^/'/;\\\$s/\\\$/'/;s/'''/'/g;1s/^''\\(.\\)/\\1/\"" "$*"
 129         unset_ _quotearg_v
 130         if [ -z "$3" ]; then
 131                 if [ -z "$1" ]; then
 132                         echo "''"
 133                 else
 134                         eval "$1=\"''\""
 135                 fi
 136         else
 137                 if [ -z "$1" ]; then
 138                         printf "%s$4" "$3" | eval "$2"
 139                 else
 140                         eval "$1="'"$(printf "%s$4" "$3" | eval "$2")"'
 141                 fi
 142         fi
 143 }
 144
 145 # same as v_quotearg except there's no extra $1 so output always goes to stdout
 146 quotearg()
 147 {
 148         v_quotearg '' "$@"
 149 }
 150
 151 vcmp()
 152 {
 153         # Compare $1 to $3 each of which must match ^[^0-9]*\d*(\.\d*)*.*$
 154         # where only the "\d*" parts in the regex participate in the comparison
 155         # Since EVERY string matches that regex this function is easy to use
 156         # An empty string ('') for $1 or $3 or any "\d*" part is treated as 0
 157         # $2 is a compare op '<', '<=', '=', '==', '!=', '>=', '>'
 158         # Return code is 0 for true, 1 for false (or unknown compare op)
 159         # There is NO difference in behavior between '=' and '=='
 160         # Note that "vcmp 1.8 == 1.8.0.0.0.0" correctly returns 0
 161         set -- "$1" "$2" "$3" "${1%%[0-9]*}" "${3%%[0-9]*}"
 162         set -- "${1#"$4"}" "$2" "${3#"$5"}"
 163         set -- "${1%%[!0-9.]*}" "$2" "${3%%[!0-9.]*}"
 164         while
 165                 vcmp_a_="${1%%.*}"
 166                 vcmp_b_="${3%%.*}"
 167                 [ "z$vcmp_a_" != "z" -o "z$vcmp_b_" != "z" ]
 168         do
 169                 if [ "${vcmp_a_:-0}" -lt "${vcmp_b_:-0}" ]; then
 170                         unset_ vcmp_a_ vcmp_b_
 171                         case "$2" in "<"|"<="|"!=") return 0; esac
 172                         return 1
 173                 elif [ "${vcmp_a_:-0}" -gt "${vcmp_b_:-0}" ]; then
 174                         unset_ vcmp_a_ vcmp_b_
 175                         case "$2" in ">"|">="|"!=") return 0; esac
 176                         return 1;
 177                 fi
 178                 vcmp_a_="${1#$vcmp_a_}"
 179                 vcmp_b_="${3#$vcmp_b_}"
 180                 set -- "${vcmp_a_#.}" "$2" "${vcmp_b_#.}"
 181         done
 182         unset_ vcmp_a_ vcmp_b_
 183         case "$2" in "="|"=="|"<="|">=") return 0; esac
 184         return 1
 185 }
 186
 187 precheck() {
 188         if ! git_version="$(git version)"; then
 189                 die "'git version' failed"
 190         fi
 191         case "$git_version" in [Gg]"it version "*);;*)
 192                 die "'git version' output does not start with 'git version '"
 193         esac
 194
 195         vcmp "$git_version" '>=' "$GIT_MINIMUM_VERSION" ||
 196                 die "git version >= $GIT_MINIMUM_VERSION required but found $git_version instead"
 197 }
 198
 199 case "$1" in version|--version|-V)
 200         echo "TopGit version $TG_VERSION"
 201         exit 0
 202 esac
 203
 204 precheck
 205 [ "$1" = "precheck" ] && exit 0
 206
 207
 208 cat_depsmsg_internal()
 209 {
 210         _rev="$(ref_exists_rev "refs/heads/$1")" || return 0
 211         if [ -s "$tg_cache_dir/refs/heads/$1/.$2" ]; then
 212                 if read _rev_match && [ "$_rev" = "$_rev_match" ]; then
 213                         _line=
 214                         while IFS= read -r _line || [ -n "$_line" ]; do
 215                                 printf '%s\n' "$_line"
 216                         done
 217                         return 0
 218                 fi <"$tg_cache_dir/refs/heads/$1/.$2"
 219         fi
 220         [ -d "$tg_cache_dir/refs/heads/$1" ] || mkdir -p "$tg_cache_dir/refs/heads/$1" 2>/dev/null || :
 221         if [ -d "$tg_cache_dir/refs/heads/$1" ]; then
 222                 printf '%s\n' "$_rev" >"$tg_cache_dir/refs/heads/$1/.$2"
 223                 _line=
 224                 git cat-file blob "$_rev:.$2" 2>/dev/null |
 225                 while IFS= read -r _line || [ -n "$_line" ]; do
 226                         printf '%s\n' "$_line" >&3
 227                         printf '%s\n' "$_line"
 228                 done 3>>"$tg_cache_dir/refs/heads/$1/.$2"
 229         else
 230                 git cat-file blob "$_rev:.$2" 2>/dev/null
 231         fi
 232 }
 233
 234 # cat_deps BRANCHNAME
 235 # Caches result
 236 cat_deps()
 237 {
 238         cat_depsmsg_internal "$1" topdeps
 239 }
 240
 241 # cat_msg BRANCHNAME
 242 # Caches result
 243 cat_msg()
 244 {
 245         cat_depsmsg_internal "$1" topmsg
 246 }
 247
 248 # cat_file TOPIC:PATH [FROM]
 249 # cat the file PATH from branch TOPIC when FROM is empty.
 250 # FROM can be -i or -w, than the file will be from the index or worktree,
 251 # respectively. The caller should than ensure that HEAD is TOPIC, to make sense.
 252 cat_file()
 253 {
 254         path="$1"
 255         case "$2" in
 256         -w)
 257                 cat "$root_dir/${path#*:}"
 258                 ;;
 259         -i)
 260                 # ':file' means cat from index
 261                 git cat-file blob ":${path#*:}" 2>/dev/null
 262                 ;;
 263         '')
 264                 case "$path" in
 265                 refs/heads/*:.topdeps)
 266                         _temp="${path%:.topdeps}"
 267                         cat_deps "${_temp#refs/heads/}"
 268                         ;;
 269                 refs/heads/*:.topmsg)
 270                         _temp="${path%:.topmsg}"
 271                         cat_msg "${_temp#refs/heads/}"
 272                         ;;
 273                 *)
 274                         git cat-file blob "$path" 2>/dev/null
 275                         ;;
 276                 esac
 277                 ;;
 278         *)
 279                 die "Wrong argument to cat_file: '$2'"
 280                 ;;
 281         esac
 282 }
 283
 284 # if use_alt_temp_odb and tg_use_alt_odb are true try to write the object(s)
 285 # into the temporary alt odb area instead of the usual location
 286 git_temp_alt_odb_cmd()
 287 {
 288         if [ -n "$use_alt_temp_odb" ] && [ -n "$tg_use_alt_odb" ] &&
 289            [ -n "$TG_OBJECT_DIRECTORY" ] &&
 290            [ -f "$TG_OBJECT_DIRECTORY/info/alternates" ]; then
 291                 (
 292                         GIT_ALTERNATE_OBJECT_DIRECTORIES="$TG_PRESERVED_ALTERNATES"
 293                         GIT_OBJECT_DIRECTORY="$TG_OBJECT_DIRECTORY"
 294                         unset_ TG_OBJECT_DIRECTORY TG_PRESERVED_ALTERNATES
 295                         export GIT_ALTERNATE_OBJECT_DIRECTORIES GIT_OBJECT_DIRECTORY
 296                         git "$@"
 297                 )
 298         else
 299                 git "$@"
 300         fi
 301 }
 302
 303 git_write_tree() { git_temp_alt_odb_cmd write-tree "$@"; }
 304 git_mktree() { git_temp_alt_odb_cmd mktree "$@"; }
 305
 306 # get tree for the committed topic
 307 get_tree_()
 308 {
 309         echo "refs/heads/$1"
 310 }
 311
 312 # get tree for the base
 313 get_tree_b()
 314 {
 315         echo "refs/$topbases/$1"
 316 }
 317
 318 # get tree for the index
 319 get_tree_i()
 320 {
 321         git_write_tree
 322 }
 323
 324 # get tree for the worktree
 325 get_tree_w()
 326 {
 327         i_tree=$(git_write_tree)
 328         (
 329                 # the file for --index-output needs to sit next to the
 330                 # current index file
 331                 cd "$root_dir"
 332                 : ${GIT_INDEX_FILE:="$git_dir/index"}
 333                 TMP_INDEX="$(mktemp "${GIT_INDEX_FILE}-tg.XXXXXX")"
 334                 git read-tree -m $i_tree --index-output="$TMP_INDEX" &&
 335                 GIT_INDEX_FILE="$TMP_INDEX" &&
 336                 export GIT_INDEX_FILE &&
 337                 git diff --name-only -z HEAD |
 338                         git update-index -z --add --remove --stdin &&
 339                 git_write_tree &&
 340                 rm -f "$TMP_INDEX"
 341         )
 342 }
 343
 344 # get tree for arbitrary ref
 345 get_tree_r()
 346 {
 347         echo "$1"
 348 }
 349
 350 # strip_ref "$(git symbolic-ref HEAD)"
 351 # Output will have a leading refs/heads/ or refs/$topbases/ stripped if present
 352 strip_ref()
 353 {
 354         case "$1" in
 355                 refs/"$topbases"/*)
 356                         echol "${1#refs/$topbases/}"
 357                         ;;
 358                 refs/heads/*)
 359                         echol "${1#refs/heads/}"
 360                         ;;
 361                 *)
 362                         echol "$1"
 363         esac
 364 }
 365
 366 # pretty_tree [-t] NAME [-b | -i | -w | -r]
 367 # Output tree ID of a cleaned-up tree without tg's artifacts.
 368 # NAME will be ignored for -i and -w, but needs to be present
 369 # With -r NAME must be a full ref name to a treeish (it's used as-is)
 370 # If -t is used the tree is written into the alternate temporary objects area
 371 pretty_tree()
 372 {
 373         use_alt_temp_odb=
 374         [ "$1" != "-t" ] || { shift; use_alt_temp_odb=1; }
 375         name="$1"
 376         source="${2#?}"
 377         git ls-tree --full-tree "$(get_tree_$source "$name")" |
 378                 sed -ne '/      \.top.*$/!p' |
 379                 git_mktree
 380 }
 381
 382 # return an empty-tree root commit -- date is either passed in or current
 383 # If passed in "$*" must be epochsecs followed by optional hhmm offset (+0000 default)
 384 # An invalid secs causes the current date to be used, an invalid zone offset
 385 # causes +0000 to be used
 386 make_empty_commit()
 387 (
 388         # the empty tree is guaranteed to always be there even in a repo with
 389         # zero objects, but for completeness we force it to exist as a real object
 390         SECS=
 391         read -r SECS ZONE JUNK <<-EOT || :
 392                 $*
 393                 EOT
 394         case "$SECS" in *[!0-9]*) SECS=; esac
 395         if [ -z "$SECS" ]; then
 396                 MTDATE="$(date '+%s %z')"
 397         else
 398                 case "$ZONE" in
 399                         -[01][0-9][0-5][0-9]|+[01][0-9][0-5][0-9])
 400                                 ;;
 401                         [01][0-9][0-5][0-9])
 402                                 ZONE="+$ZONE"
 403                                 ;;
 404                         *)
 405                                 ZONE="+0000"
 406                 esac
 407                 MTDATE="$SECS $ZONE"
 408         fi
 409         EMPTYID="- <-> $MTDATE"
 410         EMPTYTREE="$(git hash-object -t tree -w --stdin < /dev/null)"
 411         printf '%s\n' "tree $EMPTYTREE" "author $EMPTYID" "committer $EMPTYID" '' |
 412         git hash-object -t commit -w --stdin
 413 )
 414
 415 # standard input is a diff
 416 # standard output is the "+" lines with leading "+ " removed
 417 diff_added_lines()
 418 {
 419         awk '
 420 BEGIN      { in_hunk = 0; }
 421 /^@@ /     { in_hunk = 1; }
 422 /^\+/      { if (in_hunk == 1) printf("%s\n", substr($0, 2)); }
 423 /^[^@ +-]/ { in_hunk = 0; }
 424 '
 425 }
 426
 427 # $1 is name of new branch to create locally if all of these are true:
 428 #   a) exists as a remote TopGit branch for "$base_remote"
 429 #   b) the branch "name" does not have any invalid characters in it
 430 #   c) neither of the two branch refs (branch or base) exist locally
 431 # returns success only if a new local branch was created (and dumps message)
 432 auto_create_local_remote()
 433 {
 434         case "$1" in ""|*[" $tab$lf~^:\\*?["]*|.*|*/.*|*.|*./|/*|*/|*//*) return 1; esac
 435         [ -n "$base_remote" ] &&
 436         git update-ref --stdin <<-EOT >/dev/null 2>&1 &&
 437                 verify refs/remotes/$base_remote/${topbases#heads/}/$1 refs/remotes/$base_remote/${topbases#heads/}/$1
 438                 verify refs/remotes/$base_remote/$1 refs/remotes/$base_remote/$1
 439                 create refs/$topbases/$1 refs/remotes/$base_remote/${topbases#heads/}/$1^0
 440                 create refs/heads/$1 refs/remotes/$base_remote/$1^0
 441         EOT
 442         { init_reflog "refs/$topbases/$1" || :; } &&
 443         info "topic branch '$1' automatically set up from remote '$base_remote'"
 444 }
 445
 446 # setup_hook NAME
 447 setup_hook()
 448 {
 449         tgname="${0##*/}"
 450         hook_call="\"\$(\"$tgname\" --hooks-path)\"/$1 \"\$@\""
 451         if [ -f "$git_hooks_dir/$1" ] && grep -Fq "$hook_call" "$git_hooks_dir/$1"; then
 452                 # Another job well done!
 453                 return
 454         fi
 455         # Prepare incantation
 456         hook_chain=
 457         if [ -s "$git_hooks_dir/$1" -a -x "$git_hooks_dir/$1" ]; then
 458                 hook_call="$hook_call"' || exit $?'
 459                 if [ -L "$git_hooks_dir/$1" ] || ! sed -n 1p <"$git_hooks_dir/$1" | grep -Fqx "#!@SHELL_PATH@"; then
 460                         chain_num=
 461                         while [ -e "$git_hooks_dir/$1-chain$chain_num" ]; do
 462                                 chain_num=$(( $chain_num + 1 ))
 463                         done
 464                         mv -f "$git_hooks_dir/$1" "$git_hooks_dir/$1-chain$chain_num"
 465                         hook_chain=1
 466                 fi
 467         else
 468                 hook_call="exec $hook_call"
 469                 [ -d "$git_hooks_dir" ] || mkdir -p "$git_hooks_dir" || :
 470         fi
 471         # Don't call hook if tg is not installed
 472         hook_call="if command -v \"$tgname\" >/dev/null 2>&1; then $hook_call; fi"
 473         # Insert call into the hook
 474         {
 475                 echol "#!@SHELL_PATH@"
 476                 echol "$hook_call"
 477                 if [ -n "$hook_chain" ]; then
 478                         echol "exec \"\$0-chain$chain_num\" \"\$@\""
 479                 else
 480                         [ ! -s "$git_hooks_dir/$1" ] || cat "$git_hooks_dir/$1"
 481                 fi
 482         } >"$git_hooks_dir/$1+"
 483         chmod a+x "$git_hooks_dir/$1+"
 484         mv "$git_hooks_dir/$1+" "$git_hooks_dir/$1"
 485 }
 486
 487 # setup_ours (no arguments)
 488 setup_ours()
 489 {
 490         if [ ! -s "$git_common_dir/info/attributes" ] || ! grep -q topmsg "$git_common_dir/info/attributes"; then
 491                 [ -d "$git_common_dir/info" ] || mkdir "$git_common_dir/info"
 492                 {
 493                         echo ".topmsg   merge=ours"
 494                         echo ".topdeps  merge=ours"
 495                 } >>"$git_common_dir/info/attributes"
 496         fi
 497         if ! git config merge.ours.driver >/dev/null; then
 498                 git config merge.ours.name '"always keep ours" merge driver'
 499                 git config merge.ours.driver 'touch %A'
 500         fi
 501 }
 502
 503 # measure_branch NAME [BASE] [EXTRAHEAD...]
 504 measure_branch()
 505 {
 506         _bname="$1"; _base="$2"
 507         shift; shift
 508         [ -n "$_base" ] || _base="refs/$topbases/$(strip_ref "$_bname")"
 509         # The caller should've verified $name is valid
 510         _commits="$(git rev-list --count "$_bname" "$@" ^"$_base" --)"
 511         _nmcommits="$(git rev-list --count --no-merges "$_bname" "$@" ^"$_base" --)"
 512         if [ $_commits -ne 1 ]; then
 513                 _suffix="commits"
 514         else
 515                 _suffix="commit"
 516         fi
 517         echo "$_commits/$_nmcommits $_suffix"
 518 }
 519
 520 # true if $1 is contained by (or the same as) $2
 521 # this is never slower than merge-base --is-ancestor and is often slightly faster
 522 contained_by()
 523 {
 524         [ "$(git rev-list --count --max-count=1 "$1" --not "$2" --)" = "0" ]
 525 }
 526
 527 # branch_contains B1 B2
 528 # Whether B1 is a superset of B2.
 529 branch_contains()
 530 {
 531         _revb1="$(ref_exists_rev "$1")" || return 0
 532         _revb2="$(ref_exists_rev "$2")" || return 0
 533         if [ -s "$tg_cache_dir/$1/.bc/$2/.d" ]; then
 534                 if read _result _rev_matchb1 _rev_matchb2 &&
 535                         [ "$_revb1" = "$_rev_matchb1" -a "$_revb2" = "$_rev_matchb2" ]; then
 536                         return $_result
 537                 fi <"$tg_cache_dir/$1/.bc/$2/.d"
 538         fi
 539         [ -d "$tg_cache_dir/$1/.bc/$2" ] || mkdir -p "$tg_cache_dir/$1/.bc/$2" 2>/dev/null || :
 540         _result=0
 541         contained_by "$_revb2" "$_revb1" || _result=1
 542         if [ -d "$tg_cache_dir/$1/.bc/$2" ]; then
 543                 echo "$_result" "$_revb1" "$_revb2" >"$tg_cache_dir/$1/.bc/$2/.d"
 544         fi
 545         return $_result
 546 }
 547
 548 create_ref_dirs()
 549 {
 550         [ ! -s "$tg_tmp_dir/tg~ref-dirs-created" -a -s "$tg_ref_cache" ] || return 0
 551         mkdir -p "$tg_tmp_dir/cached/refs"
 552         awk '{x = $1; sub(/^refs\//, "", x); if (x != "") print x}' <"$tg_ref_cache" | tr '\n' '\0' | {
 553                 cd "$tg_tmp_dir/cached/refs" &&
 554                 xargs -0 mkdir -p
 555         }
 556         awk -v p="$tg_tmp_dir/cached/" '
 557                 NF == 2 &&
 558                 $1 ~ /^refs\/./ &&
 559                 $2 ~ /^[0-9a-fA-F][0-9a-fA-F][0-9a-fA-F][0-9a-fA-F]+$/ {
 560                         fn = p $1 "/.ref"
 561                         print "0 " $2 >fn
 562                         close(fn)
 563                 }
 564         ' <"$tg_ref_cache"
 565         echo 1 >"$tg_tmp_dir/tg~ref-dirs-created"
 566 }
 567
 568 # If the first argument is non-empty, stores "1" there if this call created the cache
 569 v_create_ref_cache()
 570 {
 571         [ -n "$tg_ref_cache" -a ! -s "$tg_ref_cache" ] || return 0
 572         _remotespec=
 573         [ -z "$base_remote" ] || _remotespec="refs/remotes/$base_remote"
 574         [ -z "$1" ] || eval "$1=1"
 575         git for-each-ref --format='%(refname) %(objectname)' \
 576                 refs/heads "refs/$topbases" $_remotespec >"$tg_ref_cache"
 577         create_ref_dirs
 578 }
 579
 580 remove_ref_cache()
 581 {
 582         [ -n "$tg_ref_cache" -a -s "$tg_ref_cache" ] || return 0
 583         >"$tg_ref_cache"
 584         >"$tg_ref_cache_br"
 585         >"$tg_ref_cache_rbr"
 586         >"$tg_ref_cache_ann"
 587         >"$tg_ref_cache_dep"
 588 }
 589
 590 # setting tg_ref_cache_only to non-empty will force non-$tg_ref_cache lookups to fail
 591 rev_parse()
 592 {
 593         if [ -n "$tg_ref_cache" -a -s "$tg_ref_cache" ]; then
 594                 awk -v r="$1" 'BEGIN {e=1}; $1 == r {print $2; e=0; exit}; END {exit e}' <"$tg_ref_cache"
 595         else
 596                 [ -z "$tg_ref_cache_only" ] || return 1
 597                 git rev-parse --quiet --verify "$1^0" -- 2>/dev/null
 598         fi
 599 }
 600
 601 # ref_exists_rev REF
 602 # Whether REF is a valid ref name
 603 # REF must be fully qualified and start with refs/heads/, refs/$topbases/
 604 # or, if $base_remote is set, refs/remotes/$base_remote/
 605 # Caches result if $tg_read_only and outputs HASH on success
 606 ref_exists_rev()
 607 {
 608         case "$1" in
 609                 refs/*)
 610                         ;;
 611                 $octet20)
 612                         printf '%s' "$1"
 613                         return;;
 614                 *)
 615                         die "ref_exists_rev requires fully-qualified ref name (given: $1)"
 616         esac
 617         [ -n "$tg_read_only" ] || { git rev-parse --quiet --verify "$1^0" -- 2>/dev/null; return; }
 618         _result=
 619         _result_rev=
 620         { read -r _result _result_rev <"$tg_tmp_dir/cached/$1/.ref"; } 2>/dev/null || :
 621         [ -z "$_result" ] || { printf '%s' "$_result_rev"; return $_result; }
 622         _result_rev="$(rev_parse "$1")"
 623         _result=$?
 624         [ -d "$tg_tmp_dir/cached/$1" ] || mkdir -p "$tg_tmp_dir/cached/$1" 2>/dev/null
 625         [ ! -d "$tg_tmp_dir/cached/$1" ] ||
 626         echo $_result $_result_rev >"$tg_tmp_dir/cached/$1/.ref" 2>/dev/null || :
 627         printf '%s' "$_result_rev"
 628         return $_result
 629 }
 630
 631 # Same as ref_exists_rev but output is abbreviated hash
 632 # Optional second argument defaults to --short but may be any --short=.../--no-short option
 633 ref_exists_rev_short()
 634 {
 635         case "$1" in
 636                 refs/*)
 637                         ;;
 638                 $octet20)
 639                         ;;
 640                 *)
 641                         die "ref_exists_rev_short requires fully-qualified ref name"
 642         esac
 643         [ -n "$tg_read_only" ] || { git rev-parse --quiet --verify ${2:---short} "$1^0" -- 2>/dev/null; return; }
 644         _result=
 645         _result_rev=
 646         { read -r _result _result_rev <"$tg_tmp_dir/cached/$1/.rfs"; } 2>/dev/null || :
 647         [ -z "$_result" ] || { printf '%s' "$_result_rev"; return $_result; }
 648         _result_rev="$(rev_parse "$1")"
 649         _result=$?
 650         if [ $_result -eq 0 ]; then
 651                 _result_rev="$(git rev-parse --verify ${2:---short} --quiet "$_result_rev^0" --)"
 652                 _result=$?
 653         fi
 654         [ -d "$tg_tmp_dir/cached/$1" ] || mkdir -p "$tg_tmp_dir/cached/$1" 2>/dev/null
 655         [ ! -d "$tg_tmp_dir/cached/$1" ] ||
 656         echo $_result $_result_rev >"$tg_tmp_dir/cached/$1/.rfs" 2>/dev/null || :
 657         printf '%s' "$_result_rev"
 658         return $_result
 659 }
 660
 661 # ref_exists REF
 662 # Whether REF is a valid ref name
 663 # REF must be fully qualified and start with refs/heads/, refs/$topbases/
 664 # or, if $base_remote is set, refs/remotes/$base_remote/
 665 # Caches result
 666 ref_exists()
 667 {
 668         ref_exists_rev "$1" >/dev/null
 669 }
 670
 671 # rev_parse_tree REF
 672 # Runs git rev-parse REF^{tree}
 673 # Caches result if $tg_read_only
 674 rev_parse_tree()
 675 {
 676         [ -n "$tg_read_only" ] || { git rev-parse --verify "$1^{tree}" -- 2>/dev/null; return; }
 677         if [ -f "$tg_tmp_dir/cached/$1/.rpt" ]; then
 678                 if IFS= read -r _result <"$tg_tmp_dir/cached/$1/.rpt"; then
 679                         printf '%s\n' "$_result"
 680                         return 0
 681                 fi
 682                 return 1
 683         fi
 684         [ -d "$tg_tmp_dir/cached/$1" ] || mkdir -p "$tg_tmp_dir/cached/$1" 2>/dev/null || :
 685         if [ -d "$tg_tmp_dir/cached/$1" ]; then
 686                 git rev-parse --verify "$1^{tree}" -- >"$tg_tmp_dir/cached/$1/.rpt" 2>/dev/null || :
 687                 if IFS= read -r _result <"$tg_tmp_dir/cached/$1/.rpt"; then
 688                         printf '%s\n' "$_result"
 689                         return 0
 690                 fi
 691                 return 1
 692         fi
 693         git rev-parse --verify "$1^{tree}" -- 2>/dev/null
 694 }
 695
 696 # has_remote BRANCH
 697 # Whether BRANCH has a remote equivalent (accepts ${topbases#heads/}/ too)
 698 has_remote()
 699 {
 700         [ -n "$base_remote" ] && ref_exists "refs/remotes/$base_remote/$1"
 701 }
 702
 703 # Return the verified TopGit branch name for "$2" in "$1" or die with an error.
 704 # If -z "$1" still set return code but do not return result
 705 # As a convenience, if HEAD or @ is given and HEAD is a symbolic ref to
 706 # refs/heads/... then ... will be verified instead.
 707 # if "$3" = "-f" (for fail) then return an error rather than dying.
 708 v_verify_topgit_branch()
 709 {
 710         if [ "$2" = "HEAD" ] || [ "$2" = "@" ]; then
 711                 _verifyname="$(git symbolic-ref HEAD 2>/dev/null)" || :
 712                 [ -n "$_verifyname" -o "$3" = "-f" ] || die "HEAD is not a symbolic ref"
 713                 case "$_verifyname" in refs/"$topbases"/*|refs/heads/*);;*)
 714                         [ "$3" != "-f" ] || return 1
 715                         die "HEAD is not a symbolic ref to the refs/heads namespace"
 716                 esac
 717                 set -- "$1" "$_verifyname" "$3"
 718         fi
 719         case "$2" in
 720                 refs/"$topbases"/*)
 721                         _verifyname="${2#refs/$topbases/}"
 722                         ;;
 723                 refs/heads/*)
 724                         _verifyname="${2#refs/heads/}"
 725                         ;;
 726                 *)
 727                         _verifyname="$2"
 728                         ;;
 729         esac
 730         if ! ref_exists "refs/heads/$_verifyname"; then
 731                 [ "$3" != "-f" ] || return 1
 732                 die "no such branch: $_verifyname"
 733         fi
 734         if ! ref_exists "refs/$topbases/$_verifyname"; then
 735                 [ "$3" != "-f" ] || return 1
 736                 die "not a TopGit-controlled branch: $_verifyname"
 737         fi
 738         [ -z "$1" ] || eval "$1="'"$_verifyname"'
 739 }
 740
 741 # Return the verified TopGit branch name or die with an error.
 742 # As a convenience, if HEAD or @ is given and HEAD is a symbolic ref to
 743 # refs/heads/... then ... will be verified instead.
 744 # if "$2" = "-f" (for fail) then return an error rather than dying.
 745 verify_topgit_branch()
 746 {
 747         v_verify_topgit_branch _verifyname "$@" || return
 748         printf '%s' "$_verifyname"
 749 }
 750
 751 # Caches result
 752 # $1 = branch name (i.e. "t/foo/bar")
 753 # $2 = optional result of rev-parse "refs/heads/$1"
 754 # $3 = optional result of rev-parse "refs/$topbases/$1"
 755 branch_annihilated()
 756 {
 757         _branch_name="$1"
 758         _rev="${2:-$(ref_exists_rev "refs/heads/$_branch_name")}"
 759         _rev_base="${3:-$(ref_exists_rev "refs/$topbases/$_branch_name")}"
 760
 761         _result=
 762         _result_rev=
 763         _result_rev_base=
 764         { read -r _result _result_rev _result_rev_base <"$tg_cache_dir/refs/heads/$_branch_name/.ann"; } 2>/dev/null || :
 765         [ -z "$_result" -o "$_result_rev" != "$_rev" -o "$_result_rev_base" != "$_rev_base" ] || return $_result
 766
 767         # use the merge base in case the base is ahead.
 768         mb="$(git merge-base "$_rev_base" "$_rev" 2>/dev/null)"
 769
 770         test -z "$mb" || test "$(rev_parse_tree "$mb")" = "$(rev_parse_tree "$_rev")"
 771         _result=$?
 772         [ -d "$tg_cache_dir/refs/heads/$_branch_name" ] || mkdir -p "$tg_cache_dir/refs/heads/$_branch_name" 2>/dev/null
 773         [ ! -d "$tg_cache_dir/refs/heads/$_branch_name" ] ||
 774         echo $_result $_rev $_rev_base >"$tg_cache_dir/refs/heads/$_branch_name/.ann" 2>/dev/null || :
 775         return $_result
 776 }
 777
 778 non_annihilated_branches()
 779 {
 780         refscacheopt="${TG_DEBUG:+-p=\"\$tg_ref_cache.pre\" }"
 781         if [ -n "$tg_read_only" ] && [ -n "$tg_ref_cache" ] && [ -s "$tg_ref_cache" ]; then
 782                 refscacheopt="$refscacheopt"'-r="$tg_ref_cache" "refs/$topbases"'
 783         fi
 784         eval run_awk_topgit_branches -n "$refscacheopt" '"refs/$topbases" "$@"'
 785 }
 786
 787 # Make sure our tree is clean
 788 # if optional "$1" given also verify that a checkout to "$1" would succeed
 789 ensure_clean_tree()
 790 {
 791         check_status
 792         [ -z "$tg_state$git_state" ] || { do_status; exit 1; }
 793         git update-index --ignore-submodules --refresh ||
 794                 die "the working directory has uncommitted changes (see above) - first commit or reset them"
 795         [ -z "$(git diff-index --cached --name-status -r --ignore-submodules HEAD --)" ] ||
 796                 die "the index has uncommited changes"
 797         [ -z "$1" ] || git read-tree -n -u -m "$1" ||
 798                 die "git checkout \"$1\" would fail"
 799 }
 800
 801 # Make sure .topdeps and .topmsg are "clean"
 802 # They are considered "clean" if each is identical in worktree, index and HEAD
 803 # With "-u" as the argument skip the HEAD check (-u => unborn)
 804 # untracked .topdeps and/or .topmsg files are always considered "dirty" as well
 805 # with -u them just existing constitutes "dirty"
 806 ensure_clean_topfiles()
 807 {
 808         _dirtw=0
 809         _dirti=0
 810         _dirtu=0
 811         _check="$(git diff-files --ignore-submodules --name-only -- :/.topdeps :/.topmsg)" &&
 812         [ -z "$_check" ] || _dirtw=1
 813         if [ "$1" != "-u" ]; then
 814                 _check="$(git diff-index --cached --ignore-submodules --name-only HEAD -- :/.topdeps :/.topmsg)" &&
 815                 [ -z "$_check" ] || _dirti=1
 816         fi
 817         if [ "$_dirti$_dirtw" = "00" ]; then
 818                 v_get_show_cdup
 819                 if [ -e "${git_cdup_result}.topdeps" ] || [ -e "${git_cdup_result}.topmsg" ]; then
 820                         [ "$1" != "-u" ] &&
 821                         _check="$(git status --porcelain --ignored --untracked-files --ignore-submodules -- :/.topdeps :/.topmsg)" &&
 822                         [ -z "$_check" ] || _dirtu=1
 823                 fi
 824         fi
 825         if [ "$_dirtu$_dirti$_dirtw" != "000" ]; then
 826                 git status --ignored --untracked-files --ignore-submodules -- :/.topdeps :/.topmsg || :
 827                 case "$_dirtu$_dirti$_dirtw" in
 828                 001) die "the working directory has uncommitted changes (see above) - first commit or reset them";;
 829                 010) die "the index has uncommited changes (see above)";;
 830                 011) die "the working directory and index have uncommitted changes (see above) - first commit or reset them";;
 831                 100) die "the working directory has untracked files that would be overwritten (see above)";;
 832                 esac
 833         fi
 834 }
 835
 836 # is_sha1 REF
 837 # Whether REF is a SHA1 (compared to a symbolic name).
 838 is_sha1()
 839 {
 840         case "$1" in $octet20) return 0;; esac
 841         return 1
 842 }
 843
 844 # navigate_deps <run_awk_topgit_navigate options and arguments>
 845 # all options and arguments are passed through to run_awk_topgit_navigate
 846 # except for a leading -td= option, if any, which is picked off for deps
 847 # after arranging to feed it a suitable deps list
 848 navigate_deps()
 849 {
 850         dogfer=
 851         dorad=1
 852         userc=
 853         tmpdep=
 854         ratd_opts="${TG_DEBUG:+-p=\"\$tg_ref_cache.pre\" }"
 855         ratn_opts=
 856         if [ -n "$tg_read_only" ] && [ -n "$tg_ref_cache" ]; then
 857                 userc=1
 858                 tmprfs="$tg_ref_cache"
 859                 tmptgbr="$tg_ref_cache_br"
 860                 tmpann="$tg_ref_cache_ann"
 861                 tmpdep="$tg_ref_cache_dep"
 862                 [ -s "$tg_ref_cache" ] || dogfer=1
 863                 [ -n "$dogfer" ] || ! [ -s "$tmptgbr" ] || ! [ -f "$tmpann" ] || ! [ -s "$tmpdep" ] || dorad=
 864         else
 865                 ratd_opts="${ratd_opts}-rmr"
 866                 ratn_opts="-rma -rmb"
 867                 tmprfs="$tg_tmp_dir/refs.$$"
 868                 tmpann="$tg_tmp_dir/ann.$$"
 869                 tmptgbr="$tg_tmp_dir/tgbr.$$"
 870                 dogfer=1
 871         fi
 872         refpats="\"refs/heads\" \"refs/\$topbases\""
 873         [ -z "$base_remote" ] || refpats="$refpats \"refs/remotes/\$base_remote\""
 874         [ -z "$dogfer" ] ||
 875         eval git for-each-ref '--format="%(refname) %(objectname)"' "$refpats" >"$tmprfs"
 876         depscmd="run_awk_topgit_deps $ratd_opts"
 877         case "$1" in -td=*)
 878                 userc=
 879                 depscmd="$depscmd $1"
 880                 shift
 881         esac
 882         depscmd="$depscmd"' -a="$tmpann" -b="$tmptgbr" -r="$tmprfs" -m="$mtblob" -s "refs/$topbases"'
 883         if [ -n "$userc" ]; then
 884                 if [ -n "$dorad" ]; then
 885                         eval "$depscmd" >"$tmpdep"
 886                 fi
 887                 depscmd='<"$tmpdep" '
 888         else
 889                 depscmd="$depscmd |"
 890         fi
 891         eval "$depscmd" run_awk_topgit_navigate '-a="$tmpann" -b="$tmptgbr"' "$ratn_opts" '"$@"'
 892 }
 893
 894 # recurse_deps_internal NAME [BRANCHPATH...]
 895 # get recursive list of dependencies with leading 0 if branch exists 1 if missing
 896 # followed by a 1 if the branch is "tgish" (2 if it also has a remote); 0 if not
 897 # followed by a 0 for a non-leaf, 1 for a leaf or 2 for annihilated tgish
 898 # but missing and remotes are always "0"
 899 # then the branch name followed by its depedency chain (which might be empty)
 900 # An output line might look like this:
 901 #   0 1 1 t/foo/leaf t/foo/int t/stage
 902 # If no_remotes is non-empty, exclude remotes
 903 # If recurse_preorder is non-empty, do a preorder rather than postorder traversal
 904 # If with_top_level is non-empty, include the top-level that's normally omitted
 905 # any branch names in the space-separated recurse_deps_exclude variable
 906 # are skipped (along with their dependencies)
 907 recurse_deps_internal()
 908 {
 909         case " $recurse_deps_exclude " in *" $1 "*) return 0; esac
 910         ratr_opts="${recurse_preorder:+-f} ${with_top_level:+-s}"
 911         dogfer=
 912         dorad=1
 913         userc=
 914         tmpdep=
 915         if [ -n "$tg_read_only" ] && [ -n "$tg_ref_cache" ]; then
 916                 userc=1
 917                 tmprfs="$tg_ref_cache"
 918                 tmptgbr="$tg_ref_cache_br"
 919                 tmpann="$tg_ref_cache_ann"
 920                 tmpdep="$tg_ref_cache_dep"
 921                 [ -s "$tg_ref_cache" ] || dogfer=1
 922                 [ -n "$dogfer" ] || ! [ -s "$tmptgbr" ] || ! [ -f "$tmpann" ] || ! [ -s "$tmpdep" ] || dorad=
 923         else
 924                 ratr_opts="$ratr_opts -rmh -rma -rmb"
 925                 tmprfs="$tg_tmp_dir/refs.$$"
 926                 tmpann="$tg_tmp_dir/ann.$$"
 927                 tmptgbr="$tg_tmp_dir/tgbr.$$"
 928                 dogfer=1
 929         fi
 930         refpats="\"refs/heads\" \"refs/\$topbases\""
 931         [ -z "$base_remote" ] || refpats="$refpats \"refs/remotes/\$base_remote\""
 932         tmptgrmtbr=
 933         dorab=1
 934         if [ -z "$no_remotes" ] && [ -n "$base_remote" ]; then
 935                 if [ -n "$userc" ]; then
 936                         tmptgrmtbr="$tg_ref_cache_rbr"
 937                         [ -n "$dogfer" ] || ! [ -s "$tmptgrmtbr" ] || dorab=
 938                 else
 939                         tmptgrmtbr="$tg_tmp_dir/tgrmtbr.$$"
 940                         ratr_opts="$ratr_opts -rmr"
 941                 fi
 942                 ratr_opts="$ratr_opts -r=\"\$tmptgbr\" -u=\"refs/remotes/\$base_remote/\${topbases#heads/}\""
 943         fi
 944         [ -z "$dogfer" ] ||
 945         eval git for-each-ref '--format="%(refname) %(objectname)"' "$refpats" >"$tmprfs"
 946         if [ -n "$tmptgrmtbr" ] && [ -n "$dorab" ]; then
 947                 run_awk_topgit_branches -n -h="refs/remotes/$base_remote" -r="$tmprfs" \
 948                         "refs/remotes/$base_remote/${topbases#heads/}" >"$tmptgrmtbr"
 949         fi
 950         depscmd="run_awk_topgit_deps${TG_DEBUG:+ -p=\"\$tg_ref_cache.pre\"}"
 951         depscmd="$depscmd"' -a="$tmpann" -b="$tmptgbr" -r="$tmprfs" -m="$mtblob" "refs/$topbases"'
 952         if [ -n "$userc" ]; then
 953                 if [ -n "$dorad" ]; then
 954                         eval "$depscmd" >"$tmpdep"
 955                 fi
 956                 depscmd='<"$tmpdep" '
 957         else
 958                 depscmd="$depscmd |"
 959         fi
 960         eval "$depscmd" run_awk_topgit_recurse '-a="$tmpann" -b="$tmptgbr"' \
 961                 '-c=1 -h="$tmprfs"' "$ratr_opts" '-x="$recurse_deps_exclude"' '"$@"'
 962 }
 963
 964 # do_eval CMD
 965 # helper for recurse_deps so that a return statement executed inside CMD
 966 # does not return from recurse_deps.  This shouldn't be necessary, but it
 967 # seems that it actually is.
 968 do_eval()
 969 {
 970         eval "$@"
 971 }
 972
 973 # becomes read-only for caching purposes
 974 # assigns new value to tg_read_only
 975 # become_cacheable/undo_become_cacheable calls may be nested
 976 become_cacheable()
 977 {
 978         _old_tg_read_only="$tg_read_only"
 979         if [ -z "$tg_read_only" ]; then
 980                 ! [ -e "$tg_tmp_dir/cached" ] && ! [ -e "$tg_tmp_dir/tg~ref-dirs-created" ] ||
 981                 rm -rf "$tg_tmp_dir/cached" "$tg_tmp_dir/tg~ref-dirs-created"
 982                 tg_read_only=1
 983         fi
 984         _my_ref_cache=
 985         v_create_ref_cache _my_ref_cache
 986         _my_ref_cache="${_my_ref_cache:+1}"
 987         tg_read_only="undo${_my_ref_cache:-0}-$_old_tg_read_only"
 988 }
 989
 990 # restores tg_read_only and ref_cache to state before become_cacheable call
 991 # become_cacheable/undo_bocome_cacheable calls may be nested
 992 undo_become_cacheable()
 993 {
 994         case "$tg_read_only" in
 995                 "undo"[01]"-"*)
 996                         _suffix="${tg_read_only#undo?-}"
 997                         [ "${tg_read_only%$_suffix}" = "undo0-" ] || remove_ref_cache
 998                         tg_read_only="$_suffix"
 999         esac
1000 }
1001
1002 # just call this, no undo, sets tg_read_only= and removes ref cache and cached results
1003 become_non_cacheable()
1004 {
1005         remove_ref_cache
1006         tg_read_only=
1007         ! [ -e "$tg_tmp_dir/cached" ] && ! [ -e "$tg_tmp_dir/tg~ref-dirs-created" ] ||
1008         rm -rf "$tg_tmp_dir/cached" "$tg_tmp_dir/tg~ref-dirs-created"
1009 }
1010
1011 # call this to make sure Git will not complain about a missing user/email
1012 # result is cached in TG_IDENT_CHECKED and a non-empty value suppresses the check
1013 ensure_ident_available()
1014 {
1015         [ -z "$TG_IDENT_CHECKED" ] || return 0
1016         git var GIT_AUTHOR_IDENT >/dev/null &&
1017         git var GIT_COMMITTER_IDENT >/dev/null || exit
1018         TG_IDENT_CHECKED=1
1019         export TG_IDENT_CHECKED
1020         return 0
1021 }
1022
1023 # recurse_deps [-o=<options string>] CMD NAME [BRANCHPATH...]
1024 # Recursively eval CMD on all dependencies of NAME.
1025 # Dependencies are visited in topological order.
1026 # If <options string> is given, it's eval'd into the recurse_deps_internal
1027 # call just before the "--" that's passed just before NAME
1028 # CMD can refer to the following variables:
1029 #
1030 #   _ret              starts as 0; CMD can change; will be final return result
1031 #   _dep              bare branch name or "refs/remotes/..." for a remote base
1032 #   _name             has $_dep in its .topdeps ("" for top and $with_top_level)
1033 #   _depchain         0+ space-separated branch names forming a path to top
1034 #   _dep_missing      boolean "1" if no such $_dep ref; "" if ref present
1035 #   _dep_is_leaf      boolean "1" if leaf; "" if not
1036 #   _dep_is_tgish     boolean "1" if tgish; "" if not (which implies no remote)
1037 #   _dep_has_remote   boolean "1" if $_dep has_remote; "" if not
1038 #   _dep_annihilated  boolean "1" if $_dep annihilated; "" if not
1039 #
1040 # CMD may use a "return" statement without issue; its return value is ignored,
1041 # but if CMD sets _ret to a negative value, e.g. "-0" or "-1" the enumeration
1042 # will stop immediately and the value with the leading "-" stripped off will
1043 # be the final result code
1044 #
1045 # CMD can refer to $_name for queried branch name,
1046 # $_dep for dependency name,
1047 # $_depchain for space-seperated branch backtrace,
1048 # $_dep_missing boolean to check whether $_dep is present
1049 # and the $_dep_is_tgish and $_dep_annihilated booleans.
1050 # If recurse_preorder is NOT set then the $_dep_is_leaf boolean is also valid.
1051 # It can modify $_ret to affect the return value
1052 # of the whole function.
1053 # If recurse_deps() hits missing dependencies, it will append
1054 # them to space-separated $missing_deps list and skip them
1055 # after calling CMD with _dep_missing set.
1056 # remote dependencies are processed if no_remotes is unset.
1057 # any branch names in the space-separated recurse_deps_exclude variable
1058 # are skipped (along with their dependencies)
1059 #
1060 # If no_remotes is non-empty, exclude remotes
1061 # If recurse_preorder is non-empty, do a preorder rather than postorder traversal
1062 # If with_top_level is non-empty, include the top-level that's normally omitted
1063 # any branch names in the space-separated recurse_deps_exclude variable
1064 # are skipped (along with their dependencies)
1065 recurse_deps()
1066 {
1067         _opts=
1068         case "$1" in -o=*) _opts="${1#-o=}"; shift; esac
1069         _cmd="$1"; shift
1070
1071         _depsfile="$(get_temp tg-depsfile)"
1072         eval recurse_deps_internal "$_opts" -- '"$@"' >"$_depsfile" || :
1073
1074         _ret=0
1075         while read _ismissing _istgish _isleaf _dep _name _deppath; do
1076                 _depchain="$_name${_deppath:+ $_deppath}"
1077                 _dep_is_tgish=
1078                 [ "$_istgish" = "0" ] || _dep_is_tgish=1
1079                 _dep_has_remote=
1080                 [ "$_istgish" != "2" ] || _dep_has_remote=1
1081                 _dep_missing=
1082                 if [ "$_ismissing" != "0" ]; then
1083                         _dep_missing=1
1084                         case " $missing_deps " in *" $_dep "*);;*)
1085                                 missing_deps="${missing_deps:+$missing_deps }$_dep"
1086                         esac
1087                 fi
1088                 _dep_annihilated=
1089                 _dep_is_leaf=
1090                 if [ "$_isleaf" = "1" ]; then
1091                         _dep_is_leaf=1
1092                 elif [ "$_isleaf" = "2" ]; then
1093                         _dep_annihilated=1
1094                 fi
1095                 do_eval "$_cmd" || :
1096                 if [ "${_ret#-}" != "$_ret" ]; then
1097                         _ret="${_ret#-}"
1098                         break
1099                 fi
1100         done <"$_depsfile"
1101         rm -f "$_depsfile"
1102         return ${_ret:-0}
1103 }
1104
1105 # find_leaves NAME
1106 # output (one per line) the unique leaves of NAME
1107 # a leaf is either
1108 #   1) a non-tgish dependency
1109 #   2) the base of a tgish dependency with no non-annihilated dependencies
1110 # duplicates are suppressed (by commit rev) and remotes are always ignored
1111 # if a leaf has an exact tag match that will be output
1112 # note that recurse_deps_exclude IS honored for this operation
1113 find_leaves()
1114 {
1115         no_remotes=1
1116         with_top_level=1
1117         recurse_preorder=
1118         seen_leaf_refs=
1119         seen_leaf_revs=
1120         while read _ismissing _istgish _isleaf _dep _name _deppath; do
1121                 [ "$_isleaf" = "1" ] && [ "$_ismissing" = "0" ] || continue
1122                 if [ "$_istgish" != "0" ]; then
1123                         fulldep="refs/$topbases/$_dep"
1124                 else
1125                         fulldep="refs/heads/$_dep"
1126                 fi
1127                 case " $seen_leaf_refs " in *" $fulldep "*);;*)
1128                         seen_leaf_refs="${seen_leaf_refs:+$seen_leaf_refs }$fulldep"
1129                         if fullrev="$(ref_exists_rev "$fulldep")"; then
1130                                 case " $seen_leaf_revs " in *" $fullrev "*);;*)
1131                                         seen_leaf_revs="${seen_leaf_revs:+$seen_leaf_revs }$fullrev"
1132                                         # See if Git knows it by another name
1133                                         if tagname="$(git describe --exact-match "$fullrev" 2>/dev/null)" && [ -n "$tagname" ]; then
1134                                                 echo "refs/tags/$tagname"
1135                                         else
1136                                                 echo "$fulldep"
1137                                         fi
1138                                 esac
1139                         fi
1140                 esac
1141         done <<-EOT
1142         $(recurse_deps_internal -l -o=1 -- "$1")
1143         EOT
1144         with_top_level=
1145 }
1146
1147 # branch_needs_update
1148 # This is a helper function for determining whether given branch
1149 # is up-to-date wrt. its dependencies. It expects input as if it
1150 # is called as a recurse_deps() helper.
1151 # In case the branch does need update, it will echo it together
1152 # with the branch backtrace on the output (see needs_update()
1153 # description for details) and set $_ret to non-zero.
1154 branch_needs_update()
1155 {
1156         if [ -n "$_dep_missing" ]; then
1157                 echo "! $_dep $_depchain"
1158                 return 0
1159         fi
1160
1161         if [ -n "$_dep_is_tgish" ]; then
1162                 [ -z "$_dep_annihilated" ] || return 0
1163
1164                 if [ -n "$_dep_has_remote" ]; then
1165                         branch_contains "refs/heads/$_dep" "refs/remotes/$base_remote/$_dep" ||
1166                                 echo "refs/remotes/$base_remote/$_dep $_dep $_depchain"
1167                 fi
1168                 # We want to sync with our base first and should output this before
1169                 # the remote branch, but the order does not actually matter to tg-update
1170                 # as it just recurses regardless, but it does matter for tg-info (which
1171                 # treats out-of-date bases as though they were already merged in) so
1172                 # we output the remote before the base.
1173                 branch_contains "refs/heads/$_dep" "refs/$topbases/$_dep" || {
1174                         echo ": $_dep $_depchain"
1175                         _ret=1
1176                         return
1177                 }
1178         fi
1179
1180         if [ -n "$_name" ]; then
1181                 case "$_dep" in refs/*) _fulldep="$_dep";; *) _fulldep="refs/heads/$_dep";; esac
1182                 if ! branch_contains "refs/$topbases/$_name" "$_fulldep"; then
1183                         # Some new commits in _dep
1184                         echo "$_dep $_depchain"
1185                         _ret=1
1186                 fi
1187         fi
1188 }
1189
1190 # needs_update NAME
1191 # This function is recursive; it outputs reverse path from NAME
1192 # to the branch (e.g. B_DIRTY B1 B2 NAME), one path per line,
1193 # inner paths first. Innermost name can be refs/remotes/<remote>/<name>
1194 # if the head is not in sync with the <remote> branch <name>, ':' if
1195 # the head is not in sync with the base (in this order of priority)
1196 # or '!' if dependency is missing.  Note that the remote branch, base
1197 # order is reversed from the order they will actually be updated in
1198 # order to accomodate tg info which treats out-of-date items that are
1199 # only in the base as already being in the head for status purposes.
1200 # It will also return non-zero status if NAME needs update.
1201 # If needs_update() hits missing dependencies, it will append
1202 # them to space-separated $missing_deps list and skip them.
1203 needs_update()
1204 {
1205         recurse_deps branch_needs_update "$1"
1206 }
1207
1208 # branch_empty NAME [-i | -w]
1209 branch_empty()
1210 {
1211         if [ -z "$2" ]; then
1212                 _rev="$(ref_exists_rev "refs/heads/$1")" || return 0
1213                 _result=
1214                 _result_rev=
1215                 { read -r _result _result_rev <"$tg_cache_dir/refs/heads/$1/.mt"; } 2>/dev/null || :
1216                 [ -z "$_result" -o "$_result_rev" != "$_rev" ] || return $_result
1217                 _result=0
1218                 [ "$(pretty_tree -t "$1" -b)" = "$(pretty_tree -t "$1" $2)" ] || _result=$?
1219                 [ -d "$tg_cache_dir/refs/heads/$1" ] || mkdir -p "$tg_cache_dir/refs/heads/$1" 2>/dev/null
1220                 [ ! -d "$tg_cache_dir/refs/heads/$1" ] || echo $_result $_rev >"$tg_cache_dir/refs/heads/$1/.mt"
1221                 return $_result
1222         else
1223                 [ "$(pretty_tree -t "$1" -b)" = "$(pretty_tree -t "$1" $2)" ]
1224         fi
1225 }
1226
1227 v_get_tdmopt_internal()
1228 {
1229         [ -n "$1" ] && [ -n "$3" ] || return 0
1230         [ "$2" = "-i" ] || [ "$2" = "-w" ] || return 0
1231         _optval=
1232         if v_verify_topgit_branch _tghead "HEAD" -f; then
1233                 if [ "$2" = "-w" ] && [ -f "$root_dir/$3" ] && [ -r "$root_dir/$3" ]; then
1234                         _opthash=
1235                         if _opthash="$(git hash-object -w -t blob --stdin <"$root_dir/$3")" && [ -n "$_opthash" ]; then
1236                                 _optval="$4\"$_tghead:$_opthash\""
1237                         fi
1238                 elif [ "$2" = "-i" ]; then
1239                         if _opthash="$(git rev-parse --quiet --verify ":0:$3" --)" && [ -n "$_opthash" ]; then
1240                                 _optval="$4\"$_tghead:$_opthash\""
1241                         fi
1242                 fi
1243         fi
1244         eval "$1="'"$_optval"'
1245 }
1246
1247 # set var $1 to the correct -td= option for use in an eval for $2 -i or -w mode
1248 v_get_tdopt() { v_get_tdmopt_internal "$1" "$2" ".topdeps" "-td="; }
1249
1250 # set var $1 to the correct -tm= option for use in an eval for $2 -i or -w mode
1251 v_get_tmopt() { v_get_tdmopt_internal "$1" "$2" ".topmsg" "-tm="; }
1252
1253 # checkout_symref_full [-f] FULLREF [SEED]
1254 # Just like git checkout $iowopt -b FULLREF [SEED] except that FULLREF MUST start with
1255 # refs/ and HEAD is ALWAYS set to a symref to it and [SEED] (default is FULLREF)
1256 # MUST be a committish which if present will be used instead of current FULLREF
1257 # (and FULLREF will be updated to it as well in that case)
1258 # Any merge state is always cleared by this function
1259 # With -f it's like git checkout $iowopt -f -b FULLREF (uses read-tree --reset
1260 # instead of -m) but it will clear out any unmerged entries
1261 # As an extension, FULLREF may also be a full hash to create a detached HEAD instead
1262 checkout_symref_full()
1263 {
1264         _mode=-m
1265         _head="HEAD"
1266         if [ "$1" = "-f" ]; then
1267                 _mode="--reset"
1268                 _head=
1269                 shift
1270         fi
1271         _ishash=
1272         case "$1" in
1273                 refs/?*)
1274                         ;;
1275                 $octet20)
1276                         _ishash=1
1277                         [ -z "$2" ] || [ "$1" = "$2" ] ||
1278                                 die "programmer error: invalid checkout_symref_full \"$1\" \"$2\""
1279                         set -- HEAD "$1"
1280                         ;;
1281                 *)
1282                         die "programmer error: invalid checkout_symref_full \"$1\""
1283                         ;;
1284         esac
1285         _seedrev="$(git rev-parse --quiet --verify "${2:-$1}^0" --)" ||
1286                 die "invalid committish: \"${2:-$1}\""
1287         # Clear out any MERGE_HEAD kruft
1288         rm -f "$git_dir/MERGE_HEAD" || :
1289         # We have to do all the hard work ourselves :/
1290         # This is like git checkout -b "$1" "$2"
1291         # (or just git checkout "$1"),
1292         # but never creates a detached HEAD (unless $1 is a hash)
1293         git read-tree -u $_mode $_head "$_seedrev" &&
1294         {
1295                 [ -z "$2" ] && [ "$(git cat-file -t "$1")" = "commit" ] ||
1296                 git update-ref ${_ishash:+--no-deref} "$1" "$_seedrev"
1297         } && {
1298                 [ -n "$_ishash" ] || git symbolic-ref HEAD "$1"
1299         }
1300 }
1301
1302 # switch_to_base NAME [SEED]
1303 switch_to_base()
1304 {
1305         checkout_symref_full "refs/$topbases/$1" "$2"
1306 }
1307
1308 # run editor with arguments
1309 # the editor setting will be cached in $tg_editor (which is eval'd)
1310 # result non-zero if editor fails or GIT_EDITOR cannot be determined
1311 # just in case, noalt_setup will be in effect while the editor is running
1312 run_editor()
1313 {
1314         tg_editor="$GIT_EDITOR"
1315         [ -n "$tg_editor" ] || tg_editor="$(git var GIT_EDITOR)" || return $?
1316         (
1317                 noalt_setup
1318                 eval "$tg_editor" '"$@"'
1319         )
1320 }
1321
1322 # Show the help messages.
1323 do_help()
1324 {
1325         _www=
1326         if [ "$1" = "-w" ]; then
1327                 _www=1
1328                 shift
1329         fi
1330         if [ -z "$1" ] ; then
1331                 # This is currently invoked in all kinds of circumstances,
1332                 # including when the user made a usage error. Should we end up
1333                 # providing more than a short help message, then we should
1334                 # differentiate.
1335                 # Petr's comment: http://marc.info/?l=git&m=122718711327376&w=2
1336
1337                 ## Build available commands list for help output
1338
1339                 cmds=
1340                 sep=
1341                 for cmd in "$TG_INST_CMDDIR"/tg-[!-]*; do
1342                         ! [ -r "$cmd" ] && continue
1343                         # strip directory part and "tg-" prefix
1344                         cmd="${cmd##*/}"
1345                         cmd="${cmd#tg-}"
1346                         [ "$cmd" != "migrate-bases" ] || continue
1347                         [ "$cmd" != "summary" ] || cmd="st[atus]|$cmd"
1348                         cmds="$cmds$sep$cmd"
1349                         sep="|"
1350                 done
1351
1352                 echo "TopGit version $TG_VERSION - A different patch queue manager"
1353                 echo "Usage: $tgname [-C <dir>] [-r <remote> | -u]" \
1354                         "[-c <name>=<val>] [--no-pager] ($cmds) ..."
1355                 echo "   Or: $tgname help [-w] [<command>]"
1356                 echo "Use \"$tgdisplaydir$tgname help tg\" for overview of TopGit"
1357         elif [ -r "$TG_INST_CMDDIR"/tg-$1 -o -r "$TG_INST_SHAREDIR/tg-$1.txt" ] ; then
1358                 if [ -n "$_www" ]; then
1359                         nohtml=
1360                         if ! [ -r "$TG_INST_SHAREDIR/topgit.html" ]; then
1361                                 echo "${0##*/}: missing html help file:" \
1362                                         "$TG_INST_SHAREDIR/topgit.html" 1>&2
1363                                 nohtml=1
1364                         fi
1365                         if ! [ -r "$TG_INST_SHAREDIR/tg-$1.html" ]; then
1366                                 echo "${0##*/}: missing html help file:" \
1367                                         "$TG_INST_SHAREDIR/tg-$1.html" 1>&2
1368                                 nohtml=1
1369                         fi
1370                         if [ -n "$nohtml" ]; then
1371                                 echo "${0##*/}: use" \
1372                                         "\"${0##*/} help $1\" instead" 1>&2
1373                                 exit 1
1374                         fi
1375                         git web--browse -c help.browser "$TG_INST_SHAREDIR/tg-$1.html"
1376                         exit
1377                 fi
1378                 output()
1379                 {
1380                         if [ -r "$TG_INST_CMDDIR"/tg-$1 ] ; then
1381                                 "$TG_INST_CMDDIR"/tg-$1 -h 2>&1 || :
1382                                 echo
1383                         elif [ "$1" = "help" ]; then
1384                                 echo "Usage: ${tgname:-tg} help [-w] [<command>]"
1385                                 echo
1386                         elif [ "$1" = "status" ] || [ "$1" = "st" ]; then
1387                                 echo "Usage: ${tgname:-tg} @tgsthelpusage@"
1388                                 echo
1389                         fi
1390                         if [ -r "$TG_INST_SHAREDIR/tg-$1.txt" ] ; then
1391                                 cat "$TG_INST_SHAREDIR/tg-$1.txt"
1392                         fi
1393                 }
1394                 page output "$1"
1395         else
1396                 echo "${0##*/}: no help for $1" 1>&2
1397                 do_help
1398                 exit 1
1399         fi
1400 }
1401
1402 check_status()
1403 {
1404         git_state=
1405         git_remove=
1406         if [ -e "$git_dir/MERGE_HEAD" ]; then
1407                 git_state="merge"
1408         elif [ -e "$git_dir/rebase-apply/applying" ]; then
1409                 git_state="am"
1410                 git_remove="$git_dir/rebase-apply"
1411         elif [ -e "$git_dir/rebase-apply" ]; then
1412                 git_state="rebase"
1413                 git_remove="$git_dir/rebase-apply"
1414         elif [ -e "$git_dir/rebase-merge" ]; then
1415                 git_state="rebase"
1416                 git_remove="$git_dir/rebase-merge"
1417         elif [ -e "$git_dir/CHERRY_PICK_HEAD" ]; then
1418                 git_state="cherry-pick"
1419         elif [ -e "$git_dir/BISECT_LOG" ]; then
1420                 git_state="bisect"
1421         elif [ -e "$git_dir/REVERT_HEAD" ]; then
1422                 git_state="revert"
1423         fi
1424         git_remove="${git_remove#./}"
1425
1426         tg_state=
1427         tg_remove=
1428         tg_topmerge=
1429         if [ -e "$git_dir/tg-update" ]; then
1430                 tg_state="update"
1431                 tg_remove="$git_dir/tg-update"
1432                 ! [ -s "$git_dir/tg-update/merging_topfiles" ] || tg_topmerge=1
1433         fi
1434         tg_remove="${tg_remove#./}"
1435 }
1436
1437 # Show status information
1438 do_status()
1439 {
1440         do_status_result=0
1441         do_status_verbose=
1442         do_status_help=
1443         abbrev=refs
1444         pfx=
1445         while [ $# -gt 0 ] && case "$1" in
1446                 --help|-h)
1447                         do_status_help=1
1448                         break;;
1449                 -vv)
1450                         # kludge in this common bundling option
1451                         abbrev=
1452                         do_status_verbose=1
1453                         pfx="## "
1454                         ;;
1455                 --verbose|-v)
1456                         [ -z "$do_status_verbose" ] || abbrev=
1457                         do_status_verbose=1
1458                         pfx="## "
1459                         ;;
1460                 --exit-code)
1461                         do_status_result=2
1462                         ;;
1463                 *)
1464                         die "unknown status argument: $1"
1465                         ;;
1466         esac; do shift; done
1467         if [ -n "$do_status_help" ]; then
1468                 echo "Usage: ${tgname:-tg} @tgsthelpusage@"
1469                 return
1470         fi
1471         check_status
1472         symref="$(git symbolic-ref --quiet HEAD)" || :
1473         headrv="$(git rev-parse --quiet --verify ${abbrev:+--short} HEAD --)" || :
1474         if [ -n "$symref" ]; then
1475                 uprefpart=
1476                 if [ -n "$headrv" ]; then
1477                         upref="$(git rev-parse --symbolic-full-name @{upstream} 2>/dev/null)" || :
1478                         if [ -n "$upref" ]; then
1479                                 uprefpart=" ... ${upref#$abbrev/remotes/}"
1480                                 mbase="$(git merge-base HEAD "$upref")" || :
1481                                 ahead="$(git rev-list --count HEAD ${mbase:+--not $mbase})" || ahead=0
1482                                 behind="$(git rev-list --count "$upref" ${mbase:+--not $mbase})" || behind=0
1483                                 [ "$ahead$behind" = "00" ] || uprefpart="$uprefpart ["
1484                                 [ "$ahead" = "0" ] || uprefpart="${uprefpart}ahead $ahead"
1485                                 [ "$ahead" = "0" ] || [ "$behind" = "0" ] || uprefpart="$uprefpart, "
1486                                 [ "$behind" = "0" ] || uprefpart="${uprefpart}behind $behind"
1487                                 [ "$ahead$behind" = "00" ] || uprefpart="$uprefpart]"
1488                         fi
1489                 fi
1490                 echol "${pfx}HEAD -> ${symref#$abbrev/heads/} [${headrv:-unborn}]$uprefpart"
1491         else
1492                 echol "${pfx}HEAD -> ${headrv:-?}"
1493         fi
1494         if [ -n "$tg_state" ]; then
1495                 extra=
1496                 if [ "$tg_state" = "update" ]; then
1497                         IFS= read -r uname <"$git_dir/tg-update/name" || :
1498                         [ -z "$uname" ] ||
1499                         extra="; currently updating branch '$uname'"
1500                 fi
1501                 echol "${pfx}tg $tg_state in progress$extra"
1502                 if [ -s "$git_dir/tg-update/fullcmd" ] && [ -s "$git_dir/tg-update/names" ]; then
1503                         printf "${pfx}You are currently updating as a result of:\n${pfx}  "
1504                         cat "$git_dir/tg-update/fullcmd"
1505                         bcnt="$(( $(wc -w < "$git_dir/tg-update/names") ))"
1506                         if [ $bcnt -gt 1 ]; then
1507                                 pcnt=0
1508                                 ! [ -s "$git_dir/tg-update/processed" ] ||
1509                                 pcnt="$(( $(wc -w < "$git_dir/tg-update/processed") ))"
1510                                 echo "${pfx}$pcnt of $bcnt branches updated so far"
1511                         fi
1512                 fi
1513                 if [ "$tg_state" = "update" ]; then
1514                         echol "${pfx}  (use \"$tgdisplayac update --continue\" to continue)"
1515                         echol "${pfx}  (use \"$tgdisplayac update --skip\" to skip this branch and continue)"
1516                         echol "${pfx}  (use \"$tgdisplayac update --stop\" to stop and retain changes so far)"
1517                         echol "${pfx}  (use \"$tgdisplayac update --abort\" to restore pre-update state)"
1518                 fi
1519         fi
1520         [ -z "$git_state" ] || echo "${pfx}git $git_state in progress"
1521         if [ "$git_state" = "merge" ]; then
1522                 ucnt="$(( $(git ls-files --unmerged --full-name --abbrev :/ | wc -l) ))"
1523                 if [ $ucnt -gt 0 ]; then
1524                         echo "${pfx}"'fix conflicts and then "git commit" the result'
1525                 else
1526                         echo "${pfx}"'all conflicts fixed; run "git commit" to record result'
1527                 fi
1528         fi
1529         if [ -z "$git_state" ]; then
1530                 gsp="$(git status --porcelain 2>/dev/null)" || return 0 # bare repository
1531                 gspcnt=0
1532                 [ -z "$gsp" ] ||
1533                 gspcnt="$(( $(printf '%s\n' "$gsp" | sed -n '/^??/!p' | wc -l) ))"
1534                 untr=
1535                 if [ "$gspcnt" -eq 0 ]; then
1536                         [ -z "$gsp" ] || untr="; non-ignored, untracked files present"
1537                         echo "${pfx}working directory is clean$untr"
1538                         [ -n "$tg_state" ] || do_status_result=0
1539                 else
1540                         echo "${pfx}working directory is DIRTY"
1541                         [ -z "$do_status_verbose" ] || git status --short --untracked-files=no
1542                 fi
1543         fi
1544 }
1545
1546 ## Pager stuff
1547
1548 # isatty FD
1549 isatty()
1550 {
1551         test -t $1
1552 }
1553
1554 # pass "diff" to get pager.diff
1555 # if pager.$1 is a boolean false returns cat
1556 # if set to true or unset fails
1557 # otherwise succeeds and returns the value
1558 get_pager()
1559 {
1560         if _x="$(git config --bool "pager.$1" 2>/dev/null)"; then
1561                 [ "$_x" != "true" ] || return 1
1562                 echo "cat"
1563                 return 0
1564         fi
1565         if _x="$(git config "pager.$1" 2>/dev/null)"; then
1566                 echol "$_x"
1567                 return 0
1568         fi
1569         return 1
1570 }
1571
1572 # setup_pager
1573 # Set TG_PAGER to a valid executable
1574 # After calling, code to be paged should be surrounded with {...} | eval "$TG_PAGER"
1575 # See also the following "page" function for ease of use
1576 # emptypager will be set to 1 (otherwise empty) if TG_PAGER was set to "cat" to not be empty
1577 # Preference is (same as Git):
1578 #   1. GIT_PAGER
1579 #   2. pager.$USE_PAGER_TYPE (but only if USE_PAGER_TYPE is set and so is pager.$USE_PAGER_TYPE)
1580 #   3. core.pager (only if set)
1581 #   4. PAGER
1582 #   5. git var GIT_PAGER
1583 #   6. less
1584 setup_pager()
1585 {
1586         isatty 1 || { emptypager=1; TG_PAGER=cat; return 0; }
1587
1588         emptypager=
1589         if [ -z "$TG_PAGER_IN_USE" ]; then
1590                 # TG_PAGER = GIT_PAGER | PAGER | less
1591                 # NOTE: GIT_PAGER='' is significant
1592                 if [ -n "${GIT_PAGER+set}" ]; then
1593                         TG_PAGER="$GIT_PAGER"
1594                 elif [ -n "$USE_PAGER_TYPE" ] && _dp="$(get_pager "$USE_PAGER_TYPE")"; then
1595                         TG_PAGER="$_dp"
1596                 elif _cp="$(git config core.pager 2>/dev/null)"; then
1597                         TG_PAGER="$_cp"
1598                 elif [ -n "${PAGER+set}" ]; then
1599                         TG_PAGER="$PAGER"
1600                 else
1601                         _gp="$(git var GIT_PAGER 2>/dev/null)" || :
1602                         [ "$_gp" != ":" ] || _gp=
1603                         TG_PAGER="${_gp:-less}"
1604                 fi
1605                 if [ -z "$TG_PAGER" ]; then
1606                         emptypager=1
1607                         TG_PAGER=cat
1608                 fi
1609         else
1610                 emptypager=1
1611                 TG_PAGER=cat
1612         fi
1613
1614         # Set pager default environment variables
1615         # see pager.c:setup_pager
1616         if [ -z "${LESS+set}" ]; then
1617                 LESS="-FRX"
1618                 export LESS
1619         fi
1620         if [ -z "${LV+set}" ]; then
1621                 LV="-c"
1622                 export LV
1623         fi
1624
1625         # this is needed so e.g. $(git diff) will still colorize it's output if
1626         # requested in ~/.gitconfig with color.diff=auto
1627         GIT_PAGER_IN_USE=1
1628         export GIT_PAGER_IN_USE
1629
1630         # this is needed so we don't get nested pagers
1631         TG_PAGER_IN_USE=1
1632         export TG_PAGER_IN_USE
1633 }
1634
1635 # page eval_arg [arg ...]
1636 #
1637 # Calls setup_pager then evals the first argument passing it all the rest
1638 # where the output is piped through eval "$TG_PAGER" unless emptypager is set
1639 # by setup_pager (in which case the output is left as-is).
1640 #
1641 # To handle arbitrary paging duties, collect lines to be paged into a
1642 # function and then call page with the function name or perhaps func_name "$@".
1643 #
1644 # If no arguments at all are passed in do nothing (return with success).
1645 page()
1646 {
1647         [ $# -gt 0 ] || return 0
1648         setup_pager
1649         _evalarg="$1"; shift
1650         if [ -n "$emptypager" ]; then
1651                 eval "$_evalarg" '"$@"'
1652         else
1653                 { eval "$_evalarg" '"$@"';} | eval "$TG_PAGER"
1654         fi
1655 }
1656
1657 # get_temp NAME [-d]
1658 # creates a new temporary file (or directory with -d) in the global
1659 # temporary directory $tg_tmp_dir with pattern prefix NAME
1660 get_temp()
1661 {
1662         mktemp $2 "$tg_tmp_dir/$1.XXXXXX"
1663 }
1664
1665 # automatically called by strftime
1666 # does nothing if already setup
1667 # may be called explicitly if the first call would otherwise be in a subshell
1668 # so that the setup is only done once before subshells start being spawned
1669 setup_strftime()
1670 {
1671         [ -z "$strftime_is_setup" ] || return 0
1672
1673         # date option to format raw epoch seconds values
1674         daterawopt=
1675         _testes='951807788'
1676         _testdt='2000-02-29 07:03:08 UTC'
1677         _testfm='%Y-%m-%d %H:%M:%S %Z'
1678         if [ "$(TZ=UTC date "-d@$_testes" "+$_testfm" 2>/dev/null)" = "$_testdt" ]; then
1679                 daterawopt='-d@'
1680         elif [ "$(TZ=UTC date "-r$_testes" "+$_testfm" 2>/dev/null)" = "$_testdt" ]; then
1681                 daterawopt='-r'
1682         fi
1683         strftime_is_setup=1
1684 }
1685
1686 # $1 => strftime format string to use
1687 # $2 => raw timestamp as seconds since epoch
1688 # $3 => optional time zone string (empty/absent for local time zone)
1689 strftime()
1690 {
1691         setup_strftime
1692         if [ -n "$daterawopt" ]; then
1693                 if [ -n "$3" ]; then
1694                         TZ="$3" date "$daterawopt$2" "+$1"
1695                 else
1696                         date "$daterawopt$2" "+$1"
1697                 fi
1698         else
1699                 if [ -n "$3" ]; then
1700                         TZ="$3" perl -MPOSIX=strftime -le 'print strftime($ARGV[0],localtime($ARGV[1]))' "$1" "$2"
1701                 else
1702                         perl -MPOSIX=strftime -le 'print strftime($ARGV[0],localtime($ARGV[1]))' "$1" "$2"
1703                 fi
1704         fi
1705 }
1706
1707 got_cdup_result=
1708 git_cdup_result=
1709 v_get_show_cdup()
1710 {
1711         if [ -z "$got_cdup_result" ]; then
1712                 git_cdup_result="$(git rev-parse --show-cdup)"
1713                 got_cdup_result=1
1714         fi
1715         [ -z "$1" ] || eval "$1="'"$git_cdup_result"'
1716 }
1717
1718 setup_git_dirs()
1719 {
1720         [ -n "$git_dir" ] || git_dir="$(git rev-parse --git-dir)"
1721         if [ -n "$git_dir" ] && [ -d "$git_dir" ]; then
1722                 git_dir="$(cd "$git_dir" && pwd)"
1723         fi
1724         if [ -z "$git_common_dir" ]; then
1725                 if vcmp "$git_version" '>=' "2.5"; then
1726                         # rev-parse --git-common-dir is broken and may give
1727                         # an incorrect result unless the current directory is
1728                         # already set to the top level directory
1729                         v_get_show_cdup
1730                         git_common_dir="$(cd "./$git_cdup_result" && cd "$(git rev-parse --git-common-dir)" && pwd)"
1731                 else
1732                         git_common_dir="$git_dir"
1733                 fi
1734         fi
1735         [ -n "$git_dir" ] && [ -n "$git_common_dir" ] &&
1736         [ -d "$git_dir" ] && [ -d "$git_common_dir" ] || die "Not a git repository"
1737         git_hooks_dir="$git_common_dir/hooks"
1738         if vcmp "$git_version" '>=' "2.9" && gchp="$(git config --path --get core.hooksPath 2>/dev/null)" && [ -n "$gchp" ]; then
1739                 case "$gchp" in
1740                         /[!/]*)
1741                                 git_hooks_dir="$gchp"
1742                                 ;;
1743                         *)
1744                                 [ -n "$1" ] || warn "ignoring non-absolute core.hooksPath: $gchp"
1745                                 ;;
1746                 esac
1747                 unset_ gchp
1748         fi
1749 }
1750
1751 basic_setup_remote()
1752 {
1753         if [ -z "$base_remote" ]; then
1754                 if [ "${TG_EXPLICIT_REMOTE+set}" = "set" ]; then
1755                         base_remote="$TG_EXPLICIT_REMOTE"
1756                 else
1757                         base_remote="$(git config topgit.remote 2>/dev/null)" || :
1758                 fi
1759         fi
1760 }
1761
1762 basic_setup()
1763 {
1764         setup_git_dirs $1
1765         basic_setup_remote
1766         tgsequester="$(git config --bool topgit.sequester 2>/dev/null)" || :
1767         tgnosequester=
1768         [ "$tgsequester" != "false" ] || tgnosequester=1
1769         unset_ tgsequester
1770
1771         # catch errors if topbases is used without being set
1772         unset_ tg_topbases_set
1773         topbases="programmer*:error"
1774         topbasesrx="programmer*:error}"
1775         oldbases="$topbases"
1776 }
1777
1778 ## Initial setup
1779 initial_setup()
1780 {
1781         # suppress the merge log editor feature since git 1.7.10
1782
1783         GIT_MERGE_AUTOEDIT=no
1784         export GIT_MERGE_AUTOEDIT
1785
1786         basic_setup $1
1787         iowopt=
1788         ! vcmp "$git_version" '>=' "2.5" || iowopt="--ignore-other-worktrees"
1789         gcfbopt=
1790         ! vcmp "$git_version" '>=' "2.6" || gcfbopt="--buffer"
1791         auhopt=
1792         ! vcmp "$git_version" '>=' "2.9" || auhopt="--allow-unrelated-histories"
1793         v_get_show_cdup root_dir
1794         root_dir="${root_dir:-.}"
1795         logrefupdates="$(git config --bool core.logallrefupdates 2>/dev/null)" || :
1796         [ "$logrefupdates" = "true" ] || logrefupdates=
1797
1798         # make sure root_dir doesn't end with a trailing slash.
1799
1800         root_dir="${root_dir%/}"
1801
1802         # create global temporary directories, inside GIT_DIR
1803
1804         if [ -n "$TG_TMPDIR" ] && [ -d "$TG_TMPDIR" ] && [ -w "$TG_TMPDIR" ] &&
1805            { >"$TG_TMPDIR/.check"; } >/dev/null 2>&1; then
1806                 tg_tmp_dir="$TG_TMPDIR"
1807         else
1808                 tg_tmp_dir=
1809                 TRAPEXIT_='${TG_DEBUG:+echo} rm -rf "$tg_tmp_dir" >&2'
1810                 trap 'trapexit_ 129' HUP
1811                 trap 'trapexit_ 130' INT
1812                 trap 'trapexit_ 131' QUIT
1813                 trap 'trapexit_ 134' ABRT
1814                 trap 'trapexit_ 141' PIPE
1815                 trap 'trapexit_ 143' TERM
1816                 tg_tmp_dir="$(mktemp -d "$git_dir/tg-tmp.XXXXXX" 2>/dev/null)" || tg_tmp_dir=
1817                 [ -n "$tg_tmp_dir" ] || tg_tmp_dir="$(mktemp -d "${TMPDIR:-/tmp}/tg-tmp.XXXXXX" 2>/dev/null)" || tg_tmp_dir=
1818                 [ -n "$tg_tmp_dir" ] || [ -z "$TMPDIR" ] || tg_tmp_dir="$(mktemp -d "/tmp/tg-tmp.XXXXXX" 2>/dev/null)" || tg_tmp_dir=
1819         fi
1820         unset_ TG_TMPDIR
1821         tg_ref_cache="$tg_tmp_dir/tg~ref-cache"
1822         tg_ref_cache_br="$tg_ref_cache.br"
1823         tg_ref_cache_rbr="$tg_ref_cache.rbr"
1824         tg_ref_cache_ann="$tg_ref_cache.ann"
1825         tg_ref_cache_dep="$tg_ref_cache.dep"
1826         [ -n "$tg_tmp_dir" ] && [ -w "$tg_tmp_dir" ] && { >"$tg_ref_cache"; } >/dev/null 2>&1 ||
1827                 die "could not create a writable temporary directory"
1828
1829         # make sure global cache directory exists inside GIT_DIR or $tg_tmp_dir
1830
1831         user_id_no="$(id -u)" || :
1832         : "${user_id_no:=_99_}"
1833         tg_cache_dir="$git_common_dir/tg-cache"
1834         [ -d "$tg_cache_dir" ] || mkdir "$tg_cache_dir" >/dev/null 2>&1 || tg_cache_dir=
1835         [ -z "$tg_cache_dir" ] || tg_cache_dir="$tg_cache_dir/$user_id_no"
1836         [ -z "$tg_cache_dir" ] || [ -d "$tg_cache_dir" ] || mkdir "$tg_cache_dir" >/dev/null 2>&1 || tg_cache_dir=
1837         [ -z "$tg_cache_dir" ] || { >"$tg_cache_dir/.tgcache"; } >/dev/null 2>&1 || tg_cache_dir=
1838         if [ -z "$tg_cache_dir" ]; then
1839                 tg_cache_dir="$tg_tmp_dir/tg-cache"
1840                 [ -d "$tg_cache_dir" ] || mkdir "$tg_cache_dir" >/dev/null 2>&1 || tg_cache_dir=
1841                 [ -z "$tg_cache_dir" ] || { >"$tg_cache_dir/.tgcache"; } >/dev/null 2>&1 || tg_cache_dir=
1842         fi
1843         [ -n "$tg_cache_dir" ] ||
1844                 die "could not create a writable tg-cache directory (even a temporary one)"
1845
1846         # GIT_ALTERNATE_OBJECT_DIRECTORIES can contain double-quoted entries
1847         # since Git v2.11.1; however, it's only necessary for : (or perhaps ;)
1848         # so we avoid it if possible and require v2.11.1 to do it at all
1849         # otherwise just don't make an alternates temporary store in that case;
1850         # it's okay to not have one; everything will still work; the nicety of
1851         # making the temporary tree objects vanish when tg exits just won't
1852         # happen in that case but nothing will break also be sure to reuse
1853         # the parent's if we've been recursively invoked and it's for the
1854         # same repository we were invoked on
1855
1856         tg_use_alt_odb=1
1857         _odbdir="${GIT_OBJECT_DIRECTORY:-$git_common_dir/objects}"
1858         [ -n "$_odbdir" ] && [ -d "$_odbdir" ] || tg_use_alt_odb=
1859         _fulltmpdir=
1860         [ -z "$tg_use_alt_odb" ] || _fulltmpdir="$(cd "$tg_tmp_dir" && pwd -P)"
1861         case "$_fulltmpdir" in *[";:"]*) vcmp "$git_version" '>=' "2.11.1" || tg_use_alt_odb=; esac
1862         _fullodbdir=
1863         [ -z "$tg_use_alt_odb" ] || _fullodbdir="$(cd "$_odbdir" && pwd -P)"
1864         if [ -n "$tg_use_alt_odb" ] && [ -n "$TG_OBJECT_DIRECTORY" ] && [ -d "$TG_OBJECT_DIRECTORY/info" ] &&
1865            [ -f "$TG_OBJECT_DIRECTORY/info/alternates" ] && [ -r "$TG_OBJECT_DIRECTORY/info/alternates" ]; then
1866                 if IFS= read -r _otherodbdir <"$TG_OBJECT_DIRECTORY/info/alternates" &&
1867                    [ -n "$_otherodbdir" ] && [ "$_otherodbdir" = "$_fullodbdir" ]; then
1868                         tg_use_alt_odb=2
1869                 fi
1870         fi
1871         if [ "$tg_use_alt_odb" = "1" ]; then
1872                 # create an alternate objects database to keep the ephemeral objects in
1873                 mkdir -p "$tg_tmp_dir/objects/info"
1874                 echol "$_fullodbdir" >"$tg_tmp_dir/objects/info/alternates"
1875                 TG_OBJECT_DIRECTORY="$_fulltmpdir/objects"
1876                 case "$TG_OBJECT_DIRECTORY" in
1877                         *[";:"]*)
1878                                 # surround in "..." and backslash-escape internal '"' and '\\'
1879                                 _altodbdq="\"$(printf '%s\n' "$TG_OBJECT_DIRECTORY" |
1880                                         sed 's/\([""\\]\)/\\\1/g')\""
1881                                 ;;
1882                         *)
1883                                 _altodbdq="$TG_OBJECT_DIRECTORY"
1884                                 ;;
1885                 esac
1886                 TG_PRESERVED_ALTERNATES="$GIT_ALTERNATE_OBJECT_DIRECTORIES"
1887                 if [ -n "$GIT_ALTERNATE_OBJECT_DIRECTORIES" ]; then
1888                         GIT_ALTERNATE_OBJECT_DIRECTORIES="$_altodbdq:$GIT_ALTERNATE_OBJECT_DIRECTORIES"
1889                 else
1890                         GIT_ALTERNATE_OBJECT_DIRECTORIES="$_altodbdq"
1891                 fi
1892                 export TG_PRESERVED_ALTERNATES TG_OBJECT_DIRECTORY GIT_ALTERNATE_OBJECT_DIRECTORIES GIT_OBJECT_DIRECTORY
1893         fi
1894 }
1895
1896 noalt_setup()
1897 {
1898         if [ "${TG_PRESERVED_ALTERNATES+set}" = "set" ]; then
1899                 GIT_ALTERNATE_OBJECT_DIRECTORIES="$TG_PRESERVED_ALTERNATES"
1900                 if [ -n "$GIT_ALTERNATE_OBJECT_DIRECTORIES" ]; then
1901                         export GIT_ALTERNATE_OBJECT_DIRECTORIES
1902                 else
1903                         unset_ GIT_ALTERNATE_OBJECT_DIRECTORIES
1904                 fi
1905         fi
1906         unset_ TG_TMPDIR TG_OBJECT_DIRECTORY TG_PRESERVED_ALTERNATES tg_use_alt_odb
1907 }
1908
1909 set_topbases()
1910 {
1911         # refer to "top-bases" in a refname with $topbases
1912
1913         [ -z "$tg_topbases_set" ] || return 0
1914
1915         topbases_implicit_default=1
1916         # See if topgit.top-bases is set to heads or refs
1917         tgtb="$(git config "topgit.top-bases" 2>/dev/null)" || :
1918         if [ -n "$tgtb" ] && [ "$tgtb" != "heads" ] && [ "$tgtb" != "refs" ]; then
1919                 if [ -n "$1" ]; then
1920                         # never die on the hook script
1921                         unset_ tgtb
1922                 else
1923                         die "invalid \"topgit.top-bases\" setting (must be \"heads\" or \"refs\")"
1924                 fi
1925         fi
1926         if [ -n "$tgtb" ]; then
1927                 case "$tgtb" in
1928                 heads)
1929                         topbases="heads/{top-bases}"
1930                         topbasesrx="heads/[{]top-bases[}]"
1931                         oldbases="top-bases";;
1932                 refs)
1933                         topbases="top-bases"
1934                         topbasesrx="top-bases"
1935                         oldbases="heads/{top-bases}";;
1936                 esac
1937                 # MUST NOT be exported
1938                 unset_ tgtb tg_topbases_set topbases_implicit_default
1939                 tg_topbases_set=1
1940                 return 0
1941         fi
1942         unset_ tgtb
1943
1944         # check heads and top-bases and see what state the current
1945         # repository is in.  remotes are ignored.
1946
1947         rc=0 activebases=
1948         activebases="$(
1949                 git for-each-ref --format='%(refname)' "refs/heads" "refs/top-bases" 2>/dev/null |
1950                 run_awk_ref_prefixes ${1:+-e} -n -- "refs/heads/{top-bases}" "refs/top-bases" "refs/heads")" ||
1951                 rc=$?
1952         if [ "$rc" = "65" ]; then
1953                 # Complain and die
1954                 err "repository contains existing TopGit branches"
1955                 err "but some use refs/top-bases/... for the base"
1956                 err "and some use refs/heads/{top-bases}/... for the base"
1957                 err "with the latter being the new, preferred location"
1958                 err "set \"topgit.top-bases\" to either \"heads\" to use"
1959                 err "the new heads/{top-bases} location or \"refs\" to use"
1960                 err "the old top-bases location."
1961                 err "(the tg migrate-bases command can also resolve this issue)"
1962                 die "schizophrenic repository requires topgit.top-bases setting"
1963         fi
1964         [ -z "$activebases" ] || unset_ topbases_implicit_default
1965         if [ "$activebases" = "refs/heads/{top-bases}" ]; then
1966                 topbases="heads/{top-bases}"
1967                 topbasesrx="heads/[{]top-bases[}]"
1968                 oldbases="top-bases"
1969         else
1970                 # default is still top-bases for now
1971                 topbases="top-bases"
1972                 topbasesrx="top-bases"
1973                 oldbases="heads/{top-bases}"
1974         fi
1975         # MUST NOT be exported
1976         unset_ rc activebases tg_topases_set
1977         tg_topbases_set=1
1978         return 0
1979 }
1980
1981 # $1 is remote name to check
1982 # $2 is optional variable name to set to result of check
1983 # $3 is optional command name to use in message (defaults to $cmd)
1984 # Fatal error if remote has schizophrenic top-bases
1985 # No error (and $2, if provided, will be set to empty) if remote has no top-bases at all
1986 check_remote_topbases()
1987 {
1988         [ -n "$1" ] || die "programmer error: check_remote_topbases called with no remote argument"
1989         _crrc=0 _crremotebases=
1990         _crremotebases="$(
1991                 git for-each-ref --format='%(refname)' "refs/remotes/$1" 2>/dev/null |
1992                 run_awk_ref_prefixes -n -- "refs/remotes/$1/{top-bases}" "refs/remotes/$1/top-bases" "refs/remotes/$1")" ||
1993                 _crrc=$?
1994         if [ "$_crrc" = "65" ]; then
1995                 err "remote \"$1\" has top-bases in both locations:"
1996                 err "  refs/remotes/$1/{top-bases}/..."
1997                 err "  refs/remotes/$1/top-bases/..."
1998                 err "set \"topgit.top-bases\" to \"heads\" for the first, preferred location"
1999                 err "or set \"topgit.top-bases\" to \"refs\" for the second, old location"
2000                 err "(the \"-c topgit.top-bases=<val>\" option can be used for this)"
2001                 err "then re-run the tg ${3:-$cmd} command"
2002                 err "(the tg migrate-bases command can also help with this problem)"
2003                 die "schizophrenic remote \"$1\" requires topgit.top-bases setting"
2004         fi
2005         [ "$_crrc" != "66" ] || _crremotebases= # just to be sure
2006         [ -z "$2" ] || eval "$2="'"$_crremotebases"'
2007         unset _crrc _crremotebases
2008         return 0
2009 }
2010
2011 # init_reflog "ref"
2012 # if "$logrefupdates" is set and ref is not under refs/heads/ then force
2013 # an empty log file to exist so that ref changes will be logged
2014 # "$1" must be a fully-qualified refname (i.e. start with "refs/")
2015 # However, if "$1" is "refs/tgstash" then always make the reflog
2016 # The only ref not under refs/ that Git will write a reflog for is HEAD;
2017 # no matter what, it will NOT update a reflog for any other bare refs so
2018 # just quietly succeed when passed TG_STASH without doing anything.
2019 init_reflog()
2020 {
2021         [ -n "$1" ] && [ "$1" != "TG_STASH" ] || return 0
2022         [ -n "$logrefupdates" ] || [ "$1" = "refs/tgstash" ] || return 0
2023         case "$1" in refs/heads/*|HEAD) return 0;; refs/*[!/]);; *) return 1; esac
2024         mkdir -p "$git_common_dir/logs/${1%/*}" 2>/dev/null || :
2025         { >>"$git_common_dir/logs/$1" || :; } 2>/dev/null
2026  }
2027
2028 # store the "realpath" for "$2" in "$1" except the leaf is not resolved if it's
2029 # a symbolic link.  The directory part must exist, but the basename need not.
2030 v_get_abs_path()
2031 {
2032         [ -n "$1" ] && [ -n "$2" ] || return 1
2033         set -- "$1" "$2" "${2%/}"
2034         case "$3" in
2035                 */*) set -- "$1" "$2" "${3%/*}";;
2036                 *  ) set -- "$1" "$2" ".";;
2037         esac
2038         case "$2" in */)
2039                 set -- "$1" "${2%/}" "$3" "/"
2040         esac
2041         [ -d "$3" ] || return 1
2042         eval "$1="'"$(cd "$3" && pwd -P)/${2##*/}$4"'
2043 }
2044
2045 ## Startup
2046
2047 : "${TG_INST_CMDDIR:=@cmddir@}"
2048 : "${TG_INST_SHAREDIR:=@sharedir@}"
2049 : "${TG_INST_HOOKSDIR:=@hooksdir@}"
2050
2051 [ -d "$TG_INST_CMDDIR" ] ||
2052         die "No command directory: '$TG_INST_CMDDIR'"
2053
2054 ## Include awk scripts and their utility functions (separated for easier debugging)
2055
2056 [ -f "$TG_INST_CMDDIR/tg--awksome" ] && [ -r "$TG_INST_CMDDIR/tg--awksome" ] ||
2057         die "Missing awk scripts: '$TG_INST_CMDDIR/tg--awksome'"
2058 . "$TG_INST_CMDDIR/tg--awksome"
2059
2060 if [ -n "$tg__include" ]; then
2061
2062         # We were sourced from another script for our utility functions;
2063         # this is set by hooks.  Skip the rest of the file.  A simple return doesn't
2064         # work as expected in every shell.  See http://bugs.debian.org/516188
2065
2066         # ensure setup happens
2067
2068         initial_setup 1
2069         set_topbases 1
2070         noalt_setup
2071
2072 else
2073
2074         set -e
2075
2076         tgbin="$0"
2077         tgdir="${tgbin%/}"
2078         case "$tgdir" in */*);;*) tgdir="./$tgdir"; esac
2079         tgdir="${tgdir%/*}/"
2080         tgname="${tgbin##*/}"
2081         [ "$0" != "$tgname" ] || tgdir=""
2082
2083         # If tg contains a '/' but does not start with one then replace it with an absolute path
2084
2085         case "$0" in /*) ;; */*)
2086                 tgdir="$(cd "${0%/*}" && pwd -P)/"
2087                 tgbin="$tgdir$tgname"
2088         esac
2089
2090         # tgdisplay will include any explicit -C <dir> etc. options whereas tgname will not
2091         # tgdisplayac is the same as tgdisplay but without any -r or -u options (ac => abort/continue)
2092
2093         tgdisplaydir="$tgdir"
2094         tgdisplay="$tgbin"
2095         tgdisplayac="$tgdisplay"
2096         if
2097             v_get_abs_path _tgnameabs "$(cmd_path "$tgname")" &&
2098             _tgabs="$_tgnameabs" &&
2099             { [ "$tgbin" = "$tgname" ] || v_get_abs_path _tgabs "$tgbin"; } &&
2100             [ "$_tgabs" = "$_tgnameabs" ]
2101         then
2102                 tgdisplaydir=""
2103                 tgdisplay="$tgname"
2104                 tgdisplayac="$tgdisplay"
2105         fi
2106         [ -z "$_tgabs" ] || tgbin="$_tgabs"
2107         unset_ _tgabs _tgnameabs
2108
2109         tg() (
2110                 TG_TMPDIR="$tg_tmp_dir" && export TG_TMPDIR &&
2111                 exec "$tgbin" "$@"
2112         )
2113
2114         explicit_remote=
2115         explicit_dir=
2116         gitcdopt=
2117         noremote=
2118
2119         cmd=
2120         while :; do case "$1" in
2121
2122                 help|--help|-h)
2123                         cmd=help
2124                         shift
2125                         break;;
2126
2127                 status|--status)
2128                         cmd=status
2129                         shift
2130                         break;;
2131
2132                 --hooks-path)
2133                         cmd=hooks-path
2134                         shift
2135                         break;;
2136
2137                 --exec-path)
2138                         cmd=exec-path
2139                         shift
2140                         break;;
2141
2142                 --awk-path)
2143                         cmd=awk-path
2144                         shift
2145                         break;;
2146
2147                 --top-bases)
2148                         cmd=top-bases
2149                         shift
2150                         break;;
2151
2152                 --no-pager)
2153                         GIT_PAGER_IN_USE=1 TG_PAGER_IN_USE=1 &&
2154                         export GIT_PAGER_IN_USE TG_PAGER_IN_USE
2155                         shift;;
2156
2157                 -r)
2158                         shift
2159                         if [ -z "$1" ]; then
2160                                 echo "Option -r requires an argument." >&2
2161                                 do_help
2162                                 exit 1
2163                         fi
2164                         unset_ noremote
2165                         base_remote="$1"
2166                         explicit_remote="$base_remote"
2167                         tgdisplay="$tgdisplaydir$tgname$gitcdopt -r $explicit_remote"
2168                         TG_EXPLICIT_REMOTE="$base_remote" && export TG_EXPLICIT_REMOTE
2169                         shift;;
2170
2171                 -u)
2172                         unset_ base_remote explicit_remote
2173                         noremote=1
2174                         tgdisplay="$tgdisplaydir$tgname$gitcdopt -u"
2175                         TG_EXPLICIT_REMOTE= && export TG_EXPLICIT_REMOTE
2176                         shift;;
2177
2178                 -C)
2179                         shift
2180                         if [ -z "$1" ]; then
2181                                 echo "Option -C requires an argument." >&2
2182                                 do_help
2183                                 exit 1
2184                         fi
2185                         cd "$1"
2186                         unset_ GIT_DIR GIT_COMMON_DIR
2187                         if [ -z "$explicit_dir" ]; then
2188                                 explicit_dir="$1"
2189                         else
2190                                 explicit_dir="$PWD"
2191                         fi
2192                         gitcdopt=" -C \"$explicit_dir\""
2193                         [ "$explicit_dir" != "." ] || explicit_dir="." gitcdopt=" -C ."
2194                         tgdisplay="$tgdisplaydir$tgname$gitcdopt"
2195                         tgdisplayac="$tgdisplay"
2196                         [ -z "$explicit_remote" ] || tgdisplay="$tgdisplay -r $explicit_remote"
2197                         [ -z "$noremote" ] || tgdisplay="$tgdisplay -u"
2198                         shift;;
2199
2200                 -c)
2201                         shift
2202                         if [ -z "$1" ]; then
2203                                 echo "Option -c requires an argument." >&2
2204                                 do_help
2205                                 exit 1
2206                         fi
2207                         param="'$(printf '%s\n' "$1" | sed "s/[']/'\\\\''/g")'"
2208                         GIT_CONFIG_PARAMETERS="${GIT_CONFIG_PARAMETERS:+$GIT_CONFIG_PARAMETERS }$param"
2209                         export GIT_CONFIG_PARAMETERS
2210                         shift;;
2211
2212                 --)
2213                         shift
2214                         break;;
2215
2216                 -*)
2217                         echo "Invalid option $1 (subcommand options must appear AFTER the subcommand)." >&2
2218                         do_help
2219                         exit 1;;
2220
2221                 *)
2222                         break;;
2223
2224         esac; done
2225
2226         [ -n "$cmd" -o $# -lt 1 ] || { cmd="$1"; shift; }
2227
2228         ## Dispatch
2229
2230         [ -n "$cmd" ] || { do_help; exit 1; }
2231
2232         case "$cmd" in
2233
2234                 help)
2235                         do_help "$@"
2236                         exit 0;;
2237
2238                 status|st)
2239                         unset_ base_remote
2240                         basic_setup
2241                         set_topbases
2242                         do_status "$@"
2243                         exit ${do_status_result:-0};;
2244
2245                 hooks-path)
2246                         # Internal command
2247                         echol "$TG_INST_HOOKSDIR";;
2248
2249                 exec-path)
2250                         # Internal command
2251                         echol "$TG_INST_CMDDIR";;
2252
2253                 awk-path)
2254                         # Internal command
2255                         echol "$TG_INST_CMDDIR/awk";;
2256
2257                 top-bases)
2258                         # Maintenance command
2259                         do_topbases_help=
2260                         show_remote_topbases=
2261                         case "$1" in
2262                                 --help|-h)
2263                                         do_topbases_help=0;;
2264                                 -r|--remote)
2265                                         if [ $# -eq 2 ] && [ -n "$2" ]; then
2266                                                 # unadvertised, but make it work
2267                                                 base_remote="$2"
2268                                                 shift
2269                                         fi
2270                                         show_remote_topbases=1;;
2271                                 *)
2272                                         [ $# -eq 0 ] || do_topbases_help=1;;
2273                         esac
2274                         [ $# -le 1 ] || do_topbases_help=1
2275                         if [ -n "$do_topbases_help" ]; then
2276                                 helpcmd='echo "Usage: ${tgname:-tg} [-r <remote>] --top-bases [-r]"'
2277                                 [ $do_topbases_help -eq 0 ] || helpcmd="$helpcmd >&2"
2278                                 eval "$helpcmd"
2279                                 exit $do_topbases_help
2280                         fi
2281                         ! git rev-parse --git-dir >/dev/null 2>&1 || setup_git_dirs
2282                         set_topbases
2283                         if [ -n "$show_remote_topbases" ]; then
2284                                 basic_setup_remote
2285                                 [ -n "$base_remote" ] ||
2286                                 die "no remote location given. Either use -r <remote> option or set topgit.remote"
2287                                 rbases=
2288                                 [ -z "$topbases_implicit_default" ] ||
2289                                 check_remote_topbases "$base_remote" rbases "--top-bases"
2290                                 if [ -n "$rbases" ]; then
2291                                         echol "$rbases"
2292                                 else
2293                                         echol "refs/remotes/$base_remote/${topbases#heads/}"
2294                                 fi
2295                         else
2296                                 echol "refs/$topbases"
2297                         fi;;
2298
2299                 *)
2300                         isutil=
2301                         case "$cmd" in index-merge-one-file)
2302                                 isutil="-"
2303                         esac
2304                         [ -r "$TG_INST_CMDDIR"/tg-$isutil$cmd ] || {
2305                                 looplevel="$TG_ALIAS_DEPTH"
2306                                 [ "${looplevel#[1-9]}" != "$looplevel" ] &&
2307                                 [ "${looplevel%%[!0-9]*}" = "$looplevel" ] ||
2308                                 looplevel=0
2309                                 tgalias="$(git config "topgit.alias.$cmd" 2>/dev/null)" || :
2310                                 [ -n "$tgalias" ] || {
2311                                         echo "Unknown subcommand: $cmd" >&2
2312                                         do_help
2313                                         exit 1
2314                                 }
2315                                 looplevel=$(( $looplevel + 1 ))
2316                                 [ $looplevel -le 10 ] || die "topgit.alias nesting level 10 exceeded"
2317                                 TG_ALIAS_DEPTH="$looplevel"
2318                                 export TG_ALIAS_DEPTH
2319                                 if [ "!${tgalias#?}" = "$tgalias" ]; then
2320                                         unset_ GIT_PREFIX
2321                                         if pfx="$(git rev-parse --show-prefix 2>/dev/null)"; then
2322                                                 GIT_PREFIX="$pfx"
2323                                                 export GIT_PREFIX
2324                                         fi
2325                                         cd "./$(git rev-parse --show-cdup 2>/dev/null)"
2326                                         exec @SHELL_PATH@ -c "${tgalias#?} \"\$@\"" @SHELL_PATH@ "$@"
2327                                 else
2328                                         eval 'exec "$tgbin"' "$tgalias" '"$@"'
2329                                 fi
2330                                 die "alias execution failed for: $tgalias"
2331                         }
2332                         unset_ TG_ALIAS_DEPTH
2333
2334                         showing_help=
2335                         if [ "$*" = "-h" ] || [ "$*" = "--help" ]; then
2336                                 showing_help=1
2337                         fi
2338
2339                         [ -n "$showing_help" ] || initial_setup
2340                         [ -z "$noremote" ] || unset_ base_remote
2341
2342                         nomergesetup="$showing_help"
2343                         case "$cmd" in base|contains|info|log|rebase|revert|summary|tag)
2344                                 # avoid merge setup where not necessary
2345
2346                                 nomergesetup=1
2347                         esac
2348
2349                         if [ -z "$nomergesetup" ]; then
2350                                 # make sure merging the .top* files will always behave sanely
2351
2352                                 setup_ours
2353                                 setup_hook "pre-commit"
2354                         fi
2355
2356                         # everything but rebase needs topbases set
2357                         carefully="$showing_help"
2358                         [ "$cmd" != "migrate-bases" ] || carefully=1
2359                         [ "$cmd" = "rebase" ] || set_topbases $carefully
2360
2361                         _use_ref_cache=
2362                         tg_read_only=1
2363                         _suppress_alt=
2364                         case "$cmd$showing_help" in
2365                                 contains|info|summary|tag)
2366                                         _use_ref_cache=1;;
2367                                 "export")
2368                                         _use_ref_cache=1
2369                                         suppress_alt=1;;
2370                                 annihilate|create|delete|depend|import|update)
2371                                         tg_read_only=
2372                                         suppress_alt=1;;
2373                         esac
2374                         [ -z "$_suppress_alt" ] || noalt_setup
2375                         [ -z "$_use_ref_cache" ] || v_create_ref_cache
2376
2377                         fullcmd="${tgname:-tg} $cmd $*"
2378                         . "$TG_INST_CMDDIR"/tg-$isutil$cmd;;
2379         esac
2380
2381 fi