le_args.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
#ifndef LEGATO_ARGS_INCLUDE_GUARD
#define LEGATO_ARGS_INCLUDE_GUARD


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
const char* le_arg_GetProgramName
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
size_t le_arg_NumArgs
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
const char* le_arg_GetArg
(
    size_t  argIndex    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_arg_GetFlagOption
(
    const char* shortName,  
    const char* longName    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_arg_GetIntOption
(
    int* varPtr,            
    const char* shortName,  
    const char* longName    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_arg_GetStringOption
(
    const char** varPtr,    
    const char* shortName,  
    const char* longName    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_SetFlagVar
(
    bool* varPtr,           
    const char* shortName,  
    const char* longName    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_SetIntVar
(
    int* varPtr,            
    const char* shortName,  
    const char* longName    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_SetStringVar
(
    const char** varPtr,    
    const char* shortName,  
    const char* longName    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_arg_FlagCallbackFunc_t)(void);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_SetFlagCallback
(
    le_arg_FlagCallbackFunc_t func, 
    const char* shortName,          
    const char* longName           
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_arg_IntCallbackFunc_t)
(
    int value   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_SetIntCallback
(
    le_arg_IntCallbackFunc_t func,  
    const char* shortName,          
    const char* longName            
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef void (*le_arg_StringCallbackFunc_t)
(
    const char* value   
);

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_SetStringCallback
(
    le_arg_StringCallbackFunc_t func,
    const char* shortName,           
    const char* longName             
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_AddPositionalCallback
(
    le_arg_StringCallbackFunc_t func    
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_AllowMorePositionalArgsThanCallbacks
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_AllowLessPositionalArgsThanCallbacks
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef size_t (*le_arg_ErrorHandlerFunc_t)
(
    size_t  argIndex,       
    le_result_t errorCode   
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_SetErrorHandler
(
    le_arg_ErrorHandlerFunc_t errorHandlerFunc  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_Scan
(
    void
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_arg_SetArgs
(
    const size_t    argc,   
    char**          argv    
);


#endif // LEGATO_ARGS_INCLUDE_GUARD