cli_option.hpp

Go to the documentation of this file.

#ifndef MLPACK_CORE_BINDINGS_CLI_CLI_OPTION_HPP
#define MLPACK_CORE_BINDINGS_CLI_CLI_OPTION_HPP

#include <string>

#include <mlpack/core/util/io.hpp>
#include "parameter_type.hpp"
#include "add_to_cli11.hpp"
#include "default_param.hpp"
#include "output_param.hpp"
#include "get_printable_param.hpp"
#include "string_type_param.hpp"
#include "get_param.hpp"
#include "get_raw_param.hpp"
#include "map_parameter_name.hpp"
#include "set_param.hpp"
#include "get_printable_param_name.hpp"
#include "get_printable_param_value.hpp"
#include "get_allocated_memory.hpp"
#include "delete_allocated_memory.hpp"
#include "in_place_copy.hpp"

namespace mlpack {
namespace bindings {
namespace cli {

template<typename N>
class CLIOption
{
 public:
  CLIOption(const N defaultValue,
            const std::string& identifier,
            const std::string& description,
            const std::string& alias,
            const std::string& cppName,
            const bool required = false,
            const bool input = true,
            const bool noTranspose = false,
            const std::string& bindingName = "")
  {
    // Create the ParamData object to give to CLI.
    util::ParamData data;

    data.desc = description;
    data.name = identifier;
    data.tname = TYPENAME(N);
    data.alias = alias[0];
    data.wasPassed = false;
    data.noTranspose = noTranspose;
    data.required = required;
    data.input = input;
    data.loaded = false;
    data.cppType = cppName;

    // Apply default value.
    if (std::is_same<typename std::remove_pointer<N>::type,
                     typename ParameterType<typename
                         std::remove_pointer<N>::type>::type>::value)
    {
      data.value = boost::any(defaultValue);
    }
    else
    {
      typename ParameterType<typename std::remove_pointer<N>::type>::type tmp;
      data.value = boost::any(std::tuple<N, decltype(tmp)>(defaultValue, tmp));
    }

    const std::string tname = data.tname;
    const std::string cliName = MapParameterName<
        typename std::remove_pointer<N>::type>(identifier);
    std::string progOptId = (alias[0] != '\0') ?
        "-" + std::string(1, alias[0]) + ",--" + cliName : "--" + cliName;

    // Set some function pointers that we need.
    IO::AddFunction(tname, "DefaultParam", &DefaultParam<N>);
    IO::AddFunction(tname, "OutputParam", &OutputParam<N>);
    IO::AddFunction(tname, "GetPrintableParam", &GetPrintableParam<N>);
    IO::AddFunction(tname, "StringTypeParam", &StringTypeParam<N>);
    IO::AddFunction(tname, "GetParam", &GetParam<N>);
    IO::AddFunction(tname, "GetRawParam", &GetRawParam<N>);
    IO::AddFunction(tname, "AddToCLI11", &AddToCLI11<N>);
    IO::AddFunction(tname, "MapParameterName", &MapParameterName<N>);
    IO::AddFunction(tname, "GetPrintableParamName", &GetPrintableParamName<N>);
    IO::AddFunction(tname, "GetPrintableParamValue",
        &GetPrintableParamValue<N>);
    IO::AddFunction(tname, "GetAllocatedMemory", &GetAllocatedMemory<N>);
    IO::AddFunction(tname, "DeleteAllocatedMemory", &DeleteAllocatedMemory<N>);
    IO::AddFunction(tname, "InPlaceCopy", &InPlaceCopy<N>);

    IO::AddParameter(bindingName, std::move(data));
  }
};

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

#endif