if [[ "$BASH_VERSINFO" -lt 4 ]]

printf >&2 "This requires bash >= 4 to run.\n"

return 1 2>/dev/null

exit 1

if ! command -v getopt >/dev/null 2>&1

printf >&2 "Cannot find the getopt command.\n"

return 1 2>/dev/null

exit 1

if declare -rp ARGSPARSE_VERSION >/dev/null 2>&1

# argsparse is already loaded.

return 0 2>/dev/null

declare -r ARGSPARSE_VERSION=1.8

declare ARGSPARSE_GNU_GETOPT=${ARGSPARSE_GNU_GETOPT:-getopt}

shopt -s extglob

set +o posix

declare -r argsparse_pgm=${0##*/}

declare __argsparse_environment_variable_prefix

argsparse_use_environment_variables() {

local prefix

case $# in

0)

prefix=$(argsparse_option_to_identifier "${argsparse_pgm%.sh}")

prefix=${prefix^^}

;;

1)

prefix=$1

;;

*)

return 1

esac

__argsparse_environment_variable_prefix=$prefix

}

argsparse_are_environment_variables_enabled() {

[[ ${__argsparse_environment_variable_prefix:-} ]]

}

argsparse_option_environment_variable_name() {

[[ $# -eq 1 ]] || return 1

local option=$1

local identifier=$(argsparse_option_to_identifier "$option")

printf %s_%s "$__argsparse_environment_variable_prefix" "${identifier^^}"

}

argsparse_option_environment_variable() {

[[ $# -eq 1 ]] || return 1

local option=$1

local var=$(argsparse_option_environment_variable_name "$option")

if [[ -v $var ]]; then

printf %s "${!var}"

return 0

fi

return 1

}

argsparse_set_option_from_environment_value() {

[[ $# -eq 2 ]] || return 1

local option=$1

local value=$2

if ! argsparse_has_option_property "$option" value

then

if [[ $value != +(0|false|no|"") ]]

then

argsparse_set_option "$option"

fi

# There should be an elif statement here, if we want to consider

# cumulated options differently.

else

argsparse_set_option "$option" "$value"

fi

}

__argsparse_parse_options_env_and_defaults() {

local option value

for option in "${!__argsparse_options_descriptions[@]}"

do

if ! argsparse_is_option_set "$option"

then

if argsparse_are_environment_variables_enabled &&

value=$(argsparse_option_environment_variable "$option")

then

argsparse_set_option_from_environment_value "$option" "$value"

elif __argsparse_has_array_item \

__argsparse_options_default_values "$option"

then

argsparse_set_option "$option" \

"${__argsparse_options_default_values[$option]}"

fi

fi

done

}

__argsparse_index_of() {

[[ $# -ge 2 ]] || return 1

local key=$1 ; shift

local index=0

local elem

for elem in "$@"

do

if [[ "$key" = "$elem" ]]

then

printf %s "$index"

return 0

fi

: $((index++))

done

return 1

}

__argsparse_join_array() {

[[ $# -ge 1 && $1 = ? ]] || return 1

local IFS="$1$IFS"

shift

printf %s "$*"

}

__argsparse_max_length() {

local max=50

shift

local max_length=0 str

for str in "$@"

do

max_length=$((max_length>${#str}?max_length:${#str}))

done

printf %d "$((max_length>max?max:max_length))"

}

__argsparse_is_array_declared() {

[[ $# -eq 1 ]] || return 1

local array_name=$1

[[ "$(declare -p "$array_name" 2>/dev/null)" = \

"declare -"[aA]" $array_name="* ]]

}

__argsparse_has_array_item() {

[[ $# = [12] ]] || return 1

local array_name=$1

local index=${2:-@}

local var="$array_name[$index]"

(

set +o nounset

[[ ${!var+set} = set ]]

)

}

argsparse_option_to_identifier() {

[[ $# -eq 1 ]] || return 1

local option=$1

printf %s "${option//-/_}"

}

__argsparse_values_array_identifier() {

local option=$1

local array="option_$(argsparse_option_to_identifier "$option")_values"

__argsparse_is_array_declared "$array" || return 1

printf %s'[@]' "$array"

}

declare -A __argsparse_options_default_values=()

declare -A __argsparse_options_properties=()

declare -A __argsparse_short_options=()

__argsparse_optstring_has_short() {

[[ $# -eq 1 ]] || return 1

local optstring=$1

if [[ "$optstring" =~ .*=(.).* ]]

then

printf %c "${BASH_REMATCH[1]}"

return 0

fi

return 1

}

argsparse_set_option_property() {

[[ $# -ge 2 ]] || return 1

local property=$1

shift

local option p short

for option in "$@"

do

case "$property" in

cumulative|cumulativeset)

argsparse_set_option_property value "$option"

;;&

type:*|exclude:*|alias:*|require:*)

if [[ "$property" =~ ^.*:(.+)$ ]]

then

# If property has a value, check its format, we

# dont want any funny chars.

if [[ "${BASH_REMATCH[1]}" = *[*?!,]* ]]

then

printf >&2 "%s: %s: invalid property value.\n" \

"$argsparse_pgm" "${BASH_REMATCH[1]}"

return 1

fi

fi

;&

mandatory|hidden|value|cumulative|cumulativeset)

# We use the comma as the property character separator

# in the __argsparse_options_properties array.

p=${__argsparse_options_properties["$option"]:-}

__argsparse_options_properties["$option"]="${p:+$p,}$property"

;;

short:?)

short=${property#short:}

if __argsparse_has_array_item \

__argsparse_short_options "$short"

then

printf >&2 \

"%s: %s: short option for %s conflicts with already-configured short option for %s.\n" \

"$argsparse_pgm" "$short" "$option" \

"${__argsparse_short_options[$short]}"

return 1

fi

__argsparse_short_options["$short"]=$option

;;

default:*)

# The default value

__argsparse_options_default_values["$option"]=${property#default:}

;;

*)

return 1

;;

esac

done

}

argsparse_has_option_property() {

[[ $# -eq 2 ]] || return 1

local option=$1

local property=$2

local p=${__argsparse_options_properties["$option"]:-""}

if [[ "$p" =~ (^|.+,)"$property"(:([^,]+))?($|,.+) ]]

then

printf %s "${BASH_REMATCH[3]}"

elif [[ $property = default && \

"${__argsparse_options_default_values[$option]+yes}" = yes ]]

then

print %s "${__argsparse_options_default_values[$option]}"

else

return 1

fi

}

argsparse_short_to_long() {

[[ $# -eq 1 ]] || return 1

local char=$1

local long=${__argsparse_short_options[$char]}

[[ -n "$long" ]] && printf %s "$long"

}

declare -A __argsparse_options_descriptions=()

__argsparse_check_declaration_conflict() {

[[ $# -eq 1 ]] || return 1

local option=$1

local identifier=$(argsparse_option_to_identifier "$option")

local -a identifiers=("${!__argsparse_tmp_identifiers[@]}")

local conflict

if __argsparse_has_array_item identifiers @ && \

conflict=$(__argsparse_index_of "$identifier" "${identifiers[@]}")

then

printf %s "${__argsparse_tmp_identifiers[${identifiers[$conflict]}]}"

return 0

fi

__argsparse_tmp_identifiers["$identifier"]=$option

return 1

}

argsparse_use_option() {

[[ $# -ge 2 ]] || return 1

local optstring=$1

local description=$2

shift 2

local long short conflict

# configure short option.

if short=$(__argsparse_optstring_has_short "$optstring")

then

set -- "short:$short" "$@"

optstring=${optstring/=/}

fi

# --$optstring expect an argument.

if [[ "$optstring" = *: ]]

then

set -- value "$@"

long=${optstring%:}

else

long=$optstring

fi

if [[ "$long" = *[!-0-9a-zA-Z_]* ]]

then

printf >&2 "%s: %s: bad option name.\n" "$argsparse_pgm" "$long"

return 2

fi

if conflict=$(__argsparse_check_declaration_conflict "$long")

then

printf >&2 "%s: %s: option conflicts with already-declared %s.\n" \

"$argsparse_pgm" "$long" "$conflict"

return 3

fi

__argsparse_options_descriptions["$long"]=$description

# Any other parameter to this function should be a property.

while [[ $# -ne 0 ]]

do

if ! argsparse_set_option_property "$1" "$long"

then

printf >&2 '%s: %s: unknown property.\n' "$argsparse_pgm" "$1"

return 4

fi

shift

done

}

argsparse_option_description() {

[[ $# -eq 1 ]] || return 1

local option=$1

[[ -n "${__argsparse_options_descriptions[$option]+yes}" ]] && \

printf %s "${__argsparse_options_descriptions[$option]}"

}

argsparse_check_option_type() {

[[ $# -eq 2 ]] || return 1

local option_type=${1,,}

local value=$2

local t

case "$option_type" in

file|directory|pipe|terminal)

# [[ wont accept the -$var as an operator.

[ -"${option_type:0:1}" "$value" ]

;;

socket|link)

t=${option_type:0:1}

[ -"${t^^}" "$value" ]

;;

char)

[[ "$value" = ? ]]

;;

unsignedint|uint)

[[ "$value" = +([0-9]) ]]

;;

integer|int)

[[ "$value" = ?(-)+([0-9]) ]]

;;

hexa)

[[ "$value" = ?(0x)+([a-fA-F0-9]) ]]

;;

ipv4)

# Regular expression for ipv4 and ipv6 have been found on

# http://www.d-sites.com/2008/10/09/regex-ipv4-et-ipv6/

[[ "$value" =~ ^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?).(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$ ]]

;;

ipv6)

[[ "$value" =~ ^((([0-9A-Fa-f]{1,4}:){7}[0-9A-Fa-f]{1,4})|(([0-9A-Fa-f]{1,4}:){6}:[0-9A-Fa-f]{1,4})|(([0-9A-Fa-f]{1,4}:){5}:([0-9A-Fa-f]{1,4}:)?[0-9A-Fa-f]{1,4})|(([0-9A-Fa-f]{1,4}:){4}:([0-9A-Fa-f]{1,4}:){0,2}[0-9A-Fa-f]{1,4})|(([0-9A-Fa-f]{1,4}:){3}:([0-9A-Fa-f]{1,4}:){0,3}[0-9A-Fa-f]{1,4})|(([0-9A-Fa-f]{1,4}:){2}:([0-9A-Fa-f]{1,4}:){0,4}[0-9A-Fa-f]{1,4})|(([0-9A-Fa-f]{1,4}:){6}((b((25[0-5])|(1d{2})|(2[0-4]d)|(d{1,2}))b).){3}(b((25[0-5])|(1d{2})|(2[0-4]d)|(d{1,2}))b))|(([0-9A-Fa-f]{1,4}:){0,5}:((b((25[0-5])|(1d{2})|(2[0-4]d)|(d{1,2}))b).){3}(b((25[0-5])|(1d{2})|(2[0-4]d)|(d{1,2}))b))|(::([0-9A-Fa-f]{1,4}:){0,5}((b((25[0-5])|(1d{2})|(2[0-4]d)|(d{1,2}))b).){3}(b((25[0-5])|(1d{2})|(2[0-4]d)|(d{1,2}))b))|([0-9A-Fa-f]{1,4}::([0-9A-Fa-f]{1,4}:){0,5}[0-9A-Fa-f]{1,4})|(::([0-9A-Fa-f]{1,4}:){0,6}[0-9A-Fa-f]{1,4})|(([0-9A-Fa-f]{1,4}:){1,7}:))$ ]]

;;

ip)

# Generic IP address.

argsparse_check_option_type ipv4 "$value" || \

argsparse_check_option_type ipv6 "$value"

;;

hostname)

# check if value resolv as an IPv4 or IPv6 address.

host -t a "$value" >/dev/null 2>&1 || \

host -t aaaa "$value" >/dev/null 2>&1

;;

host)

# An hostname or an IP address.

argsparse_check_option_type hostname "$value" || \

argsparse_check_option_type ipv4 "$value" || \

argsparse_check_option_type ipv6 "$value"

;;

portnumber)

argsparse_check_option_type uint "$value" && \

[[ "$value" -gt 0 && "$value" -le 65536 ]]

;;

port)

# Port number or service.

argsparse_check_option_type portnumber "$value" || \

getent services "$value" >/dev/null 2>&1

;;

username)

getent passwd "$value" >/dev/null 2>&1

;;

group)

getent group "$value" >/dev/null 2>&1

;;

date)

date --date "$value" >/dev/null 2>&1

;;

*)

# Invoke user-defined type-checking function if available.

if ! declare -f "check_option_type_$option_type" >/dev/null

then

printf >&2 \

"%s: %s: type has no validation function. This is a bug.\n" \

"$argsparse_pgm" "$option_type"

return 2

fi

"check_option_type_$option_type" "$value"

;;

esac

}

declare -a __argsparse_parameters_description

__argsparse_usage_short_line_management() {

[[ $# -eq 1 ]] || return 1

local next_token=$1

local max_length=78

local bigger_line

bigger_line="$current_line $next_token"

if [[ "${#bigger_line}" -gt "$max_length" ]]

then

printf -- '%s \\\n' "$current_line"

printf -v current_line "\t%s" "$next_token"

else

current_line=$bigger_line

fi

}

argsparse_usage_short() {

local option values current_line current_option param

local max_length=78

current_line=$argsparse_pgm

for option in "${!__argsparse_options_descriptions[@]}"

do

if argsparse_has_option_property "$option" hidden

then

continue

fi

current_option="--$option"

if argsparse_has_option_property "$option" value

then

if values=$(__argsparse_values_array_identifier "$option")

then

current_option="$current_option <$(

else

current_option="$current_option ${option^^}"

fi

fi

if ! argsparse_has_option_property "$option" mandatory

then

current_option="[ $current_option ]"

fi

__argsparse_usage_short_line_management "$current_option"

done

if __argsparse_has_array_item __argsparse_parameters_description @

then

for param in "${__argsparse_parameters_description[@]}"