/usr/include/dballe/cmdline/cmdline.h is in libdballe-dev 7.7-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 | #ifndef DBALLE_CMDLINE_CMDLINE_H
#define DBALLE_CMDLINE_CMDLINE_H
/** @file
* @ingroup dballe
* Common functions for commandline tools
*/
#include <wreport/error.h>
#include <dballe/file.h>
#include <popt.h>
#include <memory>
#include <vector>
#include <list>
#include <string>
namespace dballe {
struct Record;
struct Query;
namespace core {
struct Query;
}
namespace cmdline {
struct Subcommand
{
std::vector<std::string> names;
std::string usage;
std::string desc;
std::string longdesc;
int op_verbose;
virtual ~Subcommand() {}
virtual void add_to_optable(std::vector<poptOption>& opts) const;
/// Optional initialization before main is called
virtual void init();
virtual int main(poptContext) = 0;
/**
* Create a popt context for this subcommand.
*
* Options are appended to opts, which is generally passed empty. Its
* memory needs to be owned by the caller, because the resulting
* poptContext will refer to data inside it, so the lifetime of the vector
* should be at least as long as the lifetime of the resulting poptContext.
*/
poptContext make_popt_context(int argc, const char* argv[], std::vector<poptOption>& opts) const;
void manpage_print_options(FILE* out);
};
#define ODT_END { NULL, NULL, NULL, NULL, NULL, NULL }
struct Command
{
std::string name;
std::string desc;
std::string longdesc;
std::string manpage_examples_section;
std::string manpage_files_section;
std::string manpage_seealso_section;
std::vector<Subcommand*> ops;
~Command();
/// Add an action to this tool, taking ownership of its memory management
void add_subcommand(Subcommand* action);
void add_subcommand(std::unique_ptr<Subcommand>&& action);
Subcommand* find_action(const std::string& name) const;
void usage(const std::string& selfpath, FILE* out) const;
void manpage(FILE* out) const;
/// Process commandline arguments and perform the action requested
int main(int argc, const char* argv[]);
};
/// Report an error with command line options
struct error_cmdline : public std::exception
{
std::string msg; ///< error message returned by what()
/// @param msg error message
error_cmdline(const std::string& msg) : msg(msg) {}
~error_cmdline() throw () {}
virtual const char* what() const throw () { return msg.c_str(); }
/// Throw the exception, building the message printf-style
static void throwf(const char* fmt, ...) WREPORT_THROWF_ATTRS(1, 2);
};
/**
* Print informations about the last error to stderr
*/
void dba_cmdline_print_dba_error();
/**
* Print an error that happened when parsing commandline arguments, then add
* usage informations and exit
*/
void dba_cmdline_error(poptContext optCon, const char* fmt, ...) __attribute__ ((noreturn));
/**
* Return the ::dba_encoding that corresponds to the name in the string
*/
File::Encoding string_to_encoding(const char* type);
/**
* Get a DB-ALLe query from commandline parameters in the form key=value
*
* @return the number of key=value pairs found
*/
unsigned dba_cmdline_get_query(poptContext optCon, Query& query);
/**
* List available output templates
*/
void list_templates();
/// Read all the command line arguments and return them as a list
std::list<std::string> get_filenames(poptContext optCon);
}
}
#endif
|