view/common/FileToArgs.h

#ifndef FILE_TO_ARGS_H
#define FILE_TO_ARGS_H

/*!
  \page file_to_args_page デフォルト引数の読み出し

  関数 optionHandler(argc, argv) があったときに、ファイルに記述したデフォルト設定を処理させるための仕組み。ファイルの記述を元に、argc, argv を生成する。

  - \ref file_to_args_section_sample
  - \ref file_to_args_section_usage

  \n
  \section file_to_args_section_sample ビーゴ用の設定ファイル例
  \include beegoconf

  \n
  \section file_to_args_section_usage 使用例

  サンプルプログラム
\code
#include <iostream>
#include <string>

static std::string SerialPort = "/dev/ttyUSB0";

static void optionHandler(int argc, char *argv[]) {
  for (int i = 1; i < argc; ++i) {
    if (! strncmp("--port=", argv[i], 7)) {
      SerialPort = &argv[i][7];
    }
  }
}

int main(int argc, char *argv[]) {

  FileToArgs fileArgs;
  if (fileArgs.load("configfile.txt")) {
    optionHandler(fileArgs.argc, fileArgs.argv, argv[0]);
  }
  optionHandler(argc, argv);

  std::cout << "serial port: " << SerialPort << std::endl;

  return 0;
}
\endcode

  設定ファイルの詳細説明
\verbatim
# デフォルト設定
--port=/dev/usb/ttyUSB0

# programName が sloader のとき有効。--port=/dev/usb/ttyUSB0 の設定は上書きされる
sloader --port=/dev/usb/ttyUSB1

# programName が正規表現 .+loader のときのみ有効 (aloader, abcloader など)
# 基本的に、後ろの行での設定は、前に設定された項目を上書きする
.+loader --port=/dev/usb/ttyUSB2
\endverbatim

  設定ファイルについて
  - '#' から始まる行は、コメントとして無視される
  - 各行が一つの引数として処理される
  - 行に空白で区切られた２つのトークンがある場合
    - 最初のトークンと programName が一致した場合のみ、第２トークンが処理される
    - 最初のトークンには、正規表現が利用可能 (要 boost)

  \attention オブジェクト破棄と同時に引き渡した内容が無効になるため、引数情報はコピーされることが望ましい。
*/


/*!
  \file
  \brief ファイルから引数情報を取得する

  \author Satofumi KAMIMURA

  $Id$
*/

#include <memory>


namespace beego {
  /*!
    \brief ファイルから引数情報の生成
  */
  class FileToArgs {
    FileToArgs(const FileToArgs& rhs);
    FileToArgs& operator = (const FileToArgs& rhs);

    struct pImpl;
    const std::auto_ptr<pImpl> pimpl;

  public:
    int argc;
    char **argv;

    FileToArgs(void);
    ~FileToArgs(void);

    /*!
      \brief 引数情報の読み出し

      \param fname [i] 設定ファイル
      \param programName [i] argv[0] に登録するプログラム名

      \attention 読み出した内容は、デストラクト時に破棄される

      <strong>サンプル</strong>
      - \ref file_to_args_page
    */
    bool load(const char* fname, const char* programName = "");
  };
};

#endif /* !FILE_TO_ARGS_H */