include/pelib/argument_parsing.hpp File Reference

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

Go to the source code of this file.

Classes
struct	pelib_argument_stream
Typedefs
typedef struct pelib_argument_stream	pelib_argument_stream_t
Enumerations
enum	stream {   STREAM_NOTHING, STREAM_STDIN, STREAM_STDOUT, STREAM_STDERR,   STREAM_FILE }
Functions
void	pelib_argument_stream_init (pelib_argument_stream_t *pelib_argument_stream)
void	pelib_argument_stream_destroy (const pelib_argument_stream_t pelib_argument_stream)
unsigned int	pelib_argument_stream_parse (char **argv, pelib_argument_stream_t *stream)

---

Typedef Documentation

typedef struct pelib_argument_stream pelib_argument_stream_t

Spaceless type alias for struct pelib_argument_stream

Definition at line 37 of file argument_parsing.hpp.

---

Enumeration Type Documentation

enum stream

Enumerator:

STREAM_NOTHING
STREAM_STDIN
STREAM_STDOUT
STREAM_STDERR
STREAM_FILE

Definition at line 24 of file argument_parsing.hpp.

---

Function Documentation

void pelib_argument_stream_destroy

(

const pelib_argument_stream_t

pelib_argument_stream

)

Frees all memory that pointers in an instance of pelib argument stram structure points to

Definition at line 50 of file argument_parsing.cpp.

void pelib_argument_stream_init

(

pelib_argument_stream_t *

pelib_argument_stream

)

Give defaults values to an instance of pelib argument data structure

Definition at line 38 of file argument_parsing.cpp.

unsigned int pelib_argument_stream_parse	(	char **	argv,
		pelib_argument_stream_t *	stream
	)

Performs parsing operations stores data gather in a pelib_argument stream instance

Parameters:

argv	Array of strings containing all data to be parsed. Its last element must be a NULL pointer.
stream	Instance of pelib argument_stream that holds the data being parsed

Definition at line 99 of file argument_parsing.cpp.