X-Git-Url: http://git.tuebingen.mpg.de/?p=gsu.git;a=blobdiff_plain;f=funcs%2Fgsu;h=d78233ed3a8e2dab0fbaa092006f5ecc167391ff;hp=dc2033d401a981bca7b62d3a5f5f7028070cf9c6;hb=33ed4a27159aae243c71991fb71c2948cd1042e0;hpb=9cb0e6abcd699f8a595f523099ac7ba0db77f76a diff --git a/funcs/gsu b/funcs/gsu index dc2033d..d78233e 100644 --- a/funcs/gsu +++ b/funcs/gsu @@ -1,12 +1,21 @@ +#!/bin/bash # gsu -- the global subcommand utility -# (C) 2006-2007 Andre Noll +# (C) 2006-2009 Andre Noll -gsu_init_errors() +_gsu_init_errors() { gsu_errors=" GSU_SUCCESS success E_GSU_BAD_COMMAND invalid command E_GSU_NOT_A_NUMBER not a number +E_GSU_SOURCE error in config file +E_GSU_CONFIG bad/missing config file option +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_BAD_ARG_COUNT invalid number of arguments +E_NO_DEFAULT missing default value $gsu_errors " local a b i=0 @@ -22,7 +31,7 @@ $gsu_errors $gsu_errors EOF } -export -f gsu_init_errors +export -f _gsu_init_errors # check if $1 is a number gsu_is_a_number() @@ -36,6 +45,37 @@ gsu_is_a_number() } export -f gsu_is_a_number +# Check number of arguments. +# +# Usage: gsu_check_arg_count [] +# +# Check that is between and inclusively. +# If only 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 @@ -44,27 +84,29 @@ export -f gsu_short_msg gsu_msg() { - gsu_short_msg "$gsu_self: $1" + gsu_short_msg "$_gsu_self: $1" } export -f gsu_msg gsu_date_msg() { - gsu_short_msg "$gsu_self $(date): $1" + gsu_short_msg "$_gsu_self $(date): $1" } 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 - gsu_short_msg "$txt ***" + gsu_short_msg "$txt ###" } -export -f gsu_banner_msg +export -f _gsu_banner_msg gsu_err_msg() { @@ -89,23 +131,23 @@ gsu_err_msg() } 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 -gsu_available_commands() +_gsu_available_commands() { - result="$( (printf "help\nman\n"; grep "^com_[a-z_]\+()" $0) \ + result="$( (printf "help\nman\nprefs\n"; grep "^com_[a-z_]\+()" $0) \ | sed -e 's/^com_//' -e 's/()//' \ | sort \ | tr '\n' ' ')" ret=$GSU_SUCCESS } -export -f gsu_available_commands +export -f _gsu_available_commands -gsu_print_available_commands() +_gsu_print_available_commands() {( local i count gsu_short_msg "Available commands:" @@ -124,38 +166,74 @@ gsu_print_available_commands() echo ) 2>&1 } -export -f gsu_print_available_commands +export -f _gsu_print_available_commands + +export gsu_prefs_txt=" +Print the current preferences. + +Usage: prefs + +Print out a list of all cmt config variables, together with their current value +and the default value." +_com_prefs() +{ + local i + + for ((i=0; i < ${#gsu_options[@]}; i++)); do + local name= option_type= default_value= required= + local description= help_text= + eval "${gsu_options[$i]}" + eval val='"$'${gsu_config_var_prefix}_$name'"' + case "$required" in + true|yes) + printf "# required" + ;; + *) + printf "# optional" + ;; + esac + printf " $option_type: $description" + if [[ "$required" != "yes" && "$required" != "true" ]]; then + printf " [$default_value]" + fi + echo + [[ -n "$help_text" ]] && sed -e '/^[ ]*$/d; s/^[ ]*/# /g' <<< "$help_text" + printf "$name=$val" + [[ "$val" == "$default_value" ]] && printf " # default" + echo + done +} +export -f _com_prefs export gsu_man_txt=" Print the manual. Usage: man" -com_man() +_com_man() { local equal_signs="==================================================" local minus_signs="--------------------------------------------------" - local tilde_signs="~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~" local com num - echo "$gsu_self (_${gsu_banner_txt}_) manual" - echo "${equal_signs:0:${#gsu_self} + ${#gsu_banner_txt} + 16}" + echo "$_gsu_self (_${gsu_banner_txt}_) manual" + echo "${equal_signs:0:${#_gsu_self} + ${#gsu_banner_txt} + 16}" echo sed -e '1,/^#\{70,\}/d' -e '/^#\{70,\}/,$d' $0 -e 's/^# *//' echo "----" echo - echo "$gsu_self usage" - echo "${minus_signs:0:${#gsu_self} + 6}" + echo "$_gsu_self usage" + echo "${minus_signs:0:${#_gsu_self} + 6}" printf "\t" - gsu_usage 2>&1 + _gsu_usage 2>&1 echo "Each command has its own set of options as described below." echo echo "----" echo echo "Available commands:" - gsu_available_commands + _gsu_available_commands for com in $result; do num=${#com} if test $num -lt 4; then @@ -169,7 +247,7 @@ com_man() done ret=$GSU_SUCCESS } -export -f com_man +export -f _com_man export gsu_help_txt=" Print online help. @@ -179,18 +257,18 @@ Usage: help [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 - # 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 "--" - - grep -A 2 "^com_\([a-zA-Z_0-9]\+\)()" $0) \ - | grep -v -- '--' \ + _gsu_banner_msg 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 "--" + 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 \ @@ -205,7 +283,7 @@ com_help() echo "$b" done echo - echo "Try $gsu_self help for info on ." + echo "# Try $_gsu_self help for info on ." ret=$GSU_SUCCESS return fi @@ -219,46 +297,155 @@ com_help() ret=$GSU_SUCCESS return fi + if test "$1" = "prefs"; then + echo "$gsu_prefs_txt" + ret=$GSU_SUCCESS + return + 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 + _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. +_gsu_check_options() +{ + local i conf="${gsu_config_file:=$HOME/.$gsu_name.rc}" val + + for ((i=0; i < ${#gsu_options[@]}; i++)); do + eval "${gsu_options[$i]}" + eval val='"'\$$name'"' + eval orig_${gsu_config_var_prefix}_$name='"'${val}'"' + done + + [[ -r "$conf" ]] && source "$conf" + + for ((i=0; i < ${#gsu_options[@]}; i++)); do + local name= option_type= default_value= required= + local description= help_text= + local val orig_val + + eval "${gsu_options[$i]}" + + + # Check name. It must be non-empty and consist of [a-zA-Z_0-9] + # only. Moreover it must not start with [a-zA-Z]. + + ret=-$E_GSU_BAD_CONFIG_VAR + result="name: '$name'" + # bash's =~ works only for 3.2 and newer, so use grep + echo "$name" | grep '^[a-zA-Z][a-zA-Z_0123456789]*$' &> /dev/null; + [[ $? -ne 0 ]] && return + + eval orig_val='"'\$orig_${gsu_config_var_prefix}_$name'"' + if [[ -z "$orig_val" ]]; then + eval val='"'\$$name'"' + else + val="$orig_val" + fi + case "$required" in + true|yes) + ret=-$E_GSU_NEED_VALUE + result="$name" + [[ -z "$val" ]] && return + ;; + false|no) + ;; + *) + ret=-$E_GSU_BAD_BOOL + result="required: $required, name: $name, val: $val" + return + esac + + 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 + string) + ;; + num) + gsu_is_a_number "$val" + [[ $ret -lt 0 ]] && return + ;; + *) + ret=-$E_GSU_BAD_OPTION_TYPE + result="$name/$option_type" + return + esac + done + ret=$GSU_SUCCESS +} +export -f _gsu_check_options gsu() { local i - gsu_self="$(basename $0)" - gsu_init_errors - gsu_available_commands + 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_init_errors + _gsu_check_options + if [[ "$ret" -lt 0 ]]; then + if [[ "$1" != "help" && "$1" != "man" ]]; then + gsu_err_msg + exit 1 + fi + fi + _gsu_available_commands gsu_cmds="$result" if test $# -eq 0; then - gsu_usage - gsu_print_available_commands + _gsu_usage + _gsu_print_available_commands exit 1 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 "$@" - if test $ret -lt 0; then + 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 + _gsu_print_available_commands exit 1 } -# no need to export this +export -f gsu + +# TODO: gsu_strerror: get error string