com.jacobtread.blaze.TdfContainer.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of blaze-core Show documentation
Core library for blaze networking
The newest version!
@file:Suppress("NOTHING_TO_INLINE")

package com.jacobtread.blaze

import com.jacobtread.blaze.data.VarPair
import com.jacobtread.blaze.data.VarTriple
import com.jacobtread.blaze.tdf.Tdf
import com.jacobtread.blaze.tdf.types.*

/**
 * TdfContainer Structure representing a collection of TDFs that can be queried for
 * different value types. This has lots of inline helper shortcut functions for easily
 * finding different data types
 *
 * @constructor Create empty TdfContainer
 */
interface TdfContainer {

    /**
     * getTdfByLabel This is the only function the underlying implementations
     * need to implement this allows searching for TDFs by a provided label
     *
     * @param label The label to search for
     * @return The found TDF or null
     */
    fun getTdfByLabel(label: String): Tdf<*>?

    /**
     * getTdf Retrieves a TDF with the matching type and label
     *
     * @param C The tdf generic type
     * @param type The class of the type of the TDF
     * @param label The label of the tdf to search for
     * @throws MissingTdfException Thrown when there was no TDFs with the provided label
     * @throws InvalidTdfException Thrown when the TDF was not of the provided type
     * @return The TDF that was found
     */
    @Throws(MissingTdfException::class, InvalidTdfException::class)
    fun > getTdf(type: Class, label: String): C {
        val value = getTdfByLabel(label) ?: throw MissingTdfException(label)
        if (!type.isAssignableFrom(value.javaClass)) throw InvalidTdfException(label, type, value.javaClass)
        return type.cast(value)
    }

    /**
     * getTdfOrNull Retrieves a TDF with the matching type and label
     * or null if either there was none with the matching label or the
     * type of the TDF doesn't assign from C
     *
     * @param C The tdf generic type
     * @param type The class of the type of the TDF
     * @param label The label of the tdf to search for
     * @return The TDF that was found or null if it was missing or invalid
     */
    fun > getTdfOrNull(type: Class, label: String): C? {
        val value = getTdfByLabel(label)
        if (value == null || !type.isAssignableFrom(value.javaClass)) return null
        return type.cast(value)
    }

    /**
     * getValue Retrieves the value of a TDF with the matching type and label
     *
     * @param T The data type that the TDF value will be
     * @param C The TDF generic type
     * @param type The class of the type of the TDF
     * @param label The label to search for
     * @throws MissingTdfException Thrown when there was no TDFs with the provided label
     * @throws InvalidTdfException Thrown when the TDF was not of the provided type
     * @return The value of the TDF that was found
     */
    @Throws(MissingTdfException::class, InvalidTdfException::class)
    fun > getValue(type: Class, label: String): T {
        val value = getTdfByLabel(label) ?: throw MissingTdfException(label)
        if (!type.isAssignableFrom(value.javaClass)) throw InvalidTdfException(label, type, value.javaClass)
        return type.cast(value).value

    }

    /**
     * getValueOrNull Retrieves the value of a TDF with the matching type and label or
     * null if there are no TDFs with that label or if the type is not assignable
     *
     * @param T The data type that the TDF value will be
     * @param C The TDF generic type
     * @param type The class of the type of the TDF
     * @param label The label to search for
     * @return
     */
    fun > getValueOrNull(type: Class, label: String): T? {
        val value = getTdfByLabel(label)
        if (value == null || !type.isAssignableFrom(value.javaClass)) return null
        return type.cast(value).value
    }
}

//region Helper Functions

// Tdf Struct-Like Helpers

inline fun TdfContainer.varInt(label: String): VarIntTdf<*> = getTdf(VarIntTdf::class.java, label)
inline fun TdfContainer.group(label: String): GroupTdf = getTdf(GroupTdf::class.java, label)
inline fun TdfContainer.optional(label: String): OptionalTdf = getTdf(OptionalTdf::class.java, label)

inline fun TdfContainer.text(label: String): String = getValue(StringTdf::class.java, label)
inline fun TdfContainer.ulong(label: String): ULong = varInt(label).toULong()
inline fun TdfContainer.long(label: String): Long = ulong(label).toLong()
inline fun TdfContainer.int(label: String): Int = varInt(label).toInt()
inline fun TdfContainer.uint(label: String): UInt = varInt(label).toUInt()
inline fun TdfContainer.short(label: String): Short = varInt(label).toShort()
inline fun TdfContainer.ushort(label: String): UShort = varInt(label).toUShort()

inline fun TdfContainer.float(label: String): Float = getValue(FloatTdf::class.java, label)
inline fun TdfContainer.blob(label: String): ByteArray = getValue(BlobTdf::class.java, label)
inline fun TdfContainer.optionalValue(label: String): Tdf<*>? = getValue(OptionalTdf::class.java, label)
inline fun TdfContainer.triple(label: String): VarTriple = getValue(TrippleTdf::class.java, label)
inline fun TdfContainer.pair(label: String): VarPair = getValue(PairTdf::class.java, label)
inline fun TdfContainer.varIntList(label: String): List = getValue(VarIntListTdf::class.java, label)

@Suppress("UNCHECKED_CAST")
inline fun  TdfContainer.list(label: String): List = getValue(ListTdf::class.java, label) as List

@Suppress("UNCHECKED_CAST")
inline fun  TdfContainer.map(label: String): Map = getValue(MapTdf::class.java, label) as Map