#include <grpc/support/port_platform.h>
#include <string>

Include dependency graph for cmdline.h:

This graph shows which files directly or indirectly include this file:

Typedefs
typedef struct gpr_cmdline	gpr_cmdline

Functions
void	gpr_cmdline_add_flag (gpr_cmdline cl, const char name, const char help, int value)

void	gpr_cmdline_add_int (gpr_cmdline cl, const char name, const char help, int value)

void	gpr_cmdline_add_string (gpr_cmdline cl, const char name, const char help, const char *value)

gpr_cmdline *	gpr_cmdline_create (const char *description)

void	gpr_cmdline_destroy (gpr_cmdline *cl)

void	gpr_cmdline_on_extra_arg (gpr_cmdline cl, const char name, const char help, void(on_extra_arg)(void user_data, const char arg), void *user_data)

int	gpr_cmdline_parse (gpr_cmdline cl, int argc, char *argv)

void	gpr_cmdline_set_survive_failure (gpr_cmdline *cl)

std::string	gpr_cmdline_usage_string (gpr_cmdline cl, const char argv0)

Typedef Documentation

◆ gpr_cmdline

typedef struct gpr_cmdline gpr_cmdline

Simple command line parser.

Supports flags that can be specified as -foo, –foo, –no-foo, -no-foo, etc And integers, strings that can be specified as -foo=4, -foo blah, etc

No support for short command line options (but we may get that in the future.)

Usage (for a program with a single flag argument 'foo'):

int main(int argc, char **argv) { gpr_cmdline *cl; int verbose = 0;

cl = gpr_cmdline_create("My cool tool"); gpr_cmdline_add_int(cl, "verbose", "Produce verbose output?", &verbose); gpr_cmdline_parse(cl, argc, argv); gpr_cmdline_destroy(cl);

if (verbose) { gpr_log(GPR_INFO, "Goodbye cruel world!"); }

return 0; }

Definition at line 52 of file cmdline.h.

Function Documentation

◆ gpr_cmdline_add_flag()

void gpr_cmdline_add_flag	(	gpr_cmdline *	cl,
		const char *	name,
		const char *	help,
		int *	value
	)

The same, for a boolean flag

Definition at line 110 of file cmdline.cc.

◆ gpr_cmdline_add_int()

void gpr_cmdline_add_int	(	gpr_cmdline *	cl,
		const char *	name,
		const char *	help,
		int *	value
	)

Add an integer parameter, with a name (used on the command line) and some helpful text (used in the command usage)

Definition at line 105 of file cmdline.cc.

◆ gpr_cmdline_add_string()

void gpr_cmdline_add_string	(	gpr_cmdline *	cl,
		const char *	name,
		const char *	help,
		const char **	value
	)

And for a string

Definition at line 115 of file cmdline.cc.

◆ gpr_cmdline_create()

gpr_cmdline* gpr_cmdline_create ( const char * description )

Construct a command line parser: takes a short description of the tool doing the parsing

Definition at line 66 of file cmdline.cc.

◆ gpr_cmdline_destroy()

void gpr_cmdline_destroy ( gpr_cmdline * cl )

Destroy the parser

Definition at line 79 of file cmdline.cc.

◆ gpr_cmdline_on_extra_arg()

void gpr_cmdline_on_extra_arg	(	gpr_cmdline *	cl,
		const char *	name,
		const char *	help,
		void()(void user_data, const char *arg)	on_extra_arg,
		void *	user_data
	)

Set a callback for non-named arguments

Definition at line 120 of file cmdline.cc.

◆ gpr_cmdline_parse()

int gpr_cmdline_parse	(	gpr_cmdline *	cl,
		int	argc,
		char **	argv
	)

Parse the command line; returns 1 on success, on failure either dies (by default) or returns 0 if gpr_cmdline_set_survive_failure() has been called

Definition at line 309 of file cmdline.cc.

◆ gpr_cmdline_set_survive_failure()

void gpr_cmdline_set_survive_failure ( gpr_cmdline * cl )

Enable surviving failure: default behavior is to exit the process

Definition at line 75 of file cmdline.cc.

◆ gpr_cmdline_usage_string()

std::string gpr_cmdline_usage_string	(	gpr_cmdline *	cl,
		const char *	argv0
	)

Get a string describing usage

Definition at line 151 of file cmdline.cc.

Typedefs

Functions