fml::CommandLine Class Reference

#include <command_line.h>

Classes
struct	Option

Public Member Functions
	CommandLine ()
	CommandLine (const CommandLine &from)
	CommandLine (CommandLine &&from)
	CommandLine (const std::string &argv0, const std::vector< Option > &options, const std::vector< std::string > &positional_args)
	~CommandLine ()
CommandLine &	operator= (const CommandLine &from)
CommandLine &	operator= (CommandLine &&from)
bool	has_argv0 () const
const std::string &	argv0 () const
const std::vector< Option > &	options () const
const std::vector< std::string > &	positional_args () const
bool	operator== (const CommandLine &other) const
bool	operator!= (const CommandLine &other) const
bool	HasOption (std::string_view name, size_t *index=nullptr) const
bool	GetOptionValue (std::string_view name, std::string *value) const
std::vector< std::string_view >	GetOptionValues (std::string_view name) const
std::string	GetOptionValueWithDefault (std::string_view name, std::string_view default_value) const

Detailed Description

Definition at line 56 of file command_line.h.

Constructor & Destructor Documentation

CommandLine() [1/4]

fml::CommandLine::CommandLine ( )

default

CommandLine() [2/4]

fml::CommandLine::CommandLine ( const CommandLine &  from )

default

CommandLine() [3/4]

fml::CommandLine::CommandLine ( CommandLine &&  from )

default

CommandLine() [4/4]

fml::CommandLine::CommandLine ( const std::string &  argv0, const std::vector< Option > &  options, const std::vector< std::string > &  positional_args  )

explicit

Definition at line 22 of file command_line.cc.

    : has_argv0_(true),
      argv0_(argv0),
      options_(options),
      positional_args_(positional_args) {
  for (size_t i = 0; i < options_.size(); i++) {
    option_index_[options_[i].name] = i;
  }
}

~CommandLine()

fml::CommandLine::~CommandLine ( )

default

Member Function Documentation

argv0()

const std::string & fml::CommandLine::argv0 ( ) const

inline

Definition at line 94 of file command_line.h.

{ return argv0_; }

GetOptionValue()

bool fml::CommandLine::GetOptionValue	(	std::string_view	name,
		std::string *	value
	)		const

Definition at line 51 of file command_line.cc.

                                                         {
  size_t index;
  if (!HasOption(name, &index)) {
    return false;
  }
  *value = options_[index].value;
  return true;
}

GetOptionValues()

std::vector< std::string_view > fml::CommandLine::GetOptionValues

(

std::string_view

name

)

const

Definition at line 61 of file command_line.cc.

                               {
  std::vector<std::string_view> ret;
  for (const auto& option : options_) {
    if (option.name == name) {
      ret.push_back(option.value);
    }
  }
  return ret;
}

GetOptionValueWithDefault()

std::string fml::CommandLine::GetOptionValueWithDefault	(	std::string_view	name,
		std::string_view	default_value
	)		const

Definition at line 72 of file command_line.cc.

                                        {
  size_t index;
  if (!HasOption(name, &index)) {
    return {default_value.data(), default_value.size()};
  }
  return options_[index].value;
}

has_argv0()

bool fml::CommandLine::has_argv0 ( ) const

inline

Definition at line 93 of file command_line.h.

{ return has_argv0_; }

HasOption()

bool fml::CommandLine::HasOption	(	std::string_view	name,
		size_t *	index = nullptr
	)		const

Definition at line 40 of file command_line.cc.

                                                                    {
  auto it = option_index_.find(name.data());
  if (it == option_index_.end()) {
    return false;
  }
  if (index) {
    *index = it->second;
  }
  return true;
}

operator!=()

bool fml::CommandLine::operator!= ( const CommandLine &  other ) const

inline

Definition at line 106 of file command_line.h.

{ return !operator==(other); }

operator=() [1/2]

CommandLine & fml::CommandLine::operator= ( CommandLine &&  from )

default

operator=() [2/2]

CommandLine & fml::CommandLine::operator= ( const CommandLine &  from )

default

operator==()

bool fml::CommandLine::operator== ( const CommandLine &  other ) const

inline

Definition at line 100 of file command_line.h.

                                                  {
    // No need to compare |option_index_|.
    return has_argv0_ == other.has_argv0_ && argv0_ == other.argv0_ &&
           options_ == other.options_ &&
           positional_args_ == other.positional_args_;
  }

options()

const std::vector< Option > & fml::CommandLine::options ( ) const

inline

Definition at line 95 of file command_line.h.

{ return options_; }

positional_args()

const std::vector< std::string > & fml::CommandLine::positional_args ( ) const

inline

Definition at line 96 of file command_line.h.

                                                      {
    return positional_args_;
  }

---

The documentation for this class was generated from the following files:

• fml/command_line.h
• fml/command_line.cc