string.h

Go to the documentation of this file.

#pragma once
 
/* ************************************************************************** */
/*      ____    _    _____ ____     _    _   _   _____ _  _   ____  ____      */
/*     / ___|  / \  |  ___|  _ \   / \  | \ | | |_   _| || | |  _ \/ ___|     */
/*     \___ \ / _ \ | |_  | |_) | / _ \ |  \| |   | | | || |_| | | \___ \     */
/*      ___) / ___ \|  _| |  _ < / ___ \| |\  |   | | |__   _| |_| |___) |    */
/*     |____/_/   \_|_|   |_| \_/_/   \_|_| \_|   |_|    |_| |____/|____/     */
/*                                                                            */
/* ************************************************************************** */
 
#include "o2s/array.h"
 
#include <stdbool.h> // bool
#include <stddef.h>  // size_t
#include <stdint.h>  // uint32_t
#include <string.h>  // strlen

typedef array_t string_t;

string_t        string_new(void);
string_t        string_from(const char* cstring, size_t length);
void            string_clear(string_t* self);

#define string_from_literal(StringLiteral) \
    string_from(StringLiteral, strlen(StringLiteral))

#define String __attribute__((cleanup(string_clear))) string_t

bool string_append_char(string_t* self, char character);
bool string_append_cstring(string_t* self, const char* cstring, size_t length);
bool string_append(string_t* self, const string_t* other);
 
__attribute__((format(printf, 2, 3)))
bool string_append_format(string_t* self, const char* format, ...);

#define string_append_literal(Self, StringLiteral) \
    string_append_cstring(Self, StringLiteral, strlen(StringLiteral))

bool     string_pop(string_t* self, char* destination);
bool     string_pop_n(string_t* self, char* destination, size_t count);
string_t string_pop_as_string(string_t* self, size_t count);
 
bool     string_pop_front(string_t* self, char* destination);
bool     string_pop_front_n(string_t* self, char* destination, size_t count);

size_t   string_length(const string_t* self);
char*    string_get(const string_t* self, size_t index);
bool     string_is_empty(const string_t* self);
char*    string_end(const string_t* self);
 
bool     string_reserve(string_t* self, size_t count);
bool     string_trim(string_t* self);

string_t string_map(const string_t* self, char (*function)(char));
string_t string_tolower(const string_t* self);
string_t string_toupper(const string_t* self);
 
void     string_apply_inplace(string_t* self, char (*function)(char));
void     string_tolower_inplace(string_t* self);
void     string_toupper_inplace(string_t* self);
 
bool     string_is_equal(const string_t* self, const string_t* other);
 
char*    string_to_cstring(string_t* self);
 
bool     string_contains(const string_t* self, char character);
bool     is_char_in_cstring(char character, const char* cstring);


#define string_foreach(STRING, Element) array_foreach (char, STRING, Element)

#define string_enumerate(STRING, Element, Index) \
    array_enumerate (char, STRING, Element, Index)


uint32_t cstring_fnv1a_32(const char* cstring, size_t length);
uint32_t string_fnv1a_32(const string_t* self);