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