sc/string/sc_str.c

/*
 * MIT License
 *
 * Copyright (c) 2021 Ozan Tezcan
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include "sc_str.h"

#include <assert.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

/**
 * String with 'length' at the start of the allocated memory
 *  e.g :
 *  -----------------------------------------------
 *  | 0 | 0 | 0 | 4 | 'T' | 'E' | 'S' | 'T' | '\0'|
 *  -----------------------------------------------
 *
 *  User can keep pointer to first character, so it's like C style strings with
 *  additional functionality when it's used with these functions here.
 */
struct sc_str
{
    uint32_t len;
    char buf[];
};

#define sc_str_meta(str)                                                       \
    ((struct sc_str *) ((char *) (str) -offsetof(struct sc_str, buf)))

#define sc_str_bytes(n) ((n) + sizeof(struct sc_str) + 1)

#ifndef SC_SIZE_MAX
    #define SC_SIZE_MAX (UINT32_MAX - sizeof(struct sc_str) - 1)
#endif

char *sc_str_create(const char *str)
{
    size_t size;

    if (str == NULL || (size = strlen(str)) > SC_SIZE_MAX) {
        return NULL;
    }

    return sc_str_create_len(str, (uint32_t) size);
}

char *sc_str_create_len(const char *str, uint32_t len)
{
    struct sc_str *copy;

    if (str == NULL) {
        return NULL;
    }

    copy = sc_str_malloc(sc_str_bytes(len));
    if (copy == NULL) {
        return NULL;
    }

    memcpy(copy->buf, str, len);
    copy->buf[len] = '\0';
    copy->len = len;

    return copy->buf;
}

char *sc_str_create_va(const char *fmt, va_list va)
{
    int rc;
    char tmp[1024];
    struct sc_str *str;
    va_list args;

    va_copy(args, va);
    rc = vsnprintf(tmp, sizeof(tmp), fmt, args);
    if (rc < 0) {
        return NULL;
    }
    va_end(args);

    str = sc_str_malloc(sc_str_bytes(rc));
    if (str == NULL) {
        return NULL;
    }

    str->len = (uint32_t) rc;

    if (rc < (int) sizeof(tmp)) {
        memcpy(str->buf, tmp, str->len + 1);
    } else {
        va_copy(args, va);
        rc = vsnprintf(str->buf, str->len, fmt, args);
        va_end(args);

        if (rc < 0 || (uint32_t) rc > str->len) {
            sc_str_free(str);
            return NULL;
        }
    }

    return str->buf;
}

char *sc_str_create_fmt(const char *fmt, ...)
{
    char *str;
    va_list args;

    va_start(args, fmt);
    str = sc_str_create_va(fmt, args);
    va_end(args);

    return str;
}

void sc_str_destroy(char *str)
{
    if (str == NULL) {
        return;
    }

    sc_str_free(sc_str_meta(str));
}

int64_t sc_str_len(const char *str)
{
    if (str == NULL) {
        return -1;
    }

    return sc_str_meta(str)->len;
}

char *sc_str_dup(const char *str)
{
    if (str == NULL) {
        return NULL;
    }

    return sc_str_create_len(str, sc_str_meta(str)->len);
}

bool sc_str_set(char **str, const char *param)
{
    char *copy = sc_str_create(param);
    if (copy == NULL) {
        return false;
    }

    sc_str_destroy(*str);
    *str = copy;

    return true;
}

bool sc_str_set_fmt(char **str, const char *fmt, ...)
{
    char *ret;
    va_list args;

    va_start(args, fmt);
    ret = sc_str_create_va(fmt, args);
    va_end(args);

    if (ret != NULL) {
        sc_str_destroy(*str);
        *str = ret;
    }

    return ret != NULL;
}

bool sc_str_append(char **str, const char *param)
{
    size_t len, alloc;
    struct sc_str *meta;

    if (*str == NULL) {
        return (*str = sc_str_create(param)) != NULL;
    }

    meta = sc_str_meta(*str);
    len = strlen(param);
    alloc = sc_str_bytes(meta->len + len);

    if (len > SC_SIZE_MAX - meta->len ||
        (meta = sc_str_realloc(meta, alloc)) == NULL) {
        return false;
    }

    memcpy(&meta->buf[meta->len], param, len);
    meta->len += (uint32_t) len;
    meta->buf[meta->len] = '\0';
    *str = meta->buf;

    return true;
}

bool sc_str_cmp(const char *str, const char *other)
{
    struct sc_str *s1 = sc_str_meta(str);
    struct sc_str *s2 = sc_str_meta(other);

    return s1->len == s2->len && !memcmp(s1->buf, s2->buf, s1->len);
}

static void swap(char *str, char *d)
{
    char tmp;
    char *c = str + sc_str_meta(str)->len;

    tmp = *c;
    *c = *d;
    *d = tmp;
}

const char *sc_str_token_begin(char *str, char **save, const char *delim)
{
    char *it = str;

    if (str == NULL) {
        return NULL;
    }

    if (*save != NULL) {
        it = *save;
        swap(str, it);
        if (*it == '\0') {
            return NULL;
        }
        it++;
    }

    *save = it + strcspn(it, delim);
    swap(str, *save);

    return it;
}

void sc_str_token_end(char *str, char **save)
{
    char *end;

    if (str == NULL) {
        return;
    }

    end = str + sc_str_meta(str)->len;
    if (*end == '\0') {
        return;
    }

    swap(str, (save != NULL && *save != NULL) ? *save : str + strlen(str));
}

bool sc_str_trim(char **str, const char *list)
{
    size_t len;
    char *start, *end;

    if (*str == NULL) {
        return true;
    }

    len = sc_str_meta(*str)->len;
    start = *str + strspn(*str, list);
    end = (*str) + len;

    while (end > start) {
        end--;
        if (!strchr(list, *end)) {
            end++;
            break;
        }
    }

    if (start != *str || end != (*str) + len) {
        start = sc_str_create_len(start, (uint32_t)(end - start));
        if (start == NULL) {
            return false;
        }

        sc_str_destroy(*str);
        *str = start;
    }

    return true;
}

bool sc_str_substring(char **str, uint32_t start, uint32_t end)
{
    char *c;
    struct sc_str *meta;

    if (*str == NULL) {
        return false;
    }

    meta = sc_str_meta(*str);
    if (start > meta->len || end > meta->len || start > end) {
        return false;
    }

    c = sc_str_create_len(*str + start, end - start);
    if (c == NULL) {
        return false;
    }

    sc_str_destroy(*str);
    *str = c;

    return true;
}

bool sc_str_replace(char **str, const char *replace, const char *with)
{
    assert(replace != NULL && with != NULL);

    if (*str == NULL) {
        return true;
    }

    size_t replace_len = strlen(replace);
    size_t with_len = strlen(with);
    int64_t diff;
    size_t len_unmatch;
    size_t count, size;
    struct sc_str *dest;
    struct sc_str *meta = sc_str_meta(*str);
    char *orig = *str;
    char *orig_end = *str + meta->len;
    char *tmp;

    if (replace_len >= UINT32_MAX || with_len >= UINT32_MAX) {
        return false;
    }

    diff = (int64_t) with_len - (int64_t) replace_len;

    // Fast path, same size replacement.
    if (diff == 0) {
        while ((orig = strstr(orig, replace)) != NULL) {
            memcpy(orig, with, replace_len);
            orig += replace_len;
        }

        return true;
    }

    // Calculate new string size.
    tmp = orig;
    size = meta->len;
    for (count = 0; (tmp = strstr(tmp, replace)) != NULL; count++) {
        tmp += replace_len;
        // Check overflow.
        if ((int64_t) size > (int64_t) SC_SIZE_MAX - diff) {
            return false;
        }
        size += diff;
    }

    // No match.
    if (count == 0) {
        return true;
    }

    dest = sc_str_malloc(sc_str_bytes(size));
    if (!dest) {
        return false;
    }

    dest->len = (uint32_t) size;
    tmp = dest->buf;

    while (count--) {
        len_unmatch = strstr(orig, replace) - orig;
        memcpy(tmp, orig, len_unmatch);
        tmp += len_unmatch;

        memcpy(tmp, with, with_len);
        tmp += with_len;
        orig += len_unmatch + replace_len;
    }

    memcpy(tmp, orig, orig_end - orig + 1);

    sc_str_destroy(*str);
    *str = dest->buf;

    return true;
}