alerts.h

Go to the documentation of this file.

 
#ifdef FLECS_ALERTS
 
#ifndef FLECS_ALERTS_H
#define FLECS_ALERTS_H
 
#ifndef FLECS_RULES
#define FLECS_RULES
#endif
 
#ifndef FLECS_PIPELINE
#define FLECS_PIPELINE
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define ECS_ALERT_MAX_SEVERITY_FILTERS (4)
 
/* Module id */
FLECS_API extern ECS_COMPONENT_DECLARE(FlecsAlerts);
 
/* Module components */
 
FLECS_API extern ECS_COMPONENT_DECLARE(EcsAlert);
FLECS_API extern ECS_COMPONENT_DECLARE(EcsAlertInstance);
FLECS_API extern ECS_COMPONENT_DECLARE(EcsAlertsActive);
FLECS_API extern ECS_COMPONENT_DECLARE(EcsAlertTimeout);
 
/* Alert severity tags */
FLECS_API extern ECS_TAG_DECLARE(EcsAlertInfo);
FLECS_API extern ECS_TAG_DECLARE(EcsAlertWarning);
FLECS_API extern ECS_TAG_DECLARE(EcsAlertError);
FLECS_API extern ECS_TAG_DECLARE(EcsAlertCritical);
 
typedef struct EcsAlertInstance {
    char *message;
} EcsAlertInstance;
 
typedef struct EcsAlertsActive {
    int32_t info_count;
    int32_t warning_count;
    int32_t error_count;
    ecs_map_t alerts;
} EcsAlertsActive;
 
typedef struct ecs_alert_severity_filter_t {
    ecs_entity_t severity; /* Severity kind */
    ecs_id_t with;         /* Component to match */
    const char *var;       /* Variable to match component on. Do not include the
                            * '$' character. Leave to NULL for $this. */
    int32_t _var_index;    /* Index of variable in filter (do not set) */
} ecs_alert_severity_filter_t;
 
typedef struct ecs_alert_desc_t {
    int32_t _canary;
 
    ecs_entity_t entity;
 
    ecs_filter_desc_t filter;
 
    const char *message;
 
    const char *doc_name;
 
    const char *brief;
 
    ecs_entity_t severity;
 
    ecs_alert_severity_filter_t severity_filters[ECS_ALERT_MAX_SEVERITY_FILTERS];
 
    ecs_ftime_t retain_period;
 
    ecs_entity_t member;
 
    ecs_id_t id;
 
    const char *var;
} ecs_alert_desc_t;
 
FLECS_API
ecs_entity_t ecs_alert_init(
    ecs_world_t *world,
    const ecs_alert_desc_t *desc);
 
#define ecs_alert(world, ...)\
    ecs_alert_init(world, &(ecs_alert_desc_t)__VA_ARGS__)
 
FLECS_API
int32_t ecs_get_alert_count(
    const ecs_world_t *world,
    ecs_entity_t entity,
    ecs_entity_t alert);
 
FLECS_API
ecs_entity_t ecs_get_alert(
    const ecs_world_t *world,
    ecs_entity_t entity,
    ecs_entity_t alert);
 
/* Module import */
FLECS_API
void FlecsAlertsImport(
    ecs_world_t *world);
 
#ifdef __cplusplus
}
#endif
 
#endif
 
#endif