sbgString.h

Go to the documentation of this file.

 
#ifndef SBG_STRING_H
#define SBG_STRING_H
 
// sbgCommonLib headers
#include <sbgCommon.h>
#include <streamBuffer/sbgStreamBuffer.h>
 
//----------------------------------------------------------------------//
//- Header (open extern C block)                                       -//
//----------------------------------------------------------------------//
 
#ifdef __cplusplus
extern "C" {
#endif
 
//----------------------------------------------------------------------//
//- Constant definitions                                               -//
//----------------------------------------------------------------------//
 
#define SBG_STRING_INTERNAL_BUFFER_MIN_SIZE                 (4)
 
#if SBG_STRING_INTERNAL_BUFFER_MIN_SIZE == 0
#error "invalid minimum internal buffer size"
#endif
 
#define SBG_STRING_INTERNAL_BUFFER_DEFAULT_SIZE             (16)
 
#ifndef SBG_CONFIG_STRING_INTERNAL_BUFFER_SIZE
#define SBG_CONFIG_STRING_INTERNAL_BUFFER_SIZE              SBG_STRING_INTERNAL_BUFFER_DEFAULT_SIZE
#elif SBG_CONFIG_STRING_INTERNAL_BUFFER_SIZE < SBG_STRING_INTERNAL_BUFFER_MIN_SIZE
#error "invalid internal buffer size"
#endif // SBG_CONFIG_STRING_INTERNAL_BUFFER_SIZE
 
//----------------------------------------------------------------------//
//- Structure definitions                                              -//
//----------------------------------------------------------------------//
 
typedef struct _SbgString
{
    char                                 internalBuffer[SBG_CONFIG_STRING_INTERNAL_BUFFER_SIZE];
 
    char                                *pBuffer;                                   
    size_t                               capacity;                                  
    size_t                               length;                                    
    bool                                 readOnly;                                  
    bool                                 isStatic;                                  
    SbgErrorCode                         errorCode;                                 
} SbgString;
 
typedef struct _SbgStringIterator
{
    const char                          *pCursor;                                   
} SbgStringIterator;
 
//----------------------------------------------------------------------//
//- Public functions                                                   -//
//----------------------------------------------------------------------//
 
SBG_COMMON_LIB_API void sbgStringConstructEmpty(SbgString *pString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringConstruct(SbgString *pString, const SbgString *pSourceString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringConstructCString(SbgString *pString, const char *pCString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringConstructVF(SbgString *pString, const char *pFormat, va_list args) SBG_CHECK_FORMAT(printf, 2, 0);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringConstructF(SbgString *pString, const char *pFormat, ...) SBG_CHECK_FORMAT(printf, 2, 3);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringConstructStatic(SbgString *pString, const char *pCString, char *pBuffer, size_t size);
 
SBG_COMMON_LIB_API void sbgStringConstructReadOnly(SbgString *pString, const char *pCString);
 
SBG_COMMON_LIB_API void sbgStringDestroy(SbgString *pString);
 
SBG_COMMON_LIB_API int32_t sbgStringCompare(const SbgString *pString, const SbgString *pOtherString);
 
SBG_COMMON_LIB_API int32_t sbgStringCompareCString(const SbgString *pString, const char *pCString);
 
SBG_COMMON_LIB_API int32_t sbgStringCompareIgnoreCase(const SbgString *pString, const SbgString *pOtherString);
 
SBG_COMMON_LIB_API int32_t sbgStringCompareIgnoreCaseCString(const SbgString *pString, const char *pCString);
 
SBG_COMMON_LIB_API size_t sbgStringHash(const SbgString *pString);
 
SBG_COMMON_LIB_API size_t sbgStringGetLength(const SbgString *pString);
 
SBG_COMMON_LIB_API const char *sbgStringGetCString(const SbgString *pString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringCharAt(const SbgString *pString, size_t index, char *pChar);
 
SBG_COMMON_LIB_API size_t sbgStringFind(const SbgString *pString, const SbgString *pStringToFind);
 
SBG_COMMON_LIB_API size_t sbgStringFindCString(const SbgString *pString, const char *pCString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringSubstring(const SbgString *pString, size_t startIndex, size_t endIndex, SbgString *pSubstring);
 
SBG_COMMON_LIB_API bool sbgStringStartsWith(const SbgString *pString, const char *pCString);
 
SBG_COMMON_LIB_API bool sbgStringEndsWith(const SbgString *pString, const char *pCString);
 
//----------------------------------------------------------------------//
//- Modification methods                                               -//
//----------------------------------------------------------------------//
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringGetLastError(const SbgString *pString);
 
SBG_COMMON_LIB_API void sbgStringClearLastError(SbgString *pString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringSetCharAt(SbgString *pString, size_t index, char c);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringAppend(SbgString *pString, const SbgString *pAppendString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringAppendCString(SbgString *pString, const char *pCString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringAppendVF(SbgString *pString, const char *pFormat, va_list args) SBG_CHECK_FORMAT(printf, 2, 0);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringAppendF(SbgString *pString, const char *pFormat, ...) SBG_CHECK_FORMAT(printf, 2, 3);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringAssign(SbgString *pString, const SbgString *pAssignString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringAssignCString(SbgString *pString, const char *pCString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringAssignVF(SbgString *pString, const char *pFormat, va_list args) SBG_CHECK_FORMAT(printf, 2, 0);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringAssignF(SbgString *pString, const char *pFormat, ...) SBG_CHECK_FORMAT(printf, 2, 3);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringClear(SbgString *pString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToUpperCase(SbgString *pString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToLowerCase(SbgString *pString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringTrimLeft(SbgString *pString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringTrimRight(SbgString *pString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringTrim(SbgString *pString);
 
SBG_COMMON_LIB_API void sbgStringTruncate(SbgString *pString, size_t length);
 
//----------------------------------------------------------------------//
//- Conversion methods                                                 -//
//----------------------------------------------------------------------//
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringFromInt8(SbgString *pString, int8_t value);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToInt8(const SbgString *pString, int8_t *pValue);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringFromUint8(SbgString *pString, uint8_t value);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToUint8(const SbgString *pString, uint8_t *pValue);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringFromInt16(SbgString *pString, int16_t value);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToInt16(const SbgString *pString, int16_t *pValue);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringFromUint16(SbgString *pString, uint16_t value);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToUint16(const SbgString *pString, uint16_t *pValue);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringFromInt32(SbgString *pString, int32_t value);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToInt32(const SbgString *pString, int32_t *pValue);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringFromUint32(SbgString *pString, uint32_t value);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToUint32(const SbgString *pString, uint32_t *pValue);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringFromInt64(SbgString *pString, int64_t value);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToInt64(const SbgString *pString, int64_t *pValue);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringFromUint64(SbgString *pString, uint64_t value);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToUint64(const SbgString *pString, uint64_t *pValue);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringFromFloat(SbgString *pString, float value);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToFloat(const SbgString *pString, float *pValue);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringFromDouble(SbgString *pString, double value);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToDouble(const SbgString *pString, double *pValue);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringFromStreamBuffer(SbgString *pString, SbgStreamBuffer *pStream);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringToStreamBuffer(const SbgString *pString, SbgStreamBuffer *pStream);
 
//----------------------------------------------------------------------//
//- Iterator methods                                                   -//
//----------------------------------------------------------------------//
 
SBG_COMMON_LIB_API void sbgStringIteratorConstruct(SbgStringIterator *pIterator, const SbgString *pString);
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringIteratorWalk(SbgStringIterator *pIterator, const char *pSeparators, bool skipEmptyTokens, SbgString *pToken);
 
//----------------------------------------------------------------------//
//- Legacy functions                                                   -//
//----------------------------------------------------------------------//
 
SBG_COMMON_LIB_API SbgErrorCode sbgStringCopy(char *pDestination, const char *pSource, size_t destMaxSize);
 
SBG_COMMON_LIB_API const char *sbgStringFirstValidChar(const char *pInputStr);
 
//----------------------------------------------------------------------//
//- Footer (close extern C block)                                      -//
//----------------------------------------------------------------------//
 
#ifdef __cplusplus
}
#endif
 
#endif // SBG_STRING_H