☰

シェルスクリプトオプションをより簡単に処理

tag-icon • tag-icon bash command-line options getopts
シェルスクリプトオプションをより簡単に処理

私はgetopt / getoptsよりもシェルスクリプト引数を処理するためのよりきれいで「自己文書化」する方法を探しています。

それは提供する必要があります...

  • 値の後に "=" または " " (空白) の有無にかかわらず長いオプションが完全にサポートされています。
  • ハイフンで連結されたオプション名を正しく処理します（例：--ignore-case）。
  • 引用符付きオプションの値を正しく処理します（例：--text "text string"）。

getopt / getoptsに必要なケースステートメントに含まれる大きなループのオーバーヘッドを削除し、オプションの処理を次のように減らしたいと思います。

option=argumentparse "$@"
[[ option == ""           ]] && helpShow
[[ option =~ -h|--help    ]] && helpShow
[[ option =~ -v|--version ]] && versionShow
[[ option =~ -G|--GUI     ]] && GUI=$TRUE
[[ option =~ --title      ]] && TITLE=${option["--title"]}

ここで引数parse（）関数は、さまざまな構文の可能性を一貫した形式、可能な連想配列に解析します。

どこかにエンコードされたものがあるでしょう。どんなアイデアがありますか？

(更新と名前変更)

答え1

この質問は（少なくとも私にとっては）かなり多く見ましたが、答えが提出されていないので、採用された解決策を伝えます。

ノート
マルチインターフェイス出力関数などの一部の関数がifHelpShow()使用さuiShow()れますが、その呼び出しには関連情報が含まれていますが、実装には含まれていないため、ここには含まれません。

###############################################################################
# FUNCTIONS (bash 4.1.0)
###############################################################################

function isOption () {
  # isOption "$@"
  # Return true (0) if argument has 1 or more leading hyphens.
  # Example:
  #     isOption "$@"  && ...
  # Note:
  #   Cannot use ifHelpShow() here since cannot distinguish 'isOption --help'
  #   from 'isOption "$@"' where first argument in "$@" is '--help'
  # Revised:
  #     20140117 docsalvage
  # 
  # support both short and long options
  [[ "${1:0:1}" == "-" ]]  && return 0
  return 1
}

function optionArg () {
  ifHelpShow "$1" 'optionArg  --option "$@"
    Echo argument to option if any. Within "$@", option and argument may be separated
    by space or "=". Quoted strings are preserved. If no argument, nothing echoed.
    Return true (0) if option is in argument list, whether an option-argument supplied
    or not. Return false (1) if option not in argument list. See also option().
    Examples:
        FILE=$(optionArg --file "$1")
        if $(optionArg -f "$@"); then ...
        optionArg --file "$@"   && ...
    Revised:
        20140117 docsalvage'  && return
  #
  # --option to find (without '=argument' if any)
  local FINDOPT="$1"; shift
  local OPTION=""
  local ARG=
  local o=
  local re="^$FINDOPT="
  #
  # echo "option start: FINDOPT=$FINDOPT, o=$o, OPTION=$OPTION, ARG=$ARG, @=$@" >&2
  #
  # let "$@" split commandline, respecting quoted strings
  for o in "$@"
  do
    # echo "FINDOPT=$FINDOPT, o=$o, OPTION=$OPTION, ARG=$ARG" >&2
    # echo " o=$o"  >&2
    # echo "re=$re" >&2
    #
    # detect --option and handle --option=argument
    [[ $o =~ $re ]]  && { OPTION=$FINDOPT; ARG="${o/$FINDOPT=/}"; break; }
    #
    # $OPTION will be non-null if --option was detected in last pass through loop
    [[ ! $OPTION ]]  && [[ "$o" != $FINDOPT ]]   && {              continue; } # is a positional arg (no previous --option)
    [[ ! $OPTION ]]  && [[ "$o" == $FINDOPT ]]   && { OPTION="$o"; continue; } # is the arg to last --option
    [[   $OPTION ]]  &&   isOption "$o"          && {                 break; } # no more arguments
    [[   $OPTION ]]  && ! isOption "$o"          && { ARG="$o";       break; } # only allow 1 argument
  done
  #
  # echo "option  final: FINDOPT=$FINDOPT, o=$o, OPTION=$OPTION, ARG=$ARG, @=$@" >&2
  #
  # use '-n' to remove any blank lines
  echo -n "$ARG"
  [[ "$OPTION" == "$FINDOPT" ]]   && return 0
  return 1
}

###############################################################################
# MAIN  (bash 4.1.0) (excerpt of relevant lines)
###############################################################################

# options
[[ "$@" == ""            ]]   && { zimdialog --help           ; exit 0; }
[[ "$1" == "--help"      ]]   && { zimdialog --help           ; exit 0; }
[[ "$1" == "--version"   ]]   && { uiShow "version $VERSION\n"; exit 0; }

# options with arguments
TITLE="$(optionArg --title  "$@")"
TIP="$(  optionArg --tip    "$@")"
FILE="$( optionArg --file   "$@")"

答え2

ここに良い答えがありますが、OPは明示的に要求しました。もっと簡単コマンドラインオプションを処理します。getoptfromを使用するよりも複雑なシェルオプションを解析する簡単な方法はないと思います。ユーティリティLinux:

$ cat opts.sh 
#!/bin/bash

# Print usage and exit
usage() {
    exec >&2 # Write everything to STDERR (consistent with getopt errors)
    (($#)) && echo "$@"
    echo "Usage: $0 [opts...] [args...]"
    exit 1
}

# Use getopt to validate options and reorder them. On error print usage
OPTS=$(getopt -s bash -o 'ab:c' -l 'longopt,longopt2,longwitharg:' -- "$@") || usage

# Replace our arguments with the reordered version
eval set -- "$OPTS"

# At this point everything up to "--" is options
declare opt_a opt_c longopt longopt2 longwitharg
declare -a opt_b  # Array to accumulate -b arguments
while (($#))
do
    case $1 in
        -a) opt_a=1;;
        -b) opt_b+=("$2"); shift;;
        -c) ((++opt_c));;
        --longopt) longopt=1;;
        --longopt2) ((++longopt2));;
        --longwitharg) longwitharg=$2; shift;;
        --) shift; break;; # We're done with options, shift over "--" and move on...
        *) usage "Unknown argument: $1" # Should not happen unless getopt errors are ignored.
    esac
    # Always shift once (for options with arguments we already shifted in the case so it's the 2nd shift)
    shift
done

echo "Remaining arguments after parsing options: $#"
# Now you can work directly with "$@" or slurp it in an array
args=("$@")

# Here's what we're left with:
declare -p opt_a opt_b opt_c longopt longopt2 longwitharg

# This is how you iterate over an array which may contain spaces and other field separators
for file in "${args[@]}"
do
    echo "File arg: $file"
done

getopt検証を実行し、エラーを返します（指示しない限り、この場合は直接エラーをキャッチできます）。たとえば、

$ ./opts.sh --badopt
getopt: unrecognized option '--badopt'

他のすべての項目は正しくソートされ参照されます。

$ ./opts.sh -ab3 -b8 file1 -ccc --longopt --longwitharg=abc --longwitharg "abc def" "file with spaces" 
Remaining arguments after parsing options: 2
declare -- opt_a="1"
declare -a opt_b=([0]="3" [1]="8")
declare -- opt_c="3"
declare -- longopt="1"
declare -- longopt2
declare -- longwitharg="abc def"
File arg: file1
File arg: file with spaces

ここでの主張は次のとおりです。

  • -aフラグです。存在する場合は1に設定されます。
  • -b繰り返します。各インスタンスがopt_b配列に追加されます。
  • -c3の発生回数を計算するカウンタです。
  • --longoptこのような表示-a
  • --longopt2同様のカウンタです-c（この例では使用されていないため、設定されていません。算術拡張）。
  • --longwithargパラメータを持つ一般的なオプションです。この例では、後でコマンドラインでその値をオーバーライドします。
  • file1残りの引数は任意の位置に指定されていますが、getoptがコマンドラインを並べ替えたfile with spaces後、すべての末尾に表示されます。--

変数を引用することは、空白の引数を正しく処理するために非常に重要です。しかし、不要な場所では引用文を使用することを自発的に避けてください。たとえば、次のようになります。

  • 直接変数の割り当て：longwitharg=$2
  • スイッチボックス：case $1 in

不明な場合は、通常、追加の引用符を使用しても問題になりません。

関連情報