string_utils.h

Go to the documentation of this file.

/*
 * Utility functions and macros for working with C ASCII strings.
 *
 *
 * Created by MacBook on 28.10.2024.
 */
 
#ifndef CLIBS_STRING_UTILS_H
#define CLIBS_STRING_UTILS_H
 
#include "headers/attributes.h" /* UseResult */
 
#include <regex.h>     /* regex_t */
#include <stdbool.h>   /* bool */
#include <sys/types.h> /* ssize_t */
 
/* include for user */
#include <string.h>
 

typedef const char *string_t;
typedef char *str_t;
 
 
#if __STDC_VERSION__ < 202311L && !defined( __APPLE__ )
#include <stdlib.h> /* malloc */
 
#define strndup string_nduplicate
#define strdup  string_duplicate

LibraryDefined UseResult str_t string_nduplicate( string_t s, size_t l )
{
    str_t n = malloc( l + 1 );
    if ( n == NULL )
        return NULL;
 
    strncpy( n, s, l );
    n[ l ] = '\0';
    return n;
}

LibraryDefined UseResult str_t string_duplicate( string_t s )
{
    size_t l = strlen( s );
    str_t n  = malloc( l + 1 );
    if ( n == NULL )
        return NULL;
 
    n[ l ] = '\0';
    strcpy( n, s );
    return n;
}
#endif // ndef strdup
 
#if ( !defined( _GNU_SOURCE ) && !defined( __APPLE__ ) ) \
        || defined( _POSIX_C_SOURCE ) // non-standard
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
 
#ifndef vsnprintf
int vsnprintf( char *str, size_t size, const char *restrict format, va_list ap );
#endif

LibraryDefined int vasprintf( str_t *strp, const string_t fmt, va_list args )
{
    va_list vaList;
    va_copy( vaList, args );
 
    int size = vsnprintf( NULL, ( size_t ) 0, fmt, args );
 
    if ( size < 0 )
        return size;
 
    *strp = malloc( size + 1 );
    if ( !*strp )
        return -1;
 
    const int result = vsnprintf( *strp, ( size_t ) size + 1, fmt, vaList );
    va_end( args );
 
    return result;
}

LibraryDefined int asprintf( str_t *strp, const string_t fmt, ... )
{
    va_list va;
    va_start( va, fmt );
    const int rv = vasprintf( strp, fmt, va );
    va_end( va );
    return rv;
}
#endif
 

bool string_is_blank( string_t );
bool string_is_blank_l( string_t, size_t len );

bool string_is_empty( string_t s );

UseResult str_t string_stripped( string_t );
UseResult str_t string_stripped_l( string_t, size_t length );
void string_strip( str_t );
 

#define ESCAPED_CHARS "\n\t\r\f\v\"\\"

UseResult str_t string_escaped( string_t );

UseResult str_t string_unescaped( string_t );

UseResult str_t string_reversed( string_t );
void string_reverse( str_t );
 

void string_to_upper( str_t );
UseResult str_t string_as_upper( string_t );

void string_to_lower( str_t );
UseResult str_t string_as_lower( string_t );
 

UseResult str_t string_replaced( string_t, string_t old, string_t new );

int string_replace( str_t string, string_t old, string_t new );
 
 
#define STRSPLIT_EXCLUDE_EMPTY     ( 1 << 0 )
#define STRSPLIT_KEEP_DELIM_BEFORE ( 1 << 1 )
#define STRSPLIT_KEEP_DELIM_AFTER  ( 1 << 2 )

#define STRSPLIT_STRIP_RESULTS ( 1 << 3 )
 

typedef unsigned int strsplit_mode_t;

ssize_t string_split( str_t **str_arr_cont,
                      string_t string,
                      string_t split_tok,
                      strsplit_mode_t mode );
ssize_t string_split_regex( str_t **str_arr_cont,
                            string_t string,
                            const regex_t *__restrict regexp,
                            strsplit_mode_t mode );

void string_split_destroy( size_t size, str_t **str_arr_cont );
 

UseResult str_t string_join( size_t len, const string_t strarr[ len ], string_t joiner );

typedef const string_t *strjoin_strarr_t;
 
 
/* ==== Mathematical stuff ==== */
 
UseResult char *add_uint_strings( const char *, const char * );
UseResult char *mul_uint_strings( const char *, const char * );
 
 
void string_strip_lead_zeroes( str_t );
 
UseResult str_t hex_to_decimal( string_t );
 
 
#endif //CLIBS_STRING_UTILS_H