cmdline.c File Reference

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <getopt.h>
#include "cmdline.h"

Include dependency graph for cmdline.c:

Macros
#define	FIX_UNUSED(X)   (void) (X) /* avoid warnings for unused params */

Enumerations
enum	cmdline_parser_arg_type {   ARG_NO , ARG_FLAG , ARG_STRING , ARG_INT ,   ARG_NO , ARG_FLAG , ARG_STRING , ARG_INT ,   ARG_NO , ARG_FLAG , ARG_STRING , ARG_INT }

Functions
void	cmdline_parser_print_version (void)
void	cmdline_parser_print_help (void)
void	cmdline_parser_init (struct gengetopt_args_info *args_info)
void	cmdline_parser_params_init (struct cmdline_parser_params *params)
struct cmdline_parser_params *	cmdline_parser_params_create (void)
int	cmdline_parser_dump (FILE *outfile, struct gengetopt_args_info *args_info)
int	cmdline_parser_file_save (const char *filename, struct gengetopt_args_info *args_info)
void	cmdline_parser_free (struct gengetopt_args_info *args_info)
int	cmdline_parser (int argc, char **argv, struct gengetopt_args_info *args_info)
int	cmdline_parser_ext (int argc, char **argv, struct gengetopt_args_info *args_info, struct cmdline_parser_params *params)
int	cmdline_parser2 (int argc, char **argv, struct gengetopt_args_info *args_info, int override, int initialize, int check_required)
int	cmdline_parser_required (struct gengetopt_args_info *args_info, const char *prog_name)

Variables
const char *	gengetopt_args_info_purpose = ""
	the purpose string of the program
const char *	gengetopt_args_info_usage = "Usage: janus [OPTION]..."
	the usage string of the program
const char *	gengetopt_args_info_versiontext = ""
const char *	gengetopt_args_info_description = ""
	the description string of the program
const char *	gengetopt_args_info_help []
	all the lines making the help output

Macro Definition Documentation

FIX_UNUSED

#define FIX_UNUSED

(

X

)

(void) (X) /* avoid warnings for unused params */

Enumeration Type Documentation

cmdline_parser_arg_type

enum cmdline_parser_arg_type

Enumerator
ARG_NO
ARG_FLAG
ARG_STRING
ARG_INT
ARG_NO
ARG_FLAG
ARG_STRING
ARG_INT
ARG_NO
ARG_FLAG
ARG_STRING
ARG_INT

Function Documentation

cmdline_parser()

int cmdline_parser	(	int	argc,
		char **	argv,
		struct gengetopt_args_info *	args_info
	)

The command line parser

Parameters

argc	the number of command line options
argv	the command line options
args_info	the structure where option information will be stored

Returns

0 if everything went fine, NON 0 if an error took place

cmdline_parser2()

int cmdline_parser2	(	int	argc,
		char **	argv,
		struct gengetopt_args_info *	args_info,
		int	override,
		int	initialize,
		int	check_required
	)

The command line parser (version with additional parameters - deprecated)

Parameters

argc	the number of command line options
argv	the command line options
args_info	the structure where option information will be stored
override	whether to override possibly already present options
initialize	whether to initialize the option structure my_args_info
check_required	whether to check that all required options were provided

Returns

0 if everything went fine, NON 0 if an error took place

cmdline_parser_dump()

int cmdline_parser_dump	(	FILE *	outfile,
		struct gengetopt_args_info *	args_info
	)

Save the contents of the option struct into an already open FILE stream.

Parameters

outfile	the stream where to dump options
args_info	the option struct to dump

Returns

0 if everything went fine, NON 0 if an error took place

cmdline_parser_ext()

int cmdline_parser_ext	(	int	argc,
		char **	argv,
		struct gengetopt_args_info *	args_info,
		struct cmdline_parser_params *	params
	)

The command line parser (version with additional parameters)

Parameters

argc	the number of command line options
argv	the command line options
args_info	the structure where option information will be stored
params	additional parameters for the parser

Returns

0 if everything went fine, NON 0 if an error took place

cmdline_parser_file_save()

int cmdline_parser_file_save	(	const char *	filename,
		struct gengetopt_args_info *	args_info
	)

Save the contents of the option struct into a (text) file. This file can be read by the config file parser (if generated by gengetopt)

Parameters

filename	the file where to save
args_info	the option struct to save

Returns

0 if everything went fine, NON 0 if an error took place

cmdline_parser_free()

void cmdline_parser_free

(

struct gengetopt_args_info *

args_info

)

Deallocates the string fields of the gengetopt_args_info structure (but does not deallocate the structure itself)

Parameters

args_info

the structure to deallocate

cmdline_parser_init()

void cmdline_parser_init

(

struct gengetopt_args_info *

args_info

)

Initializes the passed gengetopt_args_info structure's fields (also set default values for options that have a default)

Parameters

args_info

the structure to initialize

cmdline_parser_params_create()

struct cmdline_parser_params * cmdline_parser_params_create

(

void

)

Allocates dynamically a cmdline_parser_params structure and initializes all its fields to their default values

Returns

the created and initialized cmdline_parser_params structure

cmdline_parser_params_init()

void cmdline_parser_params_init

(

struct cmdline_parser_params *

params

)

Initializes all the fields a cmdline_parser_params structure to their default values

Parameters

params

the structure to initialize

cmdline_parser_print_help()

void cmdline_parser_print_help

(

void

)

Print the help

cmdline_parser_print_version()

void cmdline_parser_print_version

(

void

)

Print the version

cmdline_parser_required()

int cmdline_parser_required	(	struct gengetopt_args_info *	args_info,
		const char *	prog_name
	)

Checks that all the required options were specified

Parameters

args_info	the structure to check
prog_name	the name of the program that will be used to print possible errors

Returns

Variable Documentation

gengetopt_args_info_description

const char* gengetopt_args_info_description = ""

the description string of the program

gengetopt_args_info_help

const char* gengetopt_args_info_help[]

all the lines making the help output

gengetopt_args_info_purpose

const char* gengetopt_args_info_purpose = ""

the purpose string of the program

gengetopt_args_info_usage

const char* gengetopt_args_info_usage = "Usage: janus [OPTION]..."

the usage string of the program

gengetopt_args_info_versiontext

const char* gengetopt_args_info_versiontext = ""