Sovereignty/jecs
1
0
Fork 0
mirror of https://github.com/Ukendio/jecs.git synced 2025-04-24 17:10:03 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add dual types

Browse source
This commit is contained in:
Ukendio 2025-03-25 23:13:53 +01:00
parent 9d83c3bc13
commit f3befa3adb
4 changed files with 502 additions and 373 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

515
jecs.luau
View file

@ -13,39 +13,49 @@ type Column = { any }
type Map<K, V> = { [K]: V } type Map<K, V> = { [K]: V }
type GraphEdge = { type ecs_graph_edge_t = {
from: Archetype, from: ecs_archetype_t,
to: Archetype?, to: ecs_archetype_t?,
id: number, id: number,
prev: GraphEdge?, prev: ecs_graph_edge_t?,
next: GraphEdge?, next: ecs_graph_edge_t?,
} }
type GraphEdges = Map<i53, GraphEdge> type ecs_graph_edges_t = Map<i53, ecs_graph_edge_t>
type GraphNode = { type ecs_graph_node_t = {
add: GraphEdges, add: ecs_graph_edges_t,
remove: GraphEdges, remove: ecs_graph_edges_t,
refs: GraphEdge, refs: ecs_graph_edge_t,
} }
type ecs_archetype_t = {
id: number,
types: Ty,
type: string,
entities: { number },
columns: { Column },
records: { [i53]: number },
counts: { [i53]: number },
} & ecs_graph_node_t
export type Archetype = { export type Archetype = {
id: number, id: number,
types: Ty, types: Ty,
type: string, type: string,
entities: { number }, entities: { number },
columns: { Column }, columns: { Column },
records: { number }, records: { [Id]: number },
counts: { number }, counts: { [Id]: number },
} & GraphNode
export type Record = {
archetype: Archetype,
row: number,
dense: i24,
} }
type IdRecord = { type ecs_record_t = {
archetype: ecs_archetype_t,
row: number,
dense: i24
}
type ecs_id_record_t = {
cache: { number }, cache: { number },
counts: { number }, counts: { number },
flags: number, flags: number,
@ -57,22 +67,46 @@ type IdRecord = {
}, },
} }
type ComponentIndex = Map<i53, IdRecord> type ecs_id_index_t = Map<i53, ecs_id_record_t>
type Archetypes = { [ArchetypeId]: Archetype } type ecs_archetypes_map_t = { [string]: ecs_archetype_t }
type ArchetypeDiff = { type ecs_archetypes_t = { ecs_archetype_t }
added: Ty,
removed: Ty,
}
type EntityIndex = { type ecs_entity_index_t = {
dense_array: Map<i24, i53>, dense_array: Map<number, i53>,
sparse_array: Map<i53, Record>, sparse_array: Map<i24, ecs_record_t>,
alive_count: number, alive_count: number,
max_id: number, max_id: number,
} }
type ecs_query_data_t = {
compatible_archetypes: { ecs_archetype_t },
ids: { i53 },
filter_with: { i53 },
filter_without: { i53 },
next: () -> (number, ...any),
world: ecs_world_t,
}
type ecs_observer_t = {
callback: (archetype: ecs_archetype_t) -> (),
query: ecs_query_data_t,
}
type ecs_observable_t = Map<i53, Map<i53, { ecs_observer_t }>>
type ecs_world_t = {
entity_index: ecs_entity_index_t,
component_index: ecs_id_index_t,
archetypes: ecs_archetypes_t,
archetype_index: ecs_archetypes_map_t,
max_archetype_id: number,
max_component_id: number,
ROOT_ARCHETYPE: ecs_archetype_t,
observable: Map<i53, Map<i53, { ecs_observer_t }>>,
}
local HI_COMPONENT_ID = _G.__JECS_HI_COMPONENT_ID or 256 local HI_COMPONENT_ID = _G.__JECS_HI_COMPONENT_ID or 256
-- stylua: ignore start -- stylua: ignore start
local EcsOnAdd = HI_COMPONENT_ID + 1 local EcsOnAdd = HI_COMPONENT_ID + 1
@ -112,7 +146,7 @@ local function ECS_IS_PAIR(e: number): boolean
return e > ECS_PAIR_OFFSET return e > ECS_PAIR_OFFSET
end end
local function ECS_GENERATION_INC(e: i53) local function ECS_GENERATION_INC(e: i53): i53
if e > ECS_ENTITY_MASK then if e > ECS_ENTITY_MASK then
local id = e % ECS_ENTITY_MASK local id = e % ECS_ENTITY_MASK
local generation = e // ECS_ENTITY_MASK local generation = e // ECS_ENTITY_MASK
@ -143,10 +177,13 @@ local function ECS_PAIR(pred: i53, obj: i53): i53
pred %= ECS_ENTITY_MASK pred %= ECS_ENTITY_MASK
obj %= ECS_ENTITY_MASK obj %= ECS_ENTITY_MASK
return obj + (pred * 2^24) + ECS_PAIR_OFFSET return obj + (pred * ECS_ENTITY_MASK) + ECS_PAIR_OFFSET
end end
local function entity_index_try_get_any(entity_index: EntityIndex, entity: number): Record? local function entity_index_try_get_any(
entity_index: ecs_entity_index_t,
entity: number
): ecs_record_t?
local r = entity_index.sparse_array[ECS_ENTITY_T_LO(entity)] local r = entity_index.sparse_array[ECS_ENTITY_T_LO(entity)]
if not r or r.dense == 0 then if not r or r.dense == 0 then
@ -156,7 +193,7 @@ local function entity_index_try_get_any(entity_index: EntityIndex, entity: numbe
return r return r
end end
local function entity_index_try_get(entity_index: EntityIndex, entity: number): Record? local function entity_index_try_get(entity_index: ecs_entity_index_t, entity: number): ecs_record_t?
local r = entity_index_try_get_any(entity_index, entity) local r = entity_index_try_get_any(entity_index, entity)
if r then if r then
local r_dense = r.dense local r_dense = r.dense
@ -170,7 +207,7 @@ local function entity_index_try_get(entity_index: EntityIndex, entity: number):
return r return r
end end
local function entity_index_try_get_fast(entity_index: EntityIndex, entity: number): Record? local function entity_index_try_get_fast(entity_index: ecs_entity_index_t, entity: number): ecs_record_t?
local r = entity_index.sparse_array[ECS_ENTITY_T_LO(entity)] local r = entity_index.sparse_array[ECS_ENTITY_T_LO(entity)]
if r then if r then
if entity_index.dense_array[r.dense] ~= entity then if entity_index.dense_array[r.dense] ~= entity then
@ -180,49 +217,51 @@ local function entity_index_try_get_fast(entity_index: EntityIndex, entity: numb
return r return r
end end
local function entity_index_get_alive(index: EntityIndex, e: i24): i53 local function entity_index_get_alive(index: ecs_entity_index_t, id: i24): i53
local r = entity_index_try_get_any(index, e) local r = entity_index_try_get_any(index, id)
if r then if r then
return index.dense_array[r.dense] return index.dense_array[r.dense]
end end
return 0 return 0
end end
local function entity_index_is_alive(entity_index: EntityIndex, entity: number) local function entity_index_is_alive(entity_index: ecs_entity_index_t, entity: i53)
return entity_index_try_get(entity_index, entity) ~= nil return entity_index_try_get(entity_index, entity) ~= nil
end end
local function entity_index_new_id(entity_index: EntityIndex): i53 local function entity_index_new_id(entity_index: ecs_entity_index_t): i53
local dense_array = entity_index.dense_array local dense_array = entity_index.dense_array
local alive_count = entity_index.alive_count local alive_count = entity_index.alive_count
if alive_count ~= #dense_array then local max_id = entity_index.max_id
if alive_count ~= max_id then
alive_count += 1 alive_count += 1
entity_index.alive_count = alive_count entity_index.alive_count = alive_count
local id = dense_array[alive_count] local id = dense_array[alive_count]
return id return id
end end
local id = entity_index.max_id + 1 local id = max_id + 1
entity_index.max_id = id entity_index.max_id = id
alive_count += 1 alive_count += 1
entity_index.alive_count = alive_count entity_index.alive_count = alive_count
dense_array[alive_count] = id dense_array[alive_count] = id
entity_index.sparse_array[id] = { dense = alive_count } :: Record entity_index.sparse_array[id] = { dense = alive_count } :: ecs_record_t
return id return id
end end
local function ecs_pair_first(world, e) local function ecs_pair_first(world: ecs_world_t, e: i53)
local pred = (e - ECS_PAIR_OFFSET) // ECS_ENTITY_MASK local pred = (e - ECS_PAIR_OFFSET) // ECS_ENTITY_MASK
return entity_index_get_alive(world.entity_index, pred) return entity_index_get_alive(world.entity_index, pred)
end end
local function ecs_pair_second(world, e) local function ecs_pair_second(world: ecs_world_t, e: i53)
local obj = (e - ECS_PAIR_OFFSET) % ECS_ENTITY_MASK local obj = (e - ECS_PAIR_OFFSET) % ECS_ENTITY_MASK
return entity_index_get_alive(world.entity_index, obj) return entity_index_get_alive(world.entity_index, obj)
end end
local function query_match(query, archetype: Archetype) local function query_match(query: ecs_query_data_t,
archetype: ecs_archetype_t)
local records = archetype.records local records = archetype.records
local with = query.filter_with local with = query.filter_with
@ -244,7 +283,8 @@ local function query_match(query, archetype: Archetype)
return true return true
end end
local function find_observers(world: World, event, component): { Observer }? local function find_observers(world: ecs_world_t, event: i53,
component: i53): { ecs_observer_t }?
local cache = world.observable[event] local cache = world.observable[event]
if not cache then if not cache then
return nil return nil
@ -252,7 +292,13 @@ local function find_observers(world: World, event, component): { Observer }?
return cache[component] :: any return cache[component] :: any
end end
local function archetype_move(entity_index: EntityIndex, to: Archetype, dst_row: i24, from: Archetype, src_row: i24) local function archetype_move(
entity_index: ecs_entity_index_t,
to: ecs_archetype_t,
dst_row: i24,
from: ecs_archetype_t,
src_row: i24
)
local src_columns = from.columns local src_columns = from.columns
local dst_columns = to.columns local dst_columns = to.columns
local dst_entities = to.entities local dst_entities = to.entities
@ -306,21 +352,33 @@ local function archetype_move(entity_index: EntityIndex, to: Archetype, dst_row:
record2.row = src_row record2.row = src_row
end end
local function archetype_append(entity: number, archetype: Archetype): number local function archetype_append(
entity: i53,
archetype: ecs_archetype_t
): number
local entities = archetype.entities local entities = archetype.entities
local length = #entities + 1 local length = #entities + 1
entities[length] = entity entities[length] = entity
return length return length
end end
local function new_entity(entity: i53, record: Record, archetype: Archetype): Record local function new_entity(
entity: i53,
record: ecs_record_t,
archetype: ecs_archetype_t
): ecs_record_t
local row = archetype_append(entity, archetype) local row = archetype_append(entity, archetype)
record.archetype = archetype record.archetype = archetype
record.row = row record.row = row
return record return record
end end
local function entity_move(entity_index: EntityIndex, entity: i53, record: Record, to: Archetype) local function entity_move(
entity_index: ecs_entity_index_t,
entity: i53,
record: ecs_record_t,
to: ecs_archetype_t
)
local sourceRow = record.row local sourceRow = record.row
local from = record.archetype local from = record.archetype
local dst_row = archetype_append(entity, to) local dst_row = archetype_append(entity, to)
@ -333,7 +391,8 @@ local function hash(arr: { number }): string
return table.concat(arr, "_") return table.concat(arr, "_")
end end
local function fetch(id, records: { number }, columns: { Column }, row: number): any local function fetch(id: i53, records: { number },
columns: { Column }, row: number): any
local tr = records[id] local tr = records[id]
if not tr then if not tr then
@ -343,7 +402,8 @@ local function fetch(id, records: { number }, columns: { Column }, row: number):
return columns[tr][row] return columns[tr][row]
end end
local function world_get(world: World, entity: i53, a: i53, b: i53?, c: i53?, d: i53?, e: i53?): ...any local function world_get(world: ecs_world_t, entity: i53,
a: i53, b: i53?, c: i53?, d: i53?, e: i53?): ...any
local record = entity_index_try_get_fast(world.entity_index, entity) local record = entity_index_try_get_fast(world.entity_index, entity)
if not record then if not record then
return nil return nil
@ -373,7 +433,7 @@ local function world_get(world: World, entity: i53, a: i53, b: i53?, c: i53?, d:
end end
end end
local function world_get_one_inline(world: World, entity: i53, id: i53): any local function world_get_one_inline(world: ecs_world_t, entity: i53, id: i53): any
local record = entity_index_try_get_fast(world.entity_index, entity) local record = entity_index_try_get_fast(world.entity_index, entity)
if not record then if not record then
return nil return nil
@ -391,7 +451,7 @@ local function world_get_one_inline(world: World, entity: i53, id: i53): any
return archetype.columns[tr][record.row] return archetype.columns[tr][record.row]
end end
local function world_has_one_inline(world: World, entity: number, id: i53): boolean local function world_has_one_inline(world: ecs_world_t, entity: i53, id: i53): boolean
local record = entity_index_try_get_fast(world.entity_index, entity) local record = entity_index_try_get_fast(world.entity_index, entity)
if not record then if not record then
return false return false
@ -407,7 +467,7 @@ local function world_has_one_inline(world: World, entity: number, id: i53): bool
return records[id] ~= nil return records[id] ~= nil
end end
local function world_has(world: World, entity: number, ...: i53): boolean local function world_has(world: ecs_world_t, entity: i53, ...: i53): boolean
local record = entity_index_try_get_fast(world.entity_index, entity) local record = entity_index_try_get_fast(world.entity_index, entity)
if not record then if not record then
return false return false
@ -429,7 +489,7 @@ local function world_has(world: World, entity: number, ...: i53): boolean
return true return true
end end
local function world_target(world: World, entity: i53, relation: i24, index: number?): i24? local function world_target(world: ecs_world_t, entity: i53, relation: i24, index: number?): i24?
local nth = index or 0 local nth = index or 0
local record = entity_index_try_get_fast(world.entity_index, entity) local record = entity_index_try_get_fast(world.entity_index, entity)
if not record then if not record then
@ -473,9 +533,9 @@ local function ECS_ID_IS_WILDCARD(e: i53): boolean
return first == EcsWildcard or second == EcsWildcard return first == EcsWildcard or second == EcsWildcard
end end
local function id_record_ensure(world: World, id: number): IdRecord local function id_record_ensure(world: ecs_world_t, id: number): ecs_id_record_t
local component_index = world.component_index local component_index = world.component_index
local idr: IdRecord = component_index[id] local idr: ecs_id_record_t = component_index[id]
if not idr then if not idr then
local flags = ECS_ID_MASK local flags = ECS_ID_MASK
@ -530,9 +590,9 @@ local function id_record_ensure(world: World, id: number): IdRecord
end end
local function archetype_append_to_records( local function archetype_append_to_records(
idr: IdRecord, idr: ecs_id_record_t,
archetype: Archetype, archetype: ecs_archetype_t,
id: number, id: i53,
index: number index: number
) )
local archetype_id = archetype.id local archetype_id = archetype.id
@ -554,7 +614,7 @@ local function archetype_append_to_records(
end end
end end
local function archetype_create(world: World, id_types: { i24 }, ty, prev: i53?): Archetype local function archetype_create(world: ecs_world_t, id_types: { i24 }, ty, prev: i53?): ecs_archetype_t
local archetype_id = (world.max_archetype_id :: number) + 1 local archetype_id = (world.max_archetype_id :: number) + 1
world.max_archetype_id = archetype_id world.max_archetype_id = archetype_id
@ -564,7 +624,7 @@ local function archetype_create(world: World, id_types: { i24 }, ty, prev: i53?)
local records: { number } = {} local records: { number } = {}
local counts: {number} = {} local counts: {number} = {}
local archetype: Archetype = { local archetype: ecs_archetype_t = {
columns = columns, columns = columns,
entities = {}, entities = {},
id = archetype_id, id = archetype_id,
@ -575,16 +635,16 @@ local function archetype_create(world: World, id_types: { i24 }, ty, prev: i53?)
add = {}, add = {},
remove = {}, remove = {},
refs = {} :: GraphEdge, refs = {} :: ecs_graph_edge_t,
} }
for i, componentId in id_types do for i, component_id in id_types do
local idr = id_record_ensure(world, componentId) local idr = id_record_ensure(world, component_id)
archetype_append_to_records(idr, archetype, componentId, i) archetype_append_to_records(idr, archetype, component_id, i)
if ECS_IS_PAIR(componentId) then if ECS_IS_PAIR(component_id) then
local relation = ecs_pair_first(world, componentId) local relation = ecs_pair_first(world, component_id)
local object = ecs_pair_second(world, componentId) local object = ecs_pair_second(world, component_id)
local r = ECS_PAIR(relation, EcsWildcard) local r = ECS_PAIR(relation, EcsWildcard)
local idr_r = id_record_ensure(world, r) local idr_r = id_record_ensure(world, r)
@ -620,15 +680,15 @@ local function archetype_create(world: World, id_types: { i24 }, ty, prev: i53?)
return archetype return archetype
end end
local function world_entity(world: World): i53 local function world_entity(world: ecs_world_t): i53
return entity_index_new_id(world.entity_index) return entity_index_new_id(world.entity_index)
end end
local function world_parent(world: World, entity: i53) local function world_parent(world: ecs_world_t, entity: i53)
return world_target(world, entity, EcsChildOf, 0) return world_target(world, entity, EcsChildOf, 0)
end end
local function archetype_ensure(world: World, id_types): Archetype local function archetype_ensure(world: ecs_world_t, id_types): ecs_archetype_t
if #id_types < 1 then if #id_types < 1 then
return world.ROOT_ARCHETYPE return world.ROOT_ARCHETYPE
end end
@ -654,7 +714,7 @@ local function find_insert(id_types: { i53 }, toAdd: i53): number
return #id_types + 1 return #id_types + 1
end end
local function find_archetype_with(world: World, node: Archetype, id: i53): Archetype local function find_archetype_with(world: ecs_world_t, node: ecs_archetype_t, id: i53): ecs_archetype_t
local id_types = node.types local id_types = node.types
-- Component IDs are added incrementally, so inserting and sorting -- Component IDs are added incrementally, so inserting and sorting
-- them each time would be expensive. Instead this insertion sort can find the insertion -- them each time would be expensive. Instead this insertion sort can find the insertion
@ -672,7 +732,11 @@ local function find_archetype_with(world: World, node: Archetype, id: i53): Arch
return archetype_ensure(world, dst) return archetype_ensure(world, dst)
end end
local function find_archetype_without(world: World, node: Archetype, id: i53): Archetype local function find_archetype_without(
world: ecs_world_t,
node: ecs_archetype_t,
id: i53
): ecs_archetype_t
local id_types = node.types local id_types = node.types
local at = table.find(id_types, id) local at = table.find(id_types, id)
if at == nil then if at == nil then
@ -685,23 +749,32 @@ local function find_archetype_without(world: World, node: Archetype, id: i53): A
return archetype_ensure(world, dst) return archetype_ensure(world, dst)
end end
local function archetype_init_edge(archetype: Archetype, edge: GraphEdge, id: i53, to: Archetype) local function archetype_init_edge(
archetype: ecs_archetype_t,
edge: ecs_graph_edge_t,
id: i53,
to: ecs_archetype_t
)
edge.from = archetype edge.from = archetype
edge.to = to edge.to = to
edge.id = id edge.id = id
end end
local function archetype_ensure_edge(world, edges: GraphEdges, id): GraphEdge local function archetype_ensure_edge(
world: ecs_world_t,
edges: ecs_graph_edges_t,
id: i53
): ecs_graph_edge_t
local edge = edges[id] local edge = edges[id]
if not edge then if not edge then
edge = {} :: GraphEdge edge = {} :: ecs_graph_edge_t
edges[id] = edge edges[id] = edge
end end
return edge return edge
end end
local function init_edge_for_add(world, archetype: Archetype, edge: GraphEdge, id, to: Archetype) local function init_edge_for_add(world, archetype: ecs_archetype_t, edge: ecs_graph_edge_t, id, to: ecs_archetype_t)
archetype_init_edge(archetype, edge, id, to) archetype_init_edge(archetype, edge, id, to)
archetype_ensure_edge(world, archetype.add, id) archetype_ensure_edge(world, archetype.add, id)
if archetype ~= to then if archetype ~= to then
@ -718,7 +791,13 @@ local function init_edge_for_add(world, archetype: Archetype, edge: GraphEdge, i
end end
end end
local function init_edge_for_remove(world: World, archetype: Archetype, edge: GraphEdge, id: number, to: Archetype) local function init_edge_for_remove(
world: ecs_world_t,
archetype: ecs_archetype_t,
edge: ecs_graph_edge_t,
id: number,
to: ecs_archetype_t
)
archetype_init_edge(archetype, edge, id, to) archetype_init_edge(archetype, edge, id, to)
archetype_ensure_edge(world, archetype.remove, id) archetype_ensure_edge(world, archetype.remove, id)
if archetype ~= to then if archetype ~= to then
@ -735,19 +814,33 @@ local function init_edge_for_remove(world: World, archetype: Archetype, edge: Gr
end end
end end
local function create_edge_for_add(world: World, node: Archetype, edge: GraphEdge, id: i53): Archetype local function create_edge_for_add(
world: ecs_world_t,
node: ecs_archetype_t,
edge: ecs_graph_edge_t,
id: i53
): ecs_archetype_t
local to = find_archetype_with(world, node, id) local to = find_archetype_with(world, node, id)
init_edge_for_add(world, node, edge, id, to) init_edge_for_add(world, node, edge, id, to)
return to return to
end end
local function create_edge_for_remove(world: World, node: Archetype, edge: GraphEdge, id: i53): Archetype local function create_edge_for_remove(
world: ecs_world_t,
node: ecs_archetype_t,
edge: ecs_graph_edge_t,
id: i53
): ecs_archetype_t
local to = find_archetype_without(world, node, id) local to = find_archetype_without(world, node, id)
init_edge_for_remove(world, node, edge, id, to) init_edge_for_remove(world, node, edge, id, to)
return to return to
end end
local function archetype_traverse_add(world: World, id: i53, from: Archetype): Archetype local function archetype_traverse_add(
world: ecs_world_t,
id: i53,
from: ecs_archetype_t
): ecs_archetype_t
from = from or world.ROOT_ARCHETYPE from = from or world.ROOT_ARCHETYPE
local edge = archetype_ensure_edge(world, from.add, id) local edge = archetype_ensure_edge(world, from.add, id)
@ -756,10 +849,14 @@ local function archetype_traverse_add(world: World, id: i53, from: Archetype): A
to = create_edge_for_add(world, from, edge, id) to = create_edge_for_add(world, from, edge, id)
end end
return to :: Archetype return to :: ecs_archetype_t
end end
local function archetype_traverse_remove(world: World, id: i53, from: Archetype): Archetype local function archetype_traverse_remove(
world: ecs_world_t,
id: i53,
from: ecs_archetype_t
): ecs_archetype_t
from = from or world.ROOT_ARCHETYPE from = from or world.ROOT_ARCHETYPE
local edge = archetype_ensure_edge(world, from.remove, id) local edge = archetype_ensure_edge(world, from.remove, id)
@ -769,10 +866,14 @@ local function archetype_traverse_remove(world: World, id: i53, from: Archetype)
to = create_edge_for_remove(world, from, edge, id) to = create_edge_for_remove(world, from, edge, id)
end end
return to :: Archetype return to :: ecs_archetype_t
end end
local function world_add(world: World, entity: i53, id: i53): () local function world_add(
world: ecs_world_t,
entity: i53,
id: i53
): ()
local entity_index = world.entity_index local entity_index = world.entity_index
local record = entity_index_try_get_fast(entity_index, entity) local record = entity_index_try_get_fast(entity_index, entity)
if not record then if not record then
@ -800,15 +901,15 @@ local function world_add(world: World, entity: i53, id: i53): ()
end end
end end
local function world_set(world: World, entity: i53, id: i53, data: unknown): () local function world_set(world: ecs_world_t, entity: i53, id: i53, data: unknown): ()
local entity_index = world.entity_index local entity_index = world.entity_index
local record = entity_index_try_get_fast(entity_index, entity) local record = entity_index_try_get_fast(entity_index, entity)
if not record then if not record then
return return
end end
local from: Archetype = record.archetype local from: ecs_archetype_t = record.archetype
local to: Archetype = archetype_traverse_add(world, id, from) local to: ecs_archetype_t = archetype_traverse_add(world, id, from)
local idr = world.component_index[id] local idr = world.component_index[id]
local idr_hooks = idr.hooks local idr_hooks = idr.hooks
@ -864,7 +965,7 @@ local function world_component(world: World): i53
return id return id
end end
local function world_remove(world: World, entity: i53, id: i53) local function world_remove(world: ecs_world_t, entity: i53, id: i53)
local entity_index = world.entity_index local entity_index = world.entity_index
local record = entity_index_try_get_fast(entity_index, entity) local record = entity_index_try_get_fast(entity_index, entity)
if not record then if not record then
@ -906,7 +1007,7 @@ local function archetype_fast_delete(columns: { Column }, column_count: number,
end end
end end
local function archetype_delete(world: World, archetype: Archetype, row: number, destruct: boolean?) local function archetype_delete(world: ecs_world_t, archetype: ecs_archetype_t, row: number)
local entity_index = world.entity_index local entity_index = world.entity_index
local component_index = world.component_index local component_index = world.component_index
local columns = archetype.columns local columns = archetype.columns
@ -945,7 +1046,7 @@ local function archetype_delete(world: World, archetype: Archetype, row: number,
end end
end end
local function world_clear(world: World, entity: i53) local function world_clear(world: ecs_world_t, entity: i53)
--TODO: use sparse_get (stashed) --TODO: use sparse_get (stashed)
local record = entity_index_try_get(world.entity_index, entity) local record = entity_index_try_get(world.entity_index, entity)
if not record then if not record then
@ -965,7 +1066,7 @@ local function world_clear(world: World, entity: i53)
record.row = nil :: any record.row = nil :: any
end end
local function archetype_disconnect_edge(edge: GraphEdge) local function archetype_disconnect_edge(edge: ecs_graph_edge_t)
local edge_next = edge.next local edge_next = edge.next
local edge_prev = edge.prev local edge_prev = edge.prev
if edge_next then if edge_next then
@ -976,14 +1077,14 @@ local function archetype_disconnect_edge(edge: GraphEdge)
end end
end end
local function archetype_remove_edge(edges: Map<i53, GraphEdge>, id: i53, edge: GraphEdge) local function archetype_remove_edge(edges: ecs_graph_edges_t, id: i53, edge: ecs_graph_edge_t)
archetype_disconnect_edge(edge) archetype_disconnect_edge(edge)
edges[id] = nil :: any edges[id] = nil :: any
end end
local function archetype_clear_edges(archetype: Archetype) local function archetype_clear_edges(archetype: ecs_archetype_t)
local add: GraphEdges = archetype.add local add: ecs_graph_edges_t = archetype.add
local remove: GraphEdges = archetype.remove local remove: ecs_graph_edges_t = archetype.remove
local node_refs = archetype.refs local node_refs = archetype.refs
for id, edge in add do for id, edge in add do
archetype_disconnect_edge(edge) archetype_disconnect_edge(edge)
@ -996,7 +1097,7 @@ local function archetype_clear_edges(archetype: Archetype)
local cur = node_refs.next local cur = node_refs.next
while cur do while cur do
local edge = cur :: GraphEdge local edge = cur :: ecs_graph_edge_t
local next_edge = edge.next local next_edge = edge.next
archetype_remove_edge(edge.from.add, edge.id, edge) archetype_remove_edge(edge.from.add, edge.id, edge)
cur = next_edge cur = next_edge
@ -1004,7 +1105,7 @@ local function archetype_clear_edges(archetype: Archetype)
cur = node_refs.prev cur = node_refs.prev
while cur do while cur do
local edge: GraphEdge = cur local edge: ecs_graph_edge_t = cur
local next_edge = edge.prev local next_edge = edge.prev
archetype_remove_edge(edge.from.remove, edge.id, edge) archetype_remove_edge(edge.from.remove, edge.id, edge)
cur = next_edge cur = next_edge
@ -1014,7 +1115,7 @@ local function archetype_clear_edges(archetype: Archetype)
node_refs.prev = nil node_refs.prev = nil
end end
local function archetype_destroy(world: World, archetype: Archetype) local function archetype_destroy(world: ecs_world_t, archetype: ecs_archetype_t)
if archetype == world.ROOT_ARCHETYPE then if archetype == world.ROOT_ARCHETYPE then
return return
end end
@ -1050,7 +1151,7 @@ local function archetype_destroy(world: World, archetype: Archetype)
end end
end end
local function world_cleanup(world: World) local function world_cleanup(world: ecs_world_t)
local archetypes = world.archetypes local archetypes = world.archetypes
for _, archetype in archetypes do for _, archetype in archetypes do
@ -1059,7 +1160,7 @@ local function world_cleanup(world: World)
end end
end end
local new_archetypes = table.create(#archetypes) :: { Archetype } local new_archetypes = table.create(#archetypes) :: { ecs_archetype_t }
local new_archetype_map = {} local new_archetype_map = {}
for index, archetype in archetypes do for index, archetype in archetypes do
@ -1071,9 +1172,7 @@ local function world_cleanup(world: World)
world.archetype_index = new_archetype_map world.archetype_index = new_archetype_map
end end
local world_delete: (world: World, entity: i53, destruct: boolean?) -> () local function world_delete(world: ecs_world_t, entity: i53)
do
function world_delete(world: World, entity: i53, destruct: boolean?)
local entity_index = world.entity_index local entity_index = world.entity_index
local record = entity_index_try_get(entity_index, entity) local record = entity_index_try_get(entity_index, entity)
if not record then if not record then
@ -1086,12 +1185,12 @@ do
if archetype then if archetype then
-- In the future should have a destruct mode for -- In the future should have a destruct mode for
-- deleting archetypes themselves. Maybe requires recycling -- deleting archetypes themselves. Maybe requires recycling
archetype_delete(world, archetype, row, destruct) archetype_delete(world, archetype, row)
end end
local delete = entity local delete = entity
local component_index = world.component_index local component_index = world.component_index
local archetypes: Archetypes = world.archetypes local archetypes = world.archetypes
local tgt = ECS_PAIR(EcsWildcard, delete) local tgt = ECS_PAIR(EcsWildcard, delete)
local idr_t = component_index[tgt] local idr_t = component_index[tgt]
local idr = component_index[delete] local idr = component_index[delete]
@ -1192,7 +1291,7 @@ do
entity_index.alive_count = index_of_last_alive_entity - 1 entity_index.alive_count = index_of_last_alive_entity - 1
local last_alive_entity = dense_array[index_of_last_alive_entity] local last_alive_entity = dense_array[index_of_last_alive_entity]
local r_swap = entity_index_try_get_any(entity_index, last_alive_entity) :: Record local r_swap = entity_index_try_get_any(entity_index, last_alive_entity) :: ecs_record_t
r_swap.dense = index_of_deleted_entity r_swap.dense = index_of_deleted_entity
record.archetype = nil :: any record.archetype = nil :: any
record.row = nil :: any record.row = nil :: any
@ -1201,15 +1300,14 @@ do
dense_array[index_of_deleted_entity] = last_alive_entity dense_array[index_of_deleted_entity] = last_alive_entity
dense_array[index_of_last_alive_entity] = ECS_GENERATION_INC(entity) dense_array[index_of_last_alive_entity] = ECS_GENERATION_INC(entity)
end end
end
local function world_contains(world: World, entity): boolean local function world_contains(world: ecs_world_t, entity): boolean
return entity_index_is_alive(world.entity_index, entity) return entity_index_is_alive(world.entity_index, entity)
end end
local function NOOP() end local function NOOP() end
type QueryInner = { export type QueryInner = {
compatible_archetypes: { Archetype }, compatible_archetypes: { Archetype },
ids: { i53 }, ids: { i53 },
filter_with: { i53 }, filter_with: { i53 },
@ -1218,7 +1316,9 @@ type QueryInner = {
world: World, world: World,
} }
local function query_iter_init(query: QueryInner): () -> (number, ...any)
local function query_iter_init(query: ecs_query_data_t): () -> (number, ...any)
local world_query_iter_next local world_query_iter_next
local compatible_archetypes = query.compatible_archetypes local compatible_archetypes = query.compatible_archetypes
@ -1563,7 +1663,7 @@ local function query_iter(query): () -> (number, ...any)
return query_next return query_next
end end
local function query_without(query: QueryInner, ...: i53) local function query_without(query: ecs_query_data_t, ...: i53)
local without = { ... } local without = { ... }
query.filter_without = without query.filter_without = without
local compatible_archetypes = query.compatible_archetypes local compatible_archetypes = query.compatible_archetypes
@ -1593,7 +1693,7 @@ local function query_without(query: QueryInner, ...: i53)
return query :: any return query :: any
end end
local function query_with(query: QueryInner, ...: i53) local function query_with(query: ecs_query_data_t, ...: i53)
local compatible_archetypes = query.compatible_archetypes local compatible_archetypes = query.compatible_archetypes
local with = { ... } local with = { ... }
query.filter_with = with query.filter_with = with
@ -1631,7 +1731,7 @@ local function query_archetypes(query)
return query.compatible_archetypes return query.compatible_archetypes
end end
local function query_cached(query: QueryInner) local function query_cached(query: ecs_query_data_t)
local with = query.filter_with local with = query.filter_with
local ids = query.ids local ids = query.ids
if with then if with then
@ -1651,14 +1751,14 @@ local function query_cached(query: QueryInner)
local columns: { Column } local columns: { Column }
local entities: { number } local entities: { number }
local i: number local i: number
local archetype: Archetype local archetype: ecs_archetype_t
local records: { number } local records: { number }
local archetypes = query.compatible_archetypes local archetypes = query.compatible_archetypes
local world = query.world :: { observable: Observable } local world = query.world :: { observable: ecs_observable_t }
-- Only need one observer for EcsArchetypeCreate and EcsArchetypeDelete respectively -- Only need one observer for EcsArchetypeCreate and EcsArchetypeDelete respectively
-- because the event will be emitted for all components of that Archetype. -- because the event will be emitted for all components of that Archetype.
local observable = world.observable :: Observable local observable = world.observable :: ecs_observable_t
local on_create_action = observable[EcsOnArchetypeCreate] local on_create_action = observable[EcsOnArchetypeCreate]
if not on_create_action then if not on_create_action then
on_create_action = {} on_create_action = {}
@ -2052,7 +2152,7 @@ Query.with = query_with
Query.archetypes = query_archetypes Query.archetypes = query_archetypes
Query.cached = query_cached Query.cached = query_cached
local function world_query(world: World, ...) local function world_query(world: ecs_world_t, ...)
local compatible_archetypes = {} local compatible_archetypes = {}
local length = 0 local length = 0
@ -2060,7 +2160,7 @@ local function world_query(world: World, ...)
local archetypes = world.archetypes local archetypes = world.archetypes
local idr: IdRecord? local idr: ecs_id_record_t?
local component_index = world.component_index local component_index = world.component_index
local q = setmetatable({ local q = setmetatable({
@ -2112,7 +2212,7 @@ local function world_query(world: World, ...)
return q return q
end end
local function world_each(world: World, id): () -> () local function world_each(world: ecs_world_t, id: i53): () -> ()
local idr = world.component_index[id] local idr = world.component_index[id]
if not idr then if not idr then
return NOOP return NOOP
@ -2146,10 +2246,36 @@ local function world_each(world: World, id): () -> ()
end end
end end
local function world_children(world, parent) local function world_children(world: ecs_world_t, parent: i53)
return world_each(world, ECS_PAIR(EcsChildOf, parent)) return world_each(world, ECS_PAIR(EcsChildOf, parent))
end end
export type Record = {
archetype: Archetype,
row: number,
dense: i24,
}
export type ComponentRecord = {
cache: { [Id]: number },
counts: { [Id]: number },
flags: number,
size: number,
hooks: {
on_add: ((entity: Entity) -> ())?,
on_set: ((entity: Entity, data: any) -> ())?,
on_remove: ((entity: Entity) -> ())?,
},
}
export type ComponentIndex = Map<Id, ComponentRecord>
export type Archetypes = { [Id]: Archetype }
export type EntityIndex = {
dense_array: Map<number, Entity>,
sparse_array: Map<i24, Record>,
alive_count: number,
max_id: number,
}
local World = {} local World = {}
World.__index = World World.__index = World
@ -2170,122 +2296,13 @@ World.cleanup = world_cleanup
World.each = world_each World.each = world_each
World.children = world_children World.children = world_children
if _G.__JECS_DEBUG then local function world_new()
local function dbg_info(n: number): any local entity_index = {
return debug.info(n, "s") dense_array = {},
end sparse_array = {},
local function throw(msg: string)
local s = 1
local root = dbg_info(1)
repeat
s += 1
until dbg_info(s) ~= root
if warn then
error(msg, s)
else
print(`[jecs] error: {msg}\n`)
end
end
local function ASSERT<T>(v: T, msg: string)
if v then
return
end
throw(msg)
end
local function get_name(world, id)
return world_get_one_inline(world, id, EcsName)
end
local function bname(world: World, id): string
local name: string
if ECS_IS_PAIR(id) then
local first = get_name(world, ecs_pair_first(world, id))
local second = get_name(world, ecs_pair_second(world, id))
name = `pair({first}, {second})`
else
return get_name(world, id)
end
if name then
return name
else
return `${id}`
end
end
local function ID_IS_TAG(world: World, id)
if ECS_IS_PAIR(id) then
id = ecs_pair_first(world, id)
end
return not world_has_one_inline(world, id, EcsComponent)
end
World.query = function(world: World, ...)
ASSERT((...), "Requires at least a single component")
return world_query(world, ...)
end
World.set = function(world: World, entity: i53, id: i53, value: any): ()
local is_tag = ID_IS_TAG(world, id)
if is_tag and value == nil then
local _1 = bname(world, entity)
local _2 = bname(world, id)
local why = "cannot set component value to nil"
throw(why)
return
elseif value ~= nil and is_tag then
local _1 = bname(world, entity)
local _2 = bname(world, id)
local why = `cannot set a component value because {_2} is a tag`
why ..= `\n[jecs] note: consider using "world:add({_1}, {_2})" instead`
throw(why)
return
end
world_set(world, entity, id, value)
end
World.add = function(world: World, entity: i53, id: i53, value: any)
if value ~= nil then
local _1 = bname(world, entity)
local _2 = bname(world, id)
throw("You provided a value when none was expected. " .. `Did you mean to use "world:add({_1}, {_2})"`)
end
world_add(world, entity, id)
end
World.get = function(world: World, entity: i53, ...)
local length = select("#", ...)
ASSERT(length < 5, "world:get does not support more than 4 components")
local _1
for i = 1, length do
local id = select(i, ...)
local id_is_tag = not world_has(world, id, EcsComponent)
if id_is_tag then
local name = get_name(world, id)
if not _1 then
_1 = get_name(world, entity)
end
throw(
`cannot get (#{i}) component {name} value because it is a tag.`
.. `\n[jecs] note: If this was intentional, use "world:has({_1}, {name}) instead"`
)
end
end
return world_get(world, entity, ...)
end
end
function World.new()
local entity_index: EntityIndex = {
dense_array = {} :: { [i24]: i53 },
sparse_array = {} :: { [i53]: Record },
alive_count = 0, alive_count = 0,
max_id = 0, max_id = 0,
} } :: ecs_entity_index_t
local self = setmetatable({ local self = setmetatable({
archetype_index = {} :: { [string]: Archetype }, archetype_index = {} :: { [string]: Archetype },
archetypes = {} :: Archetypes, archetypes = {} :: Archetypes,
@ -2336,23 +2353,13 @@ function World.new()
return self return self
end end
export type Entity<T = unknown> = {__T: T} World.new = world_new
export type Id<T = unknown> =
| Entity<T>
| Pair<Entity<T>, Entity>
| Pair<Entity, Entity<T>>
| Pair<Entity<T>, Entity<unknown>>
export type Pair<P, O> = number & {
__P: P,
__O: O,
}
type Item<T...> = (self: Query<T...>) -> (Entity, T...)
type Iter<T...> = (query: Query<T...>) -> () -> (Entity, T...)
export type Entity<T = unknown> = { __nominal_entity: "Tag", __phantom_data: T }
export type Id<T = unknown> = { __phantom_data: T }
export type Pair<P, O> = { __phantom_data: P }
export type Item<T...> = (self: Query<T...>) -> (Entity, T...)
export type Iter<T...> = (query: Query<T...>) -> () -> (Entity, T...)
export type Query<T...> = typeof(setmetatable({}, { export type Query<T...> = typeof(setmetatable({}, {
__iter = (nil :: any) :: Iter<T...>, __iter = (nil :: any) :: Iter<T...>,
@ -2369,9 +2376,9 @@ export type Observer = {
query: QueryInner, query: QueryInner,
} }
type Observable = { export type Observable = {
[i53]: { [Id]: {
[i53]: { [Id]: {
{ Observer } { Observer }
} }
} }

10
test/devtools_test.luau
View file

@ -5,21 +5,21 @@ local lifetime_tracker_add = require("@tools/lifetime_tracker")
local pe = require("@tools/entity_visualiser").prettify local pe = require("@tools/entity_visualiser").prettify
local world = lifetime_tracker_add(jecs.world(), {padding_enabled=false}) local world = lifetime_tracker_add(jecs.world(), {padding_enabled=false})
local FriendsWith = world:component() local FriendsWith = world:component()
local _1 = world:print_snapshot() world:print_snapshot()
local e1 = world:entity() local e1 = world:entity()
local e2 = world:entity() local e2 = world:entity()
world:delete(e2) world:delete(e2)
local _2 = world:print_snapshot() world:print_snapshot()
local e3 = world:entity() local e3 = world:entity()
world:add(e3, pair(ChildOf, e1)) world:add(e3, pair(ChildOf, e1))
local e4 = world:entity() local e4 = world:entity()
world:add(e4, pair(FriendsWith, e3)) world:add(e4, pair(FriendsWith, e3))
local _3 = world:print_snapshot() world:print_snapshot()
world:delete(e1) world:delete(e1)
world:delete(e3) world:delete(e3)
local _4 = world:print_snapshot() world:print_snapshot()
world:print_entity_index() world:print_entity_index()
world:entity() world:entity()
world:entity() world:entity()
local _5 = world:print_snapshot() world:print_snapshot()

42
test/tests.luau
View file

@ -117,6 +117,34 @@ local function name(world, e)
return world:get(e, jecs.Name) return world:get(e, jecs.Name)
end end
TEST("#repro2", function()
local world = world_new()
local Lifetime = world:component() :: jecs.Id<number>
local Particle = world:entity()
local Beam = world:entity()
local entity = world:entity()
world:set(entity, pair(Lifetime, Particle), 1)
world:set(entity, pair(Lifetime, Beam), 2)
for e in world:each(pair(Lifetime, __)) do
local i = 0
local nth = world:target(e, Lifetime, i)
while nth do
local data = world:get(e, pair(Lifetime, nth))
if nth == Particle then
CHECK(data == 1)
elseif nth == Beam then
CHECK(data == 2)
else
CHECK(false)
end
i += 1
nth = world:target(e, Lifetime, i)
end
end
end)
TEST("#repro", function() TEST("#repro", function()
local world = world_new() local world = world_new()
@ -1394,24 +1422,10 @@ TEST("world:target", function()
CHECK(world:target(e, C, 0) == D) CHECK(world:target(e, C, 0) == D)
CHECK(world:target(e, C, 1) == nil) CHECK(world:target(e, C, 1) == nil)
-- for id in archetype.records do
-- local f = world:get(ecs_pair_first(world, id), jecs.Name)
-- local s = world:get(ecs_pair_second(world, id), jecs.Name)
-- print(`({f}, {s})`)
-- end
--
CHECK(archetype.records[pair(A, B)] == 1) CHECK(archetype.records[pair(A, B)] == 1)
CHECK(archetype.records[pair(A, C)] == 2) CHECK(archetype.records[pair(A, C)] == 2)
CHECK(archetype.records[pair(A, D)] == 3) CHECK(archetype.records[pair(A, D)] == 3)
CHECK(archetype.records[pair(A, E)] == 4) CHECK(archetype.records[pair(A, E)] == 4)
-- print("(A, B)", archetype.records[pair(A, B)])
-- print("(A, C)", archetype.records[pair(A, C)])
-- print("(A, D)", archetype.records[pair(A, D)])
-- print("(A, E)", archetype.records[pair(A, E)])
-- print(pair(A, D), pair(B, C))
-- print("(B, C)", archetype.records[pair(B, C)])
CHECK(world:target(e, C, 0) == D) CHECK(world:target(e, C, 0) == D)
CHECK(world:target(e, C, 1) == nil) CHECK(world:target(e, C, 1) == nil)

108
tools/runtime_lints.luau Normal file
View file

@ -0,0 +1,108 @@
local function dbg_info(n: number): any
return debug.info(n, "s")
end
local function throw(msg: string)
local s = 1
local root = dbg_info(1)
repeat
s += 1
until dbg_info(s) ~= root
if warn then
error(msg, s)
else
print(`[jecs] error: {msg}\n`)
end
end
local function ASSERT<T>(v: T, msg: string)
if v then
return
end
throw(msg)
end
local function runtime_lints_add(world)
local function get_name(id)
return world_get_one_inline(world, id, EcsName)
end
local function bname(id): string
local name: string
if ECS_IS_PAIR(id) then
local first = get_name(world, ecs_pair_first(world, id))
local second = get_name(world, ecs_pair_second(world, id))
name = `pair({first}, {second})`
else
return get_name(world, id)
end
if name then
return name
else
return `${id}`
end
end
local function ID_IS_TAG(world: World, id)
if ECS_IS_PAIR(id) then
id = ecs_pair_first(world, id)
end
return not world_has_one_inline(world, id, EcsComponent)
end
World.query = function(world: World, ...)
ASSERT((...), "Requires at least a single component")
return world_query(world, ...)
end
World.set = function(world: World, entity: i53, id: i53, value: any): ()
local is_tag = ID_IS_TAG(world, id)
if is_tag and value == nil then
local _1 = bname(world, entity)
local _2 = bname(world, id)
local why = "cannot set component value to nil"
throw(why)
return
elseif value ~= nil and is_tag then
local _1 = bname(world, entity)
local _2 = bname(world, id)
local why = `cannot set a component value because {_2} is a tag`
why ..= `\n[jecs] note: consider using "world:add({_1}, {_2})" instead`
throw(why)
return
end
world_set(world, entity, id, value)
end
World.add = function(world: World, entity: i53, id: i53, value: any)
if value ~= nil then
local _1 = bname(world, entity)
local _2 = bname(world, id)
throw("You provided a value when none was expected. " .. `Did you mean to use "world:add({_1}, {_2})"`)
end
world_add(world, entity, id)
end
World.get = function(world: World, entity: i53, ...)
local length = select("#", ...)
ASSERT(length < 5, "world:get does not support more than 4 components")
local _1
for i = 1, length do
local id = select(i, ...)
local id_is_tag = not world_has(world, id, EcsComponent)
if id_is_tag then
local name = get_name(world, id)
if not _1 then
_1 = get_name(world, entity)
end
throw(
`cannot get (#{i}) component {name} value because it is a tag.`
.. `\n[jecs] note: If this was intentional, use "world:has({_1}, {name}) instead"`
)
end
end
return world_get(world, entity, ...)
end
end