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