json.h

Go to the documentation of this file.

 
#ifdef FLECS_JSON
 
#ifndef FLECS_META
#define FLECS_META
#endif
 
#ifndef FLECS_SCRIPT
#define FLECS_SCRIPT
#endif
 
#ifndef FLECS_JSON_H
#define FLECS_JSON_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct ecs_from_json_desc_t {
    const char *name; 
    const char *expr; 
    ecs_entity_t (*lookup_action)(
        const ecs_world_t*,
        const char *value,
        void *ctx);
    void *lookup_ctx;
 
    bool strict;
} ecs_from_json_desc_t;
 
FLECS_API
const char* ecs_ptr_from_json(
    const ecs_world_t *world,
    ecs_entity_t type,
    void *ptr,
    const char *json,
    const ecs_from_json_desc_t *desc);
 
FLECS_API
const char* ecs_entity_from_json(
    ecs_world_t *world,
    ecs_entity_t entity,
    const char *json,
    const ecs_from_json_desc_t *desc);
 
FLECS_API
const char* ecs_world_from_json(
    ecs_world_t *world,
    const char *json,
    const ecs_from_json_desc_t *desc);
 
FLECS_API
const char* ecs_world_from_json_file(
    ecs_world_t *world,
    const char *filename,
    const ecs_from_json_desc_t *desc);
 
FLECS_API
char* ecs_array_to_json(
    const ecs_world_t *world,
    ecs_entity_t type,
    const void *data,
    int32_t count);
 
FLECS_API
int ecs_array_to_json_buf(
    const ecs_world_t *world,
    ecs_entity_t type,
    const void *data,
    int32_t count,
    ecs_strbuf_t *buf_out);
 
FLECS_API
char* ecs_ptr_to_json(
    const ecs_world_t *world,
    ecs_entity_t type,
    const void *data);
 
FLECS_API
int ecs_ptr_to_json_buf(
    const ecs_world_t *world,
    ecs_entity_t type,
    const void *data,
    ecs_strbuf_t *buf_out);
 
FLECS_API
char* ecs_type_info_to_json(
    const ecs_world_t *world,
    ecs_entity_t type);
 
FLECS_API
int ecs_type_info_to_json_buf(
    const ecs_world_t *world,
    ecs_entity_t type,
    ecs_strbuf_t *buf_out);
 
typedef struct ecs_entity_to_json_desc_t {
    bool serialize_entity_id;  
    bool serialize_doc;        
    bool serialize_full_paths; 
    bool serialize_inherited;  
    bool serialize_values;     
    bool serialize_builtin;    
    bool serialize_type_info;  
    bool serialize_alerts;     
    ecs_entity_t serialize_refs; 
    bool serialize_matches;    
} ecs_entity_to_json_desc_t;
 
#define ECS_ENTITY_TO_JSON_INIT (ecs_entity_to_json_desc_t){\
    .serialize_doc = false, \
    .serialize_full_paths = true, \
    .serialize_inherited = false, \
    .serialize_values = true, \
    .serialize_builtin = false, \
    .serialize_type_info = false, \
    .serialize_alerts = false, \
    .serialize_refs = 0, \
    .serialize_matches = false, \
}
 
FLECS_API
char* ecs_entity_to_json(
    const ecs_world_t *world,
    ecs_entity_t entity,
    const ecs_entity_to_json_desc_t *desc);
 
FLECS_API
int ecs_entity_to_json_buf(
    const ecs_world_t *world,
    ecs_entity_t entity,
    ecs_strbuf_t *buf_out,
    const ecs_entity_to_json_desc_t *desc);
 
typedef struct ecs_iter_to_json_desc_t {
    bool serialize_entity_ids;      
    bool serialize_values;          
    bool serialize_builtin;         
    bool serialize_doc;             
    bool serialize_full_paths;      
    bool serialize_fields;          
    bool serialize_inherited;       
    bool serialize_table;           
    bool serialize_type_info;       
    bool serialize_field_info;      
    bool serialize_query_info;      
    bool serialize_query_plan;      
    bool serialize_query_profile;   
    bool dont_serialize_results;    
    bool serialize_alerts;          
    ecs_entity_t serialize_refs;    
    bool serialize_matches;         
    ecs_poly_t *query;            
} ecs_iter_to_json_desc_t;
 
#define ECS_ITER_TO_JSON_INIT (ecs_iter_to_json_desc_t){\
    .serialize_entity_ids =      false, \
    .serialize_values =          true, \
    .serialize_builtin =         false, \
    .serialize_doc =             false, \
    .serialize_full_paths =      true, \
    .serialize_fields =          true, \
    .serialize_inherited =       false, \
    .serialize_table =           false, \
    .serialize_type_info =       false, \
    .serialize_field_info =      false, \
    .serialize_query_info =      false, \
    .serialize_query_plan =      false, \
    .serialize_query_profile =   false, \
    .dont_serialize_results =    false, \
    .serialize_alerts =          false, \
    .serialize_refs =            false, \
    .serialize_matches =         false, \
}
 
FLECS_API
char* ecs_iter_to_json(
    ecs_iter_t *iter,
    const ecs_iter_to_json_desc_t *desc);
 
FLECS_API
int ecs_iter_to_json_buf(
    ecs_iter_t *iter,
    ecs_strbuf_t *buf_out,
    const ecs_iter_to_json_desc_t *desc);
 
typedef struct ecs_world_to_json_desc_t {
    bool serialize_builtin;    
    bool serialize_modules;    
} ecs_world_to_json_desc_t;
 
FLECS_API
char* ecs_world_to_json(
    ecs_world_t *world,
    const ecs_world_to_json_desc_t *desc);
 
FLECS_API
int ecs_world_to_json_buf(
    ecs_world_t *world,
    ecs_strbuf_t *buf_out,
    const ecs_world_to_json_desc_t *desc);
 
 
 
/* Legacy deserializer functions. These can be used to load a v3 JSON string and
 * save it to the new format. These functions will be removed in the next
 * release. */
 
FLECS_API
const char* ecs_entity_from_json_legacy(
    ecs_world_t *world,
    ecs_entity_t entity,
    const char *json,
    const ecs_from_json_desc_t *desc);
 
FLECS_API
const char* ecs_world_from_json_legacy(
    ecs_world_t *world,
    const char *json,
    const ecs_from_json_desc_t *desc);
 
FLECS_API
const char* ecs_world_from_json_file_legacy(
    ecs_world_t *world,
    const char *filename,
    const ecs_from_json_desc_t *desc);
 
#ifdef __cplusplus
}
#endif
 
#endif
 
#endif