#include "Config.h"
#include <assert.h>
#include <iconv.h>
#include <stdarg.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <wchar.h>
#include "Hash.h"
#include "MutableArray.h"
#include "MutableString.h"

Data Structures
struct	Transcode
	Character transcoding context for `iconv`. More...

Macros
#define	_Class _String

Functions
Class *	_String (void)

static Order	compareTo (const String self, const String other, const Range range)

static Array *	componentsSeparatedByCharacters (const String self, const char chars)

static Array *	componentsSeparatedByString (const String self, const String string)

static Object *	copy (const Object *self)

static void	dealloc (Object *self)

static String *	description (const Object *self)

static Data *	getData (const String *self, StringEncoding encoding)

static int	hash (const Object *self)

static _Bool	hasPrefix (const String self, const String prefix)

static _Bool	hasSuffix (const String self, const String suffix)

static void	initialize (Class *clazz)

static String *	initWithBytes (String self, const uint8_t bytes, size_t length, StringEncoding encoding)

static String *	initWithCharacters (String self, const char chars)

static String *	initWithContentsOfFile (String self, const char path, StringEncoding encoding)

static String *	initWithData (String self, const Data data, StringEncoding encoding)

static String *	initWithFormat (String self, const char fmt,...)

static String *	initWithMemory (String *self, const ident mem, size_t length)

static String *	initWithVaList (String self, const char fmt, va_list args)

static _Bool	isEqual (const Object self, const Object other)

static String *	lowercaseString (const String *self)

static MutableString *	mutableCopy (const String *self)

const char *	NameForStringEncoding (StringEncoding encoding)

static Range	rangeOfCharacters (const String self, const char chars, const Range range)

static Range	rangeOfString (const String self, const String string, const Range range)

String *	str (const char *fmt,...)

Order	StringCompare (const ident a, const ident b)

StringEncoding	StringEncodingForName (const char *name)

static String *	stringWithBytes (const uint8_t *bytes, size_t length, StringEncoding encoding)

static String *	stringWithCharacters (const char *chars)

static String *	stringWithContentsOfFile (const char *path, StringEncoding encoding)

static String *	stringWithData (const Data *data, StringEncoding encoding)

static String *	stringWithFormat (const char *fmt,...)

static String *	stringWithMemory (const ident mem, size_t length)

char *	strtrim (const char *s)
	Copies the given null-terminated C string, trimming leading and trailing whitespace. More...

static String *	substring (const String *self, const Range range)

static size_t	transcode (Transcode *trans)
	Transcodes input from one character encoding to another via `iconv`. More...

static String *	trimmedString (const String *self)

static String *	uppercaseString (const String *self)

static _Bool	writeToFile (const String self, const char path, StringEncoding encoding)

Macro Definition Documentation

◆ _Class

#define _Class _String

Definition at line 44 of file String.c.

Function Documentation

◆ _String()

Class * _String ( void )

Definition at line 654 of file String.c.

                     {
    static Class *clazz;
    static Once once;
 
    do_once(&once, {
        clazz = _initialize(&(const ClassDef) {
            .name = "String",
            .superclass = _Object(),
            .instanceSize = sizeof(String),
            .interfaceOffset = offsetof(String, interface),
            .interfaceSize = sizeof(StringInterface),
            .initialize = initialize,
        });
    });
 
    return clazz;
}

◆ compareTo()

static Order compareTo	(	const String *	self,
		const String *	other,
		const Range	range
	)

static

Definition at line 163 of file String.c.

                                                                                   {
 
    assert(range.location + range.length <= self->length);
 
    if (other) {
        const int i = strncmp(self->chars + range.location, other->chars, range.length);
        if (i == 0) {
            return OrderSame;
        }
        if (i > 0) {
            return OrderDescending;
        }
    }
 
    return OrderAscending;
}

◆ componentsSeparatedByCharacters()

static Array * componentsSeparatedByCharacters	(	const String *	self,
		const char *	chars
	)

static

Definition at line 184 of file String.c.

                                                                                     {
 
    assert(chars);
 
    MutableArray *components = $(alloc(MutableArray), init);
 
    Range search = { 0, self->length };
    Range result = $(self, rangeOfCharacters, chars, search);
 
    while (result.length) {
        search.length = result.location - search.location;
 
        String *component = $(self, substring, search);
        $(components, addObject, component);
        release(component);
 
        search.location = result.location + result.length;
        search.length = self->length - search.location;
 
        result = $(self, rangeOfCharacters, chars, search);
    }
 
    String *component = $(self, substring, search);
    $(components, addObject, component);
    release(component);
 
    return (Array *) components;
}

◆ componentsSeparatedByString()

static Array * componentsSeparatedByString	(	const String *	self,
		const String *	string
	)

static

Definition at line 217 of file String.c.

                                                                                    {
 
    assert(string);
 
    return $(self, componentsSeparatedByCharacters, string->chars);
}

◆ copy()

static Object * copy ( const Object * self )

static

See also: Object::copy(const Object *)

Definition at line 51 of file String.c.

                                        {
 
    String *this = (String *) self;
    String *that = $$(String, stringWithCharacters, this->chars);
 
    return (Object *) that;
}

◆ dealloc()

static void dealloc ( Object * self )

static

See also: Object::dealloc(Object *)

Definition at line 62 of file String.c.

                                  {
 
    String *this = (String *) self;
 
    free(this->chars);
 
    super(Object, self, dealloc);
}

◆ description()

static String * description ( const Object * self )

static

See also: Object::description(const Object *)

Definition at line 74 of file String.c.

                                               {
 
    return (String *) $(self, copy);
}

◆ getData()

static Data * getData	(	const String *	self,
		StringEncoding	encoding
	)

static

Definition at line 228 of file String.c.

                                                                  {
 
    Transcode trans = {
        .to = encoding,
        .from = STRING_ENCODING_UTF8,
        .in = self->chars,
        .length = self->length,
        .out = calloc(self->length, sizeof(Unicode) / sizeof(char)),
        .size = self->length * sizeof(Unicode)
    };
 
    assert(trans.out);
 
    const size_t size = transcode(&trans);
    assert(size <= trans.size);
 
    return $$(Data, dataWithMemory, trans.out, size);
}

◆ hash()

static int hash ( const Object * self )

static

See also: Object::hash(const Object *)

Definition at line 82 of file String.c.

                                    {
 
    String *this = (String *) self;
 
    return HashForCString(HASH_SEED, this->chars);
}

◆ hasPrefix()

static _Bool hasPrefix	(	const String *	self,
		const String *	prefix
	)

static

Definition at line 251 of file String.c.

                                                                 {
 
    if (prefix->length > self->length) {
        return false;
    }
 
    Range range = { 0, prefix->length };
    return $(self, compareTo, prefix, range) == OrderSame;
}

◆ hasSuffix()

static _Bool hasSuffix	(	const String *	self,
		const String *	suffix
	)

static

Definition at line 265 of file String.c.

                                                                 {
 
    if (suffix->length > self->length) {
        return false;
    }
 
    Range range = { self->length - suffix->length, suffix->length };
    return $(self, compareTo, suffix, range) == OrderSame;
}

◆ initialize()

static void initialize ( Class * clazz )

static

See also: Class::initialize(Class *)

Definition at line 613 of file String.c.

                                     {
 
    ((ObjectInterface *) clazz->interface)->copy = copy;
    ((ObjectInterface *) clazz->interface)->dealloc = dealloc;
    ((ObjectInterface *) clazz->interface)->description = description;
    ((ObjectInterface *) clazz->interface)->hash = hash;
    ((ObjectInterface *) clazz->interface)->isEqual = isEqual;
 
    ((StringInterface *) clazz->interface)->compareTo = compareTo;
    ((StringInterface *) clazz->interface)->componentsSeparatedByCharacters = componentsSeparatedByCharacters;
    ((StringInterface *) clazz->interface)->componentsSeparatedByString = componentsSeparatedByString;
    ((StringInterface *) clazz->interface)->getData = getData;
    ((StringInterface *) clazz->interface)->hasPrefix = hasPrefix;
    ((StringInterface *) clazz->interface)->hasSuffix = hasSuffix;
    ((StringInterface *) clazz->interface)->initWithBytes = initWithBytes;
    ((StringInterface *) clazz->interface)->initWithCharacters = initWithCharacters;
    ((StringInterface *) clazz->interface)->initWithContentsOfFile = initWithContentsOfFile;
    ((StringInterface *) clazz->interface)->initWithData = initWithData;
    ((StringInterface *) clazz->interface)->initWithFormat = initWithFormat;
    ((StringInterface *) clazz->interface)->initWithMemory = initWithMemory;
    ((StringInterface *) clazz->interface)->initWithVaList = initWithVaList;
    ((StringInterface *) clazz->interface)->lowercaseString = lowercaseString;
    ((StringInterface *) clazz->interface)->mutableCopy = mutableCopy;
    ((StringInterface *) clazz->interface)->rangeOfCharacters = rangeOfCharacters;
    ((StringInterface *) clazz->interface)->rangeOfString = rangeOfString;
    ((StringInterface *) clazz->interface)->stringWithBytes = stringWithBytes;
    ((StringInterface *) clazz->interface)->stringWithCharacters = stringWithCharacters;
    ((StringInterface *) clazz->interface)->stringWithContentsOfFile = stringWithContentsOfFile;
    ((StringInterface *) clazz->interface)->stringWithData = stringWithData;
    ((StringInterface *) clazz->interface)->stringWithFormat = stringWithFormat;
    ((StringInterface *) clazz->interface)->stringWithMemory = stringWithMemory;
    ((StringInterface *) clazz->interface)->substring = substring;
    ((StringInterface *) clazz->interface)->trimmedString = trimmedString;
    ((StringInterface *) clazz->interface)->uppercaseString = uppercaseString;
    ((StringInterface *) clazz->interface)->writeToFile = writeToFile;
}

◆ initWithBytes()

static String * initWithBytes	(	String *	self,
		const uint8_t *	bytes,
		size_t	length,
		StringEncoding	encoding
	)

static

Definition at line 279 of file String.c.

                                                                                                         {
 
    if (bytes) {
 
        Transcode trans = {
            .to = STRING_ENCODING_UTF8,
            .from = encoding,
            .in = (char *) bytes,
            .length = length,
            .out = calloc(length * sizeof(Unicode) + 1, sizeof(char)),
            .size = length * sizeof(Unicode) + 1
        };
 
        assert(trans.out);
 
        const size_t size = transcode(&trans);
        assert(size < trans.size);
 
        ident mem = realloc(trans.out, size + 1);
        assert(mem);
 
        return $(self, initWithMemory, mem, size);
    }
 
    return $(self, initWithMemory, NULL, 0);
}

◆ initWithCharacters()

static String * initWithCharacters	(	String *	self,
		const char *	chars
	)

static

Definition at line 310 of file String.c.

                                                                   {
 
    if (chars) {
 
        ident mem = strdup(chars);
        assert(mem);
 
        const size_t length = strlen(chars);
        return $(self, initWithMemory, mem, length);
    }
 
    return $(self, initWithMemory, NULL, 0);
}

◆ initWithContentsOfFile()

static String * initWithContentsOfFile	(	String *	self,
		const char *	path,
		StringEncoding	encoding
	)

static

Definition at line 328 of file String.c.

                                                                                               {
 
    Data *data = $$(Data, dataWithContentsOfFile, path);
    if (data) {
        self = $(self, initWithData, data, encoding);
    } else {
        self = $(self, initWithMemory, NULL, 0);
    }
    release(data);
 
    return self;
}

◆ initWithData()

static String * initWithData	(	String *	self,
		const Data *	data,
		StringEncoding	encoding
	)

static

Definition at line 345 of file String.c.

                                                                                     {
 
    assert(data);
 
    return $(self, initWithBytes, data->bytes, data->length, encoding);
}

◆ initWithFormat()

static String * initWithFormat	(	String *	self,
		const char *	fmt,
			...
	)

static

Definition at line 356 of file String.c.

                                                                  {
 
    va_list args;
    va_start(args, fmt);
 
    self = $(self, initWithVaList, fmt, args);
 
    va_end(args);
 
    return self;
}

◆ initWithMemory()

static String * initWithMemory	(	String *	self,
		const ident	mem,
		size_t	length
	)

static

Definition at line 372 of file String.c.

                                                                            {
 
    self = (String *) super(Object, self, init);
    if (self) {
 
        if (mem) {
            self->chars = (char *) mem;
            self->length = length;
        }
    }
 
    return self;
}

◆ initWithVaList()

static String * initWithVaList	(	String *	self,
		const char *	fmt,
		va_list	args
	)

static

Definition at line 390 of file String.c.

                                                                           {
 
    self = (String *) super(Object, self, init);
    if (self) {
 
        if (fmt) {
            const int len = vasprintf(&self->chars, fmt, args);
            assert(len >= 0);
 
            self->length = len;
        }
    }
 
    return self;
}

◆ isEqual()

static _Bool isEqual	(	const Object *	self,
		const Object *	other
	)

static

See also: Object::isEqual(const Object *, const Object *)

Definition at line 92 of file String.c.

                                                              {
 
    if (super(Object, self, isEqual, other)) {
        return true;
    }
 
    if (other && $(other, isKindOfClass, _String())) {
 
        const String *this = (String *) self;
        const String *that = (String *) other;
 
        if (this->length == that->length) {
 
            const Range range = { 0, this->length };
            return $(this, compareTo, that, range) == OrderSame;
        }
    }
 
    return false;
}

◆ lowercaseString()

static String * lowercaseString ( const String * self )

static

Definition at line 410 of file String.c.

                                                   {
 
    Data *data = $(self, getData, STRING_ENCODING_WCHAR);
    assert(data);
 
    const size_t codepoints = data->length / sizeof(Unicode);
    Unicode *unicode = (Unicode *) data->bytes;
 
    for (size_t i = 0; i < codepoints; i++, unicode++) {
        *unicode = towlower(*unicode);
    }
 
    String *lowercase = $$(String, stringWithData, data, STRING_ENCODING_WCHAR);
 
    release(data);
    return lowercase;
}

◆ mutableCopy()

static MutableString * mutableCopy ( const String * self )

static

Definition at line 432 of file String.c.

                                                      {
 
    return $(alloc(MutableString), initWithString, self);
}

◆ NameForStringEncoding()

const char * NameForStringEncoding ( StringEncoding encoding )

                                                           {
 
    switch (encoding) {
        case STRING_ENCODING_ASCII:
            return "ASCII";
        case STRING_ENCODING_LATIN1:
            return "ISO-8859-1";
        case STRING_ENCODING_LATIN2:
            return "ISO-8859-2";
        case STRING_ENCODING_MACROMAN:
            return "MacRoman";
        case STRING_ENCODING_UTF16:
            return "UTF-16";
        case STRING_ENCODING_UTF32:
            return "UTF-32";
        case STRING_ENCODING_UTF8:
            return "UTF-8";
        case STRING_ENCODING_WCHAR:
            return "WCHAR_T";
    }
 
    return "ASCII";
}

◆ rangeOfCharacters()

static Range rangeOfCharacters	(	const String *	self,
		const char *	chars,
		const Range	range
	)

static

Definition at line 441 of file String.c.

                                                                                         {
 
    assert(chars);
    assert(range.location > -1);
    assert(range.length > 0);
    assert(range.location + range.length <= self->length);
 
    Range match = { -1, 0 };
    const size_t len = strlen(chars);
 
    const char *str = self->chars + range.location;
    for (size_t i = 0; i < range.length; i++, str++) {
        if (strncmp(str, chars, len) == 0) {
            match.location = range.location + i;
            match.length = len;
            break;
        }
    }
 
    return match;
}

◆ rangeOfString()

static Range rangeOfString	(	const String *	self,
		const String *	string,
		const Range	range
	)

static

Definition at line 467 of file String.c.

                                                                                        {
 
    assert(string);
 
    return $(self, rangeOfCharacters, string->chars, range);
}

◆ str()

String * str	(	const char *	fmt,
			...
	)

                                  {
 
    va_list args;
    va_start(args, fmt);
 
    String *string = $(alloc(String), initWithVaList, fmt, args);
    assert(string);
 
    va_end(args);
 
    return string;
}

◆ StringCompare()

Order StringCompare	(	const ident	a,
		const ident	b
	)

                                                  {
 
    if (a) {
        if (b) {
            const int i = strcmp(((String *) a)->chars, ((String *) b)->chars);
            if (i == 0) {
                return OrderSame;
            }
            if (i > 0) {
                return OrderDescending;
            }
        } else {
            return OrderDescending;
        }
    }
    return OrderAscending;
}

◆ StringEncodingForName()

StringEncoding StringEncodingForName ( const char * name )

                                                       {
 
    if (strcasecmp("ASCII", name) == 0) {
        return STRING_ENCODING_ASCII;
    } else if (strcasecmp("ISO-8859-1", name) == 0) {
        return STRING_ENCODING_LATIN1;
    } else if (strcasecmp("ISO-8859-2", name) == 0) {
        return STRING_ENCODING_LATIN2;
    } else if (strcasecmp("MacRoman", name) == 0) {
        return STRING_ENCODING_MACROMAN;
    } else if (strcasecmp("UTF-16", name) == 0) {
        return STRING_ENCODING_UTF16;
    } else if (strcasecmp("UTF-32", name) == 0) {
        return STRING_ENCODING_UTF32;
    } else if (strcasecmp("UTF-8", name) == 0) {
        return STRING_ENCODING_UTF8;
    } else if (strcasecmp("WCHAR", name) == 0) {
        return STRING_ENCODING_WCHAR;
    }
 
    return STRING_ENCODING_ASCII;
}

◆ stringWithBytes()

static String * stringWithBytes	(	const uint8_t *	bytes,
		size_t	length,
		StringEncoding	encoding
	)

static

Definition at line 478 of file String.c.

                                                                                             {
 
    return $(alloc(String), initWithBytes, bytes, length, encoding);
}

◆ stringWithCharacters()

static String * stringWithCharacters ( const char * chars )

static

Definition at line 487 of file String.c.

                                                       {
 
    return $(alloc(String), initWithCharacters, chars);
}

◆ stringWithContentsOfFile()

static String * stringWithContentsOfFile	(	const char *	path,
		StringEncoding	encoding
	)

static

Definition at line 496 of file String.c.

                                                                                   {
 
    return $(alloc(String), initWithContentsOfFile, path, encoding);
}

◆ stringWithData()

static String * stringWithData	(	const Data *	data,
		StringEncoding	encoding
	)

static

Definition at line 505 of file String.c.

                                                                         {
 
    return $(alloc(String), initWithData, data, encoding);
}

◆ stringWithFormat()

static String * stringWithFormat	(	const char *	fmt,
			...
	)

static

Definition at line 514 of file String.c.

                                                      {
 
    va_list args;
    va_start(args, fmt);
 
    String *string = $(alloc(String), initWithVaList, fmt, args);
 
    va_end(args);
 
    return string;
}

◆ stringWithMemory()

static String * stringWithMemory	(	const ident	mem,
		size_t	length
	)

static

Definition at line 530 of file String.c.

                                                                {
 
    return $(alloc(String), initWithMemory, mem, length);
}

◆ strtrim()

char * strtrim ( const char * s )

Copies the given null-terminated C string, trimming leading and trailing whitespace.

Parameters

s	A null-terminated C string.

Returns: A trimmed copy of str which must be freed by the caller.

Definition at line 752 of file String.c.

                             {
 
    assert(s);
    while (isspace(*s)) {
        s++;
    }
 
    char *trimmed = strdup(s);
    assert(trimmed);
 
    char *end = trimmed + strlen(trimmed);
    if (end > trimmed) {
        while (isspace(*(--end))) {
            *end = '\0';
        }
    }
 
    return trimmed;
}

◆ substring()

static String * substring	(	const String *	self,
		const Range	range
	)

static

Definition at line 539 of file String.c.

                                                                {
 
    assert(range.location + range.length <= self->length);
 
    ident mem = calloc(range.length + 1, sizeof(char));
    assert(mem);
 
    strncpy(mem, self->chars + range.location, range.length);
 
    return $(alloc(String), initWithMemory, mem, range.length);
}

◆ transcode()

static size_t transcode ( Transcode * trans )

static

Transcodes input from one character encoding to another via iconv.

Parameters

trans A Transcode struct.

Returns: The number of bytes written to trans->out.

Definition at line 133 of file String.c.

                                          {
 
    assert(trans);
    assert(trans->to);
    assert(trans->from);
    assert(trans->out);
    assert(trans->size);
 
    iconv_t cd = iconv_open(NameForStringEncoding(trans->to), NameForStringEncoding(trans->from));
    assert(cd != (iconv_t ) -1);
 
    char *in = trans->in;
    char *out = trans->out;
 
    size_t inBytesRemaining = trans->length;
    size_t outBytesRemaining = trans->size;
 
    const size_t ret = iconv(cd, &in, &inBytesRemaining, &out, &outBytesRemaining);
    assert(ret != (size_t ) -1);
 
    int err = iconv_close(cd);
    assert(err == 0);
 
    return trans->size - outBytesRemaining;
}

◆ trimmedString()

static String * trimmedString ( const String * self )

static

Definition at line 555 of file String.c.

                                                 {
 
    Range range = { .location = 0, .length = self->length };
 
    while (isspace(self->chars[range.location])) {
        range.location++;
        range.length--;
    }
 
    while (isspace(self->chars[range.length])) {
        range.length--;
    }
 
    return $(self, substring, range);
}

◆ uppercaseString()

static String * uppercaseString ( const String * self )

static

Definition at line 575 of file String.c.

                                                   {
 
    Data *data = $(self, getData, STRING_ENCODING_WCHAR);
    assert(data);
 
    const size_t codepoints = data->length / sizeof(Unicode);
    Unicode *unicode = (Unicode *) data->bytes;
 
    for (size_t i = 0; i < codepoints; i++, unicode++) {
        *unicode = towupper(*unicode);
    }
 
    String *uppercase = $$(String, stringWithData, data, STRING_ENCODING_WCHAR);
 
    release(data);
    return uppercase;
}

◆ writeToFile()

static _Bool writeToFile	(	const String *	self,
		const char *	path,
		StringEncoding	encoding
	)

static

Definition at line 597 of file String.c.

                                                                                        {
 
    Data *data = $(self, getData, encoding);
    assert(data);
 
    const _Bool success = $(data, writeToFile, path);
 
    release(data);
    return success;
}

Data Structures

Macros

Functions

Macro Definition Documentation

◆ _Class

Function Documentation

◆ _String()

◆ compareTo()

◆ componentsSeparatedByCharacters()

◆ componentsSeparatedByString()

◆ copy()

◆ dealloc()

◆ description()

◆ getData()

◆ hash()

◆ hasPrefix()

◆ hasSuffix()

◆ initialize()

◆ initWithBytes()

◆ initWithCharacters()

◆ initWithContentsOfFile()

◆ initWithData()

◆ initWithFormat()

◆ initWithMemory()

◆ initWithVaList()

◆ isEqual()

◆ lowercaseString()

◆ mutableCopy()

◆ NameForStringEncoding()

◆ rangeOfCharacters()

◆ rangeOfString()

◆ str()

◆ StringCompare()

◆ StringEncodingForName()

◆ stringWithBytes()

◆ stringWithCharacters()

◆ stringWithContentsOfFile()

◆ stringWithData()

◆ stringWithFormat()

◆ stringWithMemory()

◆ strtrim()

◆ substring()

◆ transcode()

◆ trimmedString()

◆ uppercaseString()

◆ writeToFile()