From 80a734de03eaf3d534f95010653c47bf54389f48 Mon Sep 17 00:00:00 2001 From: Omniscient <17525998+omnisci3nce@users.noreply.github.com> Date: Sun, 25 Feb 2024 12:50:39 +1100 Subject: new string function signatures just dropped --- src/std/str.h | 59 +++++++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 51 insertions(+), 8 deletions(-) (limited to 'src/std/str.h') diff --git a/src/std/str.h b/src/std/str.h index 3d3cb41..d2fa891 100644 --- a/src/std/str.h +++ b/src/std/str.h @@ -1,30 +1,73 @@ /** - * @brief - * + * @file str.h + * @author your name (you@domain.com) + * @brief + * @version 0.1 + * @date 2024-02-25 + * + * @copyright Copyright (c) 2024 + * */ #pragma once #include "defines.h" +#include "mem.h" /** - * @brief Fat pointer representing a UTF8 (TODO) encoded string - * @note when using `printf` you must use %s.*s length, string + * @brief Fat pointer representing a UTF8 encoded string + * @note when using `printf` you must use %s.*s length, string until our own modified + print routines are written. alternatively wrap in `cstr()` and pass to `%s`. */ typedef struct { u8 *buf; size_t len; } str8; + +// --- Constructors + +/** @brief Take a string literal and turn it into a `str8` */ +#define str8lit(s) (str8){(u8 *)s, ((sizeof(s) / sizeof(*(s)) - 1))} + +str8 str8_create(u8* buf, size_t len); + +/** @brief Return a null-terminated C string cloned onto an arena */ +char* str8_to_cstr(arena* a, str8 s); + +#define cstr(a, s) (str8_to_cstr(a, s)) // Shorthand + +// --- Comparisons + /** @brief Compare two strings for exact equality */ bool str8_equals(str8 a, str8 b); /** * @brief Compare the first `first_nchars` of each string for equality - If either of the strings are shorter than the number only the characters up until the end - of the shorter string will be compared. + * @details If either of the strings are shorter than the number only the characters up until the end + of the shorter string will be compared. * @returns 0 if they are fully equal up until `first_nchars`, i.e they never differed, else it - returns the index at which the first string differed from the second string. + returns the index at which the first string differed from the second string. */ size_t str8_nequals(str8 a, str8 b, size_t first_nchars); -bool str8_ends_with(str8 input_str, str8 suffix); \ No newline at end of file +bool str8_ends_with(str8 input_str, str8 suffix); + +/// --- Subviews + +str8 str8_substr(str8 s, u64 min, u64 max); +/** @brief Keeps only the `first_n` chars of `s` */ +str8 str8_take(str8 s, u64 first_n); +/** @brief Keeps only the `last_n` chars of `s` */ +str8 str8_drop(str8 s, u64 last_n); +/** @brief Keeps everything after the first `n` chars of `s` */ +str8 str8_skip(str8 s, u64 n); +/** @brief Keeps everything before the last `n` chars of `s` */ +str8 str8_chop(str8 s, u64 n); + +str8 str8_concat(arena* a, str8 left, str8 right); + +/// --- Misc + +static inline bool str8_is_null_term(str8 a) { + return a.buf[a.len] == 0; // This doesn't seem safe. YOLO +} \ No newline at end of file -- cgit v1.2.3-70-g09d2 From 938f745f052c14fccaa987b98ea4ac84e70c1fcc Mon Sep 17 00:00:00 2001 From: Omniscient <17525998+omnisci3nce@users.noreply.github.com> Date: Sun, 25 Feb 2024 13:49:12 +1100 Subject: chore: format --- examples/standard_lib/ex_std.c | 30 ++++++++++++++++++++++++++++++ src/platform/file.h | 4 ++-- src/std/str.h | 20 ++++++++++---------- 3 files changed, 42 insertions(+), 12 deletions(-) create mode 100644 examples/standard_lib/ex_std.c (limited to 'src/std/str.h') diff --git a/examples/standard_lib/ex_std.c b/examples/standard_lib/ex_std.c new file mode 100644 index 0000000..9d474de --- /dev/null +++ b/examples/standard_lib/ex_std.c @@ -0,0 +1,30 @@ +#include +#include +#include "file.h" +#include "str.h" + +int main() { + // Examples of how to work with arenas and strings + size_t arena_size = 1024; + arena scratch = arena_create(malloc(arena_size), arena_size); + arena* a = &scratch; + + str8 hello = str8lit("Hello World"); + + // this works but we should be careful because str8 is not *guaranteed* to point to + // a null-terminated string + printf("String before: '%s' (null-terminated: %s) \n ", hello.buf, + str8_is_null_term(hello) ? "true" : "false"); + + char* c = str8_to_cstr(&scratch, hello); + + printf("String after: %s\n", c); + + str8_opt test_file = str8_from_file(&scratch, str8lit("assets/shaders/ui_rect.vert")); + if (test_file.has_value) { + printf("Contents: %.*s \n", (int)test_file.contents.len, test_file.contents.buf); + printf("Null-terminated: %s\n", str8_is_null_term(test_file.contents) ? "true" : "false"); + } + + return 0; +} diff --git a/src/platform/file.h b/src/platform/file.h index fa09891..8bb22c8 100644 --- a/src/platform/file.h +++ b/src/platform/file.h @@ -10,8 +10,8 @@ #include "str.h" typedef struct str8_opt { - str8 contents; - bool has_value; + str8 contents; + bool has_value; } str8_opt; const char* string_from_file(const char* path); diff --git a/src/std/str.h b/src/std/str.h index d2fa891..f6f8820 100644 --- a/src/std/str.h +++ b/src/std/str.h @@ -1,12 +1,12 @@ /** * @file str.h * @author your name (you@domain.com) - * @brief + * @brief * @version 0.1 * @date 2024-02-25 - * + * * @copyright Copyright (c) 2024 - * + * */ #pragma once @@ -19,22 +19,22 @@ print routines are written. alternatively wrap in `cstr()` and pass to `%s`. */ typedef struct { - u8 *buf; + u8* buf; size_t len; } str8; - // --- Constructors /** @brief Take a string literal and turn it into a `str8` */ -#define str8lit(s) (str8){(u8 *)s, ((sizeof(s) / sizeof(*(s)) - 1))} +#define str8lit(s) \ + (str8) { (u8*)s, ((sizeof(s) / sizeof(*(s)) - 1)) } str8 str8_create(u8* buf, size_t len); /** @brief Return a null-terminated C string cloned onto an arena */ char* str8_to_cstr(arena* a, str8 s); -#define cstr(a, s) (str8_to_cstr(a, s)) // Shorthand +#define cstr(a, s) (str8_to_cstr(a, s)) // Shorthand // --- Comparisons @@ -43,8 +43,8 @@ bool str8_equals(str8 a, str8 b); /** * @brief Compare the first `first_nchars` of each string for equality - * @details If either of the strings are shorter than the number only the characters up until the end - of the shorter string will be compared. + * @details If either of the strings are shorter than the number only the characters up until the + end of the shorter string will be compared. * @returns 0 if they are fully equal up until `first_nchars`, i.e they never differed, else it returns the index at which the first string differed from the second string. */ @@ -69,5 +69,5 @@ str8 str8_concat(arena* a, str8 left, str8 right); /// --- Misc static inline bool str8_is_null_term(str8 a) { - return a.buf[a.len] == 0; // This doesn't seem safe. YOLO + return a.buf[a.len] == 0; // This doesn't seem safe. YOLO } \ No newline at end of file -- cgit v1.2.3-70-g09d2