MtFmt: inc/mm_string.h 源文件

浏览该文件的文档.
// SPDX-License-Identifier: LGPL-3.0
#if !defined(_INCLUDE_MM_STRING_H_)
#define _INCLUDE_MM_STRING_H_ 1
#include "mm_cfg.h"
#include "mm_result.h"
#include "mm_type.h"
 
#define MSTR_STACK_REGION_SIZE 16
 
typedef enum tagMStringReplaceOption
{
    MStringReplaceOption_StartWith,
 
    MStringReplaceOption_EndWith,
 
    MStringReplaceOption_All,
} MStringReplaceOption;
 
typedef struct tagMStringMatchResult
{
    usize_t is_matched;
 
    usize_t begin_pos;
 
    usize_t begin_offset;
} MStringMatchResult;
 
typedef struct tagMString
{
    char* buff;
 
    char stack_region[MSTR_STACK_REGION_SIZE];
 
    usize_t count;
 
    usize_t length;
 
    usize_t cap_size;
} MString;
 
typedef struct tagMStringIter
{
    const char* it;
 
    const char* it_end;
 
    usize_t rem_length;
} MStringIter;
 
#define mstr_init(pstr)                            \
    do {                                           \
        (pstr)->count = 0;                         \
        (pstr)->length = 0;                        \
        (pstr)->buff = (pstr)->stack_region;       \
        (pstr)->cap_size = MSTR_STACK_REGION_SIZE; \
    } while (0)
 
MSTR_EXPORT_API(mstr_result_t)
mstr_create(MString* str, const char* content);
 
#define mstr_create_empty(s) mstr_create(s, "")
 
MSTR_EXPORT_API(void)
mstr_move_from(MString* str, MString* other);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_copy_from(MString* str, const MString* other);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_reserve(MString* str, usize_t new_size);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_concat(MString* str, const MString* other);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_concat_cstr(MString* str, const char* other);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_concat_cstr_slice(
    MString* str, const char* start, const char* end
);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_append(MString* str, mstr_codepoint_t ch);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_repeat_append(MString* str, mstr_codepoint_t ch, usize_t cnt);
 
MSTR_EXPORT_API(void) mstr_clear(MString* str);
 
MSTR_EXPORT_API(void) mstr_reverse_self(MString* str);
 
MSTR_EXPORT_API(void) mstr_reverse_only(MString* str);
 
MSTR_EXPORT_API(const char*) mstr_c_str(MString* str);
 
MSTR_EXPORT_API(mstr_bool_t)
mstr_equal(const MString* a, const MString* b);
 
MSTR_EXPORT_API(mstr_bool_t)
mstr_equal_cstr(const MString* a, const mstr_char_t* b, usize_t b_cnt);
 
MSTR_EXPORT_API(mstr_bool_t)
mstr_start_with(
    const MString* str, const char* prefix, usize_t prefix_cnt
);
 
MSTR_EXPORT_API(mstr_bool_t)
mstr_end_with(
    const MString* str, const char* suffix, usize_t suffix_cnt
);
 
MSTR_EXPORT_API(mstr_bool_t)
mstr_contains(
    const MString* str, const char* pattern, usize_t pattern_cnt
);
 
MSTR_EXPORT_API(mstr_codepoint_t)
mstr_char_at(const MString* str, usize_t idx);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_remove(MString* str, mstr_codepoint_t* removed_ch, usize_t idx);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_insert(MString* str, usize_t idx, mstr_codepoint_t ch);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_find(
    const MString* str,
    MStringMatchResult* f_res,
    usize_t begin_pos,
    const char* pattern,
    usize_t pattern_cnt
);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_retain(
    MString* str,
    MStringReplaceOption opt,
    const char* pattern,
    usize_t pattern_cnt
);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_replace(
    MString* str,
    MStringReplaceOption opt,
    const char* pattern,
    usize_t pattern_cnt,
    const char* replace_to,
    usize_t replace_to_cnt
);
 
MSTR_EXPORT_API(void) mstr_iter(MStringIter* it, const MString* str);
 
#define mstr_iter_move_next(it)                      \
    do {                                             \
        usize_t step = mstr_char_length(*((it).it)); \
        (it).it += step;                             \
        (it).rem_leng -= 1;                          \
    } while (0)
 
#define mstr_iter_is_end(it) ((it).it == (it).it_end)
 
MSTR_EXPORT_API(usize_t) mstr_char_length(char lead);
 
MSTR_EXPORT_API(usize_t)
mstr_lead_char_offset(const mstr_char_t* buff, usize_t hist_len);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_as_utf8(
    mstr_codepoint_t code, mstr_char_t* result, usize_t* result_len
);
 
MSTR_EXPORT_API(mstr_result_t)
mstr_codepoint_of(
    mstr_codepoint_t* code, const mstr_char_t* ch, usize_t byte_count
);
 
MSTR_EXPORT_API(usize_t)
mstr_char_offset_at(const MString* str, usize_t idx);
 
MSTR_EXPORT_API(void) mstr_free(MString* str);
 
#endif // _INCLUDE_MM_STRING_H_