parser

#!/bin/bash
# @parseArger-begin
# @parseArger-help "parseArger parsing string for options" --option "help" --short-option "h"
# @parseArger-version "0.1" --option "version" --short-option "v"
# @parseArger-verbose --option "verbose" --level "0" --quiet-option "quiet"
# @parseArger-declarations
# @parseArger pos arg-name "nested option namespace"
# @parseArger pos description "positional argument description"
# @parseArger opt one-of "accepted values for keys" --repeat
# @parseArger opt complete "bash built-in completely function" --repeat
# @parseArger opt complete-custom "completely custom dynamic suggestion" --repeat
# @parseArger-declarations-end

# @parseArger-utils
_helpHasBeenPrinted=1;
_SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd -P)";
# @parseArger-utils-end

# @parseArger-parsing
die()
{
	local _ret="${2:-1}"
	test "${_PRINT_HELP:-no}" = yes && print_help >&2
	log "$1" -3 >&2
	exit "${_ret}"
}


begins_with_short_option()
{
	local first_option all_short_options=''
	first_option="${1:0:1}"
	test "$all_short_options" = "${all_short_options/$first_option/}" && return 1 || return 0
}

# POSITIONALS ARGUMENTS
_positionals=();
_optional_positionals=();
_arg_arg_name="";
_arg_description="";
# OPTIONALS ARGUMENTS
_arg_one_of=()
_arg_complete=()
_arg_complete_custom=()
# FLAGS
_verbose_level="0";



print_help()
{
	_triggerSCHelp=1;

	if [[ "$_helpHasBeenPrinted" == "1" ]]; then
		_helpHasBeenPrinted=0;
		echo -e "parseArger parsing string for options:"
	echo -e "	arg-name: nested option namespace"
	echo -e "	description: positional argument description"
	echo -e "	--one-of <one-of>: accepted values for keys, repeatable"
	echo -e "	--complete <complete>: bash built-in completely function, repeatable"
	echo -e "	--complete-custom <complete-custom>: completely custom dynamic suggestion, repeatable"
	echo -e "Usage :
	$0 <arg-name> <description> [--one-of <value>] [--complete <value>] [--complete-custom <value>]";
	fi

}

log() {
	local _arg_msg="${1}";
	local _arg_level="${2:-"0"}";
	if [ "${_arg_level}" -le "${_verbose_level}" ]; then
		case "$_arg_level" in
			-3)
				_arg_COLOR="\033[0;31m";
				;;
			-2)
				_arg_COLOR="\033[0;33m";
				;;
			-1)
				_arg_COLOR="\033[1;33m";
				;;
			1)
				_arg_COLOR="\033[0;32m";
				;;
			2)
				_arg_COLOR="\033[1;36m";
				;;
			3)
				_arg_COLOR="\033[0;36m";
				;;
			*)
				_arg_COLOR="\033[0m";
				;;
		esac
		echo -e "${_arg_COLOR}${_arg_msg}\033[0m";
	fi
}

parse_commandline()
{
	_positionals_count=0
	while test $# -gt 0
	do
		_key="$1"
		case "$_key" in
			--one-of)
				test $# -lt 2 && die "Missing value for the option: '$_key'" 1
				_arg_one_of+=("$2")
				shift
				;;
			--one-of=*)
				_arg_one_of+=("${_key##--one-of=}")
				;;
			
			--complete)
				test $# -lt 2 && die "Missing value for the option: '$_key'" 1
				_arg_complete+=("$2")
				shift
				;;
			--complete=*)
				_arg_complete+=("${_key##--complete=}")
				;;
			
			--complete-custom)
				test $# -lt 2 && die "Missing value for the option: '$_key'" 1
				_arg_complete_custom+=("$2")
				shift
				;;
			--complete-custom=*)
				_arg_complete_custom+=("${_key##--complete-custom=}")
				;;
			
			-h|--help)
				print_help;
				exit 0;
				;;
			-h*)
				print_help;
				exit 0;
				;;
			-v|--version)
				print_version;
				exit 0;
				;;
			-v*)
				print_version;
				exit 0;
				;;
			--verbose)
					if [ $# -lt 2 ];then
						_verbose_level="$((_verbose_level + 1))";
					else
						_verbose_level="$2";
						shift;
					fi
					;;
				--quiet)
					if [ $# -lt 2 ];then
						_verbose_level="$((_verbose_level - 1))";
					else
						_verbose_level="-$2";
						shift;
					fi
					;;
				
				*)
				_last_positional="$1"
				_positionals+=("$_last_positional")
				_positionals_count=$((_positionals_count + 1))
				;;
		esac
		shift
	done
}


handle_passed_args_count()
{
	local _required_args_string="arg-name description"
	if [ "${_positionals_count}" -gt 2 ] && [ "$_helpHasBeenPrinted" == "1" ];then
		_PRINT_HELP=yes die "FATAL ERROR: There were spurious positional arguments --- we expect at most 2 (namely: $_required_args_string), but got ${_positionals_count} (the last one was: '${_last_positional}').\n\t${_positionals[*]}" 1
	fi
	if [ "${_positionals_count}" -lt 2 ] && [ "$_helpHasBeenPrinted" == "1" ];then
		_PRINT_HELP=yes die "FATAL ERROR: Not enough positional arguments - we require at least 2 (namely: $_required_args_string), but got only ${_positionals_count}.
	${_positionals[*]}" 1;
	fi
}


assign_positional_args()
{
	local _positional_name _shift_for=$1;
	_positional_names="_arg_arg_name _arg_description ";
	shift "$_shift_for"
	for _positional_name in ${_positional_names};do
		test $# -gt 0 || break;
		eval "if [ \"\$_one_of${_positional_name}\" != \"\" ];then [[ \"\${_one_of${_positional_name}[*]}\" =~ \"\${1}\" ]];fi" || die "${_positional_name} must be one of: $(eval "echo \"\${_one_of${_positional_name}[*]}\"")" 1;
		eval "$_positional_name=\${1}" || die "Error during argument parsing, possibly an ParseArger bug." 1;
		shift;
	done
}

print_debug()
{
	print_help
	# shellcheck disable=SC2145
	echo "DEBUG: $0 $@";
	
	echo -e "\targ-name: ${_arg_arg_name}";
	echo -e "\tdescription: ${_arg_description}";
	echo -e "\tone-of: ${_arg_one_of[*]}";
	echo -e "\tcomplete: ${_arg_complete[*]}";
	echo -e "\tcomplete-custom: ${_arg_complete_custom[*]}";

}

print_version()
{
	echo "0.1";
}

on_interrupt() {
	die Process aborted! 130;
}

parse_commandline "$@";
handle_passed_args_count;
assign_positional_args 1 "${_positionals[@]}";
trap on_interrupt INT;



# @parseArger-parsing-end
# print_debug "$@"
# @parseArger-end
optMissingValueError="Missing value for the option: "
optParser="--${_arg_arg_name})\n\t";

setOptStr="_arg_${_arg_arg_name//-/_}=\"\$2\"";

# TODO
# if [ "${#_arg_one_of[@]}" -gt 0 ]; then
# 	setOptStr+="\n\tif [[ \"\${#_one_of_arg_${_arg_arg_name//-/_}[@]}\" -gt 0 ]];then [[ \"\${_one_of_arg_${_arg_arg_name//-/_}[*]}\" =~ (^|[[:space:]])\"\$_arg_${_arg_arg_name//-/_}\"(\$|[[:space:]]) ]] || die \"$_arg_arg_name must be one of: ${_arg_one_of[*]}\";fi";
# fi

optParser+="test \$# -lt 2 && die \"${optMissingValueError}'\$_key'\" 1
	${setOptStr}
	shift
	;;
";

setvalstr="=\"\${_key##--${_arg_arg_name}=}\""
optParser="${optParser}--${_arg_arg_name}=*)
	_arg_${_arg_arg_name//-/_}${setvalstr}";

# TODO
# if [ "${#_arg_one_of[@]}" -gt 0 ]; then
# 	optParser+="
# 	if [[ \"\${#_one_of_arg_${_arg_arg_name//-/_}[@]}\" -gt 0 ]];then [[ \"\${_one_of_arg_${_arg_arg_name//-/_}[*]}\" =~ (^|[[:space:]])\"\$_arg_${_arg_arg_name//-/_}\"(\$|[[:space:]]) ]] || die \"$_arg_arg_name must be one of: ${_arg_one_of[*]}\";fi";
# fi

optParser+="
	;;
";

# TODO : support some kind of serialization to have array in _arg_ns_*[$_ns_key]
optParser+="--${_arg_arg_name}-*)
	_ns_key=\"\${_key##--${_arg_arg_name}-}\";
	test \$# -lt 2 && die \"${optMissingValueError}'\$_key-\$_ns_key'\" 1;
	_arg_ns_${_arg_arg_name//-/_}[\$_ns_key]=\"\$2\";
	shift;
	;;
";

echo -e "${optParser}";