subcommand: Make help text variables private.

[gsu.git] / subcommand

diff --git a/subcommand b/subcommand
index f668f2adb5332bce964fdb1d5cc28e07ad0d7b2f..71f06141abbdd7f0f0b81068abb2037190abec99 100644 (file)
--- a/subcommand
+++ b/subcommand
@@ -1,14 +1,16 @@
 #!/bin/bash
 #!/bin/bash

-# (C) 2006-2011 Andre Noll
+# Copyright (C) 2006 Andre Noll
+# Licensed under the LGPL, version 3. See COPYING and COPYING.LESSER.

 
 

-if [[ $(type -t gsu_is_a_number) != "function" ]]; then
-       GSU_DIR=${GSU_DIR:=${HOME-}/.gsu}
-       . $GSU_DIR/common || exit 1
+if [[ "$(type -t _gsu_setup)" != "function" ]]; then
+       gsu_dir=${gsu_dir:-${BASH_SOURCE[0]%/*}}
+       . $gsu_dir/common || exit 1
+       _gsu_setup

 fi
 
 _gsu_usage()
 {
 fi
 
 _gsu_usage()
 {

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

 }
 
 # Return an extended regular expression to match against $0.
 }
 
 # Return an extended regular expression to match against $0.


@@ -23,7 +25,7 @@ _gsu_usage()
 # exactly one parenthesized subexpression for matching the command name.
 _gsu_get_command_regex()
 {
 # exactly one parenthesized subexpression for matching the command name.
 _gsu_get_command_regex()
 {

-       local cmd="${1:-[-a-zA-Z_0-9]+}"
+       local cmd="${1:-[-a-zA-Z_0-9]{1,\}}"

        result="^com_($cmd)\(\)"
 }
 
        result="^com_($cmd)\(\)"
 }
 


@@ -48,15 +50,131 @@ _gsu_available_commands()
        } | sort | tr '\n' ' ')"
 }
 
        } | sort | tr '\n' ' ')"
 }
 

+# 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 required
+gsu_check_arg_count()
+{
+       ret=-$E_GSU_BAD_ARG_COUNT
+       if (($# == 2)); then # only num1 is given
+               result="at least $2 args required, $1 given"
+               (($1 < $2)) && return
+               ret=$GSU_SUCCESS
+               return
+       fi
+       # num1 and num2 given
+       result="need at least $2 args, $1 given"
+       (($1 < $2)) && return
+       result="need at most $3 args, $1 given"
+       (($1 > $3)) && return
+       ret=$GSU_SUCCESS
+}
+
+# Wrapper for the bash getopts builtin.
+#
+# Aborts on programming errors such as missing or invalid option string.  On
+# success $result contains shell code that can be eval'ed. For each defined
+# option x, the local variable o_x will be created when calling eval "$result".
+# o_x contains true/false for options without argument and either the empty
+# string or the given argument for options that take an argument.
+#
+# Example:
+#      gsu_getopts abc:x:y
+#      eval "$result"
+#      (($ret < 0)) && return
+#
+#      [[ "$o_a" = 'true' ]] && echo 'The -a flag was given'
+#      [[ -n "$o_c" ]] && echo "The -c option was given with arg $o_c"
+gsu_getopts()
+{
+       local i c tab=' ' cr='
+'
+
+       gsu_check_arg_count $# 1 1
+       if (($ret < 0)); then
+               gsu_err_msg
+               exit 1
+       fi
+
+       ret=-$E_GSU_GETOPTS
+       result="invalid optstring $1"
+       if [[ -z "$1" ]] || grep -q '::' <<< "$1" ; then
+               gsu_err_msg
+               exit 1
+       fi
+
+       for ((i=0; i < ${#1}; i++)); do
+               c=${1:$i:1}
+               case "$c" in
+               [a-zA-Z:]);;
+               *)
+                       ret=-$E_GSU_GETOPTS
+                       result="invalid character $c in optstring"
+                       gsu_err_msg
+                       exit 1
+               esac
+       done
+       result="local _gsu_getopts_opt"
+       for ((i=0; i < ${#1}; i++)); do
+               c1=${1:$i:1}
+               c2=${1:$(($i + 1)):1}
+               result+=" o_$c1="
+               if [[ "$c2" = ":" ]]; then
+                       let i++
+               else
+                       result+="false"
+               fi
+       done
+       result+="
+       OPTIND=1
+       while getopts $1 _gsu_getopts_opt \"\$@\"; do
+               case \"\$_gsu_getopts_opt\" in
+"
+       for ((i=0; i < ${#1}; i++)); do
+               c1=${1:$i:1}
+               c2=${1:$(($i + 1)):1}
+               result+="$tab$tab$c1) o_$c1="
+               if [[ "$c2" = ":" ]]; then
+                       result+="\"\$OPTARG\""
+                       let i++
+               else
+                       result+="true"
+               fi
+               result+=";;$cr"
+       done
+       result+="
+               *)
+                       ret=-\$E_GSU_GETOPTS
+                       result=\"invalid option given\"
+                       return
+                       ;;
+               esac
+       done
+       shift \$((\$OPTIND - 1))
+"
+       ret=$GSU_SUCCESS
+}
+

 _gsu_print_available_commands()
 {
 _gsu_print_available_commands()
 {

-       local cmd
+       local cmd cmds

        local -i count=0
 
        local -i count=0
 

+       _gsu_available_commands
+       cmds="$result"

        printf 'Available commands:\n'
        printf 'Available commands:\n'

-       for cmd in $gsu_cmds; do
+       for cmd in $cmds; do

                printf '%s' "$cmd"
                printf '%s' "$cmd"

-               let count++
+               let ++count

                if (($count % 4)); then
                        printf '\t'
                        ((${#cmd} < 8)) && printf '\t'
                if (($count % 4)); then
                        printf '\t'
                        ((${#cmd} < 8)) && printf '\t'


@@ -67,6 +185,8 @@ _gsu_print_available_commands()
        printf '\n'
 }
 
        printf '\n'
 }
 

+# Print all options of the given optstring to stdout if the word in the current
+# command line begins with a hyphen character.

 gsu_complete_options()
 {
        local opts="$1" cword="$2" cur opt
 gsu_complete_options()
 {
        local opts="$1" cword="$2" cur opt


@@ -87,19 +207,23 @@ gsu_complete_options()
        done
 }
 
        done
 }
 

-export gsu_prefs_txt="
+com_prefs_options='e'
+
+_gsu_prefs_txt="

 Print the current preferences.
 
 Usage: prefs [-e]
 
 Print the current preferences.
 
 Usage: prefs [-e]
 

-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()
+If -e is given, the config file is opened with the default editor.
+Without options, the command prints out a list of all config variables,
+together with their current value and the default value.
+"
+
+com_prefs()

 {
        local i conf="${gsu_config_file:=${HOME:-}/.$gsu_name.rc}"
 
 {
        local i conf="${gsu_config_file:=${HOME:-}/.$gsu_name.rc}"
 

-       gsu_getopts "e"
+       gsu_getopts "$com_prefs_options"

        eval "$result"
        (($ret < 0)) && return
        gsu_check_arg_count $# 0 0
        eval "$result"
        (($ret < 0)) && return
        gsu_check_arg_count $# 0 0


@@ -109,11 +233,11 @@ _com_prefs()
                ret=-$E_GSU_MKDIR
                result="${conf%/*}"
                mkdir -p "$result"
                ret=-$E_GSU_MKDIR
                result="${conf%/*}"
                mkdir -p "$result"

-               [[ $? -ne 0 ]] && return
+               (($? != 0)) && return

                ret=-$E_GSU_EDITOR
                result="${EDITOR:-vi}"
                "$result" "$conf"
                ret=-$E_GSU_EDITOR
                result="${EDITOR:-vi}"
                "$result" "$conf"

-               [[ $? -ne 0 ]] && return
+               (($? != 0)) && return

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


@@ -145,29 +269,29 @@ _com_prefs()
 
 complete_prefs()
 {
 
 complete_prefs()
 {

-       gsu_complete_options "e" "$@"
+       gsu_complete_options "$com_prefs_options" "$@"

 }
 
 }
 

-export gsu_man_txt="
+_gsu_man_txt="

 Print the manual.
 
 Usage: man"
 
 Print the manual.
 
 Usage: man"
 

-_com_man()
+com_man()

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

-        local com num
+       local com num

 
 

-       echo "$_gsu_self (_${gsu_banner_txt}_) manual"
-       echo "${equal_signs:0:${#_gsu_self} + ${#gsu_banner_txt} + 16}"
+       echo "$gsu_name (_${gsu_banner_txt}_) manual"
+       echo "${equal_signs:0:${#gsu_name} + ${#gsu_banner_txt} + 16}"

        echo
 
        echo
 

-        sed -e '1,/^#\{70,\}/d' -e '/^#\{70,\}/,$d' $0 -e 's/^# *//'
+       sed -e '1,/^#\{70,\}/d' -e '/^#\{70,\}/,$d' $0 -e 's/^# *//'

        echo "----"
        echo "----"

-        echo
-       echo "$_gsu_self usage"
-       echo "${minus_signs:0:${#_gsu_self} + 6}"
+       echo
+       echo "$gsu_name usage"
+       echo "${minus_signs:0:${#gsu_name} + 6}"

        printf "\t"
        _gsu_usage 2>&1
        echo "Each command has its own set of options as described below."
        printf "\t"
        _gsu_usage 2>&1
        echo "Each command has its own set of options as described below."


@@ -177,26 +301,19 @@ _com_man()
        echo "Available commands:"
 
        _gsu_available_commands
        echo "Available commands:"
 
        _gsu_available_commands

-        for com in $result; do
+       for com in $result; do

                num=${#com}
                num=${#com}

-               if test $num -lt 4; then
-                       num=4
-               fi
-                echo "${minus_signs:0:$num}"
-                echo "$com"
-                echo "${minus_signs:0:$num}"
-                $0 help $com
+               (($num < 4)) && num=4
+               echo "${minus_signs:0:$num}"
+               echo "$com"
+               echo "${minus_signs:0:$num}"
+               $0 help $com

                echo
                echo

-        done
-        ret=$GSU_SUCCESS
-}
-
-_gsu_banner_msg()
-{
-       gsu_short_msg "### $_gsu_self -- ###"
+       done
+       ret=$GSU_SUCCESS

 }
 
 }
 

-export gsu_help_txt="
+_gsu_help_txt="

 Print online help.
 
 Usage: help [command]
 Print online help.
 
 Usage: help [command]


@@ -204,7 +321,7 @@ 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."
 

-export gsu_complete_txt="
+_gsu_complete_txt="

 Command line completion.
 
 Usage: complete [<cword> <word>...]
 Command line completion.
 
 Usage: complete [<cword> <word>...]


@@ -218,7 +335,7 @@ written to stdout. This can be used from the completion function of
 the subcommand.
 "
 
 the subcommand.
 "
 

-_com_help()
+com_help()

 {
        local a b ere tab='     '
 
 {
        local a b ere tab='     '
 


@@ -226,13 +343,13 @@ _com_help()
        ere="$result"
 
        if (($# == 0)); then
        ere="$result"
 
        if (($# == 0)); then

-               _gsu_banner_msg 2>&1
+               gsu_short_msg "### $gsu_name -- $gsu_banner_txt ###"

                _gsu_usage 2>&1
                {
                _gsu_usage 2>&1
                {

-                       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 "--"
-                       printf "com_complete()\n$gsu_complete_txt" | head -n 4; echo "--"
+                       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 "--"
+                       printf "com_complete()\n$_gsu_complete_txt" | head -n 4; echo "--"

                        grep -EA 2 "$ere" $0
                } | grep -v -- '--' \
                        | sed -En "/$ere/"'!d
                        grep -EA 2 "$ere" $0
                } | grep -v -- '--' \
                        | sed -En "/$ere/"'!d


@@ -256,27 +373,27 @@ _com_help()
                                # and print the sucker
                                p'
                echo
                                # and print the sucker
                                p'
                echo

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

                ret=$GSU_SUCCESS
                return
        fi
        if test "$1" = "help"; then
                ret=$GSU_SUCCESS
                return
        fi
        if test "$1" = "help"; then

-               echo "$gsu_help_txt"
+               echo "$_gsu_help_txt"

                ret=$GSU_SUCCESS
                return
        fi
        if test "$1" = "man"; then
                ret=$GSU_SUCCESS
                return
        fi
        if test "$1" = "man"; then

-               echo "$gsu_man_txt"
+               echo "$_gsu_man_txt"

                ret=$GSU_SUCCESS
                return
        fi
        if test "$1" = "prefs"; then
                ret=$GSU_SUCCESS
                return
        fi
        if test "$1" = "prefs"; then

-               echo "$gsu_prefs_txt"
+               echo "$_gsu_prefs_txt"

                ret=$GSU_SUCCESS
                return
        fi
        if test "$1" = "complete"; then
                ret=$GSU_SUCCESS
                return
        fi
        if test "$1" = "complete"; then

-               echo "$gsu_complete_txt"
+               echo "$_gsu_complete_txt"

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


@@ -315,92 +432,7 @@ complete_help()
        echo "$result"
 }
 
        echo "$result"
 }
 

-# Wrapper for the bash getopts builtin.
-#
-# Aborts on programming errors such as missing or invalid option string.  On
-# success $result contains shell code that can be eval'ed. For each defined
-# option x, the local variable o_x will be created when calling eval "$result".
-# o_x contains true/false for options without argument and either the emtpy
-# string or the given argument for options that take an argument.
-#
-# Example:
-#      gsu_getopts abc:x:y
-#      eval "$result"
-#      (($ret < 0)) && return
-#
-#      [[ "$o_a" = 'true' ]] && echo 'The -a flag was given'
-#      [[ -n "$o_c" ]] && echo "The -c option was given with arg $o_c"
-gsu_getopts()
-{
-       local i c tab=' ' cr='
-'
-
-       gsu_check_arg_count $# 1 1
-       if [[ $ret -lt 0 ]]; then
-               gsu_err_msg
-               exit 1
-       fi
-
-       ret=-$E_GSU_GETOPTS
-       result="invalid optstring $1"
-       if [[ -z "$1" ]] || grep -q '::' <<< "$1" ; then
-               gsu_err_msg
-               exit 1
-       fi
-
-       for ((i=0; i < ${#1}; i++)); do
-               c=${1:$i:1}
-               case "$c" in
-               [a-zA-Z:]);;
-               *)
-                       ret=-$E_GSU_GETOPTS
-                       result="invalid character $c in optstring"
-                       gsu_err_msg
-                       exit 1
-               esac
-       done
-       result="local _gsu_getopts_opt"
-       for ((i=0; i < ${#1}; i++)); do
-               c1=${1:$i:1}
-               c2=${1:$(($i + 1)):1}
-               result+=" o_$c1="
-               if [[ "$c2" = ":" ]]; then
-                       let i++
-               else
-                       result+="false"
-               fi
-       done
-       result+="
-       OPTIND=1
-       while getopts $1 _gsu_getopts_opt \"\$@\"; do
-               case \"\$_gsu_getopts_opt\" in
-"
-       for ((i=0; i < ${#1}; i++)); do
-               c1=${1:$i:1}
-               c2=${1:$(($i + 1)):1}
-               result+="$tab$tab$c1) o_$c1="
-               if [[ "$c2" = ":" ]]; then
-                       result+="\"\$OPTARG\""
-                       let i++
-               else
-                       result+="true"
-               fi
-               result+=";;$cr"
-       done
-       result+="
-               *)
-                       ret=-\$E_GSU_GETOPTS
-                       result=\"invalid option given\"
-                       return
-                       ;;
-               esac
-       done
-       shift \$((\$OPTIND - 1))
-"
-       ret=$GSU_SUCCESS
-}
-
-_com_complete()
+com_complete()

 {
        local cmd n cword
        local -a words
 {
        local cmd n cword
        local -a words


@@ -530,71 +562,25 @@ gsu_get_unnamed_arg_num()
 gsu()
 {
        local i
 gsu()
 {
        local i

-       _gsu_setup
-       _gsu_available_commands
-       gsu_cmds="$result"
-       if test $# -eq 0; then
+
+       if (($# == 0)); then

                _gsu_usage
                _gsu_print_available_commands
                exit 1
        fi
        arg="$1"
        shift
                _gsu_usage
                _gsu_print_available_commands
                exit 1
        fi
        arg="$1"
        shift

-       # check internal commands
-       if [[ "$arg" = "help" || "$arg" = "man" || "$arg" = "prefs" || "$arg" = "complete" ]]; then
-               _com_$arg "$@"
-               if [[ "$ret" -lt 0 ]]; then
+       if [[ "$(type -t com_$arg)" == 'function' ]]; then
+               com_$arg "$@"
+               if (("$ret" < 0)); then

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

-
-       # external commands
-       for i in $gsu_cmds; do
-               if test "$arg" = "$i"; then
-                       com_$arg "$@"
-                       if [[ "$ret" -lt 0 ]]; then
-                               gsu_err_msg
-                               exit 1
-                       fi
-                       exit 0
-               fi
-       done
-

        ret=-$E_GSU_BAD_COMMAND
        result="$arg"
        gsu_err_msg
        _gsu_print_available_commands
        exit 1
 }
        ret=-$E_GSU_BAD_COMMAND
        result="$arg"
        gsu_err_msg
        _gsu_print_available_commands
        exit 1
 }

-
-# 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
-}