option.h File Reference

Basic functions for Option operation. More...

#include <stdbool.h>

Include dependency graph for option.h:

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

Go to the source code of this file.

Classes
struct	opt
	Option Struct. More...

Typedefs
typedef struct opt	Option
	Option Struct. More...

Functions
Option *	create_Option (char *opt_name, int args_len, bool(*handle_func)(const Option *))
	Create a ParseData pointer, need to be deleted before exit execution. More...
void	delete_Option (Option *opt)
	Delete a Option pointer from create_Option(). More...
void	delete_Option_array (Option **opt, int opt_len)
	Delete a Option pointer array. More...
void	show_opt (const Option *opt)
	Print Option. More...

Detailed Description

Basic functions for Option operation.

Typedef Documentation

Option

typedef struct opt Option

Option Struct.

Parameters

opt_name	option name.
args_len	args length.
args	char pointer arrary. It contains arguments.
found	initialize to false. Set to true if the option is found.
handle_func	pointer of option handler.

Function Documentation

create_Option()

Option* create_Option	(	char *	opt_name,
		int	args_len,
		bool(*)(const Option *)	handle_func
	)

Create a ParseData pointer, need to be deleted before exit execution.

Parameters

opt_name	is the name of option.
args_len	is the expected length of arguments. -1 means the option will accept
func_ptr	pointer of option handler (option handler should be a function). all arguments after it.

Returns

return Option pointer.

delete_Option()

void delete_Option

(

Option *

opt

)

Delete a Option pointer from create_Option().

Parameters

opt	is a Option pointer.

delete_Option_array()

void delete_Option_array	(	Option **	opt,
		int	opt_len
	)

Delete a Option pointer array.

Parameters

opt	is a Option pointer array.
opt_len	is the length of Option pointer array.

show_opt()

void show_opt

(

const Option *

opt

)

Print Option.

Parameters

opt	is a Option pointer