kmx git

/* kc3
 * Copyright 2022,2023,2024 kmx.io <contact@kmx.io>
 *
 * Permission is hereby granted to use this software granted the above
 * copyright notice and this permission paragraph are included in all
 * copies and substantial portions of this software.
 *
 * THIS SOFTWARE IS PROVIDED "AS-IS" WITHOUT ANY GUARANTEE OF
 * PURPOSE AND PERFORMANCE. IN NO EVENT WHATSOEVER SHALL THE
 * AUTHOR BE CONSIDERED LIABLE FOR THE USE AND PERFORMANCE OF
 * THIS SOFTWARE.
 */
/**
 * @file str.h
 * @brief Byte string manipulation functions.
 *
 * Structure to manipulate byte strings.
 */
#ifndef LIBKC3_STR_H
#define LIBKC3_STR_H

#include <stdarg.h>
#include <stdio.h>
#include "hash.h"
#include "types.h"

#define STR_MAX (16 * 1024 * 1024)

#define PROTOTYPE_STR_INIT(name, type)                          \
  s_str * str_init_ ## name (s_str *str, type x)

#define PROTOTYPE_STR_INIT_INT(type)                            \
  s_str * str_init_ ## type (s_str *str, type x)

#define PROTOTYPE_STR_INIT_STRUCT(type)                         \
  s_str * str_init_ ## type (s_str *str, const s_ ## type *x)

/* Stack allocation compatible functions */
void    str_clean (s_str *str);
s_str * str_init (s_str *str, char *free, uw size, const char *p);
s_str * str_init_1 (s_str *str, char *free, const char *p);
s_str * str_init_1_alloc (s_str *str, const char *p);
s_str * str_init_alloc (s_str *str, uw size);
s_str * str_init_alloc_copy (s_str *str, uw size, const char *p);
PROTOTYPE_STR_INIT_STRUCT(array);
s_str * str_init_cast (s_str *str, const s_sym * const *type,
                       const s_tag *tag);
s_str * str_init_concatenate (s_str *str, const s_str *a,
                              const s_str *b);
s_str * str_init_concatenate_list (s_str *str,
                                   const s_list * const *list);
s_str * str_init_character (s_str *str, const character src);
s_str * str_init_copy (s_str *str, const s_str *src);
s_str * str_init_copy_1 (s_str *str, const char *p);
s_str * str_init_empty (s_str *str);
s_str * str_init_f (s_str *str, const char *fmt, ...);
PROTOTYPE_STR_INIT_STRUCT(fn);
s_str * str_init_ftime (s_str *str, s_time *time, const s_str *format);
PROTOTYPE_STR_INIT(list, const s_list * const *);
PROTOTYPE_STR_INIT_STRUCT(map);
PROTOTYPE_STR_INIT(ptr, const u_ptr_w *);
PROTOTYPE_STR_INIT(ptr_free, const u_ptr_w *);
PROTOTYPE_STR_INIT_INT(s8);
PROTOTYPE_STR_INIT_INT(s16);
PROTOTYPE_STR_INIT_INT(s32);
PROTOTYPE_STR_INIT_INT(s64);
s_str * str_init_slice (s_str *str, const s_str *src, sw start, sw end);
s_str * str_init_slice_utf8 (s_str *str, const s_str *src, sw start,
                             sw end);
s_str * str_init_subst (s_str *str, const s_str *src,
                        const s_str *search, const s_str *replace);
sw      str_init_subst_size (const s_str *src, const s_str *search,
                             const s_str *replace);
PROTOTYPE_STR_INIT_STRUCT(struct);
PROTOTYPE_STR_INIT_INT(sw);
s_str * str_init_to_lower (s_str *str, const s_str *src);
s_str * str_init_to_upper (s_str *str, const s_str *src);
PROTOTYPE_STR_INIT_STRUCT(tuple);
PROTOTYPE_STR_INIT_INT(u8);
PROTOTYPE_STR_INIT_INT(u16);
PROTOTYPE_STR_INIT_INT(u32);
PROTOTYPE_STR_INIT_INT(u64);
PROTOTYPE_STR_INIT_INT(uw);
PROTOTYPE_STR_INIT_STRUCT(var);
s_str * str_init_vf (s_str *str, const char *fmt, va_list ap);

/* Constructors, call str_delete after use */
s_str * str_new (char *free, uw size, const char *p);
s_str * str_new_1 (char *free, const char *p);
s_str * str_new_cpy (const char *p, uw size);
s_str * str_new_copy (const s_str *src);
s_str * str_new_empty (void);
s_str * str_new_f (const char *fmt, ...);
s_str * str_new_vf (const char *fmt, va_list ap);

/* Destructor */
void str_delete (s_str *str);

/* Observers */
sw            str_character (const s_str *str, uw position,
                             character *dest);
character     str_character_escape (character c);
bool          str_character_is_reserved (character c);
sw            str_character_position (const s_str *str, character c);
bool *        str_ends_with (const s_str *str, const s_str *end,
                             bool *dest);
bool *        str_has_reserved_characters (const s_str *src,
                                           bool *dest);
bool *        str_has_str (const s_str *src, const s_str *search,
                           bool *dest);
sw            str_length_utf8 (const s_str *str);
bool          str_parse_eval (const s_str *str, s_tag *dest);
sw            str_peek_bool (const s_str *str, bool *dest);
sw            str_peek_character_utf8 (const s_str *str, character *dest);
sw            str_peek_f32 (const s_str *str, f32 *dest);
sw            str_peek_f64 (const s_str *str, f64 *dest);
sw            str_peek_s8 (const s_str *str, s8 *dest);
sw            str_peek_s16 (const s_str *str, s16 *dest);
sw            str_peek_s32 (const s_str *str, s32 *dest);
sw            str_peek_s64 (const s_str *str, s64 *dest);
sw            str_peek_str (const s_str *str, s_str *dest);
sw            str_peek_sym (const s_str *str, s_sym *dest);
sw            str_peek_u8 (const s_str *str, u8 *dest);
sw            str_peek_u16 (const s_str *str, u16 *dest);
sw            str_peek_u32 (const s_str *str, u32 *dest);
sw            str_peek_u64 (const s_str *str, u64 *dest);
sw            str_position_1 (const s_str *str, const char *token);
sw            str_rindex_character (const s_str *str, character c);
s_list **     str_split (const s_str *str, const s_str *separator,
                         s_list **dest);
bool *        str_starts_with (const s_str *str, const s_str *start,
                               bool *dest);
uw *          str_sw_pos_to_uw (sw pos, uw max_pos, uw *dest);
s_str *       str_to_hex (const s_str *str, s_str *dest);
s_ident *     str_to_ident (const s_str *str, s_ident *dest);
const s_sym * str_to_sym (const s_str *str);

/* Modifiers */
sw str_read_u8 (s_str *str, u8 *dest);
sw str_read_character_utf8 (s_str *str, character *c);

#endif /* LIBKC3_STR_H */
kc3-lang/kc3/libkc3/str.h

Commit

libkc3/str.h
