zethtool::generic_subcommand< CommandT > Class Template Reference

#include <tool_common.hpp>

Inheritance diagram for zethtool::generic_subcommand< CommandT >:

Collaboration diagram for zethtool::generic_subcommand< CommandT >:

Classes
class	this_caller

Public Member Functions
	generic_subcommand (const std::string &subcommand_name, const std::string &description)
Public Member Functions inherited from libtool::subcommand< GlobalOptionsT >
	subcommand (const std::string &subcommand_name, const std::string &description)
virtual	~subcommand ()
const std::string &	description () const
int	execute (const char *argv0, const std::vector< std::string > command_args, const GlobalOptionsT &global)
	Common code to parse options and invoke the virtual execute entrypoint. More...

Protected Member Functions
void	initialize_suboptions (boost::program_options::options_description &options, boost::program_options::options_description &, boost::program_options::positional_options_description &) override
	Instantiation can now set up the boost program_options structures. More...
void	parse_suboptions (const boost::program_options::variables_map &vm) override
int	execute_subcommand (const global_options &options) override
Protected Member Functions inherited from libtool::subcommand< GlobalOptionsT >
void	usage (const char *argv0, const boost::program_options::options_description &options)
virtual void	subcommand_usage (const char *argv0)=0
	Any command-specific output for usage. More...
virtual int	execute_subcommand (const GlobalOptionsT &global)=0
	Execute the command using global options defined by the caller. More...

Protected Attributes
std::string	curve
std::string	snark
Protected Attributes inherited from libtool::subcommand< GlobalOptionsT >
std::string	subcommand_name
std::string	subcommand_description

Detailed Description

template<class CommandT>
class zethtool::generic_subcommand< CommandT >

Base class of subcommands with entry points generic over curve and snark. Implementations are expected to implement a public generic execute_generic method of the form:

class my_cmd : generic_subcommand_base<my_cmd> { public: template<typename ppT, typename snarkT> int execute_generic( const global_options &) { ... } }

along side the usual parsing entry points initialize_suboptions and parse_suboptions, which MUST call the equivalent methods on this base class.

Definition at line 87 of file tool_common.hpp.

Constructor & Destructor Documentation

generic_subcommand()

template<class CommandT >

zethtool::generic_subcommand< CommandT >::generic_subcommand ( const std::string &  subcommand_name, const std::string &  description  )

inline

Definition at line 90 of file tool_common.hpp.

        : zeth_subcommand(subcommand_name, description)
    {
    }

Member Function Documentation

execute_subcommand()

template<class CommandT >

int zethtool::generic_subcommand< CommandT >::execute_subcommand ( const global_options &  options )

inlineoverrideprotected

Definition at line 118 of file tool_common.hpp.

    {
        return curve_and_snark_resolver<this_caller>::resolve(
            curve, snark, this, options);
    }

initialize_suboptions()

template<class CommandT >

void zethtool::generic_subcommand< CommandT >::initialize_suboptions ( boost::program_options::options_description &  options, boost::program_options::options_description &  all_options, boost::program_options::positional_options_description &  pos  )

inlineoverrideprotectedvirtual

Instantiation can now set up the boost program_options structures.

Implements libtool::subcommand< GlobalOptionsT >.

Definition at line 97 of file tool_common.hpp.

    {
        // Options
        options.add_options()(
            "curve,c",
            po::value<std::string>(),
            "Curve: alt-bn128, bls12-377 or bw6-761");
        options.add_options()(
            "snark,s", po::value<std::string>(), "Snark: groth16 or pghr13");
    }

parse_suboptions()

template<class CommandT >

void zethtool::generic_subcommand< CommandT >::parse_suboptions ( const boost::program_options::variables_map &  vm )

inlineoverrideprotectedvirtual

Instantiation can record any command-specific information from the parsed variables_map.

Implements libtool::subcommand< GlobalOptionsT >.

Definition at line 111 of file tool_common.hpp.

    {
        curve = vm.count("curve") ? vm["curve"].as<std::string>() : "alt-bn128";
        snark = vm.count("snark") ? vm["snark"].as<std::string>() : "groth16";
    }

Member Data Documentation

curve

template<class CommandT >

std::string zethtool::generic_subcommand< CommandT >::curve

protected

Definition at line 135 of file tool_common.hpp.

snark

template<class CommandT >

std::string zethtool::generic_subcommand< CommandT >::snark

protected

Definition at line 136 of file tool_common.hpp.

---

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

• /home/runner/work/zeth/zeth/zeth_tool/tool_common.hpp