Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Go to file
 
 
Cannot retrieve contributors at this time

One header file Commandline Parse for C++11

[ Japanese (日本語) / English ]

https://github.com/trueroad/cmdlineparse

Commandline Parse C++11 用のコマンドラインパーサ (コマンドラインオプション解析器)です。 ヘッダファイル一つだけでできていますので、簡単に使えます。

サンプルをビルドする

サンプルをビルドする方法には 2 通りあります。

手動コンパイル

サンプルは下記のようなコマンドでビルドできます。 環境によっては異なるコマンドやオプションが必要になる場合があります。

シンプルなサンプル

$ g++ -std=c++11 -o simple-sample simple-sample.cc

高度なサンプル

$ g++ -std=c++11 -o advanced-sample advanced-sample.cc

国際化サンプル

国際化サンプルには gettext が必要です。

$ g++ -std=c++11 -o i18n-sample -DENABLE_NLS -DLOCALEDIR="\".\"" -DPACKAGE="\"cmdlineparse\"" i18n-sample.cc -lintl
$ mkdir -p ja/LC_MESSAGES
$ msgfmt -o ja/LC_MESSAGES/cmdlineparse.mo po/ja.po

Autotools

Commandline Parse そのものは Autotools 不要ですが、 Autotools を使うと以下のコマンドで簡単にビルドできます。

$ ./autogen.sh
$ ./configure
$ make

国際化サンプルを試してみたい場合には、 以下のようなコマンドが便利かもしれません。

$ ./autogen.sh
$ ./configure --prefix /path/to/mo/install/directory
$ make
$ make -C po install

使い方

シンプルなサンプル

以下は simple-sample.cc からの抜粋です。

#include <iostream>
#include "cmdlineparse.hh"

int main (int argc, char *argv[])
{
  // Prepare parser instance
  cmdlineparse::parser cmd;

  // Prepare variable to store the parse result
  std::string str;
  bool flag;

  // Set version string for `--help' and `--version' etc.
  cmd.set_version_string (
"One header file Commandline Parse for C++11: Simple Sample\n"
"Copyright (C) 2016 Masamichi Hosoda. All rights reserved.\n"
                          );

  // Add `--help' and `--version' options
  cmd.add_default ();

  // Add a string option
  //   1st arg: short option name
  //   2nd arg: long option name
  //   3rd arg: a pointer to store the parse result
  //   4th arg: default value
  //   5th arg: description for `--help'
  //            Four spaces indent is recommended.
  cmd.add_string ('s', "string", &str, "foobar",
                  "    Specify string option.");

  // Add a flag option
  //   1st arg: short option name
  //   2nd arg: long option name
  //   3rd arg: pointer to store the parse result
  //   4th arg: description for `--help'
  //            This parser doesn't warp text automatically.
  //            Four spaces indent is recommended.
  cmd.add_flag ('f', "flag", &flag,
                "    This is a flag.\n"
                "    Second line.\n"
                "    This parser doesn't warp text automatically.");

  // Parse
  if (!cmd.parse (argc, argv))
    return 0;

  // Output results
  std::cout << "string option = \"" << str << "\"" << std::endl;
  std::cout << "flag = " << ( flag ? "true" : "false" ) << std::endl;

  return 0;
}

以下、いくつかの出力例です。

短いオプション -h は help を表示して終了します。

$ ./simple-sample -h
One header file Commandline Parse for C++11: Simple Sample
Copyright (C) 2016 Masamichi Hosoda. All rights reserved.

Usage: ./simple-sample [options] ...

  -h, --help
    Print help and exit
  -V, --version
    Print version and exit
  -s, --string=STRING   (default=foobar)
    Specify string option.
  -f, --flag
    This is a flag.
    Second line.
    This parser doesn't warp text automatically.

何もオプションを付けないとデフォルトになります。

$ ./simple-sample
string option = "foobar"
flag = false

文字列 (string) オプションを使うと、指定した変数に値が設定されます。 -s baz, -sbaz, --string baz, --string=baz のいずれのスタイルでも同じ結果となります。

$ ./simple-sample -s baz
string option = "baz"
flag = false

フラグ (flag) オプションを使うと、指定したフラグが true になります。 -f, --flag いずれのスタイルでも同じ結果となります。

$ ./simple-sample -f
string option = "foobar"
flag = true

以下、複数のオプションを組み合わせた場合の例です。

$ ./simple-sample --string=baz -f
string option = "baz"
flag = true

以下、もう一つの組み合わせの例です。

$ ./simple-sample -fsbaz
string option = "baz"
flag = true

文字列 (string) オプションには引数が必要です。

$ ./simple-sample -s
./simple-sample: option requires an argument -- s

フラグ (flag) オプションは引数を使えません。

$ ./simple-sample --flag=baz
./simple-sample: option doesn't take an argument -- flag

一部省略した長いオプションが使えます。

$ ./simple-sample --fl --str=baz
string option = "baz"
flag = true

高度なサンプル

高度なサンプルは advanced-sample.cc にあります。 以下、出力の例です。

$ ./advanced-sample --help
One header file Commandline Parse for C++11 2016-09-29.21
Copyright (C) 2016 Masamichi Hosoda. All rights reserved.
License: BSD-2-Clause

https://github.com/trueroad/cmdlineparse/

Usage: ./advanced-sample [options] [FILES] ...

  -h, --help
    Print help and exit
  -V, --version
    Print version and exit
  -s, --string=STRING   (default=foo)
    Specify string option.
  -f, --flag
    This is a flag.
    Second line.
    This parser doesn't warp text automatically.
  -H, --handler[=OPTION]
    This is option handler
Description only
  description only

Group1:
  -tFILENAME   (default=bar)
    Specify string option 2.
  --flag-another
    This is a flag 2.
  -F, --callback-func=OPTARG   (OPTARG is required)
    This is callback hander
  Description 2
    description only 2 - first line
    description only 2 - second line

Group2:
  -a, --abort=FLAG   (possible value=true, false)
    This option aborts parsing
    If FLAG=true, abort parsing
Abort reason is option_handler -- help

国際化サンプル

国際化サンプルは i18n-sample.cc にあります。 以下、出力の例です。

$ LANG=ja_JP.UTF-8 ./i18n-sample -h
One header file Commandline Parse for C++11: i18n Sample
Copyright (C) 2016 Masamichi Hosoda. All rights reserved.

使い方: ./i18n-sample [オプション] ...

  -h, --help
    ヘルプを表示して終了
  -V, --version
    バージョンを表示して終了
  -s, --string=STRING   (デフォルト=foobar)
    文字列オプションを指定.
  -f, --flag
    これはフラグです.
    二行目.
    このパーサは自動改行しません.

$ LANG=C ./i18n-sample -h
One header file Commandline Parse for C++11: i18n Sample
Copyright (C) 2016 Masamichi Hosoda. All rights reserved.

Usage: ./i18n-sample [options] ...

  -h, --help
    Print help and exit
  -V, --version
    Print version and exit
  -s, --string=STRING   (default=foobar)
    Specify string option.
  -f, --flag
    This is a flag.
    Second line.
    This parser doesn't warp text automatically.

定義

オプションを追加する

オプションハンドラの追加

bool add_handler (char short_name,
                  const std::string &long_name,
                  arg_mode has_arg,
                  std::function<bool(const std::string&)> option_handler,
                  const std::string &description = "",
                  const std::string &typestr = "",
                  const std::string &header = "",
                  const std::string &group = "");

オプションハンドラを追加します。

  • パラメータ:
    • short_name: 短いオプション。0 の場合は短いオプション無しとなります。
    • long_name: 長いオプション。空の場合は長いオプション無しとなります。
    • has_arg: getopt_long () と同様の下記 3 種類のいずれか。
      • no_argument: オプションは引数を取らない。
      • required_argument: オプションは引数が必須。
      • optional_argument: オプションは引数があってもなくてもよい。
    • option_handler: オプションハンドラ。 パーサがオプションを見つけたら呼び出されます。 ハンドラのパラメータはオプションの引数または空です。 ハンドラが false を返した場合、パースは中断されます。
    • description: オプションの説明本文。 help メッセージに追加されます。 UTF-8 等のマルチバイト文字列の場合に困難となるため、 自動改行や自動インデントされません。
    • typestr: 引数の type string。 help メッセージに追加されます。
    • header: オプションの説明ヘッダ。 help メッセージに追加されます。
    • group: オプショングループの名前。 help メッセージのグループに使われます。
  • 返り値:
    • true: 追加完了。
    • false: オプション名は既に登録されています。なにも変更しませんでした。

フラグ (flag) オプションの追加

bool add_flag (char short_name,
               const std::string &long_name,
               bool *flag,
               const std::string &description = "",
               const std::string &group = "");

フラグ (flag) オプションを追加します。

  • パラメータ:
    • flag: フラグへのポインタ。以下のいずれかがセットされます。
      • true: このオプションが指定されました。
      • false: このオプションは指定されませんでした。
    • 他のパラメータは add_handler () と同じです。
  • 返り値:
    • 返り値は add_handler () と同じです。

文字列 (string) オプションの追加

bool add_string (char short_name,
                 const std::string &long_name,
                 std::string *var,
                 const std::string &defval,
                 const std::string &description = "",
                 const std::string &typestr = "STRING",
                 const std::string &group = "");

文字列 (string) オプションを追加します。

  • パラメータ:
    • var: 文字列へのポインタ。 このオプションが指定された時には、その引数が var にセットされます。
    • defval: デフォルト値。 このオプションが指定されなかった時には、この値が var にセットされます。
    • 他のパラメータは add_handler () と同じです。
  • 返り値:
    • 返り値は add_handler () と同じです。

help 説明文の追加

void add_description (char short_name,
                      const std::string &long_name,
                      arg_mode has_arg,
                      const std::string &description,
                      const std::string &typestr = "",
                      const std::string &header = "",
                      const std::string &group = "");

help 説明文を追加します。 説明文の追加のみです。 パーサの動作は変更されません。

  • パラメータ:
    • 全てのパラメータは add_handler () と同じです。

デフォルトハンドラの追加

help
bool add_default_help (void);

デフォルトの help オプションハンドラを追加します。 -h, --help オプションが追加されます。

  • 返り値:
    • 返り値は add_handler () と同じです。
version
bool add_default_version (void);

デフォルトの version オプションハンドラを追加します。 -V, --version オプションが追加されます。

  • 返り値:
    • 返り値は add_handler () と同じです。
help と version
bool add_default (void);

デフォルトのオプションハンドラを追加します。 -h, --help, -V, --version オプションが追加されます。

  • 返り値:
    • 返り値は add_handler () と同じです。

パース

オプションをパース

bool parse (int argc, char const* const* argv, int optind = 1);

オプションをパースします。

  • パラメータ:
    • argc, argv: main () の引数。
    • optind: パースする最初の引数のインデックス。
  • 返り値:
    • true: パース成功。 get_unamed_args () が使えるようになります。
    • false: パース中断。 get_abort_reason ()get_abort_option () が使えるようになります。

unamed_args 取得

const std::vector<std::string> &get_unamed_args () const noexcept;

無名の引数(追加のオプション)を取得します。 この関数はパースが成功した後で使うことができます。

中断理由の取得

abort_reason get_abort_reason () const noexcept;

中断理由を取得します。 この関数はパースが中断した後で使うことができます。

中断したときのオプションを取得

const std::string &get_abort_option () const noexcept;

中断したときのオプションを取得します。 この関数はパースが中断した後で使うことができます。

文字列の構築/取得

デフォルト文字列の取得

使い方 (usage)
std::string build_usage (void) const;

使い方 (usage) 文字列を構築します。 カスタムのヘルプハンドラ等に使うことができます。

help
std::string build_help (void) const;

help 文字列を構築します。 カスタムのヘルプハンドラ等に使うことができます。

version
const std::string &get_version_string () const noexcept;

バージョン文字列を取得します。 カスタムのバージョンハンドラ等に使うことができます。

カスタマイズ

デフォルト文字列の変更

version 文字列
void set_version_string (const std::string &s);

バージョン文字列を設定します。 get_version_string (), build_help () とデフォルトのオプションハンドラがこの文字列を使います。

この関数を使わなかった場合は、デフォルトの文字列が使われます。 Autotools を使っている場合は、マクロでデフォルト文字列が設定されます。 Autotools を使っていない場合は、argv[0] が使われます。

usage_unamed_opts 文字列
void set_usage_unamed_opts (const std::string &s);

usage_unamed_opts 文字列を設定します。 build_usage (), build_help () とデフォルトのヘルプハンドラがこの文字列を使います。

デフォルトの動作を変更

opterr
void set_opterr (bool flag) noexcept;
  • true (default): パーサはエラーが発生したら標準エラー出力へエラーメッセージを出力します。
  • false: パーサはエラーが発生しても何も出力しません。
long_only
void set_long_only (bool flag) noexcept;
  • true: getopt_long_only () のような動作になります。 つまり、ハイフン一つの長い名前のオプション(たとえば -long_option) が使えるようになります。
  • false (default): getopt_long () のような動作になります。 つまり、長いオプションはハイフン二つが必須(たとえば --long_option) となります。
continue_on_error
void set_continue_on_error (bool flag) noexcept;
  • true: エラーが発生してもパースを続けます。
  • false (default): エラーが発生したらパースを中断します。
abbreviated_long_name
void set_abbreviated_long_name (bool flag) noexcept;
  • true (default): 一部省略した長いオプションが使えます。
  • false: 長いオプションは完全一致する必要があります。

License

Copyright (C) 2016, 2017, 2019 Masamichi Hosoda. All rights reserved.

License: BSD-2-Clause

LICENSE をご覧ください。

もし GPL が良い場合には、 Extract PDFmark に GPL 版の Commandline Parse があります。