script_async.h

Go to the documentation of this file.

 
#ifdef FLECS_SCRIPT_ASYNC
 
#ifndef FLECS_SCRIPT
#define FLECS_SCRIPT
#endif
 
#ifndef FLECS_SCRIPT_ASYNC_H
#define FLECS_SCRIPT_ASYNC_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
FLECS_API
extern ECS_COMPONENT_DECLARE(EcsScriptTask);
 
typedef struct ecs_script_future_t ecs_script_future_t;
 
typedef struct ecs_script_task_t ecs_script_task_t;
 
typedef void(*ecs_async_function_callback_t)(
    const ecs_function_ctx_t *ctx,
    int32_t argc,
    const ecs_value_t *argv,
    ecs_script_future_t *future);
 
typedef void(*ecs_async_function_cancel_t)(
    const ecs_function_ctx_t *ctx,
    ecs_script_future_t *future);
 
typedef struct EcsScriptTask {
    ecs_vec_t tasks; 
} EcsScriptTask;
 
typedef enum ecs_script_task_status_t {
    EcsScriptTaskPending,    
    EcsScriptTaskDone,       
    EcsScriptTaskError,      
    EcsScriptTaskCancelled   
} ecs_script_task_status_t;
 
typedef enum ecs_script_task_loop_t {
    EcsScriptTaskLoopOnce,    
    EcsScriptTaskLoopCount,   
    EcsScriptTaskLoopForever  
} ecs_script_task_loop_t;
 
typedef struct ecs_script_task_desc_t {
    ecs_entity_t entity;           
    void *ctx;                     
    ecs_ctx_free_t ctx_free;       
    ecs_script_task_loop_t loop;   
    int32_t iterations;            
} ecs_script_task_desc_t;
 
FLECS_API
ecs_script_task_t* ecs_script_task_new(
    const ecs_script_t *script,
    const ecs_script_task_desc_t *desc);
 
FLECS_API
ecs_script_task_status_t ecs_script_task_resume(
    ecs_script_task_t *task,
    ecs_script_eval_result_t *result);
 
FLECS_API
bool ecs_script_task_is_ready(
    const ecs_script_task_t *task);
 
FLECS_API
void ecs_script_task_cancel(
    ecs_script_task_t *task);
 
FLECS_API
void ecs_script_task_free(
    ecs_script_task_t *task);
 
FLECS_API
int ecs_script_future_resolve(
    ecs_script_future_t *future,
    const ecs_value_t *value);
 
FLECS_API
int ecs_script_future_reject(
    ecs_script_future_t *future,
    const char *error);
 
FLECS_API
int ecs_script_future_reject_id(
    ecs_script_future_t *future,
    ecs_entity_t error,
    const char *msg);
 
FLECS_API
bool ecs_script_future_is_cancelled(
    const ecs_script_future_t *future);
 
FLECS_API
ecs_script_future_t* ecs_script_future_retain(
    ecs_script_future_t *future);
 
FLECS_API
void ecs_script_future_release(
    ecs_script_future_t *future);
 
FLECS_API
void ecs_script_future_set_ctx(
    ecs_script_future_t *future,
    void *ctx,
    ecs_ctx_free_t ctx_free);
 
FLECS_API
void* ecs_script_future_get_ctx(
    const ecs_script_future_t *future);
 
typedef struct ecs_async_function_desc_t {
    const char *name;
 
    ecs_entity_t parent;
 
    ecs_script_parameter_t params[FLECS_SCRIPT_FUNCTION_ARGS_MAX];
 
    ecs_entity_t return_type;
 
    ecs_async_function_callback_t callback;
 
    ecs_async_function_cancel_t cancel;
 
    void *ctx;
} ecs_async_function_desc_t;
 
FLECS_API
ecs_entity_t ecs_async_function_init(
    ecs_world_t *world,
    const ecs_async_function_desc_t *desc);
 
#define ecs_async_function(world, ...)\
    ecs_async_function_init(world, &(ecs_async_function_desc_t)__VA_ARGS__)
 
#ifdef __cplusplus
}
#endif
 
#endif
 
#endif