framework/c/inc/le_pathIter.h

Go to the documentation of this file.

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------

#ifndef LEGATO_PATH_ITER_INCLUDE_GUARD
#define LEGATO_PATH_ITER_INCLUDE_GUARD


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef struct le_pathIter_t* le_pathIter_Ref_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_pathIter_Ref_t le_pathIter_Create
(
    const char* pathPtr,        
    const char* separatorPtr,   

    const char* parentSpecPtr,  


    const char* currentSpecPtr  

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_pathIter_Ref_t le_pathIter_CreateForUnix
(
    const char* pathPtr  

);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_pathIter_Ref_t le_pathIter_Clone
(
    le_pathIter_Ref_t originalRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_pathIter_Delete
(
    le_pathIter_Ref_t iterRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pathIter_GetSeparator
(
    le_pathIter_Ref_t iterRef,  
    char* bufferPtr,            
    size_t bufferSize           
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pathIter_GetParentSpecifier
(
    le_pathIter_Ref_t iterRef,  
    char* bufferPtr,            
    size_t bufferSize           
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pathIter_GetCurrentSpecifier
(
    le_pathIter_Ref_t iterRef,  
    char* bufferPtr,            
    size_t bufferSize           
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pathIter_GetPath
(
    le_pathIter_Ref_t iterRef,  
    char* bufferPtr,            
    size_t bufferSize           
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pathIter_GoToStart
(
    le_pathIter_Ref_t iterRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pathIter_GoToEnd
(
    le_pathIter_Ref_t iterRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pathIter_GoToNext
(
    le_pathIter_Ref_t iterRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pathIter_GoToPrev
(
    le_pathIter_Ref_t iterRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pathIter_GetCurrentNode
(
    le_pathIter_Ref_t iterRef,  
    char* bufferPtr,            
    size_t bufferSize           
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
void le_pathIter_Truncate
(
    le_pathIter_Ref_t iterRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
le_result_t le_pathIter_Append
(
    le_pathIter_Ref_t iterRef,  
    const char* pathStr         
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_pathIter_IsAbsolute
(
    le_pathIter_Ref_t iterRef  
);


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
bool le_pathIter_IsEmpty
(
    le_pathIter_Ref_t iterRef  
);


#endif  // LEGATO_PATH_ITER_INCLUDE_GUARD