gsu com_help(): Be more strict when looking for command documentation.

[gsu.git] / funcs / gsu

diff --git a/funcs/gsu b/funcs/gsu
index b80fc919659c008420cc54d79890ea7d14ae4d7f..df25bf63c429ca9873024a2dd4e8283be161143c 100644 (file)
--- a/funcs/gsu
+++ b/funcs/gsu
@@ -14,6 +14,7 @@ E_GSU_BAD_CONFIG_VAR          invalid config variable
 E_GSU_NEED_VALUE               value required but not given
 E_GSU_BAD_BOOL                 bad value for boolian option
 E_GSU_BAD_OPTION_TYPE          invalid option type
 E_GSU_NEED_VALUE               value required but not given
 E_GSU_BAD_BOOL                 bad value for boolian option
 E_GSU_BAD_OPTION_TYPE          invalid option type

+E_GSU_BAD_ARG_COUNT            invalid number of arguments

 E_NO_DEFAULT                   missing default value
 $gsu_errors
 "
 E_NO_DEFAULT                   missing default value
 $gsu_errors
 "


@@ -44,6 +45,37 @@ gsu_is_a_number()
 }
 export -f gsu_is_a_number
 
 }
 export -f gsu_is_a_number
 

+# Check number of arguments.
+#
+# Usage: gsu_check_arg_count <num_given> <num1> [<num2>]
+#
+# Check that <num_given> is between <num1> and <num2> inclusively.
+# If only <num1> ist given, num2 is assumed to be infinity.
+#
+# Examples:
+#      0 0 no argument allowed
+#      1 1 exactly one argument required
+#      0 2 at most two arguments admissible
+#      2   at least two arguments reqired
+#
+gsu_check_arg_count()
+{
+       ret=-$E_GSU_BAD_ARG_COUNT
+       if [[ $# -eq 2 ]]; then # only num1 is given
+               result="at least $2 args required, $1 given"
+               [[ $1 -lt $2 ]] && return
+               ret=$GSU_SUCCESS
+               return
+       fi
+       # num1 and num2 given
+       result="need at least $2 args, $1 given"
+       [[ $1 -lt $2 ]] && return
+       result="need at most $3 args, $1 given"
+       [[ $1 -gt $3 ]] && return
+       ret=$GSU_SUCCESS
+}
+export -f gsu_check_arg_count
+

 gsu_short_msg()
 {
        echo "$1" 1>&2
 gsu_short_msg()
 {
        echo "$1" 1>&2


@@ -62,15 +94,17 @@ gsu_date_msg()
 }
 export -f gsu_date_msg
 
 }
 export -f gsu_date_msg
 

+
+

 _gsu_banner_msg()
 {
 _gsu_banner_msg()
 {

-       local txt="*** $_gsu_self --"
+       local txt="### $_gsu_self --"

        if test -z "$gsu_banner_txt"; then
                txt="$txt set \$gsu_banner_txt to customize this message"
        else
                txt="$txt $gsu_banner_txt"
        fi
        if test -z "$gsu_banner_txt"; then
                txt="$txt set \$gsu_banner_txt to customize this message"
        else
                txt="$txt $gsu_banner_txt"
        fi

-       gsu_short_msg "$txt ***"
+       gsu_short_msg "$txt ###"

 }
 export -f _gsu_banner_msg
 
 }
 export -f _gsu_banner_msg
 


@@ -99,7 +133,7 @@ export -f gsu_err_msg
 
 _gsu_usage()
 {
 
 _gsu_usage()
 {

-       gsu_short_msg "Usage: $_gsu_self command [options]"
+       gsu_short_msg "# Usage: $_gsu_self command [options]"

 }
 export -f _gsu_usage
 
 }
 export -f _gsu_usage
 


@@ -141,7 +175,7 @@ Usage: prefs
 
 Print out a list of all cmt config variables, together with their current value
 and the default value."
 
 Print out a list of all cmt config variables, together with their current value
 and the default value."

-com_prefs()
+_com_prefs()

 {
        local i
 
 {
        local i
 


@@ -169,14 +203,14 @@ com_prefs()
                echo
        done
 }
                echo
        done
 }

-export -f com_prefs
+export -f _com_prefs

 
 export gsu_man_txt="
 Print the manual.
 
 Usage: man"
 
 
 export gsu_man_txt="
 Print the manual.
 
 Usage: man"
 

-com_man()
+_com_man()

 {
        local equal_signs="=================================================="
        local minus_signs="--------------------------------------------------"
 {
        local equal_signs="=================================================="
        local minus_signs="--------------------------------------------------"


@@ -213,7 +247,7 @@ com_man()
         done
         ret=$GSU_SUCCESS
 }
         done
         ret=$GSU_SUCCESS
 }

-export -f com_man
+export -f _com_man

 
 export gsu_help_txt="
 Print online help.
 
 export gsu_help_txt="
 Print online help.


@@ -223,19 +257,18 @@ Usage: help [command]
 Without arguments, print the list of available commands. Otherwise,
 print the help text for the given command."
 
 Without arguments, print the list of available commands. Otherwise,
 print the help text for the given command."
 

-com_help()
+_com_help()

 {
        local a b
        if test -z "$1"; then
                _gsu_banner_msg 2>&1
                _gsu_usage 2>&1
 {
        local a b
        if test -z "$1"; then
                _gsu_banner_msg 2>&1
                _gsu_usage 2>&1

-               # sed is magic, baby
-               (printf "com_help()\n$gsu_help_txt" | head -n 4; echo "--"
-               printf "com_man()\n$gsu_man_txt" | head -n 4; echo "--"
-               printf "com_prefs()\n$gsu_prefs_txt" | head -n 4; echo "--"
-
-               grep -A 2 "^com_\([a-zA-Z_0-9]\+\)()" $0) \
-                       | grep -v -- '--' \
+               {
+                       printf "com_help()\n$gsu_help_txt" | head -n 4; echo "--"
+                       printf "com_man()\n$gsu_man_txt" | head -n 4; echo "--"
+                       printf "com_prefs()\n$gsu_prefs_txt" | head -n 4; echo "--"
+                       grep -A 2 "^com_\([a-zA-Z_0-9]\+\)()" $0
+               } | grep -v -- '--' \

                        | sed -e '/^com_\([a-zA-Z_0-9]\+\)()/bs' \
                                -e 'H;$!d;x;s/\n//g;b' \
                                -e :s \
                        | sed -e '/^com_\([a-zA-Z_0-9]\+\)()/bs' \
                                -e 'H;$!d;x;s/\n//g;b' \
                                -e :s \


@@ -250,7 +283,7 @@ com_help()
                                echo "$b"
                         done
                echo
                                echo "$b"
                         done
                echo

-               echo "Try $_gsu_self help <command> for info on <command>."
+               echo "# Try $_gsu_self help <command> for info on <command>."

                ret=$GSU_SUCCESS
                return
        fi
                ret=$GSU_SUCCESS
                return
        fi


@@ -271,14 +304,14 @@ com_help()
        fi
        ret=$GSU_SUCCESS
        if grep -q "^com_$1()" $0; then
        fi
        ret=$GSU_SUCCESS
        if grep -q "^com_$1()" $0; then

-               sed -e "1,/com_$1()/d" -e '/^{/,$d' -e 's/^## *//' $0
+               sed -e "1,/^com_$1()$/d" -e '/^{/,$d' -e 's/^## *//' $0

                return
        fi
        _gsu_print_available_commands
        result="$1"
        ret=-$E_GSU_BAD_COMMAND
 }
                return
        fi
        _gsu_print_available_commands
        result="$1"
        ret=-$E_GSU_BAD_COMMAND
 }

-export -f com_help
+export -f _com_help

 
 # internal gsu function that syntactically checks the gsu_options array
 # for errors and parses the config file.
 
 # internal gsu function that syntactically checks the gsu_options array
 # for errors and parses the config file.


@@ -331,7 +364,7 @@ _gsu_check_options()
                        return
                esac
 
                        return
                esac
 

-               eval ${gsu_config_var_prefix}_$name="\"${val:=$default_value}\""
+               eval ${gsu_config_var_prefix}_$name='"'${val:=$default_value}'"'

                # Check option type. ATM, only num and string are supported
                # Other types may be added without breaking compatibility
                case "$option_type" in
                # Check option type. ATM, only num and string are supported
                # Other types may be added without breaking compatibility
                case "$option_type" in


@@ -355,6 +388,16 @@ gsu()
 {
        local i
 
 {
        local i
 

+       gsu_is_a_number "${BASH_VERSINFO[0]}"
+       if [[ $ret -lt 0 ]]; then
+               gsu_msg "fatal: failed to determine bash version"
+               exit 1
+       fi
+
+       if [[ "${BASH_VERSINFO[0]}" -lt 4 ]]; then
+               gsu_msg "fatal: This script requires at least bash 4.0"
+               exit 1
+       fi

        _gsu_self="$(basename $0)"
        gsu_name="${gsu_name:=$_gsu_self}"
        gsu_config_var_prefix="${gsu_config_var_prefix:=$gsu_name}"
        _gsu_self="$(basename $0)"
        gsu_name="${gsu_name:=$_gsu_self}"
        gsu_config_var_prefix="${gsu_config_var_prefix:=$gsu_name}"


@@ -375,6 +418,17 @@ gsu()
        fi
        arg="$1"
        shift
        fi
        arg="$1"
        shift

+       # check internal commands
+       if [[ "$arg" = "help" || "$arg" = "man" || "$arg" = "prefs" ]]; then
+               _com_$arg "$@"
+               if [[ "$ret" -lt 0 ]]; then
+                       gsu_err_msg
+                       exit 1
+               fi
+               exit 0
+       fi
+
+       # external commands

        for i in $gsu_cmds; do
                if test "$arg" = "$i"; then
                        com_$arg "$@"
        for i in $gsu_cmds; do
                if test "$arg" = "$i"; then
                        com_$arg "$@"


@@ -385,6 +439,7 @@ gsu()
                        exit 0
                fi
        done
                        exit 0
                fi
        done

+

        ret=-$E_GSU_BAD_COMMAND
        result="$arg"
        gsu_err_msg
        ret=-$E_GSU_BAD_COMMAND
        result="$arg"
        gsu_err_msg