cmdline.cc File Reference

#include "test/core/util/cmdline.h"
#include <limits.h>
#include <stdio.h>
#include <string.h>
#include <vector>
#include "absl/strings/str_cat.h"
#include "absl/strings/str_format.h"
#include "absl/strings/str_join.h"
#include <grpc/support/alloc.h>
#include <grpc/support/log.h>
#include <grpc/support/string_util.h>
#include "src/core/lib/gprpp/memory.h"

Include dependency graph for cmdline.cc:

Go to the source code of this file.

Classes
struct	arg
struct	gpr_cmdline

Typedefs
typedef struct arg	arg

Enumerations
enum	argtype { ARGTYPE_INT, ARGTYPE_BOOL, ARGTYPE_STRING }

Functions
static void	add_arg (gpr_cmdline *cl, const char *name, const char *help, argtype type, void *value)
static void	add_args_to_usage (arg *a, std::vector< std::string > *s)
static int	extra_state (gpr_cmdline *cl, char *str)
static arg *	find_arg (gpr_cmdline *cl, char *name)
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)
static int	normal_state (gpr_cmdline *cl, char *str)
static int	print_usage_and_die (gpr_cmdline *cl)
static int	value_state (gpr_cmdline *cl, char *str)

Typedef Documentation

arg

typedef struct arg arg

Enumeration Type Documentation

argtype

enum argtype

Enumerator
ARGTYPE_INT
ARGTYPE_BOOL
ARGTYPE_STRING

Definition at line 38 of file cmdline.cc.

Function Documentation

add_arg()

static void add_arg ( gpr_cmdline *  cl, const char *  name, const char *  help, argtype  type, void *  value  )

static

Definition at line 88 of file cmdline.cc.

add_args_to_usage()

static void add_args_to_usage ( arg *  a, std::vector< std::string > *  s  )

static

Definition at line 135 of file cmdline.cc.

extra_state()

static int extra_state ( gpr_cmdline *  cl, char *  str  )

static

Definition at line 177 of file cmdline.cc.

find_arg()

static arg* find_arg ( gpr_cmdline *  cl, char *  name  )

static

Definition at line 185 of file cmdline.cc.

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.

normal_state()

static int normal_state ( gpr_cmdline *  cl, char *  str  )

static

Definition at line 238 of file cmdline.cc.

print_usage_and_die()

static int print_usage_and_die ( gpr_cmdline *  cl )

static

Definition at line 169 of file cmdline.cc.

value_state()

static int value_state ( gpr_cmdline *  cl, char *  str  )

static

Definition at line 202 of file cmdline.cc.