183 lines
6.3 KiB
C
183 lines
6.3 KiB
C
#ifndef STRING_UTILS_H
|
|
#define STRING_UTILS_H
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
#include <ctype.h>
|
|
#include <string.h>
|
|
#include <stdbool.h>
|
|
#include <stdarg.h>
|
|
#include "collections.h"
|
|
#include "utf8proc/utf8proc.h"
|
|
#include "vector.h"
|
|
|
|
// NOTE: this particular implementation works only for ASCII strings
|
|
int string_compare_case_insensitive(const char *str1, const char *str2);
|
|
int string_compare_n_case_insensitive(const char *str1, const char *str2, size_t len);
|
|
int string_common_prefix(const char *str1, const char *str2);
|
|
|
|
void string_lower(char *str);
|
|
void string_upper(char *str);
|
|
|
|
bool string_starts_with(const char *str, const char *start);
|
|
bool string_ends_with(const char *str, const char *ending);
|
|
|
|
uint string_translate(char *str, size_t len, char *word_chars, char *word_repls, size_t trans_len);
|
|
|
|
char *utf8_reversed_string(const char *s); // returns a copy, caller frees
|
|
ssize_t utf8proc_iterate_reversed(const uint8_t *str, const uint8_t *start, int32_t *dst);
|
|
bool utf8_is_letter(int32_t ch);
|
|
|
|
size_t string_ltrim(char *str);
|
|
size_t string_rtrim(char *str);
|
|
size_t string_trim(char *str);
|
|
|
|
/* Caller has to free the original string,
|
|
also keep in mind that after operating on a char array,
|
|
the pointer to the original string may get realloc'd and change
|
|
so need to set the char pointer to array.a when done.
|
|
Consider a macro which does this consistently
|
|
*/
|
|
char_array *char_array_from_string(char *str);
|
|
char *char_array_get_string(char_array *array);
|
|
|
|
// Frees the char_array and returns a standard NUL-terminated string
|
|
char *char_array_to_string(char_array *array);
|
|
|
|
size_t char_array_len(char_array *array);
|
|
|
|
void char_array_append(char_array *array, char *str);
|
|
void char_array_append_len(char_array *array, char *str, size_t len);
|
|
void char_array_terminate(char_array *array);
|
|
|
|
char_array *char_array_copy(char_array *array);
|
|
|
|
// Similar to strcat, strips NUL-byte and guarantees 0-terminated
|
|
void char_array_cat(char_array *array, char *str);
|
|
void char_array_cat_len(char_array *array, char *str, size_t len);
|
|
|
|
// Strips NUL-byte but does not NUL-terminate
|
|
void char_array_cat_unterminated(char_array *array, char *str);
|
|
void char_array_cat_unterminated_len(char_array *array, char *str, size_t len);
|
|
|
|
// Cat with printf args
|
|
void char_array_cat_printf(char_array *array, char *format, ...);
|
|
|
|
void char_array_add_joined(char_array *array, char *separator, int count, ...);
|
|
void char_array_cat_joined(char_array *array, char *separator, int count, ...);
|
|
|
|
|
|
/*
|
|
cstring_arrays represent n strings stored contiguously, delimited by NUL-byte.
|
|
|
|
Instead of storing an array of char pointers (char **), cstring_arrays use this format:
|
|
|
|
array->indices = {0, 4, 9};
|
|
array->str = {'f', 'o', 'o', '\0', 'b', 'a', 'r', '\0', 'b', 'a', 'z', '\0'};
|
|
|
|
Each value in array->indices is the start position of a token in array->str. Each string
|
|
is NUL-terminated, so array->str->a + 4 is "bar", a valid NUL-terminated C string
|
|
|
|
array->str is a char_array, so all of the powerful methods like char_array_cat_printf above
|
|
can be used when building the contiguous string arrays as well.
|
|
|
|
*/
|
|
|
|
typedef struct {
|
|
uint32_array *indices;
|
|
char_array *str;
|
|
} cstring_array;
|
|
|
|
cstring_array *cstring_array_new(void);
|
|
|
|
cstring_array *cstring_array_new_size(size_t size);
|
|
|
|
size_t cstring_array_capacity(cstring_array *self);
|
|
size_t cstring_array_used(cstring_array *self);
|
|
size_t cstring_array_num_strings(cstring_array *self);
|
|
void cstring_array_resize(cstring_array *self, size_t size);
|
|
|
|
cstring_array *cstring_array_from_char_array(char_array *str);
|
|
|
|
cstring_array *cstring_array_split(char *str, const char *separator, size_t separator_len, int *count);
|
|
|
|
void cstring_array_join_strings(cstring_array *self, char *separator, int count, ...);
|
|
uint32_t cstring_array_start_token(cstring_array *self);
|
|
uint32_t cstring_array_add_string(cstring_array *self, char *str);
|
|
uint32_t cstring_array_add_string_len(cstring_array *self, char *str, size_t len);
|
|
|
|
|
|
void cstring_array_append_string(cstring_array *self, char *str);
|
|
void cstring_array_append_string_len(cstring_array *self, char *str, size_t len);
|
|
int32_t cstring_array_get_offset(cstring_array *self, uint32_t i);
|
|
char *cstring_array_get_token(cstring_array *self, uint32_t i);
|
|
int64_t cstring_array_token_length(cstring_array *self, uint32_t i);
|
|
|
|
void cstring_array_destroy(cstring_array *self);
|
|
|
|
/*
|
|
String trees are a way of storing alternative representations of a tokenized string concisely
|
|
|
|
Particularly with hyphens, we may want the string "twenty-five" to normalize to both:
|
|
|
|
twenty five
|
|
twentyfive
|
|
|
|
so when we encounter "twenty-five", we'd propose both alternative representations as possible
|
|
normalizations of the token.
|
|
|
|
string_tree is similar to a CSR (compressed sparse row) sparse matrix.
|
|
|
|
@tokens - for token i, tree->tokens[i] is the index in strings->indices where token i's alternatives begin
|
|
@strings - a contiguous string array which only contains as many tokens as there are alternatives
|
|
|
|
Since we typically only normalize on mid-word hyphens, periods and non-ASCII characters, a string_tree
|
|
might not need to store anything at all in many languages.
|
|
|
|
*/
|
|
|
|
typedef struct string_tree {
|
|
uint32_array *token_indices;
|
|
cstring_array *strings;
|
|
} string_tree_t;
|
|
|
|
string_tree_t *string_tree_new(void);
|
|
string_tree_t *string_tree_new_size(size_t size);
|
|
|
|
// finalize
|
|
void string_tree_finalize_token(string_tree_t *self);
|
|
// terminated
|
|
void string_tree_add_string(string_tree_t *self, char *str);
|
|
void string_tree_add_string_len(string_tree_t *self, char *str, size_t len);
|
|
// unterminated
|
|
void string_tree_append_string(string_tree_t *self, char *str);
|
|
void string_tree_append_string_len(string_tree_t *self, char *str, size_t len);
|
|
|
|
uint32_t string_tree_num_alternatives(string_tree_t *self, uint32_t i);
|
|
|
|
void string_tree_destroy(string_tree_t *self);
|
|
|
|
typedef struct string_tree_iterator {
|
|
string_tree_t *tree;
|
|
uint32_t *path;
|
|
uint32_t *num_alternatives;
|
|
uint32_t num_tokens;
|
|
uint32_t cursor;
|
|
int8_t direction; // 1 or -1
|
|
uint32_t remaining;
|
|
} string_tree_iterator_t;
|
|
|
|
string_tree_iterator_t *string_tree_iterator_new(string_tree_t *tree);
|
|
void string_tree_iterator_next(string_tree_iterator_t *self);
|
|
char *string_tree_iterator_get_string(string_tree_iterator_t *self, uint32_t i);
|
|
bool string_tree_iterator_done(string_tree_iterator_t *self);
|
|
void string_tree_iterator_destroy(string_tree_iterator_t *self);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif
|