Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WIP: Visitor pattern implementation for serialization #1456

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

WIP: Visitor pattern implementation for serialization #1456

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ee9b91a
Started lifting type-value serialization to a visitor-pattern.
garrett-is-a-swann Nov 28, 2024
0b21a9e
Raised abstraction through a portion of query-serialization. Working …
garrett-is-a-swann Nov 30, 2024
85eb630
Fixed tests
garrett-is-a-swann Dec 1, 2024
cfb1db7
Made count-index types size_t
garrett-is-a-swann Dec 1, 2024
8d67505
Moved script-serializers to correct location
garrett-is-a-swann Dec 1, 2024
b81f180
Fixed more type issues, predeclared serialization functions
garrett-is-a-swann Dec 1, 2024
3fe77f0
Fixed typo, made Script add Serialize dependency
garrett-is-a-swann Dec 1, 2024
e6b35bc
Fixed some script tests
garrett-is-a-swann Dec 1, 2024
a6f72e5
Fixed includes. Possibly fixed meson builds
garrett-is-a-swann Dec 2, 2024
1032d43
Included more of the entity-iter api in the visitor abstraction
garrett-is-a-swann Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
113 changes: 90 additions & 23 deletions distr/flecs.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45189,6 +45189,7 @@ char* ecs_type_info_to_json(

#ifdef FLECS_JSON


static
int flecs_json_ser_type_ops(
const ecs_world_t *world,
Expand All @@ -45205,13 +45206,27 @@ int flecs_json_ser_type_op(
const void *base,
ecs_strbuf_t *str);

static
void flecs_json_ser_enum(
uint32_t value,
const char* constant_name,
void* user_data)
{
(void)value;
ecs_strbuf_t *str = (ecs_strbuf_t*)user_data;

ecs_strbuf_appendch(str, '"');
ecs_strbuf_appendstr(str, constant_name);
ecs_strbuf_appendch(str, '"');
}

/* Serialize enumeration */
static
int flecs_json_ser_enum(
int flecs_ser_enum(
const ecs_world_t *world,
ecs_meta_type_op_t *op,
const void *base,
ecs_strbuf_t *str)
ecs_visitor_desc_t *ser_desc,
const void *base)
{
const EcsEnum *enum_type = ecs_get(world, op->type, EcsEnum);
ecs_check(enum_type != NULL, ECS_INVALID_PARAMETER, NULL);
Expand All @@ -45231,43 +45246,68 @@ int flecs_json_ser_enum(
goto error;
}

ecs_strbuf_appendch(str, '"');
ecs_strbuf_appendstr(str, ecs_get_name(world, constant->constant));
ecs_strbuf_appendch(str, '"');
ser_desc->visit_enum(value, ecs_get_name(world, constant->constant), ser_desc->user_data);

return 0;
error:
return -1;
}

/* Serialize bitmask */

static int flecs_json_ser_enter_bitmask(uint32_t initial_value, void* user_data) {
(void)initial_value;
ecs_strbuf_t *str = (ecs_strbuf_t*)user_data;
if (!initial_value) {
ecs_strbuf_appendch(str, '0');
return 0;
}
ecs_strbuf_list_push(str, "\"", "|");
return 1;
}

static void flecs_json_ser_bitmask_value(uint32_t value, const char* constant_name, void* user_data) {
(void)value;
ecs_strbuf_t *str = (ecs_strbuf_t*)user_data;
ecs_strbuf_list_appendstr(str, constant_name);
}

static void flecs_json_ser_exit_bitmask(void* user_data) {
ecs_strbuf_t *str = (ecs_strbuf_t*)user_data;
ecs_strbuf_list_pop(str, "\"");
}

static
int flecs_json_ser_bitmask(
int flecs_ser_bitmask(
const ecs_world_t *world,
ecs_meta_type_op_t *op,
const void *ptr,
ecs_strbuf_t *str)
ecs_visitor_desc_t *ser_desc,
const void *ptr
)
{
const EcsBitmask *bitmask_type = ecs_get(world, op->type, EcsBitmask);
ecs_check(bitmask_type != NULL, ECS_INVALID_PARAMETER, NULL);

uint32_t value = *(const uint32_t*)ptr;
if (!value) {
ecs_strbuf_appendch(str, '0');

if (ser_desc->visit_bitmask.enter && !ser_desc->visit_bitmask.enter(value, ser_desc->user_data)) {
// Visit Enter Bitmask can decide to skip visiting by returning 0
return 0;
}

ecs_strbuf_list_push(str, "\"", "|");

/* Multiple flags can be set at a given time. Iterate through all the flags
* and append the ones that are set. */
ecs_map_iter_t it = ecs_map_iter(&bitmask_type->constants);
while (ecs_map_next(&it)) {
ecs_bitmask_constant_t *constant = ecs_map_ptr(&it);
ecs_map_key_t key = ecs_map_key(&it);
if ((value & key) == key) {
ecs_strbuf_list_appendstr(str,
ecs_get_name(world, constant->constant));
if (ser_desc && ser_desc->visit_bitmask.value) {
ser_desc->visit_bitmask.value(
(uint32_t)key,
ecs_get_name(world, constant->constant),
ser_desc->user_data
);
}
value -= (uint32_t)key;
}
}
Expand All @@ -45281,13 +45321,16 @@ int flecs_json_ser_bitmask(
goto error;
}

ecs_strbuf_list_pop(str, "\"");
if (ser_desc->visit_bitmask.exit) {
ser_desc->visit_bitmask.exit(ser_desc->user_data);
}

return 0;
error:
return -1;
}


/* Serialize elements of a contiguous array */
static
int flecs_json_ser_elements(
Expand Down Expand Up @@ -45469,6 +45512,16 @@ int json_ser_custom_type(
return 0;
}

void flecs_json_ser_f32(const ecs_f32_t value, void* user_data) {
ecs_strbuf_t* str = (ecs_strbuf_t*)user_data;
ecs_strbuf_appendflt(str, (ecs_f64_t)value, '"');
}

void flecs_json_ser_f64(const ecs_f64_t value, void* user_data) {
ecs_strbuf_t* str = (ecs_strbuf_t*)user_data;
ecs_strbuf_appendflt(str, value, '"');
}

/* Forward serialization to the different type kinds */
static
int flecs_json_ser_type_op(
Expand All @@ -45477,6 +45530,18 @@ int flecs_json_ser_type_op(
const void *ptr,
ecs_strbuf_t *str)
{
ecs_visitor_desc_t ser_desc = {
.visit_f32 = flecs_json_ser_f32, // Reuse
.visit_f64 = flecs_json_ser_f64,
.visit_enum = flecs_json_ser_enum,
.visit_bitmask = {
.enter = flecs_json_ser_enter_bitmask,
.value = flecs_json_ser_bitmask_value,
.exit = flecs_json_ser_exit_bitmask,
},
.user_data = str
};

void *vptr = ECS_OFFSET(ptr, op->offset);
bool large_int = false;
if (op->kind == EcsOpI64) {
Expand All @@ -45500,20 +45565,22 @@ int flecs_json_ser_type_op(
ecs_throw(ECS_INVALID_PARAMETER, NULL);
break;
case EcsOpF32:
ecs_strbuf_appendflt(str,
(ecs_f64_t)*(const ecs_f32_t*)vptr, '"');
// Reuse visit f64
if (ser_desc.visit_f32)
ser_desc.visit_f32(*(const ecs_f32_t*)vptr, ser_desc.user_data);
break;
case EcsOpF64:
ecs_strbuf_appendflt(str,
*(ecs_f64_t*)vptr, '"');
if (ser_desc.visit_f64)
ser_desc.visit_f64(*(const ecs_f64_t*)vptr, ser_desc.user_data);
break;
case EcsOpEnum:
if (flecs_json_ser_enum(world, op, vptr, str)) {
if (ser_desc.visit_enum && flecs_ser_enum(world, op, &ser_desc, vptr)) {
goto error;
}
break;
case EcsOpBitmask:
if (flecs_json_ser_bitmask(world, op, vptr, str)) {
if ((ser_desc.visit_bitmask.enter || ser_desc.visit_bitmask.value)
&& flecs_ser_bitmask(world, op, &ser_desc, vptr)) {
goto error;
}
break;
Expand Down
27 changes: 27 additions & 0 deletions distr/flecs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15331,6 +15331,33 @@ typedef struct ecs_serializer_t {
extern "C" {
#endif

/** Visitor Seriailzation API
*/
typedef struct ecs_visitor_desc_t {
/** Here Be Visitor Functions
* If the visit has a return, it has some form of flow control.
*/

/** Visit Primitives */
void (*visit_f32)(const ecs_f32_t value, void* user_data);
void (*visit_f64)(const ecs_f64_t value, void* user_data);

garrett-is-a-swann marked this conversation as resolved.
Show resolved Hide resolved

void (*visit_string)(const char *value);
void (*visit_enum)(uint32_t value, const char* constant_name, void* user_data);
struct {
int (*enter)(uint32_t initial_value, void* user_data);
void (*value)(uint32_t value, const char* constant_name, void* user_data);
void (*exit)(void* user_data);
} visit_bitmask;

/** User Data that is handed out to each visit.
* Ex: JSON serialization passes a string buffer
*/
void* user_data;
} ecs_visitor_desc_t;


/** Callback invoked serializing an opaque type. */
typedef int (*ecs_meta_serialize_t)(
const ecs_serializer_t *ser,
Expand Down
43 changes: 43 additions & 0 deletions include/flecs/addons/meta.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,49 @@ typedef struct ecs_serializer_t {
extern "C" {
#endif

/** Visitor Seriailzation API
*/
typedef struct ecs_visitor_desc_t {
/** Here Be Visitor Functions
* If the visit has a return, it has some form of flow control.
*/

/** visit primitives */
void (*visit_char)(const ecs_char_t value, void* user_data);
void (*visit_u8)(const ecs_u8_t value, void* user_data);
void (*visit_u16)(const ecs_u16_t value, void* user_data);
void (*visit_u32)(const ecs_u32_t value, void* user_data);
void (*visit_u64)(const ecs_u64_t value, void* user_data);
void (*visit_i8)(const ecs_i8_t value, void* user_data);
void (*visit_i16)(const ecs_i16_t value, void* user_data);
void (*visit_i32)(const ecs_i32_t value, void* user_data);
void (*visit_i64)(const ecs_i64_t value, void* user_data);
void (*visit_f32)(const ecs_f32_t value, void* user_data);
void (*visit_f64)(const ecs_f64_t value, void* user_data);
void (*visit_bool)(const ecs_bool_t value, void* user_data);
void (*visit_byte)(const ecs_byte_t value, void* user_data);
void (*visit_uptr)(const ecs_uptr_t value, void* user_data);
void (*visit_iptr)(const ecs_iptr_t value, void* user_data);
void (*visit_string)(const char* value, void* user_data);
void (*visit_entity)(const ecs_world_t*, const ecs_entity_t value, void* user_data);
void (*visit_id)(const ecs_world_t*, const ecs_id_t value, void* user_data);


void (*visit_enum)(uint32_t value, const char* constant_name, void* user_data);
struct {
int (*enter)(uint32_t initial_value, void* user_data);
void (*value)(uint32_t value, const char* constant_name, void* user_data);
void (*exit)(void* user_data);
} visit_bitmask;

/** User Data that is handed out to each visit.
* Ex: JSON serialization passes a string buffer
*/
void* user_data;
} ecs_visitor_desc_t;

#define ecs_visit(desc, fn, T, ptr) desc->fn(*(T*)ptr);

/** Callback invoked serializing an opaque type. */
typedef int (*ecs_meta_serialize_t)(
const ecs_serializer_t *ser,
Expand Down
Loading