Command Line Parser Libraryを使ってコマンドライン引数を解析する1 †
アプリケーションを起動する時に指定されたコマンドライン引数は、「起動時のコマンドライン引数を取得する」で紹介しているように、System.Environment.CommandLineプロパティやGetCommandLineArgsメソッド、あるいはMainメソッドのパラメータを使って取得することができます。これで十分という場合も多いですが、コマンドライン引数によるオプションが複雑な場合は、どのようなオプションが指定されたかという解析がとても面倒です。
コマンドライン引数を解析するためのフリーのクラスやライブラリは色々あるようですが、ここでは「Command Line Parser Library」（バージョン1.9.71.2）を使ってみます。Command Line Parser LibraryはMITライセンスで、.NET Framework 3.5以降、あるいはMono Profile 2.1以降で使えます。
Command Line Parser Libraryをインストールする †
NuGetを使った方法 †
Command Line Parser LibraryはNuGetを使ってインストールすることができます。Visual Studio 2012ではデフォルトでNuGetがインストールされていると思います。Visual Studio 2010では、拡張機能マネージャー（メニューの[ツール]-[拡張機能マネージャー]）を使ってインストールできます（詳しくは、「NuGet - NuGet でプロジェクト ライブラリを管理する」等を参考にしてください）。
もしVisual Studio 2010未満でNuGetがインストールできないのであれば、「NuGet.exe Command Line bootstrapper」を使う方法もあります。
Visual Studio 2010以上でNuGetがインストールされているならば、次のような手順でCommand Line Parser Libraryをインストールできます。
- Command Line Parser Libraryを使用するプロジェクトをVisual Studioで開きます。
- メニューの[ツール]-[プロジェクト]-[NuGetパッケージの管理]を選択して、ダイアログを表示します。
- ダイアログの左側で「オンライン」を選択し、右上の「オンラインの検索」欄に「Command Line Parser Library」と入力して検索します。すると、「Command Line Parser Library」が見つかるはずです。
- 見つかった「Command Line Parser Library」を選択して、「インストール」ボタンを押すと、プロジェクトに「Command Line Parser Library」がインストールされ、参照設定に「CommandLine」が追加されます。
このようなダイアログを使わずに、パッケージマネージャーコンソールを使ってインストールすることもできます。この場合は、メニューの[ツール]-[ライブラリパッケージマネージャー]-[パッケージマネージャーコンソール]を選択してパッケージマネージャーコンソールを表示して、以下のように入力すると（「Install-Package」以降）、Command Line Parser Libraryがインストールされます。
PM> Install-Package CommandLineParser
バイナリをダウンロードする方法 †
NuGetを使わずに、バイナリを直接ダウンロードしてインストールする昔ながらの方法も有効です。「Command Line Parser Library」からZIPファイルをダウンロードすると、ZIPファイル内の「CommandLine\src\libcmdline\bin\Release」ディレクトリに「CommandLine.dll」と「CommandLine.XML」がありますので、「CommandLine.dll」をプロジェクトの参照設定に追加してください。（方法が分からない方は、「「○○○.dllを参照に追加します」の意味は？」をご覧ください。）
Command Line Parser Libraryが解析できるコマンドライン引数 †
Command Line Parser Libraryが解析できるコマンドライン引数はUNIX風のもので、オプション名の前にダッシュかハイフンが付いたものです。Windowsでお馴染みのスラッシュ(/)ではありません。
例えば、
-o test.txt -v
というコマンドライン引数を解析することはできますが、
/o test.txt /v
というものは解析できません。
簡単な使い方 †
それでは早速使ってみましょう。
ここでは、"o"と"v"2つのオプションを定義することで、例えば
-o test.txt -v
というコマンドライン引数を、
「"o"オプションには"test.txt"が指定されていて、"v"オプションも指定されている」
と解析できるようにします。
まずコンソールアプリケーションのプロジェクトを作成して、上記の方法で「Command Line Parser Library」を参照設定に追加しておきます。そして、次のようなクラスを作成します。
1
2
3
4
5
6
7
8
9
10
| | Public Class Options
<CommandLine.Option("o"c)> _
Public Property OutputFile As String
<CommandLine.Option("v"c)> _
Public Property Overwrite As Boolean
End Class
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| | public class Options
{
[CommandLine.Option('o')]
public string OutputFile
{
get;
set;
}
[CommandLine.Option('v')]
public bool Overwrite
{
get;
set;
}
}
|
このクラスにはOption属性が適用されたプロパティが2つありますが、これらのプロパティにコマンドライン引数の解析結果が入ります。"o"オプションで指定された値がOutputFileプロパティに、"v"オプションで指定された値がOverwriteプロパティに格納されます（OverwriteプロパティはBoolean型ですので、"v"が指定されていればTrue、指定されていなければFalseになります）。
| 補足 |
プロパティには、GetとSetの両方が必要です。Getだけではエラーになります。
|
次に、解析結果を取得するためのコードを記述します。これは、エントリポイントに記述します。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
| | Module Module1
Sub Main(args As String())
Dim opts = New Options()
Dim isSuccess As Boolean = _
CommandLine.Parser.Default.ParseArguments(args, opts)
If isSuccess Then
Console.WriteLine("OutputFile: {0}", opts.OutputFile)
Console.WriteLine("Overwrite: {0}", opts.Overwrite)
Else
Console.WriteLine("コマンドライン引数の解析に失敗")
End If
Console.ReadLine()
End Sub
End Module
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
| | public class Program
{
static void Main(string[] args)
{
var opts = new Options();
bool isSuccess = CommandLine.Parser.Default.ParseArguments(args, opts);
if (isSuccess)
{
Console.WriteLine("OutputFile: {0}", opts.OutputFile);
Console.WriteLine("Overwrite: {0}", opts.Overwrite);
}
else
{
Console.WriteLine("コマンドライン引数の解析に失敗");
}
Console.ReadLine();
}
}
|
ParseArgumentsメソッドに、Mainメソッドのパラメータであるargsと、Optionsオブジェクトを渡すと、このOptionsオブジェクトに解析結果が入ります。
はじめに示した
-o test.txt -v
というコマンドライン引数でこのアプリケーションを起動した時、OptionsオブジェクトのOutputFileプロパティが"test.txt"、OverwriteプロパティがTrueになります。
コマンドライン引数に何も指定されなかった場合は、OutputFileプロパティはnull（VB.NETでは、Nothing）、OverwriteプロパティはFalseになります。（この規定値を変更する方法は、後述します。）
| 補足 |
Visual Studioのデバッグでコマンドライン引数を指定してプロジェクトを実行するには、プロジェクトのプロパティを開き（ソリューションエクスプローラーでプロジェクトを右クリックしてコンテキストメニューを表示し、[プロパティ]を選択する）、「デバッグ」タブにある「コマンドライン引数」の欄にコマンドライン引数を入力します。
|
ParseArgumentsメソッドがFalseを返した時は、解析に失敗した時です。解析に失敗するのは、存在しないオプションが含まれていたり、必須のオプション（後述します）が見つからなかったり、指定されたオプションがプロパティの型に変換できなかったり、排他的なオプション（後述します）が指定されている場合などです。ただしParseArgumentsメソッドがFalseを返したとしても、大抵の場合は解析できた結果がOptionsオブジェクトに格納されています。
長いコマンドラインオプション名 †
上記の例ではオプション名が一文字（Char型）でしたが、2文字以上の長い名前を短い名前と同時に（あるいは単独で）指定することもできます。
次のようにOptionsクラスを変更すると、長い名前を使えるようになります。
1
2
3
4
5
6
7
8
9
10
| | Public Class Options
<CommandLine.Option("o"c, "output")> _
Public Property OutputFile As String
<CommandLine.Option("overwrite")> _
Public Property Overwrite As Boolean
End Class
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| | public class Options
{
[CommandLine.Option('o', "output")]
public string OutputFile
{
get;
set;
}
[CommandLine.Option("overwrite")]
public bool Overwrite
{
get;
set;
}
}
|
| 補足 |
短い名前はChar型、長い名前はString型で指定しますが、1文字のString型のみを指定した場合は、短い名前と解釈されるようです。
|
| 補足 |
長い名前にはダッシュやハイフンを含めることもできます。半角スペースや"="は含めることができません。短い名前にはハイフンやダッシュ、それに数字を指定できませんが、アルファベット以外の様々な記号を指定することができます。短い名前と長い名前の双方に日本語が使用できましたが、すべての環境で有効かは分かりません。
|
長いオプション名をコマンドライン引数に使う場合は、オプション名の前にダッシュ（あるいはハイフン）を2つ付けます。
--output "C:\My Documents\test.txt" --overwrite
上記の例では、OutputFileは短い名前も有効ですので、次のように短い名前を使うこともできます。
-o "C:\My Documents\test.txt" --overwrite
長いオプション名を使った場合は、オプション名と値の区切り文字に"="を使うこともできます。
--output="C:\My Documents\test.txt" --overwrite
| 補足 |
短い名前の前にもダッシュ（あるいはハイフン）を2つ付けることができます。この時、オプション名と値の区切り文字に"="を使うこともできます。
|
ちなみに短い名前も長い名前も付けられていないプロパティは、そのプロパティ名がそのままオプションの長い名前になります。
1
2
3
4
5
6
| | Public Class Options
<CommandLine.Option> _
Public Property OutputFile As String
End Class
|
1
2
3
4
5
6
7
8
9
10
11
| | public class Options
{
[CommandLine.Option()]
public string OutputFile
{
get;
set;
}
}
|
コマンドライン引数の書き方 †
繰り返しになりますが、Command Line Parser Libraryが解析できるコマンドライン引数はダッシュかハイフンを使ったUNIX風のもので、Windowsのようなスラッシュは使えません。
コマンドは、まとめて記述することができます。例えば、
-vo test.txt
としたり、
-votest.txt
としたりすることもできます。
| 補足 |
同じコマンドが2回記述された時は、後で記述されたものが優先されるようです。
|
必須のオプションを指定する †
必ずなければならない必須のオプションは、Option属性のRequiredプロパティをTrueにします。必須のオプションがコマンドライン引数になかった場合は、ParseArgumentsメソッドがFalseを返します。
以下の例では、OutputFileを必須のオプションにしています。
1
2
3
4
5
6
| | Public Class Options
<CommandLine.Option("o"c, "output", Required:=True)> _
Public Property OutputFile As String
End Class
|
1
2
3
4
5
6
7
8
9
10
11
| | public class Options
{
[CommandLine.Option('o', "output", Required=true)]
public string OutputFile
{
get;
set;
}
}
|
既定値を指定する †
オプションが指定されていなかった時の既定値を指定するには、DefaultValueプロパティを使います。
以下の例では、OutputFileの既定値を"test.txt"にしています。
1
2
3
4
5
6
| | Public Class Options
<CommandLine.Option("o"c, DefaultValue:="test.txt")> _
Public Property OutputFile As String
End Class
|
1
2
3
4
5
6
7
8
9
10
11
| | public class Options
{
[CommandLine.Option('o', DefaultValue="test.txt")]
public string OutputFile
{
get;
set;
}
}
|
数値型や列挙型のオプション †
上記の例ではオプションは文字列と論理値でしたが、数値や列挙型でも大丈夫です。Null許容型でもOKです。
以下に、整数型、Null許容型、列挙型のオプションの例を示します。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
| | Public Enum FileType
Text
Html
Xml
End Enum
Public Class Options
<CommandLine.Option("s"c)> _
Public Property Size As Integer
<CommandLine.Option("c"c)> _
Public Property Score As System.Nullable(Of Double)
<CommandLine.Option("t"c)> _
Public Property FileType As FileType
End Class
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
| | public enum FileType
{
Text,
Html,
Xml
}
public class Options
{
[CommandLine.Option('s')]
public int Size
{
get;
set;
}
[CommandLine.Option('c')]
public double? Score
{
get;
set;
}
[CommandLine.Option('t')]
public FileType FileType
{
get;
set;
}
}
|
列挙型のオプションの場合、コマンドライン引数でその値を指定するには、その要素の名前を使用します。大文字と小文字の区別はしません。
上記のクラスで正しく解析されるコマンドライン引数の例を示します。
-s 100 -c 1E3 -t text
オプションで指定された文字列がそれに対応するプロパティの型に変換できない場合は、ParseArgumentsメソッドがFalseを返します。
オプションが数値型の場合、指定された文字列が数値型に変換できるかはカルチャによって変わるかもしれませんが、上記のようにParser.Defaultを使った解析ではインバリアントカルチャが使われます。これを変える方法は、次回紹介する予定です。
配列やリストのオプション †
配列やリストのオプションも可能です。この場合は、Option属性の代わりに、OptionArrayとOptionList属性を使用します。
以下に、配列とリストのオプションの例を示します。
1
2
3
4
5
6
7
8
9
10
| | Public Class Options
<CommandLine.OptionArray("n"c)> _
Public Property Numbers As Integer()
<CommandLine.OptionList("f"c, "files")> _
Public Property Files As IList(Of String)
End Class
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| | public class Options
{
[CommandLine.OptionArray('n')]
public int[] Numbers
{
get;
set;
}
[CommandLine.OptionList('f', "files")]
public IList<string> Files
{
get;
set;
}
}
|
| 注意 |
OptionList属性を適用する場合は、短い名前と長い名前の両方を指定しないと、値を正常に取得できませんでした。
|
解析可能なコマンドライン引数は、例えば以下のようなものです。リストは、デフォルトでは、コロン（:）で区切ります。
-n 1 5 7 -f 1.txt:2.txt:3.txt
リストの区切り文字を変更するには、Separatorプロパティを使います。例えばコンマ（,）にするには、以下のようにします。
1
2
| | <CommandLine.OptionList("f"c, "files", Separator:=","c)> _
Public Property Files As IList(Of String)
|
1
2
3
4
5
6
| | [CommandLine.OptionList('f', "files", Separator=',')]
public IList<string> Files
{
get;
set;
}
|
オプション名のないリストを取得する †
例えばコマンドライン引数が
1.txt 2.txt 3.txt
のようにオプション名が付いていない場合でも、その値をリストとして取得することができます。これにはValueList属性を使います。
1
2
3
4
5
6
7
8
9
10
| | Public Class Options
<CommandLine.Option("o"c, "output")> _
Public Property OutputFile As String
<CommandLine.ValueList(GetType(List(Of String)))> _
Public Property InputFiles As IList(Of String)
End Class
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
| | public class Options
{
[CommandLine.Option('o', "output")]
public string OutputFile
{
get;
set;
}
[CommandLine.ValueList(typeof(List<string>))]
public IList<string> InputFiles
{
get;
set;
}
}
|
例えばコマンドライン引数が
-o test.txt 1.txt 2.txt 3.txt
だった場合、InputFilesプロパティには、"1.txt"、"2.txt"、"3.txt"の3つの文字列が入ります。
1.txt -o test.txt 2.txt 3.txt
のように順番が変わっても同じです。
| 補足 |
コマンドライン引数に不明なオプション（文字列の先頭にダッシュやハイフンが付いていて、Option属性でオプション名として定義されていないもの）が含まれている場合、この不明なオプションをValueList属性で取得することができません。
|
ValueList属性は、MaximumElementsプロパティによって、最大の要素数を指定することもできます。例えば上記のInputFilesプロパティを以下のようにしてMaximumElementsプロパティを1にしてみましょう。
1
2
3
| | <CommandLine.ValueList(GetType(List(Of String)), MaximumElements:=1)> _
Public Property InputFiles As IList(Of String)
|
1
2
3
4
5
6
7
| | [CommandLine.ValueList(typeof(List<string>), MaximumElements=1)]
public IList<string> InputFiles
{
get;
set;
}
|
この状態でコマンドライン引数を
-o test.txt 1.txt 2.txt 3.txt
とすると、ParseArgumentsメソッドがFalseを返し、InputFilesプロパティは"1.txt"だけになります。
次回予告 †
まだまだ紹介したい機能がありますが、今回はこれまでとさせてください。次回は、大文字と小文字を区別する方法や、同時に指定できないオプションを設定する方法、ヘルプやエラーを表示する方法などを紹介させていただく予定です。
コメント †
