/**
* @since 2.0.0
*/
import * as Dual from "./Function.js"
import { format, NodeInspectSymbol, toJSON } from "./Inspectable.js"
import type { Inspectable } from "./Inspectable.js"
import type { Pipeable } from "./Pipeable.js"
import { pipeArguments } from "./Pipeable.js"
const TypeId: unique symbol = Symbol.for("effect/MutableList") as TypeId
/**
* @since 2.0.0
* @category symbol
*/
export type TypeId = typeof TypeId
/**
* @since 2.0.0
* @category model
*/
export interface MutableList<out A> extends Iterable<A>, Pipeable, Inspectable {
readonly [TypeId]: TypeId
/** @internal */
head: LinkedListNode<A> | undefined
/** @internal */
tail: LinkedListNode<A> | undefined
}
const MutableListProto: Omit<MutableList<unknown>, "head" | "tail"> = {
[TypeId]: TypeId,
[Symbol.iterator](this: MutableList<unknown>): Iterator<unknown> {
let done = false
let head: LinkedListNode<unknown> | undefined = this.head
return {
next() {
if (done) {
return this.return!()
}
if (head == null) {
done = true
return this.return!()
}
const value = head.value
head = head.next
return { done, value }
},
return(value?: unknown) {
if (!done) {
done = true
}
return { done: true, value }
}
}
},
toString() {
return format(this.toJSON())
},
toJSON() {
return {
_id: "MutableList",
values: Array.from(this).map(toJSON)
}
},
[NodeInspectSymbol]() {
return this.toJSON()
},
pipe() {
return pipeArguments(this, arguments)
}
}
interface MutableListImpl<A> extends MutableList<A> {
_length: number
}
/** @internal */
interface LinkedListNode<T> {
removed: boolean
value: T
prev: LinkedListNode<T> | undefined
next: LinkedListNode<T> | undefined
}
/** @internal */
const makeNode = <T>(value: T): LinkedListNode<T> => ({
value,
removed: false,
prev: undefined,
next: undefined
})
/**
* Creates an empty `MutableList`.
*
* @since 2.0.0
* @category constructors
*/
export const empty = <A = never>(): MutableList<A> => {
const list = Object.create(MutableListProto)
list.head = undefined
list.tail = undefined
list._length = 0
return list
}
/**
* Creates a new `MutableList` from an iterable collection of values.
*
* @since 2.0.0
* @category constructors
*/
export const fromIterable = <A>(iterable: Iterable<A>): MutableList<A> => {
const list = empty<A>()
for (const element of iterable) {
append(list, element)
}
return list
}
/**
* Creates a new `MutableList` from the specified elements.
*
* @since 2.0.0
* @category constructors
*/
export const make = <A>(...elements: ReadonlyArray<A>): MutableList<A> => fromIterable(elements)
/**
* Returns `true` if the list contains zero elements, `false`, otherwise.
*
* @since 2.0.0
* @category getters
*/
export const isEmpty = <A>(self: MutableList<A>): boolean => length(self) === 0
/**
* Returns the length of the list.
*
* @since 2.0.0
* @category getters
*/
export const length = <A>(self: MutableList<A>): number => (self as MutableListImpl<A>)._length
/**
* Returns the last element of the list, if it exists.
*
* @since 2.0.0
* @category getters
*/
export const tail = <A>(self: MutableList<A>): A | undefined => self.tail === undefined ? undefined : self.tail.value
/**
* Returns the first element of the list, if it exists.
*
* @since 2.0.0
* @category getters
*/
export const head = <A>(self: MutableList<A>): A | undefined => self.head === undefined ? undefined : self.head.value
/**
* Executes the specified function `f` for each element in the list.
*
* @since 2.0.0
* @category traversing
*/
export const forEach: {
/**
* Executes the specified function `f` for each element in the list.
*
* @since 2.0.0
* @category traversing
*/
<A>(f: (element: A) => void): (self: MutableList<A>) => void
/**
* Executes the specified function `f` for each element in the list.
*
* @since 2.0.0
* @category traversing
*/
<A>(self: MutableList<A>, f: (element: A) => void): void
} = Dual.dual<
<A>(f: (element: A) => void) => (self: MutableList<A>) => void,
<A>(self: MutableList<A>, f: (element: A) => void) => void
>(2, (self, f) => {
let current = self.head
while (current !== undefined) {
f(current.value)
current = current.next
}
})
/**
* Removes all elements from the doubly-linked list.
*
* @since 2.0.0
*/
export const reset = <A>(self: MutableList<A>): MutableList<A> => {
;(self as MutableListImpl<A>)._length = 0
self.head = undefined
self.tail = undefined
return self
}
/**
* Appends the specified element to the end of the `MutableList`.
*
* @category concatenating
* @since 2.0.0
*/
export const append: {
/**
* Appends the specified element to the end of the `MutableList`.
*
* @category concatenating
* @since 2.0.0
*/
<A>(value: A): (self: MutableList<A>) => MutableList<A>
/**
* Appends the specified element to the end of the `MutableList`.
*
* @category concatenating
* @since 2.0.0
*/
<A>(self: MutableList<A>, value: A): MutableList<A>
} = Dual.dual<
<A>(value: A) => (self: MutableList<A>) => MutableList<A>,
<A>(self: MutableList<A>, value: A) => MutableList<A>
>(2, <A>(self: MutableList<A>, value: A) => {
const node = makeNode(value)
if (self.head === undefined) {
self.head = node
}
if (self.tail === undefined) {
self.tail = node
} else {
self.tail.next = node
node.prev = self.tail
self.tail = node
}
;(self as MutableListImpl<A>)._length += 1
return self
})
/**
* Removes the first value from the list and returns it, if it exists.
*
* @since 0.0.1
*/
export const shift = <A>(self: MutableList<A>): A | undefined => {
const head = self.head
if (head !== undefined) {
remove(self, head)
return head.value
}
return undefined
}
/**
* Removes the last value from the list and returns it, if it exists.
*
* @since 0.0.1
*/
export const pop = <A>(self: MutableList<A>): A | undefined => {
const tail = self.tail
if (tail !== undefined) {
remove(self, tail)
return tail.value
}
return undefined
}
/**
* Prepends the specified value to the beginning of the list.
*
* @category concatenating
* @since 2.0.0
*/
export const prepend: {
/**
* Prepends the specified value to the beginning of the list.
*
* @category concatenating
* @since 2.0.0
*/
<A>(value: A): (self: MutableList<A>) => MutableList<A>
/**
* Prepends the specified value to the beginning of the list.
*
* @category concatenating
* @since 2.0.0
*/
<A>(self: MutableList<A>, value: A): MutableList<A>
} = Dual.dual<
<A>(value: A) => (self: MutableList<A>) => MutableList<A>,
<A>(self: MutableList<A>, value: A) => MutableList<A>
>(2, <A>(self: MutableList<A>, value: A) => {
const node = makeNode(value)
node.next = self.head
if (self.head !== undefined) {
self.head.prev = node
}
self.head = node
if (self.tail === undefined) {
self.tail = node
}
;(self as MutableListImpl<A>)._length += 1
return self
})
const remove = <A>(self: MutableList<A>, node: LinkedListNode<A>): void => {
if (node.removed) {
return
}
node.removed = true
if (node.prev !== undefined && node.next !== undefined) {
node.prev.next = node.next
node.next.prev = node.prev
} else if (node.prev !== undefined) {
self.tail = node.prev
node.prev.next = undefined
} else if (node.next !== undefined) {
self.head = node.next
node.next.prev = undefined
} else {
self.tail = undefined
self.head = undefined
}
if ((self as MutableListImpl<A>)._length > 0) {
;(self as MutableListImpl<A>)._length -= 1
}
}