initial commit
This commit is contained in:
1404
libs/CLI11/include/CLI/App.hpp
Normal file
1404
libs/CLI11/include/CLI/App.hpp
Normal file
File diff suppressed because it is too large
Load Diff
36
libs/CLI11/include/CLI/CLI.hpp
Normal file
36
libs/CLI11/include/CLI/CLI.hpp
Normal file
@@ -0,0 +1,36 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// CLI Library includes
|
||||
// Order is important for combiner script
|
||||
|
||||
#include "Version.hpp"
|
||||
|
||||
#include "Macros.hpp"
|
||||
|
||||
#include "StringTools.hpp"
|
||||
|
||||
#include "Error.hpp"
|
||||
|
||||
#include "TypeTools.hpp"
|
||||
|
||||
#include "Split.hpp"
|
||||
|
||||
#include "ConfigFwd.hpp"
|
||||
|
||||
#include "Validators.hpp"
|
||||
|
||||
#include "FormatterFwd.hpp"
|
||||
|
||||
#include "Option.hpp"
|
||||
|
||||
#include "App.hpp"
|
||||
|
||||
#include "Config.hpp"
|
||||
|
||||
#include "Formatter.hpp"
|
||||
48
libs/CLI11/include/CLI/Config.hpp
Normal file
48
libs/CLI11/include/CLI/Config.hpp
Normal file
@@ -0,0 +1,48 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <algorithm>
|
||||
#include <cctype>
|
||||
#include <fstream>
|
||||
#include <iostream>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:set]
|
||||
|
||||
#include "App.hpp"
|
||||
#include "ConfigFwd.hpp"
|
||||
#include "StringTools.hpp"
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:config_hpp:verbatim]
|
||||
namespace detail {
|
||||
|
||||
std::string convert_arg_for_ini(const std::string &arg, char stringQuote = '"', char characterQuote = '\'');
|
||||
|
||||
/// Comma separated join, adds quotes if needed
|
||||
std::string ini_join(const std::vector<std::string> &args,
|
||||
char sepChar = ',',
|
||||
char arrayStart = '[',
|
||||
char arrayEnd = ']',
|
||||
char stringQuote = '"',
|
||||
char characterQuote = '\'');
|
||||
|
||||
std::vector<std::string> generate_parents(const std::string §ion, std::string &name, char parentSeparator);
|
||||
|
||||
/// assuming non default segments do a check on the close and open of the segments in a configItem structure
|
||||
void checkParentSegments(std::vector<ConfigItem> &output, const std::string ¤tSection, char parentSeparator);
|
||||
} // namespace detail
|
||||
|
||||
// [CLI11:config_hpp:end]
|
||||
} // namespace CLI
|
||||
|
||||
#ifndef CLI11_COMPILE
|
||||
#include "impl/Config_inl.hpp"
|
||||
#endif
|
||||
185
libs/CLI11/include/CLI/ConfigFwd.hpp
Normal file
185
libs/CLI11/include/CLI/ConfigFwd.hpp
Normal file
@@ -0,0 +1,185 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <algorithm>
|
||||
#include <fstream>
|
||||
#include <iostream>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
#include "Error.hpp"
|
||||
#include "StringTools.hpp"
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:config_fwd_hpp:verbatim]
|
||||
|
||||
class App;
|
||||
|
||||
/// Holds values to load into Options
|
||||
struct ConfigItem {
|
||||
/// This is the list of parents
|
||||
std::vector<std::string> parents{};
|
||||
|
||||
/// This is the name
|
||||
std::string name{};
|
||||
|
||||
/// Listing of inputs
|
||||
std::vector<std::string> inputs{};
|
||||
|
||||
/// The list of parents and name joined by "."
|
||||
CLI11_NODISCARD std::string fullname() const {
|
||||
std::vector<std::string> tmp = parents;
|
||||
tmp.emplace_back(name);
|
||||
return detail::join(tmp, ".");
|
||||
}
|
||||
};
|
||||
|
||||
/// This class provides a converter for configuration files.
|
||||
class Config {
|
||||
protected:
|
||||
std::vector<ConfigItem> items{};
|
||||
|
||||
public:
|
||||
/// Convert an app into a configuration
|
||||
virtual std::string to_config(const App *, bool, bool, std::string) const = 0;
|
||||
|
||||
/// Convert a configuration into an app
|
||||
virtual std::vector<ConfigItem> from_config(std::istream &) const = 0;
|
||||
|
||||
/// Get a flag value
|
||||
CLI11_NODISCARD virtual std::string to_flag(const ConfigItem &item) const {
|
||||
if(item.inputs.size() == 1) {
|
||||
return item.inputs.at(0);
|
||||
}
|
||||
if(item.inputs.empty()) {
|
||||
return "{}";
|
||||
}
|
||||
throw ConversionError::TooManyInputsFlag(item.fullname()); // LCOV_EXCL_LINE
|
||||
}
|
||||
|
||||
/// Parse a config file, throw an error (ParseError:ConfigParseError or FileError) on failure
|
||||
CLI11_NODISCARD std::vector<ConfigItem> from_file(const std::string &name) const {
|
||||
std::ifstream input{name};
|
||||
if(!input.good())
|
||||
throw FileError::Missing(name);
|
||||
|
||||
return from_config(input);
|
||||
}
|
||||
|
||||
/// Virtual destructor
|
||||
virtual ~Config() = default;
|
||||
};
|
||||
|
||||
/// This converter works with INI/TOML files; to write INI files use ConfigINI
|
||||
class ConfigBase : public Config {
|
||||
protected:
|
||||
/// the character used for comments
|
||||
char commentChar = '#';
|
||||
/// the character used to start an array '\0' is a default to not use
|
||||
char arrayStart = '[';
|
||||
/// the character used to end an array '\0' is a default to not use
|
||||
char arrayEnd = ']';
|
||||
/// the character used to separate elements in an array
|
||||
char arraySeparator = ',';
|
||||
/// the character used separate the name from the value
|
||||
char valueDelimiter = '=';
|
||||
/// the character to use around strings
|
||||
char stringQuote = '"';
|
||||
/// the character to use around single characters
|
||||
char characterQuote = '\'';
|
||||
/// the maximum number of layers to allow
|
||||
uint8_t maximumLayers{255};
|
||||
/// the separator used to separator parent layers
|
||||
char parentSeparatorChar{'.'};
|
||||
/// Specify the configuration index to use for arrayed sections
|
||||
int16_t configIndex{-1};
|
||||
/// Specify the configuration section that should be used
|
||||
std::string configSection{};
|
||||
|
||||
public:
|
||||
std::string
|
||||
to_config(const App * /*app*/, bool default_also, bool write_description, std::string prefix) const override;
|
||||
|
||||
std::vector<ConfigItem> from_config(std::istream &input) const override;
|
||||
/// Specify the configuration for comment characters
|
||||
ConfigBase *comment(char cchar) {
|
||||
commentChar = cchar;
|
||||
return this;
|
||||
}
|
||||
/// Specify the start and end characters for an array
|
||||
ConfigBase *arrayBounds(char aStart, char aEnd) {
|
||||
arrayStart = aStart;
|
||||
arrayEnd = aEnd;
|
||||
return this;
|
||||
}
|
||||
/// Specify the delimiter character for an array
|
||||
ConfigBase *arrayDelimiter(char aSep) {
|
||||
arraySeparator = aSep;
|
||||
return this;
|
||||
}
|
||||
/// Specify the delimiter between a name and value
|
||||
ConfigBase *valueSeparator(char vSep) {
|
||||
valueDelimiter = vSep;
|
||||
return this;
|
||||
}
|
||||
/// Specify the quote characters used around strings and characters
|
||||
ConfigBase *quoteCharacter(char qString, char qChar) {
|
||||
stringQuote = qString;
|
||||
characterQuote = qChar;
|
||||
return this;
|
||||
}
|
||||
/// Specify the maximum number of parents
|
||||
ConfigBase *maxLayers(uint8_t layers) {
|
||||
maximumLayers = layers;
|
||||
return this;
|
||||
}
|
||||
/// Specify the separator to use for parent layers
|
||||
ConfigBase *parentSeparator(char sep) {
|
||||
parentSeparatorChar = sep;
|
||||
return this;
|
||||
}
|
||||
/// get a reference to the configuration section
|
||||
std::string §ionRef() { return configSection; }
|
||||
/// get the section
|
||||
CLI11_NODISCARD const std::string §ion() const { return configSection; }
|
||||
/// specify a particular section of the configuration file to use
|
||||
ConfigBase *section(const std::string §ionName) {
|
||||
configSection = sectionName;
|
||||
return this;
|
||||
}
|
||||
|
||||
/// get a reference to the configuration index
|
||||
int16_t &indexRef() { return configIndex; }
|
||||
/// get the section index
|
||||
CLI11_NODISCARD int16_t index() const { return configIndex; }
|
||||
/// specify a particular index in the section to use (-1) for all sections to use
|
||||
ConfigBase *index(int16_t sectionIndex) {
|
||||
configIndex = sectionIndex;
|
||||
return this;
|
||||
}
|
||||
};
|
||||
|
||||
/// the default Config is the TOML file format
|
||||
using ConfigTOML = ConfigBase;
|
||||
|
||||
/// ConfigINI generates a "standard" INI compliant output
|
||||
class ConfigINI : public ConfigTOML {
|
||||
|
||||
public:
|
||||
ConfigINI() {
|
||||
commentChar = ';';
|
||||
arrayStart = '\0';
|
||||
arrayEnd = '\0';
|
||||
arraySeparator = ' ';
|
||||
valueDelimiter = '=';
|
||||
}
|
||||
};
|
||||
// [CLI11:config_fwd_hpp:end]
|
||||
} // namespace CLI
|
||||
354
libs/CLI11/include/CLI/Error.hpp
Normal file
354
libs/CLI11/include/CLI/Error.hpp
Normal file
@@ -0,0 +1,354 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <exception>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
// CLI library includes
|
||||
#include "Macros.hpp"
|
||||
#include "StringTools.hpp"
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:error_hpp:verbatim]
|
||||
|
||||
// Use one of these on all error classes.
|
||||
// These are temporary and are undef'd at the end of this file.
|
||||
#define CLI11_ERROR_DEF(parent, name) \
|
||||
protected: \
|
||||
name(std::string ename, std::string msg, int exit_code) : parent(std::move(ename), std::move(msg), exit_code) {} \
|
||||
name(std::string ename, std::string msg, ExitCodes exit_code) \
|
||||
: parent(std::move(ename), std::move(msg), exit_code) {} \
|
||||
\
|
||||
public: \
|
||||
name(std::string msg, ExitCodes exit_code) : parent(#name, std::move(msg), exit_code) {} \
|
||||
name(std::string msg, int exit_code) : parent(#name, std::move(msg), exit_code) {}
|
||||
|
||||
// This is added after the one above if a class is used directly and builds its own message
|
||||
#define CLI11_ERROR_SIMPLE(name) \
|
||||
explicit name(std::string msg) : name(#name, msg, ExitCodes::name) {}
|
||||
|
||||
/// These codes are part of every error in CLI. They can be obtained from e using e.exit_code or as a quick shortcut,
|
||||
/// int values from e.get_error_code().
|
||||
enum class ExitCodes {
|
||||
Success = 0,
|
||||
IncorrectConstruction = 100,
|
||||
BadNameString,
|
||||
OptionAlreadyAdded,
|
||||
FileError,
|
||||
ConversionError,
|
||||
ValidationError,
|
||||
RequiredError,
|
||||
RequiresError,
|
||||
ExcludesError,
|
||||
ExtrasError,
|
||||
ConfigError,
|
||||
InvalidError,
|
||||
HorribleError,
|
||||
OptionNotFound,
|
||||
ArgumentMismatch,
|
||||
BaseClass = 127
|
||||
};
|
||||
|
||||
// Error definitions
|
||||
|
||||
/// @defgroup error_group Errors
|
||||
/// @brief Errors thrown by CLI11
|
||||
///
|
||||
/// These are the errors that can be thrown. Some of them, like CLI::Success, are not really errors.
|
||||
/// @{
|
||||
|
||||
/// All errors derive from this one
|
||||
class Error : public std::runtime_error {
|
||||
int actual_exit_code;
|
||||
std::string error_name{"Error"};
|
||||
|
||||
public:
|
||||
CLI11_NODISCARD int get_exit_code() const { return actual_exit_code; }
|
||||
|
||||
CLI11_NODISCARD std::string get_name() const { return error_name; }
|
||||
|
||||
Error(std::string name, std::string msg, int exit_code = static_cast<int>(ExitCodes::BaseClass))
|
||||
: runtime_error(msg), actual_exit_code(exit_code), error_name(std::move(name)) {}
|
||||
|
||||
Error(std::string name, std::string msg, ExitCodes exit_code) : Error(name, msg, static_cast<int>(exit_code)) {}
|
||||
};
|
||||
|
||||
// Note: Using Error::Error constructors does not work on GCC 4.7
|
||||
|
||||
/// Construction errors (not in parsing)
|
||||
class ConstructionError : public Error {
|
||||
CLI11_ERROR_DEF(Error, ConstructionError)
|
||||
};
|
||||
|
||||
/// Thrown when an option is set to conflicting values (non-vector and multi args, for example)
|
||||
class IncorrectConstruction : public ConstructionError {
|
||||
CLI11_ERROR_DEF(ConstructionError, IncorrectConstruction)
|
||||
CLI11_ERROR_SIMPLE(IncorrectConstruction)
|
||||
static IncorrectConstruction PositionalFlag(std::string name) {
|
||||
return IncorrectConstruction(name + ": Flags cannot be positional");
|
||||
}
|
||||
static IncorrectConstruction Set0Opt(std::string name) {
|
||||
return IncorrectConstruction(name + ": Cannot set 0 expected, use a flag instead");
|
||||
}
|
||||
static IncorrectConstruction SetFlag(std::string name) {
|
||||
return IncorrectConstruction(name + ": Cannot set an expected number for flags");
|
||||
}
|
||||
static IncorrectConstruction ChangeNotVector(std::string name) {
|
||||
return IncorrectConstruction(name + ": You can only change the expected arguments for vectors");
|
||||
}
|
||||
static IncorrectConstruction AfterMultiOpt(std::string name) {
|
||||
return IncorrectConstruction(
|
||||
name + ": You can't change expected arguments after you've changed the multi option policy!");
|
||||
}
|
||||
static IncorrectConstruction MissingOption(std::string name) {
|
||||
return IncorrectConstruction("Option " + name + " is not defined");
|
||||
}
|
||||
static IncorrectConstruction MultiOptionPolicy(std::string name) {
|
||||
return IncorrectConstruction(name + ": multi_option_policy only works for flags and exact value options");
|
||||
}
|
||||
};
|
||||
|
||||
/// Thrown on construction of a bad name
|
||||
class BadNameString : public ConstructionError {
|
||||
CLI11_ERROR_DEF(ConstructionError, BadNameString)
|
||||
CLI11_ERROR_SIMPLE(BadNameString)
|
||||
static BadNameString OneCharName(std::string name) { return BadNameString("Invalid one char name: " + name); }
|
||||
static BadNameString BadLongName(std::string name) { return BadNameString("Bad long name: " + name); }
|
||||
static BadNameString DashesOnly(std::string name) {
|
||||
return BadNameString("Must have a name, not just dashes: " + name);
|
||||
}
|
||||
static BadNameString MultiPositionalNames(std::string name) {
|
||||
return BadNameString("Only one positional name allowed, remove: " + name);
|
||||
}
|
||||
};
|
||||
|
||||
/// Thrown when an option already exists
|
||||
class OptionAlreadyAdded : public ConstructionError {
|
||||
CLI11_ERROR_DEF(ConstructionError, OptionAlreadyAdded)
|
||||
explicit OptionAlreadyAdded(std::string name)
|
||||
: OptionAlreadyAdded(name + " is already added", ExitCodes::OptionAlreadyAdded) {}
|
||||
static OptionAlreadyAdded Requires(std::string name, std::string other) {
|
||||
return {name + " requires " + other, ExitCodes::OptionAlreadyAdded};
|
||||
}
|
||||
static OptionAlreadyAdded Excludes(std::string name, std::string other) {
|
||||
return {name + " excludes " + other, ExitCodes::OptionAlreadyAdded};
|
||||
}
|
||||
};
|
||||
|
||||
// Parsing errors
|
||||
|
||||
/// Anything that can error in Parse
|
||||
class ParseError : public Error {
|
||||
CLI11_ERROR_DEF(Error, ParseError)
|
||||
};
|
||||
|
||||
// Not really "errors"
|
||||
|
||||
/// This is a successful completion on parsing, supposed to exit
|
||||
class Success : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, Success)
|
||||
Success() : Success("Successfully completed, should be caught and quit", ExitCodes::Success) {}
|
||||
};
|
||||
|
||||
/// -h or --help on command line
|
||||
class CallForHelp : public Success {
|
||||
CLI11_ERROR_DEF(Success, CallForHelp)
|
||||
CallForHelp() : CallForHelp("This should be caught in your main function, see examples", ExitCodes::Success) {}
|
||||
};
|
||||
|
||||
/// Usually something like --help-all on command line
|
||||
class CallForAllHelp : public Success {
|
||||
CLI11_ERROR_DEF(Success, CallForAllHelp)
|
||||
CallForAllHelp()
|
||||
: CallForAllHelp("This should be caught in your main function, see examples", ExitCodes::Success) {}
|
||||
};
|
||||
|
||||
/// -v or --version on command line
|
||||
class CallForVersion : public Success {
|
||||
CLI11_ERROR_DEF(Success, CallForVersion)
|
||||
CallForVersion()
|
||||
: CallForVersion("This should be caught in your main function, see examples", ExitCodes::Success) {}
|
||||
};
|
||||
|
||||
/// Does not output a diagnostic in CLI11_PARSE, but allows main() to return with a specific error code.
|
||||
class RuntimeError : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, RuntimeError)
|
||||
explicit RuntimeError(int exit_code = 1) : RuntimeError("Runtime error", exit_code) {}
|
||||
};
|
||||
|
||||
/// Thrown when parsing an INI file and it is missing
|
||||
class FileError : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, FileError)
|
||||
CLI11_ERROR_SIMPLE(FileError)
|
||||
static FileError Missing(std::string name) { return FileError(name + " was not readable (missing?)"); }
|
||||
};
|
||||
|
||||
/// Thrown when conversion call back fails, such as when an int fails to coerce to a string
|
||||
class ConversionError : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, ConversionError)
|
||||
CLI11_ERROR_SIMPLE(ConversionError)
|
||||
ConversionError(std::string member, std::string name)
|
||||
: ConversionError("The value " + member + " is not an allowed value for " + name) {}
|
||||
ConversionError(std::string name, std::vector<std::string> results)
|
||||
: ConversionError("Could not convert: " + name + " = " + detail::join(results)) {}
|
||||
static ConversionError TooManyInputsFlag(std::string name) {
|
||||
return ConversionError(name + ": too many inputs for a flag");
|
||||
}
|
||||
static ConversionError TrueFalse(std::string name) {
|
||||
return ConversionError(name + ": Should be true/false or a number");
|
||||
}
|
||||
};
|
||||
|
||||
/// Thrown when validation of results fails
|
||||
class ValidationError : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, ValidationError)
|
||||
CLI11_ERROR_SIMPLE(ValidationError)
|
||||
explicit ValidationError(std::string name, std::string msg) : ValidationError(name + ": " + msg) {}
|
||||
};
|
||||
|
||||
/// Thrown when a required option is missing
|
||||
class RequiredError : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, RequiredError)
|
||||
explicit RequiredError(std::string name) : RequiredError(name + " is required", ExitCodes::RequiredError) {}
|
||||
static RequiredError Subcommand(std::size_t min_subcom) {
|
||||
if(min_subcom == 1) {
|
||||
return RequiredError("A subcommand");
|
||||
}
|
||||
return {"Requires at least " + std::to_string(min_subcom) + " subcommands", ExitCodes::RequiredError};
|
||||
}
|
||||
static RequiredError
|
||||
Option(std::size_t min_option, std::size_t max_option, std::size_t used, const std::string &option_list) {
|
||||
if((min_option == 1) && (max_option == 1) && (used == 0))
|
||||
return RequiredError("Exactly 1 option from [" + option_list + "]");
|
||||
if((min_option == 1) && (max_option == 1) && (used > 1)) {
|
||||
return {"Exactly 1 option from [" + option_list + "] is required and " + std::to_string(used) +
|
||||
" were given",
|
||||
ExitCodes::RequiredError};
|
||||
}
|
||||
if((min_option == 1) && (used == 0))
|
||||
return RequiredError("At least 1 option from [" + option_list + "]");
|
||||
if(used < min_option) {
|
||||
return {"Requires at least " + std::to_string(min_option) + " options used and only " +
|
||||
std::to_string(used) + "were given from [" + option_list + "]",
|
||||
ExitCodes::RequiredError};
|
||||
}
|
||||
if(max_option == 1)
|
||||
return {"Requires at most 1 options be given from [" + option_list + "]", ExitCodes::RequiredError};
|
||||
|
||||
return {"Requires at most " + std::to_string(max_option) + " options be used and " + std::to_string(used) +
|
||||
"were given from [" + option_list + "]",
|
||||
ExitCodes::RequiredError};
|
||||
}
|
||||
};
|
||||
|
||||
/// Thrown when the wrong number of arguments has been received
|
||||
class ArgumentMismatch : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, ArgumentMismatch)
|
||||
CLI11_ERROR_SIMPLE(ArgumentMismatch)
|
||||
ArgumentMismatch(std::string name, int expected, std::size_t received)
|
||||
: ArgumentMismatch(expected > 0 ? ("Expected exactly " + std::to_string(expected) + " arguments to " + name +
|
||||
", got " + std::to_string(received))
|
||||
: ("Expected at least " + std::to_string(-expected) + " arguments to " + name +
|
||||
", got " + std::to_string(received)),
|
||||
ExitCodes::ArgumentMismatch) {}
|
||||
|
||||
static ArgumentMismatch AtLeast(std::string name, int num, std::size_t received) {
|
||||
return ArgumentMismatch(name + ": At least " + std::to_string(num) + " required but received " +
|
||||
std::to_string(received));
|
||||
}
|
||||
static ArgumentMismatch AtMost(std::string name, int num, std::size_t received) {
|
||||
return ArgumentMismatch(name + ": At Most " + std::to_string(num) + " required but received " +
|
||||
std::to_string(received));
|
||||
}
|
||||
static ArgumentMismatch TypedAtLeast(std::string name, int num, std::string type) {
|
||||
return ArgumentMismatch(name + ": " + std::to_string(num) + " required " + type + " missing");
|
||||
}
|
||||
static ArgumentMismatch FlagOverride(std::string name) {
|
||||
return ArgumentMismatch(name + " was given a disallowed flag override");
|
||||
}
|
||||
static ArgumentMismatch PartialType(std::string name, int num, std::string type) {
|
||||
return ArgumentMismatch(name + ": " + type + " only partially specified: " + std::to_string(num) +
|
||||
" required for each element");
|
||||
}
|
||||
};
|
||||
|
||||
/// Thrown when a requires option is missing
|
||||
class RequiresError : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, RequiresError)
|
||||
RequiresError(std::string curname, std::string subname)
|
||||
: RequiresError(curname + " requires " + subname, ExitCodes::RequiresError) {}
|
||||
};
|
||||
|
||||
/// Thrown when an excludes option is present
|
||||
class ExcludesError : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, ExcludesError)
|
||||
ExcludesError(std::string curname, std::string subname)
|
||||
: ExcludesError(curname + " excludes " + subname, ExitCodes::ExcludesError) {}
|
||||
};
|
||||
|
||||
/// Thrown when too many positionals or options are found
|
||||
class ExtrasError : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, ExtrasError)
|
||||
explicit ExtrasError(std::vector<std::string> args)
|
||||
: ExtrasError((args.size() > 1 ? "The following arguments were not expected: "
|
||||
: "The following argument was not expected: ") +
|
||||
detail::rjoin(args, " "),
|
||||
ExitCodes::ExtrasError) {}
|
||||
ExtrasError(const std::string &name, std::vector<std::string> args)
|
||||
: ExtrasError(name,
|
||||
(args.size() > 1 ? "The following arguments were not expected: "
|
||||
: "The following argument was not expected: ") +
|
||||
detail::rjoin(args, " "),
|
||||
ExitCodes::ExtrasError) {}
|
||||
};
|
||||
|
||||
/// Thrown when extra values are found in an INI file
|
||||
class ConfigError : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, ConfigError)
|
||||
CLI11_ERROR_SIMPLE(ConfigError)
|
||||
static ConfigError Extras(std::string item) { return ConfigError("INI was not able to parse " + item); }
|
||||
static ConfigError NotConfigurable(std::string item) {
|
||||
return ConfigError(item + ": This option is not allowed in a configuration file");
|
||||
}
|
||||
};
|
||||
|
||||
/// Thrown when validation fails before parsing
|
||||
class InvalidError : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, InvalidError)
|
||||
explicit InvalidError(std::string name)
|
||||
: InvalidError(name + ": Too many positional arguments with unlimited expected args", ExitCodes::InvalidError) {
|
||||
}
|
||||
};
|
||||
|
||||
/// This is just a safety check to verify selection and parsing match - you should not ever see it
|
||||
/// Strings are directly added to this error, but again, it should never be seen.
|
||||
class HorribleError : public ParseError {
|
||||
CLI11_ERROR_DEF(ParseError, HorribleError)
|
||||
CLI11_ERROR_SIMPLE(HorribleError)
|
||||
};
|
||||
|
||||
// After parsing
|
||||
|
||||
/// Thrown when counting a non-existent option
|
||||
class OptionNotFound : public Error {
|
||||
CLI11_ERROR_DEF(Error, OptionNotFound)
|
||||
explicit OptionNotFound(std::string name) : OptionNotFound(name + " not found", ExitCodes::OptionNotFound) {}
|
||||
};
|
||||
|
||||
#undef CLI11_ERROR_DEF
|
||||
#undef CLI11_ERROR_SIMPLE
|
||||
|
||||
/// @}
|
||||
|
||||
// [CLI11:error_hpp:end]
|
||||
} // namespace CLI
|
||||
25
libs/CLI11/include/CLI/Formatter.hpp
Normal file
25
libs/CLI11/include/CLI/Formatter.hpp
Normal file
@@ -0,0 +1,25 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <algorithm>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
#include "App.hpp"
|
||||
#include "FormatterFwd.hpp"
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:formatter_hpp:verbatim]
|
||||
// [CLI11:formatter_hpp:end]
|
||||
} // namespace CLI
|
||||
|
||||
#ifndef CLI11_COMPILE
|
||||
#include "impl/Formatter_inl.hpp"
|
||||
#endif
|
||||
189
libs/CLI11/include/CLI/FormatterFwd.hpp
Normal file
189
libs/CLI11/include/CLI/FormatterFwd.hpp
Normal file
@@ -0,0 +1,189 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <functional>
|
||||
#include <map>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
#include "StringTools.hpp"
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:formatter_fwd_hpp:verbatim]
|
||||
|
||||
class Option;
|
||||
class App;
|
||||
|
||||
/// This enum signifies the type of help requested
|
||||
///
|
||||
/// This is passed in by App; all user classes must accept this as
|
||||
/// the second argument.
|
||||
|
||||
enum class AppFormatMode {
|
||||
Normal, ///< The normal, detailed help
|
||||
All, ///< A fully expanded help
|
||||
Sub, ///< Used when printed as part of expanded subcommand
|
||||
};
|
||||
|
||||
/// This is the minimum requirements to run a formatter.
|
||||
///
|
||||
/// A user can subclass this is if they do not care at all
|
||||
/// about the structure in CLI::Formatter.
|
||||
class FormatterBase {
|
||||
protected:
|
||||
/// @name Options
|
||||
///@{
|
||||
|
||||
/// The width of the first column
|
||||
std::size_t column_width_{30};
|
||||
|
||||
/// @brief The required help printout labels (user changeable)
|
||||
/// Values are Needs, Excludes, etc.
|
||||
std::map<std::string, std::string> labels_{};
|
||||
|
||||
///@}
|
||||
/// @name Basic
|
||||
///@{
|
||||
|
||||
public:
|
||||
FormatterBase() = default;
|
||||
FormatterBase(const FormatterBase &) = default;
|
||||
FormatterBase(FormatterBase &&) = default;
|
||||
FormatterBase &operator=(const FormatterBase &) = default;
|
||||
FormatterBase &operator=(FormatterBase &&) = default;
|
||||
|
||||
/// Adding a destructor in this form to work around bug in GCC 4.7
|
||||
virtual ~FormatterBase() noexcept {} // NOLINT(modernize-use-equals-default)
|
||||
|
||||
/// This is the key method that puts together help
|
||||
virtual std::string make_help(const App *, std::string, AppFormatMode) const = 0;
|
||||
|
||||
///@}
|
||||
/// @name Setters
|
||||
///@{
|
||||
|
||||
/// Set the "REQUIRED" label
|
||||
void label(std::string key, std::string val) { labels_[key] = val; }
|
||||
|
||||
/// Set the column width
|
||||
void column_width(std::size_t val) { column_width_ = val; }
|
||||
|
||||
///@}
|
||||
/// @name Getters
|
||||
///@{
|
||||
|
||||
/// Get the current value of a name (REQUIRED, etc.)
|
||||
CLI11_NODISCARD std::string get_label(std::string key) const {
|
||||
if(labels_.find(key) == labels_.end())
|
||||
return key;
|
||||
return labels_.at(key);
|
||||
}
|
||||
|
||||
/// Get the current column width
|
||||
CLI11_NODISCARD std::size_t get_column_width() const { return column_width_; }
|
||||
|
||||
///@}
|
||||
};
|
||||
|
||||
/// This is a specialty override for lambda functions
|
||||
class FormatterLambda final : public FormatterBase {
|
||||
using funct_t = std::function<std::string(const App *, std::string, AppFormatMode)>;
|
||||
|
||||
/// The lambda to hold and run
|
||||
funct_t lambda_;
|
||||
|
||||
public:
|
||||
/// Create a FormatterLambda with a lambda function
|
||||
explicit FormatterLambda(funct_t funct) : lambda_(std::move(funct)) {}
|
||||
|
||||
/// Adding a destructor (mostly to make GCC 4.7 happy)
|
||||
~FormatterLambda() noexcept override {} // NOLINT(modernize-use-equals-default)
|
||||
|
||||
/// This will simply call the lambda function
|
||||
std::string make_help(const App *app, std::string name, AppFormatMode mode) const override {
|
||||
return lambda_(app, name, mode);
|
||||
}
|
||||
};
|
||||
|
||||
/// This is the default Formatter for CLI11. It pretty prints help output, and is broken into quite a few
|
||||
/// overridable methods, to be highly customizable with minimal effort.
|
||||
class Formatter : public FormatterBase {
|
||||
public:
|
||||
Formatter() = default;
|
||||
Formatter(const Formatter &) = default;
|
||||
Formatter(Formatter &&) = default;
|
||||
Formatter &operator=(const Formatter &) = default;
|
||||
Formatter &operator=(Formatter &&) = default;
|
||||
|
||||
/// @name Overridables
|
||||
///@{
|
||||
|
||||
/// This prints out a group of options with title
|
||||
///
|
||||
CLI11_NODISCARD virtual std::string
|
||||
make_group(std::string group, bool is_positional, std::vector<const Option *> opts) const;
|
||||
|
||||
/// This prints out just the positionals "group"
|
||||
virtual std::string make_positionals(const App *app) const;
|
||||
|
||||
/// This prints out all the groups of options
|
||||
std::string make_groups(const App *app, AppFormatMode mode) const;
|
||||
|
||||
/// This prints out all the subcommands
|
||||
virtual std::string make_subcommands(const App *app, AppFormatMode mode) const;
|
||||
|
||||
/// This prints out a subcommand
|
||||
virtual std::string make_subcommand(const App *sub) const;
|
||||
|
||||
/// This prints out a subcommand in help-all
|
||||
virtual std::string make_expanded(const App *sub) const;
|
||||
|
||||
/// This prints out all the groups of options
|
||||
virtual std::string make_footer(const App *app) const;
|
||||
|
||||
/// This displays the description line
|
||||
virtual std::string make_description(const App *app) const;
|
||||
|
||||
/// This displays the usage line
|
||||
virtual std::string make_usage(const App *app, std::string name) const;
|
||||
|
||||
/// This puts everything together
|
||||
std::string make_help(const App * /*app*/, std::string, AppFormatMode) const override;
|
||||
|
||||
///@}
|
||||
/// @name Options
|
||||
///@{
|
||||
|
||||
/// This prints out an option help line, either positional or optional form
|
||||
virtual std::string make_option(const Option *opt, bool is_positional) const {
|
||||
std::stringstream out;
|
||||
detail::format_help(
|
||||
out, make_option_name(opt, is_positional) + make_option_opts(opt), make_option_desc(opt), column_width_);
|
||||
return out.str();
|
||||
}
|
||||
|
||||
/// @brief This is the name part of an option, Default: left column
|
||||
virtual std::string make_option_name(const Option *, bool) const;
|
||||
|
||||
/// @brief This is the options part of the name, Default: combined into left column
|
||||
virtual std::string make_option_opts(const Option *) const;
|
||||
|
||||
/// @brief This is the description. Default: Right column, on new line if left column too large
|
||||
virtual std::string make_option_desc(const Option *) const;
|
||||
|
||||
/// @brief This is used to print the name on the USAGE line
|
||||
virtual std::string make_option_usage(const Option *opt) const;
|
||||
|
||||
///@}
|
||||
};
|
||||
|
||||
// [CLI11:formatter_fwd_hpp:end]
|
||||
} // namespace CLI
|
||||
75
libs/CLI11/include/CLI/Macros.hpp
Normal file
75
libs/CLI11/include/CLI/Macros.hpp
Normal file
@@ -0,0 +1,75 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// [CLI11:macros_hpp:verbatim]
|
||||
|
||||
// The following version macro is very similar to the one in pybind11
|
||||
#if !(defined(_MSC_VER) && __cplusplus == 199711L) && !defined(__INTEL_COMPILER)
|
||||
#if __cplusplus >= 201402L
|
||||
#define CLI11_CPP14
|
||||
#if __cplusplus >= 201703L
|
||||
#define CLI11_CPP17
|
||||
#if __cplusplus > 201703L
|
||||
#define CLI11_CPP20
|
||||
#endif
|
||||
#endif
|
||||
#endif
|
||||
#elif defined(_MSC_VER) && __cplusplus == 199711L
|
||||
// MSVC sets _MSVC_LANG rather than __cplusplus (supposedly until the standard is fully implemented)
|
||||
// Unless you use the /Zc:__cplusplus flag on Visual Studio 2017 15.7 Preview 3 or newer
|
||||
#if _MSVC_LANG >= 201402L
|
||||
#define CLI11_CPP14
|
||||
#if _MSVC_LANG > 201402L && _MSC_VER >= 1910
|
||||
#define CLI11_CPP17
|
||||
#if _MSVC_LANG > 201703L && _MSC_VER >= 1910
|
||||
#define CLI11_CPP20
|
||||
#endif
|
||||
#endif
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#if defined(CLI11_CPP14)
|
||||
#define CLI11_DEPRECATED(reason) [[deprecated(reason)]]
|
||||
#elif defined(_MSC_VER)
|
||||
#define CLI11_DEPRECATED(reason) __declspec(deprecated(reason))
|
||||
#else
|
||||
#define CLI11_DEPRECATED(reason) __attribute__((deprecated(reason)))
|
||||
#endif
|
||||
|
||||
// GCC < 10 doesn't ignore this in unevaluated contexts
|
||||
#if !defined(CLI11_CPP17) || \
|
||||
(defined(__GNUC__) && !defined(__llvm__) && !defined(__INTEL_COMPILER) && __GNUC__ < 10 && __GNUC__ > 4)
|
||||
#define CLI11_NODISCARD
|
||||
#else
|
||||
#define CLI11_NODISCARD [[nodiscard]]
|
||||
#endif
|
||||
|
||||
/** detection of rtti */
|
||||
#ifndef CLI11_USE_STATIC_RTTI
|
||||
#if(defined(_HAS_STATIC_RTTI) && _HAS_STATIC_RTTI)
|
||||
#define CLI11_USE_STATIC_RTTI 1
|
||||
#elif defined(__cpp_rtti)
|
||||
#if(defined(_CPPRTTI) && _CPPRTTI == 0)
|
||||
#define CLI11_USE_STATIC_RTTI 1
|
||||
#else
|
||||
#define CLI11_USE_STATIC_RTTI 0
|
||||
#endif
|
||||
#elif(defined(__GCC_RTTI) && __GXX_RTTI)
|
||||
#define CLI11_USE_STATIC_RTTI 0
|
||||
#else
|
||||
#define CLI11_USE_STATIC_RTTI 1
|
||||
#endif
|
||||
#endif
|
||||
|
||||
/** Inline macro **/
|
||||
#ifdef CLI11_COMPILE
|
||||
#define CLI11_INLINE
|
||||
#else
|
||||
#define CLI11_INLINE inline
|
||||
#endif
|
||||
// [CLI11:macros_hpp:end]
|
||||
807
libs/CLI11/include/CLI/Option.hpp
Normal file
807
libs/CLI11/include/CLI/Option.hpp
Normal file
@@ -0,0 +1,807 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <algorithm>
|
||||
#include <functional>
|
||||
#include <memory>
|
||||
#include <set>
|
||||
#include <string>
|
||||
#include <tuple>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
#include "Error.hpp"
|
||||
#include "Macros.hpp"
|
||||
#include "Split.hpp"
|
||||
#include "StringTools.hpp"
|
||||
#include "Validators.hpp"
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:option_hpp:verbatim]
|
||||
|
||||
using results_t = std::vector<std::string>;
|
||||
/// callback function definition
|
||||
using callback_t = std::function<bool(const results_t &)>;
|
||||
|
||||
class Option;
|
||||
class App;
|
||||
|
||||
using Option_p = std::unique_ptr<Option>;
|
||||
/// Enumeration of the multiOption Policy selection
|
||||
enum class MultiOptionPolicy : char {
|
||||
Throw, //!< Throw an error if any extra arguments were given
|
||||
TakeLast, //!< take only the last Expected number of arguments
|
||||
TakeFirst, //!< take only the first Expected number of arguments
|
||||
Join, //!< merge all the arguments together into a single string via the delimiter character default('\n')
|
||||
TakeAll, //!< just get all the passed argument regardless
|
||||
Sum //!< sum all the arguments together if numerical or concatenate directly without delimiter
|
||||
};
|
||||
|
||||
/// This is the CRTP base class for Option and OptionDefaults. It was designed this way
|
||||
/// to share parts of the class; an OptionDefaults can copy to an Option.
|
||||
template <typename CRTP> class OptionBase {
|
||||
friend App;
|
||||
|
||||
protected:
|
||||
/// The group membership
|
||||
std::string group_ = std::string("Options");
|
||||
|
||||
/// True if this is a required option
|
||||
bool required_{false};
|
||||
|
||||
/// Ignore the case when matching (option, not value)
|
||||
bool ignore_case_{false};
|
||||
|
||||
/// Ignore underscores when matching (option, not value)
|
||||
bool ignore_underscore_{false};
|
||||
|
||||
/// Allow this option to be given in a configuration file
|
||||
bool configurable_{true};
|
||||
|
||||
/// Disable overriding flag values with '=value'
|
||||
bool disable_flag_override_{false};
|
||||
|
||||
/// Specify a delimiter character for vector arguments
|
||||
char delimiter_{'\0'};
|
||||
|
||||
/// Automatically capture default value
|
||||
bool always_capture_default_{false};
|
||||
|
||||
/// Policy for handling multiple arguments beyond the expected Max
|
||||
MultiOptionPolicy multi_option_policy_{MultiOptionPolicy::Throw};
|
||||
|
||||
/// Copy the contents to another similar class (one based on OptionBase)
|
||||
template <typename T> void copy_to(T *other) const;
|
||||
|
||||
public:
|
||||
// setters
|
||||
|
||||
/// Changes the group membership
|
||||
CRTP *group(const std::string &name) {
|
||||
if(!detail::valid_alias_name_string(name)) {
|
||||
throw IncorrectConstruction("Group names may not contain newlines or null characters");
|
||||
}
|
||||
group_ = name;
|
||||
return static_cast<CRTP *>(this);
|
||||
}
|
||||
|
||||
/// Set the option as required
|
||||
CRTP *required(bool value = true) {
|
||||
required_ = value;
|
||||
return static_cast<CRTP *>(this);
|
||||
}
|
||||
|
||||
/// Support Plumbum term
|
||||
CRTP *mandatory(bool value = true) { return required(value); }
|
||||
|
||||
CRTP *always_capture_default(bool value = true) {
|
||||
always_capture_default_ = value;
|
||||
return static_cast<CRTP *>(this);
|
||||
}
|
||||
|
||||
// Getters
|
||||
|
||||
/// Get the group of this option
|
||||
CLI11_NODISCARD const std::string &get_group() const { return group_; }
|
||||
|
||||
/// True if this is a required option
|
||||
CLI11_NODISCARD bool get_required() const { return required_; }
|
||||
|
||||
/// The status of ignore case
|
||||
CLI11_NODISCARD bool get_ignore_case() const { return ignore_case_; }
|
||||
|
||||
/// The status of ignore_underscore
|
||||
CLI11_NODISCARD bool get_ignore_underscore() const { return ignore_underscore_; }
|
||||
|
||||
/// The status of configurable
|
||||
CLI11_NODISCARD bool get_configurable() const { return configurable_; }
|
||||
|
||||
/// The status of configurable
|
||||
CLI11_NODISCARD bool get_disable_flag_override() const { return disable_flag_override_; }
|
||||
|
||||
/// Get the current delimiter char
|
||||
CLI11_NODISCARD char get_delimiter() const { return delimiter_; }
|
||||
|
||||
/// Return true if this will automatically capture the default value for help printing
|
||||
CLI11_NODISCARD bool get_always_capture_default() const { return always_capture_default_; }
|
||||
|
||||
/// The status of the multi option policy
|
||||
CLI11_NODISCARD MultiOptionPolicy get_multi_option_policy() const { return multi_option_policy_; }
|
||||
|
||||
// Shortcuts for multi option policy
|
||||
|
||||
/// Set the multi option policy to take last
|
||||
CRTP *take_last() {
|
||||
auto *self = static_cast<CRTP *>(this);
|
||||
self->multi_option_policy(MultiOptionPolicy::TakeLast);
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Set the multi option policy to take last
|
||||
CRTP *take_first() {
|
||||
auto *self = static_cast<CRTP *>(this);
|
||||
self->multi_option_policy(MultiOptionPolicy::TakeFirst);
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Set the multi option policy to take all arguments
|
||||
CRTP *take_all() {
|
||||
auto self = static_cast<CRTP *>(this);
|
||||
self->multi_option_policy(MultiOptionPolicy::TakeAll);
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Set the multi option policy to join
|
||||
CRTP *join() {
|
||||
auto *self = static_cast<CRTP *>(this);
|
||||
self->multi_option_policy(MultiOptionPolicy::Join);
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Set the multi option policy to join with a specific delimiter
|
||||
CRTP *join(char delim) {
|
||||
auto self = static_cast<CRTP *>(this);
|
||||
self->delimiter_ = delim;
|
||||
self->multi_option_policy(MultiOptionPolicy::Join);
|
||||
return self;
|
||||
}
|
||||
|
||||
/// Allow in a configuration file
|
||||
CRTP *configurable(bool value = true) {
|
||||
configurable_ = value;
|
||||
return static_cast<CRTP *>(this);
|
||||
}
|
||||
|
||||
/// Allow in a configuration file
|
||||
CRTP *delimiter(char value = '\0') {
|
||||
delimiter_ = value;
|
||||
return static_cast<CRTP *>(this);
|
||||
}
|
||||
};
|
||||
|
||||
/// This is a version of OptionBase that only supports setting values,
|
||||
/// for defaults. It is stored as the default option in an App.
|
||||
class OptionDefaults : public OptionBase<OptionDefaults> {
|
||||
public:
|
||||
OptionDefaults() = default;
|
||||
|
||||
// Methods here need a different implementation if they are Option vs. OptionDefault
|
||||
|
||||
/// Take the last argument if given multiple times
|
||||
OptionDefaults *multi_option_policy(MultiOptionPolicy value = MultiOptionPolicy::Throw) {
|
||||
multi_option_policy_ = value;
|
||||
return this;
|
||||
}
|
||||
|
||||
/// Ignore the case of the option name
|
||||
OptionDefaults *ignore_case(bool value = true) {
|
||||
ignore_case_ = value;
|
||||
return this;
|
||||
}
|
||||
|
||||
/// Ignore underscores in the option name
|
||||
OptionDefaults *ignore_underscore(bool value = true) {
|
||||
ignore_underscore_ = value;
|
||||
return this;
|
||||
}
|
||||
|
||||
/// Disable overriding flag values with an '=<value>' segment
|
||||
OptionDefaults *disable_flag_override(bool value = true) {
|
||||
disable_flag_override_ = value;
|
||||
return this;
|
||||
}
|
||||
|
||||
/// set a delimiter character to split up single arguments to treat as multiple inputs
|
||||
OptionDefaults *delimiter(char value = '\0') {
|
||||
delimiter_ = value;
|
||||
return this;
|
||||
}
|
||||
};
|
||||
|
||||
class Option : public OptionBase<Option> {
|
||||
friend App;
|
||||
|
||||
protected:
|
||||
/// @name Names
|
||||
///@{
|
||||
|
||||
/// A list of the short names (`-a`) without the leading dashes
|
||||
std::vector<std::string> snames_{};
|
||||
|
||||
/// A list of the long names (`--long`) without the leading dashes
|
||||
std::vector<std::string> lnames_{};
|
||||
|
||||
/// A list of the flag names with the appropriate default value, the first part of the pair should be duplicates of
|
||||
/// what is in snames or lnames but will trigger a particular response on a flag
|
||||
std::vector<std::pair<std::string, std::string>> default_flag_values_{};
|
||||
|
||||
/// a list of flag names with specified default values;
|
||||
std::vector<std::string> fnames_{};
|
||||
|
||||
/// A positional name
|
||||
std::string pname_{};
|
||||
|
||||
/// If given, check the environment for this option
|
||||
std::string envname_{};
|
||||
|
||||
///@}
|
||||
/// @name Help
|
||||
///@{
|
||||
|
||||
/// The description for help strings
|
||||
std::string description_{};
|
||||
|
||||
/// A human readable default value, either manually set, captured, or captured by default
|
||||
std::string default_str_{};
|
||||
|
||||
/// If given, replace the text that describes the option type and usage in the help text
|
||||
std::string option_text_{};
|
||||
|
||||
/// A human readable type value, set when App creates this
|
||||
///
|
||||
/// This is a lambda function so "types" can be dynamic, such as when a set prints its contents.
|
||||
std::function<std::string()> type_name_{[]() { return std::string(); }};
|
||||
|
||||
/// Run this function to capture a default (ignore if empty)
|
||||
std::function<std::string()> default_function_{};
|
||||
|
||||
///@}
|
||||
/// @name Configuration
|
||||
///@{
|
||||
|
||||
/// The number of arguments that make up one option. max is the nominal type size, min is the minimum number of
|
||||
/// strings
|
||||
int type_size_max_{1};
|
||||
/// The minimum number of arguments an option should be expecting
|
||||
int type_size_min_{1};
|
||||
|
||||
/// The minimum number of expected values
|
||||
int expected_min_{1};
|
||||
/// The maximum number of expected values
|
||||
int expected_max_{1};
|
||||
|
||||
/// A list of Validators to run on each value parsed
|
||||
std::vector<Validator> validators_{};
|
||||
|
||||
/// A list of options that are required with this option
|
||||
std::set<Option *> needs_{};
|
||||
|
||||
/// A list of options that are excluded with this option
|
||||
std::set<Option *> excludes_{};
|
||||
|
||||
///@}
|
||||
/// @name Other
|
||||
///@{
|
||||
|
||||
/// link back up to the parent App for fallthrough
|
||||
App *parent_{nullptr};
|
||||
|
||||
/// Options store a callback to do all the work
|
||||
callback_t callback_{};
|
||||
|
||||
///@}
|
||||
/// @name Parsing results
|
||||
///@{
|
||||
|
||||
/// complete Results of parsing
|
||||
results_t results_{};
|
||||
/// results after reduction
|
||||
results_t proc_results_{};
|
||||
/// enumeration for the option state machine
|
||||
enum class option_state : char {
|
||||
parsing = 0, //!< The option is currently collecting parsed results
|
||||
validated = 2, //!< the results have been validated
|
||||
reduced = 4, //!< a subset of results has been generated
|
||||
callback_run = 6, //!< the callback has been executed
|
||||
};
|
||||
/// Whether the callback has run (needed for INI parsing)
|
||||
option_state current_option_state_{option_state::parsing};
|
||||
/// Specify that extra args beyond type_size_max should be allowed
|
||||
bool allow_extra_args_{false};
|
||||
/// Specify that the option should act like a flag vs regular option
|
||||
bool flag_like_{false};
|
||||
/// Control option to run the callback to set the default
|
||||
bool run_callback_for_default_{false};
|
||||
/// flag indicating a separator needs to be injected after each argument call
|
||||
bool inject_separator_{false};
|
||||
/// flag indicating that the option should trigger the validation and callback chain on each result when loaded
|
||||
bool trigger_on_result_{false};
|
||||
/// flag indicating that the option should force the callback regardless if any results present
|
||||
bool force_callback_{false};
|
||||
///@}
|
||||
|
||||
/// Making an option by hand is not defined, it must be made by the App class
|
||||
Option(std::string option_name, std::string option_description, callback_t callback, App *parent)
|
||||
: description_(std::move(option_description)), parent_(parent), callback_(std::move(callback)) {
|
||||
std::tie(snames_, lnames_, pname_) = detail::get_names(detail::split_names(option_name));
|
||||
}
|
||||
|
||||
public:
|
||||
/// @name Basic
|
||||
///@{
|
||||
|
||||
Option(const Option &) = delete;
|
||||
Option &operator=(const Option &) = delete;
|
||||
|
||||
/// Count the total number of times an option was passed
|
||||
CLI11_NODISCARD std::size_t count() const { return results_.size(); }
|
||||
|
||||
/// True if the option was not passed
|
||||
CLI11_NODISCARD bool empty() const { return results_.empty(); }
|
||||
|
||||
/// This bool operator returns true if any arguments were passed or the option callback is forced
|
||||
explicit operator bool() const { return !empty() || force_callback_; }
|
||||
|
||||
/// Clear the parsed results (mostly for testing)
|
||||
void clear() {
|
||||
results_.clear();
|
||||
current_option_state_ = option_state::parsing;
|
||||
}
|
||||
|
||||
///@}
|
||||
/// @name Setting options
|
||||
///@{
|
||||
|
||||
/// Set the number of expected arguments
|
||||
Option *expected(int value);
|
||||
|
||||
/// Set the range of expected arguments
|
||||
Option *expected(int value_min, int value_max);
|
||||
|
||||
/// Set the value of allow_extra_args which allows extra value arguments on the flag or option to be included
|
||||
/// with each instance
|
||||
Option *allow_extra_args(bool value = true) {
|
||||
allow_extra_args_ = value;
|
||||
return this;
|
||||
}
|
||||
/// Get the current value of allow extra args
|
||||
CLI11_NODISCARD bool get_allow_extra_args() const { return allow_extra_args_; }
|
||||
/// Set the value of trigger_on_parse which specifies that the option callback should be triggered on every parse
|
||||
Option *trigger_on_parse(bool value = true) {
|
||||
trigger_on_result_ = value;
|
||||
return this;
|
||||
}
|
||||
/// The status of trigger on parse
|
||||
CLI11_NODISCARD bool get_trigger_on_parse() const { return trigger_on_result_; }
|
||||
|
||||
/// Set the value of force_callback
|
||||
Option *force_callback(bool value = true) {
|
||||
force_callback_ = value;
|
||||
return this;
|
||||
}
|
||||
/// The status of force_callback
|
||||
CLI11_NODISCARD bool get_force_callback() const { return force_callback_; }
|
||||
|
||||
/// Set the value of run_callback_for_default which controls whether the callback function should be called to set
|
||||
/// the default This is controlled automatically but could be manipulated by the user.
|
||||
Option *run_callback_for_default(bool value = true) {
|
||||
run_callback_for_default_ = value;
|
||||
return this;
|
||||
}
|
||||
/// Get the current value of run_callback_for_default
|
||||
CLI11_NODISCARD bool get_run_callback_for_default() const { return run_callback_for_default_; }
|
||||
|
||||
/// Adds a Validator with a built in type name
|
||||
Option *check(Validator validator, const std::string &validator_name = "");
|
||||
|
||||
/// Adds a Validator. Takes a const string& and returns an error message (empty if conversion/check is okay).
|
||||
Option *check(std::function<std::string(const std::string &)> Validator,
|
||||
std::string Validator_description = "",
|
||||
std::string Validator_name = "");
|
||||
|
||||
/// Adds a transforming Validator with a built in type name
|
||||
Option *transform(Validator Validator, const std::string &Validator_name = "");
|
||||
|
||||
/// Adds a Validator-like function that can change result
|
||||
Option *transform(const std::function<std::string(std::string)> &func,
|
||||
std::string transform_description = "",
|
||||
std::string transform_name = "");
|
||||
|
||||
/// Adds a user supplied function to run on each item passed in (communicate though lambda capture)
|
||||
Option *each(const std::function<void(std::string)> &func);
|
||||
|
||||
/// Get a named Validator
|
||||
Validator *get_validator(const std::string &Validator_name = "");
|
||||
|
||||
/// Get a Validator by index NOTE: this may not be the order of definition
|
||||
Validator *get_validator(int index);
|
||||
|
||||
/// Sets required options
|
||||
Option *needs(Option *opt) {
|
||||
if(opt != this) {
|
||||
needs_.insert(opt);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/// Can find a string if needed
|
||||
template <typename T = App> Option *needs(std::string opt_name) {
|
||||
auto opt = static_cast<T *>(parent_)->get_option_no_throw(opt_name);
|
||||
if(opt == nullptr) {
|
||||
throw IncorrectConstruction::MissingOption(opt_name);
|
||||
}
|
||||
return needs(opt);
|
||||
}
|
||||
|
||||
/// Any number supported, any mix of string and Opt
|
||||
template <typename A, typename B, typename... ARG> Option *needs(A opt, B opt1, ARG... args) {
|
||||
needs(opt);
|
||||
return needs(opt1, args...); // NOLINT(readability-suspicious-call-argument)
|
||||
}
|
||||
|
||||
/// Remove needs link from an option. Returns true if the option really was in the needs list.
|
||||
bool remove_needs(Option *opt);
|
||||
|
||||
/// Sets excluded options
|
||||
Option *excludes(Option *opt);
|
||||
|
||||
/// Can find a string if needed
|
||||
template <typename T = App> Option *excludes(std::string opt_name) {
|
||||
auto opt = static_cast<T *>(parent_)->get_option_no_throw(opt_name);
|
||||
if(opt == nullptr) {
|
||||
throw IncorrectConstruction::MissingOption(opt_name);
|
||||
}
|
||||
return excludes(opt);
|
||||
}
|
||||
|
||||
/// Any number supported, any mix of string and Opt
|
||||
template <typename A, typename B, typename... ARG> Option *excludes(A opt, B opt1, ARG... args) {
|
||||
excludes(opt);
|
||||
return excludes(opt1, args...);
|
||||
}
|
||||
|
||||
/// Remove needs link from an option. Returns true if the option really was in the needs list.
|
||||
bool remove_excludes(Option *opt);
|
||||
|
||||
/// Sets environment variable to read if no option given
|
||||
Option *envname(std::string name) {
|
||||
envname_ = std::move(name);
|
||||
return this;
|
||||
}
|
||||
|
||||
/// Ignore case
|
||||
///
|
||||
/// The template hides the fact that we don't have the definition of App yet.
|
||||
/// You are never expected to add an argument to the template here.
|
||||
template <typename T = App> Option *ignore_case(bool value = true);
|
||||
|
||||
/// Ignore underscores in the option names
|
||||
///
|
||||
/// The template hides the fact that we don't have the definition of App yet.
|
||||
/// You are never expected to add an argument to the template here.
|
||||
template <typename T = App> Option *ignore_underscore(bool value = true);
|
||||
|
||||
/// Take the last argument if given multiple times (or another policy)
|
||||
Option *multi_option_policy(MultiOptionPolicy value = MultiOptionPolicy::Throw);
|
||||
|
||||
/// Disable flag overrides values, e.g. --flag=<value> is not allowed
|
||||
Option *disable_flag_override(bool value = true) {
|
||||
disable_flag_override_ = value;
|
||||
return this;
|
||||
}
|
||||
///@}
|
||||
/// @name Accessors
|
||||
///@{
|
||||
|
||||
/// The number of arguments the option expects
|
||||
CLI11_NODISCARD int get_type_size() const { return type_size_min_; }
|
||||
|
||||
/// The minimum number of arguments the option expects
|
||||
CLI11_NODISCARD int get_type_size_min() const { return type_size_min_; }
|
||||
/// The maximum number of arguments the option expects
|
||||
CLI11_NODISCARD int get_type_size_max() const { return type_size_max_; }
|
||||
|
||||
/// Return the inject_separator flag
|
||||
CLI11_NODISCARD bool get_inject_separator() const { return inject_separator_; }
|
||||
|
||||
/// The environment variable associated to this value
|
||||
CLI11_NODISCARD std::string get_envname() const { return envname_; }
|
||||
|
||||
/// The set of options needed
|
||||
CLI11_NODISCARD std::set<Option *> get_needs() const { return needs_; }
|
||||
|
||||
/// The set of options excluded
|
||||
CLI11_NODISCARD std::set<Option *> get_excludes() const { return excludes_; }
|
||||
|
||||
/// The default value (for help printing)
|
||||
CLI11_NODISCARD std::string get_default_str() const { return default_str_; }
|
||||
|
||||
/// Get the callback function
|
||||
CLI11_NODISCARD callback_t get_callback() const { return callback_; }
|
||||
|
||||
/// Get the long names
|
||||
CLI11_NODISCARD const std::vector<std::string> &get_lnames() const { return lnames_; }
|
||||
|
||||
/// Get the short names
|
||||
CLI11_NODISCARD const std::vector<std::string> &get_snames() const { return snames_; }
|
||||
|
||||
/// Get the flag names with specified default values
|
||||
CLI11_NODISCARD const std::vector<std::string> &get_fnames() const { return fnames_; }
|
||||
/// Get a single name for the option, first of lname, pname, sname, envname
|
||||
CLI11_NODISCARD const std::string &get_single_name() const {
|
||||
if(!lnames_.empty()) {
|
||||
return lnames_[0];
|
||||
}
|
||||
if(!pname_.empty()) {
|
||||
return pname_;
|
||||
}
|
||||
if(!snames_.empty()) {
|
||||
return snames_[0];
|
||||
}
|
||||
return envname_;
|
||||
}
|
||||
/// The number of times the option expects to be included
|
||||
CLI11_NODISCARD int get_expected() const { return expected_min_; }
|
||||
|
||||
/// The number of times the option expects to be included
|
||||
CLI11_NODISCARD int get_expected_min() const { return expected_min_; }
|
||||
/// The max number of times the option expects to be included
|
||||
CLI11_NODISCARD int get_expected_max() const { return expected_max_; }
|
||||
|
||||
/// The total min number of expected string values to be used
|
||||
CLI11_NODISCARD int get_items_expected_min() const { return type_size_min_ * expected_min_; }
|
||||
|
||||
/// Get the maximum number of items expected to be returned and used for the callback
|
||||
CLI11_NODISCARD int get_items_expected_max() const {
|
||||
int t = type_size_max_;
|
||||
return detail::checked_multiply(t, expected_max_) ? t : detail::expected_max_vector_size;
|
||||
}
|
||||
/// The total min number of expected string values to be used
|
||||
CLI11_NODISCARD int get_items_expected() const { return get_items_expected_min(); }
|
||||
|
||||
/// True if the argument can be given directly
|
||||
CLI11_NODISCARD bool get_positional() const { return pname_.length() > 0; }
|
||||
|
||||
/// True if option has at least one non-positional name
|
||||
CLI11_NODISCARD bool nonpositional() const { return (snames_.size() + lnames_.size()) > 0; }
|
||||
|
||||
/// True if option has description
|
||||
CLI11_NODISCARD bool has_description() const { return description_.length() > 0; }
|
||||
|
||||
/// Get the description
|
||||
CLI11_NODISCARD const std::string &get_description() const { return description_; }
|
||||
|
||||
/// Set the description
|
||||
Option *description(std::string option_description) {
|
||||
description_ = std::move(option_description);
|
||||
return this;
|
||||
}
|
||||
|
||||
Option *option_text(std::string text) {
|
||||
option_text_ = std::move(text);
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_NODISCARD const std::string &get_option_text() const { return option_text_; }
|
||||
|
||||
///@}
|
||||
/// @name Help tools
|
||||
///@{
|
||||
|
||||
/// \brief Gets a comma separated list of names.
|
||||
/// Will include / prefer the positional name if positional is true.
|
||||
/// If all_options is false, pick just the most descriptive name to show.
|
||||
/// Use `get_name(true)` to get the positional name (replaces `get_pname`)
|
||||
CLI11_NODISCARD std::string get_name(bool positional = false, ///< Show the positional name
|
||||
bool all_options = false ///< Show every option
|
||||
) const;
|
||||
|
||||
///@}
|
||||
/// @name Parser tools
|
||||
///@{
|
||||
|
||||
/// Process the callback
|
||||
void run_callback();
|
||||
|
||||
/// If options share any of the same names, find it
|
||||
CLI11_NODISCARD const std::string &matching_name(const Option &other) const;
|
||||
|
||||
/// If options share any of the same names, they are equal (not counting positional)
|
||||
bool operator==(const Option &other) const { return !matching_name(other).empty(); }
|
||||
|
||||
/// Check a name. Requires "-" or "--" for short / long, supports positional name
|
||||
CLI11_NODISCARD bool check_name(const std::string &name) const;
|
||||
|
||||
/// Requires "-" to be removed from string
|
||||
CLI11_NODISCARD bool check_sname(std::string name) const {
|
||||
return (detail::find_member(std::move(name), snames_, ignore_case_) >= 0);
|
||||
}
|
||||
|
||||
/// Requires "--" to be removed from string
|
||||
CLI11_NODISCARD bool check_lname(std::string name) const {
|
||||
return (detail::find_member(std::move(name), lnames_, ignore_case_, ignore_underscore_) >= 0);
|
||||
}
|
||||
|
||||
/// Requires "--" to be removed from string
|
||||
CLI11_NODISCARD bool check_fname(std::string name) const {
|
||||
if(fnames_.empty()) {
|
||||
return false;
|
||||
}
|
||||
return (detail::find_member(std::move(name), fnames_, ignore_case_, ignore_underscore_) >= 0);
|
||||
}
|
||||
|
||||
/// Get the value that goes for a flag, nominally gets the default value but allows for overrides if not
|
||||
/// disabled
|
||||
CLI11_NODISCARD std::string get_flag_value(const std::string &name, std::string input_value) const;
|
||||
|
||||
/// Puts a result at the end
|
||||
Option *add_result(std::string s);
|
||||
|
||||
/// Puts a result at the end and get a count of the number of arguments actually added
|
||||
Option *add_result(std::string s, int &results_added);
|
||||
|
||||
/// Puts a result at the end
|
||||
Option *add_result(std::vector<std::string> s);
|
||||
|
||||
/// Get the current complete results set
|
||||
CLI11_NODISCARD const results_t &results() const { return results_; }
|
||||
|
||||
/// Get a copy of the results
|
||||
CLI11_NODISCARD results_t reduced_results() const;
|
||||
|
||||
/// Get the results as a specified type
|
||||
template <typename T> void results(T &output) const {
|
||||
bool retval = false;
|
||||
if(current_option_state_ >= option_state::reduced || (results_.size() == 1 && validators_.empty())) {
|
||||
const results_t &res = (proc_results_.empty()) ? results_ : proc_results_;
|
||||
retval = detail::lexical_conversion<T, T>(res, output);
|
||||
} else {
|
||||
results_t res;
|
||||
if(results_.empty()) {
|
||||
if(!default_str_.empty()) {
|
||||
// _add_results takes an rvalue only
|
||||
_add_result(std::string(default_str_), res);
|
||||
_validate_results(res);
|
||||
results_t extra;
|
||||
_reduce_results(extra, res);
|
||||
if(!extra.empty()) {
|
||||
res = std::move(extra);
|
||||
}
|
||||
} else {
|
||||
res.emplace_back();
|
||||
}
|
||||
} else {
|
||||
res = reduced_results();
|
||||
}
|
||||
retval = detail::lexical_conversion<T, T>(res, output);
|
||||
}
|
||||
if(!retval) {
|
||||
throw ConversionError(get_name(), results_);
|
||||
}
|
||||
}
|
||||
|
||||
/// Return the results as the specified type
|
||||
template <typename T> CLI11_NODISCARD T as() const {
|
||||
T output;
|
||||
results(output);
|
||||
return output;
|
||||
}
|
||||
|
||||
/// See if the callback has been run already
|
||||
CLI11_NODISCARD bool get_callback_run() const { return (current_option_state_ == option_state::callback_run); }
|
||||
|
||||
///@}
|
||||
/// @name Custom options
|
||||
///@{
|
||||
|
||||
/// Set the type function to run when displayed on this option
|
||||
Option *type_name_fn(std::function<std::string()> typefun) {
|
||||
type_name_ = std::move(typefun);
|
||||
return this;
|
||||
}
|
||||
|
||||
/// Set a custom option typestring
|
||||
Option *type_name(std::string typeval) {
|
||||
type_name_fn([typeval]() { return typeval; });
|
||||
return this;
|
||||
}
|
||||
|
||||
/// Set a custom option size
|
||||
Option *type_size(int option_type_size);
|
||||
|
||||
/// Set a custom option type size range
|
||||
Option *type_size(int option_type_size_min, int option_type_size_max);
|
||||
|
||||
/// Set the value of the separator injection flag
|
||||
void inject_separator(bool value = true) { inject_separator_ = value; }
|
||||
|
||||
/// Set a capture function for the default. Mostly used by App.
|
||||
Option *default_function(const std::function<std::string()> &func) {
|
||||
default_function_ = func;
|
||||
return this;
|
||||
}
|
||||
|
||||
/// Capture the default value from the original value (if it can be captured)
|
||||
Option *capture_default_str() {
|
||||
if(default_function_) {
|
||||
default_str_ = default_function_();
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
/// Set the default value string representation (does not change the contained value)
|
||||
Option *default_str(std::string val) {
|
||||
default_str_ = std::move(val);
|
||||
return this;
|
||||
}
|
||||
|
||||
/// Set the default value and validate the results and run the callback if appropriate to set the value into the
|
||||
/// bound value only available for types that can be converted to a string
|
||||
template <typename X> Option *default_val(const X &val) {
|
||||
std::string val_str = detail::to_string(val);
|
||||
auto old_option_state = current_option_state_;
|
||||
results_t old_results{std::move(results_)};
|
||||
results_.clear();
|
||||
try {
|
||||
add_result(val_str);
|
||||
// if trigger_on_result_ is set the callback already ran
|
||||
if(run_callback_for_default_ && !trigger_on_result_) {
|
||||
run_callback(); // run callback sets the state, we need to reset it again
|
||||
current_option_state_ = option_state::parsing;
|
||||
} else {
|
||||
_validate_results(results_);
|
||||
current_option_state_ = old_option_state;
|
||||
}
|
||||
} catch(const CLI::Error &) {
|
||||
// this should be done
|
||||
results_ = std::move(old_results);
|
||||
current_option_state_ = old_option_state;
|
||||
throw;
|
||||
}
|
||||
results_ = std::move(old_results);
|
||||
default_str_ = std::move(val_str);
|
||||
return this;
|
||||
}
|
||||
|
||||
/// Get the full typename for this option
|
||||
CLI11_NODISCARD std::string get_type_name() const;
|
||||
|
||||
private:
|
||||
/// Run the results through the Validators
|
||||
void _validate_results(results_t &res) const;
|
||||
|
||||
/** reduce the results in accordance with the MultiOptionPolicy
|
||||
@param[out] out results are assigned to res if there if they are different
|
||||
*/
|
||||
void _reduce_results(results_t &out, const results_t &original) const;
|
||||
|
||||
// Run a result through the Validators
|
||||
std::string _validate(std::string &result, int index) const;
|
||||
|
||||
/// Add a single result to the result set, taking into account delimiters
|
||||
int _add_result(std::string &&result, std::vector<std::string> &res) const;
|
||||
};
|
||||
|
||||
// [CLI11:option_hpp:end]
|
||||
} // namespace CLI
|
||||
|
||||
#ifndef CLI11_COMPILE
|
||||
#include "impl/Option_inl.hpp"
|
||||
#endif
|
||||
48
libs/CLI11/include/CLI/Split.hpp
Normal file
48
libs/CLI11/include/CLI/Split.hpp
Normal file
@@ -0,0 +1,48 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <string>
|
||||
#include <tuple>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
#include "Macros.hpp"
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:split_hpp:verbatim]
|
||||
|
||||
namespace detail {
|
||||
|
||||
// Returns false if not a short option. Otherwise, sets opt name and rest and returns true
|
||||
CLI11_INLINE bool split_short(const std::string ¤t, std::string &name, std::string &rest);
|
||||
|
||||
// Returns false if not a long option. Otherwise, sets opt name and other side of = and returns true
|
||||
CLI11_INLINE bool split_long(const std::string ¤t, std::string &name, std::string &value);
|
||||
|
||||
// Returns false if not a windows style option. Otherwise, sets opt name and value and returns true
|
||||
CLI11_INLINE bool split_windows_style(const std::string ¤t, std::string &name, std::string &value);
|
||||
|
||||
// Splits a string into multiple long and short names
|
||||
CLI11_INLINE std::vector<std::string> split_names(std::string current);
|
||||
|
||||
/// extract default flag values either {def} or starting with a !
|
||||
CLI11_INLINE std::vector<std::pair<std::string, std::string>> get_default_flag_values(const std::string &str);
|
||||
|
||||
/// Get a vector of short names, one of long names, and a single name
|
||||
CLI11_INLINE std::tuple<std::vector<std::string>, std::vector<std::string>, std::string>
|
||||
get_names(const std::vector<std::string> &input);
|
||||
|
||||
} // namespace detail
|
||||
// [CLI11:split_hpp:end]
|
||||
} // namespace CLI
|
||||
|
||||
#ifndef CLI11_COMPILE
|
||||
#include "impl/Split_inl.hpp"
|
||||
#endif
|
||||
234
libs/CLI11/include/CLI/StringTools.hpp
Normal file
234
libs/CLI11/include/CLI/StringTools.hpp
Normal file
@@ -0,0 +1,234 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <algorithm>
|
||||
#include <iomanip>
|
||||
#include <locale>
|
||||
#include <sstream>
|
||||
#include <stdexcept>
|
||||
#include <string>
|
||||
#include <type_traits>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
#include "Macros.hpp"
|
||||
|
||||
namespace CLI {
|
||||
|
||||
// [CLI11:string_tools_hpp:verbatim]
|
||||
|
||||
/// Include the items in this namespace to get free conversion of enums to/from streams.
|
||||
/// (This is available inside CLI as well, so CLI11 will use this without a using statement).
|
||||
namespace enums {
|
||||
|
||||
/// output streaming for enumerations
|
||||
template <typename T, typename = typename std::enable_if<std::is_enum<T>::value>::type>
|
||||
std::ostream &operator<<(std::ostream &in, const T &item) {
|
||||
// make sure this is out of the detail namespace otherwise it won't be found when needed
|
||||
return in << static_cast<typename std::underlying_type<T>::type>(item);
|
||||
}
|
||||
|
||||
} // namespace enums
|
||||
|
||||
/// Export to CLI namespace
|
||||
using enums::operator<<;
|
||||
|
||||
namespace detail {
|
||||
/// a constant defining an expected max vector size defined to be a big number that could be multiplied by 4 and not
|
||||
/// produce overflow for some expected uses
|
||||
constexpr int expected_max_vector_size{1 << 29};
|
||||
// Based on http://stackoverflow.com/questions/236129/split-a-string-in-c
|
||||
/// Split a string by a delim
|
||||
CLI11_INLINE std::vector<std::string> split(const std::string &s, char delim);
|
||||
|
||||
/// Simple function to join a string
|
||||
template <typename T> std::string join(const T &v, std::string delim = ",") {
|
||||
std::ostringstream s;
|
||||
auto beg = std::begin(v);
|
||||
auto end = std::end(v);
|
||||
if(beg != end)
|
||||
s << *beg++;
|
||||
while(beg != end) {
|
||||
s << delim << *beg++;
|
||||
}
|
||||
return s.str();
|
||||
}
|
||||
|
||||
/// Simple function to join a string from processed elements
|
||||
template <typename T,
|
||||
typename Callable,
|
||||
typename = typename std::enable_if<!std::is_constructible<std::string, Callable>::value>::type>
|
||||
std::string join(const T &v, Callable func, std::string delim = ",") {
|
||||
std::ostringstream s;
|
||||
auto beg = std::begin(v);
|
||||
auto end = std::end(v);
|
||||
auto loc = s.tellp();
|
||||
while(beg != end) {
|
||||
auto nloc = s.tellp();
|
||||
if(nloc > loc) {
|
||||
s << delim;
|
||||
loc = nloc;
|
||||
}
|
||||
s << func(*beg++);
|
||||
}
|
||||
return s.str();
|
||||
}
|
||||
|
||||
/// Join a string in reverse order
|
||||
template <typename T> std::string rjoin(const T &v, std::string delim = ",") {
|
||||
std::ostringstream s;
|
||||
for(std::size_t start = 0; start < v.size(); start++) {
|
||||
if(start > 0)
|
||||
s << delim;
|
||||
s << v[v.size() - start - 1];
|
||||
}
|
||||
return s.str();
|
||||
}
|
||||
|
||||
// Based roughly on http://stackoverflow.com/questions/25829143/c-trim-whitespace-from-a-string
|
||||
|
||||
/// Trim whitespace from left of string
|
||||
CLI11_INLINE std::string <rim(std::string &str);
|
||||
|
||||
/// Trim anything from left of string
|
||||
CLI11_INLINE std::string <rim(std::string &str, const std::string &filter);
|
||||
|
||||
/// Trim whitespace from right of string
|
||||
CLI11_INLINE std::string &rtrim(std::string &str);
|
||||
|
||||
/// Trim anything from right of string
|
||||
CLI11_INLINE std::string &rtrim(std::string &str, const std::string &filter);
|
||||
|
||||
/// Trim whitespace from string
|
||||
inline std::string &trim(std::string &str) { return ltrim(rtrim(str)); }
|
||||
|
||||
/// Trim anything from string
|
||||
inline std::string &trim(std::string &str, const std::string filter) { return ltrim(rtrim(str, filter), filter); }
|
||||
|
||||
/// Make a copy of the string and then trim it
|
||||
inline std::string trim_copy(const std::string &str) {
|
||||
std::string s = str;
|
||||
return trim(s);
|
||||
}
|
||||
|
||||
/// remove quotes at the front and back of a string either '"' or '\''
|
||||
CLI11_INLINE std::string &remove_quotes(std::string &str);
|
||||
|
||||
/// Add a leader to the beginning of all new lines (nothing is added
|
||||
/// at the start of the first line). `"; "` would be for ini files
|
||||
///
|
||||
/// Can't use Regex, or this would be a subs.
|
||||
CLI11_INLINE std::string fix_newlines(const std::string &leader, std::string input);
|
||||
|
||||
/// Make a copy of the string and then trim it, any filter string can be used (any char in string is filtered)
|
||||
inline std::string trim_copy(const std::string &str, const std::string &filter) {
|
||||
std::string s = str;
|
||||
return trim(s, filter);
|
||||
}
|
||||
/// Print a two part "help" string
|
||||
CLI11_INLINE std::ostream &
|
||||
format_help(std::ostream &out, std::string name, const std::string &description, std::size_t wid);
|
||||
|
||||
/// Print subcommand aliases
|
||||
CLI11_INLINE std::ostream &format_aliases(std::ostream &out, const std::vector<std::string> &aliases, std::size_t wid);
|
||||
|
||||
/// Verify the first character of an option
|
||||
/// - is a trigger character, ! has special meaning and new lines would just be annoying to deal with
|
||||
template <typename T> bool valid_first_char(T c) { return ((c != '-') && (c != '!') && (c != ' ') && c != '\n'); }
|
||||
|
||||
/// Verify following characters of an option
|
||||
template <typename T> bool valid_later_char(T c) {
|
||||
// = and : are value separators, { has special meaning for option defaults,
|
||||
// and \n would just be annoying to deal with in many places allowing space here has too much potential for
|
||||
// inadvertent entry errors and bugs
|
||||
return ((c != '=') && (c != ':') && (c != '{') && (c != ' ') && c != '\n');
|
||||
}
|
||||
|
||||
/// Verify an option/subcommand name
|
||||
CLI11_INLINE bool valid_name_string(const std::string &str);
|
||||
|
||||
/// Verify an app name
|
||||
inline bool valid_alias_name_string(const std::string &str) {
|
||||
static const std::string badChars(std::string("\n") + '\0');
|
||||
return (str.find_first_of(badChars) == std::string::npos);
|
||||
}
|
||||
|
||||
/// check if a string is a container segment separator (empty or "%%")
|
||||
inline bool is_separator(const std::string &str) {
|
||||
static const std::string sep("%%");
|
||||
return (str.empty() || str == sep);
|
||||
}
|
||||
|
||||
/// Verify that str consists of letters only
|
||||
inline bool isalpha(const std::string &str) {
|
||||
return std::all_of(str.begin(), str.end(), [](char c) { return std::isalpha(c, std::locale()); });
|
||||
}
|
||||
|
||||
/// Return a lower case version of a string
|
||||
inline std::string to_lower(std::string str) {
|
||||
std::transform(std::begin(str), std::end(str), std::begin(str), [](const std::string::value_type &x) {
|
||||
return std::tolower(x, std::locale());
|
||||
});
|
||||
return str;
|
||||
}
|
||||
|
||||
/// remove underscores from a string
|
||||
inline std::string remove_underscore(std::string str) {
|
||||
str.erase(std::remove(std::begin(str), std::end(str), '_'), std::end(str));
|
||||
return str;
|
||||
}
|
||||
|
||||
/// Find and replace a substring with another substring
|
||||
CLI11_INLINE std::string find_and_replace(std::string str, std::string from, std::string to);
|
||||
|
||||
/// check if the flag definitions has possible false flags
|
||||
inline bool has_default_flag_values(const std::string &flags) {
|
||||
return (flags.find_first_of("{!") != std::string::npos);
|
||||
}
|
||||
|
||||
CLI11_INLINE void remove_default_flag_values(std::string &flags);
|
||||
|
||||
/// Check if a string is a member of a list of strings and optionally ignore case or ignore underscores
|
||||
CLI11_INLINE std::ptrdiff_t find_member(std::string name,
|
||||
const std::vector<std::string> names,
|
||||
bool ignore_case = false,
|
||||
bool ignore_underscore = false);
|
||||
|
||||
/// Find a trigger string and call a modify callable function that takes the current string and starting position of the
|
||||
/// trigger and returns the position in the string to search for the next trigger string
|
||||
template <typename Callable> inline std::string find_and_modify(std::string str, std::string trigger, Callable modify) {
|
||||
std::size_t start_pos = 0;
|
||||
while((start_pos = str.find(trigger, start_pos)) != std::string::npos) {
|
||||
start_pos = modify(str, start_pos);
|
||||
}
|
||||
return str;
|
||||
}
|
||||
|
||||
/// Split a string '"one two" "three"' into 'one two', 'three'
|
||||
/// Quote characters can be ` ' or "
|
||||
CLI11_INLINE std::vector<std::string> split_up(std::string str, char delimiter = '\0');
|
||||
|
||||
/// This function detects an equal or colon followed by an escaped quote after an argument
|
||||
/// then modifies the string to replace the equality with a space. This is needed
|
||||
/// to allow the split up function to work properly and is intended to be used with the find_and_modify function
|
||||
/// the return value is the offset+1 which is required by the find_and_modify function.
|
||||
CLI11_INLINE std::size_t escape_detect(std::string &str, std::size_t offset);
|
||||
|
||||
/// Add quotes if the string contains spaces
|
||||
CLI11_INLINE std::string &add_quotes_if_needed(std::string &str);
|
||||
|
||||
} // namespace detail
|
||||
|
||||
// [CLI11:string_tools_hpp:end]
|
||||
|
||||
} // namespace CLI
|
||||
|
||||
#ifndef CLI11_COMPILE
|
||||
#include "impl/StringTools_inl.hpp"
|
||||
#endif
|
||||
135
libs/CLI11/include/CLI/Timer.hpp
Normal file
135
libs/CLI11/include/CLI/Timer.hpp
Normal file
@@ -0,0 +1,135 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// On GCC < 4.8, the following define is often missing. Due to the
|
||||
// fact that this library only uses sleep_for, this should be safe
|
||||
#if defined(__GNUC__) && !defined(__clang__) && __GNUC__ < 5 && __GNUC_MINOR__ < 8
|
||||
#define _GLIBCXX_USE_NANOSLEEP
|
||||
#endif
|
||||
|
||||
#include <cmath>
|
||||
|
||||
#include <array>
|
||||
#include <chrono>
|
||||
#include <functional>
|
||||
#include <iostream>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
|
||||
namespace CLI {
|
||||
|
||||
/// This is a simple timer with pretty printing. Creating the timer starts counting.
|
||||
class Timer {
|
||||
protected:
|
||||
/// This is a typedef to make clocks easier to use
|
||||
using clock = std::chrono::steady_clock;
|
||||
|
||||
/// This typedef is for points in time
|
||||
using time_point = std::chrono::time_point<clock>;
|
||||
|
||||
/// This is the type of a printing function, you can make your own
|
||||
using time_print_t = std::function<std::string(std::string, std::string)>;
|
||||
|
||||
/// This is the title of the timer
|
||||
std::string title_;
|
||||
|
||||
/// This is the function that is used to format most of the timing message
|
||||
time_print_t time_print_;
|
||||
|
||||
/// This is the starting point (when the timer was created)
|
||||
time_point start_;
|
||||
|
||||
/// This is the number of times cycles (print divides by this number)
|
||||
std::size_t cycles{1};
|
||||
|
||||
public:
|
||||
/// Standard print function, this one is set by default
|
||||
static std::string Simple(std::string title, std::string time) { return title + ": " + time; }
|
||||
|
||||
/// This is a fancy print function with --- headers
|
||||
static std::string Big(std::string title, std::string time) {
|
||||
return std::string("-----------------------------------------\n") + "| " + title + " | Time = " + time + "\n" +
|
||||
"-----------------------------------------";
|
||||
}
|
||||
|
||||
public:
|
||||
/// Standard constructor, can set title and print function
|
||||
explicit Timer(std::string title = "Timer", time_print_t time_print = Simple)
|
||||
: title_(std::move(title)), time_print_(std::move(time_print)), start_(clock::now()) {}
|
||||
|
||||
/// Time a function by running it multiple times. Target time is the len to target.
|
||||
std::string time_it(std::function<void()> f, double target_time = 1) {
|
||||
time_point start = start_;
|
||||
double total_time = NAN;
|
||||
|
||||
start_ = clock::now();
|
||||
std::size_t n = 0;
|
||||
do {
|
||||
f();
|
||||
std::chrono::duration<double> elapsed = clock::now() - start_;
|
||||
total_time = elapsed.count();
|
||||
} while(n++ < 100u && total_time < target_time);
|
||||
|
||||
std::string out = make_time_str(total_time / static_cast<double>(n)) + " for " + std::to_string(n) + " tries";
|
||||
start_ = start;
|
||||
return out;
|
||||
}
|
||||
|
||||
/// This formats the numerical value for the time string
|
||||
std::string make_time_str() const { // NOLINT(modernize-use-nodiscard)
|
||||
time_point stop = clock::now();
|
||||
std::chrono::duration<double> elapsed = stop - start_;
|
||||
double time = elapsed.count() / static_cast<double>(cycles);
|
||||
return make_time_str(time);
|
||||
}
|
||||
|
||||
// LCOV_EXCL_START
|
||||
/// This prints out a time string from a time
|
||||
std::string make_time_str(double time) const { // NOLINT(modernize-use-nodiscard)
|
||||
auto print_it = [](double x, std::string unit) {
|
||||
const unsigned int buffer_length = 50;
|
||||
std::array<char, buffer_length> buffer;
|
||||
std::snprintf(buffer.data(), buffer_length, "%.5g", x);
|
||||
return buffer.data() + std::string(" ") + unit;
|
||||
};
|
||||
|
||||
if(time < .000001)
|
||||
return print_it(time * 1000000000, "ns");
|
||||
if(time < .001)
|
||||
return print_it(time * 1000000, "us");
|
||||
if(time < 1)
|
||||
return print_it(time * 1000, "ms");
|
||||
return print_it(time, "s");
|
||||
}
|
||||
// LCOV_EXCL_STOP
|
||||
|
||||
/// This is the main function, it creates a string
|
||||
std::string to_string() const { return time_print_(title_, make_time_str()); } // NOLINT(modernize-use-nodiscard)
|
||||
|
||||
/// Division sets the number of cycles to divide by (no graphical change)
|
||||
Timer &operator/(std::size_t val) {
|
||||
cycles = val;
|
||||
return *this;
|
||||
}
|
||||
};
|
||||
|
||||
/// This class prints out the time upon destruction
|
||||
class AutoTimer : public Timer {
|
||||
public:
|
||||
/// Reimplementing the constructor is required in GCC 4.7
|
||||
explicit AutoTimer(std::string title = "Timer", time_print_t time_print = Simple) : Timer(title, time_print) {}
|
||||
// GCC 4.7 does not support using inheriting constructors.
|
||||
|
||||
/// This destructor prints the string
|
||||
~AutoTimer() { std::cout << to_string() << std::endl; }
|
||||
};
|
||||
|
||||
} // namespace CLI
|
||||
|
||||
/// This prints out the time if shifted into a std::cout like stream.
|
||||
inline std::ostream &operator<<(std::ostream &in, const CLI::Timer &timer) { return in << timer.to_string(); }
|
||||
1588
libs/CLI11/include/CLI/TypeTools.hpp
Normal file
1588
libs/CLI11/include/CLI/TypeTools.hpp
Normal file
File diff suppressed because it is too large
Load Diff
908
libs/CLI11/include/CLI/Validators.hpp
Normal file
908
libs/CLI11/include/CLI/Validators.hpp
Normal file
@@ -0,0 +1,908 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "Error.hpp"
|
||||
#include "Macros.hpp"
|
||||
#include "StringTools.hpp"
|
||||
#include "TypeTools.hpp"
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <cmath>
|
||||
#include <cstdint>
|
||||
#include <functional>
|
||||
#include <iostream>
|
||||
#include <limits>
|
||||
#include <map>
|
||||
#include <memory>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
// [CLI11:validators_hpp_filesystem:verbatim]
|
||||
|
||||
// C standard library
|
||||
// Only needed for existence checking
|
||||
#if defined CLI11_CPP17 && defined __has_include && !defined CLI11_HAS_FILESYSTEM
|
||||
#if __has_include(<filesystem>)
|
||||
// Filesystem cannot be used if targeting macOS < 10.15
|
||||
#if defined __MAC_OS_X_VERSION_MIN_REQUIRED && __MAC_OS_X_VERSION_MIN_REQUIRED < 101500
|
||||
#define CLI11_HAS_FILESYSTEM 0
|
||||
#elif defined(__wasi__)
|
||||
// As of wasi-sdk-14, filesystem is not implemented
|
||||
#define CLI11_HAS_FILESYSTEM 0
|
||||
#else
|
||||
#include <filesystem>
|
||||
#if defined __cpp_lib_filesystem && __cpp_lib_filesystem >= 201703
|
||||
#if defined _GLIBCXX_RELEASE && _GLIBCXX_RELEASE >= 9
|
||||
#define CLI11_HAS_FILESYSTEM 1
|
||||
#elif defined(__GLIBCXX__)
|
||||
// if we are using gcc and Version <9 default to no filesystem
|
||||
#define CLI11_HAS_FILESYSTEM 0
|
||||
#else
|
||||
#define CLI11_HAS_FILESYSTEM 1
|
||||
#endif
|
||||
#else
|
||||
#define CLI11_HAS_FILESYSTEM 0
|
||||
#endif
|
||||
#endif
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#if defined CLI11_HAS_FILESYSTEM && CLI11_HAS_FILESYSTEM > 0
|
||||
#include <filesystem> // NOLINT(build/include)
|
||||
#else
|
||||
#include <sys/stat.h>
|
||||
#include <sys/types.h>
|
||||
#endif
|
||||
|
||||
// [CLI11:validators_hpp_filesystem:end]
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:validators_hpp:verbatim]
|
||||
|
||||
class Option;
|
||||
|
||||
/// @defgroup validator_group Validators
|
||||
|
||||
/// @brief Some validators that are provided
|
||||
///
|
||||
/// These are simple `std::string(const std::string&)` validators that are useful. They return
|
||||
/// a string if the validation fails. A custom struct is provided, as well, with the same user
|
||||
/// semantics, but with the ability to provide a new type name.
|
||||
/// @{
|
||||
|
||||
///
|
||||
class Validator {
|
||||
protected:
|
||||
/// This is the description function, if empty the description_ will be used
|
||||
std::function<std::string()> desc_function_{[]() { return std::string{}; }};
|
||||
|
||||
/// This is the base function that is to be called.
|
||||
/// Returns a string error message if validation fails.
|
||||
std::function<std::string(std::string &)> func_{[](std::string &) { return std::string{}; }};
|
||||
/// The name for search purposes of the Validator
|
||||
std::string name_{};
|
||||
/// A Validator will only apply to an indexed value (-1 is all elements)
|
||||
int application_index_ = -1;
|
||||
/// Enable for Validator to allow it to be disabled if need be
|
||||
bool active_{true};
|
||||
/// specify that a validator should not modify the input
|
||||
bool non_modifying_{false};
|
||||
|
||||
Validator(std::string validator_desc, std::function<std::string(std::string &)> func)
|
||||
: desc_function_([validator_desc]() { return validator_desc; }), func_(std::move(func)) {}
|
||||
|
||||
public:
|
||||
Validator() = default;
|
||||
/// Construct a Validator with just the description string
|
||||
explicit Validator(std::string validator_desc) : desc_function_([validator_desc]() { return validator_desc; }) {}
|
||||
/// Construct Validator from basic information
|
||||
Validator(std::function<std::string(std::string &)> op, std::string validator_desc, std::string validator_name = "")
|
||||
: desc_function_([validator_desc]() { return validator_desc; }), func_(std::move(op)),
|
||||
name_(std::move(validator_name)) {}
|
||||
/// Set the Validator operation function
|
||||
Validator &operation(std::function<std::string(std::string &)> op) {
|
||||
func_ = std::move(op);
|
||||
return *this;
|
||||
}
|
||||
/// This is the required operator for a Validator - provided to help
|
||||
/// users (CLI11 uses the member `func` directly)
|
||||
std::string operator()(std::string &str) const;
|
||||
|
||||
/// This is the required operator for a Validator - provided to help
|
||||
/// users (CLI11 uses the member `func` directly)
|
||||
std::string operator()(const std::string &str) const {
|
||||
std::string value = str;
|
||||
return (active_) ? func_(value) : std::string{};
|
||||
}
|
||||
|
||||
/// Specify the type string
|
||||
Validator &description(std::string validator_desc) {
|
||||
desc_function_ = [validator_desc]() { return validator_desc; };
|
||||
return *this;
|
||||
}
|
||||
/// Specify the type string
|
||||
CLI11_NODISCARD Validator description(std::string validator_desc) const;
|
||||
|
||||
/// Generate type description information for the Validator
|
||||
CLI11_NODISCARD std::string get_description() const {
|
||||
if(active_) {
|
||||
return desc_function_();
|
||||
}
|
||||
return std::string{};
|
||||
}
|
||||
/// Specify the type string
|
||||
Validator &name(std::string validator_name) {
|
||||
name_ = std::move(validator_name);
|
||||
return *this;
|
||||
}
|
||||
/// Specify the type string
|
||||
CLI11_NODISCARD Validator name(std::string validator_name) const {
|
||||
Validator newval(*this);
|
||||
newval.name_ = std::move(validator_name);
|
||||
return newval;
|
||||
}
|
||||
/// Get the name of the Validator
|
||||
CLI11_NODISCARD const std::string &get_name() const { return name_; }
|
||||
/// Specify whether the Validator is active or not
|
||||
Validator &active(bool active_val = true) {
|
||||
active_ = active_val;
|
||||
return *this;
|
||||
}
|
||||
/// Specify whether the Validator is active or not
|
||||
CLI11_NODISCARD Validator active(bool active_val = true) const {
|
||||
Validator newval(*this);
|
||||
newval.active_ = active_val;
|
||||
return newval;
|
||||
}
|
||||
|
||||
/// Specify whether the Validator can be modifying or not
|
||||
Validator &non_modifying(bool no_modify = true) {
|
||||
non_modifying_ = no_modify;
|
||||
return *this;
|
||||
}
|
||||
/// Specify the application index of a validator
|
||||
Validator &application_index(int app_index) {
|
||||
application_index_ = app_index;
|
||||
return *this;
|
||||
}
|
||||
/// Specify the application index of a validator
|
||||
CLI11_NODISCARD Validator application_index(int app_index) const {
|
||||
Validator newval(*this);
|
||||
newval.application_index_ = app_index;
|
||||
return newval;
|
||||
}
|
||||
/// Get the current value of the application index
|
||||
CLI11_NODISCARD int get_application_index() const { return application_index_; }
|
||||
/// Get a boolean if the validator is active
|
||||
CLI11_NODISCARD bool get_active() const { return active_; }
|
||||
|
||||
/// Get a boolean if the validator is allowed to modify the input returns true if it can modify the input
|
||||
CLI11_NODISCARD bool get_modifying() const { return !non_modifying_; }
|
||||
|
||||
/// Combining validators is a new validator. Type comes from left validator if function, otherwise only set if the
|
||||
/// same.
|
||||
Validator operator&(const Validator &other) const;
|
||||
|
||||
/// Combining validators is a new validator. Type comes from left validator if function, otherwise only set if the
|
||||
/// same.
|
||||
Validator operator|(const Validator &other) const;
|
||||
|
||||
/// Create a validator that fails when a given validator succeeds
|
||||
Validator operator!() const;
|
||||
|
||||
private:
|
||||
void _merge_description(const Validator &val1, const Validator &val2, const std::string &merger);
|
||||
};
|
||||
|
||||
/// Class wrapping some of the accessors of Validator
|
||||
class CustomValidator : public Validator {
|
||||
public:
|
||||
};
|
||||
// The implementation of the built in validators is using the Validator class;
|
||||
// the user is only expected to use the const (static) versions (since there's no setup).
|
||||
// Therefore, this is in detail.
|
||||
namespace detail {
|
||||
|
||||
/// CLI enumeration of different file types
|
||||
enum class path_type { nonexistent, file, directory };
|
||||
|
||||
/// get the type of the path from a file name
|
||||
CLI11_INLINE path_type check_path(const char *file) noexcept;
|
||||
|
||||
/// Check for an existing file (returns error message if check fails)
|
||||
class ExistingFileValidator : public Validator {
|
||||
public:
|
||||
ExistingFileValidator();
|
||||
};
|
||||
|
||||
/// Check for an existing directory (returns error message if check fails)
|
||||
class ExistingDirectoryValidator : public Validator {
|
||||
public:
|
||||
ExistingDirectoryValidator();
|
||||
};
|
||||
|
||||
/// Check for an existing path
|
||||
class ExistingPathValidator : public Validator {
|
||||
public:
|
||||
ExistingPathValidator();
|
||||
};
|
||||
|
||||
/// Check for an non-existing path
|
||||
class NonexistentPathValidator : public Validator {
|
||||
public:
|
||||
NonexistentPathValidator();
|
||||
};
|
||||
|
||||
/// Validate the given string is a legal ipv4 address
|
||||
class IPV4Validator : public Validator {
|
||||
public:
|
||||
IPV4Validator();
|
||||
};
|
||||
|
||||
} // namespace detail
|
||||
|
||||
// Static is not needed here, because global const implies static.
|
||||
|
||||
/// Check for existing file (returns error message if check fails)
|
||||
const detail::ExistingFileValidator ExistingFile;
|
||||
|
||||
/// Check for an existing directory (returns error message if check fails)
|
||||
const detail::ExistingDirectoryValidator ExistingDirectory;
|
||||
|
||||
/// Check for an existing path
|
||||
const detail::ExistingPathValidator ExistingPath;
|
||||
|
||||
/// Check for an non-existing path
|
||||
const detail::NonexistentPathValidator NonexistentPath;
|
||||
|
||||
/// Check for an IP4 address
|
||||
const detail::IPV4Validator ValidIPV4;
|
||||
|
||||
/// Validate the input as a particular type
|
||||
template <typename DesiredType> class TypeValidator : public Validator {
|
||||
public:
|
||||
explicit TypeValidator(const std::string &validator_name)
|
||||
: Validator(validator_name, [](std::string &input_string) {
|
||||
auto val = DesiredType();
|
||||
if(!detail::lexical_cast(input_string, val)) {
|
||||
return std::string("Failed parsing ") + input_string + " as a " + detail::type_name<DesiredType>();
|
||||
}
|
||||
return std::string();
|
||||
}) {}
|
||||
TypeValidator() : TypeValidator(detail::type_name<DesiredType>()) {}
|
||||
};
|
||||
|
||||
/// Check for a number
|
||||
const TypeValidator<double> Number("NUMBER");
|
||||
|
||||
/// Modify a path if the file is a particular default location, can be used as Check or transform
|
||||
/// with the error return optionally disabled
|
||||
class FileOnDefaultPath : public Validator {
|
||||
public:
|
||||
explicit FileOnDefaultPath(std::string default_path, bool enableErrorReturn = true);
|
||||
};
|
||||
|
||||
/// Produce a range (factory). Min and max are inclusive.
|
||||
class Range : public Validator {
|
||||
public:
|
||||
/// This produces a range with min and max inclusive.
|
||||
///
|
||||
/// Note that the constructor is templated, but the struct is not, so C++17 is not
|
||||
/// needed to provide nice syntax for Range(a,b).
|
||||
template <typename T>
|
||||
Range(T min_val, T max_val, const std::string &validator_name = std::string{}) : Validator(validator_name) {
|
||||
if(validator_name.empty()) {
|
||||
std::stringstream out;
|
||||
out << detail::type_name<T>() << " in [" << min_val << " - " << max_val << "]";
|
||||
description(out.str());
|
||||
}
|
||||
|
||||
func_ = [min_val, max_val](std::string &input) {
|
||||
T val;
|
||||
bool converted = detail::lexical_cast(input, val);
|
||||
if((!converted) || (val < min_val || val > max_val)) {
|
||||
std::stringstream out;
|
||||
out << "Value " << input << " not in range [";
|
||||
out << min_val << " - " << max_val << "]";
|
||||
return out.str();
|
||||
}
|
||||
return std::string{};
|
||||
};
|
||||
}
|
||||
|
||||
/// Range of one value is 0 to value
|
||||
template <typename T>
|
||||
explicit Range(T max_val, const std::string &validator_name = std::string{})
|
||||
: Range(static_cast<T>(0), max_val, validator_name) {}
|
||||
};
|
||||
|
||||
/// Check for a non negative number
|
||||
const Range NonNegativeNumber((std::numeric_limits<double>::max)(), "NONNEGATIVE");
|
||||
|
||||
/// Check for a positive valued number (val>0.0), <double>::min here is the smallest positive number
|
||||
const Range PositiveNumber((std::numeric_limits<double>::min)(), (std::numeric_limits<double>::max)(), "POSITIVE");
|
||||
|
||||
/// Produce a bounded range (factory). Min and max are inclusive.
|
||||
class Bound : public Validator {
|
||||
public:
|
||||
/// This bounds a value with min and max inclusive.
|
||||
///
|
||||
/// Note that the constructor is templated, but the struct is not, so C++17 is not
|
||||
/// needed to provide nice syntax for Range(a,b).
|
||||
template <typename T> Bound(T min_val, T max_val) {
|
||||
std::stringstream out;
|
||||
out << detail::type_name<T>() << " bounded to [" << min_val << " - " << max_val << "]";
|
||||
description(out.str());
|
||||
|
||||
func_ = [min_val, max_val](std::string &input) {
|
||||
T val;
|
||||
bool converted = detail::lexical_cast(input, val);
|
||||
if(!converted) {
|
||||
return std::string("Value ") + input + " could not be converted";
|
||||
}
|
||||
if(val < min_val)
|
||||
input = detail::to_string(min_val);
|
||||
else if(val > max_val)
|
||||
input = detail::to_string(max_val);
|
||||
|
||||
return std::string{};
|
||||
};
|
||||
}
|
||||
|
||||
/// Range of one value is 0 to value
|
||||
template <typename T> explicit Bound(T max_val) : Bound(static_cast<T>(0), max_val) {}
|
||||
};
|
||||
|
||||
namespace detail {
|
||||
template <typename T,
|
||||
enable_if_t<is_copyable_ptr<typename std::remove_reference<T>::type>::value, detail::enabler> = detail::dummy>
|
||||
auto smart_deref(T value) -> decltype(*value) {
|
||||
return *value;
|
||||
}
|
||||
|
||||
template <
|
||||
typename T,
|
||||
enable_if_t<!is_copyable_ptr<typename std::remove_reference<T>::type>::value, detail::enabler> = detail::dummy>
|
||||
typename std::remove_reference<T>::type &smart_deref(T &value) {
|
||||
return value;
|
||||
}
|
||||
/// Generate a string representation of a set
|
||||
template <typename T> std::string generate_set(const T &set) {
|
||||
using element_t = typename detail::element_type<T>::type;
|
||||
using iteration_type_t = typename detail::pair_adaptor<element_t>::value_type; // the type of the object pair
|
||||
std::string out(1, '{');
|
||||
out.append(detail::join(
|
||||
detail::smart_deref(set),
|
||||
[](const iteration_type_t &v) { return detail::pair_adaptor<element_t>::first(v); },
|
||||
","));
|
||||
out.push_back('}');
|
||||
return out;
|
||||
}
|
||||
|
||||
/// Generate a string representation of a map
|
||||
template <typename T> std::string generate_map(const T &map, bool key_only = false) {
|
||||
using element_t = typename detail::element_type<T>::type;
|
||||
using iteration_type_t = typename detail::pair_adaptor<element_t>::value_type; // the type of the object pair
|
||||
std::string out(1, '{');
|
||||
out.append(detail::join(
|
||||
detail::smart_deref(map),
|
||||
[key_only](const iteration_type_t &v) {
|
||||
std::string res{detail::to_string(detail::pair_adaptor<element_t>::first(v))};
|
||||
|
||||
if(!key_only) {
|
||||
res.append("->");
|
||||
res += detail::to_string(detail::pair_adaptor<element_t>::second(v));
|
||||
}
|
||||
return res;
|
||||
},
|
||||
","));
|
||||
out.push_back('}');
|
||||
return out;
|
||||
}
|
||||
|
||||
template <typename C, typename V> struct has_find {
|
||||
template <typename CC, typename VV>
|
||||
static auto test(int) -> decltype(std::declval<CC>().find(std::declval<VV>()), std::true_type());
|
||||
template <typename, typename> static auto test(...) -> decltype(std::false_type());
|
||||
|
||||
static const auto value = decltype(test<C, V>(0))::value;
|
||||
using type = std::integral_constant<bool, value>;
|
||||
};
|
||||
|
||||
/// A search function
|
||||
template <typename T, typename V, enable_if_t<!has_find<T, V>::value, detail::enabler> = detail::dummy>
|
||||
auto search(const T &set, const V &val) -> std::pair<bool, decltype(std::begin(detail::smart_deref(set)))> {
|
||||
using element_t = typename detail::element_type<T>::type;
|
||||
auto &setref = detail::smart_deref(set);
|
||||
auto it = std::find_if(std::begin(setref), std::end(setref), [&val](decltype(*std::begin(setref)) v) {
|
||||
return (detail::pair_adaptor<element_t>::first(v) == val);
|
||||
});
|
||||
return {(it != std::end(setref)), it};
|
||||
}
|
||||
|
||||
/// A search function that uses the built in find function
|
||||
template <typename T, typename V, enable_if_t<has_find<T, V>::value, detail::enabler> = detail::dummy>
|
||||
auto search(const T &set, const V &val) -> std::pair<bool, decltype(std::begin(detail::smart_deref(set)))> {
|
||||
auto &setref = detail::smart_deref(set);
|
||||
auto it = setref.find(val);
|
||||
return {(it != std::end(setref)), it};
|
||||
}
|
||||
|
||||
/// A search function with a filter function
|
||||
template <typename T, typename V>
|
||||
auto search(const T &set, const V &val, const std::function<V(V)> &filter_function)
|
||||
-> std::pair<bool, decltype(std::begin(detail::smart_deref(set)))> {
|
||||
using element_t = typename detail::element_type<T>::type;
|
||||
// do the potentially faster first search
|
||||
auto res = search(set, val);
|
||||
if((res.first) || (!(filter_function))) {
|
||||
return res;
|
||||
}
|
||||
// if we haven't found it do the longer linear search with all the element translations
|
||||
auto &setref = detail::smart_deref(set);
|
||||
auto it = std::find_if(std::begin(setref), std::end(setref), [&](decltype(*std::begin(setref)) v) {
|
||||
V a{detail::pair_adaptor<element_t>::first(v)};
|
||||
a = filter_function(a);
|
||||
return (a == val);
|
||||
});
|
||||
return {(it != std::end(setref)), it};
|
||||
}
|
||||
|
||||
// the following suggestion was made by Nikita Ofitserov(@himikof)
|
||||
// done in templates to prevent compiler warnings on negation of unsigned numbers
|
||||
|
||||
/// Do a check for overflow on signed numbers
|
||||
template <typename T>
|
||||
inline typename std::enable_if<std::is_signed<T>::value, T>::type overflowCheck(const T &a, const T &b) {
|
||||
if((a > 0) == (b > 0)) {
|
||||
return ((std::numeric_limits<T>::max)() / (std::abs)(a) < (std::abs)(b));
|
||||
}
|
||||
return ((std::numeric_limits<T>::min)() / (std::abs)(a) > -(std::abs)(b));
|
||||
}
|
||||
/// Do a check for overflow on unsigned numbers
|
||||
template <typename T>
|
||||
inline typename std::enable_if<!std::is_signed<T>::value, T>::type overflowCheck(const T &a, const T &b) {
|
||||
return ((std::numeric_limits<T>::max)() / a < b);
|
||||
}
|
||||
|
||||
/// Performs a *= b; if it doesn't cause integer overflow. Returns false otherwise.
|
||||
template <typename T> typename std::enable_if<std::is_integral<T>::value, bool>::type checked_multiply(T &a, T b) {
|
||||
if(a == 0 || b == 0 || a == 1 || b == 1) {
|
||||
a *= b;
|
||||
return true;
|
||||
}
|
||||
if(a == (std::numeric_limits<T>::min)() || b == (std::numeric_limits<T>::min)()) {
|
||||
return false;
|
||||
}
|
||||
if(overflowCheck(a, b)) {
|
||||
return false;
|
||||
}
|
||||
a *= b;
|
||||
return true;
|
||||
}
|
||||
|
||||
/// Performs a *= b; if it doesn't equal infinity. Returns false otherwise.
|
||||
template <typename T>
|
||||
typename std::enable_if<std::is_floating_point<T>::value, bool>::type checked_multiply(T &a, T b) {
|
||||
T c = a * b;
|
||||
if(std::isinf(c) && !std::isinf(a) && !std::isinf(b)) {
|
||||
return false;
|
||||
}
|
||||
a = c;
|
||||
return true;
|
||||
}
|
||||
|
||||
} // namespace detail
|
||||
/// Verify items are in a set
|
||||
class IsMember : public Validator {
|
||||
public:
|
||||
using filter_fn_t = std::function<std::string(std::string)>;
|
||||
|
||||
/// This allows in-place construction using an initializer list
|
||||
template <typename T, typename... Args>
|
||||
IsMember(std::initializer_list<T> values, Args &&...args)
|
||||
: IsMember(std::vector<T>(values), std::forward<Args>(args)...) {}
|
||||
|
||||
/// This checks to see if an item is in a set (empty function)
|
||||
template <typename T> explicit IsMember(T &&set) : IsMember(std::forward<T>(set), nullptr) {}
|
||||
|
||||
/// This checks to see if an item is in a set: pointer or copy version. You can pass in a function that will filter
|
||||
/// both sides of the comparison before computing the comparison.
|
||||
template <typename T, typename F> explicit IsMember(T set, F filter_function) {
|
||||
|
||||
// Get the type of the contained item - requires a container have ::value_type
|
||||
// if the type does not have first_type and second_type, these are both value_type
|
||||
using element_t = typename detail::element_type<T>::type; // Removes (smart) pointers if needed
|
||||
using item_t = typename detail::pair_adaptor<element_t>::first_type; // Is value_type if not a map
|
||||
|
||||
using local_item_t = typename IsMemberType<item_t>::type; // This will convert bad types to good ones
|
||||
// (const char * to std::string)
|
||||
|
||||
// Make a local copy of the filter function, using a std::function if not one already
|
||||
std::function<local_item_t(local_item_t)> filter_fn = filter_function;
|
||||
|
||||
// This is the type name for help, it will take the current version of the set contents
|
||||
desc_function_ = [set]() { return detail::generate_set(detail::smart_deref(set)); };
|
||||
|
||||
// This is the function that validates
|
||||
// It stores a copy of the set pointer-like, so shared_ptr will stay alive
|
||||
func_ = [set, filter_fn](std::string &input) {
|
||||
local_item_t b;
|
||||
if(!detail::lexical_cast(input, b)) {
|
||||
throw ValidationError(input); // name is added later
|
||||
}
|
||||
if(filter_fn) {
|
||||
b = filter_fn(b);
|
||||
}
|
||||
auto res = detail::search(set, b, filter_fn);
|
||||
if(res.first) {
|
||||
// Make sure the version in the input string is identical to the one in the set
|
||||
if(filter_fn) {
|
||||
input = detail::value_string(detail::pair_adaptor<element_t>::first(*(res.second)));
|
||||
}
|
||||
|
||||
// Return empty error string (success)
|
||||
return std::string{};
|
||||
}
|
||||
|
||||
// If you reach this point, the result was not found
|
||||
return input + " not in " + detail::generate_set(detail::smart_deref(set));
|
||||
};
|
||||
}
|
||||
|
||||
/// You can pass in as many filter functions as you like, they nest (string only currently)
|
||||
template <typename T, typename... Args>
|
||||
IsMember(T &&set, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&...other)
|
||||
: IsMember(
|
||||
std::forward<T>(set),
|
||||
[filter_fn_1, filter_fn_2](std::string a) { return filter_fn_2(filter_fn_1(a)); },
|
||||
other...) {}
|
||||
};
|
||||
|
||||
/// definition of the default transformation object
|
||||
template <typename T> using TransformPairs = std::vector<std::pair<std::string, T>>;
|
||||
|
||||
/// Translate named items to other or a value set
|
||||
class Transformer : public Validator {
|
||||
public:
|
||||
using filter_fn_t = std::function<std::string(std::string)>;
|
||||
|
||||
/// This allows in-place construction
|
||||
template <typename... Args>
|
||||
Transformer(std::initializer_list<std::pair<std::string, std::string>> values, Args &&...args)
|
||||
: Transformer(TransformPairs<std::string>(values), std::forward<Args>(args)...) {}
|
||||
|
||||
/// direct map of std::string to std::string
|
||||
template <typename T> explicit Transformer(T &&mapping) : Transformer(std::forward<T>(mapping), nullptr) {}
|
||||
|
||||
/// This checks to see if an item is in a set: pointer or copy version. You can pass in a function that will filter
|
||||
/// both sides of the comparison before computing the comparison.
|
||||
template <typename T, typename F> explicit Transformer(T mapping, F filter_function) {
|
||||
|
||||
static_assert(detail::pair_adaptor<typename detail::element_type<T>::type>::value,
|
||||
"mapping must produce value pairs");
|
||||
// Get the type of the contained item - requires a container have ::value_type
|
||||
// if the type does not have first_type and second_type, these are both value_type
|
||||
using element_t = typename detail::element_type<T>::type; // Removes (smart) pointers if needed
|
||||
using item_t = typename detail::pair_adaptor<element_t>::first_type; // Is value_type if not a map
|
||||
using local_item_t = typename IsMemberType<item_t>::type; // Will convert bad types to good ones
|
||||
// (const char * to std::string)
|
||||
|
||||
// Make a local copy of the filter function, using a std::function if not one already
|
||||
std::function<local_item_t(local_item_t)> filter_fn = filter_function;
|
||||
|
||||
// This is the type name for help, it will take the current version of the set contents
|
||||
desc_function_ = [mapping]() { return detail::generate_map(detail::smart_deref(mapping)); };
|
||||
|
||||
func_ = [mapping, filter_fn](std::string &input) {
|
||||
local_item_t b;
|
||||
if(!detail::lexical_cast(input, b)) {
|
||||
return std::string();
|
||||
// there is no possible way we can match anything in the mapping if we can't convert so just return
|
||||
}
|
||||
if(filter_fn) {
|
||||
b = filter_fn(b);
|
||||
}
|
||||
auto res = detail::search(mapping, b, filter_fn);
|
||||
if(res.first) {
|
||||
input = detail::value_string(detail::pair_adaptor<element_t>::second(*res.second));
|
||||
}
|
||||
return std::string{};
|
||||
};
|
||||
}
|
||||
|
||||
/// You can pass in as many filter functions as you like, they nest
|
||||
template <typename T, typename... Args>
|
||||
Transformer(T &&mapping, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&...other)
|
||||
: Transformer(
|
||||
std::forward<T>(mapping),
|
||||
[filter_fn_1, filter_fn_2](std::string a) { return filter_fn_2(filter_fn_1(a)); },
|
||||
other...) {}
|
||||
};
|
||||
|
||||
/// translate named items to other or a value set
|
||||
class CheckedTransformer : public Validator {
|
||||
public:
|
||||
using filter_fn_t = std::function<std::string(std::string)>;
|
||||
|
||||
/// This allows in-place construction
|
||||
template <typename... Args>
|
||||
CheckedTransformer(std::initializer_list<std::pair<std::string, std::string>> values, Args &&...args)
|
||||
: CheckedTransformer(TransformPairs<std::string>(values), std::forward<Args>(args)...) {}
|
||||
|
||||
/// direct map of std::string to std::string
|
||||
template <typename T> explicit CheckedTransformer(T mapping) : CheckedTransformer(std::move(mapping), nullptr) {}
|
||||
|
||||
/// This checks to see if an item is in a set: pointer or copy version. You can pass in a function that will filter
|
||||
/// both sides of the comparison before computing the comparison.
|
||||
template <typename T, typename F> explicit CheckedTransformer(T mapping, F filter_function) {
|
||||
|
||||
static_assert(detail::pair_adaptor<typename detail::element_type<T>::type>::value,
|
||||
"mapping must produce value pairs");
|
||||
// Get the type of the contained item - requires a container have ::value_type
|
||||
// if the type does not have first_type and second_type, these are both value_type
|
||||
using element_t = typename detail::element_type<T>::type; // Removes (smart) pointers if needed
|
||||
using item_t = typename detail::pair_adaptor<element_t>::first_type; // Is value_type if not a map
|
||||
using local_item_t = typename IsMemberType<item_t>::type; // Will convert bad types to good ones
|
||||
// (const char * to std::string)
|
||||
using iteration_type_t = typename detail::pair_adaptor<element_t>::value_type; // the type of the object pair
|
||||
|
||||
// Make a local copy of the filter function, using a std::function if not one already
|
||||
std::function<local_item_t(local_item_t)> filter_fn = filter_function;
|
||||
|
||||
auto tfunc = [mapping]() {
|
||||
std::string out("value in ");
|
||||
out += detail::generate_map(detail::smart_deref(mapping)) + " OR {";
|
||||
out += detail::join(
|
||||
detail::smart_deref(mapping),
|
||||
[](const iteration_type_t &v) { return detail::to_string(detail::pair_adaptor<element_t>::second(v)); },
|
||||
",");
|
||||
out.push_back('}');
|
||||
return out;
|
||||
};
|
||||
|
||||
desc_function_ = tfunc;
|
||||
|
||||
func_ = [mapping, tfunc, filter_fn](std::string &input) {
|
||||
local_item_t b;
|
||||
bool converted = detail::lexical_cast(input, b);
|
||||
if(converted) {
|
||||
if(filter_fn) {
|
||||
b = filter_fn(b);
|
||||
}
|
||||
auto res = detail::search(mapping, b, filter_fn);
|
||||
if(res.first) {
|
||||
input = detail::value_string(detail::pair_adaptor<element_t>::second(*res.second));
|
||||
return std::string{};
|
||||
}
|
||||
}
|
||||
for(const auto &v : detail::smart_deref(mapping)) {
|
||||
auto output_string = detail::value_string(detail::pair_adaptor<element_t>::second(v));
|
||||
if(output_string == input) {
|
||||
return std::string();
|
||||
}
|
||||
}
|
||||
|
||||
return "Check " + input + " " + tfunc() + " FAILED";
|
||||
};
|
||||
}
|
||||
|
||||
/// You can pass in as many filter functions as you like, they nest
|
||||
template <typename T, typename... Args>
|
||||
CheckedTransformer(T &&mapping, filter_fn_t filter_fn_1, filter_fn_t filter_fn_2, Args &&...other)
|
||||
: CheckedTransformer(
|
||||
std::forward<T>(mapping),
|
||||
[filter_fn_1, filter_fn_2](std::string a) { return filter_fn_2(filter_fn_1(a)); },
|
||||
other...) {}
|
||||
};
|
||||
|
||||
/// Helper function to allow ignore_case to be passed to IsMember or Transform
|
||||
inline std::string ignore_case(std::string item) { return detail::to_lower(item); }
|
||||
|
||||
/// Helper function to allow ignore_underscore to be passed to IsMember or Transform
|
||||
inline std::string ignore_underscore(std::string item) { return detail::remove_underscore(item); }
|
||||
|
||||
/// Helper function to allow checks to ignore spaces to be passed to IsMember or Transform
|
||||
inline std::string ignore_space(std::string item) {
|
||||
item.erase(std::remove(std::begin(item), std::end(item), ' '), std::end(item));
|
||||
item.erase(std::remove(std::begin(item), std::end(item), '\t'), std::end(item));
|
||||
return item;
|
||||
}
|
||||
|
||||
/// Multiply a number by a factor using given mapping.
|
||||
/// Can be used to write transforms for SIZE or DURATION inputs.
|
||||
///
|
||||
/// Example:
|
||||
/// With mapping = `{"b"->1, "kb"->1024, "mb"->1024*1024}`
|
||||
/// one can recognize inputs like "100", "12kb", "100 MB",
|
||||
/// that will be automatically transformed to 100, 14448, 104857600.
|
||||
///
|
||||
/// Output number type matches the type in the provided mapping.
|
||||
/// Therefore, if it is required to interpret real inputs like "0.42 s",
|
||||
/// the mapping should be of a type <string, float> or <string, double>.
|
||||
class AsNumberWithUnit : public Validator {
|
||||
public:
|
||||
/// Adjust AsNumberWithUnit behavior.
|
||||
/// CASE_SENSITIVE/CASE_INSENSITIVE controls how units are matched.
|
||||
/// UNIT_OPTIONAL/UNIT_REQUIRED throws ValidationError
|
||||
/// if UNIT_REQUIRED is set and unit literal is not found.
|
||||
enum Options {
|
||||
CASE_SENSITIVE = 0,
|
||||
CASE_INSENSITIVE = 1,
|
||||
UNIT_OPTIONAL = 0,
|
||||
UNIT_REQUIRED = 2,
|
||||
DEFAULT = CASE_INSENSITIVE | UNIT_OPTIONAL
|
||||
};
|
||||
|
||||
template <typename Number>
|
||||
explicit AsNumberWithUnit(std::map<std::string, Number> mapping,
|
||||
Options opts = DEFAULT,
|
||||
const std::string &unit_name = "UNIT") {
|
||||
description(generate_description<Number>(unit_name, opts));
|
||||
validate_mapping(mapping, opts);
|
||||
|
||||
// transform function
|
||||
func_ = [mapping, opts](std::string &input) -> std::string {
|
||||
Number num{};
|
||||
|
||||
detail::rtrim(input);
|
||||
if(input.empty()) {
|
||||
throw ValidationError("Input is empty");
|
||||
}
|
||||
|
||||
// Find split position between number and prefix
|
||||
auto unit_begin = input.end();
|
||||
while(unit_begin > input.begin() && std::isalpha(*(unit_begin - 1), std::locale())) {
|
||||
--unit_begin;
|
||||
}
|
||||
|
||||
std::string unit{unit_begin, input.end()};
|
||||
input.resize(static_cast<std::size_t>(std::distance(input.begin(), unit_begin)));
|
||||
detail::trim(input);
|
||||
|
||||
if(opts & UNIT_REQUIRED && unit.empty()) {
|
||||
throw ValidationError("Missing mandatory unit");
|
||||
}
|
||||
if(opts & CASE_INSENSITIVE) {
|
||||
unit = detail::to_lower(unit);
|
||||
}
|
||||
if(unit.empty()) {
|
||||
if(!detail::lexical_cast(input, num)) {
|
||||
throw ValidationError(std::string("Value ") + input + " could not be converted to " +
|
||||
detail::type_name<Number>());
|
||||
}
|
||||
// No need to modify input if no unit passed
|
||||
return {};
|
||||
}
|
||||
|
||||
// find corresponding factor
|
||||
auto it = mapping.find(unit);
|
||||
if(it == mapping.end()) {
|
||||
throw ValidationError(unit +
|
||||
" unit not recognized. "
|
||||
"Allowed values: " +
|
||||
detail::generate_map(mapping, true));
|
||||
}
|
||||
|
||||
if(!input.empty()) {
|
||||
bool converted = detail::lexical_cast(input, num);
|
||||
if(!converted) {
|
||||
throw ValidationError(std::string("Value ") + input + " could not be converted to " +
|
||||
detail::type_name<Number>());
|
||||
}
|
||||
// perform safe multiplication
|
||||
bool ok = detail::checked_multiply(num, it->second);
|
||||
if(!ok) {
|
||||
throw ValidationError(detail::to_string(num) + " multiplied by " + unit +
|
||||
" factor would cause number overflow. Use smaller value.");
|
||||
}
|
||||
} else {
|
||||
num = static_cast<Number>(it->second);
|
||||
}
|
||||
|
||||
input = detail::to_string(num);
|
||||
|
||||
return {};
|
||||
};
|
||||
}
|
||||
|
||||
private:
|
||||
/// Check that mapping contains valid units.
|
||||
/// Update mapping for CASE_INSENSITIVE mode.
|
||||
template <typename Number> static void validate_mapping(std::map<std::string, Number> &mapping, Options opts) {
|
||||
for(auto &kv : mapping) {
|
||||
if(kv.first.empty()) {
|
||||
throw ValidationError("Unit must not be empty.");
|
||||
}
|
||||
if(!detail::isalpha(kv.first)) {
|
||||
throw ValidationError("Unit must contain only letters.");
|
||||
}
|
||||
}
|
||||
|
||||
// make all units lowercase if CASE_INSENSITIVE
|
||||
if(opts & CASE_INSENSITIVE) {
|
||||
std::map<std::string, Number> lower_mapping;
|
||||
for(auto &kv : mapping) {
|
||||
auto s = detail::to_lower(kv.first);
|
||||
if(lower_mapping.count(s)) {
|
||||
throw ValidationError(std::string("Several matching lowercase unit representations are found: ") +
|
||||
s);
|
||||
}
|
||||
lower_mapping[detail::to_lower(kv.first)] = kv.second;
|
||||
}
|
||||
mapping = std::move(lower_mapping);
|
||||
}
|
||||
}
|
||||
|
||||
/// Generate description like this: NUMBER [UNIT]
|
||||
template <typename Number> static std::string generate_description(const std::string &name, Options opts) {
|
||||
std::stringstream out;
|
||||
out << detail::type_name<Number>() << ' ';
|
||||
if(opts & UNIT_REQUIRED) {
|
||||
out << name;
|
||||
} else {
|
||||
out << '[' << name << ']';
|
||||
}
|
||||
return out.str();
|
||||
}
|
||||
};
|
||||
|
||||
inline AsNumberWithUnit::Options operator|(const AsNumberWithUnit::Options &a, const AsNumberWithUnit::Options &b) {
|
||||
return static_cast<AsNumberWithUnit::Options>(static_cast<int>(a) | static_cast<int>(b));
|
||||
}
|
||||
|
||||
/// Converts a human-readable size string (with unit literal) to uin64_t size.
|
||||
/// Example:
|
||||
/// "100" => 100
|
||||
/// "1 b" => 100
|
||||
/// "10Kb" => 10240 // you can configure this to be interpreted as kilobyte (*1000) or kibibyte (*1024)
|
||||
/// "10 KB" => 10240
|
||||
/// "10 kb" => 10240
|
||||
/// "10 kib" => 10240 // *i, *ib are always interpreted as *bibyte (*1024)
|
||||
/// "10kb" => 10240
|
||||
/// "2 MB" => 2097152
|
||||
/// "2 EiB" => 2^61 // Units up to exibyte are supported
|
||||
class AsSizeValue : public AsNumberWithUnit {
|
||||
public:
|
||||
using result_t = std::uint64_t;
|
||||
|
||||
/// If kb_is_1000 is true,
|
||||
/// interpret 'kb', 'k' as 1000 and 'kib', 'ki' as 1024
|
||||
/// (same applies to higher order units as well).
|
||||
/// Otherwise, interpret all literals as factors of 1024.
|
||||
/// The first option is formally correct, but
|
||||
/// the second interpretation is more wide-spread
|
||||
/// (see https://en.wikipedia.org/wiki/Binary_prefix).
|
||||
explicit AsSizeValue(bool kb_is_1000);
|
||||
|
||||
private:
|
||||
/// Get <size unit, factor> mapping
|
||||
static std::map<std::string, result_t> init_mapping(bool kb_is_1000);
|
||||
|
||||
/// Cache calculated mapping
|
||||
static std::map<std::string, result_t> get_mapping(bool kb_is_1000);
|
||||
};
|
||||
|
||||
namespace detail {
|
||||
/// Split a string into a program name and command line arguments
|
||||
/// the string is assumed to contain a file name followed by other arguments
|
||||
/// the return value contains is a pair with the first argument containing the program name and the second
|
||||
/// everything else.
|
||||
CLI11_INLINE std::pair<std::string, std::string> split_program_name(std::string commandline);
|
||||
|
||||
} // namespace detail
|
||||
/// @}
|
||||
|
||||
// [CLI11:validators_hpp:end]
|
||||
} // namespace CLI
|
||||
|
||||
#ifndef CLI11_COMPILE
|
||||
#include "impl/Validators_inl.hpp"
|
||||
#endif
|
||||
16
libs/CLI11/include/CLI/Version.hpp
Normal file
16
libs/CLI11/include/CLI/Version.hpp
Normal file
@@ -0,0 +1,16 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// [CLI11:version_hpp:verbatim]
|
||||
|
||||
#define CLI11_VERSION_MAJOR 2
|
||||
#define CLI11_VERSION_MINOR 3
|
||||
#define CLI11_VERSION_PATCH 1
|
||||
#define CLI11_VERSION "2.3.1"
|
||||
|
||||
// [CLI11:version_hpp:end]
|
||||
2103
libs/CLI11/include/CLI/impl/App_inl.hpp
Normal file
2103
libs/CLI11/include/CLI/impl/App_inl.hpp
Normal file
File diff suppressed because it is too large
Load Diff
394
libs/CLI11/include/CLI/impl/Config_inl.hpp
Normal file
394
libs/CLI11/include/CLI/impl/Config_inl.hpp
Normal file
@@ -0,0 +1,394 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// This include is only needed for IDEs to discover symbols
|
||||
#include <CLI/Config.hpp>
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <algorithm>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:config_inl_hpp:verbatim]
|
||||
|
||||
namespace detail {
|
||||
|
||||
CLI11_INLINE std::string convert_arg_for_ini(const std::string &arg, char stringQuote, char characterQuote) {
|
||||
if(arg.empty()) {
|
||||
return std::string(2, stringQuote);
|
||||
}
|
||||
// some specifically supported strings
|
||||
if(arg == "true" || arg == "false" || arg == "nan" || arg == "inf") {
|
||||
return arg;
|
||||
}
|
||||
// floating point conversion can convert some hex codes, but don't try that here
|
||||
if(arg.compare(0, 2, "0x") != 0 && arg.compare(0, 2, "0X") != 0) {
|
||||
double val = 0.0;
|
||||
if(detail::lexical_cast(arg, val)) {
|
||||
return arg;
|
||||
}
|
||||
}
|
||||
// just quote a single non numeric character
|
||||
if(arg.size() == 1) {
|
||||
return std::string(1, characterQuote) + arg + characterQuote;
|
||||
}
|
||||
// handle hex, binary or octal arguments
|
||||
if(arg.front() == '0') {
|
||||
if(arg[1] == 'x') {
|
||||
if(std::all_of(arg.begin() + 2, arg.end(), [](char x) {
|
||||
return (x >= '0' && x <= '9') || (x >= 'A' && x <= 'F') || (x >= 'a' && x <= 'f');
|
||||
})) {
|
||||
return arg;
|
||||
}
|
||||
} else if(arg[1] == 'o') {
|
||||
if(std::all_of(arg.begin() + 2, arg.end(), [](char x) { return (x >= '0' && x <= '7'); })) {
|
||||
return arg;
|
||||
}
|
||||
} else if(arg[1] == 'b') {
|
||||
if(std::all_of(arg.begin() + 2, arg.end(), [](char x) { return (x == '0' || x == '1'); })) {
|
||||
return arg;
|
||||
}
|
||||
}
|
||||
}
|
||||
if(arg.find_first_of(stringQuote) == std::string::npos) {
|
||||
return std::string(1, stringQuote) + arg + stringQuote;
|
||||
}
|
||||
return characterQuote + arg + characterQuote;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string ini_join(const std::vector<std::string> &args,
|
||||
char sepChar,
|
||||
char arrayStart,
|
||||
char arrayEnd,
|
||||
char stringQuote,
|
||||
char characterQuote) {
|
||||
std::string joined;
|
||||
if(args.size() > 1 && arrayStart != '\0') {
|
||||
joined.push_back(arrayStart);
|
||||
}
|
||||
std::size_t start = 0;
|
||||
for(const auto &arg : args) {
|
||||
if(start++ > 0) {
|
||||
joined.push_back(sepChar);
|
||||
if(!std::isspace<char>(sepChar, std::locale())) {
|
||||
joined.push_back(' ');
|
||||
}
|
||||
}
|
||||
joined.append(convert_arg_for_ini(arg, stringQuote, characterQuote));
|
||||
}
|
||||
if(args.size() > 1 && arrayEnd != '\0') {
|
||||
joined.push_back(arrayEnd);
|
||||
}
|
||||
return joined;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::vector<std::string>
|
||||
generate_parents(const std::string §ion, std::string &name, char parentSeparator) {
|
||||
std::vector<std::string> parents;
|
||||
if(detail::to_lower(section) != "default") {
|
||||
if(section.find(parentSeparator) != std::string::npos) {
|
||||
parents = detail::split(section, parentSeparator);
|
||||
} else {
|
||||
parents = {section};
|
||||
}
|
||||
}
|
||||
if(name.find(parentSeparator) != std::string::npos) {
|
||||
std::vector<std::string> plist = detail::split(name, parentSeparator);
|
||||
name = plist.back();
|
||||
detail::remove_quotes(name);
|
||||
plist.pop_back();
|
||||
parents.insert(parents.end(), plist.begin(), plist.end());
|
||||
}
|
||||
|
||||
// clean up quotes on the parents
|
||||
for(auto &parent : parents) {
|
||||
detail::remove_quotes(parent);
|
||||
}
|
||||
return parents;
|
||||
}
|
||||
|
||||
CLI11_INLINE void
|
||||
checkParentSegments(std::vector<ConfigItem> &output, const std::string ¤tSection, char parentSeparator) {
|
||||
|
||||
std::string estring;
|
||||
auto parents = detail::generate_parents(currentSection, estring, parentSeparator);
|
||||
if(!output.empty() && output.back().name == "--") {
|
||||
std::size_t msize = (parents.size() > 1U) ? parents.size() : 2;
|
||||
while(output.back().parents.size() >= msize) {
|
||||
output.push_back(output.back());
|
||||
output.back().parents.pop_back();
|
||||
}
|
||||
|
||||
if(parents.size() > 1) {
|
||||
std::size_t common = 0;
|
||||
std::size_t mpair = (std::min)(output.back().parents.size(), parents.size() - 1);
|
||||
for(std::size_t ii = 0; ii < mpair; ++ii) {
|
||||
if(output.back().parents[ii] != parents[ii]) {
|
||||
break;
|
||||
}
|
||||
++common;
|
||||
}
|
||||
if(common == mpair) {
|
||||
output.pop_back();
|
||||
} else {
|
||||
while(output.back().parents.size() > common + 1) {
|
||||
output.push_back(output.back());
|
||||
output.back().parents.pop_back();
|
||||
}
|
||||
}
|
||||
for(std::size_t ii = common; ii < parents.size() - 1; ++ii) {
|
||||
output.emplace_back();
|
||||
output.back().parents.assign(parents.begin(), parents.begin() + static_cast<std::ptrdiff_t>(ii) + 1);
|
||||
output.back().name = "++";
|
||||
}
|
||||
}
|
||||
} else if(parents.size() > 1) {
|
||||
for(std::size_t ii = 0; ii < parents.size() - 1; ++ii) {
|
||||
output.emplace_back();
|
||||
output.back().parents.assign(parents.begin(), parents.begin() + static_cast<std::ptrdiff_t>(ii) + 1);
|
||||
output.back().name = "++";
|
||||
}
|
||||
}
|
||||
|
||||
// insert a section end which is just an empty items_buffer
|
||||
output.emplace_back();
|
||||
output.back().parents = std::move(parents);
|
||||
output.back().name = "++";
|
||||
}
|
||||
} // namespace detail
|
||||
|
||||
inline std::vector<ConfigItem> ConfigBase::from_config(std::istream &input) const {
|
||||
std::string line;
|
||||
std::string currentSection = "default";
|
||||
std::string previousSection = "default";
|
||||
std::vector<ConfigItem> output;
|
||||
bool isDefaultArray = (arrayStart == '[' && arrayEnd == ']' && arraySeparator == ',');
|
||||
bool isINIArray = (arrayStart == '\0' || arrayStart == ' ') && arrayStart == arrayEnd;
|
||||
bool inSection{false};
|
||||
char aStart = (isINIArray) ? '[' : arrayStart;
|
||||
char aEnd = (isINIArray) ? ']' : arrayEnd;
|
||||
char aSep = (isINIArray && arraySeparator == ' ') ? ',' : arraySeparator;
|
||||
int currentSectionIndex{0};
|
||||
while(getline(input, line)) {
|
||||
std::vector<std::string> items_buffer;
|
||||
std::string name;
|
||||
|
||||
detail::trim(line);
|
||||
std::size_t len = line.length();
|
||||
// lines have to be at least 3 characters to have any meaning to CLI just skip the rest
|
||||
if(len < 3) {
|
||||
continue;
|
||||
}
|
||||
if(line.front() == '[' && line.back() == ']') {
|
||||
if(currentSection != "default") {
|
||||
// insert a section end which is just an empty items_buffer
|
||||
output.emplace_back();
|
||||
output.back().parents = detail::generate_parents(currentSection, name, parentSeparatorChar);
|
||||
output.back().name = "--";
|
||||
}
|
||||
currentSection = line.substr(1, len - 2);
|
||||
// deal with double brackets for TOML
|
||||
if(currentSection.size() > 1 && currentSection.front() == '[' && currentSection.back() == ']') {
|
||||
currentSection = currentSection.substr(1, currentSection.size() - 2);
|
||||
}
|
||||
if(detail::to_lower(currentSection) == "default") {
|
||||
currentSection = "default";
|
||||
} else {
|
||||
detail::checkParentSegments(output, currentSection, parentSeparatorChar);
|
||||
}
|
||||
inSection = false;
|
||||
if(currentSection == previousSection) {
|
||||
++currentSectionIndex;
|
||||
} else {
|
||||
currentSectionIndex = 0;
|
||||
previousSection = currentSection;
|
||||
}
|
||||
continue;
|
||||
}
|
||||
|
||||
// comment lines
|
||||
if(line.front() == ';' || line.front() == '#' || line.front() == commentChar) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// Find = in string, split and recombine
|
||||
auto pos = line.find(valueDelimiter);
|
||||
if(pos != std::string::npos) {
|
||||
name = detail::trim_copy(line.substr(0, pos));
|
||||
std::string item = detail::trim_copy(line.substr(pos + 1));
|
||||
auto cloc = item.find(commentChar);
|
||||
if(cloc != std::string::npos) {
|
||||
item.erase(cloc, std::string::npos); // NOLINT(readability-suspicious-call-argument)
|
||||
detail::trim(item);
|
||||
}
|
||||
if(item.size() > 1 && item.front() == aStart) {
|
||||
for(std::string multiline; item.back() != aEnd && std::getline(input, multiline);) {
|
||||
detail::trim(multiline);
|
||||
item += multiline;
|
||||
}
|
||||
items_buffer = detail::split_up(item.substr(1, item.length() - 2), aSep);
|
||||
} else if((isDefaultArray || isINIArray) && item.find_first_of(aSep) != std::string::npos) {
|
||||
items_buffer = detail::split_up(item, aSep);
|
||||
} else if((isDefaultArray || isINIArray) && item.find_first_of(' ') != std::string::npos) {
|
||||
items_buffer = detail::split_up(item);
|
||||
} else {
|
||||
items_buffer = {item};
|
||||
}
|
||||
} else {
|
||||
name = detail::trim_copy(line);
|
||||
auto cloc = name.find(commentChar);
|
||||
if(cloc != std::string::npos) {
|
||||
name.erase(cloc, std::string::npos); // NOLINT(readability-suspicious-call-argument)
|
||||
detail::trim(name);
|
||||
}
|
||||
|
||||
items_buffer = {"true"};
|
||||
}
|
||||
if(name.find(parentSeparatorChar) == std::string::npos) {
|
||||
detail::remove_quotes(name);
|
||||
}
|
||||
// clean up quotes on the items
|
||||
for(auto &it : items_buffer) {
|
||||
detail::remove_quotes(it);
|
||||
}
|
||||
|
||||
std::vector<std::string> parents = detail::generate_parents(currentSection, name, parentSeparatorChar);
|
||||
if(parents.size() > maximumLayers) {
|
||||
continue;
|
||||
}
|
||||
if(!configSection.empty() && !inSection) {
|
||||
if(parents.empty() || parents.front() != configSection) {
|
||||
continue;
|
||||
}
|
||||
if(configIndex >= 0 && currentSectionIndex != configIndex) {
|
||||
continue;
|
||||
}
|
||||
parents.erase(parents.begin());
|
||||
inSection = true;
|
||||
}
|
||||
if(!output.empty() && name == output.back().name && parents == output.back().parents) {
|
||||
output.back().inputs.insert(output.back().inputs.end(), items_buffer.begin(), items_buffer.end());
|
||||
} else {
|
||||
output.emplace_back();
|
||||
output.back().parents = std::move(parents);
|
||||
output.back().name = std::move(name);
|
||||
output.back().inputs = std::move(items_buffer);
|
||||
}
|
||||
}
|
||||
if(currentSection != "default") {
|
||||
// insert a section end which is just an empty items_buffer
|
||||
std::string ename;
|
||||
output.emplace_back();
|
||||
output.back().parents = detail::generate_parents(currentSection, ename, parentSeparatorChar);
|
||||
output.back().name = "--";
|
||||
while(output.back().parents.size() > 1) {
|
||||
output.push_back(output.back());
|
||||
output.back().parents.pop_back();
|
||||
}
|
||||
}
|
||||
return output;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string
|
||||
ConfigBase::to_config(const App *app, bool default_also, bool write_description, std::string prefix) const {
|
||||
std::stringstream out;
|
||||
std::string commentLead;
|
||||
commentLead.push_back(commentChar);
|
||||
commentLead.push_back(' ');
|
||||
|
||||
std::vector<std::string> groups = app->get_groups();
|
||||
bool defaultUsed = false;
|
||||
groups.insert(groups.begin(), std::string("Options"));
|
||||
if(write_description && (app->get_configurable() || app->get_parent() == nullptr || app->get_name().empty())) {
|
||||
out << commentLead << detail::fix_newlines(commentLead, app->get_description()) << '\n';
|
||||
}
|
||||
for(auto &group : groups) {
|
||||
if(group == "Options" || group.empty()) {
|
||||
if(defaultUsed) {
|
||||
continue;
|
||||
}
|
||||
defaultUsed = true;
|
||||
}
|
||||
if(write_description && group != "Options" && !group.empty()) {
|
||||
out << '\n' << commentLead << group << " Options\n";
|
||||
}
|
||||
for(const Option *opt : app->get_options({})) {
|
||||
|
||||
// Only process options that are configurable
|
||||
if(opt->get_configurable()) {
|
||||
if(opt->get_group() != group) {
|
||||
if(!(group == "Options" && opt->get_group().empty())) {
|
||||
continue;
|
||||
}
|
||||
}
|
||||
std::string name = prefix + opt->get_single_name();
|
||||
std::string value = detail::ini_join(
|
||||
opt->reduced_results(), arraySeparator, arrayStart, arrayEnd, stringQuote, characterQuote);
|
||||
|
||||
if(value.empty() && default_also) {
|
||||
if(!opt->get_default_str().empty()) {
|
||||
value = detail::convert_arg_for_ini(opt->get_default_str(), stringQuote, characterQuote);
|
||||
} else if(opt->get_expected_min() == 0) {
|
||||
value = "false";
|
||||
} else if(opt->get_run_callback_for_default()) {
|
||||
value = "\"\""; // empty string default value
|
||||
}
|
||||
}
|
||||
|
||||
if(!value.empty()) {
|
||||
if(!opt->get_fnames().empty()) {
|
||||
value = opt->get_flag_value(name, value);
|
||||
}
|
||||
if(write_description && opt->has_description()) {
|
||||
out << '\n';
|
||||
out << commentLead << detail::fix_newlines(commentLead, opt->get_description()) << '\n';
|
||||
}
|
||||
out << name << valueDelimiter << value << '\n';
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
auto subcommands = app->get_subcommands({});
|
||||
for(const App *subcom : subcommands) {
|
||||
if(subcom->get_name().empty()) {
|
||||
if(write_description && !subcom->get_group().empty()) {
|
||||
out << '\n' << commentLead << subcom->get_group() << " Options\n";
|
||||
}
|
||||
out << to_config(subcom, default_also, write_description, prefix);
|
||||
}
|
||||
}
|
||||
|
||||
for(const App *subcom : subcommands) {
|
||||
if(!subcom->get_name().empty()) {
|
||||
if(subcom->get_configurable() && app->got_subcommand(subcom)) {
|
||||
if(!prefix.empty() || app->get_parent() == nullptr) {
|
||||
out << '[' << prefix << subcom->get_name() << "]\n";
|
||||
} else {
|
||||
std::string subname = app->get_name() + parentSeparatorChar + subcom->get_name();
|
||||
const auto *p = app->get_parent();
|
||||
while(p->get_parent() != nullptr) {
|
||||
subname = p->get_name() + parentSeparatorChar + subname;
|
||||
p = p->get_parent();
|
||||
}
|
||||
out << '[' << subname << "]\n";
|
||||
}
|
||||
out << to_config(subcom, default_also, write_description, "");
|
||||
} else {
|
||||
out << to_config(
|
||||
subcom, default_also, write_description, prefix + subcom->get_name() + parentSeparatorChar);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return out.str();
|
||||
}
|
||||
// [CLI11:config_inl_hpp:end]
|
||||
} // namespace CLI
|
||||
291
libs/CLI11/include/CLI/impl/Formatter_inl.hpp
Normal file
291
libs/CLI11/include/CLI/impl/Formatter_inl.hpp
Normal file
@@ -0,0 +1,291 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// This include is only needed for IDEs to discover symbols
|
||||
#include <CLI/Formatter.hpp>
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <algorithm>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:formatter_inl_hpp:verbatim]
|
||||
CLI11_INLINE std::string
|
||||
Formatter::make_group(std::string group, bool is_positional, std::vector<const Option *> opts) const {
|
||||
std::stringstream out;
|
||||
|
||||
out << "\n" << group << ":\n";
|
||||
for(const Option *opt : opts) {
|
||||
out << make_option(opt, is_positional);
|
||||
}
|
||||
|
||||
return out.str();
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_positionals(const App *app) const {
|
||||
std::vector<const Option *> opts =
|
||||
app->get_options([](const Option *opt) { return !opt->get_group().empty() && opt->get_positional(); });
|
||||
|
||||
if(opts.empty())
|
||||
return {};
|
||||
|
||||
return make_group(get_label("Positionals"), true, opts);
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_groups(const App *app, AppFormatMode mode) const {
|
||||
std::stringstream out;
|
||||
std::vector<std::string> groups = app->get_groups();
|
||||
|
||||
// Options
|
||||
for(const std::string &group : groups) {
|
||||
std::vector<const Option *> opts = app->get_options([app, mode, &group](const Option *opt) {
|
||||
return opt->get_group() == group // Must be in the right group
|
||||
&& opt->nonpositional() // Must not be a positional
|
||||
&& (mode != AppFormatMode::Sub // If mode is Sub, then
|
||||
|| (app->get_help_ptr() != opt // Ignore help pointer
|
||||
&& app->get_help_all_ptr() != opt)); // Ignore help all pointer
|
||||
});
|
||||
if(!group.empty() && !opts.empty()) {
|
||||
out << make_group(group, false, opts);
|
||||
|
||||
if(group != groups.back())
|
||||
out << "\n";
|
||||
}
|
||||
}
|
||||
|
||||
return out.str();
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_description(const App *app) const {
|
||||
std::string desc = app->get_description();
|
||||
auto min_options = app->get_require_option_min();
|
||||
auto max_options = app->get_require_option_max();
|
||||
if(app->get_required()) {
|
||||
desc += " REQUIRED ";
|
||||
}
|
||||
if((max_options == min_options) && (min_options > 0)) {
|
||||
if(min_options == 1) {
|
||||
desc += " \n[Exactly 1 of the following options is required]";
|
||||
} else {
|
||||
desc += " \n[Exactly " + std::to_string(min_options) + " options from the following list are required]";
|
||||
}
|
||||
} else if(max_options > 0) {
|
||||
if(min_options > 0) {
|
||||
desc += " \n[Between " + std::to_string(min_options) + " and " + std::to_string(max_options) +
|
||||
" of the follow options are required]";
|
||||
} else {
|
||||
desc += " \n[At most " + std::to_string(max_options) + " of the following options are allowed]";
|
||||
}
|
||||
} else if(min_options > 0) {
|
||||
desc += " \n[At least " + std::to_string(min_options) + " of the following options are required]";
|
||||
}
|
||||
return (!desc.empty()) ? desc + "\n" : std::string{};
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_usage(const App *app, std::string name) const {
|
||||
std::stringstream out;
|
||||
|
||||
out << get_label("Usage") << ":" << (name.empty() ? "" : " ") << name;
|
||||
|
||||
std::vector<std::string> groups = app->get_groups();
|
||||
|
||||
// Print an Options badge if any options exist
|
||||
std::vector<const Option *> non_pos_options =
|
||||
app->get_options([](const Option *opt) { return opt->nonpositional(); });
|
||||
if(!non_pos_options.empty())
|
||||
out << " [" << get_label("OPTIONS") << "]";
|
||||
|
||||
// Positionals need to be listed here
|
||||
std::vector<const Option *> positionals = app->get_options([](const Option *opt) { return opt->get_positional(); });
|
||||
|
||||
// Print out positionals if any are left
|
||||
if(!positionals.empty()) {
|
||||
// Convert to help names
|
||||
std::vector<std::string> positional_names(positionals.size());
|
||||
std::transform(positionals.begin(), positionals.end(), positional_names.begin(), [this](const Option *opt) {
|
||||
return make_option_usage(opt);
|
||||
});
|
||||
|
||||
out << " " << detail::join(positional_names, " ");
|
||||
}
|
||||
|
||||
// Add a marker if subcommands are expected or optional
|
||||
if(!app->get_subcommands(
|
||||
[](const CLI::App *subc) { return ((!subc->get_disabled()) && (!subc->get_name().empty())); })
|
||||
.empty()) {
|
||||
out << " " << (app->get_require_subcommand_min() == 0 ? "[" : "")
|
||||
<< get_label(app->get_require_subcommand_max() < 2 || app->get_require_subcommand_min() > 1 ? "SUBCOMMAND"
|
||||
: "SUBCOMMANDS")
|
||||
<< (app->get_require_subcommand_min() == 0 ? "]" : "");
|
||||
}
|
||||
|
||||
out << std::endl;
|
||||
|
||||
return out.str();
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_footer(const App *app) const {
|
||||
std::string footer = app->get_footer();
|
||||
if(footer.empty()) {
|
||||
return std::string{};
|
||||
}
|
||||
return "\n" + footer + "\n";
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_help(const App *app, std::string name, AppFormatMode mode) const {
|
||||
|
||||
// This immediately forwards to the make_expanded method. This is done this way so that subcommands can
|
||||
// have overridden formatters
|
||||
if(mode == AppFormatMode::Sub)
|
||||
return make_expanded(app);
|
||||
|
||||
std::stringstream out;
|
||||
if((app->get_name().empty()) && (app->get_parent() != nullptr)) {
|
||||
if(app->get_group() != "Subcommands") {
|
||||
out << app->get_group() << ':';
|
||||
}
|
||||
}
|
||||
|
||||
out << make_description(app);
|
||||
out << make_usage(app, name);
|
||||
out << make_positionals(app);
|
||||
out << make_groups(app, mode);
|
||||
out << make_subcommands(app, mode);
|
||||
out << make_footer(app);
|
||||
|
||||
return out.str();
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_subcommands(const App *app, AppFormatMode mode) const {
|
||||
std::stringstream out;
|
||||
|
||||
std::vector<const App *> subcommands = app->get_subcommands({});
|
||||
|
||||
// Make a list in definition order of the groups seen
|
||||
std::vector<std::string> subcmd_groups_seen;
|
||||
for(const App *com : subcommands) {
|
||||
if(com->get_name().empty()) {
|
||||
if(!com->get_group().empty()) {
|
||||
out << make_expanded(com);
|
||||
}
|
||||
continue;
|
||||
}
|
||||
std::string group_key = com->get_group();
|
||||
if(!group_key.empty() &&
|
||||
std::find_if(subcmd_groups_seen.begin(), subcmd_groups_seen.end(), [&group_key](std::string a) {
|
||||
return detail::to_lower(a) == detail::to_lower(group_key);
|
||||
}) == subcmd_groups_seen.end())
|
||||
subcmd_groups_seen.push_back(group_key);
|
||||
}
|
||||
|
||||
// For each group, filter out and print subcommands
|
||||
for(const std::string &group : subcmd_groups_seen) {
|
||||
out << "\n" << group << ":\n";
|
||||
std::vector<const App *> subcommands_group = app->get_subcommands(
|
||||
[&group](const App *sub_app) { return detail::to_lower(sub_app->get_group()) == detail::to_lower(group); });
|
||||
for(const App *new_com : subcommands_group) {
|
||||
if(new_com->get_name().empty())
|
||||
continue;
|
||||
if(mode != AppFormatMode::All) {
|
||||
out << make_subcommand(new_com);
|
||||
} else {
|
||||
out << new_com->help(new_com->get_name(), AppFormatMode::Sub);
|
||||
out << "\n";
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return out.str();
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_subcommand(const App *sub) const {
|
||||
std::stringstream out;
|
||||
detail::format_help(out, sub->get_display_name(true), sub->get_description(), column_width_);
|
||||
return out.str();
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_expanded(const App *sub) const {
|
||||
std::stringstream out;
|
||||
out << sub->get_display_name(true) << "\n";
|
||||
|
||||
out << make_description(sub);
|
||||
if(sub->get_name().empty() && !sub->get_aliases().empty()) {
|
||||
detail::format_aliases(out, sub->get_aliases(), column_width_ + 2);
|
||||
}
|
||||
out << make_positionals(sub);
|
||||
out << make_groups(sub, AppFormatMode::Sub);
|
||||
out << make_subcommands(sub, AppFormatMode::Sub);
|
||||
|
||||
// Drop blank spaces
|
||||
std::string tmp = detail::find_and_replace(out.str(), "\n\n", "\n");
|
||||
tmp = tmp.substr(0, tmp.size() - 1); // Remove the final '\n'
|
||||
|
||||
// Indent all but the first line (the name)
|
||||
return detail::find_and_replace(tmp, "\n", "\n ") + "\n";
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_option_name(const Option *opt, bool is_positional) const {
|
||||
if(is_positional)
|
||||
return opt->get_name(true, false);
|
||||
|
||||
return opt->get_name(false, true);
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_option_opts(const Option *opt) const {
|
||||
std::stringstream out;
|
||||
|
||||
if(!opt->get_option_text().empty()) {
|
||||
out << " " << opt->get_option_text();
|
||||
} else {
|
||||
if(opt->get_type_size() != 0) {
|
||||
if(!opt->get_type_name().empty())
|
||||
out << " " << get_label(opt->get_type_name());
|
||||
if(!opt->get_default_str().empty())
|
||||
out << " [" << opt->get_default_str() << "] ";
|
||||
if(opt->get_expected_max() == detail::expected_max_vector_size)
|
||||
out << " ...";
|
||||
else if(opt->get_expected_min() > 1)
|
||||
out << " x " << opt->get_expected();
|
||||
|
||||
if(opt->get_required())
|
||||
out << " " << get_label("REQUIRED");
|
||||
}
|
||||
if(!opt->get_envname().empty())
|
||||
out << " (" << get_label("Env") << ":" << opt->get_envname() << ")";
|
||||
if(!opt->get_needs().empty()) {
|
||||
out << " " << get_label("Needs") << ":";
|
||||
for(const Option *op : opt->get_needs())
|
||||
out << " " << op->get_name();
|
||||
}
|
||||
if(!opt->get_excludes().empty()) {
|
||||
out << " " << get_label("Excludes") << ":";
|
||||
for(const Option *op : opt->get_excludes())
|
||||
out << " " << op->get_name();
|
||||
}
|
||||
}
|
||||
return out.str();
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_option_desc(const Option *opt) const { return opt->get_description(); }
|
||||
|
||||
CLI11_INLINE std::string Formatter::make_option_usage(const Option *opt) const {
|
||||
// Note that these are positionals usages
|
||||
std::stringstream out;
|
||||
out << make_option_name(opt, true);
|
||||
if(opt->get_expected_max() >= detail::expected_max_vector_size)
|
||||
out << "...";
|
||||
else if(opt->get_expected_max() > 1)
|
||||
out << "(" << opt->get_expected() << "x)";
|
||||
|
||||
return opt->get_required() ? out.str() : "[" + out.str() + "]";
|
||||
}
|
||||
// [CLI11:formatter_inl_hpp:end]
|
||||
} // namespace CLI
|
||||
653
libs/CLI11/include/CLI/impl/Option_inl.hpp
Normal file
653
libs/CLI11/include/CLI/impl/Option_inl.hpp
Normal file
@@ -0,0 +1,653 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// This include is only needed for IDEs to discover symbols
|
||||
#include <CLI/Option.hpp>
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <algorithm>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:option_inl_hpp:verbatim]
|
||||
|
||||
template <typename CRTP> template <typename T> void OptionBase<CRTP>::copy_to(T *other) const {
|
||||
other->group(group_);
|
||||
other->required(required_);
|
||||
other->ignore_case(ignore_case_);
|
||||
other->ignore_underscore(ignore_underscore_);
|
||||
other->configurable(configurable_);
|
||||
other->disable_flag_override(disable_flag_override_);
|
||||
other->delimiter(delimiter_);
|
||||
other->always_capture_default(always_capture_default_);
|
||||
other->multi_option_policy(multi_option_policy_);
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::expected(int value) {
|
||||
if(value < 0) {
|
||||
expected_min_ = -value;
|
||||
if(expected_max_ < expected_min_) {
|
||||
expected_max_ = expected_min_;
|
||||
}
|
||||
allow_extra_args_ = true;
|
||||
flag_like_ = false;
|
||||
} else if(value == detail::expected_max_vector_size) {
|
||||
expected_min_ = 1;
|
||||
expected_max_ = detail::expected_max_vector_size;
|
||||
allow_extra_args_ = true;
|
||||
flag_like_ = false;
|
||||
} else {
|
||||
expected_min_ = value;
|
||||
expected_max_ = value;
|
||||
flag_like_ = (expected_min_ == 0);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::expected(int value_min, int value_max) {
|
||||
if(value_min < 0) {
|
||||
value_min = -value_min;
|
||||
}
|
||||
|
||||
if(value_max < 0) {
|
||||
value_max = detail::expected_max_vector_size;
|
||||
}
|
||||
if(value_max < value_min) {
|
||||
expected_min_ = value_max;
|
||||
expected_max_ = value_min;
|
||||
} else {
|
||||
expected_max_ = value_max;
|
||||
expected_min_ = value_min;
|
||||
}
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::check(Validator validator, const std::string &validator_name) {
|
||||
validator.non_modifying();
|
||||
validators_.push_back(std::move(validator));
|
||||
if(!validator_name.empty())
|
||||
validators_.back().name(validator_name);
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::check(std::function<std::string(const std::string &)> Validator,
|
||||
std::string Validator_description,
|
||||
std::string Validator_name) {
|
||||
validators_.emplace_back(Validator, std::move(Validator_description), std::move(Validator_name));
|
||||
validators_.back().non_modifying();
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::transform(Validator Validator, const std::string &Validator_name) {
|
||||
validators_.insert(validators_.begin(), std::move(Validator));
|
||||
if(!Validator_name.empty())
|
||||
validators_.front().name(Validator_name);
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::transform(const std::function<std::string(std::string)> &func,
|
||||
std::string transform_description,
|
||||
std::string transform_name) {
|
||||
validators_.insert(validators_.begin(),
|
||||
Validator(
|
||||
[func](std::string &val) {
|
||||
val = func(val);
|
||||
return std::string{};
|
||||
},
|
||||
std::move(transform_description),
|
||||
std::move(transform_name)));
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::each(const std::function<void(std::string)> &func) {
|
||||
validators_.emplace_back(
|
||||
[func](std::string &inout) {
|
||||
func(inout);
|
||||
return std::string{};
|
||||
},
|
||||
std::string{});
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE Validator *Option::get_validator(const std::string &Validator_name) {
|
||||
for(auto &Validator : validators_) {
|
||||
if(Validator_name == Validator.get_name()) {
|
||||
return &Validator;
|
||||
}
|
||||
}
|
||||
if((Validator_name.empty()) && (!validators_.empty())) {
|
||||
return &(validators_.front());
|
||||
}
|
||||
throw OptionNotFound(std::string{"Validator "} + Validator_name + " Not Found");
|
||||
}
|
||||
|
||||
CLI11_INLINE Validator *Option::get_validator(int index) {
|
||||
// This is an signed int so that it is not equivalent to a pointer.
|
||||
if(index >= 0 && index < static_cast<int>(validators_.size())) {
|
||||
return &(validators_[static_cast<decltype(validators_)::size_type>(index)]);
|
||||
}
|
||||
throw OptionNotFound("Validator index is not valid");
|
||||
}
|
||||
|
||||
CLI11_INLINE bool Option::remove_needs(Option *opt) {
|
||||
auto iterator = std::find(std::begin(needs_), std::end(needs_), opt);
|
||||
|
||||
if(iterator == std::end(needs_)) {
|
||||
return false;
|
||||
}
|
||||
needs_.erase(iterator);
|
||||
return true;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::excludes(Option *opt) {
|
||||
if(opt == this) {
|
||||
throw(IncorrectConstruction("and option cannot exclude itself"));
|
||||
}
|
||||
excludes_.insert(opt);
|
||||
|
||||
// Help text should be symmetric - excluding a should exclude b
|
||||
opt->excludes_.insert(this);
|
||||
|
||||
// Ignoring the insert return value, excluding twice is now allowed.
|
||||
// (Mostly to allow both directions to be excluded by user, even though the library does it for you.)
|
||||
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE bool Option::remove_excludes(Option *opt) {
|
||||
auto iterator = std::find(std::begin(excludes_), std::end(excludes_), opt);
|
||||
|
||||
if(iterator == std::end(excludes_)) {
|
||||
return false;
|
||||
}
|
||||
excludes_.erase(iterator);
|
||||
return true;
|
||||
}
|
||||
|
||||
template <typename T> Option *Option::ignore_case(bool value) {
|
||||
if(!ignore_case_ && value) {
|
||||
ignore_case_ = value;
|
||||
auto *parent = static_cast<T *>(parent_);
|
||||
for(const Option_p &opt : parent->options_) {
|
||||
if(opt.get() == this) {
|
||||
continue;
|
||||
}
|
||||
const auto &omatch = opt->matching_name(*this);
|
||||
if(!omatch.empty()) {
|
||||
ignore_case_ = false;
|
||||
throw OptionAlreadyAdded("adding ignore case caused a name conflict with " + omatch);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
ignore_case_ = value;
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
template <typename T> Option *Option::ignore_underscore(bool value) {
|
||||
|
||||
if(!ignore_underscore_ && value) {
|
||||
ignore_underscore_ = value;
|
||||
auto *parent = static_cast<T *>(parent_);
|
||||
for(const Option_p &opt : parent->options_) {
|
||||
if(opt.get() == this) {
|
||||
continue;
|
||||
}
|
||||
const auto &omatch = opt->matching_name(*this);
|
||||
if(!omatch.empty()) {
|
||||
ignore_underscore_ = false;
|
||||
throw OptionAlreadyAdded("adding ignore underscore caused a name conflict with " + omatch);
|
||||
}
|
||||
}
|
||||
} else {
|
||||
ignore_underscore_ = value;
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::multi_option_policy(MultiOptionPolicy value) {
|
||||
if(value != multi_option_policy_) {
|
||||
if(multi_option_policy_ == MultiOptionPolicy::Throw && expected_max_ == detail::expected_max_vector_size &&
|
||||
expected_min_ > 1) { // this bizarre condition is to maintain backwards compatibility
|
||||
// with the previous behavior of expected_ with vectors
|
||||
expected_max_ = expected_min_;
|
||||
}
|
||||
multi_option_policy_ = value;
|
||||
current_option_state_ = option_state::parsing;
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_NODISCARD CLI11_INLINE std::string Option::get_name(bool positional, bool all_options) const {
|
||||
if(get_group().empty())
|
||||
return {}; // Hidden
|
||||
|
||||
if(all_options) {
|
||||
|
||||
std::vector<std::string> name_list;
|
||||
|
||||
/// The all list will never include a positional unless asked or that's the only name.
|
||||
if((positional && (!pname_.empty())) || (snames_.empty() && lnames_.empty())) {
|
||||
name_list.push_back(pname_);
|
||||
}
|
||||
if((get_items_expected() == 0) && (!fnames_.empty())) {
|
||||
for(const std::string &sname : snames_) {
|
||||
name_list.push_back("-" + sname);
|
||||
if(check_fname(sname)) {
|
||||
name_list.back() += "{" + get_flag_value(sname, "") + "}";
|
||||
}
|
||||
}
|
||||
|
||||
for(const std::string &lname : lnames_) {
|
||||
name_list.push_back("--" + lname);
|
||||
if(check_fname(lname)) {
|
||||
name_list.back() += "{" + get_flag_value(lname, "") + "}";
|
||||
}
|
||||
}
|
||||
} else {
|
||||
for(const std::string &sname : snames_)
|
||||
name_list.push_back("-" + sname);
|
||||
|
||||
for(const std::string &lname : lnames_)
|
||||
name_list.push_back("--" + lname);
|
||||
}
|
||||
|
||||
return detail::join(name_list);
|
||||
}
|
||||
|
||||
// This returns the positional name no matter what
|
||||
if(positional)
|
||||
return pname_;
|
||||
|
||||
// Prefer long name
|
||||
if(!lnames_.empty())
|
||||
return std::string(2, '-') + lnames_[0];
|
||||
|
||||
// Or short name if no long name
|
||||
if(!snames_.empty())
|
||||
return std::string(1, '-') + snames_[0];
|
||||
|
||||
// If positional is the only name, it's okay to use that
|
||||
return pname_;
|
||||
}
|
||||
|
||||
CLI11_INLINE void Option::run_callback() {
|
||||
if(force_callback_ && results_.empty()) {
|
||||
add_result(default_str_);
|
||||
}
|
||||
if(current_option_state_ == option_state::parsing) {
|
||||
_validate_results(results_);
|
||||
current_option_state_ = option_state::validated;
|
||||
}
|
||||
|
||||
if(current_option_state_ < option_state::reduced) {
|
||||
_reduce_results(proc_results_, results_);
|
||||
current_option_state_ = option_state::reduced;
|
||||
}
|
||||
if(current_option_state_ >= option_state::reduced) {
|
||||
current_option_state_ = option_state::callback_run;
|
||||
if(!(callback_)) {
|
||||
return;
|
||||
}
|
||||
const results_t &send_results = proc_results_.empty() ? results_ : proc_results_;
|
||||
bool local_result = callback_(send_results);
|
||||
|
||||
if(!local_result)
|
||||
throw ConversionError(get_name(), results_);
|
||||
}
|
||||
}
|
||||
|
||||
CLI11_NODISCARD CLI11_INLINE const std::string &Option::matching_name(const Option &other) const {
|
||||
static const std::string estring;
|
||||
for(const std::string &sname : snames_)
|
||||
if(other.check_sname(sname))
|
||||
return sname;
|
||||
for(const std::string &lname : lnames_)
|
||||
if(other.check_lname(lname))
|
||||
return lname;
|
||||
|
||||
if(ignore_case_ ||
|
||||
ignore_underscore_) { // We need to do the inverse, in case we are ignore_case or ignore underscore
|
||||
for(const std::string &sname : other.snames_)
|
||||
if(check_sname(sname))
|
||||
return sname;
|
||||
for(const std::string &lname : other.lnames_)
|
||||
if(check_lname(lname))
|
||||
return lname;
|
||||
}
|
||||
return estring;
|
||||
}
|
||||
|
||||
CLI11_NODISCARD CLI11_INLINE bool Option::check_name(const std::string &name) const {
|
||||
|
||||
if(name.length() > 2 && name[0] == '-' && name[1] == '-')
|
||||
return check_lname(name.substr(2));
|
||||
if(name.length() > 1 && name.front() == '-')
|
||||
return check_sname(name.substr(1));
|
||||
if(!pname_.empty()) {
|
||||
std::string local_pname = pname_;
|
||||
std::string local_name = name;
|
||||
if(ignore_underscore_) {
|
||||
local_pname = detail::remove_underscore(local_pname);
|
||||
local_name = detail::remove_underscore(local_name);
|
||||
}
|
||||
if(ignore_case_) {
|
||||
local_pname = detail::to_lower(local_pname);
|
||||
local_name = detail::to_lower(local_name);
|
||||
}
|
||||
if(local_name == local_pname) {
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
if(!envname_.empty()) {
|
||||
// this needs to be the original since envname_ shouldn't match on case insensitivity
|
||||
return (name == envname_);
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
CLI11_NODISCARD CLI11_INLINE std::string Option::get_flag_value(const std::string &name,
|
||||
std::string input_value) const {
|
||||
static const std::string trueString{"true"};
|
||||
static const std::string falseString{"false"};
|
||||
static const std::string emptyString{"{}"};
|
||||
// check for disable flag override_
|
||||
if(disable_flag_override_) {
|
||||
if(!((input_value.empty()) || (input_value == emptyString))) {
|
||||
auto default_ind = detail::find_member(name, fnames_, ignore_case_, ignore_underscore_);
|
||||
if(default_ind >= 0) {
|
||||
// We can static cast this to std::size_t because it is more than 0 in this block
|
||||
if(default_flag_values_[static_cast<std::size_t>(default_ind)].second != input_value) {
|
||||
throw(ArgumentMismatch::FlagOverride(name));
|
||||
}
|
||||
} else {
|
||||
if(input_value != trueString) {
|
||||
throw(ArgumentMismatch::FlagOverride(name));
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
auto ind = detail::find_member(name, fnames_, ignore_case_, ignore_underscore_);
|
||||
if((input_value.empty()) || (input_value == emptyString)) {
|
||||
if(flag_like_) {
|
||||
return (ind < 0) ? trueString : default_flag_values_[static_cast<std::size_t>(ind)].second;
|
||||
}
|
||||
return (ind < 0) ? default_str_ : default_flag_values_[static_cast<std::size_t>(ind)].second;
|
||||
}
|
||||
if(ind < 0) {
|
||||
return input_value;
|
||||
}
|
||||
if(default_flag_values_[static_cast<std::size_t>(ind)].second == falseString) {
|
||||
try {
|
||||
auto val = detail::to_flag_value(input_value);
|
||||
return (val == 1) ? falseString : (val == (-1) ? trueString : std::to_string(-val));
|
||||
} catch(const std::invalid_argument &) {
|
||||
return input_value;
|
||||
}
|
||||
} else {
|
||||
return input_value;
|
||||
}
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::add_result(std::string s) {
|
||||
_add_result(std::move(s), results_);
|
||||
current_option_state_ = option_state::parsing;
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::add_result(std::string s, int &results_added) {
|
||||
results_added = _add_result(std::move(s), results_);
|
||||
current_option_state_ = option_state::parsing;
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::add_result(std::vector<std::string> s) {
|
||||
current_option_state_ = option_state::parsing;
|
||||
for(auto &str : s) {
|
||||
_add_result(std::move(str), results_);
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_NODISCARD CLI11_INLINE results_t Option::reduced_results() const {
|
||||
results_t res = proc_results_.empty() ? results_ : proc_results_;
|
||||
if(current_option_state_ < option_state::reduced) {
|
||||
if(current_option_state_ == option_state::parsing) {
|
||||
res = results_;
|
||||
_validate_results(res);
|
||||
}
|
||||
if(!res.empty()) {
|
||||
results_t extra;
|
||||
_reduce_results(extra, res);
|
||||
if(!extra.empty()) {
|
||||
res = std::move(extra);
|
||||
}
|
||||
}
|
||||
}
|
||||
return res;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::type_size(int option_type_size) {
|
||||
if(option_type_size < 0) {
|
||||
// this section is included for backwards compatibility
|
||||
type_size_max_ = -option_type_size;
|
||||
type_size_min_ = -option_type_size;
|
||||
expected_max_ = detail::expected_max_vector_size;
|
||||
} else {
|
||||
type_size_max_ = option_type_size;
|
||||
if(type_size_max_ < detail::expected_max_vector_size) {
|
||||
type_size_min_ = option_type_size;
|
||||
} else {
|
||||
inject_separator_ = true;
|
||||
}
|
||||
if(type_size_max_ == 0)
|
||||
required_ = false;
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_INLINE Option *Option::type_size(int option_type_size_min, int option_type_size_max) {
|
||||
if(option_type_size_min < 0 || option_type_size_max < 0) {
|
||||
// this section is included for backwards compatibility
|
||||
expected_max_ = detail::expected_max_vector_size;
|
||||
option_type_size_min = (std::abs)(option_type_size_min);
|
||||
option_type_size_max = (std::abs)(option_type_size_max);
|
||||
}
|
||||
|
||||
if(option_type_size_min > option_type_size_max) {
|
||||
type_size_max_ = option_type_size_min;
|
||||
type_size_min_ = option_type_size_max;
|
||||
} else {
|
||||
type_size_min_ = option_type_size_min;
|
||||
type_size_max_ = option_type_size_max;
|
||||
}
|
||||
if(type_size_max_ == 0) {
|
||||
required_ = false;
|
||||
}
|
||||
if(type_size_max_ >= detail::expected_max_vector_size) {
|
||||
inject_separator_ = true;
|
||||
}
|
||||
return this;
|
||||
}
|
||||
|
||||
CLI11_NODISCARD CLI11_INLINE std::string Option::get_type_name() const {
|
||||
std::string full_type_name = type_name_();
|
||||
if(!validators_.empty()) {
|
||||
for(const auto &Validator : validators_) {
|
||||
std::string vtype = Validator.get_description();
|
||||
if(!vtype.empty()) {
|
||||
full_type_name += ":" + vtype;
|
||||
}
|
||||
}
|
||||
}
|
||||
return full_type_name;
|
||||
}
|
||||
|
||||
CLI11_INLINE void Option::_validate_results(results_t &res) const {
|
||||
// Run the Validators (can change the string)
|
||||
if(!validators_.empty()) {
|
||||
if(type_size_max_ > 1) { // in this context index refers to the index in the type
|
||||
int index = 0;
|
||||
if(get_items_expected_max() < static_cast<int>(res.size()) &&
|
||||
multi_option_policy_ == CLI::MultiOptionPolicy::TakeLast) {
|
||||
// create a negative index for the earliest ones
|
||||
index = get_items_expected_max() - static_cast<int>(res.size());
|
||||
}
|
||||
|
||||
for(std::string &result : res) {
|
||||
if(detail::is_separator(result) && type_size_max_ != type_size_min_ && index >= 0) {
|
||||
index = 0; // reset index for variable size chunks
|
||||
continue;
|
||||
}
|
||||
auto err_msg = _validate(result, (index >= 0) ? (index % type_size_max_) : index);
|
||||
if(!err_msg.empty())
|
||||
throw ValidationError(get_name(), err_msg);
|
||||
++index;
|
||||
}
|
||||
} else {
|
||||
int index = 0;
|
||||
if(expected_max_ < static_cast<int>(res.size()) &&
|
||||
multi_option_policy_ == CLI::MultiOptionPolicy::TakeLast) {
|
||||
// create a negative index for the earliest ones
|
||||
index = expected_max_ - static_cast<int>(res.size());
|
||||
}
|
||||
for(std::string &result : res) {
|
||||
auto err_msg = _validate(result, index);
|
||||
++index;
|
||||
if(!err_msg.empty())
|
||||
throw ValidationError(get_name(), err_msg);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
CLI11_INLINE void Option::_reduce_results(results_t &out, const results_t &original) const {
|
||||
|
||||
// max num items expected or length of vector, always at least 1
|
||||
// Only valid for a trimming policy
|
||||
|
||||
out.clear();
|
||||
// Operation depends on the policy setting
|
||||
switch(multi_option_policy_) {
|
||||
case MultiOptionPolicy::TakeAll:
|
||||
break;
|
||||
case MultiOptionPolicy::TakeLast: {
|
||||
// Allow multi-option sizes (including 0)
|
||||
std::size_t trim_size = std::min<std::size_t>(
|
||||
static_cast<std::size_t>(std::max<int>(get_items_expected_max(), 1)), original.size());
|
||||
if(original.size() != trim_size) {
|
||||
out.assign(original.end() - static_cast<results_t::difference_type>(trim_size), original.end());
|
||||
}
|
||||
} break;
|
||||
case MultiOptionPolicy::TakeFirst: {
|
||||
std::size_t trim_size = std::min<std::size_t>(
|
||||
static_cast<std::size_t>(std::max<int>(get_items_expected_max(), 1)), original.size());
|
||||
if(original.size() != trim_size) {
|
||||
out.assign(original.begin(), original.begin() + static_cast<results_t::difference_type>(trim_size));
|
||||
}
|
||||
} break;
|
||||
case MultiOptionPolicy::Join:
|
||||
if(results_.size() > 1) {
|
||||
out.push_back(detail::join(original, std::string(1, (delimiter_ == '\0') ? '\n' : delimiter_)));
|
||||
}
|
||||
break;
|
||||
case MultiOptionPolicy::Sum:
|
||||
out.push_back(detail::sum_string_vector(original));
|
||||
break;
|
||||
case MultiOptionPolicy::Throw:
|
||||
default: {
|
||||
auto num_min = static_cast<std::size_t>(get_items_expected_min());
|
||||
auto num_max = static_cast<std::size_t>(get_items_expected_max());
|
||||
if(num_min == 0) {
|
||||
num_min = 1;
|
||||
}
|
||||
if(num_max == 0) {
|
||||
num_max = 1;
|
||||
}
|
||||
if(original.size() < num_min) {
|
||||
throw ArgumentMismatch::AtLeast(get_name(), static_cast<int>(num_min), original.size());
|
||||
}
|
||||
if(original.size() > num_max) {
|
||||
throw ArgumentMismatch::AtMost(get_name(), static_cast<int>(num_max), original.size());
|
||||
}
|
||||
break;
|
||||
}
|
||||
}
|
||||
// this check is to allow an empty vector in certain circumstances but not if expected is not zero.
|
||||
// {} is the indicator for an empty container
|
||||
if(out.empty()) {
|
||||
if(original.size() == 1 && original[0] == "{}" && get_items_expected_min() > 0) {
|
||||
out.push_back("{}");
|
||||
out.push_back("%%");
|
||||
}
|
||||
} else if(out.size() == 1 && out[0] == "{}" && get_items_expected_min() > 0) {
|
||||
out.push_back("%%");
|
||||
}
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string Option::_validate(std::string &result, int index) const {
|
||||
std::string err_msg;
|
||||
if(result.empty() && expected_min_ == 0) {
|
||||
// an empty with nothing expected is allowed
|
||||
return err_msg;
|
||||
}
|
||||
for(const auto &vali : validators_) {
|
||||
auto v = vali.get_application_index();
|
||||
if(v == -1 || v == index) {
|
||||
try {
|
||||
err_msg = vali(result);
|
||||
} catch(const ValidationError &err) {
|
||||
err_msg = err.what();
|
||||
}
|
||||
if(!err_msg.empty())
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return err_msg;
|
||||
}
|
||||
|
||||
CLI11_INLINE int Option::_add_result(std::string &&result, std::vector<std::string> &res) const {
|
||||
int result_count = 0;
|
||||
if(allow_extra_args_ && !result.empty() && result.front() == '[' &&
|
||||
result.back() == ']') { // this is now a vector string likely from the default or user entry
|
||||
result.pop_back();
|
||||
|
||||
for(auto &var : CLI::detail::split(result.substr(1), ',')) {
|
||||
if(!var.empty()) {
|
||||
result_count += _add_result(std::move(var), res);
|
||||
}
|
||||
}
|
||||
return result_count;
|
||||
}
|
||||
if(delimiter_ == '\0') {
|
||||
res.push_back(std::move(result));
|
||||
++result_count;
|
||||
} else {
|
||||
if((result.find_first_of(delimiter_) != std::string::npos)) {
|
||||
for(const auto &var : CLI::detail::split(result, delimiter_)) {
|
||||
if(!var.empty()) {
|
||||
res.push_back(var);
|
||||
++result_count;
|
||||
}
|
||||
}
|
||||
} else {
|
||||
res.push_back(std::move(result));
|
||||
++result_count;
|
||||
}
|
||||
}
|
||||
return result_count;
|
||||
}
|
||||
// [CLI11:option_inl_hpp:end]
|
||||
} // namespace CLI
|
||||
139
libs/CLI11/include/CLI/impl/Split_inl.hpp
Normal file
139
libs/CLI11/include/CLI/impl/Split_inl.hpp
Normal file
@@ -0,0 +1,139 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// This include is only needed for IDEs to discover symbols
|
||||
#include <CLI/Split.hpp>
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <string>
|
||||
#include <tuple>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
#include <CLI/Error.hpp>
|
||||
#include <CLI/StringTools.hpp>
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:split_inl_hpp:verbatim]
|
||||
|
||||
namespace detail {
|
||||
|
||||
CLI11_INLINE bool split_short(const std::string ¤t, std::string &name, std::string &rest) {
|
||||
if(current.size() > 1 && current[0] == '-' && valid_first_char(current[1])) {
|
||||
name = current.substr(1, 1);
|
||||
rest = current.substr(2);
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
CLI11_INLINE bool split_long(const std::string ¤t, std::string &name, std::string &value) {
|
||||
if(current.size() > 2 && current.substr(0, 2) == "--" && valid_first_char(current[2])) {
|
||||
auto loc = current.find_first_of('=');
|
||||
if(loc != std::string::npos) {
|
||||
name = current.substr(2, loc - 2);
|
||||
value = current.substr(loc + 1);
|
||||
} else {
|
||||
name = current.substr(2);
|
||||
value = "";
|
||||
}
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
CLI11_INLINE bool split_windows_style(const std::string ¤t, std::string &name, std::string &value) {
|
||||
if(current.size() > 1 && current[0] == '/' && valid_first_char(current[1])) {
|
||||
auto loc = current.find_first_of(':');
|
||||
if(loc != std::string::npos) {
|
||||
name = current.substr(1, loc - 1);
|
||||
value = current.substr(loc + 1);
|
||||
} else {
|
||||
name = current.substr(1);
|
||||
value = "";
|
||||
}
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::vector<std::string> split_names(std::string current) {
|
||||
std::vector<std::string> output;
|
||||
std::size_t val = 0;
|
||||
while((val = current.find(',')) != std::string::npos) {
|
||||
output.push_back(trim_copy(current.substr(0, val)));
|
||||
current = current.substr(val + 1);
|
||||
}
|
||||
output.push_back(trim_copy(current));
|
||||
return output;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::vector<std::pair<std::string, std::string>> get_default_flag_values(const std::string &str) {
|
||||
std::vector<std::string> flags = split_names(str);
|
||||
flags.erase(std::remove_if(flags.begin(),
|
||||
flags.end(),
|
||||
[](const std::string &name) {
|
||||
return ((name.empty()) || (!(((name.find_first_of('{') != std::string::npos) &&
|
||||
(name.back() == '}')) ||
|
||||
(name[0] == '!'))));
|
||||
}),
|
||||
flags.end());
|
||||
std::vector<std::pair<std::string, std::string>> output;
|
||||
output.reserve(flags.size());
|
||||
for(auto &flag : flags) {
|
||||
auto def_start = flag.find_first_of('{');
|
||||
std::string defval = "false";
|
||||
if((def_start != std::string::npos) && (flag.back() == '}')) {
|
||||
defval = flag.substr(def_start + 1);
|
||||
defval.pop_back();
|
||||
flag.erase(def_start, std::string::npos); // NOLINT(readability-suspicious-call-argument)
|
||||
}
|
||||
flag.erase(0, flag.find_first_not_of("-!"));
|
||||
output.emplace_back(flag, defval);
|
||||
}
|
||||
return output;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::tuple<std::vector<std::string>, std::vector<std::string>, std::string>
|
||||
get_names(const std::vector<std::string> &input) {
|
||||
|
||||
std::vector<std::string> short_names;
|
||||
std::vector<std::string> long_names;
|
||||
std::string pos_name;
|
||||
|
||||
for(std::string name : input) {
|
||||
if(name.length() == 0) {
|
||||
continue;
|
||||
}
|
||||
if(name.length() > 1 && name[0] == '-' && name[1] != '-') {
|
||||
if(name.length() == 2 && valid_first_char(name[1]))
|
||||
short_names.emplace_back(1, name[1]);
|
||||
else
|
||||
throw BadNameString::OneCharName(name);
|
||||
} else if(name.length() > 2 && name.substr(0, 2) == "--") {
|
||||
name = name.substr(2);
|
||||
if(valid_name_string(name))
|
||||
long_names.push_back(name);
|
||||
else
|
||||
throw BadNameString::BadLongName(name);
|
||||
} else if(name == "-" || name == "--") {
|
||||
throw BadNameString::DashesOnly(name);
|
||||
} else {
|
||||
if(pos_name.length() > 0)
|
||||
throw BadNameString::MultiPositionalNames(name);
|
||||
pos_name = name;
|
||||
}
|
||||
}
|
||||
|
||||
return std::make_tuple(short_names, long_names, pos_name);
|
||||
}
|
||||
|
||||
} // namespace detail
|
||||
// [CLI11:split_inl_hpp:end]
|
||||
} // namespace CLI
|
||||
260
libs/CLI11/include/CLI/impl/StringTools_inl.hpp
Normal file
260
libs/CLI11/include/CLI/impl/StringTools_inl.hpp
Normal file
@@ -0,0 +1,260 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
// This include is only needed for IDEs to discover symbols
|
||||
#include <CLI/StringTools.hpp>
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <string>
|
||||
#include <vector>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:string_tools_inl_hpp:verbatim]
|
||||
|
||||
namespace detail {
|
||||
CLI11_INLINE std::vector<std::string> split(const std::string &s, char delim) {
|
||||
std::vector<std::string> elems;
|
||||
// Check to see if empty string, give consistent result
|
||||
if(s.empty()) {
|
||||
elems.emplace_back();
|
||||
} else {
|
||||
std::stringstream ss;
|
||||
ss.str(s);
|
||||
std::string item;
|
||||
while(std::getline(ss, item, delim)) {
|
||||
elems.push_back(item);
|
||||
}
|
||||
}
|
||||
return elems;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string <rim(std::string &str) {
|
||||
auto it = std::find_if(str.begin(), str.end(), [](char ch) { return !std::isspace<char>(ch, std::locale()); });
|
||||
str.erase(str.begin(), it);
|
||||
return str;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string <rim(std::string &str, const std::string &filter) {
|
||||
auto it = std::find_if(str.begin(), str.end(), [&filter](char ch) { return filter.find(ch) == std::string::npos; });
|
||||
str.erase(str.begin(), it);
|
||||
return str;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string &rtrim(std::string &str) {
|
||||
auto it = std::find_if(str.rbegin(), str.rend(), [](char ch) { return !std::isspace<char>(ch, std::locale()); });
|
||||
str.erase(it.base(), str.end());
|
||||
return str;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string &rtrim(std::string &str, const std::string &filter) {
|
||||
auto it =
|
||||
std::find_if(str.rbegin(), str.rend(), [&filter](char ch) { return filter.find(ch) == std::string::npos; });
|
||||
str.erase(it.base(), str.end());
|
||||
return str;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string &remove_quotes(std::string &str) {
|
||||
if(str.length() > 1 && (str.front() == '"' || str.front() == '\'')) {
|
||||
if(str.front() == str.back()) {
|
||||
str.pop_back();
|
||||
str.erase(str.begin(), str.begin() + 1);
|
||||
}
|
||||
}
|
||||
return str;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string fix_newlines(const std::string &leader, std::string input) {
|
||||
std::string::size_type n = 0;
|
||||
while(n != std::string::npos && n < input.size()) {
|
||||
n = input.find('\n', n);
|
||||
if(n != std::string::npos) {
|
||||
input = input.substr(0, n + 1) + leader + input.substr(n + 1);
|
||||
n += leader.size();
|
||||
}
|
||||
}
|
||||
return input;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::ostream &
|
||||
format_help(std::ostream &out, std::string name, const std::string &description, std::size_t wid) {
|
||||
name = " " + name;
|
||||
out << std::setw(static_cast<int>(wid)) << std::left << name;
|
||||
if(!description.empty()) {
|
||||
if(name.length() >= wid)
|
||||
out << "\n" << std::setw(static_cast<int>(wid)) << "";
|
||||
for(const char c : description) {
|
||||
out.put(c);
|
||||
if(c == '\n') {
|
||||
out << std::setw(static_cast<int>(wid)) << "";
|
||||
}
|
||||
}
|
||||
}
|
||||
out << "\n";
|
||||
return out;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::ostream &format_aliases(std::ostream &out, const std::vector<std::string> &aliases, std::size_t wid) {
|
||||
if(!aliases.empty()) {
|
||||
out << std::setw(static_cast<int>(wid)) << " aliases: ";
|
||||
bool front = true;
|
||||
for(const auto &alias : aliases) {
|
||||
if(!front) {
|
||||
out << ", ";
|
||||
} else {
|
||||
front = false;
|
||||
}
|
||||
out << detail::fix_newlines(" ", alias);
|
||||
}
|
||||
out << "\n";
|
||||
}
|
||||
return out;
|
||||
}
|
||||
|
||||
CLI11_INLINE bool valid_name_string(const std::string &str) {
|
||||
if(str.empty() || !valid_first_char(str[0])) {
|
||||
return false;
|
||||
}
|
||||
auto e = str.end();
|
||||
for(auto c = str.begin() + 1; c != e; ++c)
|
||||
if(!valid_later_char(*c))
|
||||
return false;
|
||||
return true;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string find_and_replace(std::string str, std::string from, std::string to) {
|
||||
|
||||
std::size_t start_pos = 0;
|
||||
|
||||
while((start_pos = str.find(from, start_pos)) != std::string::npos) {
|
||||
str.replace(start_pos, from.length(), to);
|
||||
start_pos += to.length();
|
||||
}
|
||||
|
||||
return str;
|
||||
}
|
||||
|
||||
CLI11_INLINE void remove_default_flag_values(std::string &flags) {
|
||||
auto loc = flags.find_first_of('{', 2);
|
||||
while(loc != std::string::npos) {
|
||||
auto finish = flags.find_first_of("},", loc + 1);
|
||||
if((finish != std::string::npos) && (flags[finish] == '}')) {
|
||||
flags.erase(flags.begin() + static_cast<std::ptrdiff_t>(loc),
|
||||
flags.begin() + static_cast<std::ptrdiff_t>(finish) + 1);
|
||||
}
|
||||
loc = flags.find_first_of('{', loc + 1);
|
||||
}
|
||||
flags.erase(std::remove(flags.begin(), flags.end(), '!'), flags.end());
|
||||
}
|
||||
|
||||
CLI11_INLINE std::ptrdiff_t
|
||||
find_member(std::string name, const std::vector<std::string> names, bool ignore_case, bool ignore_underscore) {
|
||||
auto it = std::end(names);
|
||||
if(ignore_case) {
|
||||
if(ignore_underscore) {
|
||||
name = detail::to_lower(detail::remove_underscore(name));
|
||||
it = std::find_if(std::begin(names), std::end(names), [&name](std::string local_name) {
|
||||
return detail::to_lower(detail::remove_underscore(local_name)) == name;
|
||||
});
|
||||
} else {
|
||||
name = detail::to_lower(name);
|
||||
it = std::find_if(std::begin(names), std::end(names), [&name](std::string local_name) {
|
||||
return detail::to_lower(local_name) == name;
|
||||
});
|
||||
}
|
||||
|
||||
} else if(ignore_underscore) {
|
||||
name = detail::remove_underscore(name);
|
||||
it = std::find_if(std::begin(names), std::end(names), [&name](std::string local_name) {
|
||||
return detail::remove_underscore(local_name) == name;
|
||||
});
|
||||
} else {
|
||||
it = std::find(std::begin(names), std::end(names), name);
|
||||
}
|
||||
|
||||
return (it != std::end(names)) ? (it - std::begin(names)) : (-1);
|
||||
}
|
||||
|
||||
CLI11_INLINE std::vector<std::string> split_up(std::string str, char delimiter) {
|
||||
|
||||
const std::string delims("\'\"`");
|
||||
auto find_ws = [delimiter](char ch) {
|
||||
return (delimiter == '\0') ? std::isspace<char>(ch, std::locale()) : (ch == delimiter);
|
||||
};
|
||||
trim(str);
|
||||
|
||||
std::vector<std::string> output;
|
||||
bool embeddedQuote = false;
|
||||
char keyChar = ' ';
|
||||
while(!str.empty()) {
|
||||
if(delims.find_first_of(str[0]) != std::string::npos) {
|
||||
keyChar = str[0];
|
||||
auto end = str.find_first_of(keyChar, 1);
|
||||
while((end != std::string::npos) && (str[end - 1] == '\\')) { // deal with escaped quotes
|
||||
end = str.find_first_of(keyChar, end + 1);
|
||||
embeddedQuote = true;
|
||||
}
|
||||
if(end != std::string::npos) {
|
||||
output.push_back(str.substr(1, end - 1));
|
||||
if(end + 2 < str.size()) {
|
||||
str = str.substr(end + 2);
|
||||
} else {
|
||||
str.clear();
|
||||
}
|
||||
|
||||
} else {
|
||||
output.push_back(str.substr(1));
|
||||
str = "";
|
||||
}
|
||||
} else {
|
||||
auto it = std::find_if(std::begin(str), std::end(str), find_ws);
|
||||
if(it != std::end(str)) {
|
||||
std::string value = std::string(str.begin(), it);
|
||||
output.push_back(value);
|
||||
str = std::string(it + 1, str.end());
|
||||
} else {
|
||||
output.push_back(str);
|
||||
str = "";
|
||||
}
|
||||
}
|
||||
// transform any embedded quotes into the regular character
|
||||
if(embeddedQuote) {
|
||||
output.back() = find_and_replace(output.back(), std::string("\\") + keyChar, std::string(1, keyChar));
|
||||
embeddedQuote = false;
|
||||
}
|
||||
trim(str);
|
||||
}
|
||||
return output;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::size_t escape_detect(std::string &str, std::size_t offset) {
|
||||
auto next = str[offset + 1];
|
||||
if((next == '\"') || (next == '\'') || (next == '`')) {
|
||||
auto astart = str.find_last_of("-/ \"\'`", offset - 1);
|
||||
if(astart != std::string::npos) {
|
||||
if(str[astart] == ((str[offset] == '=') ? '-' : '/'))
|
||||
str[offset] = ' '; // interpret this as a space so the split_up works properly
|
||||
}
|
||||
}
|
||||
return offset + 1;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::string &add_quotes_if_needed(std::string &str) {
|
||||
if((str.front() != '"' && str.front() != '\'') || str.front() != str.back()) {
|
||||
char quote = str.find('"') < str.find('\'') ? '\'' : '"';
|
||||
if(str.find(' ') != std::string::npos) {
|
||||
str.insert(0, 1, quote);
|
||||
str.append(1, quote);
|
||||
}
|
||||
}
|
||||
return str;
|
||||
}
|
||||
|
||||
} // namespace detail
|
||||
// [CLI11:string_tools_inl_hpp:end]
|
||||
} // namespace CLI
|
||||
346
libs/CLI11/include/CLI/impl/Validators_inl.hpp
Normal file
346
libs/CLI11/include/CLI/impl/Validators_inl.hpp
Normal file
@@ -0,0 +1,346 @@
|
||||
// Copyright (c) 2017-2022, University of Cincinnati, developed by Henry Schreiner
|
||||
// under NSF AWARD 1414736 and by the respective contributors.
|
||||
// All rights reserved.
|
||||
//
|
||||
// SPDX-License-Identifier: BSD-3-Clause
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <CLI/Validators.hpp>
|
||||
|
||||
#include <CLI/Macros.hpp>
|
||||
#include <CLI/StringTools.hpp>
|
||||
#include <CLI/TypeTools.hpp>
|
||||
|
||||
// [CLI11:public_includes:set]
|
||||
#include <map>
|
||||
#include <string>
|
||||
#include <utility>
|
||||
// [CLI11:public_includes:end]
|
||||
|
||||
namespace CLI {
|
||||
// [CLI11:validators_inl_hpp:verbatim]
|
||||
|
||||
CLI11_INLINE std::string Validator::operator()(std::string &str) const {
|
||||
std::string retstring;
|
||||
if(active_) {
|
||||
if(non_modifying_) {
|
||||
std::string value = str;
|
||||
retstring = func_(value);
|
||||
} else {
|
||||
retstring = func_(str);
|
||||
}
|
||||
}
|
||||
return retstring;
|
||||
}
|
||||
|
||||
CLI11_NODISCARD CLI11_INLINE Validator Validator::description(std::string validator_desc) const {
|
||||
Validator newval(*this);
|
||||
newval.desc_function_ = [validator_desc]() { return validator_desc; };
|
||||
return newval;
|
||||
}
|
||||
|
||||
CLI11_INLINE Validator Validator::operator&(const Validator &other) const {
|
||||
Validator newval;
|
||||
|
||||
newval._merge_description(*this, other, " AND ");
|
||||
|
||||
// Give references (will make a copy in lambda function)
|
||||
const std::function<std::string(std::string & filename)> &f1 = func_;
|
||||
const std::function<std::string(std::string & filename)> &f2 = other.func_;
|
||||
|
||||
newval.func_ = [f1, f2](std::string &input) {
|
||||
std::string s1 = f1(input);
|
||||
std::string s2 = f2(input);
|
||||
if(!s1.empty() && !s2.empty())
|
||||
return std::string("(") + s1 + ") AND (" + s2 + ")";
|
||||
return s1 + s2;
|
||||
};
|
||||
|
||||
newval.active_ = active_ && other.active_;
|
||||
newval.application_index_ = application_index_;
|
||||
return newval;
|
||||
}
|
||||
|
||||
CLI11_INLINE Validator Validator::operator|(const Validator &other) const {
|
||||
Validator newval;
|
||||
|
||||
newval._merge_description(*this, other, " OR ");
|
||||
|
||||
// Give references (will make a copy in lambda function)
|
||||
const std::function<std::string(std::string &)> &f1 = func_;
|
||||
const std::function<std::string(std::string &)> &f2 = other.func_;
|
||||
|
||||
newval.func_ = [f1, f2](std::string &input) {
|
||||
std::string s1 = f1(input);
|
||||
std::string s2 = f2(input);
|
||||
if(s1.empty() || s2.empty())
|
||||
return std::string();
|
||||
|
||||
return std::string("(") + s1 + ") OR (" + s2 + ")";
|
||||
};
|
||||
newval.active_ = active_ && other.active_;
|
||||
newval.application_index_ = application_index_;
|
||||
return newval;
|
||||
}
|
||||
|
||||
CLI11_INLINE Validator Validator::operator!() const {
|
||||
Validator newval;
|
||||
const std::function<std::string()> &dfunc1 = desc_function_;
|
||||
newval.desc_function_ = [dfunc1]() {
|
||||
auto str = dfunc1();
|
||||
return (!str.empty()) ? std::string("NOT ") + str : std::string{};
|
||||
};
|
||||
// Give references (will make a copy in lambda function)
|
||||
const std::function<std::string(std::string & res)> &f1 = func_;
|
||||
|
||||
newval.func_ = [f1, dfunc1](std::string &test) -> std::string {
|
||||
std::string s1 = f1(test);
|
||||
if(s1.empty()) {
|
||||
return std::string("check ") + dfunc1() + " succeeded improperly";
|
||||
}
|
||||
return std::string{};
|
||||
};
|
||||
newval.active_ = active_;
|
||||
newval.application_index_ = application_index_;
|
||||
return newval;
|
||||
}
|
||||
|
||||
CLI11_INLINE void
|
||||
Validator::_merge_description(const Validator &val1, const Validator &val2, const std::string &merger) {
|
||||
|
||||
const std::function<std::string()> &dfunc1 = val1.desc_function_;
|
||||
const std::function<std::string()> &dfunc2 = val2.desc_function_;
|
||||
|
||||
desc_function_ = [=]() {
|
||||
std::string f1 = dfunc1();
|
||||
std::string f2 = dfunc2();
|
||||
if((f1.empty()) || (f2.empty())) {
|
||||
return f1 + f2;
|
||||
}
|
||||
return std::string(1, '(') + f1 + ')' + merger + '(' + f2 + ')';
|
||||
};
|
||||
}
|
||||
|
||||
namespace detail {
|
||||
|
||||
#if defined CLI11_HAS_FILESYSTEM && CLI11_HAS_FILESYSTEM > 0
|
||||
CLI11_INLINE path_type check_path(const char *file) noexcept {
|
||||
std::error_code ec;
|
||||
auto stat = std::filesystem::status(file, ec);
|
||||
if(ec) {
|
||||
return path_type::nonexistent;
|
||||
}
|
||||
switch(stat.type()) {
|
||||
case std::filesystem::file_type::none: // LCOV_EXCL_LINE
|
||||
case std::filesystem::file_type::not_found:
|
||||
return path_type::nonexistent;
|
||||
case std::filesystem::file_type::directory:
|
||||
return path_type::directory;
|
||||
case std::filesystem::file_type::symlink:
|
||||
case std::filesystem::file_type::block:
|
||||
case std::filesystem::file_type::character:
|
||||
case std::filesystem::file_type::fifo:
|
||||
case std::filesystem::file_type::socket:
|
||||
case std::filesystem::file_type::regular:
|
||||
case std::filesystem::file_type::unknown:
|
||||
default:
|
||||
return path_type::file;
|
||||
}
|
||||
}
|
||||
#else
|
||||
CLI11_INLINE path_type check_path(const char *file) noexcept {
|
||||
#if defined(_MSC_VER)
|
||||
struct __stat64 buffer;
|
||||
if(_stat64(file, &buffer) == 0) {
|
||||
return ((buffer.st_mode & S_IFDIR) != 0) ? path_type::directory : path_type::file;
|
||||
}
|
||||
#else
|
||||
struct stat buffer;
|
||||
if(stat(file, &buffer) == 0) {
|
||||
return ((buffer.st_mode & S_IFDIR) != 0) ? path_type::directory : path_type::file;
|
||||
}
|
||||
#endif
|
||||
return path_type::nonexistent;
|
||||
}
|
||||
#endif
|
||||
|
||||
CLI11_INLINE ExistingFileValidator::ExistingFileValidator() : Validator("FILE") {
|
||||
func_ = [](std::string &filename) {
|
||||
auto path_result = check_path(filename.c_str());
|
||||
if(path_result == path_type::nonexistent) {
|
||||
return "File does not exist: " + filename;
|
||||
}
|
||||
if(path_result == path_type::directory) {
|
||||
return "File is actually a directory: " + filename;
|
||||
}
|
||||
return std::string();
|
||||
};
|
||||
}
|
||||
|
||||
CLI11_INLINE ExistingDirectoryValidator::ExistingDirectoryValidator() : Validator("DIR") {
|
||||
func_ = [](std::string &filename) {
|
||||
auto path_result = check_path(filename.c_str());
|
||||
if(path_result == path_type::nonexistent) {
|
||||
return "Directory does not exist: " + filename;
|
||||
}
|
||||
if(path_result == path_type::file) {
|
||||
return "Directory is actually a file: " + filename;
|
||||
}
|
||||
return std::string();
|
||||
};
|
||||
}
|
||||
|
||||
CLI11_INLINE ExistingPathValidator::ExistingPathValidator() : Validator("PATH(existing)") {
|
||||
func_ = [](std::string &filename) {
|
||||
auto path_result = check_path(filename.c_str());
|
||||
if(path_result == path_type::nonexistent) {
|
||||
return "Path does not exist: " + filename;
|
||||
}
|
||||
return std::string();
|
||||
};
|
||||
}
|
||||
|
||||
CLI11_INLINE NonexistentPathValidator::NonexistentPathValidator() : Validator("PATH(non-existing)") {
|
||||
func_ = [](std::string &filename) {
|
||||
auto path_result = check_path(filename.c_str());
|
||||
if(path_result != path_type::nonexistent) {
|
||||
return "Path already exists: " + filename;
|
||||
}
|
||||
return std::string();
|
||||
};
|
||||
}
|
||||
|
||||
CLI11_INLINE IPV4Validator::IPV4Validator() : Validator("IPV4") {
|
||||
func_ = [](std::string &ip_addr) {
|
||||
auto result = CLI::detail::split(ip_addr, '.');
|
||||
if(result.size() != 4) {
|
||||
return std::string("Invalid IPV4 address must have four parts (") + ip_addr + ')';
|
||||
}
|
||||
int num = 0;
|
||||
for(const auto &var : result) {
|
||||
bool retval = detail::lexical_cast(var, num);
|
||||
if(!retval) {
|
||||
return std::string("Failed parsing number (") + var + ')';
|
||||
}
|
||||
if(num < 0 || num > 255) {
|
||||
return std::string("Each IP number must be between 0 and 255 ") + var;
|
||||
}
|
||||
}
|
||||
return std::string();
|
||||
};
|
||||
}
|
||||
|
||||
} // namespace detail
|
||||
|
||||
CLI11_INLINE FileOnDefaultPath::FileOnDefaultPath(std::string default_path, bool enableErrorReturn)
|
||||
: Validator("FILE") {
|
||||
func_ = [default_path, enableErrorReturn](std::string &filename) {
|
||||
auto path_result = detail::check_path(filename.c_str());
|
||||
if(path_result == detail::path_type::nonexistent) {
|
||||
std::string test_file_path = default_path;
|
||||
if(default_path.back() != '/' && default_path.back() != '\\') {
|
||||
// Add folder separator
|
||||
test_file_path += '/';
|
||||
}
|
||||
test_file_path.append(filename);
|
||||
path_result = detail::check_path(test_file_path.c_str());
|
||||
if(path_result == detail::path_type::file) {
|
||||
filename = test_file_path;
|
||||
} else {
|
||||
if(enableErrorReturn) {
|
||||
return "File does not exist: " + filename;
|
||||
}
|
||||
}
|
||||
}
|
||||
return std::string{};
|
||||
};
|
||||
}
|
||||
|
||||
CLI11_INLINE AsSizeValue::AsSizeValue(bool kb_is_1000) : AsNumberWithUnit(get_mapping(kb_is_1000)) {
|
||||
if(kb_is_1000) {
|
||||
description("SIZE [b, kb(=1000b), kib(=1024b), ...]");
|
||||
} else {
|
||||
description("SIZE [b, kb(=1024b), ...]");
|
||||
}
|
||||
}
|
||||
|
||||
CLI11_INLINE std::map<std::string, AsSizeValue::result_t> AsSizeValue::init_mapping(bool kb_is_1000) {
|
||||
std::map<std::string, result_t> m;
|
||||
result_t k_factor = kb_is_1000 ? 1000 : 1024;
|
||||
result_t ki_factor = 1024;
|
||||
result_t k = 1;
|
||||
result_t ki = 1;
|
||||
m["b"] = 1;
|
||||
for(std::string p : {"k", "m", "g", "t", "p", "e"}) {
|
||||
k *= k_factor;
|
||||
ki *= ki_factor;
|
||||
m[p] = k;
|
||||
m[p + "b"] = k;
|
||||
m[p + "i"] = ki;
|
||||
m[p + "ib"] = ki;
|
||||
}
|
||||
return m;
|
||||
}
|
||||
|
||||
CLI11_INLINE std::map<std::string, AsSizeValue::result_t> AsSizeValue::get_mapping(bool kb_is_1000) {
|
||||
if(kb_is_1000) {
|
||||
static auto m = init_mapping(true);
|
||||
return m;
|
||||
}
|
||||
static auto m = init_mapping(false);
|
||||
return m;
|
||||
}
|
||||
|
||||
namespace detail {
|
||||
|
||||
CLI11_INLINE std::pair<std::string, std::string> split_program_name(std::string commandline) {
|
||||
// try to determine the programName
|
||||
std::pair<std::string, std::string> vals;
|
||||
trim(commandline);
|
||||
auto esp = commandline.find_first_of(' ', 1);
|
||||
while(detail::check_path(commandline.substr(0, esp).c_str()) != path_type::file) {
|
||||
esp = commandline.find_first_of(' ', esp + 1);
|
||||
if(esp == std::string::npos) {
|
||||
// if we have reached the end and haven't found a valid file just assume the first argument is the
|
||||
// program name
|
||||
if(commandline[0] == '"' || commandline[0] == '\'' || commandline[0] == '`') {
|
||||
bool embeddedQuote = false;
|
||||
auto keyChar = commandline[0];
|
||||
auto end = commandline.find_first_of(keyChar, 1);
|
||||
while((end != std::string::npos) && (commandline[end - 1] == '\\')) { // deal with escaped quotes
|
||||
end = commandline.find_first_of(keyChar, end + 1);
|
||||
embeddedQuote = true;
|
||||
}
|
||||
if(end != std::string::npos) {
|
||||
vals.first = commandline.substr(1, end - 1);
|
||||
esp = end + 1;
|
||||
if(embeddedQuote) {
|
||||
vals.first = find_and_replace(vals.first, std::string("\\") + keyChar, std::string(1, keyChar));
|
||||
}
|
||||
} else {
|
||||
esp = commandline.find_first_of(' ', 1);
|
||||
}
|
||||
} else {
|
||||
esp = commandline.find_first_of(' ', 1);
|
||||
}
|
||||
|
||||
break;
|
||||
}
|
||||
}
|
||||
if(vals.first.empty()) {
|
||||
vals.first = commandline.substr(0, esp);
|
||||
rtrim(vals.first);
|
||||
}
|
||||
|
||||
// strip the program name
|
||||
vals.second = (esp < commandline.length() - 1) ? commandline.substr(esp + 1) : std::string{};
|
||||
ltrim(vals.second);
|
||||
return vals;
|
||||
}
|
||||
|
||||
} // namespace detail
|
||||
/// @}
|
||||
|
||||
// [CLI11:validators_inl_hpp:end]
|
||||
} // namespace CLI
|
||||
Reference in New Issue
Block a user