/* component.h Component management Copyright (C) 2022 Bill Currie Author: Bill Currie Date: 2022/10/07 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to: Free Software Foundation, Inc. 59 Temple Place - Suite 330 Boston, MA 02111-1307, USA */ #ifndef __QF_ecs_component_h #define __QF_ecs_component_h #include #include #include "QF/qtypes.h" #include "QF/progs.h"//FIXME for PR_RESMAP #include "QF/ecs/hierarchy.h" /** \defgroup component Entity Component System \ingroup utils */ ///@{ #define ENT_GROW 1024 #define COMP_GROW 128 #define ENT_IDBITS 20 #define nullent (~0u) typedef struct ecs_pool_s { uint32_t *sparse; // indexed by entity id, holds index to dense/data uint32_t *dense; // holds entity id void *data; // component data uint32_t count; // number of components/dense entity ids uint32_t max_count; // current capacity for components/entity ids } ecs_pool_t; typedef struct component_s { size_t size; void (*create) (void *); void (*destroy) (void *); const char *name; } component_t; typedef struct ecs_registry_s { uint32_t *entities; uint32_t next; uint32_t available; uint32_t num_entities; uint32_t max_entities; const component_t *components; ecs_pool_t *comp_pools; uint32_t num_components; uint32_t href_comp;//FIXME find a better way PR_RESMAP (hierarchy_t) hierarchies;//FIXME find a better way } ecs_registry_t; #define COMPINLINE GNU89INLINE inline COMPINLINE void Component_ResizeArray (const component_t *component, void **array, uint32_t count); COMPINLINE void *Component_MoveElements (const component_t *component, void *array, uint32_t dstIndex, uint32_t srcIndex, uint32_t count); COMPINLINE void Component_SwapElements (const component_t *component, void *a, void *b); COMPINLINE void *Component_CopyElements (const component_t *component, void *dstArray, uint32_t dstIndex, const void *srcArray, uint32_t srcIndex, uint32_t count); COMPINLINE void *Component_CreateElements (const component_t *component, void *array, uint32_t index, uint32_t count); COMPINLINE void Component_DestroyElements (const component_t *component, void *array, uint32_t index, uint32_t count); COMPINLINE uint32_t Ent_Index (uint32_t id); COMPINLINE uint32_t Ent_Generation (uint32_t id); COMPINLINE uint32_t Ent_NextGen (uint32_t id); COMPINLINE int ECS_EntValid (uint32_t id, ecs_registry_t *reg); COMPINLINE int Ent_HasComponent (uint32_t ent, uint32_t comp, ecs_registry_t *reg); COMPINLINE void *Ent_GetComponent (uint32_t ent, uint32_t comp, ecs_registry_t *reg); COMPINLINE void *Ent_SetComponent (uint32_t ent, uint32_t comp, ecs_registry_t *registry, const void *data); #undef COMPINLINE #ifndef IMPLEMENT_COMPONENT_Funcs #define COMPINLINE GNU89INLINE inline #else #define COMPINLINE VISIBLE #endif COMPINLINE void Component_ResizeArray (const component_t *component, void **array, uint32_t count) { *array = realloc (*array, count * component->size); } COMPINLINE void * Component_MoveElements (const component_t *component, void *array, uint32_t dstIndex, uint32_t srcIndex, uint32_t count) { __auto_type dst = (byte *) array + dstIndex * component->size; __auto_type src = (byte *) array + srcIndex * component->size; return memmove (dst, src, count * component->size); } COMPINLINE void Component_SwapElements (const component_t *component, void *a, void *b) { size_t size = component->size; byte tmp[size]; memcpy (tmp, a, size); memcpy (a, b, size); memcpy (b, tmp, size); } COMPINLINE void * Component_CopyElements (const component_t *component, void *dstArray, uint32_t dstIndex, const void *srcArray, uint32_t srcIndex, uint32_t count) { __auto_type dst = (byte *) dstArray + dstIndex * component->size; __auto_type src = (byte *) srcArray + srcIndex * component->size; return memcpy (dst, src, count * component->size); } COMPINLINE void * Component_CreateElements (const component_t *component, void *array, uint32_t index, uint32_t count) { if (component->create) { for (uint32_t i = index; count-- > 0; i++) { __auto_type dst = (byte *) array + i * component->size; component->create (dst); } } else { __auto_type dst = (byte *) array + index * component->size; memset (dst, 0, count * component->size); } return (byte *) array + index * component->size; } COMPINLINE void Component_DestroyElements (const component_t *component, void *array, uint32_t index, uint32_t count) { if (component->destroy) { for (uint32_t i = index; count-- > 0; i++) { __auto_type dst = (byte *) array + i * component->size; component->destroy (dst); } } } COMPINLINE uint32_t Ent_Index (uint32_t id) { return id & ((1 << ENT_IDBITS) - 1); } COMPINLINE uint32_t Ent_Generation (uint32_t id) { return id & ~((1 << ENT_IDBITS) - 1); } COMPINLINE uint32_t Ent_NextGen(uint32_t id) { return id + (1 << ENT_IDBITS); } COMPINLINE int ECS_EntValid (uint32_t id, ecs_registry_t *reg) { uint32_t ind = Ent_Index (id); return ind < reg->num_entities && reg->entities[ind] == id; } COMPINLINE int Ent_HasComponent (uint32_t ent, uint32_t comp, ecs_registry_t *reg) { ecs_pool_t *pool = ®->comp_pools[comp]; uint32_t ind = pool->sparse[Ent_Index (ent)]; return ind < pool->count && pool->dense[ind] == ent; } COMPINLINE void * Ent_GetComponent (uint32_t ent, uint32_t comp, ecs_registry_t *reg) { const component_t *component = ®->components[comp]; uint32_t ind = reg->comp_pools[comp].sparse[Ent_Index (ent)]; byte *data = reg->comp_pools[comp].data; return data + ind * component->size; } ecs_registry_t *ECS_NewRegistry (void); void ECS_DelRegistry (ecs_registry_t *registry); void ECS_RegisterComponents (ecs_registry_t *registry, const component_t *components, uint32_t count); #ifndef __compar_d_fn_t_defined #define __compar_d_fn_t_defined typedef int (*__compar_d_fn_t)(const void *, const void *, void *); #endif void ECS_SortComponentPool (ecs_registry_t *registry, uint32_t component, __compar_d_fn_t cmp, void *arg); uint32_t ECS_NewEntity (ecs_registry_t *registry); void ECS_DelEntity (ecs_registry_t *registry, uint32_t ent); void ECS_RemoveEntities (ecs_registry_t *registry, uint32_t component); void *Ent_AddComponent (uint32_t ent, uint32_t comp, ecs_registry_t *registry); void Ent_RemoveComponent (uint32_t ent, uint32_t comp, ecs_registry_t *registry); COMPINLINE void * Ent_SetComponent (uint32_t ent, uint32_t comp, ecs_registry_t *registry, const void *data) { void *dst = Ent_AddComponent (ent, comp, registry); if (data) { return Component_CopyElements (®istry->components[comp], dst, 0, data, 0, 1); } else { return Component_CreateElements (®istry->components[comp], dst, 0, 1); } } ///@} #endif//__QF_ecs_component_h