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