tim::argparse::argument_vector Struct Reference

This class exists to simplify creating argument arrays compatible with execv* routines and MPI_Comm_spawn/MPI_Comm_spawn_multiple. More...

#include "timemory/utility/argparse.hpp"

Collaboration diagram for tim::argparse::argument_vector:

Classes
struct	c_args

Public Types
using	base_type = std::vector< std::string >
using	cargs_t = c_args

Public Member Functions
template<typename... Args>
	argument_vector (Args &&... args)
	argument_vector (int &argc, char **&argv)
	argument_vector (int &argc, const char **&argv)
	argument_vector (int &argc, const char *const *&argv)
cargs_t	get_execv (const base_type &_prepend, size_t _beg=0, size_t _end=std::numeric_limits< size_t >::max()) const
cargs_t	get_execv (size_t _beg=0, size_t _end=std::numeric_limits< size_t >::max()) const

Static Public Member Functions
static void	free_execv (cargs_t &itr)

Detailed Description

This class exists to simplify creating argument arrays compatible with execv* routines and MPI_Comm_spawn/MPI_Comm_spawn_multiple.

Definition at line 269 of file argparse.hpp.

Member Typedef Documentation

base_type

using tim::argparse::argument_vector::base_type = std::vector<std::string>

Definition at line 296 of file argparse.hpp.

cargs_t

using tim::argparse::argument_vector::cargs_t = c_args

Definition at line 297 of file argparse.hpp.

Constructor & Destructor Documentation

argument_vector() [1/4]

template<typename... Args>

tim::argparse::argument_vector::argument_vector ( Args &&...  args )

inline

Definition at line 300 of file argparse.hpp.

    : base_type(std::forward<Args>(args)...)
    {}

argument_vector() [2/4]

TIMEMORY_UTILITY_INLINE tim::argparse::argument_vector::argument_vector ( int &  argc, char **&  argv  )

explicit

Definition at line 39 of file argparse.cpp.

: base_type()
{
    reserve(argc);
    for(int i = 0; i < argc; ++i)
        push_back(argv[i]);
}

References tim::argv.

argument_vector() [3/4]

TIMEMORY_UTILITY_INLINE tim::argparse::argument_vector::argument_vector ( int &  argc, const char **&  argv  )

explicit

Definition at line 48 of file argparse.cpp.

: base_type()
{
    reserve(argc);
    for(int i = 0; i < argc; ++i)
        push_back(argv[i]);
}

References tim::argv.

argument_vector() [4/4]

TIMEMORY_UTILITY_INLINE tim::argparse::argument_vector::argument_vector ( int &  argc, const char *const *&  argv  )

explicit

Definition at line 57 of file argparse.cpp.

{
    reserve(argc);
    for(int i = 0; i < argc; ++i)
        push_back(argv[i]);
}

References tim::argv.

Member Function Documentation

free_execv()

static void tim::argparse::argument_vector::free_execv ( cargs_t &  itr )

inlinestatic

Definition at line 314 of file argparse.hpp.

{ itr.clear(); }

References tim::argparse::argument_vector::c_args::clear().

get_execv() [1/2]

TIMEMORY_UTILITY_INLINE argument_vector::cargs_t tim::argparse::argument_vector::get_execv	(	const base_type &	_prepend,
		size_t	_beg = 0,
		size_t	_end = std::numeric_limits<size_t>::max()
	)		const

Definition at line 65 of file argparse.cpp.

{
    std::stringstream cmdss;
    // find the end if not specified
    _end = std::min<size_t>(size(), _end);
    // determine the number of arguments
    auto _argc = (_end - _beg) + _prepend.size();
    // create the new C argument array, add an extra entry at the end which will
    // always be a null pointer because that is how execv determines the end
    char** _argv = new char*[_argc + 1];
 
    // ensure all arguments are null pointers initially
    for(size_t i = 0; i < _argc + 1; ++i)
        _argv[i] = nullptr;
 
    // add the prepend list
    size_t _idx = 0;
    for(const auto& itr : _prepend)
        _argv[_idx++] = helpers::strdup(itr.c_str());
 
    // copy over the arguments stored internally from the range specified
    for(auto i = _beg; i < _end; ++i)
        _argv[_idx++] = helpers::strdup(this->at(i).c_str());
 
    // add check that last argument really is a nullptr
    assert(_argv[_argc] == nullptr);
 
    // create the command string
    for(size_t i = 0; i < _argc; ++i)
        cmdss << " " << _argv[i];
    auto cmd = cmdss.str().substr(1);
 
    // return a new (int argc, char** argv) and subtract 1 bc nullptr in last entry
    // does not count as argc
    return cargs_t(_argc - 1, _argv, cmd);
}

References tim::at(), tim::plotting::cmd, and strdup().

Referenced by get_execv().

get_execv() [2/2]

TIMEMORY_UTILITY_INLINE argument_vector::cargs_t tim::argparse::argument_vector::get_execv	(	size_t	_beg = 0,
		size_t	_end = std::numeric_limits<size_t>::max()
	)		const

Definition at line 103 of file argparse.cpp.

{
    return get_execv(base_type{}, _beg, _end);
}

References get_execv().

---

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

• timemory/utility/argparse.hpp
• timemory/utility/argparse.cpp