amxc_string.h

Go to the documentation of this file.

/****************************************************************************
**
** SPDX-License-Identifier: BSD-2-Clause-Patent
**
** SPDX-FileCopyrightText: Copyright (c) 2023 SoftAtHome
**
** 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.
**
** Subject to the terms and conditions of this license, each copyright holder
** and contributor hereby grants to those receiving rights under this license
** a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable
** (except for failure to satisfy the conditions of this license) patent license
** to make, have made, use, offer to sell, sell, import, and otherwise transfer
** this software, where such license applies only to those patent claims, already
** acquired or hereafter acquired, licensable by such copyright holder or contributor
** that are necessarily infringed by:
**
** (a) their Contribution(s) (the licensed copyrights of copyright holders and
** non-copyrightable additions of contributors, in source or binary form) alone;
** or
**
** (b) combination of their Contribution(s) with the work of authorship to which
** such Contribution(s) was added by such copyright holder or contributor, if,
** at the time the Contribution is added, such addition causes such combination
** to be necessarily infringed. The patent license shall not apply to any other
** combinations which include the Contribution.
**
** Except as expressly stated above, no rights or licenses from any copyright
** holder or contributor is granted under this license, whether expressly, by
** implication, estoppel or otherwise.
**
** DISCLAIMER
**
** 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 HOLDERS 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.
**
****************************************************************************/
 
#if !defined(__AMXC_STRING_H__)
#define __AMXC_STRING_H__
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stddef.h>
#include <stdbool.h>
#include <stdint.h>
#include <stdarg.h>
 
#include <amxc/amxc_common.h>
#include <amxc/amxc_llist.h>
 
#define AMXC_STRING_MAX SIZE_MAX
 
 
#define amxc_string_from_llist_it(ll_it) \
    amxc_container_of(ll_it, amxc_string_t, it)
 
typedef struct _amxc_string {
    char* buffer;                  
    size_t length;                 
    size_t last_used;              
    amxc_llist_it_t it;            
} amxc_string_t;
 
typedef enum _amxc_string_flags {
    amxc_string_no_flags  = 0x00,   
    amxc_string_insert = 0x00,      
    amxc_string_overwrite = 0x01    
} amxc_string_flags_t;
 
typedef int (* amxc_string_is_char_fn_t) (int c);
 
typedef bool (* amxc_string_is_safe_cb_t) (const char* replacement);
 
int amxc_string_new(amxc_string_t** string, const size_t length);
 
void amxc_string_delete(amxc_string_t** string);
 
int amxc_string_init(amxc_string_t* const string, const size_t length);
 
void amxc_string_clean(amxc_string_t* const string);
 
void amxc_string_reset(amxc_string_t* const string);
 
int amxc_string_copy(amxc_string_t* const dest,
                     const amxc_string_t* const src);
 
int amxc_string_grow(amxc_string_t* const string, const size_t length);
 
int amxc_string_shrink(amxc_string_t* const string,
                       const size_t length);
 
int amxc_string_set_at(amxc_string_t* const string,
                       const size_t pos,
                       const char* const text,
                       const size_t length,
                       const amxc_string_flags_t flags);
 
int amxc_string_remove_at(amxc_string_t* const string,
                          const size_t pos,
                          size_t length);
 
const char* amxc_string_get(const amxc_string_t* const string,
                            const size_t offset);
 
char* amxc_string_take_buffer(amxc_string_t* const string);
 
int amxc_string_push_buffer(amxc_string_t* const string,
                            char* buffer,
                            size_t length);
 
char* amxc_string_dup(const amxc_string_t* const string,
                      const size_t start,
                      size_t length);
 
void amxc_string_triml(amxc_string_t* const string, amxc_string_is_char_fn_t fn);
 
void amxc_string_trimr(amxc_string_t* const string, amxc_string_is_char_fn_t fn);
 
void amxc_string_trim(amxc_string_t* const string, amxc_string_is_char_fn_t fn);
 
int amxc_string_vsetf(amxc_string_t* const string, const char* fmt, va_list ap);
 
int amxc_string_setf(amxc_string_t* const string, const char* fmt, ...) \
    __attribute__ ((format(printf, 2, 3)));
 
int amxc_string_vsetf_checked(amxc_string_t* const string,
                              amxc_string_is_safe_cb_t is_safe_cb,
                              const char* fmt,
                              va_list args);
 
int amxc_string_setf_checked(amxc_string_t* target_string,
                             amxc_string_is_safe_cb_t is_safe_cb,
                             const char* fmt, ...) \
    __attribute__ ((format(printf, 3, 4)));
int amxc_string_vappendf(amxc_string_t* const string,
                         const char* fmt,
                         va_list ap);
 
int amxc_string_appendf(amxc_string_t* const string, const char* fmt, ...) \
    __attribute__ ((format(printf, 2, 3)));
 
int amxc_string_vappendf_checked(amxc_string_t* target_string,
                                 amxc_string_is_safe_cb_t is_safe_cb,
                                 const char* fmt, va_list args);
 
int amxc_string_appendf_checked(amxc_string_t* string,
                                amxc_string_is_safe_cb_t is_safe_cb,
                                const char* fmt, ...) \
    __attribute__ ((format(printf, 3, 4)));
 
int amxc_string_vprependf(amxc_string_t* const string,
                          const char* fmt,
                          va_list ap);
 
int amxc_string_prependf(amxc_string_t* const string, const char* fmt, ...) \
    __attribute__ ((format(printf, 2, 3)));
 
bool amxc_string_is_numeric(const amxc_string_t* const string);
 
int amxc_string_search(const amxc_string_t* const string,
                       const char* needle,
                       uint32_t start_pos);
 
int amxc_string_replace(amxc_string_t* const string,
                        const char* needle,
                        const char* newstr,
                        uint32_t max);
 
int amxc_string_to_upper(amxc_string_t* const string);
 
int amxc_string_to_lower(amxc_string_t* const string);
 
AMXC_INLINE
int amxc_string_append(amxc_string_t* const string,
                       const char* const text,
                       const size_t length) {
    return amxc_string_set_at(string,
                              string != NULL ? string->last_used : 0,
                              text,
                              length,
                              amxc_string_no_flags);
}
 
AMXC_INLINE
int amxc_string_prepend(amxc_string_t* const string,
                        const char* const text,
                        const size_t length) {
    return amxc_string_set_at(string, 0, text, length, amxc_string_no_flags);
}
 
AMXC_INLINE
size_t amxc_string_buffer_length(const amxc_string_t* const string) {
    return string != NULL ? string->length : 0;
}
 
AMXC_INLINE
size_t amxc_string_text_length(const amxc_string_t* const string) {
    return string != NULL ? string->last_used : 0;
}
 
AMXC_INLINE
bool amxc_string_is_empty(const amxc_string_t* const string) {
    return string != NULL ? (string->last_used == 0) : true;
}
 
AMXC_INLINE
int amxc_string_insert_at(amxc_string_t* const string,
                          const size_t pos,
                          const char* text,
                          size_t length) {
    return amxc_string_set_at(string, pos, text, length, amxc_string_insert);
}
 
size_t amxc_string_set(amxc_string_t* const string, const char* text);
 
int amxc_string_bytes_2_hex_binary(amxc_string_t* const string,
                                   const char bytes[],
                                   const uint32_t len,
                                   const char* sep);
 
int amxc_string_hex_binary_2_bytes(const amxc_string_t* const string,
                                   char** bytes,
                                   uint32_t* len,
                                   const char* sep);
#ifdef __cplusplus
}
#endif
 
#endif // __AMXC_STRING_H__