diff options
| -rw-r--r-- | examples/main_loop/ex_main_loop.c | 2 | ||||
| -rw-r--r-- | examples/standard_lib/ex_std.c | 30 | ||||
| -rw-r--r-- | src/log.h | 2 | ||||
| -rw-r--r-- | src/platform/file.c | 31 | ||||
| -rw-r--r-- | src/platform/file.h | 10 | ||||
| -rw-r--r-- | src/renderer/render_types.h | 3 | ||||
| -rw-r--r-- | src/std/mem.c | 32 | ||||
| -rw-r--r-- | src/std/mem.h | 15 | ||||
| -rw-r--r-- | src/std/str.c | 30 | ||||
| -rw-r--r-- | src/std/str.h | 52 | ||||
| -rw-r--r-- | tests/arena_tests.c | 12 | ||||
| -rw-r--r-- | xmake.lua | 7 |
12 files changed, 216 insertions, 10 deletions
diff --git a/examples/main_loop/ex_main_loop.c b/examples/main_loop/ex_main_loop.c index 2afc3c0..3b2354a 100644 --- a/examples/main_loop/ex_main_loop.c +++ b/examples/main_loop/ex_main_loop.c @@ -19,4 +19,4 @@ int main() { } return 0; -}
\ No newline at end of file +} 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 <stdio.h> +#include <stdlib.h> +#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; +} @@ -1,6 +1,8 @@ #pragma once #include <stdbool.h> +#include <stdio.h> +#include <stdlib.h> #define ERROR_EXIT(...) \ { \ diff --git a/src/platform/file.c b/src/platform/file.c index 45c5b30..44aa9d0 100644 --- a/src/platform/file.c +++ b/src/platform/file.c @@ -7,6 +7,8 @@ #include <stdlib.h> #include "log.h" +#include "mem.h" +#include "str.h" const char *string_from_file(const char *path) { FILE *f = fopen(path, "rb"); @@ -29,4 +31,33 @@ const char *string_from_file(const char *path) { string[fsize] = '\0'; return string; +} + +str8_opt str8_from_file(arena *a, str8 path) { + char *p = cstr(a, path); + str8_opt result = { .has_value = false }; + + FILE *f = fopen(p, "rb"); + if (f == NULL) { + ERROR("Error reading file: %s. errno: %d", path, errno); + return result; + } + if (ferror(f)) { + ERROR("Error reading file: %s. errno: %d", path, errno); + return result; + } + fseek(f, 0, SEEK_END); + long fsize = ftell(f); + rewind(f); + + u8 *raw = arena_alloc(a, fsize + 1); + str8 contents = str8_create(raw, fsize); + contents.buf[contents.len] = '\0'; + + fread(raw, fsize, 1, f); + fclose(f); + result.contents = contents; + result.has_value = true; + + return result; }
\ No newline at end of file diff --git a/src/platform/file.h b/src/platform/file.h index b965ceb..8bb22c8 100644 --- a/src/platform/file.h +++ b/src/platform/file.h @@ -6,6 +6,14 @@ */ #pragma once -#include <stdbool.h> +#include "defines.h" +#include "str.h" + +typedef struct str8_opt { + str8 contents; + bool has_value; +} str8_opt; const char* string_from_file(const char* path); + +str8_opt str8_from_file(arena* a, str8 path);
\ No newline at end of file diff --git a/src/renderer/render_types.h b/src/renderer/render_types.h index a3639e7..e24fc24 100644 --- a/src/renderer/render_types.h +++ b/src/renderer/render_types.h @@ -9,6 +9,7 @@ #include "darray.h" #include "maths_types.h" +#include "str.h" struct GLFWwindow; @@ -65,7 +66,7 @@ KITC_DECL_TYPED_ARRAY(mesh) // creates "mesh_darray" #endif typedef struct model { - char name[256]; + str8 name; } model; #ifndef TYPED_MODEL_ARRAY diff --git a/src/std/mem.c b/src/std/mem.c new file mode 100644 index 0000000..f5b92d4 --- /dev/null +++ b/src/std/mem.c @@ -0,0 +1,32 @@ +#include "mem.h" +#include <stddef.h> +#include <stdint.h> +#include <string.h> +#include "log.h" + +#ifndef DEFAULT_ALIGNMENT +#define DEFAULT_ALIGNMENT (2 * sizeof(void*)) +#endif + +void* arena_alloc_align(arena* a, size_t size, size_t align) { + ptrdiff_t padding = -(uintptr_t)a->curr & (align - 1); + ptrdiff_t available = a->end - a->curr - padding; + TRACE("Padding %td available %td", padding, available); + if (available < 0 || (ptrdiff_t)size > available) { + ERROR_EXIT("Arena ran out of memory\n"); + } + void* p = a->begin + padding; + a->begin += padding + size; + return memset(p, 0, size); +} +void* arena_alloc(arena* a, size_t size) { return arena_alloc_align(a, size, DEFAULT_ALIGNMENT); } + +arena arena_create(void* backing_buffer, size_t capacity) { + return (arena){ .begin = backing_buffer, + .curr = backing_buffer, + .end = backing_buffer + (ptrdiff_t)capacity }; +} + +void arena_free_all(arena* a) { + a->curr = a->begin; // pop everything at once and reset to the start. +}
\ No newline at end of file diff --git a/src/std/mem.h b/src/std/mem.h index 74222a7..c3ec61d 100644 --- a/src/std/mem.h +++ b/src/std/mem.h @@ -9,6 +9,17 @@ */ #pragma once -#include "defines.h" +#include <stddef.h> -typedef void* (*alloc)(size_t amount);
\ No newline at end of file +// Inspired by https://nullprogram.com/blog/2023/09/27/ +typedef struct arena { + char* begin; + char* curr; + char* end; +} arena; + +arena arena_create(void* backing_buffer, size_t capacity); +void* arena_alloc(arena* a, size_t size); +void* arena_alloc_align(arena* a, size_t size, size_t align); +void arena_free_all(arena* a); +// TODO: arena_resize
\ No newline at end of file diff --git a/src/std/str.c b/src/std/str.c index 27f8f68..3b2770e 100644 --- a/src/std/str.c +++ b/src/std/str.c @@ -1,4 +1,9 @@ #include "str.h" +#include <string.h> + +#include "mem.h" + +str8 str8_create(u8* buf, size_t len) { return (str8){ .buf = buf, .len = len }; } bool str8_equals(str8 a, str8 b) { if (a.len != b.len) { @@ -11,4 +16,29 @@ bool str8_equals(str8 a, str8 b) { } } return true; +} + +char* str8_to_cstr(arena* a, str8 s) { + bool is_null_terminated = s.buf[s.len - 1] == 0; + size_t n_bytes = is_null_terminated ? s.len : s.len + 1; + + u8* dest = arena_alloc(a, n_bytes); + + memcpy(dest, s.buf, s.len); + if (is_null_terminated) { + dest[s.len] = '\0'; + } + return (char*)dest; +} + +str8 str8_concat(arena* a, str8 left, str8 right) { + size_t n_bytes = left.len + right.len + 1; + + u8* dest = arena_alloc(a, n_bytes); + memcpy(dest, left.buf, left.len); + memcpy(dest + right.len, right.buf, right.len); + + dest[n_bytes - 1] = '\0'; + + return str8_create(dest, n_bytes); }
\ No newline at end of file diff --git a/src/std/str.h b/src/std/str.h index f3ade5a..735b88e 100644 --- a/src/std/str.h +++ b/src/std/str.h @@ -1,10 +1,17 @@ /** + * @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 some APIs supporting utf8) encoded string @@ -12,20 +19,55 @@ 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)) } + +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 diff --git a/tests/arena_tests.c b/tests/arena_tests.c new file mode 100644 index 0000000..88fc21b --- /dev/null +++ b/tests/arena_tests.c @@ -0,0 +1,12 @@ +/* +size_t arena_size = 16; + arena scratch = arena_create(malloc(arena_size), arena_size); + + i32* int_ptr = arena_alloc(&scratch, sizeof(i32)); + i32* b = arena_alloc(&scratch, sizeof(i32)); + i32* c = arena_alloc(&scratch, sizeof(i32)); + *int_ptr = 55; + printf("Int pointer %d %p\n", (*int_ptr), int_ptr); + + // will abort on second arena alloc +*/
\ No newline at end of file @@ -87,4 +87,11 @@ target("main_loop") set_group("examples") add_deps("core_shared") add_files("examples/main_loop/ex_main_loop.c") + set_rundir("$(projectdir)") + +target("std") + set_kind("binary") + set_group("examples") + add_deps("core_static") + add_files("examples/standard_lib/ex_std.c") set_rundir("$(projectdir)")
\ No newline at end of file |