Skip to content

Commit

Permalink
Add wildcards (#37)
Browse files Browse the repository at this point in the history 
* Fix export

* Initial commit

* Uncomment cases

* Rename case

* Add tests for wildcards

* Support wildcards in records

* Add tests for relation data

* Add shorthands

* Change casing of exports

* Change function signatures

* Improve inlining of ECS_PAIR

* Delete whitespace

* Create root archetype

* Add back tests

* Fix tests
  • Loading branch information
@Ukendio
Ukendio authored May 12, 2024
1 parent 582b09b commit 2df5f3f
Show file tree
Hide file tree
Showing 5 changed files with 292 additions and 161 deletions.
299 changes: 157 additions & 142 deletions lib/init.lua
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,118 @@ type ArchetypeDiff = {
removed: Ty,
}

local FLAGS_PAIR = 0x8
local HI_COMPONENT_ID = 256
local ON_ADD = HI_COMPONENT_ID + 1
local ON_REMOVE = HI_COMPONENT_ID + 2
local ON_SET = HI_COMPONENT_ID + 3
local REST = HI_COMPONENT_ID + 4
local WILDCARD = HI_COMPONENT_ID + 4
local REST = HI_COMPONENT_ID + 5

local ECS_ID_FLAGS_MASK = 0x10
local ECS_ENTITY_MASK = bit32.lshift(1, 24)
local ECS_GENERATION_MASK = bit32.lshift(1, 16)

local function addFlags(isPair: boolean)
local typeFlags = 0x0

if isPair then
typeFlags = bit32.bor(typeFlags, FLAGS_PAIR) -- HIGHEST bit in the ID.
end
if false then
typeFlags = bit32.bor(typeFlags, 0x4) -- Set the second flag to true
end
if false then
typeFlags = bit32.bor(typeFlags, 0x2) -- Set the third flag to true
end
if false then
typeFlags = bit32.bor(typeFlags, 0x1) -- LAST BIT in the ID.
end

return typeFlags
end

local function newId(source: number, target: number)
local e = source * 2^28 + target * ECS_ID_FLAGS_MASK
return e
end

local function ECS_IS_PAIR(e: number)
return (e % 2^4) // FLAGS_PAIR ~= 0
end

function separate(entity: number)
local _typeFlags = entity % 0x10
entity //= ECS_ID_FLAGS_MASK
return entity // ECS_ENTITY_MASK, entity % ECS_GENERATION_MASK, _typeFlags
end

-- HIGH 24 bits LOW 24 bits
local function ECS_GENERATION(e: i53)
e //= 0x10
return e % ECS_GENERATION_MASK
end

local function ECS_ID(e: i53)
e //= 0x10
return e // ECS_ENTITY_MASK
end

local function ECS_GENERATION_INC(e: i53)
local id, generation, flags = separate(e)

return newId(id, generation + 1) + flags
end

-- gets the high ID
local function ECS_PAIR_FIRST(entity: i53): i24
entity //= 0x10
local first = entity % ECS_ENTITY_MASK
return first
end

-- gets the low ID
local ECS_PAIR_SECOND = ECS_ID

local function ECS_PAIR(first: number, second: number)
local target = WILDCARD
local relation

if first == WILDCARD then
relation = second
elseif second == WILDCARD then
relation = first
else
relation = second
target = ECS_PAIR_SECOND(first)
end

return newId(
ECS_PAIR_SECOND(relation), target) + addFlags(--[[isPair]] true)
end

local function getAlive(entityIndex: EntityIndex, id: i53)
return entityIndex.dense[id]
end

local function ecs_get_source(entityIndex, e)
assert(ECS_IS_PAIR(e))
return getAlive(entityIndex, ECS_PAIR_FIRST(e))
end
local function ecs_get_target(entityIndex, e)
assert(ECS_IS_PAIR(e))
return getAlive(entityIndex, ECS_PAIR_SECOND(e))
end

local function nextEntityId(entityIndex, index: i24)
local id = newId(index, 0)
entityIndex.sparse[id] = {
dense = index
} :: Record
entityIndex.dense[index] = id

return id
end

local function transitionArchetype(
entityIndex: EntityIndex,
Expand Down Expand Up @@ -132,22 +239,14 @@ local function hash(arr): string | number
return table.concat(arr, "_")
end

local function createArchetypeRecords(componentIndex: ComponentIndex, to: Archetype, _from: Archetype?)
local destinationIds = to.types
local records = to.records
local id = to.id

for i, destinationId in destinationIds do
local archetypesMap = componentIndex[destinationId]
local function createArchetypeRecord(componentIndex, id, componentId, i)
local archetypesMap = componentIndex[componentId]

if not archetypesMap then
archetypesMap = {size = 0, sparse = {}}
componentIndex[destinationId] = archetypesMap
end

archetypesMap.sparse[id] = i
records[destinationId] = i
if not archetypesMap then
archetypesMap = {size = 0, sparse = {}}
componentIndex[componentId] = archetypesMap
end
archetypesMap.sparse[id] = i
end

local function archetypeOf(world: World, types: {i24}, prev: Archetype?): Archetype
Expand All @@ -157,26 +256,39 @@ local function archetypeOf(world: World, types: {i24}, prev: Archetype?): Archet
world.nextArchetypeId = id

local length = #types
local columns = table.create(length) :: {any}
local columns = table.create(length)

for index in types do
columns[index] = {}
local records = {}
local componentIndex = world.componentIndex
local entityIndex = world.entityIndex
for i, componentId in types do
createArchetypeRecord(componentIndex, id, componentId, i)
records[componentId] = i
columns[i] = {}

if ECS_IS_PAIR(componentId) then
local first = ecs_get_source(entityIndex, componentId)
local second = ecs_get_target(entityIndex, componentId)
local firstPair = ECS_PAIR(first, WILDCARD)
local secondPair = ECS_PAIR(WILDCARD, second)
createArchetypeRecord(componentIndex, id, firstPair, i)
createArchetypeRecord(componentIndex, id, secondPair, i)
records[firstPair] = i
records[secondPair] = i
end
end

local archetype = {
columns = columns;
edges = {};
entities = {};
id = id;
records = {};
records = records;
type = ty;
types = types;
}
world.archetypeIndex[ty] = archetype
world.archetypes[id] = archetype
if length > 0 then
createArchetypeRecords(world.componentIndex, archetype, prev)
end

return archetype
end
Expand All @@ -186,8 +298,8 @@ World.__index = World
function World.new()
local self = setmetatable({
archetypeIndex = {};
archetypes = {};
componentIndex = {};
archetypes = {} :: Archetypes;
componentIndex = {} :: ComponentIndex;
entityIndex = {
dense = {},
sparse = {}
Expand All @@ -200,107 +312,10 @@ function World.new()
nextEntityId = 0;
ROOT_ARCHETYPE = (nil :: any) :: Archetype;
}, World)
self.ROOT_ARCHETYPE = archetypeOf(self, {})
return self
end

local FLAGS_PAIR = 0x8

local function addFlags(flags)
local typeFlags = 0x0
if flags.isPair then
typeFlags = bit32.bor(typeFlags, FLAGS_PAIR) -- HIGHEST bit in the ID.
end
if false then
typeFlags = bit32.bor(typeFlags, 0x4) -- Set the second flag to true
end
if false then
typeFlags = bit32.bor(typeFlags, 0x2) -- Set the third flag to true
end
if false then
typeFlags = bit32.bor(typeFlags, 0x1) -- LAST BIT in the ID.
end

return typeFlags
end

local ECS_ID_FLAGS_MASK = 0x10

-- ECS_ENTITY_MASK (0xFFFFFFFFull << 28)
local ECS_ENTITY_MASK = bit32.lshift(1, 24)

-- ECS_GENERATION_MASK (0xFFFFull << 24)
local ECS_GENERATION_MASK = bit32.lshift(1, 16)

local function newId(source: number, target: number)
local e = source * 2^28 + target * ECS_ID_FLAGS_MASK
return e
end

local function isPair(e: number)
return (e % 2^4) // FLAGS_PAIR ~= 0
end

function separate(entity: number)
local _typeFlags = entity % 0x10
entity //= ECS_ID_FLAGS_MASK
return entity // ECS_ENTITY_MASK, entity % ECS_GENERATION_MASK, _typeFlags
end

-- HIGH 24 bits LOW 24 bits
local function ECS_GENERATION(e: i53)
e //= 0x10
return e % ECS_GENERATION_MASK
end

local function ECS_ID(e: i53)
e //= 0x10
return e // ECS_ENTITY_MASK
end

local function ECS_GENERATION_INC(e: i53)
local id, generation, flags = separate(e)

return newId(id, generation + 1) + flags
end

-- gets the high ID
local function ECS_PAIR_FIRST(entity: i53): i24
entity //= 0x10
local first = entity % ECS_ENTITY_MASK
return first
end

-- gets the low ID
local ECS_PAIR_SECOND = ECS_ID

local function ECS_PAIR(source: number, target: number)
local id = newId(ECS_PAIR_SECOND(target), ECS_PAIR_SECOND(source)) + addFlags({ isPair = true })
return id
end

local function getAlive(entityIndex: EntityIndex, id: i53)
return entityIndex.dense[id]
end

local function ecs_get_source(entityIndex, e)
assert(isPair(e))
return getAlive(entityIndex, ECS_PAIR_FIRST(e))
end
local function ecs_get_target(entityIndex, e)
assert(isPair(e))
return getAlive(entityIndex, ECS_PAIR_SECOND(e))
end

local function nextEntityId(entityIndex, index: i24)
local id = newId(index, 0)
entityIndex.sparse[id] = {
dense = index
} :: Record
entityIndex.dense[index] = id

return id
end

function World.component(world: World)
local componentId = world.nextComponentId + 1
if componentId > HI_COMPONENT_ID then
Expand Down Expand Up @@ -402,15 +417,16 @@ local function findArchetypeWith(world: World, node: Archetype, componentId: i53
-- Component IDs are added incrementally, so inserting and sorting
-- them each time would be expensive. Instead this insertion sort can find the insertion
-- point in the types array.

local destinationType = table.clone(node.types)
local at = findInsert(types, componentId)
if at == -1 then
-- If it finds a duplicate, it just means it is the same archetype so it can return it
-- directly instead of needing to hash types for a lookup to the archetype.
return node
end

local destinationType = table.clone(node.types)
table.insert(destinationType, at, componentId)

return ensureArchetype(world, destinationType, node)
end

Expand All @@ -425,15 +441,7 @@ local function ensureEdge(archetype: Archetype, componentId: i53)
end

local function archetypeTraverseAdd(world: World, componentId: i53, from: Archetype): Archetype
if not from then
-- If there was no source archetype then it should return the ROOT_ARCHETYPE
local ROOT_ARCHETYPE = world.ROOT_ARCHETYPE
if not ROOT_ARCHETYPE then
ROOT_ARCHETYPE = archetypeOf(world, {}, nil)
world.ROOT_ARCHETYPE = ROOT_ARCHETYPE :: never
end
from = ROOT_ARCHETYPE
end
from = from or world.ROOT_ARCHETYPE

local edge = ensureEdge(from, componentId)
local add = edge.add
Expand Down Expand Up @@ -659,14 +667,14 @@ function World.query(world: World, ...: i53): Query
function preparedQuery:__iter()
return function()
local archetype = compatibleArchetype[1]
local row = next(archetype.entities, lastRow)
local row: number = next(archetype.entities, lastRow) :: number
while row == nil do
lastArchetype, compatibleArchetype = next(compatibleArchetypes, lastArchetype)
if lastArchetype == nil then
return
end
archetype = compatibleArchetype[1]
row = next(archetype.entities, row)
row = next(archetype.entities, row) :: number
end
lastRow = row

Expand Down Expand Up @@ -764,15 +772,22 @@ end

return table.freeze({
World = World;
ON_ADD = ON_ADD;
ON_REMOVE = ON_REMOVE;
ON_SET = ON_SET;

OnAdd = ON_ADD;
OnRemove = ON_REMOVE;
OnSet = ON_SET;
Wildcard = WILDCARD,
w = WILDCARD,
Rest = REST,

ECS_ID = ECS_ID,
IS_PAIR = isPair,
IS_PAIR = ECS_IS_PAIR,
ECS_PAIR = ECS_PAIR,
ECS_GENERATION = ECS_GENERATION,
ECS_GENERATION_INC = ECS_GENERATION_INC,
getAlive = getAlive,
ECS_GENERATION = ECS_GENERATION,
ecs_get_target = ecs_get_target,
ecs_get_source = ecs_get_source
ecs_get_source = ecs_get_source,

pair = ECS_PAIR,
getAlive = getAlive,
})
Loading

0 comments on commit 2df5f3f

Please sign in to comment.