kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 1 | # $Id$ |
| 2 | # vim:et:ft=sh:sts=2:sw=2 |
| 3 | # |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 4 | # Copyright 2008 Kate Ward. All Rights Reserved. |
kate.ward | 29ddd4e | 2008-06-18 19:05:43 +0000 | [diff] [blame] | 5 | # Released under the LGPL (GNU Lesser General Public License) |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 6 | # |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 7 | # shFlags -- Advanced command-line flag library for Unix shell scripts. |
| 8 | # http://code.google.com/p/shflags/ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 9 | # |
kate.ward | 29ddd4e | 2008-06-18 19:05:43 +0000 | [diff] [blame] | 10 | # Author: kate.ward@forestent.com (Kate Ward) |
| 11 | # |
kate.ward | a895395 | 2008-06-17 16:48:34 +0000 | [diff] [blame] | 12 | # This module implements something like the google-gflags library available |
kate.ward | 29ddd4e | 2008-06-18 19:05:43 +0000 | [diff] [blame] | 13 | # from http://code.google.com/p/google-gflags/. |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 14 | # |
| 15 | # FLAG TYPES: This is a list of the DEFINE_*'s that you can do. All flags take |
| 16 | # a name, default value, help-string, and optional 'short' name (one-letter |
| 17 | # name). Some flags have other arguments, which are described with the flag. |
| 18 | # |
| 19 | # DEFINE_string: takes any input, and intreprets it as a string. |
| 20 | # |
| 21 | # DEFINE_boolean: typically does not take any argument: say --myflag to set |
| 22 | # FLAGS_myflag to true, or --nomyflag to set FLAGS_myflag to false. |
| 23 | # Alternately, you can say |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 24 | # --myflag=true or --myflag=t or --myflag=0 or |
| 25 | # --myflag=false or --myflag=f or --myflag=1 |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 26 | # Passing an option has the same affect as passing the option once. |
| 27 | # |
| 28 | # DEFINE_float: takes an input and intreprets it as a floating point number. As |
| 29 | # shell does not support floats per-se, the input is merely validated as |
| 30 | # being a valid floating point value. |
| 31 | # |
| 32 | # DEFINE_integer: takes an input and intreprets it as an integer. |
| 33 | # |
| 34 | # SPECIAL FLAGS: There are a few flags that have special meaning: |
| 35 | # --help (or -?) prints a list of all the flags in a human-readable fashion |
kate.ward | 39913d1 | 2009-04-01 14:09:23 +0000 | [diff] [blame] | 36 | # --flagfile=foo read flags from foo. (not implemented yet) |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 37 | # -- as in getopt(), terminates flag-processing |
| 38 | # |
| 39 | # EXAMPLE USAGE: |
| 40 | # |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 41 | # -- begin hello.sh -- |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 42 | # #! /bin/sh |
| 43 | # . ./shflags |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 44 | # DEFINE_string name 'world' "somebody's name" n |
| 45 | # FLAGS "$@" || exit $? |
| 46 | # eval set -- "${FLAGS_ARGV}" |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 47 | # echo "Hello, ${FLAGS_name}." |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 48 | # -- end hello.sh -- |
| 49 | # |
| 50 | # $ ./hello.sh -n Kate |
| 51 | # Hello, Kate. |
kate.ward | 29ddd4e | 2008-06-18 19:05:43 +0000 | [diff] [blame] | 52 | # |
| 53 | # NOTE: Not all systems include a getopt version that supports long flags. On |
| 54 | # these systems, only short flags are recognized. |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 55 | |
| 56 | #============================================================================== |
kate.ward | a895395 | 2008-06-17 16:48:34 +0000 | [diff] [blame] | 57 | # shFlags |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 58 | # |
| 59 | # Shared attributes: |
| 60 | # flags_error: last error message |
| 61 | # flags_return: last return value |
| 62 | # |
| 63 | # __flags_longNames: list of long names for all flags |
| 64 | # __flags_shortNames: list of short names for all flags |
| 65 | # __flags_boolNames: list of boolean flag names |
| 66 | # |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 67 | # __flags_opts: options parsed by getopt |
| 68 | # |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 69 | # Per-flag attributes: |
| 70 | # FLAGS_<flag_name>: contains value of flag named 'flag_name' |
| 71 | # __flags_<flag_name>_default: the default flag value |
| 72 | # __flags_<flag_name>_help: the flag help string |
| 73 | # __flags_<flag_name>_short: the flag short name |
| 74 | # __flags_<flag_name>_type: the flag type |
| 75 | # |
| 76 | # Notes: |
| 77 | # - lists of strings are space separated, and a null value is the '~' char. |
| 78 | |
| 79 | # return if FLAGS already loaded |
kate.ward | d3d3d08 | 2008-07-10 20:00:42 +0000 | [diff] [blame] | 80 | [ -n "${FLAGS_VERSION:-}" ] && return 0 |
kate.ward | 9a183b8 | 2010-03-18 00:25:34 +0000 | [diff] [blame] | 81 | FLAGS_VERSION='1.0.4pre' |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 82 | |
kate.ward | 39913d1 | 2009-04-01 14:09:23 +0000 | [diff] [blame] | 83 | # return values |
kate.ward | d2258ed | 2008-11-12 23:21:48 +0000 | [diff] [blame] | 84 | FLAGS_TRUE=0 |
| 85 | FLAGS_FALSE=1 |
| 86 | FLAGS_ERROR=2 |
| 87 | |
kate.ward | 39913d1 | 2009-04-01 14:09:23 +0000 | [diff] [blame] | 88 | # reserved flag names |
kate.ward | 929261f | 2010-03-28 23:12:17 +0000 | [diff] [blame^] | 89 | FLAGS_RESERVED_LIST=' ARGC ARGV ERROR FALSE HELP PARENT RESERVED TRUE VERSION ' |
kate.ward | 39913d1 | 2009-04-01 14:09:23 +0000 | [diff] [blame] | 90 | |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 91 | _flags_debug() { echo "flags:DEBUG $@" >&2; } |
kate.ward | b7fa8d6 | 2008-08-28 21:18:21 +0000 | [diff] [blame] | 92 | _flags_warn() { echo "flags:WARN $@" >&2; } |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 93 | _flags_error() { echo "flags:ERROR $@" >&2; } |
| 94 | _flags_fatal() { echo "flags:FATAL $@" >&2; } |
| 95 | |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 96 | # specific shell checks |
| 97 | if [ -n "${ZSH_VERSION:-}" ]; then |
kate.ward | 1d0ecc4 | 2008-07-11 15:33:23 +0000 | [diff] [blame] | 98 | setopt |grep "^shwordsplit$" >/dev/null |
| 99 | if [ $? -ne ${FLAGS_TRUE} ]; then |
| 100 | _flags_fatal 'zsh shwordsplit option is required for proper zsh operation' |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 101 | exit ${FLAGS_ERROR} |
| 102 | fi |
| 103 | if [ -z "${FLAGS_PARENT:-}" ]; then |
| 104 | _flags_fatal "zsh does not pass \$0 through properly. please declare' \ |
kate.ward | a895395 | 2008-06-17 16:48:34 +0000 | [diff] [blame] | 105 | \"FLAGS_PARENT=\$0\" before calling shFlags" |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 106 | exit ${FLAGS_ERROR} |
| 107 | fi |
| 108 | fi |
| 109 | |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 110 | # |
| 111 | # constants |
| 112 | # |
| 113 | |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 114 | # getopt version |
| 115 | __FLAGS_GETOPT_VERS_STD=0 |
| 116 | __FLAGS_GETOPT_VERS_ENH=1 |
| 117 | __FLAGS_GETOPT_VERS_BSD=2 |
| 118 | |
| 119 | getopt >/dev/null 2>&1 |
| 120 | case $? in |
| 121 | 0) __FLAGS_GETOPT_VERS=${__FLAGS_GETOPT_VERS_STD} ;; # bsd getopt |
| 122 | 2) |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 123 | # TODO(kward): look into '-T' option to test the internal getopt() version |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 124 | if [ "`getopt --version`" = '-- ' ]; then |
| 125 | __FLAGS_GETOPT_VERS=${__FLAGS_GETOPT_VERS_STD} |
| 126 | else |
| 127 | __FLAGS_GETOPT_VERS=${__FLAGS_GETOPT_VERS_ENH} |
| 128 | fi |
| 129 | ;; |
| 130 | *) |
| 131 | _flags_fatal 'unable to determine getopt version' |
| 132 | exit ${FLAGS_ERROR} |
| 133 | ;; |
| 134 | esac |
| 135 | |
| 136 | # getopt optstring lengths |
| 137 | __FLAGS_OPTSTR_SHORT=0 |
| 138 | __FLAGS_OPTSTR_LONG=1 |
| 139 | |
| 140 | __FLAGS_NULL='~' |
| 141 | |
| 142 | # flag info strings |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 143 | __FLAGS_INFO_DEFAULT='default' |
| 144 | __FLAGS_INFO_HELP='help' |
| 145 | __FLAGS_INFO_SHORT='short' |
| 146 | __FLAGS_INFO_TYPE='type' |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 147 | |
| 148 | # flag lengths |
| 149 | __FLAGS_LEN_SHORT=0 |
| 150 | __FLAGS_LEN_LONG=1 |
| 151 | |
| 152 | # flag types |
| 153 | __FLAGS_TYPE_NONE=0 |
| 154 | __FLAGS_TYPE_BOOLEAN=1 |
| 155 | __FLAGS_TYPE_FLOAT=2 |
| 156 | __FLAGS_TYPE_INTEGER=3 |
| 157 | __FLAGS_TYPE_STRING=4 |
| 158 | |
| 159 | # set the constants readonly |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 160 | __flags_constants=`set |awk -F= '/^FLAGS_/ || /^__FLAGS_/ {print $1}'` |
| 161 | for __flags_const in ${__flags_constants}; do |
| 162 | # skip certain flags |
| 163 | case ${__flags_const} in |
kate.ward | 39913d1 | 2009-04-01 14:09:23 +0000 | [diff] [blame] | 164 | FLAGS_HELP) continue ;; |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 165 | FLAGS_PARENT) continue ;; |
| 166 | esac |
| 167 | # set flag readonly |
| 168 | if [ -z "${ZSH_VERSION:-}" ]; then |
| 169 | readonly ${__flags_const} |
| 170 | else # handle zsh |
kate.ward | 1d0ecc4 | 2008-07-11 15:33:23 +0000 | [diff] [blame] | 171 | case ${ZSH_VERSION} in |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 172 | [123].*) readonly ${__flags_const} ;; |
| 173 | *) readonly -g ${__flags_const} ;; # declare readonly constants globally |
kate.ward | 1d0ecc4 | 2008-07-11 15:33:23 +0000 | [diff] [blame] | 174 | esac |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 175 | fi |
| 176 | done |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 177 | unset __flags_const __flags_constants |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 178 | |
| 179 | # |
| 180 | # internal variables |
| 181 | # |
| 182 | |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 183 | __flags_boolNames=' ' # space separated list of boolean flag names |
| 184 | __flags_longNames=' ' # space separated list of long flag names |
| 185 | __flags_shortNames=' ' # space separated list of short flag names |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 186 | |
kate.ward | 14b33bf | 2008-11-15 20:03:18 +0000 | [diff] [blame] | 187 | __flags_columns='' # screen width in columns |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 188 | __flags_opts='' # temporary storage for parsed getopt flags |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 189 | |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 190 | #------------------------------------------------------------------------------ |
| 191 | # private functions |
| 192 | # |
| 193 | |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 194 | # Define a flag. |
| 195 | # |
| 196 | # Calling this function will define the following info variables for the |
| 197 | # specified flag: |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 198 | # FLAGS_flagname - the name for this flag (based upon the long flag name) |
| 199 | # __flags_<flag_name>_default - the default value |
| 200 | # __flags_flagname_help - the help string |
| 201 | # __flags_flagname_short - the single letter alias |
| 202 | # __flags_flagname_type - the type of flag (one of __FLAGS_TYPE_*) |
| 203 | # |
| 204 | # Args: |
| 205 | # _flags__type: integer: internal type of flag (__FLAGS_TYPE_*) |
| 206 | # _flags__name: string: long flag name |
| 207 | # _flags__default: default flag value |
| 208 | # _flags__help: string: help string |
| 209 | # _flags__short: string: (optional) short flag name |
| 210 | # Returns: |
| 211 | # integer: success of operation, or error |
| 212 | _flags_define() |
| 213 | { |
| 214 | if [ $# -lt 4 ]; then |
| 215 | flags_error='DEFINE error: too few arguments' |
| 216 | flags_return=${FLAGS_ERROR} |
| 217 | _flags_error "${flags_error}" |
| 218 | return ${flags_return} |
| 219 | fi |
| 220 | |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 221 | _flags_type_=$1 |
| 222 | _flags_name_=$2 |
| 223 | _flags_default_=$3 |
| 224 | _flags_help_=$4 |
| 225 | _flags_short_=${5:-${__FLAGS_NULL}} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 226 | |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 227 | _flags_return_=${FLAGS_TRUE} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 228 | |
| 229 | # TODO(kward): check for validity of the flag name (e.g. dashes) |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 230 | |
kate.ward | 39913d1 | 2009-04-01 14:09:23 +0000 | [diff] [blame] | 231 | # check whether the flag name is reserved |
kate.ward | 929261f | 2010-03-28 23:12:17 +0000 | [diff] [blame^] | 232 | _flags_itemInList ${_flags_name_} "${FLAGS_RESERVED_LIST}" |
| 233 | if [ $? -eq ${FLAGS_TRUE} ]; then |
kate.ward | 39913d1 | 2009-04-01 14:09:23 +0000 | [diff] [blame] | 234 | flags_error="flag name (${_flags_name_}) is reserved" |
| 235 | _flags_return_=${FLAGS_ERROR} |
| 236 | fi |
| 237 | |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 238 | # require short option for getopt that don't support long options |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 239 | if [ ${_flags_return_} -eq ${FLAGS_TRUE} \ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 240 | -a ${__FLAGS_GETOPT_VERS} -ne ${__FLAGS_GETOPT_VERS_ENH} \ |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 241 | -a "${_flags_short_}" = "${__FLAGS_NULL}" ] |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 242 | then |
kate.ward | 5b48fc1 | 2008-11-13 00:42:43 +0000 | [diff] [blame] | 243 | flags_error="short flag required for (${_flags_name_}) on this platform" |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 244 | _flags_return_=${FLAGS_ERROR} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 245 | fi |
| 246 | |
| 247 | # check for existing long name definition |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 248 | if [ ${_flags_return_} -eq ${FLAGS_TRUE} ]; then |
| 249 | if _flags_itemInList "${_flags_name_}" \ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 250 | ${__flags_longNames} ${__flags_boolNames} |
| 251 | then |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 252 | flags_error="flag name ([no]${_flags_name_}) already defined" |
kate.ward | 20d0678 | 2008-10-21 19:57:19 +0000 | [diff] [blame] | 253 | _flags_warn "${flags_error}" |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 254 | _flags_return_=${FLAGS_FALSE} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 255 | fi |
| 256 | fi |
| 257 | |
| 258 | # check for existing short name definition |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 259 | if [ ${_flags_return_} -eq ${FLAGS_TRUE} \ |
| 260 | -a "${_flags_short_}" != "${__FLAGS_NULL}" ] |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 261 | then |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 262 | if _flags_itemInList "${_flags_short_}" ${__flags_shortNames}; then |
| 263 | flags_error="flag short name (${_flags_short_}) already defined" |
kate.ward | 20d0678 | 2008-10-21 19:57:19 +0000 | [diff] [blame] | 264 | _flags_warn "${flags_error}" |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 265 | _flags_return_=${FLAGS_FALSE} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 266 | fi |
| 267 | fi |
| 268 | |
| 269 | # handle default value. note, on several occasions the 'if' portion of an |
| 270 | # if/then/else contains just a ':' which does nothing. a binary reversal via |
| 271 | # '!' is not done because it does not work on all shells. |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 272 | if [ ${_flags_return_} -eq ${FLAGS_TRUE} ]; then |
| 273 | case ${_flags_type_} in |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 274 | ${__FLAGS_TYPE_BOOLEAN}) |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 275 | if _flags_validateBoolean "${_flags_default_}"; then |
| 276 | case ${_flags_default_} in |
| 277 | true|t|0) _flags_default_=${FLAGS_TRUE} ;; |
| 278 | false|f|1) _flags_default_=${FLAGS_FALSE} ;; |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 279 | esac |
| 280 | else |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 281 | flags_error="invalid default flag value '${_flags_default_}'" |
| 282 | _flags_return_=${FLAGS_ERROR} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 283 | fi |
| 284 | ;; |
| 285 | |
| 286 | ${__FLAGS_TYPE_FLOAT}) |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 287 | if _flags_validateFloat "${_flags_default_}"; then |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 288 | : |
| 289 | else |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 290 | flags_error="invalid default flag value '${_flags_default_}'" |
| 291 | _flags_return_=${FLAGS_ERROR} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 292 | fi |
| 293 | ;; |
| 294 | |
| 295 | ${__FLAGS_TYPE_INTEGER}) |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 296 | if _flags_validateInteger "${_flags_default_}"; then |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 297 | : |
| 298 | else |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 299 | flags_error="invalid default flag value '${_flags_default_}'" |
| 300 | _flags_return_=${FLAGS_ERROR} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 301 | fi |
| 302 | ;; |
| 303 | |
| 304 | ${__FLAGS_TYPE_STRING}) ;; # everything in shell is a valid string |
| 305 | |
| 306 | *) |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 307 | flags_error="unrecognized flag type '${_flags_type_}'" |
| 308 | _flags_return_=${FLAGS_ERROR} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 309 | ;; |
| 310 | esac |
| 311 | fi |
| 312 | |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 313 | if [ ${_flags_return_} -eq ${FLAGS_TRUE} ]; then |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 314 | # store flag information |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 315 | eval "FLAGS_${_flags_name_}='${_flags_default_}'" |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 316 | eval "__flags_${_flags_name_}_${__FLAGS_INFO_TYPE}=${_flags_type_}" |
| 317 | eval "__flags_${_flags_name_}_${__FLAGS_INFO_DEFAULT}=\ |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 318 | \"${_flags_default_}\"" |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 319 | eval "__flags_${_flags_name_}_${__FLAGS_INFO_HELP}=\"${_flags_help_}\"" |
| 320 | eval "__flags_${_flags_name_}_${__FLAGS_INFO_SHORT}='${_flags_short_}'" |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 321 | |
| 322 | # append flag name(s) to list of names |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 323 | __flags_longNames="${__flags_longNames}${_flags_name_} " |
| 324 | __flags_shortNames="${__flags_shortNames}${_flags_short_} " |
| 325 | [ ${_flags_type_} -eq ${__FLAGS_TYPE_BOOLEAN} ] && \ |
| 326 | __flags_boolNames="${__flags_boolNames}no${_flags_name_} " |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 327 | fi |
| 328 | |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 329 | flags_return=${_flags_return_} |
| 330 | unset _flags_default_ _flags_help_ _flags_name_ _flags_return_ _flags_short_ \ |
| 331 | _flags_type_ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 332 | [ ${flags_return} -eq ${FLAGS_ERROR} ] && _flags_error "${flags_error}" |
| 333 | return ${flags_return} |
| 334 | } |
| 335 | |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 336 | # Return valid getopt options using currently defined list of long options. |
| 337 | # |
| 338 | # This function builds a proper getopt option string for short (and long) |
| 339 | # options, using the current list of long options for reference. |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 340 | # |
| 341 | # Args: |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 342 | # _flags_optStr: integer: option string type (__FLAGS_OPTSTR_*) |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 343 | # Output: |
| 344 | # string: generated option string for getopt |
| 345 | # Returns: |
| 346 | # boolean: success of operation (always returns True) |
| 347 | _flags_genOptStr() |
| 348 | { |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 349 | _flags_optStrType_=$1 |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 350 | |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 351 | _flags_opts_='' |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 352 | |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 353 | for _flags_flag_ in ${__flags_longNames}; do |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 354 | _flags_type_=`_flags_getFlagInfo ${_flags_flag_} ${__FLAGS_INFO_TYPE}` |
kate.ward | 929261f | 2010-03-28 23:12:17 +0000 | [diff] [blame^] | 355 | [ $? -eq ${FLAGS_TRUE} ] || \ |
| 356 | ( _flags_fatal 'call to _flags_type_ failed'; return ${FLAGS_ERROR} ) |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 357 | case ${_flags_optStrType_} in |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 358 | ${__FLAGS_OPTSTR_SHORT}) |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 359 | _flags_shortName_=`_flags_getFlagInfo \ |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 360 | ${_flags_flag_} ${__FLAGS_INFO_SHORT}` |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 361 | if [ "${_flags_shortName_}" != "${__FLAGS_NULL}" ]; then |
| 362 | _flags_opts_="${_flags_opts_}${_flags_shortName_}" |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 363 | # getopt needs a trailing ':' to indicate a required argument |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 364 | [ ${_flags_type_} -ne ${__FLAGS_TYPE_BOOLEAN} ] && \ |
| 365 | _flags_opts_="${_flags_opts_}:" |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 366 | fi |
| 367 | ;; |
| 368 | |
| 369 | ${__FLAGS_OPTSTR_LONG}) |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 370 | _flags_opts_="${_flags_opts_:+${_flags_opts_},}${_flags_flag_}" |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 371 | # getopt needs a trailing ':' to indicate a required argument |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 372 | [ ${_flags_type_} -ne ${__FLAGS_TYPE_BOOLEAN} ] && \ |
| 373 | _flags_opts_="${_flags_opts_}:" |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 374 | ;; |
| 375 | esac |
| 376 | done |
| 377 | |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 378 | echo "${_flags_opts_}" |
| 379 | unset _flags_flag_ _flags_opts_ _flags_optStrType_ _flags_shortName_ \ |
| 380 | _flags_type_ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 381 | return ${FLAGS_TRUE} |
| 382 | } |
| 383 | |
| 384 | # Returns flag details based on a flag name and flag info. |
| 385 | # |
| 386 | # Args: |
| 387 | # string: long flag name |
| 388 | # string: flag info (see the _flags_define function for valid info types) |
| 389 | # Output: |
| 390 | # string: value of dereferenced flag variable |
| 391 | # Returns: |
| 392 | # integer: one of FLAGS_{TRUE|FALSE|ERROR} |
| 393 | _flags_getFlagInfo() |
| 394 | { |
kate.ward | 1b600c5 | 2008-11-12 21:26:05 +0000 | [diff] [blame] | 395 | _flags_name_=$1 |
| 396 | _flags_info_=$2 |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 397 | |
kate.ward | 1b600c5 | 2008-11-12 21:26:05 +0000 | [diff] [blame] | 398 | _flags_nameVar_="__flags_${_flags_name_}_${_flags_info_}" |
kate.ward | 929261f | 2010-03-28 23:12:17 +0000 | [diff] [blame^] | 399 | _flags_strToEval_="_flags_nameValue_=\"\${${_flags_nameVar_}:-}\"" |
kate.ward | 1b600c5 | 2008-11-12 21:26:05 +0000 | [diff] [blame] | 400 | eval "${_flags_strToEval_}" |
kate.ward | 929261f | 2010-03-28 23:12:17 +0000 | [diff] [blame^] | 401 | if [ -n "${_flags_nameValue_}" ]; then |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 402 | flags_return=${FLAGS_TRUE} |
| 403 | else |
kate.ward | 1b600c5 | 2008-11-12 21:26:05 +0000 | [diff] [blame] | 404 | # see if the _flags_name_ variable is a string as strings can be empty... |
| 405 | # note: the DRY principle would say to have this function call itself for |
| 406 | # the next three lines, but doing so results in an infinite loop as an |
| 407 | # invalid _flags_name_ will also not have the associated _type variable. |
| 408 | # Because it doesn't (it will evaluate to an empty string) the logic will |
| 409 | # try to find the _type variable of the _type variable, and so on. Not so |
| 410 | # good ;-) |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 411 | _flags_typeVar_="__flags_${_flags_name_}_${__FLAGS_INFO_TYPE}" |
kate.ward | 929261f | 2010-03-28 23:12:17 +0000 | [diff] [blame^] | 412 | _flags_strToEval_="_flags_typeValue_=\"\${${_flags_typeVar_}:-}\"" |
kate.ward | 1b600c5 | 2008-11-12 21:26:05 +0000 | [diff] [blame] | 413 | eval "${_flags_strToEval_}" |
kate.ward | 929261f | 2010-03-28 23:12:17 +0000 | [diff] [blame^] | 414 | if [ "${_flags_typeValue_}" = "${__FLAGS_TYPE_STRING}" ]; then |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 415 | flags_return=${FLAGS_TRUE} |
| 416 | else |
| 417 | flags_return=${FLAGS_ERROR} |
kate.ward | 1b600c5 | 2008-11-12 21:26:05 +0000 | [diff] [blame] | 418 | flags_error="invalid flag name (${_flags_nameVar_})" |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 419 | fi |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 420 | fi |
| 421 | |
kate.ward | 929261f | 2010-03-28 23:12:17 +0000 | [diff] [blame^] | 422 | echo "${_flags_nameValue_}" |
| 423 | unset _flags_info_ _flags_name_ _flags_nameValue_ _flags_nameVar_ \ |
| 424 | _flags_strToEval_ _flags_typeValue_ _flags_typeVar_ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 425 | [ ${flags_return} -eq ${FLAGS_ERROR} ] && _flags_error "${flags_error}" |
| 426 | return ${flags_return} |
| 427 | } |
| 428 | |
| 429 | # check for presense of item in a list. passed a string (e.g. 'abc'), this |
| 430 | # function will determine if the string is present in the list of strings (e.g. |
| 431 | # ' foo bar abc '). |
| 432 | # |
| 433 | # Args: |
| 434 | # _flags__str: string: string to search for in a list of strings |
| 435 | # unnamed: list: list of strings |
| 436 | # Returns: |
| 437 | # boolean: true if item is in the list |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 438 | _flags_itemInList() |
| 439 | { |
| 440 | _flags_str_=$1 |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 441 | shift |
| 442 | |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 443 | echo " ${*:-} " |grep " ${_flags_str_} " >/dev/null |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 444 | if [ $? -eq 0 ]; then |
| 445 | flags_return=${FLAGS_TRUE} |
| 446 | else |
| 447 | flags_return=${FLAGS_FALSE} |
| 448 | fi |
| 449 | |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 450 | unset _flags_str_ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 451 | return ${flags_return} |
| 452 | } |
| 453 | |
kate.ward | dadc164 | 2008-11-14 02:00:29 +0000 | [diff] [blame] | 454 | # Returns the width of the current screen. |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 455 | # |
kate.ward | 18d456e | 2008-11-14 00:46:44 +0000 | [diff] [blame] | 456 | # Output: |
kate.ward | dadc164 | 2008-11-14 02:00:29 +0000 | [diff] [blame] | 457 | # integer: width in columns of the current screen. |
kate.ward | 14b33bf | 2008-11-15 20:03:18 +0000 | [diff] [blame] | 458 | _flags_columns() |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 459 | { |
kate.ward | 14b33bf | 2008-11-15 20:03:18 +0000 | [diff] [blame] | 460 | if [ -z "${__flags_columns}" ]; then |
| 461 | # determine the value and store it |
| 462 | if eval stty size >/dev/null 2>&1; then |
| 463 | # stty size worked :-) |
| 464 | set -- `stty size` |
| 465 | __flags_columns=$2 |
| 466 | elif eval tput cols >/dev/null 2>&1; then |
| 467 | set -- `tput cols` |
| 468 | __flags_columns=$1 |
| 469 | else |
| 470 | __flags_columns=80 # default terminal width |
| 471 | fi |
kate.ward | dadc164 | 2008-11-14 02:00:29 +0000 | [diff] [blame] | 472 | fi |
kate.ward | 14b33bf | 2008-11-15 20:03:18 +0000 | [diff] [blame] | 473 | echo ${__flags_columns} |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 474 | } |
| 475 | |
| 476 | # Validate a boolean. |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 477 | # |
| 478 | # Args: |
| 479 | # _flags__bool: boolean: value to validate |
| 480 | # Returns: |
| 481 | # bool: true if the value is a valid boolean |
| 482 | _flags_validateBoolean() |
| 483 | { |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 484 | _flags_bool_=$1 |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 485 | |
| 486 | flags_return=${FLAGS_TRUE} |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 487 | case "${_flags_bool_}" in |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 488 | true|t|0) ;; |
| 489 | false|f|1) ;; |
| 490 | *) flags_return=${FLAGS_FALSE} ;; |
| 491 | esac |
| 492 | |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 493 | unset _flags_bool_ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 494 | return ${flags_return} |
| 495 | } |
| 496 | |
kate.ward | 18d456e | 2008-11-14 00:46:44 +0000 | [diff] [blame] | 497 | # Validate a float. |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 498 | # |
| 499 | # Args: |
| 500 | # _flags__float: float: value to validate |
| 501 | # Returns: |
| 502 | # bool: true if the value is a valid float |
| 503 | _flags_validateFloat() |
| 504 | { |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 505 | _flags_float_=$1 |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 506 | |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 507 | if _flags_validateInteger ${_flags_float_}; then |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 508 | flags_return=${FLAGS_TRUE} |
| 509 | else |
| 510 | flags_return=${FLAGS_TRUE} |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 511 | case ${_flags_float_} in |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 512 | -*) # negative floats |
kate.ward | 9a183b8 | 2010-03-18 00:25:34 +0000 | [diff] [blame] | 513 | _flags_test_=`expr -- "${_flags_float_}" :\ |
| 514 | '\(-[0-9][0-9]*\.[0-9][0-9]*\)'` |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 515 | ;; |
| 516 | *) # positive floats |
kate.ward | 9a183b8 | 2010-03-18 00:25:34 +0000 | [diff] [blame] | 517 | _flags_test_=`expr -- "${_flags_float_}" :\ |
| 518 | '\([0-9][0-9]*\.[0-9][0-9]*\)'` |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 519 | ;; |
| 520 | esac |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 521 | [ "${_flags_test_}" != "${_flags_float_}" ] && flags_return=${FLAGS_FALSE} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 522 | fi |
| 523 | |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 524 | unset _flags_float_ _flags_test_ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 525 | return ${flags_return} |
| 526 | } |
| 527 | |
kate.ward | 18d456e | 2008-11-14 00:46:44 +0000 | [diff] [blame] | 528 | # Validate an integer. |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 529 | # |
| 530 | # Args: |
| 531 | # _flags__integer: interger: value to validate |
| 532 | # Returns: |
| 533 | # bool: true if the value is a valid integer |
| 534 | _flags_validateInteger() |
| 535 | { |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 536 | _flags_int_=$1 |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 537 | |
| 538 | flags_return=${FLAGS_TRUE} |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 539 | case ${_flags_int_} in |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 540 | -*) # negative ints |
kate.ward | 9a183b8 | 2010-03-18 00:25:34 +0000 | [diff] [blame] | 541 | _flags_test_=`expr -- "${_flags_int_}" : '\(-[0-9][0-9]*\)'` |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 542 | ;; |
| 543 | *) # positive ints |
kate.ward | 9a183b8 | 2010-03-18 00:25:34 +0000 | [diff] [blame] | 544 | _flags_test_=`expr -- "${_flags_int_}" : '\([0-9][0-9]*\)'` |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 545 | ;; |
| 546 | esac |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 547 | [ "${_flags_test_}" != "${_flags_int_}" ] && flags_return=${FLAGS_FALSE} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 548 | |
kate.ward | cc14568 | 2008-11-14 00:32:42 +0000 | [diff] [blame] | 549 | unset _flags_int_ _flags_test_ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 550 | return ${flags_return} |
| 551 | } |
| 552 | |
kate.ward | 18d456e | 2008-11-14 00:46:44 +0000 | [diff] [blame] | 553 | # Parse command-line options using the standard getopt. |
| 554 | # |
| 555 | # Note: the flag options are passed around in the global __flags_opts so that |
| 556 | # the formatting is not lost due to shell parsing and such. |
| 557 | # |
| 558 | # Args: |
| 559 | # @: varies: command-line options to parse |
| 560 | # Returns: |
| 561 | # integer: a FLAGS success condition |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 562 | _flags_getoptStandard() |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 563 | { |
| 564 | flags_return=${FLAGS_TRUE} |
| 565 | _flags_shortOpts_=`_flags_genOptStr ${__FLAGS_OPTSTR_SHORT}` |
| 566 | |
| 567 | # check for spaces in passed options |
| 568 | for _flags_opt_ in "$@"; do |
kate.ward | 14b33bf | 2008-11-15 20:03:18 +0000 | [diff] [blame] | 569 | # note: the silliness with the x's is purely for ksh93 on Ubuntu 6.06 |
| 570 | _flags_match_=`echo "x${_flags_opt_}x" |sed 's/ //g'` |
| 571 | if [ "${_flags_match_}" != "x${_flags_opt_}x" ]; then |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 572 | flags_error='the available getopt does not support spaces in options' |
| 573 | flags_return=${FLAGS_ERROR} |
| 574 | break |
| 575 | fi |
| 576 | done |
| 577 | |
| 578 | if [ ${flags_return} -eq ${FLAGS_TRUE} ]; then |
| 579 | __flags_opts=`getopt ${_flags_shortOpts_} $@ 2>&1` |
kate.ward | 7a3c9c4 | 2009-04-24 00:12:35 +0000 | [diff] [blame] | 580 | _flags_rtrn_=$? |
| 581 | if [ ${_flags_rtrn_} -ne ${FLAGS_TRUE} ]; then |
| 582 | _flags_warn "${__flags_opts}" |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 583 | flags_error='unable to parse provided options with getopt.' |
| 584 | flags_return=${FLAGS_ERROR} |
| 585 | fi |
| 586 | fi |
| 587 | |
kate.ward | 7a3c9c4 | 2009-04-24 00:12:35 +0000 | [diff] [blame] | 588 | unset _flags_match_ _flags_opt_ _flags_rtrn_ _flags_shortOpts_ |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 589 | return ${flags_return} |
| 590 | } |
| 591 | |
kate.ward | 18d456e | 2008-11-14 00:46:44 +0000 | [diff] [blame] | 592 | # Parse command-line options using the enhanced getopt. |
| 593 | # |
| 594 | # Note: the flag options are passed around in the global __flags_opts so that |
| 595 | # the formatting is not lost due to shell parsing and such. |
| 596 | # |
| 597 | # Args: |
| 598 | # @: varies: command-line options to parse |
| 599 | # Returns: |
| 600 | # integer: a FLAGS success condition |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 601 | _flags_getoptEnhanced() |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 602 | { |
| 603 | flags_return=${FLAGS_TRUE} |
| 604 | _flags_shortOpts_=`_flags_genOptStr ${__FLAGS_OPTSTR_SHORT}` |
| 605 | _flags_boolOpts_=`echo "${__flags_boolNames}" \ |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 606 | |sed 's/^ *//;s/ *$//;s/ /,/g'` |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 607 | _flags_longOpts_=`_flags_genOptStr ${__FLAGS_OPTSTR_LONG}` |
| 608 | |
| 609 | __flags_opts=`getopt \ |
| 610 | -o ${_flags_shortOpts_} \ |
| 611 | -l "${_flags_longOpts_},${_flags_boolOpts_}" \ |
| 612 | -- "$@" 2>&1` |
kate.ward | 7a3c9c4 | 2009-04-24 00:12:35 +0000 | [diff] [blame] | 613 | _flags_rtrn_=$? |
| 614 | if [ ${_flags_rtrn_} -ne ${FLAGS_TRUE} ]; then |
| 615 | _flags_warn "${__flags_opts}" |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 616 | flags_error='unable to parse provided options with getopt.' |
| 617 | flags_return=${FLAGS_ERROR} |
| 618 | fi |
| 619 | |
kate.ward | 7a3c9c4 | 2009-04-24 00:12:35 +0000 | [diff] [blame] | 620 | unset _flags_boolOpts_ _flags_longOpts_ _flags_rtrn_ _flags_shortOpts_ |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 621 | return ${flags_return} |
| 622 | } |
| 623 | |
kate.ward | 18d456e | 2008-11-14 00:46:44 +0000 | [diff] [blame] | 624 | # Dynamically parse a getopt result and set appropriate variables. |
| 625 | # |
| 626 | # This function does the actual conversion of getopt output and runs it through |
| 627 | # the standard case structure for parsing. The case structure is actually quite |
| 628 | # dynamic to support any number of flags. |
| 629 | # |
| 630 | # Args: |
kate.ward | 9ccba51 | 2009-04-01 13:31:18 +0000 | [diff] [blame] | 631 | # argc: int: original command-line argument count |
kate.ward | 18d456e | 2008-11-14 00:46:44 +0000 | [diff] [blame] | 632 | # @: varies: output from getopt parsing |
| 633 | # Returns: |
| 634 | # integer: a FLAGS success condition |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 635 | _flags_parseGetopt() |
| 636 | { |
kate.ward | 9ccba51 | 2009-04-01 13:31:18 +0000 | [diff] [blame] | 637 | _flags_argc_=$1 |
| 638 | shift |
| 639 | |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 640 | flags_return=${FLAGS_TRUE} |
| 641 | |
| 642 | if [ ${__FLAGS_GETOPT_VERS} -ne ${__FLAGS_GETOPT_VERS_ENH} ]; then |
| 643 | set -- $@ |
| 644 | else |
| 645 | # note the quotes around the `$@' -- they are essential! |
| 646 | eval set -- "$@" |
| 647 | fi |
| 648 | |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 649 | # provide user with number of arguments to shift by later |
| 650 | # NOTE: the FLAGS_ARGC variable is obsolete as of 1.0.3 because it does not |
| 651 | # properly give user access to non-flag arguments mixed in between flag |
| 652 | # arguments. Its usage was replaced by FLAGS_ARGV, and it is being kept only |
| 653 | # for backwards compatibility reasons. |
kate.ward | 9ccba51 | 2009-04-01 13:31:18 +0000 | [diff] [blame] | 654 | FLAGS_ARGC=`expr $# - 1 - ${_flags_argc_}` |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 655 | |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 656 | # handle options. note options with values must do an additional shift |
| 657 | while true; do |
| 658 | _flags_opt_=$1 |
| 659 | _flags_arg_=${2:-} |
| 660 | _flags_type_=${__FLAGS_TYPE_NONE} |
kate.ward | 7a3c9c4 | 2009-04-24 00:12:35 +0000 | [diff] [blame] | 661 | _flags_name_='' |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 662 | |
| 663 | # determine long flag name |
| 664 | case "${_flags_opt_}" in |
| 665 | --) shift; break ;; # discontinue option parsing |
| 666 | |
| 667 | --*) # long option |
kate.ward | 9a183b8 | 2010-03-18 00:25:34 +0000 | [diff] [blame] | 668 | _flags_opt_=`expr -- "${_flags_opt_}" : '--\(.*\)'` |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 669 | _flags_len_=${__FLAGS_LEN_LONG} |
| 670 | if _flags_itemInList "${_flags_opt_}" ${__flags_longNames}; then |
| 671 | _flags_name_=${_flags_opt_} |
| 672 | else |
| 673 | # check for negated long boolean version |
| 674 | if _flags_itemInList "${_flags_opt_}" ${__flags_boolNames}; then |
kate.ward | 9a183b8 | 2010-03-18 00:25:34 +0000 | [diff] [blame] | 675 | _flags_name_=`expr -- "${_flags_opt_}" : 'no\(.*\)'` |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 676 | _flags_type_=${__FLAGS_TYPE_BOOLEAN} |
| 677 | _flags_arg_=${__FLAGS_NULL} |
| 678 | fi |
| 679 | fi |
| 680 | ;; |
| 681 | |
| 682 | -*) # short option |
kate.ward | 9a183b8 | 2010-03-18 00:25:34 +0000 | [diff] [blame] | 683 | _flags_opt_=`expr -- "${_flags_opt_}" : '-\(.*\)'` |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 684 | _flags_len_=${__FLAGS_LEN_SHORT} |
| 685 | if _flags_itemInList "${_flags_opt_}" ${__flags_shortNames}; then |
| 686 | # yes. match short name to long name. note purposeful off-by-one |
| 687 | # (too high) with awk calculations. |
| 688 | _flags_pos_=`echo "${__flags_shortNames}" \ |
| 689 | |awk 'BEGIN{RS=" ";rn=0}$0==e{rn=NR}END{print rn}' \ |
| 690 | e=${_flags_opt_}` |
| 691 | _flags_name_=`echo "${__flags_longNames}" \ |
| 692 | |awk 'BEGIN{RS=" "}rn==NR{print $0}' rn="${_flags_pos_}"` |
| 693 | fi |
| 694 | ;; |
| 695 | esac |
| 696 | |
| 697 | # die if the flag was unrecognized |
| 698 | if [ -z "${_flags_name_}" ]; then |
| 699 | flags_error="unrecognized option (${_flags_opt_})" |
| 700 | flags_return=${FLAGS_ERROR} |
| 701 | break |
| 702 | fi |
| 703 | |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 704 | # set new flag value |
| 705 | [ ${_flags_type_} -eq ${__FLAGS_TYPE_NONE} ] && \ |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 706 | _flags_type_=`_flags_getFlagInfo \ |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 707 | "${_flags_name_}" ${__FLAGS_INFO_TYPE}` |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 708 | case ${_flags_type_} in |
| 709 | ${__FLAGS_TYPE_BOOLEAN}) |
| 710 | if [ ${_flags_len_} -eq ${__FLAGS_LEN_LONG} ]; then |
| 711 | if [ "${_flags_arg_}" != "${__FLAGS_NULL}" ]; then |
| 712 | eval "FLAGS_${_flags_name_}=${FLAGS_TRUE}" |
| 713 | else |
| 714 | eval "FLAGS_${_flags_name_}=${FLAGS_FALSE}" |
| 715 | fi |
| 716 | else |
| 717 | _flags_strToEval_="_flags_val_=\ |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 718 | \${__flags_${_flags_name_}_${__FLAGS_INFO_DEFAULT}}" |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 719 | eval "${_flags_strToEval_}" |
| 720 | if [ ${_flags_val_} -eq ${FLAGS_FALSE} ]; then |
| 721 | eval "FLAGS_${_flags_name_}=${FLAGS_TRUE}" |
| 722 | else |
| 723 | eval "FLAGS_${_flags_name_}=${FLAGS_FALSE}" |
| 724 | fi |
| 725 | fi |
| 726 | ;; |
| 727 | |
| 728 | ${__FLAGS_TYPE_FLOAT}) |
| 729 | if _flags_validateFloat "${_flags_arg_}"; then |
| 730 | eval "FLAGS_${_flags_name_}='${_flags_arg_}'" |
| 731 | else |
| 732 | flags_error="invalid float value (${_flags_arg_})" |
| 733 | flags_return=${FLAGS_ERROR} |
| 734 | break |
| 735 | fi |
| 736 | ;; |
| 737 | |
| 738 | ${__FLAGS_TYPE_INTEGER}) |
| 739 | if _flags_validateInteger "${_flags_arg_}"; then |
| 740 | eval "FLAGS_${_flags_name_}='${_flags_arg_}'" |
| 741 | else |
| 742 | flags_error="invalid integer value (${_flags_arg_})" |
| 743 | flags_return=${FLAGS_ERROR} |
| 744 | break |
| 745 | fi |
| 746 | ;; |
| 747 | |
| 748 | ${__FLAGS_TYPE_STRING}) |
| 749 | eval "FLAGS_${_flags_name_}='${_flags_arg_}'" |
| 750 | ;; |
| 751 | esac |
| 752 | |
kate.ward | 5b48fc1 | 2008-11-13 00:42:43 +0000 | [diff] [blame] | 753 | # handle special case help flag |
| 754 | if [ "${_flags_name_}" = 'help' ]; then |
| 755 | if [ ${FLAGS_help} -eq ${FLAGS_TRUE} ]; then |
| 756 | flags_help |
| 757 | flags_error='help requested' |
| 758 | flags_return=${FLAGS_FALSE} |
| 759 | break |
| 760 | fi |
| 761 | fi |
| 762 | |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 763 | # shift the option and non-boolean arguements out. |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 764 | shift |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 765 | [ ${_flags_type_} != ${__FLAGS_TYPE_BOOLEAN} ] && shift |
| 766 | done |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 767 | |
kate.ward | c521068 | 2009-03-30 18:54:36 +0000 | [diff] [blame] | 768 | # give user back non-flag arguments |
| 769 | FLAGS_ARGV='' |
| 770 | while [ $# -gt 0 ]; do |
| 771 | FLAGS_ARGV="${FLAGS_ARGV:+${FLAGS_ARGV} }'$1'" |
| 772 | shift |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 773 | done |
| 774 | |
| 775 | unset _flags_arg_ _flags_len_ _flags_name_ _flags_opt_ _flags_pos_ \ |
| 776 | _flags_strToEval_ _flags_type_ _flags_val_ |
| 777 | return ${flags_return} |
| 778 | } |
| 779 | |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 780 | #------------------------------------------------------------------------------ |
| 781 | # public functions |
| 782 | # |
| 783 | |
| 784 | # A basic boolean flag. Boolean flags do not take any arguments, and their |
| 785 | # value is either 1 (false) or 0 (true). For long flags, the false value is |
| 786 | # specified on the command line by prepending the word 'no'. With short flags, |
| 787 | # the presense of the flag toggles the current value between true and false. |
| 788 | # Specifying a short boolean flag twice on the command results in returning the |
| 789 | # value back to the default value. |
| 790 | # |
| 791 | # A default value is required for boolean flags. |
| 792 | # |
| 793 | # For example, lets say a Boolean flag was created whose long name was 'update' |
| 794 | # and whose short name was 'x', and the default value was 'false'. This flag |
| 795 | # could be explicitly set to 'true' with '--update' or by '-x', and it could be |
| 796 | # explicitly set to 'false' with '--noupdate'. |
| 797 | DEFINE_boolean() { _flags_define ${__FLAGS_TYPE_BOOLEAN} "$@"; } |
| 798 | |
| 799 | # Other basic flags. |
| 800 | DEFINE_float() { _flags_define ${__FLAGS_TYPE_FLOAT} "$@"; } |
| 801 | DEFINE_integer() { _flags_define ${__FLAGS_TYPE_INTEGER} "$@"; } |
| 802 | DEFINE_string() { _flags_define ${__FLAGS_TYPE_STRING} "$@"; } |
| 803 | |
| 804 | # Parse the flags. |
| 805 | # |
| 806 | # Args: |
| 807 | # unnamed: list: command-line flags to parse |
| 808 | # Returns: |
| 809 | # integer: success of operation, or error |
| 810 | FLAGS() |
| 811 | { |
kate.ward | abae05d | 2008-11-12 22:37:05 +0000 | [diff] [blame] | 812 | # define a standard 'help' flag if one isn't already defined |
| 813 | [ -z "${__flags_help_type:-}" ] && \ |
| 814 | DEFINE_boolean 'help' false 'show this help' 'h' |
kate.ward | f08c5b6 | 2008-07-11 20:32:11 +0000 | [diff] [blame] | 815 | |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 816 | # parse options |
kate.ward | 7a3c9c4 | 2009-04-24 00:12:35 +0000 | [diff] [blame] | 817 | if [ $# -gt 0 ]; then |
| 818 | if [ ${__FLAGS_GETOPT_VERS} -ne ${__FLAGS_GETOPT_VERS_ENH} ]; then |
| 819 | _flags_getoptStandard "$@" |
| 820 | else |
| 821 | _flags_getoptEnhanced "$@" |
| 822 | fi |
| 823 | flags_return=$? |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 824 | else |
kate.ward | 7a3c9c4 | 2009-04-24 00:12:35 +0000 | [diff] [blame] | 825 | # nothing passed; won't bother running getopt |
| 826 | __flags_opts='--' |
| 827 | flags_return=${FLAGS_TRUE} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 828 | fi |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 829 | |
| 830 | if [ ${flags_return} -eq ${FLAGS_TRUE} ]; then |
kate.ward | 7a3c9c4 | 2009-04-24 00:12:35 +0000 | [diff] [blame] | 831 | _flags_parseGetopt $# "${__flags_opts}" |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 832 | flags_return=$? |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 833 | fi |
| 834 | |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 835 | [ ${flags_return} -eq ${FLAGS_ERROR} ] && _flags_fatal "${flags_error}" |
| 836 | return ${flags_return} |
| 837 | } |
| 838 | |
| 839 | # This is a helper function for determining the `getopt` version for platforms |
| 840 | # where the detection isn't working. It simply outputs debug information that |
| 841 | # can be included in a bug report. |
| 842 | # |
| 843 | # Args: |
| 844 | # none |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 845 | # Output: |
| 846 | # debug info that can be included in a bug report |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 847 | # Returns: |
| 848 | # nothing |
| 849 | flags_getoptInfo() |
| 850 | { |
| 851 | # platform info |
| 852 | _flags_debug "uname -a: `uname -a`" |
| 853 | _flags_debug "PATH: ${PATH}" |
| 854 | |
| 855 | # shell info |
| 856 | if [ -n "${BASH_VERSION:-}" ]; then |
| 857 | _flags_debug 'shell: bash' |
| 858 | _flags_debug "BASH_VERSION: ${BASH_VERSION}" |
| 859 | elif [ -n "${ZSH_VERSION:-}" ]; then |
| 860 | _flags_debug 'shell: zsh' |
| 861 | _flags_debug "ZSH_VERSION: ${ZSH_VERSION}" |
| 862 | fi |
| 863 | |
| 864 | # getopt info |
| 865 | getopt >/dev/null |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 866 | _flags_getoptReturn=$? |
| 867 | _flags_debug "getopt return: ${_flags_getoptReturn}" |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 868 | _flags_debug "getopt --version: `getopt --version 2>&1`" |
| 869 | |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 870 | unset _flags_getoptReturn |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 871 | } |
| 872 | |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 873 | # Returns whether the detected getopt version is the enhanced version. |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 874 | # |
| 875 | # Args: |
| 876 | # none |
kate.ward | 60c2598 | 2008-11-12 20:12:44 +0000 | [diff] [blame] | 877 | # Output: |
| 878 | # none |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 879 | # Returns: |
| 880 | # bool: true if getopt is the enhanced version |
| 881 | flags_getoptIsEnh() |
| 882 | { |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 883 | test ${__FLAGS_GETOPT_VERS} -eq ${__FLAGS_GETOPT_VERS_ENH} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 884 | } |
| 885 | |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 886 | # Returns whether the detected getopt version is the standard version. |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 887 | # |
| 888 | # Args: |
| 889 | # none |
| 890 | # Returns: |
| 891 | # bool: true if getopt is the standard version |
| 892 | flags_getoptIsStd() |
| 893 | { |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 894 | test ${__FLAGS_GETOPT_VERS} -eq ${__FLAGS_GETOPT_VERS_STD} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 895 | } |
| 896 | |
| 897 | # This is effectively a 'usage()' function. It prints usage information and |
| 898 | # exits the program with ${FLAGS_FALSE} if it is ever found in the command line |
| 899 | # arguments. Note this function can be overridden so other apps can define |
| 900 | # their own --help flag, replacing this one, if they want. |
| 901 | # |
| 902 | # Args: |
| 903 | # none |
| 904 | # Returns: |
| 905 | # integer: success of operation (always returns true) |
| 906 | flags_help() |
| 907 | { |
| 908 | if [ -n "${FLAGS_HELP:-}" ]; then |
| 909 | echo "${FLAGS_HELP}" >&2 |
| 910 | else |
kate.ward | 4d8e047 | 2008-07-18 11:52:56 +0000 | [diff] [blame] | 911 | echo "USAGE: ${FLAGS_PARENT:-$0} [flags] args" >&2 |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 912 | fi |
| 913 | if [ -n "${__flags_longNames}" ]; then |
| 914 | echo 'flags:' >&2 |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 915 | for flags_name_ in ${__flags_longNames}; do |
| 916 | flags_flagStr_='' |
kate.ward | bda3917 | 2009-04-01 03:30:22 +0000 | [diff] [blame] | 917 | flags_boolStr_='' |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 918 | |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 919 | flags_default_=`_flags_getFlagInfo \ |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 920 | "${flags_name_}" ${__FLAGS_INFO_DEFAULT}` |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 921 | flags_help_=`_flags_getFlagInfo \ |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 922 | "${flags_name_}" ${__FLAGS_INFO_HELP}` |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 923 | flags_short_=`_flags_getFlagInfo \ |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 924 | "${flags_name_}" ${__FLAGS_INFO_SHORT}` |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 925 | flags_type_=`_flags_getFlagInfo \ |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 926 | "${flags_name_}" ${__FLAGS_INFO_TYPE}` |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 927 | |
kate.ward | bda3917 | 2009-04-01 03:30:22 +0000 | [diff] [blame] | 928 | [ "${flags_short_}" != "${__FLAGS_NULL}" ] \ |
| 929 | && flags_flagStr_="-${flags_short_}" |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 930 | |
| 931 | if [ ${__FLAGS_GETOPT_VERS} -eq ${__FLAGS_GETOPT_VERS_ENH} ]; then |
kate.ward | bda3917 | 2009-04-01 03:30:22 +0000 | [diff] [blame] | 932 | [ "${flags_short_}" != "${__FLAGS_NULL}" ] \ |
| 933 | && flags_flagStr_="${flags_flagStr_}," |
| 934 | [ ${flags_type_} -eq ${__FLAGS_TYPE_BOOLEAN} ] \ |
| 935 | && flags_boolStr_='[no]' |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 936 | flags_flagStr_="${flags_flagStr_}--${flags_boolStr_}${flags_name_}:" |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 937 | fi |
| 938 | |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 939 | case ${flags_type_} in |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 940 | ${__FLAGS_TYPE_BOOLEAN}) |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 941 | if [ ${flags_default_} -eq ${FLAGS_TRUE} ]; then |
| 942 | flags_defaultStr_='true' |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 943 | else |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 944 | flags_defaultStr_='false' |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 945 | fi |
| 946 | ;; |
| 947 | ${__FLAGS_TYPE_FLOAT}|${__FLAGS_TYPE_INTEGER}) |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 948 | flags_defaultStr_=${flags_default_} ;; |
| 949 | ${__FLAGS_TYPE_STRING}) flags_defaultStr_="'${flags_default_}'" ;; |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 950 | esac |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 951 | flags_defaultStr_="(default: ${flags_defaultStr_})" |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 952 | |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 953 | flags_helpStr_=" ${flags_flagStr_} ${flags_help_} ${flags_defaultStr_}" |
kate.ward | 9a183b8 | 2010-03-18 00:25:34 +0000 | [diff] [blame] | 954 | flags_helpStrLen_=`expr -- "${flags_helpStr_}" : '.*'` |
kate.ward | 14b33bf | 2008-11-15 20:03:18 +0000 | [diff] [blame] | 955 | flags_columns_=`_flags_columns` |
| 956 | if [ ${flags_helpStrLen_} -lt ${flags_columns_} ]; then |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 957 | echo "${flags_helpStr_}" >&2 |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 958 | else |
kate.ward | 6409961 | 2008-11-17 17:36:14 +0000 | [diff] [blame] | 959 | echo " ${flags_flagStr_} ${flags_help_}" >&2 |
kate.ward | 87b0c2e | 2009-04-01 03:48:16 +0000 | [diff] [blame] | 960 | # note: the silliness with the x's is purely for ksh93 on Ubuntu 6.06 |
| 961 | # because it doesn't like empty strings when used in this manner. |
kate.ward | bda3917 | 2009-04-01 03:30:22 +0000 | [diff] [blame] | 962 | flags_emptyStr_="`echo \"x${flags_flagStr_}x\" \ |
| 963 | |awk '{printf "%"length($0)-2"s", ""}'`" |
kate.ward | 6409961 | 2008-11-17 17:36:14 +0000 | [diff] [blame] | 964 | flags_helpStr_=" ${flags_emptyStr_} ${flags_defaultStr_}" |
kate.ward | 9a183b8 | 2010-03-18 00:25:34 +0000 | [diff] [blame] | 965 | flags_helpStrLen_=`expr -- "${flags_helpStr_}" : '.*'` |
kate.ward | 6409961 | 2008-11-17 17:36:14 +0000 | [diff] [blame] | 966 | if [ ${__FLAGS_GETOPT_VERS} -eq ${__FLAGS_GETOPT_VERS_STD} \ |
| 967 | -o ${flags_helpStrLen_} -lt ${flags_columns_} ]; then |
| 968 | # indented to match help string |
| 969 | echo "${flags_helpStr_}" >&2 |
| 970 | else |
| 971 | # indented four from left to allow for longer defaults as long flag |
| 972 | # names might be used too, making things too long |
| 973 | echo " ${flags_defaultStr_}" >&2 |
| 974 | fi |
kate.ward | 437639d | 2008-10-19 17:21:41 +0000 | [diff] [blame] | 975 | fi |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 976 | done |
| 977 | fi |
| 978 | |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 979 | unset flags_boolStr_ flags_default_ flags_defaultStr_ flags_emptyStr_ \ |
| 980 | flags_flagStr_ flags_help_ flags_helpStr flags_helpStrLen flags_name_ \ |
kate.ward | 14b33bf | 2008-11-15 20:03:18 +0000 | [diff] [blame] | 981 | flags_columns_ flags_short_ flags_type_ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 982 | return ${FLAGS_TRUE} |
| 983 | } |
| 984 | |
kate.ward | cecd7bd | 2009-05-10 17:56:13 +0000 | [diff] [blame] | 985 | # Reset shflags back to an uninitialized state. |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 986 | # |
| 987 | # Args: |
| 988 | # none |
| 989 | # Returns: |
| 990 | # nothing |
| 991 | flags_reset() |
| 992 | { |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 993 | for flags_name_ in ${__flags_longNames}; do |
| 994 | flags_strToEval_="unset FLAGS_${flags_name_}" |
| 995 | for flags_type_ in \ |
kate.ward | cecd7bd | 2009-05-10 17:56:13 +0000 | [diff] [blame] | 996 | ${__FLAGS_INFO_DEFAULT} \ |
kate.ward | fb0e718 | 2009-05-10 16:59:13 +0000 | [diff] [blame] | 997 | ${__FLAGS_INFO_HELP} \ |
| 998 | ${__FLAGS_INFO_SHORT} \ |
| 999 | ${__FLAGS_INFO_TYPE} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 1000 | do |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 1001 | flags_strToEval_=\ |
| 1002 | "${flags_strToEval_} __flags_${flags_name_}_${flags_type_}" |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 1003 | done |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 1004 | eval ${flags_strToEval_} |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 1005 | done |
| 1006 | |
| 1007 | # reset internal variables |
| 1008 | __flags_boolNames=' ' |
| 1009 | __flags_longNames=' ' |
| 1010 | __flags_shortNames=' ' |
| 1011 | |
kate.ward | d967240 | 2008-11-15 16:55:51 +0000 | [diff] [blame] | 1012 | unset flags_name_ flags_type_ flags_strToEval_ |
kate.ward | f51c616 | 2008-06-17 16:38:35 +0000 | [diff] [blame] | 1013 | } |