CLISH  0.7.3
Typedefs | Functions

This utility provides a simple means of manipulating a vector of command textual words. More...

Typedefs

typedef struct lub_argv_s lub_argv_t
 

Functions

unsigned lub_argv_wordcount (const char *line)
 
lub_argv_tlub_argv_new (const char *line, size_t offset)
 
void lub_argv_delete (lub_argv_t *instance)
 
unsigned lub_argv__get_count (const lub_argv_t *instance)
 
const char * lub_argv__get_arg (const lub_argv_t *instance, unsigned index)
 
size_t lub_argv__get_offset (const lub_argv_t *instance, unsigned index)
 
bool_t lub_argv__get_quoted (const lub_argv_t *instance, unsigned index)
 
void lub_argv__set_arg (lub_argv_t *instance, unsigned index, const char *arg)
 

Detailed Description

This utility provides a simple means of manipulating a vector of command textual words.

A word is either separated by whitespace, or if quotes are used a word is defined by the scope of the quotes.

e.g.

one two "this is the third word" four

contains four "words" the third of which is a string.

Typedef Documentation

typedef struct lub_argv_s lub_argv_t

This type is used to reference an instance of an argument vector

Function Documentation

lub_argv_t* lub_argv_new ( const char *  line,
size_t  offset 
)

This operation is used to construct an instance of this class. The client species a string and an offset within that string, from which to start collecting "words" to place into the vector instance.

Precondition
  • none
Returns
  • A instance of an argument vector, which represents the words contained in the provided string.
  • NULL if there is insuffcient resource
Postcondition
  • The client becomes resposible for releasing the instance when they are finished with it, by calling lub_argv_delete()
Parameters
lineThe string to analyse
offsetThe offset in the string to start from
unsigned lub_argv_wordcount ( const char *  line)
Precondition
  • none
Returns
The number of space separated words in the specified string.
Postcondition
  • none
Parameters
lineThe string to analyse