Refactor strings and allocator to primitives

src/primitives/strings/str8/str8.h

@@ -0,0 +1,103 @@
+#ifndef STR8_H
+#define STR8_H
+
+#include "../../../common/aliases/aliases.h"
+#include "../../../common/platform/platform.h"
+#include "../../../primitives/dbl_list/dbl_list.h"
+#include "../../mem_allocator/mem_allocator.h"
+#include <string.h>
+#include <stdbool.h>
+
+#ifdef WAPP_PLATFORM_CPP
+BEGIN_C_LINKAGE
+#endif // !WAPP_PLATFORM_CPP
+
+typedef struct str8 Str8;
+struct str8 {
+  u64 capacity;
+  u64 size;
+  c8 *buf;
+};
+
+typedef const Str8 Str8RO;
+
+/**
+ * Utilities to be used with printf functions
+ */
+#define WAPP_STR8_SPEC "%.*s"
+#define wapp_str8_varg(STRING) (int)((STRING).size), (STRING).buf
+
+/**
+ * Str8 stack buffers
+ */
+#define wapp_str8_buf(CAPACITY) ((Str8){.capacity = CAPACITY, .size = 0, .buf = (c8[CAPACITY]){0}})
+
+// Utilises the fact that memcpy returns pointer to dest buffer and that getting
+// address of compound literals is valid in C to create a string on the stack
+#define wapp_str8_lit(STRING) ((Str8){.capacity = (sizeof(STRING) - 1) * 2, \
+                                      .size     = sizeof(STRING) - 1,       \
+                                      .buf      = memcpy(&((c8 [sizeof(STRING) * 2]){0}), STRING, sizeof(STRING))})
+#define wapp_str8_lit_ro(STRING) ((Str8RO){.capacity = sizeof(STRING) - 1, \
+                                           .size     = sizeof(STRING) - 1, \
+                                           .buf      = (c8 *)STRING})
+// To be used only when initialising a static storage variable in compilers that don't support
+// initialisers with the syntax of wapp_str8_lit_ro (e.g. gcc). Should only be used when necessary
+// and only be assigned to a Str8RO variable to avoid any attempt at modifying the string
+#define wapp_str8_lit_ro_initialiser_list(STRING) {.capacity = sizeof(STRING) - 1, \
+                                                   .size     = sizeof(STRING) - 1, \
+                                                   .buf      = (c8 *)STRING}
+
+/**
+ * Str8 allocated buffers
+ */
+Str8 *wapp_str8_alloc_buf(const Allocator *allocator, u64 capacity);
+Str8 *wapp_str8_alloc_cstr(const Allocator *allocator, const char *str);
+Str8 *wapp_str8_alloc_str8(const Allocator *allocator, Str8RO *str);
+Str8 *wapp_str8_alloc_substr(const Allocator *allocator, Str8RO *str, u64 start, u64 end);
+Str8 *wapp_str8_alloc_concat(const Allocator *allocator, Str8 *dst, Str8RO *src);
+// Only needed for allocators like malloc where each allocation has to be freed on its own.
+// No need to use it for allocators like Arena.
+void wapp_str8_dealloc_buf(const Allocator *allocator, Str8 **str);
+
+/**
+ * Str8 utilities
+ */
+c8   wapp_str8_get(Str8RO *str, u64 index);
+void wapp_str8_set(Str8 *str, u64 index, c8 c);
+void wapp_str8_push_back(Str8 *str, c8 c);
+bool wapp_str8_equal(Str8RO *s1, Str8RO *s2);
+bool wapp_str8_equal_to_count(Str8RO* s1, Str8RO* s2, u64 count);
+Str8 wapp_str8_slice(Str8RO *str, u64 start, u64 end);
+void wapp_str8_concat_capped(Str8 *dst, Str8RO *src);
+void wapp_str8_copy_cstr_capped(Str8 *dst, const char *src);
+void wapp_str8_copy_str8_capped(Str8 *dst, Str8RO *src);
+void wapp_str8_copy_to_cstr(char *dst, Str8RO *src, u64 dst_capacity);
+void wapp_str8_format(Str8 *dst, const char *format, ...);
+
+/**
+ * Str8 find functions
+ */
+i64 wapp_str8_find(Str8RO *str, Str8RO substr);
+i64 wapp_str8_rfind(Str8RO *str, Str8RO substr);
+
+/**
+ * Str8 split and join
+ */
+#define wapp_str8_split(ALLOCATOR, STR, DELIMITER) wapp_str8_split_with_max(ALLOCATOR, STR, DELIMITER, -1)
+#define wapp_str8_rsplit(ALLOCATOR, STR, DELIMITER) wapp_str8_rsplit_with_max(ALLOCATOR, STR, DELIMITER, -1)
+Str8List *wapp_str8_split_with_max(const Allocator *allocator, Str8RO *str, Str8RO *delimiter, i64 max_splits);
+Str8List *wapp_str8_rsplit_with_max(const Allocator *allocator, Str8RO *str, Str8RO *delimiter, i64 max_splits);
+Str8     *wapp_str8_join(const Allocator *allocator, const Str8List *list, Str8RO *delimiter);
+
+/**
+ * Str8 list utilities
+ */
+#define wapp_str8_node_from_cstr(STRING) wapp_str8_list_node(&wapp_str8_lit(STRING))
+#define wapp_str8_node_from_str8(STRING) wapp_str8_list_node(&(STRING))
+u64 wapp_str8_list_total_size(const Str8List *list);
+
+#ifdef WAPP_PLATFORM_CPP
+END_C_LINKAGE
+#endif // !WAPP_PLATFORM_CPP
+
+#endif // !STR8_H