cli.hpp

Go to the documentation of this file.

#ifndef MLPACK_CORE_UTIL_CLI_HPP
#define MLPACK_CORE_UTIL_CLI_HPP

#include <list>
#include <iostream>
#include <map>
#include <string>

#include <boost/any.hpp>

#include <mlpack/prereqs.hpp>

#include "timers.hpp"
#include "program_doc.hpp"
#include "version.hpp"

#include "param_data.hpp"

namespace mlpack {
namespace util {

// Externally defined in option.hpp, this class holds information about the
// program being run.
class ProgramDoc;

} // namespace util

class CLI
{
 public:
  static void Add(util::ParamData&& d);

  static bool HasParam(const std::string& identifier);

  template<typename T>
  static T& GetParam(const std::string& identifier);

  template<typename T>
  static std::string GetPrintableParam(const std::string& identifier);

  template<typename T>
  static T& GetRawParam(const std::string& identifier);

  static void MakeInPlaceCopy(const std::string& outputParamName,
                              const std::string& inputParamName);

  static CLI& GetSingleton();

  static void RegisterProgramDoc(util::ProgramDoc* doc);

  static std::map<std::string, util::ParamData>& Parameters();
  static std::map<char, std::string>& Aliases();

  static std::string ProgramName();

  static void SetPassed(const std::string& name);

  static void StoreSettings(const std::string& name);

  static void RestoreSettings(const std::string& name, const bool fatal = true);

  static void ClearSettings();

 private:
  std::map<char, std::string> aliases;
  std::map<std::string, util::ParamData> parameters;

 public:
  typedef std::map<std::string, std::map<std::string,
      void (*)(const util::ParamData&, const void*, void*)>> FunctionMapType;
  FunctionMapType functionMap;

 private:
  std::map<std::string, std::tuple<std::map<std::string, util::ParamData>,
      std::map<char, std::string>, FunctionMapType>> storageMap;

 public:
  bool didParse;

  std::string programName;

  Timers timer;

  friend class Timer;

  util::ProgramDoc* doc;

 private:
  CLI();

  CLI(const CLI& other);
  CLI& operator=(const CLI& other);
};

} // namespace mlpack

// Include the actual definitions of templated methods
#include "cli_impl.hpp"

#endif