summaryrefslogtreecommitdiff
path: root/vendor/codeberg.org/gruf/go-list/list.go
blob: 5490fa6367a7aeed5568fec558cc00e60088db7b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
package list

// Elem represents an element in a doubly-linked list.
type Elem[T any] struct {
	Next  *Elem[T]
	Prev  *Elem[T]
	Value T
}

// List implements a doubly-linked list, where:
// - Head = index 0   (i.e. the front)
// - Tail = index n-1 (i.e. the back)
type List[T any] struct {
	Head *Elem[T]
	Tail *Elem[T]
	len  int
}

// Len returns the current list length.
func (l *List[T]) Len() int {
	return l.len
}

// PushFront adds 'v' to the beginning of the list.
func (l *List[T]) PushFront(v T) *Elem[T] {
	elem := &Elem[T]{Value: v}
	l.PushElemFront(elem)
	return elem
}

// PushBack adds 'v' to the end of the list.
func (l *List[T]) PushBack(v T) *Elem[T] {
	elem := &Elem[T]{Value: v}
	l.PushElemBack(elem)
	return elem
}

// InsertBefore adds 'v' into the list before 'at'.
func (l *List[T]) InsertBefore(v T, at *Elem[T]) *Elem[T] {
	elem := &Elem[T]{Value: v}
	l.InsertElemBefore(elem, at)
	return elem
}

// InsertAfter adds 'v' into the list after 'at'.
func (l *List[T]) InsertAfter(v T, at *Elem[T]) *Elem[T] {
	elem := &Elem[T]{Value: v}
	l.InsertElemAfter(elem, at)
	return elem
}

// PushFrontNode adds 'elem' to the front of the list.
func (l *List[T]) PushElemFront(elem *Elem[T]) {
	if elem == l.Head {
		return
	}

	// Set new head.
	oldHead := l.Head
	l.Head = elem

	if oldHead != nil {
		// Link to old head
		elem.Next = oldHead
		oldHead.Prev = elem
	} else {
		// First in list.
		l.Tail = elem
	}

	// Incr count
	l.len++
}

// PushBackNode adds 'elem' to the back of the list.
func (l *List[T]) PushElemBack(elem *Elem[T]) {
	if elem == l.Tail {
		return
	}

	// Set new tail.
	oldTail := l.Tail
	l.Tail = elem

	if oldTail != nil {
		// Link to old tail
		elem.Prev = oldTail
		oldTail.Next = elem
	} else {
		// First in list.
		l.Head = elem
	}

	// Incr count
	l.len++
}

// InsertElemAfter adds 'elem' into the list after 'at' (i.e. at.Next = elem).
func (l *List[T]) InsertElemAfter(elem *Elem[T], at *Elem[T]) {
	if elem == at {
		return
	}

	// Set new 'next'.
	oldNext := at.Next
	at.Next = elem

	// Link to 'at'.
	elem.Prev = at

	if oldNext == nil {
		// Set new tail
		l.Tail = elem
	} else {
		// Link to 'prev'.
		oldNext.Prev = elem
		elem.Next = oldNext
	}

	// Incr count
	l.len++
}

// InsertElemBefore adds 'elem' into the list before 'at' (i.e. at.Prev = elem).
func (l *List[T]) InsertElemBefore(elem *Elem[T], at *Elem[T]) {
	if elem == at {
		return
	}

	// Set new 'prev'.
	oldPrev := at.Prev
	at.Prev = elem

	// Link to 'at'.
	elem.Next = at

	if oldPrev == nil {
		// Set new head
		l.Head = elem
	} else {
		// Link to 'next'.
		oldPrev.Next = elem
		elem.Prev = oldPrev
	}

	// Incr count
	l.len++
}

// Remove removes the 'elem' from the list.
func (l *List[T]) Remove(elem *Elem[T]) {
	// Get linked elems.
	next := elem.Next
	prev := elem.Prev

	// Unset elem.
	elem.Next = nil
	elem.Prev = nil

	switch {
	// elem is ONLY one in list.
	case next == nil && prev == nil:
		l.Head = nil
		l.Tail = nil

	// elem is front in list.
	case next != nil && prev == nil:
		l.Head = next
		next.Prev = nil

	// elem is last in list.
	case prev != nil && next == nil:
		l.Tail = prev
		prev.Next = nil

	// elem in middle of list.
	default:
		next.Prev = prev
		prev.Next = next
	}

	// Decr count
	l.len--
}

// Range calls 'fn' on every element from head forward in list.
func (l *List[T]) Range(fn func(*Elem[T])) {
	if fn == nil {
		panic("nil function")
	}
	for elem := l.Head; elem != nil; elem = elem.Next {
		fn(elem)
	}
}

// RangeReverse calls 'fn' on every element from tail backward in list.
func (l *List[T]) RangeReverse(fn func(*Elem[T])) {
	if fn == nil {
		panic("nil function")
	}
	for elem := l.Tail; elem != nil; elem = elem.Prev {
		fn(elem)
	}
}