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