F# のパターンマッチでコマンドライン スイッチの判定を実装してみた

※本稿は F# Advent Calendar 2013 / 19日目の参加記事です。

お題

"Markdown Presenter" という HTML アプリを実行するための簡易 HTTP サーバーをコマンドラインから起動する仕組みを考案するにあたって、F# スクリプトでの実装を行ったことがある。

すなわち、次のようなコマンドラインインターフェースを考えた。

> httpd.fsx -root . -port 80

大体お察しいただけると思うが、

• -root スイッチに伴う引数が HTTP サーバーがコンテンツを返す起点のフォルダパス、
• -port スイッチに伴う引数が HTTP サーバーが着信を待ち受ける TCP ポート番号、

といった具合である。

いずれのスイッチも省略可能で、省略時は -root には . (カレントフォルダ)、-port には 80 を指定したのと同じ動作にする。

また、スイッチの指定順は問わない。
よって「http.fsx -port 80 -root .」でもOK。

さてこのような仕様のコマンドライン引数をどうやって解析するのがスマートか、というのが今回のお題。

まずは C# で書いてみる

C# だとどんな感じになるだろうか。

例えば、string[] args にコマンドライン引数が格納されているとして、string Root および int Port プロパティを持つ Param 型のオブジェクトを返す Parse メソッドを定義するという命題で考えてみる。

もちろん色々実装はあるだろう。
さらには、コマンドライン引数を解析する便利なクラスライブラリも多々出回っているので普通はそちらを活用することと思う。

そこを今回はあえて、標準のクラスライブラリだけという制約で試しに書いてみよう。
一例としては以下のような感じだろうか。

public class Param {

  public string Root { get; set; }

  public int Port { get; set; }  

}



public Param Parse(string[] args){

  var param = new Param{Root = ".", Port = 80};

  for (var i=0; i
    switch (args[i]) {

      case "-root": param.Root = args[i+1];

        i++;

        break;

      case "-port": param.Port = int.Parse(args[i+1]);

        i++;

        break;

      default:

        throw new Exception();

    }

  }

  return param;

}

C# に限らず、類似の手続き型言語だと同様の実装が書けることと思う。

しかしまぁ、難しい処理ではないが、雑然とした印象があり、可読性はあまり高くない感じがする。
さらにループ変数 i に 1 足して args を参照したり、はたまた、ループ中でループ変数 i をインクリメントして書き換えてしまうあたりが気持ち悪いなど、微妙な感じが否めない。

List<T> を使って、要素が空になるまでループ中で "pop" する実装にしたらもっとましになる気もした。

F# なら?

さておき。

さて、同様の処理を F# で書いてみよう。
F# にも for も switch も クラス もあるので、上記 C# コードと同じようにも書ける。
しかし折角なので、なるべく F# らしさを出せるように努めてみる。

自分の作例はこんな感じ。

type Param = {Root:string; Port:int}



let Parse  (args:string array) =

  let rec doParse param args =

    match args with

    | [] -> param

    | "-root" :: root :: tail -> doParse {param with Root = root} tail

    | "-port" :: port :: tail -> doParse {param with Port = int port} tail

    | _ -> failwith "Unknown command line arguments."

  doParse {Root="."; Port=80} (args |> Seq.toList)

いかがだろう、ずいぶんとすっきり記述できる。

それに、さすがに F# の文法が読めないとあれだが、読めるようになっていれば、こちらのほうがより宣言的になっているのではないだろうか。

解説

少し解説してみよう。

最初の1行は F# のレコード型を定義しているところ。

C# でいう、プロパティしかないような型を定義するのにすっきり記述できて便利。
(但し F# のレコード型もメソッドは持てたりはする。いっぽうで "不変性" という側面を持つのだがここでは割愛。)

続けて Parse 関数の構造だが、Parse 関数の内部のスコープでもうひとつの関数: doParse 関数を定義し、即座にデフォルト値とコマンドライン引数とを渡して呼び出している。

ということでいちばん大事なのは doParse 関数の仕組み。

doParse 関数は引数を2つとり、第1引数が Param型の値、第2引数が文字列のリストである。
(コマンドライン引数は文字列の "配列" というのが今回のお題における仕様なので、Parse 関数が doParse 関数を呼び出すときに、"配列" であるコマンドライン引数を "リスト" に変換してから渡している。)

そして doParse 関数は再帰関数であるため、rec キーワードが付いている。
(C# ではこんなキーワード付けずとも再帰呼び出し可能なので、F# は劣化してるんじゃなかという気もしたが、F# の特徴のひとつである強力な型推論を実現するため等々、しかるべき理由があってのことだそう。当たり前だけど。)

どんな風に再帰処理するのかというと、

1. 第2引数に渡された文字列のリストを先頭から順に "解析" し、
2. その解析 "外" の残りのリストをまた解析する、

という形で再帰による繰り返しになっている。

パターンマッチ

そしてその "解析" の正味がパターンマッチだ。

パターンマッチは超リッチな switch case のようでもある。
ただし、C# の switch case よりも、場合分けの定義が柔軟かつ直感的であり、しかも、単に "場合分け" するのではない。

"場合" の判定とともに、
変数への "割り当て"(束縛。bind。) も行われる
のだ。

F# のデータ構造 "リスト"

ここで F# のリストについて少し知っておく必要がある。

F# におけるリスト(今回は文字列のリスト)を即値で書くと次のような感じ。

let l = ["-root"; "/sub"; "-port"; "81"]

ここで、変数への代入(正確には束縛)時に、リストの先頭要素と残りの要素に分解して、2つの変数にいっきに束縛できるのだ。
次のように :: 演算子を使う。

let h::t = ["-root"; "./sub"; "-port"; "81"]

こうすると、変数 h は文字列 "-root" が、変数 t にはリスト ["./sub"; "-port"; "81"] が束縛されるのだ。

さらにこう書くとどうなるか?

let h::(h2::t) = ["-root"; "./sub"; "-port"; "81"]

まず変数 h には、相変わらず文字列 "-root" が束縛される。

しかし先と異なり、残りのリストに対してさらに :: 演算子によって分割するので、

• 変数 h2 に "./sub" が束縛され、
• 変数 t にはリスト ["-port"; "81"] が束縛

される。

この要領でコマンドライン引数を解析できるわけだ。

ここまでわかってくると、パターンマッチのパターンの記述、

| "-root" :: root :: tail -> (処理)

が、

• リストの先頭要素が "-root" で、
• かつ、次に何かの要素が続き (そしてその要素は変数 root に束縛!)、
• かつ、リストの残りがある場合※

という場合にマッチすることがわかり、コマンドラインスイッチの引数は変数 root で取り出せて、さらに残りのリスト tail に対して引き続き再帰によって処理を継続できるのがわかると思う。

※残りといっても、これでちょうど何も要素が続かない場合は空リスト [] が返る。

まとめ

このように F# のパターンマッチを使うと、可読性が高い表現で、すっきりと、コマンドライン引数の解析が実装できるのがわかると思う。

パターンマッチの使いどころは、今回の例のように、ただの場合分けではなく、
場合分けと同時に変数束縛も行ってしまう
ところにも醍醐味があるように思う。


C# 版も F# 版も、もっといろんな書き方があるとは思うが、今回はコマンドライン引数の解析処理をとおして、F# のパターンマッチの強力さをあらためて感じたので、そのご紹介まで。

もちろん、このテーマからスピンアウトして、いろんな言語のいろんな書き方の作例をお知らせいただけると楽しいかもしれない。