gsu: Add -e option to com_prefs.

[gsu.git] / funcs / gsu

diff --git a/funcs/gsu b/funcs/gsu
index b409bc50bc75d50969d60a800c0710358c34c2d9..448d551180ee0dee11896ac23746f7704186f9ad 100644 (file)
--- a/funcs/gsu
+++ b/funcs/gsu
@@ -15,6 +15,7 @@ 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_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_GSU_EDITOR                   failed to execute editor

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


@@ -98,13 +99,13 @@ 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
 


@@ -133,7 +134,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
 


@@ -171,13 +172,22 @@ export -f _gsu_print_available_commands
 export gsu_prefs_txt="
 Print the current preferences.
 
 export gsu_prefs_txt="
 Print the current preferences.
 

-Usage: prefs
+Usage: prefs [-e]

 
 

-Print out a list of all cmt config variables, together with their current value
-and the default value."
-com_prefs()
+If -e is given, the config file is opened with the default editor.  Without
+options, the command prints out a list of all cmt config variables, together
+with their current value and the default value."
+_com_prefs()

 {
 {

-       local i
+       local i conf="${gsu_config_file:=$HOME/.$gsu_name.rc}"
+
+       if [[ "$1" = "-e" ]]; then
+               ret=-$E_GSU_EDITOR
+               result="${EDITOR:-vi}"
+               "$result" "$conf"
+               ret=$GSU_SUCCESS
+               return
+       fi

 
        for ((i=0; i < ${#gsu_options[@]}; i++)); do
                local name= option_type= default_value= required=
 
        for ((i=0; i < ${#gsu_options[@]}; i++)); do
                local name= option_type= default_value= required=


@@ -203,14 +213,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="--------------------------------------------------"


@@ -247,7 +257,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.


@@ -257,19 +267,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 \


@@ -284,7 +293,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


@@ -305,14 +314,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.


@@ -389,6 +398,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}"


@@ -409,16 +428,28 @@ 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 "$@"

-                       if test $ret -lt 0; then
+                       if [[ "$ret" -lt 0 ]]; then

                                gsu_err_msg
                                exit 1
                        fi
                        exit 0
                fi
        done
                                gsu_err_msg
                                exit 1
                        fi
                        exit 0
                fi
        done

+

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