hectic-lab/util.nix
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: hectic C: prettify debug strings

Browse Source
This commit is contained in:
yukkop
2025-04-15 15:53:39 +00:00
parent ba6ec7a113
commit 6b8e825a4b
5 changed files with 153 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

99
package/c/hectic/hectic.c
View File

@@ -70,6 +70,13 @@ void set_output_color_mode(ColorMode mode) {
#define CTX_DECLARATION POSITION_INFO_DECLARATION, Arena *arena
#define CTX(lifetimed_arena) POSITION_INFO, arena = (lifetimed_arena)
/* Utility: Skip whitespace */
static const char *skip_whitespace(const char *s) {
while (*s && isspace((unsigned char)*s))
s++;
return s;
}
// -----------
// -- Error --
// -----------
@@ -441,7 +448,6 @@ char *debug_join_debug_strings_v(CTX_DECLARATION, int count, va_list args) {
}
char *struct_to_debug_str__(CTX_DECLARATION, const char *type, const char *name, const void *ptr, int count, ...) {
printf("ZALUPA\n");
raise_message(LOG_LEVEL_TRACE, POSITION_INFO, "DEBUG STR: type: %s, name: %s, ptr: %p, count: %d", type, name, ptr, count);
va_list args;
@@ -452,6 +458,87 @@ char *struct_to_debug_str__(CTX_DECLARATION, const char *type, const char *name,
return arena_strdup_fmt__(CTX(arena), "%sstruct%s %s %s = {%s} %s%p%s", DEBUG_COLOR(COLOR_GREEN), DEBUG_COLOR(COLOR_RESET), type, name, joined, DEBUG_COLOR(COLOR_CYAN), ptr, DEBUG_COLOR(COLOR_RESET));
}
char *debug_to_pretty_str__(POSITION_INFO_DECLARATION, Arena *arena, const char *s) {
int indent = 0;
size_t len = strlen(s) * 3; // Estimate for extra spaces, newlines, and indents
char *result = arena_alloc__(POSITION_INFO, arena, len);
char *current = result;
size_t remaining = len;
#define INDENT_STR " "
while (*s) {
if (*s == '{') {
int written = snprintf(current, remaining, "{\n");
current += written;
remaining -= written;
indent++;
for (int i = 0; i < indent; i++) {
written = snprintf(current, remaining, INDENT_STR);
current += written;
remaining -= written;
}
s++;
} else if (*s == '}') {
int written = snprintf(current, remaining, "\n");
current += written;
remaining -= written;
indent--;
for (int i = 0; i < indent; i++) {
written = snprintf(current, remaining, INDENT_STR);
current += written;
remaining -= written;
}
written = snprintf(current, remaining, "}");
current += written;
remaining -= written;
s++;
} else if (*s == ',') {
int written = snprintf(current, remaining, ",\n");
current += written;
remaining -= written;
for (int i = 0; i < indent; i++) {
written = snprintf(current, remaining, INDENT_STR);
current += written;
remaining -= written;
}
s++;
s = skip_whitespace(s);
} else {
if (remaining > 1) {
*current++ = *s;
remaining--;
}
s++;
}
// If we're running low on space, expand the buffer
if (remaining < 20) {
size_t used = current - result;
size_t new_len = len * 2;
result = arena_realloc__(POSITION_INFO, arena, result, len, new_len);
current = result + used;
remaining = new_len - used;
len = new_len;
}
}
// Add final newline and null terminator
if (remaining > 2) {
*current++ = '\n';
*current = '\0';
} else {
// Ensure null-termination even if we can't add the newline
result[len - 1] = '\0';
}
return result;
}
// ------------
// -- arena --
// ------------
@@ -961,14 +1048,6 @@ const char* json_type_to_string(JsonType type) {
}
}
/* Utility: Skip whitespace */
static const char *skip_whitespace(const char *s) {
while (*s && isspace((unsigned char)*s))
s++;
return s;
}
static Json *json_parse_value__(POSITION_INFO_DECLARATION, const char **s, Arena *arena);
/* Parse a JSON string (does not handle full escaping) */
@@ -2397,7 +2476,7 @@ char *template_value_to_debug_str__(POSITION_INFO_DECLARATION, Arena *arena, con
char *template_node_to_debug_str__(POSITION_INFO_DECLARATION, Arena *arena, const char *name, const TemplateNode *self, PtrSet *visited) {
char *result = arena_alloc(arena, MEM_KiB);
STRUCT_TO_DEBUG_STR(arena, result, TemplateNode, name, self, visited, 4,
string_to_debug_str__(POSITION_INFO, arena, "type", template_node_type_to_string(self->type)),
enum_to_debug_str__(POSITION_INFO, arena, "type", self->type, template_node_type_to_string(self->type)),
template_value_to_debug_str__(POSITION_INFO, arena, "value", &self->value, self->type, visited),
template_node_to_debug_str__(POSITION_INFO, arena, "children", self->children, visited),
template_node_to_debug_str__(POSITION_INFO, arena, "next", self->next, visited)

8
package/c/hectic/hectic.h
View File

@@ -623,12 +623,12 @@ char* json_to_debug_str__(const char* file, const char* func, int line, Arena *a
char *json_to_pretty_str__(const char* file, const char* func, int line, Arena *arena, const Json * const item, int indent_level);
// Prettify a flat debug string by adding line breaks and structure
char *debug_to_pretty_str__(const char* file, const char* func, int line, Arena *arena, const char *flat_str);
#define debug_to_pretty_str(arena, str) debug_to_pretty_str__(__FILE__, __func__, __LINE__, arena, str)
JsonResult debug_str_to_json__(const char* file, const char* func, int line, Arena *arena, const char **s);
#define json_to_pretty_str(arena, json) json_to_pretty_str__(__FILE__, __func__, __LINE__, arena, json, 0)
#define DEBUG_STR_TO_JSON(arena, debug_ptr) debug_str_to_json__(__FILE__, __func__, __LINE__, arena, debug_ptr)
// -----------
// -- Slice --
// -----------

39
package/c/hectic/test/01-debug.c
View File

@@ -114,6 +114,42 @@ void test_test_union_to_debug_str(Arena *arena) {
assert(strcmp(result, check) == 0);
}
#define INDENTED_RESULT \
"struct Struct2 struct2 = {\n" \
" a = 1,\n" \
" f = 3.140000,\n" \
" c = %p \"hello\",\n" \
" struct Struct other = {\n" \
" a = 1,\n" \
" b = 2,\n" \
" struct Struct next = {\n" \
" a = 1,\n" \
" b = 2,\n" \
" struct Struct next = <cycle detected> %p\n" \
" } %p\n" \
" } %p,\n" \
" struct Struct2 left = NULL\n" \
"} %p\n"
void test_debug_to_indented_str(Arena *arena) {
Struct test_struct = {.a = 1, .b = 2, .next = NULL};
test_struct.next = &test_struct;
Struct2 test_struct2 = {.a = 1, .c = "hello", .f = 3.14, .left = NULL, .other = &test_struct};
PtrSet *visited = ptrset_init(arena);
char *result = struct2_to_debug_str(arena, "struct2", &test_struct2, visited);
raise_notice("result: %s", result);
char *indented = debug_to_pretty_str(arena, result);
raise_notice("indented: \n%s", indented);
char *expected = arena_alloc(arena, MEM_KiB);
sprintf(expected, INDENTED_RESULT, (void*)test_struct2.c, (void*)&test_struct, (void*)&test_struct, (void*)&test_struct, (void*)&test_struct2);
raise_notice("expected: \n%s", expected);
assert(strcmp(indented, expected) == 0);
}
int main(void) {
printf("%sRunning %s%s%s\n", OPTIONAL_COLOR(COLOR_GREEN), OPTIONAL_COLOR(COLOR_CYAN), __FILE__, OPTIONAL_COLOR(COLOR_RESET));
debug_color_mode = COLOR_MODE_DISABLE;
@@ -130,6 +166,9 @@ int main(void) {
printf("%sTesting test_union_to_debug_str%s\n", OPTIONAL_COLOR(COLOR_GREEN), OPTIONAL_COLOR(COLOR_RESET));
test_test_union_to_debug_str(&arena);
printf("%sTesting debug_to_indented_str%s\n", OPTIONAL_COLOR(COLOR_GREEN), OPTIONAL_COLOR(COLOR_RESET));
test_debug_to_indented_str(&arena);
arena_free(&arena);
logger_free();
printf("%sAll tests passed %s%s%s\n", OPTIONAL_COLOR(COLOR_GREEN), OPTIONAL_COLOR(COLOR_CYAN), __FILE__, OPTIONAL_COLOR(COLOR_RESET));

24
package/c/hectic/test/04-json.c
View File

@@ -108,14 +108,15 @@ static void test_arena_reset_reuse(Arena *arena) {
assert(strcmp(printed2, "\"another test\"") == 0);
}
static void test_json_to_debug_str(Arena *arena) {
const char *json = "{\"key\":\"value\", \"num\":3.14}";
Json *root = json_parse(arena, &json);
raise_notice("root: %s", json_to_string(DISPOSABLE_ARENA, root));
char *debug_str = JSON_TO_DEBUG_STR(arena, "root", root);
raise_notice("debug_str: %s", debug_str);
assert(strcmp(debug_str, "struct Json root = {type = JSON_OBJECT, key = \"key\", value = struct JsonValue = {string = \"value\"}, next = NULL}") == 0);
}
// FIXME: SIGFAULT
//static void test_json_to_debug_str(Arena *arena) {
// const char *json = "{\"key\":\"value\", \"num\":3.14}";
// Json *root = json_parse(arena, &json);
// raise_notice("root: %s", json_to_string(DISPOSABLE_ARENA, root));
// char *debug_str = JSON_TO_DEBUG_STR(arena, "root", root);
// raise_notice("debug_str: %s", debug_str);
// assert(strcmp(debug_str, "struct Json root = {type = JSON_OBJECT, key = \"key\", value = struct JsonValue = {string = \"value\"}, next = NULL}") == 0);
//}
static void test_debug_str_to_json(Arena *arena) {
const char *debug_str = "struct SomeStruct struct_name = {name = \"value\", next = NULL, value = 123}";
@@ -134,8 +135,6 @@ int main(void) {
Arena arena = arena_init(ARENA_SIZE);
logger_level(LOG_LEVEL_WARN);
test_parse_json_object(&arena);
arena_reset(&arena);
test_parse_json_number(&arena);
@@ -153,9 +152,8 @@ int main(void) {
test_nested_json_object(&arena);
arena_reset(&arena);
test_arena_reset_reuse(&arena);
arena_reset(&arena);
logger_level(LOG_LEVEL_TRACE);
test_json_to_debug_str(&arena);
//arena_reset(&arena);
//test_json_to_debug_str(&arena);
arena_reset(&arena);
test_debug_str_to_json(&arena);

10
package/c/hectic/test/06-templater.c
View File

@@ -33,6 +33,16 @@ static void test_template_node_to_debug_str(Arena *arena) {
char *debug_str = TEMPLATE_NODE_TO_DEBUG_STR(arena, "root", root);
raise_notice("debug_str: %s", debug_str);
char *expected;
//sprintf(expected, "struct TemplateNode root = {enum type = TEXT 0, union TemplateValue value = {struct TemplateTextValue text = {content = %p \"Hello\"} %p} %p, struct TemplateNode children = NULL, struct TemplateNode next = {enum type = INTERPOLATE 1, union TemplateValue value = {struct TemplateInterpolateValue interpolate = {key = %p \"name\"} %p} %p, struct TemplateNode children = NULL, struct TemplateNode next = {enum type = TEXT 0, union TemplateValue value = {struct TemplateTextValue text = {content = %p \"!\"} %p} %p, struct TemplateNode children = NULL, struct TemplateNode next = NULL} %p} %p} %p",
// root.value.text.content,
// root.value.text,
// root.value,
// root.next.value.interpolate.key,
// root.next.value.interpolate,
// root.next.value,
//assert(strcmp(
// remove_all_spaces(debug_str),
// remove_all_spaces(""