striter.h

Go to the documentation of this file.

#pragma once
 
#include <cx/string/strbase.h>
 
 
 
CX_C_BEGIN
 
typedef struct striter {
    // Public members - safe to read
    uint8* _Nullable bytes;   
    uint32 off;               
    uint32 len;               
    uint32 cursor;            
 
    // Private members - do not access directly
    string _str;
    bool _borrowed;
} striter;
 
typedef enum {
    STRI_BYTE,    
    STRI_U8CHAR   
} STRI_SEEK_TYPE;
 
typedef enum {
    STRI_SET,   
    STRI_CUR,   
    STRI_END    
} STRI_SEEK_WHENCE;
 
void striInit(_Out_ striter* _Nonnull i, _In_opt_ strref s);
 
void striInitRev(_Out_ striter* _Nonnull i, _In_opt_ strref s);
 
bool striNext(_Inout_ striter* _Nonnull i);
 
bool striPrev(_Inout_ striter* _Nonnull i);
 
bool striSeek(_Inout_ striter* _Nonnull i, int32 off, STRI_SEEK_TYPE type, STRI_SEEK_WHENCE whence);
 
void striFinish(_Inout_ striter* _Nonnull i);
 
_meta_inline bool striValid(_In_ striter* _Nonnull i)
{
    return i->len > 0;
}
 
void striBorrow(_Out_ striter* _Nonnull i, _In_opt_ strref s);
 
void striBorrowRev(_Out_ striter* _Nonnull i, _In_opt_ strref s);
 
 
_meta_inline _Success_(return) _Must_inspect_result_ bool
striChar(_Inout_ striter* _Nonnull i, _Out_ uint8* _Nonnull out)
{
    while (i->cursor >= i->len) {
        striNext(i);
        if (i->len == 0)
            return false;
    }
 
    *out = i->bytes[i->cursor++];
    return true;
}
 
_meta_inline _Success_(return) _Must_inspect_result_ bool
striPeekChar(_Inout_ striter* _Nonnull i, _Out_ uint8* _Nonnull out)
{
    while (i->cursor >= i->len) {
        striNext(i);
        if (i->len == 0)
            return false;
    }
 
    *out = i->bytes[i->cursor];
    return true;
}
 
_meta_inline bool striAdvance(_Inout_ striter* _Nonnull i, uint32 by)
{
    i->cursor += by;
    while (i->cursor >= i->len) {
        striNext(i);
        if (i->len == 0)
            return (i->cursor == 0);   // return true for hitting end of string exactly
    }
    return true;
}
 
 
#define _striU8Anno _Success_(return) _Must_inspect_result_
 
 
_striU8Anno bool striU8Char(_Inout_ striter* _Nonnull i, _Out_ int32* out);
 
#define _striPeekU8Anno _Success_(return) _Must_inspect_result_
 
_striPeekU8Anno bool striPeekU8Char(_Inout_ striter* _Nonnull i, _Out_ int32* out);
 
bool striAdvanceU8(_Inout_ striter* _Nonnull i, uint32 by);
 
 
 
CX_C_END