//
// pre content template before commands
// needs to escape some > characters
//
pre(name) ::= <<
# bash completion for <name> -*- shell-script -*-
__<name>_debug()
{
    if [[ -n ${BASH_COMP_DEBUG_FILE:-} ]]; then
        echo "$*" \>> "${BASH_COMP_DEBUG_FILE}"
    fi
}

# Homebrew on Macs have version 1.3 of bash-completion which doesn't include
# _init_completion. This is a very minimal version of that function.
__<name>_init_completion()
{
    COMPREPLY=()
    _get_comp_words_by_ref "$@" cur prev words cword
}
__<name>_index_of_word()
{
    local w word=$1
    shift
    index=0
    for w in "$@"; do
        [[ $w = "$word" ]] && return
        index=$((index+1))
    done
    index=-1
}
__<name>_contains_word()
{
    local w word=$1; shift
    for w in "$@"; do
        [[ $w = "$word" ]] && return
    done
    return 1
}
__<name>_handle_go_custom_completion()
{
    __<name>_debug "${FUNCNAME[0]}: cur is ${cur}, words[*] is ${words[*]}, #words[@] is ${#words[@]}"
    local shellCompDirectiveError=%[3]d
    local shellCompDirectiveNoSpace=%[4]d
    local shellCompDirectiveNoFileComp=%[5]d
    local shellCompDirectiveFilterFileExt=%[6]d
    local shellCompDirectiveFilterDirs=%[7]d
    local out requestComp lastParam lastChar comp directive args
    # Prepare the command to request completions for the program.
    # Calling ${words[0]} instead of directly <name> allows to handle aliases
    args=("${words[@]:1}")
    requestComp="${words[0]} %[2]s ${args[*]}"
    lastParam=${words[$((${#words[@]}-1))]}
    lastChar=${lastParam:$((${#lastParam}-1)):1}
    __<name>_debug "${FUNCNAME[0]}: lastParam ${lastParam}, lastChar ${lastChar}"
    if [ -z "${cur}" ] && [ "${lastChar}" != "=" ]; then
        # If the last parameter is complete (there is a space following it)
        # We add an extra empty parameter so we can indicate this to the go method.
        __<name>_debug "${FUNCNAME[0]}: Adding extra empty parameter"
        requestComp="${requestComp} \"\""
    fi
    __<name>_debug "${FUNCNAME[0]}: calling ${requestComp}"
    # Use eval to handle any environment variables and such
    out=$(eval "${requestComp}" 2>/dev/null)
    # Extract the directive integer at the very end of the output following a colon (:)
    directive=${out##*:}
    # Remove the directive
    out=${out%%:*}
    if [ "${directive}" = "${out}" ]; then
        # There is not directive specified
        directive=0
    fi
    __<name>_debug "${FUNCNAME[0]}: the completion directive is: ${directive}"
    __<name>_debug "${FUNCNAME[0]}: the completions are: ${out[*]}"
    if [ $((directive & shellCompDirectiveError)) -ne 0 ]; then
        # Error code.  No completion.
        __<name>_debug "${FUNCNAME[0]}: received error from custom completion go code"
        return
    else
        if [ $((directive & shellCompDirectiveNoSpace)) -ne 0 ]; then
            if [[ $(type -t compopt) = "builtin" ]]; then
                __<name>_debug "${FUNCNAME[0]}: activating no space"
                compopt -o nospace
            fi
        fi
        if [ $((directive & shellCompDirectiveNoFileComp)) -ne 0 ]; then
            if [[ $(type -t compopt) = "builtin" ]]; then
                __<name>_debug "${FUNCNAME[0]}: activating no file completion"
                compopt +o default
            fi
        fi
    fi
    if [ $((directive & shellCompDirectiveFilterFileExt)) -ne 0 ]; then
        # File extension filtering
        local fullFilter filter filteringCmd
        # Do not use quotes around the $out variable or else newline
        # characters will be kept.
        for filter in ${out[*]}; do
            fullFilter+="$filter|"
        done
        filteringCmd="_filedir $fullFilter"
        __<name>_debug "File filtering command: $filteringCmd"
        $filteringCmd
    elif [ $((directive & shellCompDirectiveFilterDirs)) -ne 0 ]; then
        # File completion for directories only
        local subdir
        # Use printf to strip any trailing newline
        subdir=$(printf "%%s" "${out[0]}")
        if [ -n "$subdir" ]; then
            __<name>_debug "Listing directories in $subdir"
            __<name>_handle_subdirs_in_dir_flag "$subdir"
        else
            __<name>_debug "Listing directories in ."
            _filedir -d
        fi
    else
        while IFS='' read -r comp; do
            COMPREPLY+=("$comp")
        done \< \<(compgen -W "${out[*]}" -- "$cur")
    fi
}
__<name>_handle_reply()
{
    __<name>_debug "${FUNCNAME[0]}"
    local comp
    case $cur in
        -*)
            if [[ $(type -t compopt) = "builtin" ]]; then
                compopt -o nospace
            fi
            local allflags
            if [ ${#must_have_one_flag[@]} -ne 0 ]; then
                allflags=("${must_have_one_flag[@]}")
            else
                allflags=("${flags[*]} ${two_word_flags[*]}")
            fi
            while IFS='' read -r comp; do
                COMPREPLY+=("$comp")
            done \< \<(compgen -W "${allflags[*]}" -- "$cur")
            if [[ $(type -t compopt) = "builtin" ]]; then
                [[ "${COMPREPLY[0]}" == *= ]] || compopt +o nospace
            fi
            # complete after --flag=abc
            if [[ $cur == *=* ]]; then
                if [[ $(type -t compopt) = "builtin" ]]; then
                    compopt +o nospace
                fi
                local index flag
                flag="${cur%%=*}"
                __<name>_index_of_word "${flag}" "${flags_with_completion[@]}"
                COMPREPLY=()
                if [[ ${index} -ge 0 ]]; then
                    PREFIX=""
                    cur="${cur#*=}"
                    ${flags_completion[${index}]}
                    if [ -n "${ZSH_VERSION:-}" ]; then
                        # zsh completion needs --flag= prefix
                        eval "COMPREPLY=( \"\${COMPREPLY[@]/#/${flag}=}\" )"
                    fi
                fi
            fi
            if [[ -z "${flag_parsing_disabled}" ]]; then
                # If flag parsing is enabled, we have completed the flags and can return.
                # If flag parsing is disabled, we may not know all (or any) of the flags, so we fallthrough
                # to possibly call handle_go_custom_completion.
                return 0;
            fi
            ;;
    esac
    # check if we are handling a flag with special work handling
    local index
    __<name>_index_of_word "${prev}" "${flags_with_completion[@]}"
    if [[ ${index} -ge 0 ]]; then
        ${flags_completion[${index}]}
        return
    fi
    # we are parsing a flag and don't have a special handler, no completion
    if [[ ${cur} != "${words[cword]}" ]]; then
        return
    fi
    local completions
    completions=("${commands[@]}")
    if [[ ${#must_have_one_noun[@]} -ne 0 ]]; then
        completions+=("${must_have_one_noun[@]}")
    elif [[ -n "${has_completion_function}" ]]; then
        # if a go completion function is provided, defer to that function
        __<name>_handle_go_custom_completion
    fi
    if [[ ${#must_have_one_flag[@]} -ne 0 ]]; then
        completions+=("${must_have_one_flag[@]}")
    fi
    while IFS='' read -r comp; do
        COMPREPLY+=("$comp")
    done \< \<(compgen -W "${completions[*]}" -- "$cur")
    if [[ ${#COMPREPLY[@]} -eq 0 && ${#noun_aliases[@]} -gt 0 && ${#must_have_one_noun[@]} -ne 0 ]]; then
        while IFS='' read -r comp; do
            COMPREPLY+=("$comp")
        done \< \<(compgen -W "${noun_aliases[*]}" -- "$cur")
    fi
    if [[ ${#COMPREPLY[@]} -eq 0 ]]; then
        if declare -F __<name>_custom_func >/dev/null; then
            # try command name qualified custom func
            __<name>_custom_func
        else
            # otherwise fall back to unqualified for compatibility
            declare -F __custom_func >/dev/null && __custom_func
        fi
    fi
    # available in bash-completion >= 2, not always present on macOS
    if declare -F __ltrim_colon_completions >/dev/null; then
        __ltrim_colon_completions "$cur"
    fi
    # If there is only 1 completion and it is a flag with an = it will be completed
    # but we don't want a space after the =
    if [[ "${#COMPREPLY[@]}" -eq "1" ]] && [[ $(type -t compopt) = "builtin" ]] && [[ "${COMPREPLY[0]}" == --*= ]]; then
       compopt -o nospace
    fi
}
# The arguments should be in the form "ext1|ext2|extn"
__<name>_handle_filename_extension_flag()
{
    local ext="$1"
    _filedir "@(${ext})"
}
__<name>_handle_subdirs_in_dir_flag()
{
    local dir="$1"
    pushd "${dir}" >/dev/null 2>&1 && _filedir -d && popd >/dev/null 2>&1 || return
}
__<name>_handle_flag()
{
    __<name>_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
    # if a command required a flag, and we found it, unset must_have_one_flag()
    local flagname=${words[c]}
    local flagvalue=""
    # if the word contained an =
    if [[ ${words[c]} == *"="* ]]; then
        flagvalue=${flagname#*=} # take in as flagvalue after the =
        flagname=${flagname%%=*} # strip everything after the =
        flagname="${flagname}=" # but put the = back
    fi
    __<name>_debug "${FUNCNAME[0]}: looking for ${flagname}"
    if __<name>_contains_word "${flagname}" "${must_have_one_flag[@]}"; then
        must_have_one_flag=()
    fi
    # if you set a flag which only applies to this command, don't show subcommands
    if __<name>_contains_word "${flagname}" "${local_nonpersistent_flags[@]}"; then
      commands=()
    fi
    # keep flag value with flagname as flaghash
    # flaghash variable is an associative array which is only supported in bash > 3.
    if [[ -z "${BASH_VERSION:-}" || "${BASH_VERSINFO[0]:-}" -gt 3 ]]; then
        if [ -n "${flagvalue}" ] ; then
            flaghash[${flagname}]=${flagvalue}
        elif [ -n "${words[ $((c+1)) ]}" ] ; then
            flaghash[${flagname}]=${words[ $((c+1)) ]}
        else
            flaghash[${flagname}]="true" # pad "true" for bool flag
        fi
    fi
    # skip the argument to a two word flag
    if [[ ${words[c]} != *"="* ]] && __<name>_contains_word "${words[c]}" "${two_word_flags[@]}"; then
        __<name>_debug "${FUNCNAME[0]}: found a flag ${words[c]}, skip the next argument"
        c=$((c+1))
        # if we are looking for a flags value, don't show commands
        if [[ $c -eq $cword ]]; then
            commands=()
        fi
    fi
    c=$((c+1))
}
__<name>_handle_noun()
{
    __<name>_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
    if __<name>_contains_word "${words[c]}" "${must_have_one_noun[@]}"; then
        must_have_one_noun=()
    elif __<name>_contains_word "${words[c]}" "${noun_aliases[@]}"; then
        must_have_one_noun=()
    fi
    nouns+=("${words[c]}")
    c=$((c+1))
}
__<name>_handle_command()
{
    __<name>_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
    local next_command
    if [[ -n ${last_command} ]]; then
        next_command="_${last_command}_${words[c]//:/__}"
    else
        if [[ $c -eq 0 ]]; then
            next_command="_<name>_root_command"
        else
            next_command="_${words[c]//:/__}"
        fi
    fi
    c=$((c+1))
    __<name>_debug "${FUNCNAME[0]}: looking for ${next_command}"
    declare -F "$next_command" >/dev/null && $next_command
}
__<name>_handle_word()
{
    if [[ $c -ge $cword ]]; then
        __<name>_handle_reply
        return
    fi
    __<name>_debug "${FUNCNAME[0]}: c is $c words[c] is ${words[c]}"
    if [[ "${words[c]}" == -* ]]; then
        __<name>_handle_flag
    elif __<name>_contains_word "${words[c]}" "${commands[@]}"; then
        __<name>_handle_command
    elif [[ $c -eq 0 ]]; then
        __<name>_handle_command
    elif __<name>_contains_word "${words[c]}" "${command_aliases[@]}"; then
        # aliashash variable is an associative array which is only supported in bash > 3.
        if [[ -z "${BASH_VERSION:-}" || "${BASH_VERSINFO[0]:-}" -gt 3 ]]; then
            words[c]=${aliashash[${words[c]}]}
            __<name>_handle_command
        else
            __<name>_handle_noun
        fi
    else
        __<name>_handle_noun
    fi
    __<name>_handle_word
}
>>

//
// post content template after commands
//
post(name) ::= <<
__start_<name>()
{
    local cur prev words cword split
    declare -A flaghash 2>/dev/null || :
    declare -A aliashash 2>/dev/null || :
    if declare -F _init_completion >/dev/null 2>&1; then
        _init_completion -s || return
    else
        __<name>_init_completion -n "=" || return
    fi
    local c=0
    local flag_parsing_disabled=
    local flags=()
    local two_word_flags=()
    local local_nonpersistent_flags=()
    local flags_with_completion=()
    local flags_completion=()
    local commands=("<name>")
    local command_aliases=()
    local must_have_one_flag=()
    local must_have_one_noun=()
    local has_completion_function=""
    local last_command=""
    local nouns=()
    local noun_aliases=()
    __<name>_handle_word
}

if [[ $(type -t compopt) = "builtin" ]]; then
    complete -o default -F __start_<name> <name>
else
    complete -o default -o nospace -F __start_<name> <name>
fi
>>

//
// command_aliases=() template section in commands
//
command_aliases() ::= <<
command_aliases=()
>>

//
// commands=() template section in commands
//
commands(commands) ::= <<
commands=()
<commands:{c | commands+=("<c>")}; separator="\n">
>>

//
// flags=() template section in commands
//
flags() ::= <<
flags=()
>>

//
// two_word_flags=() template section in commands
//
two_word_flags(flags) ::= <<
two_word_flags=()
<flags:{f | two_word_flags+=("<f>")}; separator="\n">
>>

//
// local_nonpersistent_flags=() template section in commands
//
local_nonpersistent_flags() ::= <<
local_nonpersistent_flags=()
>>

//
// flags_with_completion=() template section in commands
//
flags_with_completion() ::= <<
flags_with_completion=()
>>

//
// flags_completion=() template section in commands
//
flags_completion() ::= <<
flags_completion=()
>>

//
// must_have_one_flag=() template section in commands
//
must_have_one_flag() ::= <<
must_have_one_flag=()
>>

//
// must_have_one_noun=() template section in commands
//
must_have_one_noun() ::= <<
must_have_one_noun=()
>>

//
// noun_aliases=() template section in commands
//
noun_aliases() ::= <<
noun_aliases=()
>>

//
// template for each command
//
sub_command(name,command) ::= <<
_<name>_<command.commandParts:{p | <p>}; separator="_">()
{
    last_command="<name>_<c.commandParts:{p | <p>}; separator="_">"

    <command_aliases()>
    <commands(command.subCommands)>
    <flags()>
    <two_word_flags(command.flags)>
    <local_nonpersistent_flags()>
    <flags_with_completion()>
    <flags_completion()>
    <must_have_one_flag()>
    <must_have_one_noun()>
    <noun_aliases()>
}
>>

//
// top level root commands template
//
root_commands(name,commands) ::= <<
_<name>_root_command()
{
    last_command="<name>"

    <command_aliases()>
    <commands(commands)>
    <flags()>
    <two_word_flags([])>
    <local_nonpersistent_flags()>
    <flags_with_completion()>
    <flags_completion()>
    <must_have_one_flag()>
    <must_have_one_noun()>
    <noun_aliases()>
}
>>

//
// main template to call from render
//
main(name, model) ::= <<
<pre(name)>

<model.allCommands:{c | <sub_command(name,c)>}; separator="\n\n">

<root_commands(name,model.rootCommands)>

<post(name)>
>>
