X-Git-Url: http://git.tuebingen.mpg.de/?p=gsu.git;a=blobdiff_plain;f=funcs%2Fgsu;h=e7a49feaf2a084def529e9ba95512922d050437a;hp=75e569cb0a00789badb00735bf3a36f8391ce6db;hb=36395c9a656df7f1834d0840c07662885adcf52b;hpb=b3e4039f76f3af4dc2c11642e9edd8309161951c diff --git a/funcs/gsu b/funcs/gsu index 75e569c..e7a49fe 100644 --- a/funcs/gsu +++ b/funcs/gsu @@ -1,6 +1,6 @@ #!/bin/bash # gsu -- the global subcommand utility -# (C) 2006-2009 Andre Noll +# (C) 2006-2010 Andre Noll _gsu_init_errors() { @@ -8,14 +8,13 @@ _gsu_init_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 +E_GSU_EDITOR failed to execute editor +E_GSU_MKDIR failed to create directory $gsu_errors " local a b i=0 @@ -45,17 +44,25 @@ gsu_is_a_number() } export -f gsu_is_a_number +# Check number of arguments. +# # Usage: gsu_check_arg_count [] # -# If only ist given, then must equal . -# Otherwise, .. is treated as a range and it is checked -# that lies between and inclusively. +# 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="exactly $2 args needed, $1 given" - [[ $1 -ne $2 ]] && return + result="at least $2 args required, $1 given" + [[ $1 -lt $2 ]] && return ret=$GSU_SUCCESS return fi @@ -90,13 +97,13 @@ export -f gsu_date_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 @@ -125,7 +132,7 @@ export -f gsu_err_msg _gsu_usage() { - gsu_short_msg "Usage: $_gsu_self command [options]" + gsu_short_msg "# Usage: $_gsu_self command [options]" } export -f _gsu_usage @@ -163,13 +170,27 @@ export -f _gsu_print_available_commands 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_MKDIR + result="${conf%/*}" + mkdir -p "$result" + [[ $? -ne 0 ]] && return + ret=-$E_GSU_EDITOR + result="${EDITOR:-vi}" + "$result" "$conf" + [[ $? -ne 0 ]] && return + ret=$GSU_SUCCESS + return + fi for ((i=0; i < ${#gsu_options[@]}; i++)); do local name= option_type= default_value= required= @@ -195,14 +216,14 @@ com_prefs() echo done } -export -f com_prefs +export -f _com_prefs export gsu_man_txt=" Print the manual. Usage: man" -com_man() +_com_man() { local equal_signs="==================================================" local minus_signs="--------------------------------------------------" @@ -239,7 +260,7 @@ com_man() done ret=$GSU_SUCCESS } -export -f com_man +export -f _com_man export gsu_help_txt=" Print online help. @@ -249,19 +270,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 "--" - 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 \ @@ -276,7 +296,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 @@ -297,14 +317,14 @@ com_help() 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 } -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. @@ -357,7 +377,7 @@ _gsu_check_options() 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 @@ -380,7 +400,6 @@ export -f _gsu_check_options gsu() { local i - _gsu_self="$(basename $0)" gsu_name="${gsu_name:=$_gsu_self}" gsu_config_var_prefix="${gsu_config_var_prefix:=$gsu_name}" @@ -401,16 +420,28 @@ gsu() 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