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 <boost/program_options.hpp>

#include <mlpack/prereqs.hpp>

#include "timers.hpp"
#include "cli_deleter.hpp" // To make sure we can delete the singleton.
#include "version.hpp"
#include "param.hpp"


#include "param_data.hpp"
#include "print_param.hpp"
#include "output_param.hpp"
#include "default_param.hpp"
#include "string_type_param.hpp"

namespace po = boost::program_options;

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:
  template<class T>
  static void Add(const T& defaultValue,
                  const std::string& identifier,
                  const std::string& description,
                  const char alias = '\0',
                  const bool required = false,
                  const bool input = true,
                  const bool noTranspose = false);

  static void Destroy();

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

  template<typename T>
  static typename util::ParameterType<T>::type& GetUnmappedParam(
      const std::string& identifier);

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

  static CLI& GetSingleton();

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

  static std::string HyphenateString(const std::string& str, int padding);

  static void ParseCommandLine(int argc, char** argv);

  static void PrintHelp(const std::string& param = "");

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

  ~CLI();

 private:
  po::options_description desc;

  po::variables_map vmap;

  std::list<std::string> outputOptions;
  std::list<std::string> requiredOptions;
  std::map<char, std::string> aliases;

  std::map<std::string, util::ParamData> parameters;

  static CLI* singleton;

  bool didParse;

  std::string programName;

  Timers timer;

  friend class Timer;

 public:
  util::ProgramDoc *doc;

 private:
  static void AddAlias(const std::string& alias, const std::string& original);

  static char AliasReverseLookup(const std::string& value);

  CLI();

  CLI(const CLI& other);

  template<typename T>
  void AddOption(
      const char* optId,
      const char* descr,
      const typename std::enable_if_t<!util::IsStdVector<T>::value>*
          /* junk */ = 0);

  template<typename T>
  void AddOption(
      const char* optId,
      const char* descr,
      const typename std::enable_if_t<util::IsStdVector<T>::value>*
          /* junk */ = 0);
};

} // namespace mlpack

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

#endif