strbase.h

Go to the documentation of this file.

#pragma once
 
 
#include <cx/cx.h>
 
CX_C_BEGIN
 
typedef struct str_ref {
    void* _is_string;
} str_ref;
 
// Layout of the static empty string. The real type has to be visible here rather
// than declaring the object as a str_ref, or LTO builds see a type mismatch
// between this declaration and the definition in strempty.c
typedef struct str_empty_data {
    unsigned char hdr;     // STR_CX | STR_ASCII | STR_UTF8 | STR_LEN8
    unsigned char magic;   // 0xc1 cx string marker
    unsigned char len;     // length, always 0
    unsigned char nul;     // NUL terminator, so strC() has something valid to return
} str_empty_data;
 
extern str_empty_data _emptyStringData;   // internal data for the empty string
extern strref emptyString;                // public constant for empty string
 
 
typedef struct str_ref* _Nullable string;
 
typedef const struct str_ref* _Nullable strref;
 
typedef string* _Nonnull strhandle;
 
#define strInit(o) *(o) = NULL
 
void strReset(_Inout_ptr_opt_ strhandle o, uint32 sizehint);
 
void strDup(_Inout_ strhandle o, _In_opt_ strref s);
 
void strCopy(_Inout_ strhandle o, _In_opt_ strref s);
 
bool strFromBytes(_Inout_ strhandle o, _In_reads_bytes_opt_(sz) const void* _Nullable buf,
                  uint32 sz);
 
void strClear(_Inout_ strhandle ps);
 
_When_(s == NULL, _Post_equal_to_(0)) _Pure uint32 strLen(_In_opt_ strref s);
 
void strSetLen(_Inout_ strhandle ps, uint32 len);
 
_When_(s == NULL, _Post_equal_to_(true)) _Pure bool strEmpty(_In_opt_ strref s);
 
void strDestroy(_Inout_ strhandle ps);
 
_Ret_valid_ const char* _Nonnull strC(_In_opt_ strref s);
 
_Ret_valid_ const char* _Nonnull strPC(_Inout_ strhandle ps);
 
_Ret_valid_ uint8* _Nonnull strBuffer(_Inout_ strhandle ps, uint32 minsz);
 
uint32 strCopyOut(_In_opt_ strref s, uint32 off, _Out_writes_bytes_(bufsz) uint8* _Nonnull buf,
                  uint32 bufsz);
 
uint32 strCopyRaw(_In_opt_ strref s, uint32 off, _Out_writes_bytes_(maxlen) uint8* _Nonnull buf,
                  uint32 maxlen);
 
_Pure uint32 _strStackAllocSize(uint32 maxlen);
void _strInitStack(_Inout_ _Deref_pre_valid_ _Deref_post_opt_valid_ strhandle ps, uint32 maxlen);
 
#define strTemp(ps, maxlen)                                   \
    (*(ps)) = (string)stackAlloc(_strStackAllocSize(maxlen)); \
    _strInitStack(ps, maxlen);
 
 
#include "strliteral.h"
 
CX_C_END