シェルスクリプトで二重括弧による計算を行う際の0Xな数字に関する注意

最近のBashなどのシェルスクリプトでは二重括弧を使うことで数字の足し算などが出来ますが、おもったよりも賢い点が逆にバグを生んだ話。

二重括弧による計算
0Xな数字を二重括弧で計算する
二重括弧での数字
exprでは単に無視する
ということで

二重括弧による計算

Bashなどでは、

$ a=1
$ x=$(( a + 2 ))
$ echo $x
3

みたいな感じで二重括弧の中で数式を書くことで計算することが出来ます。

実際には数字を代入したりすることも含めていろいろな事ができます。

Arithmetic Expansion (Bash Reference Manual)

Bashでのコロンコマンドや二重括弧について

Bash/Zshで二重括弧インクリメントを使う時の注意

0Xな数字を二重括弧で計算する

ファイル名などで、数字をインクリメントして名前をつけていきたい、 10個以上になることもあるので10の位をゼロ埋めした状態にしたい、ということがある場合。

01, 02, 03….

みたいな感じにするために

#!/usr/bin/env bash

n=01
f1=file-$n
n=$(printf "%02d" $((n + 1)))
f2=file-$n
n=$(printf "%02d" $((n + 1)))
f3=file-$n
...

のようにしていくと、

file-01
file-02
file-03

といった感じのファイル名が出来上がります。

$(())の中で01とかでも足し算で2とかにしてくれるので一見これで良いような。

nを分けて、ファイル名にする方だけでprintfして02のような形も出来ますし、この場合はそれでもあまり変わらないのですが、場合によっては直接suffixとして変更していったほうがわかりやすいこともあるかと思います。

問題はnが8を超えた時、

#!/usr/bin/env bash

n=01
f1=file-$n
n=$(printf "%02d" $((n + 1)))
f2=file-$n
n=$(printf "%02d" $((n + 1)))
f3=file-$n
n=$(printf "%02d" $((n + 1)))
f4=file-$n
n=$(printf "%02d" $((n + 1)))
f5=file-$n
n=$(printf "%02d" $((n + 1)))
f6=file-$n
n=$(printf "%02d" $((n + 1)))
f7=file-$n
n=$(printf "%02d" $((n + 1)))
f8=file-$n
n=$(printf "%02d" $((n + 1)))
f9=file-$n
...

とすると、最後の足し算のところで、

08: value too great for base (error token is "08")

といったエラーが起こります。

これはnが08の時ですが、01 + 1というのは実は普通の1 + 1ではなくて、前者を8進数の1として解釈して10進数の1と足して10進数での2になってそれを表示しています。

01~07は10進数でも1~7になるので小さい数字だけでチェックすると問題を見落とします。

8進数なので9という数は存在せずエラーになります。

二重括弧での数字

他の言語とかでも0が0が先頭なら8進数、0xなら16進数、また、0bだと2進数とするものがあります。

Bashなどの(())の計算では、0から始まるものは8進数、0xなら16進数として扱われます。

$ echo $(( 011 ))
9
$ echo $(( 0x11 ))
17

加えて、64までであれば自由な数字で進数を作ることが出来ます。ベースとなる数字を#の前に書けば、

$ echo $(( 2#11 ))
3
$ echo $(( 7#1 ))
8
$ echo $(( 64#1 ))
65

といった感じに64進数まで使えます。

Shell Arithmetic (Bash Reference Manual)

64までは、0~9の数字、a~zで10~35、A~Zで36~61、残り@、_が62、63を表します。

$ echo $(( 64#Z ))
61
$ echo $(( 64#@ ))
62
$ echo $(( 64#_ ))
63

これらで使われる文字が表す数字がベースの数字以上になるとエラーになります。

$ echo $(( 63#_ ))
bash: 63#_: value too great for base (error token is "63#_")

exprでは単に無視する

シェルスクリプトで簡単に計算しようと思うとexprというコマンドがありますが、こちらでは08も8も同じように0がないものとして扱われます。

$ expr 08 + 1
9

単に左にある0を無視するだけなので、0xaのような16進数のようなものは使えません。

$ expr 0xa + 01
expr: non-integer argument

この辺ちゃんとそれぞれ分かっていれば良いのですが、書き換えとかで同じようにしてしまうと間違えてしまうかも。

このexprですが現在では ShellCheck とかで

^--^ SC2003 (style): expr is antiquated. Consider rewriting this using $((..)), ${} or [[ ]].

といった忠告を出すようになっていて二重括弧による計算が推奨されています。

ということで

#!/usr/bin/env bash

n=1
f1=file-$(printf "%02d" $n)
n=$((n + 1)))
f2=file-$(printf "%02d" $n)
n=$((n + 1)))
f3=file-$(printf "%02d" $n)
...

のように素直に数字は数字でインクリメントしてファイル名などに埋める時に0埋めするべきだと。