string.h

Go to the documentation of this file.

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2021 Mike Becker, Olaf Wintermann All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef UCX_STRING_H
#define UCX_STRING_H
 
#include "common.h"
#include "allocator.h"
 
struct cx_mutstr_s {
    char *ptr;
    size_t length;
};
 
typedef struct cx_mutstr_s cxmutstr;
 
struct cx_string_s {
    char const *ptr;
    size_t length;
};
 
typedef struct cx_string_s cxstring;
 
struct cx_strtok_ctx_s {
    cxstring str;
    cxstring delim;
    cxstring const *delim_more;
    size_t delim_more_count;
    size_t pos;
    size_t delim_pos;
    size_t next_pos;
    size_t found;
    size_t limit;
};
 
typedef struct cx_strtok_ctx_s CxStrtokCtx;
 
#ifdef __cplusplus
extern "C" {
 
#define CX_STR(literal) cxstring{literal, sizeof(literal) - 1}
 
#else // __cplusplus
 
#define CX_STR(literal) (cxstring){literal, sizeof(literal) - 1}
 
#endif
 
 
__attribute__((__warn_unused_result__, __nonnull__))
cxmutstr cx_mutstr(char *cstring);
 
__attribute__((__warn_unused_result__))
cxmutstr cx_mutstrn(
        char *cstring,
        size_t length
);
 
__attribute__((__warn_unused_result__, __nonnull__))
cxstring cx_str(char const *cstring);
 
 
__attribute__((__warn_unused_result__))
cxstring cx_strn(
        char const *cstring,
        size_t length
);
 
__attribute__((__warn_unused_result__))
cxstring cx_strcast(cxmutstr str);
 
__attribute__((__nonnull__))
void cx_strfree(cxmutstr *str);
 
__attribute__((__nonnull__))
void cx_strfree_a(
        CxAllocator const *alloc,
        cxmutstr *str
);
 
__attribute__((__warn_unused_result__))
size_t cx_strlen(
        size_t count,
        ...
);
 
__attribute__((__warn_unused_result__, __nonnull__))
cxmutstr cx_strcat_ma(
        CxAllocator const *alloc,
        cxmutstr str,
        size_t count,
        ...
);
 
#define cx_strcat_a(alloc, count, ...) \
cx_strcat_ma(alloc, cx_mutstrn(NULL, 0), count, __VA_ARGS__)
 
#define cx_strcat(count, ...) \
cx_strcat_ma(cxDefaultAllocator, cx_mutstrn(NULL, 0), count, __VA_ARGS__)
 
#define cx_strcat_m(str, count, ...) \
cx_strcat_ma(cxDefaultAllocator, str, count, __VA_ARGS__)
 
__attribute__((__warn_unused_result__))
cxstring cx_strsubs(
        cxstring string,
        size_t start
);
 
__attribute__((__warn_unused_result__))
cxstring cx_strsubsl(
        cxstring string,
        size_t start,
        size_t length
);
 
__attribute__((__warn_unused_result__))
cxmutstr cx_strsubs_m(
        cxmutstr string,
        size_t start
);
 
__attribute__((__warn_unused_result__))
cxmutstr cx_strsubsl_m(
        cxmutstr string,
        size_t start,
        size_t length
);
 
__attribute__((__warn_unused_result__))
cxstring cx_strchr(
        cxstring string,
        int chr
);
 
__attribute__((__warn_unused_result__))
cxmutstr cx_strchr_m(
        cxmutstr string,
        int chr
);
 
__attribute__((__warn_unused_result__))
cxstring cx_strrchr(
        cxstring string,
        int chr
);
 
__attribute__((__warn_unused_result__))
cxmutstr cx_strrchr_m(
        cxmutstr string,
        int chr
);
 
__attribute__((__warn_unused_result__))
cxstring cx_strstr(
        cxstring haystack,
        cxstring needle
);
 
__attribute__((__warn_unused_result__))
cxmutstr cx_strstr_m(
        cxmutstr haystack,
        cxstring needle
);
 
__attribute__((__warn_unused_result__, __nonnull__))
size_t cx_strsplit(
        cxstring string,
        cxstring delim,
        size_t limit,
        cxstring *output
);
 
__attribute__((__warn_unused_result__, __nonnull__))
size_t cx_strsplit_a(
        CxAllocator const *allocator,
        cxstring string,
        cxstring delim,
        size_t limit,
        cxstring **output
);
 
 
__attribute__((__warn_unused_result__, __nonnull__))
size_t cx_strsplit_m(
        cxmutstr string,
        cxstring delim,
        size_t limit,
        cxmutstr *output
);
 
__attribute__((__warn_unused_result__, __nonnull__))
size_t cx_strsplit_ma(
        CxAllocator const *allocator,
        cxmutstr string,
        cxstring delim,
        size_t limit,
        cxmutstr **output
);
 
__attribute__((__warn_unused_result__))
int cx_strcmp(
        cxstring s1,
        cxstring s2
);
 
__attribute__((__warn_unused_result__))
int cx_strcasecmp(
        cxstring s1,
        cxstring s2
);
 
__attribute__((__warn_unused_result__, __nonnull__))
int cx_strcmp_p(
        void const *s1,
        void const *s2
);
 
__attribute__((__warn_unused_result__, __nonnull__))
int cx_strcasecmp_p(
        void const *s1,
        void const *s2
);
 
 
__attribute__((__warn_unused_result__, __nonnull__))
cxmutstr cx_strdup_a(
        CxAllocator const *allocator,
        cxstring string
);
 
#define cx_strdup(string) cx_strdup_a(cxDefaultAllocator, string)
 
 
#define cx_strdup_ma(allocator, string) cx_strdup_a(allocator, cx_strcast(string))
 
#define cx_strdup_m(string) cx_strdup_a(cxDefaultAllocator, cx_strcast(string))
 
__attribute__((__warn_unused_result__))
cxstring cx_strtrim(cxstring string);
 
__attribute__((__warn_unused_result__))
cxmutstr cx_strtrim_m(cxmutstr string);
 
__attribute__((__warn_unused_result__))
bool cx_strprefix(
        cxstring string,
        cxstring prefix
);
 
__attribute__((__warn_unused_result__))
bool cx_strsuffix(
        cxstring string,
        cxstring suffix
);
 
__attribute__((__warn_unused_result__))
bool cx_strcaseprefix(
        cxstring string,
        cxstring prefix
);
 
__attribute__((__warn_unused_result__))
bool cx_strcasesuffix(
        cxstring string,
        cxstring suffix
);
 
void cx_strlower(cxmutstr string);
 
void cx_strupper(cxmutstr string);
 
__attribute__((__warn_unused_result__, __nonnull__))
cxmutstr cx_strreplacen_a(
        CxAllocator const *allocator,
        cxstring str,
        cxstring pattern,
        cxstring replacement,
        size_t replmax
);
 
#define cx_strreplacen(str, pattern, replacement, replmax) \
cx_strreplacen_a(cxDefaultAllocator, str, pattern, replacement, replmax)
 
#define cx_strreplace_a(allocator, str, pattern, replacement) \
cx_strreplacen_a(allocator, str, pattern, replacement, SIZE_MAX)
 
#define cx_strreplace(str, pattern, replacement) \
cx_strreplacen_a(cxDefaultAllocator, str, pattern, replacement, SIZE_MAX)
 
__attribute__((__warn_unused_result__))
CxStrtokCtx cx_strtok(
        cxstring str,
        cxstring delim,
        size_t limit
);
 
__attribute__((__warn_unused_result__))
CxStrtokCtx cx_strtok_m(
        cxmutstr str,
        cxstring delim,
        size_t limit
);
 
__attribute__((__warn_unused_result__, __nonnull__))
bool cx_strtok_next(
        CxStrtokCtx *ctx,
        cxstring *token
);
 
__attribute__((__warn_unused_result__, __nonnull__))
bool cx_strtok_next_m(
        CxStrtokCtx *ctx,
        cxmutstr *token
);
 
__attribute__((__nonnull__))
void cx_strtok_delim(
        CxStrtokCtx *ctx,
        cxstring const *delim,
        size_t count
);
 
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif //UCX_STRING_H