シェルスクリプトでgetoptsで解析する引数をポジショナルな引数と混合して使えるようにする

シェルスクリプトでgetoptsを使うと簡単に引数のオプションが解析が出来ますが、ポジショナルな引数と一緒に使おうと思うと解析部分が途中で終わってしまったりうまく行かないことがあります。

ただ使う側としては位置を気にせず使えたほうが便利なことが多いのでそれを実装する方法について。

getoptsを使ったオプション解析
ポジショナルな引数をオプションの前や間にも入れられるようにする
オプションでない-で始まる引数をポジショナルなものとして扱う

getoptsを使ったオプション解析

よくある感じはこんなの。

arg.sh

#!/usr/bin/env bash

var1="aaa"
var2="bbb"
var3="ccc"

while getopts ab:c:h OPT;do
  case $OPT in
    "a" ) var1="xxx";;
    "b" ) var2="$OPTARG";;
    "c" ) var3="$OPTARG";;
    "h" ) echo "This is help.";exit 0;;
    \? ) echo "Invalid option."; exit 1;;
  esac
done
shift $((OPTIND - 1))

echo "$var1"
echo "$var2"
echo "$var3"
echo "$@"

getoptsの後に-始まりで使いたいオプションとして使いたいアルファベットを書きますが、値を持つものに関しては:を後ろにつけます。

このオプションのアルファベットがOPTに入り、値持ちの場合はOPTARGにこの値が入ります¹

それぞれのオプションに関してcase文でそれぞれに対しての処置を設定します。もし-付きの引数でgetoptに定義されてないものがくるとOPTには?が入るのでそれに対する処置も追加しておきます。(エスケープ(\?)が必要。)

解析が一通り終わった後、解析に使われなかった残りの引数を取得するために解析に使われた分(OPTIND - 1)² だけshiftで削除して残りをポジショナルな引数($1, $2, …)として使えるような形にしています。

実行してみると、

$ ./arg.sh
aaa
bbb
ccc

$ ./arg.sh -a -b yyy -c zzz abc def
xxx
yyy
zzz
abc def
$ ./arg.sh -b yyy -a -c zzz -c ZZZ abc def
xxx
yyy
ZZZ
abc def

みたいな感じになります。オプション部分に関しては順番は入れ替わっても大丈夫ですし、複数回同じオプションを使ってもその度に解析されるので、上の例だとただ値を入れてるだけなので-c zzz -c ZZZみたいにした場合は後の方が残っています。

ただ、これをオプションより前にポジショナルな引数を与えてしまうと

$ ./arg.sh abc -a -b yyy -c zzz def
aaa
bbb
ccc
abc -a -b yyy -c zzz def

といった感じで解析されません。

また、aは値を持たないオプションですが、-aの後ろに引数を置くとポジショナルな引数としてそこで解析が終わるので、

$ ./arg.sh -a abc -b yyy -c zzz def
xxx
bbb
ccc
abc -b yyy -c zzz def

といった感じに-aの解析だけ行われて終了してしまいます。

ポジショナルな引数をオプションの前や間にも入れられるようにする

これに関してはstackoverflowに10年以上前の質問がありました。

bash - Is mixing getopts with positional parameters possible? - Stack Overflow

一番voteされてるのは普通のgetoptsの説明で答えになってない感じではあるんですが、 8年経って投稿された答えがいい感じに解決してくれてます。

上のスクリプトを下のように書き換えてみます。

arg.sh

#!/usr/bin/env bash

var1="aaa"
var2="bbb"
var3="ccc"

positional=()
while [ "$OPTIND" -le "$#" ];do
  if getopts ab:c:h OPT;then
    case $OPT in
      "a" ) var1="xxx";;
      "b" ) var2="$OPTARG";;
      "c" ) var3="$OPTARG";;
      "h" ) echo "This is help.";exit 0;;
      \? ) echo "Invalid option."; exit 1;;
    esac
  else
    positional+=("${!OPTIND}")
    ((OPTIND++))
  fi
done

echo "$var1"
echo "$var2"
echo "$var3"
echo "${positional[@]}"

これを実行すると

$ ./arg.sh -a abc -b yyy -c zzz def
xxx
yyy
zzz
abc def

といった感じでオプション解析に使われてないものが positionalに入れられてそれを順に使えるような状態が出来ます。

ここでは

while [ "$OPTIND" -le "$#" ];do
  if getopts ab:c:h OPT;then

の組み合わせにすることでgetoptsで1つずつ解析していき、かつ-始まりでないポジショナルな引数が来たらこの2段目がfalseになるので、そこでは

positional+=("${!OPTIND}")
((OPTIND++))

としてpositional変数にその値を追加しています ³。この場合はgetoptsでのOPTINDのインクリメントが行われないので手動で1つ値を加えておきます。

こうすることで最後までオプション引数があれば解析してその他はポジショナルな引数として扱うことが出来ます。

オプションでない`-`で始まる引数をポジショナルなものとして扱う

上のスクリプトでオプションとして設定していない文字を-付きで与えると、

$ ./arg.sh -d
./arg.sh: illegal option -- d
Invalid option.

といった感じのエラーを出します。

このような設定していないものはそのままポジショナルな引数として使いたい、といったことがある場合は以下のようにすることで扱えます。

arg.sh

#!/usr/bin/env bash

var1="aaa"
var2="bbb"
var3="ccc"

positional=()
while [ "$OPTIND" -le "$#" ];do
  if getopts :ab:c:h OPT;then
    case $OPT in
      "a" ) var1="xxx";;
      "b" ) var2="$OPTARG";;
      "c" ) var3="$OPTARG";;
      "h" ) echo "This is help.";exit 0;;
      \?) positional+=("-$OPTARG");;
    esac
  else
    positional+=("${!OPTIND}")
    ((OPTIND++))
  fi
done

echo "$var1"
echo "$var2"
echo "$var3"
echo "${positional[@]}"