blitz_string.h

Go to the documentation of this file.

#ifndef BLITZ_STRING_H
#define BLITZ_STRING_H

#include "_common.h"

#include "blitz_array.h"
#include "blitz_object.h"

BB_BEGIN_DECLS

//  Used internally to calculate the amount of memory necessary
//  to allocate a string with a certain length.
#define BBSTRING_SIZE_CALC(len)         (sizeof (BBString) + (len) * sizeof (BBChar))

#define BBSTRING_SIZE(str)              BBSTRING_SIZE_CALC((str)->length)

#define BBSTRING_MAX_LENGTH             ((BBSize)(BBSIZE_MAX / sizeof (BBChar)) - sizeof (BBString))
//#define BBSTRING_MAX_LENGTH           65535

#define BBSTRING_ALLOC(len) \
    ({                                                                          \
        (BBString *)                                                            \
        bbGCAllocObject(                                                        \
            BBSTRING_SIZE_CALC(len),                                            \
            &bbStringClass,                                                     \
            BBGC_ATOMIC                                                         \
        );                                                                      \
    })

/* Creates a string from a BBChar buffer
 *
 * \param   buffer A buffer containing UCS2 encoded string data
 * \param   len The length of the buffer and the new string
 * \returns A pointer to a newly allocated string with the given contents
 */
#define BBSTRING_FROMBUFFER(buffer, len) \
    ({                                                                          \
        BB_ASSERT((len) > 0 && (len) < BBSTRING_MAX_LENGTH, "Invalid buffer length"); \
        BBString *_str  = BBSTRING_ALLOC((len));                                \
        _str->length    = (len);                                                \
        memcpy(_str->buf, (buffer), (len) * sizeof (BBChar));                   \
        _str;                                                                   \
    })

struct BBString
{
    BBClass*        clas;
    int             refs;

    BBSize          length;
    
    BBChar          buf[];
};

extern BBClass bbStringClass;

extern BBString bbEmptyString;

#define BBNULLSTRING                    (&bbEmptyString)

#ifdef BB_ENABLE_HELPER

bool bb_string_buffer_equals(const BBChar * restrict str_buf,
                             const BBChar * restrict cmp_buf,
                             BBSize len) __attribute__ ((pure));

BBInt bb_string_buffer_findall(const BBChar * restrict str_buf,
                               const BBChar * restrict sub_buf,
                               const BBSize str_len,
                               const BBSize sub_len,
                               BBInt * const matches) __attribute__ ((pure));

#endif  // BB_ENABLE_HELPER



//  Built-in

BBString* bbStringToString(const BBString *str);

BBInt bbStringCompare(const BBString *str, const BBString *rhs) __attribute__ ((pure));

BBString* bbStringClone(const BBString *str);



//  API

BBString* bbStringNew(BBInt len);

BBString* bbStringFromChar(BBInt codepoint);

BBString* bbStringFromInt(BBInt number);

BBString* bbStringFromLong(BBLong number);

BBString* bbStringFromFloat(BBFloat number);

BBString* bbStringFromDouble(BBDouble number);

BBString* bbStringFromBytes(const char *buf, BBInt size);

BBString* bbStringFromShorts(const BBShort *buf, BBInt size);

BBString* bbStringFromInts(const BBInt *buf, BBInt size);

BBString* bbStringFromArray(const BBArray *arr);

BBString* bbStringFromCString(const char *c_str);

BBString* bbStringFromWString(const BBChar *w_str);

BBString* bbStringFromUTF8String(const char *utf8_str);


BBBool bbStringStartsWith(const BBString *str, const BBString *sub) __attribute__ ((pure));

BBBool bbStringEndsWith(const BBString *str, const BBString *sub) __attribute__ ((pure));

BBBool bbStringContains(const BBString *str, const BBString *sub) __attribute__ ((pure));



BBString* bbStringConcat(const BBString *str, const BBString *rhs);


enum BBStringSide
{
    BBSTRING_SIDE_BOTH,
    
    BBSTRING_SIDE_LEFT,
    
    BBSTRING_SIDE_RIGHT
};

typedef enum BBStringSide   BBStringSide;

#define BBSTRING_SIDE_ISVALID(side) \
    ((side) >= BBSTRING_SIDE_BOTH && (side) <= BBSTRING_SIDE_RIGHT)

BBString* bbStringTrim(const BBString *str, BBStringSide side);

BBString* bbStringSlice(const BBString *str, BBInt begin, BBInt end);

BBString* bbStringReplace(const BBString *str, const BBString *sub, const BBString *replacement);

BBInt bbStringAsc(const BBString *str) __attribute__ ((pure));



#define BBSTRING_NOTFOUND   (-1)

BBInt bbStringFind(const BBString *str, const BBString *sub, BBInt index) __attribute__ ((pure));

BBInt bbStringFindLast(const BBString *str, const BBString *sub, BBInt index) __attribute__ ((pure));

BBArray* bbStringFindAll(const BBString* str, const BBString *sub, BBInt index);

BBInt bbStringFindAny(const BBString *str, const BBStringArray *all_subs, BBInt index) __attribute__ ((pure));

BBString* bbStringToLower(const BBString *str);

BBString* bbStringToUpper(const BBString *str);

BBInt bbStringToInt(const BBString *str);

BBFloat bbStringToFloat(const BBString *str);

BBDouble bbStringToDouble(const BBString *str);

void bbStringToLong(const BBString *str, BBLong *result);

char* bbStringToCString(const BBString *str);

BBChar* bbStringToWString(const BBString *str);

char* bbStringToUTF8String(const BBString *str);

BBStringArray* bbStringSplit(const BBString *str, const BBString *separator);

BBString* bbStringJoin(const BBString *str, const BBStringArray *bits);



//  Additions by BME

BBBool bbStringEquals(const BBString *str, const BBString *rhs) __attribute__ ((pure));

BBInt bbStringCount(const BBString *str, const BBString *sub) __attribute__ ((pure));

BBString* bbStringReverse(const BBString *str);

BBString* bbStringTimes(const BBString *str, BBInt count);

BBString* bbStringSub(const BBString *str, BBInt index, BBInt len);

BBBool bbStringIsLower(const BBString *str) __attribute__ ((pure));

BBBool bbStringIsUpper(const BBString *str) __attribute__ ((pure));

BBBool bbStringIsASCII(const BBString *str) __attribute__ ((pure));

//  intern

char* bbTmpCString(const BBString *str);
BBChar* bbTmpWString(const BBString *str);
char* bbTmpUTF8String(const BBString *str);

BB_END_DECLS

#endif  // BLITZ_STRING_H