subcommand.hpp

Go to the documentation of this file.

// Copyright (c) 2015-2022 Clearmatics Technologies Ltd
//
// SPDX-License-Identifier: LGPL-3.0+
 
#ifndef __ZETH_LIBTOOL_SUBCOMMAND_HPP__
#define __ZETH_LIBTOOL_SUBCOMMAND_HPP__
 
#include <boost/program_options.hpp>
#include <map>
#include <string>
 
namespace po = boost::program_options;
 
namespace libtool
{
 
template<typename GlobalOptionsT> class subcommand
{
public:
    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);
 
protected:
    void usage(
        const char *argv0,
        const boost::program_options::options_description &options);
 
    virtual void initialize_suboptions(
        boost::program_options::options_description &options,
        boost::program_options::options_description &all_options,
        boost::program_options::positional_options_description &pos) = 0;
 
    virtual void parse_suboptions(
        const boost::program_options::variables_map &vm) = 0;
 
    virtual void subcommand_usage(const char *argv0) = 0;
 
    virtual int execute_subcommand(const GlobalOptionsT &global) = 0;
 
    std::string subcommand_name;
    std::string subcommand_description;
};
 
} // namespace libtool
 
#include "libtool/subcommand.tcc"
 
#endif // __ZETH_LIBTOOL_SUBCOMMAND_HPP__