M3::MaCh3ArgumentParser Class Reference

Extended ArgumentParser with MaCh3-specific functionality. More...

#include <CLI/API/m3argparse.hpp>

Inheritance diagram for M3::MaCh3ArgumentParser:

Collaboration diagram for M3::MaCh3ArgumentParser:

Public Member Functions
virtual	~MaCh3ArgumentParser ()=default
const std::string	name () const
	Get the name of this parser/subcommand. More...
const std::list< std::reference_wrapper< ArgumentParser > > &	subparsers () const
	Get the list of registered subparsers. More...
const MaCh3ArgumentParser &	get_subcommand_used () const
	Get the subcommand that was used in parsing. More...
std::vector< std::string >	get_long_option_names () const
	Return all long option names (–xxx) registered with this parser. More...
bool	option_takes_value (const std::string &name) const
	Return true if the named option expects a value (not a flag) More...

Detailed Description

Extended ArgumentParser with MaCh3-specific functionality.

This class extends the standard ArgumentParser to provide additional methods for accessing parser name, subparsers, and tracking which subcommand was used.

Definition at line 17 of file m3argparse.hpp.

Constructor & Destructor Documentation

~MaCh3ArgumentParser()

virtual M3::MaCh3ArgumentParser::~MaCh3ArgumentParser ( )

virtualdefault

Member Function Documentation

get_long_option_names()

std::vector<std::string> M3::MaCh3ArgumentParser::get_long_option_names ( ) const

inline

Return all long option names (–xxx) registered with this parser.

Definition at line 50 of file m3argparse.hpp.

                                                               {
                std::vector<std::string> names;
                for (const auto& [name, _] : this->m_argument_map) {
                    if (name.size() >= 2 && name[0] == '-' && name[1] == '-')
                        names.push_back(name);
                }
                return names;
            }

get_subcommand_used()

const MaCh3ArgumentParser& M3::MaCh3ArgumentParser::get_subcommand_used ( ) const

inline

Get the subcommand that was used in parsing.

Recursively traverses the subparser hierarchy to find the deepest subcommand that was actually invoked.

Returns

Reference to the MaCh3ArgumentParser of the used subcommand

Definition at line 40 of file m3argparse.hpp.

                                                                  {
                for (const std::reference_wrapper<ArgumentParser>& subparser : this->m_subparsers) {
                    if (this->is_subcommand_used(subparser.get())) {
                        return static_cast<MaCh3ArgumentParser*>(&(subparser.get()))->get_subcommand_used();
                    }
                }
                return (*this);
            }

name()

const std::string M3::MaCh3ArgumentParser::name ( ) const

inline

Get the name of this parser/subcommand.

Returns

The program or subcommand name

Definition at line 24 of file m3argparse.hpp.

                                        {
                return this->m_program_name;
            }

option_takes_value()

bool M3::MaCh3ArgumentParser::option_takes_value ( const std::string &  name ) const

inline

Return true if the named option expects a value (not a flag)

Definition at line 60 of file m3argparse.hpp.

                                                                 {
                auto it = this->m_argument_map.find(name);
                if (it == this->m_argument_map.end()) return false;
                // get_usage_full() appends a metavar when max nargs > 0
                return it->second->get_usage_full().find(' ') != std::string::npos;
            }

subparsers()

const std::list<std::reference_wrapper<ArgumentParser> >& M3::MaCh3ArgumentParser::subparsers ( ) const

inline

Get the list of registered subparsers.

Returns

Reference to the list of subparsers

Definition at line 30 of file m3argparse.hpp.

                                                                                   {
                return this->m_subparsers;
            }

---

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

• CLI/API/m3argparse.hpp