parse_command_line.hpp

Go to the documentation of this file.

#ifndef MLPACK_BINDINGS_CLI_PARSE_COMMAND_LINE_HPP
#define MLPACK_BINDINGS_CLI_PARSE_COMMAND_LINE_HPP

#include <mlpack/core.hpp>
#include "print_help.hpp"

#include "third_party/CLI/CLI11.hpp"

namespace mlpack {
namespace bindings {
namespace cli {

mlpack::util::Params ParseCommandLine(
    int argc,
    char** argv,
    const char* bindingName = "")
{
  // First, we need to build the CLI11 variables for parsing.
  CLI::App app;
  app.set_help_flag();

  // Get an empty Params object that will hold all of the parameters for this
  // call.
  mlpack::util::Params params = (std::string(bindingName) == "") ?
      IO::Parameters(STRINGIFY(BINDING_NAME)) :
      IO::Parameters(bindingName);

  // Go through list of options in order to add them.
  std::map<std::string, util::ParamData>& parameters = params.Parameters();
  using ItType = std::map<std::string, util::ParamData>::iterator;

  for (ItType it = parameters.begin(); it != parameters.end(); ++it)
  {
    // Add the parameter to desc.
    util::ParamData& d = it->second;
    params.functionMap[d.tname]["AddToCLI11"](d, NULL, (void*) &app);
  }

  // Parse the command line, then place the values in the right place.
  try
  {
    try
    {
      app.parse(argc, argv);
    }
    catch (const CLI::ArgumentMismatch& err)
    {
      Log::Fatal << "An option is defined multiple times: "
                 << app.exit(err) << std::endl;
    }
    catch (const CLI::OptionNotFound& onf)
    {
      Log::Fatal << "Required option --" << app.exit(onf) << "!" << std::endl;
    }
    catch (const CLI::ParseError& pe)
    {
      Log::Fatal << app.exit(pe) << std::endl;
    }
  }
  catch (std::exception& ex)
  {
    Log::Fatal << "Caught exception from parsing command line: "
      << ex.what() << std::endl;
  }

  // If the user specified any of the default options (--help, --version, or
  // --info), handle those.

  // --version is prioritized over --help.
  if (params.Has("version"))
  {
    std::cout << params.Doc().name << ": part of " << util::GetVersion() << "."
        << std::endl;
    exit(0); // Don't do anything else.
  }

  // Default help message.
  if (params.Has("help"))
  {
    Log::Info.ignoreInput = false;
    PrintHelp(params);
    exit(0); // The user doesn't want to run the program, he wants help.
  }

  // Info on a specific parameter.
  if (params.Has("info"))
  {
    Log::Info.ignoreInput = false;
    std::string str = params.Get<std::string>("info");

    // The info node should always be there, but the user may not have specified
    // anything.
    if (str != "")
    {
      PrintHelp(params, str);
      exit(0);
    }

    // Otherwise just print the generalized help.
    PrintHelp(params);
    exit(0);
  }

  // Print whether or not we have debugging symbols.  This won't show anything
  // if we have not compiled in debugging mode.
  Log::Debug << "Compiled with debugging symbols." << std::endl;

  if (params.Has("verbose"))
  {
    // Give [INFO ] output.
    Log::Info.ignoreInput = false;
  }

  // Now, issue an error if we forgot any required options.
  for (std::map<std::string, util::ParamData>::const_iterator iter =
       parameters.begin(); iter != parameters.end(); ++iter)
  {
    util::ParamData d = iter->second;
    if (d.required)
    {
      // CLI11 expects the parameter name to have "--" prepended.
      std::string cliName;
      params.functionMap[d.tname]["MapParameterName"](d, NULL,
          (void*) &cliName);
      cliName = "--" + cliName;

      if (!app.count(cliName))
      {
        Log::Fatal << "Required option " << cliName << " is undefined."
            << std::endl;
      }
    }
  }

  return params;
}

} // namespace cli
} // namespace bindings
} // namespace mlpack

#endif