File: helpers.bash

package info (click to toggle)
crazy-complete 0.3.6-2
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 2,404 kB
  • sloc: python: 7,949; sh: 4,636; makefile: 74
file content (416 lines) | stat: -rwxr-xr-x 11,433 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
#!/bin/bash

unset CDPATH
set -u +o histexpand

foo() {
  local -a POSITIONALS
  local POSITIONAL_INDEX=0
  local argi c
  local HAVE_ARG=0 HAVE_A=0 HAVE_B=0

  for ((argi=1; argi <= $#; ++argi)); do
    local arg="${!argi}"

    case "$arg" in
      --arg|--arg=*)
        HAVE_ARG=1
        [[ "$arg" == *"="* ]] || (( ++argi ))
        ;;
      --)
        (( ++argi ))
        break
        ;;
      --*)
        ;;
      -)
        POSITIONALS[$((POSITIONAL_INDEX++))]="$arg"
        ;;
      -*)
        for ((c=1; c < ${#arg}; ++c)); do
          local char="${arg:$c:1}"
          case "$char" in
            a)
              HAVE_A=1
              (( $c + 1 < ${#arg} )) || (( ++argi ))
              break;
              ;;
            b)
              HAVE_B=1
          esac
        done
        ;;
      *)
        POSITIONALS[$((POSITIONAL_INDEX++))]="$arg"
        ;;
    esac
  done

  for ((; argi <= $#; ++argi)); do
    POSITIONALS[$((POSITIONAL_INDEX++))]="${!argi}"
  done

  echo "HAVE_B=$HAVE_B"
  echo "HAVE_A=$HAVE_A"
  echo "HAVE_ARG=$HAVE_ARG"
  echo "POSITIONALS=${POSITIONALS[@]}"
}

foo --arg=foo -ba bar foo -- bar baz

exec_() {
  local item desc

  while IFS=$'\t' read -r item desc; do
    if [[ "$item" == "$cur"* ]]; then
      COMPREPLY+=("$(printf '%q' "$item")")
    fi
  done < <(eval "$1")
}

bash_helper() {
  # ===========================================================================
  #
  # This function is for querying the command line.
  #
  # COMMANDS
  #   setup <OPTIONS> <ARGS...>
  #     This is the first call you have to make, otherwise the other commands 
  #     won't (successfully) work.
  #
  #     It parses <ARGS> accordings to <OPTIONS> and stores results in the 
  #     variables POSITIONALS, HAVING_OPTIONS and OPTION_VALUES.
  #
  #     The first argument is a comma-seperated list of options that the parser
  #     should know about. Short options (-o), long options (--option), and
  #     old-style options (-option) are supported.
  #
  #     If an option takes an argument, it is suffixed by '='.
  #     If an option takes an optional argument, it is suffixed by '=?'.
  #
  #   get_positional <NUM>
  #     Prints out the positional argument number NUM (starting from 1)
  #
  #   has_option <OPTIONS...>
  #     Checks if a option given in OPTIONS is passed on commandline.
  #
  #   option_is <OPTIONS...> -- <VALUES...>
  #     Checks if one option in OPTIONS has a value of VALUES.
  #
  # EXAMPLE
  #   local POSITIONALS HAVING_OPTIONS OPTION_VALUES
  #   zsh_helper setup '-f,-a=,-optional=?' program_name -f -optional -a foo bar
  #   zsh_helper has_option -f
  #   zsh_helper option_is -a -- foo
  #
  #   Here, -f is a flag, -a takes an argument, and -optional takes an optional
  #   argument.
  #
  #   Both queries return true.
  #
  # ===========================================================================

  local FUNC="bash_helper"
  local CONTAINS="__contains"

  __contains() {
    local ARG KEY="$1"; shift
    for ARG; do [[ "$KEY" == "$ARG" ]] && return 0; done
    return 1
  }

  if [[ $# == 0 ]]; then
    echo "$FUNC: missing command" >&2
    return 1;
  fi

  local CMD=$1
  shift

  case "$CMD" in
    get_positional)
      if test $# -ne 1; then
        echo "$FUNC: get_positional: takes exactly one argument" >&2
        return 1;
      fi

      if test "$1" -eq 0; then
        echo "$FUNC: get_positional: positionals start at 1, not 0!" >&2
        return 1
      fi

      printf "%s" "${POSITIONALS[$1]}"
      return 0
      ;;
    has_option)
      if test $# -eq 0; then
        echo "$FUNC: has_option: arguments required" >&2
        return 1;
      fi

      local OPTION=''
      for OPTION in "${HAVING_OPTIONS[@]}"; do
        $CONTAINS "$OPTION" "$@" && return 0
      done

      return 1
      ;;
    option_is)
      local -a CMD_OPTION_IS_OPTIONS=() CMD_OPTION_IS_VALUES=()
      local END_OF_OPTIONS_NUM=0

      while test $# -ge 1; do
        if [[ "$1" == "--" ]]; then
          (( ++END_OF_OPTIONS_NUM ))
        elif test $END_OF_OPTIONS_NUM -eq 0; then
          CMD_OPTION_IS_OPTIONS+=("$1")
        elif test $END_OF_OPTIONS_NUM -eq 1; then
          CMD_OPTION_IS_VALUES+=("$1")
        fi

        shift
      done

      if test ${#CMD_OPTION_IS_OPTIONS[@]} -eq 0; then
        echo "$FUNC: option_is: missing options" >&2
        return 1
      fi

      if test ${#CMD_OPTION_IS_VALUES[@]} -eq 0; then
        echo "$FUNC: option_is: missing values" >&2
        return 1
      fi

      local I=$(( ${#HAVING_OPTIONS[@]} - 1))
      while test $I -ge 0; do
        local OPTION="${HAVING_OPTIONS[$I]}"
        if $CONTAINS "$OPTION" "${CMD_OPTION_IS_OPTIONS[@]}"; then
          local VALUE="${OPTION_VALUES[$I]}"
          $CONTAINS "$VALUE" "${CMD_OPTION_IS_VALUES[@]}" && return 0
        fi

        (( --I ))
      done

      return 1
      ;;
    setup)
      local IFS=','
      local -a OPTIONS=(${1})
      unset IFS
      shift
      ;;
    *)
      echo "$FUNC: argv[1]: invalid command" >&2
      return 1
      ;;
  esac

  # continuing setup....

  # ===========================================================================
  # Parsing of available options
  # ===========================================================================

  local -a   OLD_OPTS_WITH_ARG   OLD_OPTS_WITH_OPTIONAL_ARG   OLD_OPTS_WITHOUT_ARG
  local -a  LONG_OPTS_WITH_ARG  LONG_OPTS_WITH_OPTIONAL_ARG  LONG_OPTS_WITHOUT_ARG
  local -a SHORT_OPTS_WITH_ARG SHORT_OPTS_WITH_OPTIONAL_ARG SHORT_OPTS_WITHOUT_ARG

  local OPTION
  for OPTION in "${OPTIONS[@]}"; do
    case "$OPTION" in
      --?*=)    LONG_OPTS_WITH_ARG+=("${OPTION%=}");;
      --?*=\?)  LONG_OPTS_WITH_OPTIONAL_ARG+=("${OPTION%=?}");;
      --?*)     LONG_OPTS_WITHOUT_ARG+=("$OPTION");;

      -?=)      SHORT_OPTS_WITH_ARG+=("${OPTION%=}");;
      -?=\?)    SHORT_OPTS_WITH_OPTIONAL_ARG+=("${OPTION%=?}");;
      -?)       SHORT_OPTS_WITHOUT_ARG+=("$OPTION");;

      -??*=)    OLD_OPTS_WITH_ARG+=("${OPTION%=}");;
      -??*=\?)  OLD_OPTS_WITH_OPTIONAL_ARG+=("${OPTION%=?}");;
      -??*)     OLD_OPTS_WITHOUT_ARG+=("$OPTION");;

      *) echo "$FUNC: $OPTION: not a valid short, long or oldstyle option" >&2; return 1;;
    esac
  done

  # ===========================================================================
  # Parsing of command line options
  # ===========================================================================

  POSITIONALS=()
  HAVING_OPTIONS=()
  OPTION_VALUES=()

  local ARGI=2 # ARGI[1] is program name
  while [[ $ARGI -le $# ]]; do
    local ARG="${!ARGI}"
    local HAVE_TRAILING_ARG=$(test $ARGI -lt $# && echo true || echo false)

    case "$ARG" in
      -)
        POSITIONALS+=(-);;
      --)
        for ARGI in $(seq $((ARGI + 1)) $#); do
          POSITIONALS+=("${@[$ARGI]}")
        done
        break;;
      --*)
        for OPTION in "${LONG_OPTS_WITH_ARG[@]}" "${LONG_OPTS_WITHOUT_ARG[@]}" "${LONG_OPTS_WITH_OPTIONAL_ARG[@]}"; do
          if [[ "$ARG" == "$OPTION="* ]]; then
            HAVING_OPTIONS+=("$OPTION")
            OPTION_VALUES+=("${ARG#$OPTION=}")
            break
          elif [[ "$ARG" == "$OPTION" ]]; then
            if $CONTAINS "$OPTION" "${LONG_OPTS_WITH_ARG[@]}"; then
              if $HAVE_TRAILING_ARG; then
                HAVING_OPTIONS+=("$OPTION")
                OPTION_VALUES+=("${@[$((ARGI + 1))]}")
                (( ARGI++ ))
              fi
            else
              HAVING_OPTIONS+=("$OPTION")
              OPTION_VALUES+=("")
            fi
            break
          fi
        done;;
      -*)
        local HAVE_MATCH=false

        for OPTION in "${OLD_OPTS_WITH_ARG[@]}" "${OLD_OPTS_WITHOUT_ARG[@]}" "${OLD_OPTS_WITH_OPTIONAL_ARG[@]}"; do
          if [[ "$ARG" == "$OPTION="* ]]; then
            HAVING_OPTIONS+=("$OPTION")
            OPTION_VALUES+=("${ARG#$OPTION=}")
            HAVE_MATCH=true
            break
          elif [[ "$ARG" == "$OPTION" ]]; then
            if $CONTAINS "$OPTION" "${OLD_OPTS_WITH_ARG[@]}"; then
              if $HAVE_TRAILING_ARG; then
                HAVING_OPTIONS+=("$OPTION")
                OPTION_VALUES+=("${@:$((ARGI + 1)):1}")
                (( ARGI++ ))
              fi
            else
              HAVING_OPTIONS+=("$OPTION")
              OPTION_VALUES+=("")
            fi

            HAVE_MATCH=true
            break
          fi
        done

        if ! $HAVE_MATCH; then
          local ARG_LENGTH=${#ARG}
          local I=1
          local IS_END=false
          while ! $IS_END && test $I -lt $ARG_LENGTH; do
            local ARG_CHAR="${ARG:$I:1}"
            local HAVE_TRAILING_CHARS=$(test $((I+1)) -lt $ARG_LENGTH && echo true || echo false)

            for OPTION in "${SHORT_OPTS_WITH_ARG[@]}" "${SHORT_OPTS_WITHOUT_ARG[@]}" "${SHORT_OPTS_WITH_OPTIONAL_ARG[@]}"; do
              local OPTION_CHAR="${OPTION:1:1}"

              if test "$ARG_CHAR" = "$OPTION_CHAR"; then
                if $CONTAINS "$OPTION" "${SHORT_OPTS_WITH_ARG[@]}"; then
                  if $HAVE_TRAILING_CHARS; then
                    HAVING_OPTIONS+=("$OPTION")
                    OPTION_VALUES+=("${ARG:$((I+1))}")
                    IS_END=true
                  elif $HAVE_TRAILING_ARG; then
                    HAVING_OPTIONS+=("$OPTION")
                    OPTION_VALUES+=("${@:$((ARGI + 1)):1}")
                    (( ARGI++ ))
                    IS_END=true
                  fi
                elif $CONTAINS "$OPTION" "${SHORT_OPTS_WITH_OPTIONAL_ARG[@]}"; then
                  HAVING_OPTIONS+=("$OPTION")

                  if $HAVE_TRAILING_CHARS; then
                    IS_END=true
                    OPTION_VALUES+=("${ARG:$((I+1))}")
                  else
                    OPTION_VALUES+=("")
                  fi
                else
                  HAVING_OPTIONS+=("$OPTION")
                  OPTION_VALUES+=("")
                fi

                break
              fi
            done

            (( I++ ))
          done
        fi;;
      *)
        POSITIONALS+=("$ARG");;
    esac

    (( ARGI++ ))
  done
}

value_list() {
  local separator="$1"; shift
  local -a values=("$@")
  local -a having_values

  if [[ -z "$cur" ]]; then
    COMPREPLY=("${values[@]}")
    return
  fi

  IFS="$separator" read -r -a having_values <<< "$cur"

  local -a remaining_values=()
  local value having_value found_value

  for value in "${values[@]}"; do
    found_value=false

    for having_value in "${having_values[@]}"; do
      if [[ "$value" == "$having_value" ]]; then
        found_value=true
        break
      fi
    done

    if ! $found_value; then
      remaining_values+=("$value")
    fi
  done

  COMPREPLY=()

  if [[ "${cur: -1}" == "$separator" ]]; then
    for value in "${remaining_values[@]}"; do
      COMPREPLY+=("$cur$value")
    done
  elif (( ${#having_values[@]} )); then
    local cur_last_value=${having_values[-1]}

    for value in "${remaining_values[@]}"; do
      if [[ "$value" == "$cur_last_value"* ]]; then
        COMPREPLY+=("${cur%"$cur_last_value"}$value")
      fi
    done
  fi
}

exported_variables() {
  COMPREPLY=()

  local var
  for var in $(declare -p -x | sed 's/=.*//; s/.* //'); do
    [[ "$var" == "$cur"* ]] && COMPREPLY+=("$var")
  done
}

# TODO: test
#bash_helper setup -o= progname -o bar
#bash_helper has_option -o && echo true
#bash_helper option_is -o -- bar && echo true