com.shakelang.util.pointers/com.shakelang.util.pointer

Package-level declarations

Types

LateInitMutablePointer

interface LateInitMutablePointer<T> : MutablePointer<T> , LateInitPointer<T>

A mutable late init pointer points to a value in memory. It can be used to pass a value by reference. The advantage of a pointer is that it can be used to change the value of a variable in a function.

LateInitPointer

interface LateInitPointer<T> : Pointer<T>

A late init pointer points to a value in memory. It can be used to pass a value by reference. The advantage of a pointer is that it can be used to change the value of a variable in a function.

interface MutablePointer<T> : Pointer<T>

A mutable pointer points to a value in memory. It can be used to pass a value by reference. The advantage of a pointer is that it can be used to change the value of a variable in a function.

MutablePointerList

typealias MutablePointerList<T> = MutableList<Pointer<T>>

A MutablePointerList refers to a list of mutable pointers.

MutablePointingList

interface MutablePointingList<T> : PointingList<T> , MutableList<T>

A MutablePointingList refers to a list of values that are pointed to by mutable pointers.

interface Pointer<out T>

A pointer points to a value in memory. It can be used to pass a value by reference. The advantage of a pointer is that it can be used to change the value of a variable in a function.

typealias PointerList<T> = List<Pointer<T>>

A PointerList refers to a list of pointers.

PointerRegister

class PointerRegister<T>

A register for pointers.

interface PointingList<T> : List<T>

A PointingList refers to a list of values that are pointed to by pointers.

Functions

lateMutablePoint

fun <T> lateMutablePoint(): LateInitMutablePointer<T>

Create a new mutable pointer which is not initialized yet and can be initialized later

fun <T> latePoint(): LateInitPointer<T>

Create a new pointer which is not initialized yet and can be initialized later

fun <T> T.mutablePoint(): MutablePointer<T>

Create a new mutable pointer pointing to the given value

fun <T> MutableIterable<T>.mutablePoints(): MutablePointerList<T>

Create a mutable list of pointers pointing to the values of the list

fun <T> Pointer<T?>.notNull(msg: String? = null): Pointer<T>

Make sure that the value of the pointer is not null

fun <T> T.point(): Pointer<T>

Create a new pointer pointing to the given value

fun <T> Iterable<T>.points(): PointerList<T>

Create a list of pointers pointing to the values of the list

fun <T> Pointer<T>.register(register: PointerRegister<T>): Int

Register the pointer to the given register

fun <T> taskPoint(task: () -> T): Pointer<T>

Create a new pointer which performs the given task on access and returns the result of the task

fun Pointer<*>.unregister()

Close the pointer (unregister it from all registers)

fun <T> Pointer<T>.unregister(register: PointerRegister<T>)

Unregister the pointer from the given register

fun <T> PointerList<T>.values(): PointingList<T>

You can create a list that points to the values of a PointerList with this function.

fun <T> MutablePointerList<T>.values(): MutablePointingList<T>

You can create a list that points to the values of a MutablePointerList with this function.