なぜ空(無名)ハッシュを返すのか

XML::Simpleの扱いではまる。

例えばこういうXMLの場合、

そしてこういう場合、

さらにこういう場合、

これら３パターンではXML::Simpleをデフォルトで使った場合、
返ってくるハッシュ構造が異なってしまう。
手早くコードを書こうとすると、手元にあるサンプルのXML構造だけを想定して、
変数の取り出しなどの手順を書くので、
別のXMLがきた場合、変数が取り出せなくなったりする。

それを回避するために、オプションがあるのだが、
それですべての問題を回避できるかというと、
多分できないと思う。
XML::Simpleを使うことで開発スピードはあがるが、
パースの汎用性は当然落ちるし、それによってプログラムが止まる可能性も高まる。
止まらないプログラムを書くには、
いろいろな状況を想定して条件分岐を書くしかないが、
それだと結局開発スピードが落ちて、
自分でパーサを書いた方が早かったということになるかもしれない。

今回はまあ、XML::Simpleですませてしまった。
このページを参考にさせていただいた。
Perl モジュール XML::Simple の使い方 - ミヤビッチの穴

今回はこんな感じでオプション指定した。

「SuppressEmpty => undef」は要素がなかったときに、空のハッシュを返すのではなく
undefを返せという意味。

「keyattr => [ 'name', 'key']」はnameとkeyがあったらそれはハッシュのkeyにしろという意味。
デフォルトだとこれに ' id ' も含まれているので、
それを除外した感じ。

「forcearray => 0」は要素の数に関わらず毎回必ず無名配列を作ってその要素として
ハッシュを格納する　というのを"しない"という処理。
これはデフォルトで0なのであえて指定する必要はなかったと言える。

それで、まあうまくいっていそうなんだけれども、
疑問に思ったのが、なんでデフォルトだと要素が空だった場合に空(無名)ハッシュ（ {} ）を
返す仕様になっているのかという点。

返ってきた値が空だったらこれこれの挙動をせよ、とプログラムを書こうとしても

とやるだけでは値が空でも空ハッシュが返ってきてしまうせいで真と判定されてしまう。
わざわざ

と書かないといけない。
手間としてはちょっとしたものだけれども、
どことなく直感的ではないので、ついついミスしてしまう。

まあそれはそれで、やりずらいなあと思いながらコードを書いていたのだが、
あるとき、なぜ空ハッシュになっているのかがわかった。

基本的に、XML::Simpleにパースさせたら、
返ってくるのはハッシュの配列のハッシュのハッシュの配列のハッシュの・・・・という具合に、
気の遠くなるほど複雑な無名ハッシュと無名配列と変数の入り乱れる構造が
返ってくる。

深い深いハッシュ・配列構造をしているので、
その構造を操作するさいは、常に変数（スカラー値）を取得したりセットしたりするだけでなく、
その複雑ハッシュ構造の一部のハッシュ構造を取ってきてどうのこうのという
操作をすることが頻繁に起こる。

そうすると、コードの中ではハッシュのリファレンスがあっちにいったり
こっちにいったりするようになる。
飛んできた部分ハッシュから変数を取り出したり、
そこからまた部分ハッシュを取り出したり。

送られてくるのはハッシュのリファレンスであることを想定しているので、
来た変数がハッシュどうか、リファレンスかどうかのチェックなどすることなしに、
それを操作しようとする。

それこそが、XMLの要素が空だった場合にundefとか文字のない文字列とかを返すのではなく、
無名ハッシュを返す理由なのである。

いつもハッシュが来ると思っているので
「undef」とか「0」とか「''」（文字のない文字列）が来たりすると
それにたいしてハッシュ値を取り出そうという操作をした結果、

というエラーが起こることになる。
ここで問題なのはこれはプログラムが止まってしまうエラーだということ。

もし、例え空っぽであってもハッシュが返ってくれば、
それはundefを返すだけなのでプログラムは止まらない。

ややこしいかもしれないので、くどいけど繰り返すと、

・スカラーに対してハッシュの値を取り出す操作をするとプログラムは止まる
・空っぽでもそれが(無名)ハッシュならundefを返すだけでプログラムは止まらずに済む

ということ。

プログラムが止まるか止まらないかというのは大きな差で、
止まらない方が当然ロバストなシステムとなり
使い勝手が雲泥の差となる。

だから、XML::Simpleは空の無名ハッシュを返すのだろう、
ということを考えた。