13617144606

Committed 02 Mar 2025 04:11PM CUT coverage: 97.422% (-0.002%) from 97.424%

Build # 13617144606

Build Type

push

github

Committed by

web-flow

Commit Message

Simplify component/resource registration functions (#100)

Run Details

2 of 2 new or added lines in 1 file covered. (100.0%)

3893 of 3996 relevant lines covered (97.42%)

46242.85 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

98.06

/ecs/column.go

package ecs

import (
        "reflect"
        "unsafe"
)

// column storage for components in an archetype.
type column struct {
        data       reflect.Value
        pointer    unsafe.Pointer
        isRelation bool
        target     Entity
        itemSize   uintptr
        len        uint32
}

// newColumn creates a new column for a given type and capacity.
func newColumn(tp reflect.Type, isRelation bool, target Entity, capacity uint32) column {
        // TODO: should be use a slice instead of an array here?
        data := reflect.New(reflect.ArrayOf(int(capacity), tp)).Elem()
        pointer := data.Addr().UnsafePointer()

        return column{
                data:       data,
                pointer:    pointer,
                itemSize:   sizeOf(tp),
                isRelation: isRelation,
                target:     target,
                len:        0,
        }
}

// Len returns the number of components in the column.
func (c *column) Len() int {
        return int(c.len)
}

// Cap returns the current capacity of the column.
func (c *column) Cap() int {
        return c.data.Cap()
}

// Get returns a pointer to the component at the given index.
func (c *column) Get(index uintptr) unsafe.Pointer {
        return unsafe.Add(c.pointer, index*c.itemSize)
}

// Add adds a component to the column.
func (c *column) Add(comp unsafe.Pointer) (unsafe.Pointer, uint32) {
        c.Extend(1)
        c.len++
        return c.Set(c.len-1, comp), c.len - 1
}

// Alloc allocates memory for the given number of components.
func (c *column) Alloc(n uint32) {
        c.Extend(n)
        c.len += n
}

func (c *column) AddAll(other *column) {
        oldLen := c.len
        c.Alloc(other.len)
        src := other.Get(0)
        dst := c.Get(uintptr(oldLen))
        copyPtr(src, dst, c.itemSize*uintptr(other.len))
}

// Set overwrites the component at the given index.
func (c *column) Set(index uint32, comp unsafe.Pointer) unsafe.Pointer {
        dst := c.Get(uintptr(index))
        if c.itemSize == 0 {
                return dst
        }

        copyPtr(comp, dst, uintptr(c.itemSize))
        return dst
}

// Remove swap-removes the component at the given index.
// Returns whether a swap was necessary.
func (c *column) Remove(index uint32, zero unsafe.Pointer) bool {
        lastIndex := uintptr(c.len - 1)
        swapped := index != uint32(lastIndex)

        if swapped && c.itemSize != 0 {
                src := unsafe.Add(c.pointer, lastIndex*c.itemSize)
                dst := unsafe.Add(c.pointer, uintptr(index)*c.itemSize)
                copyPtr(src, dst, uintptr(c.itemSize))
        }
        c.len--
        if zero != nil {
                c.Zero(lastIndex, zero)
        }
        return swapped
}

// Extend the column to be able to store the given number of additional components.
// Has no effect of the column's capacity is already sufficient.
// If the capacity needs to be increased, it will be doubled until it is sufficient.
func (c *column) Extend(by uint32) {
        required := c.Len() + int(by)
        cap := c.Cap()
        if cap >= required {
                return
        }
        for cap < required {
                cap *= 2
        }
        old := c.data
        c.data = reflect.New(reflect.ArrayOf(cap, old.Type().Elem())).Elem()
        c.pointer = c.data.Addr().UnsafePointer()
        reflect.Copy(c.data, old)
}

// Zero resets the memory at the given index.
func (c *column) Zero(index uintptr, zero unsafe.Pointer) {
        if c.itemSize == 0 {
                return
        }
        dst := unsafe.Add(c.pointer, index*c.itemSize)
        copyPtr(zero, dst, uintptr(c.itemSize))
}

// Zero resets a block of storage in one buffer.
func (c *column) ZeroRange(start, len uint32, zero unsafe.Pointer) {
        size := uint32(c.itemSize)
        if size == 0 {
                return
        }
        var i uint32
        for i = 0; i < len; i++ {
                dst := unsafe.Add(c.pointer, (i+start)*size)
                copyPtr(zero, dst, c.itemSize)
        }
}

func (c *column) Reset(zero unsafe.Pointer) {
        len := c.len
        if c.len == 0 {
                return
        }
        c.len = 0
        if zero == nil {
                return
        }
        if len <= 64 { // A coarse estimate where manually zeroing is faster
                c.ZeroRange(0, len, zero)
        } else {
                c.data.SetZero()
        }
}

1	package ecs
2
3	import (
4	"reflect"
5	"unsafe"
6	)
7
8	// column storage for components in an archetype.
9	type column struct {
10	data reflect.Value
11	pointer unsafe.Pointer
12	isRelation bool
13	target Entity
14	itemSize uintptr
15	len uint32
16	}
17
18	// newColumn creates a new column for a given type and capacity.
19	func newColumn(tp reflect.Type, isRelation bool, target Entity, capacity uint32) column {	939✔
20	// TODO: should be use a slice instead of an array here?	939✔
21	data := reflect.New(reflect.ArrayOf(int(capacity), tp)).Elem()	939✔
22	pointer := data.Addr().UnsafePointer()	939✔
23		939✔
24	return column{	939✔
25	data: data,	939✔
26	pointer: pointer,	939✔
27	itemSize: sizeOf(tp),	939✔
28	isRelation: isRelation,	939✔
29	target: target,	939✔
30	len: 0,	939✔
31	}	939✔
32	}	939✔
33
34	// Len returns the number of components in the column.
35	func (c *column) Len() int {	999,684✔
36	return int(c.len)	999,684✔
37	}	999,684✔
38
39	// Cap returns the current capacity of the column.
40	func (c *column) Cap() int {	997,396✔
41	return c.data.Cap()	997,396✔
42	}	997,396✔
43
44	// Get returns a pointer to the component at the given index.
45	func (c *column) Get(index uintptr) unsafe.Pointer {	4,949,366✔
46	return unsafe.Add(c.pointer, index*c.itemSize)	4,949,366✔
47	}	4,949,366✔
48
49	// Add adds a component to the column.
50	func (c *column) Add(comp unsafe.Pointer) (unsafe.Pointer, uint32) {	496,847✔
51	c.Extend(1)	496,847✔
52	c.len++	496,847✔
53	return c.Set(c.len-1, comp), c.len - 1	496,847✔
54	}	496,847✔
55
56	// Alloc allocates memory for the given number of components.
57	func (c *column) Alloc(n uint32) {	500,543✔
58	c.Extend(n)	500,543✔
59	c.len += n	500,543✔
60	}	500,543✔
61
62	func (c column) AddAll(other column) {	6✔
63	oldLen := c.len	6✔
64	c.Alloc(other.len)	6✔
65	src := other.Get(0)	6✔
66	dst := c.Get(uintptr(oldLen))	6✔
67	copyPtr(src, dst, c.itemSize*uintptr(other.len))	6✔
68	}	6✔
69
70	// Set overwrites the component at the given index.
71	func (c *column) Set(index uint32, comp unsafe.Pointer) unsafe.Pointer {	998,315✔
72	dst := c.Get(uintptr(index))	998,315✔
73	if c.itemSize == 0 {	998,770✔
74	return dst	455✔
75	}	455✔
76
77	copyPtr(comp, dst, uintptr(c.itemSize))	997,860✔
78	return dst	997,860✔
79	}
80
81	// Remove swap-removes the component at the given index.
82	// Returns whether a swap was necessary.
83	func (c *column) Remove(index uint32, zero unsafe.Pointer) bool {	991,604✔
84	lastIndex := uintptr(c.len - 1)	991,604✔
85	swapped := index != uint32(lastIndex)	991,604✔
86		991,604✔
87	if swapped && c.itemSize != 0 {	1,978,658✔
88	src := unsafe.Add(c.pointer, lastIndex*c.itemSize)	987,054✔
89	dst := unsafe.Add(c.pointer, uintptr(index)*c.itemSize)	987,054✔
90	copyPtr(src, dst, uintptr(c.itemSize))	987,054✔
91	}	987,054✔
92	c.len--	991,604✔
93	if zero != nil {	1,488,163✔
94	c.Zero(lastIndex, zero)	496,559✔
95	}	496,559✔
96	return swapped	991,604✔
97	}
98
99	// Extend the column to be able to store the given number of additional components.
100	// Has no effect of the column's capacity is already sufficient.
101	// If the capacity needs to be increased, it will be doubled until it is sufficient.
102	func (c *column) Extend(by uint32) {	997,390✔
103	required := c.Len() + int(by)	997,390✔
104	cap := c.Cap()	997,390✔
105	if cap >= required {	1,993,884✔
106	return	996,494✔
107	}	996,494✔
108	for cap < required {	1,880✔
109	cap *= 2	984✔
110	}	984✔
111	old := c.data	896✔
112	c.data = reflect.New(reflect.ArrayOf(cap, old.Type().Elem())).Elem()	896✔
113	c.pointer = c.data.Addr().UnsafePointer()	896✔
114	reflect.Copy(c.data, old)	896✔
115	}
116
117	// Zero resets the memory at the given index.
118	func (c *column) Zero(index uintptr, zero unsafe.Pointer) {	496,559✔
119	if c.itemSize == 0 {	496,697✔
120	return	138✔
121	}	138✔
122	dst := unsafe.Add(c.pointer, index*c.itemSize)	496,421✔
123	copyPtr(zero, dst, uintptr(c.itemSize))	496,421✔
124	}
125
126	// Zero resets a block of storage in one buffer.
127	func (c *column) ZeroRange(start, len uint32, zero unsafe.Pointer) {	7✔
128	size := uint32(c.itemSize)	7✔
129	if size == 0 {	9✔
130	return	2✔
131	}	2✔
132	var i uint32	5✔
133	for i = 0; i < len; i++ {	43✔
134	dst := unsafe.Add(c.pointer, (i+start)*size)	38✔
135	copyPtr(zero, dst, c.itemSize)	38✔
136	}	38✔
137	}
138
139	func (c *column) Reset(zero unsafe.Pointer) {	18✔
140	len := c.len	18✔
141	if c.len == 0 {	24✔
142	return	6✔
143	}	6✔
144	c.len = 0	12✔
145	if zero == nil {	17✔
146	return	5✔
147	}	5✔
148	if len <= 64 { // A coarse estimate where manually zeroing is faster	14✔
149	c.ZeroRange(0, len, zero)	7✔
150	} else {	7✔
151	c.data.SetZero()	×
152	}	×
153	}

mlange-42 / ark / 13617144606

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous