Merge pull request #20 from runetopic/development

Speed improvements and some code refactoring.

Author: ultraviolet-jordan

README.md

@@ -16,7 +16,7 @@ A cache library written in Kotlin.
 # Features
 - Cache Reading
 - Definitions/Providers Loading
-- Fast (Limited by I/O)
+- Very Fast (Limited by I/O)
 
 # TODO
 - Cache Writing
@@ -28,8 +28,8 @@ A cache library written in Kotlin.
 # Implementation
 Just use cache if you do not require any of the revision specific loaders.
 ```
-cache = { module = "com.runetopic.cache:cache", version.ref "1.4.16-SNAPSHOT" }
-loader = { module = "com.runetopic.cache:loader", version.ref "647.6.3-SNAPSHOT" }
+cache = { module = "com.runetopic.cache:cache", version.ref "1.4.18-SNAPSHOT" }
+loader = { module = "com.runetopic.cache:loader", version.ref "647.6.4-SNAPSHOT" }
 ```
 
 ```
@@ -55,33 +55,33 @@ val index = store.index(indexId = 5)
 ### Getting a group by group id
 ```
 val index = store.index(indexId = 5)
-val group = index.getGroup(groupId = 360)
+val group = index.group(groupId = 360)
 ```
 
 ### Getting a group by group name
 ```
 val index = store.index(indexId = 5)
-val group = index.getGroup(groupName = "m50_50")
+val group = index.group(groupName = "m50_50")
 ```
 
 ### Getting a file from a group by id
 ```
 val index = store.index(indexId = 2)
-val group = index.getGroup(groupId = 26)
-val file = group.getFile(fileId = 1000)
+val group = index.group(groupId = 26)
+val file = group.file(fileId = 1000)
 ```
 
 ### Looping multiple groups from an index
     store.index(indexId = 19).use { index ->
         (0 until index.expand()).forEach {
-            val data = index.getGroup(it ushr 8).getFile(it and 0xFF).getData()
+            val data = index.group(it ushr 8).file(it and 0xFF).data
         }
     }
 
 ### Looping multiple files from a group
-    store.index(indexId = 2).getGroup(groupId = 26).getFiles().forEach {
-        val id = it.getId()
-        val data = it.getData()
+    store.index(indexId = 2).group(groupId = 26).files().forEach {
+        val id = it.id
+        val data = it.data
     }
 
 ### Getting the reference table of an index and group by id.
@@ -102,13 +102,6 @@ val file = group.getFile(fileId = 1000)
 ### Getting 255, 255 checksums without RSA/Whirlpool
 ```val checksums = store.checksumsWithoutRSA()```
 
-### Decompressing a group
-```
-val index = store.index(indexId = 5)
-val group = index.getGroup(groupName = "m50_50")
-val decompressed = group.getData().decompress()
-```
-
 ### An example of a single thread loading providers
 ```
 objs().load(store)

cache/build.gradle.kts

@@ -4,7 +4,7 @@ plugins {
     signing
 }
 
-version = "1.4.16-SNAPSHOT"
+version = "1.4.18-SNAPSHOT"
 
 java {
     withJavadocJar()

cache/src/main/kotlin/com/runetopic/cache/codec/ContainerCodec.kt

@@ -5,8 +5,8 @@ import com.runetopic.cache.exception.CompressionException
 import com.runetopic.cache.extension.readUnsignedByte
 import com.runetopic.cache.extension.readUnsignedShort
 import com.runetopic.cache.extension.remainingBytes
+import com.runetopic.cache.extension.toByteBuffer
 import com.runetopic.cryptography.fromXTEA
-import java.nio.ByteBuffer
 import java.util.zip.CRC32
 
 /**
@@ -18,8 +18,7 @@ import java.util.zip.CRC32
 internal object ContainerCodec {
 
     fun decompress(data: ByteArray, keys: IntArray = intArrayOf()): Container {
-        val buffer = ByteBuffer.wrap(data)
-
+        val buffer = data.toByteBuffer()
         val compression = buffer.readUnsignedByte()
         val length = buffer.int
 
@@ -54,7 +53,7 @@ internal object ContainerCodec {
                     revision = buffer.readUnsignedShort()
                 }
 
-                val byteBuffer = ByteBuffer.wrap(decrypted)
+                val byteBuffer = decrypted.toByteBuffer()
                 val decompressedLength = byteBuffer.int
                 val decompressedData = type.codec.decompress(byteBuffer.remainingBytes(), length, keys)
 

cache/src/main/kotlin/com/runetopic/cache/codec/Decompression.kt

@@ -4,10 +4,5 @@ package com.runetopic.cache.codec
 /**
  * @author Jordan Abraham
  */
-fun ByteArray.decompress(keys: IntArray = intArrayOf()): ByteArray {
-    return ContainerCodec.decompress(this, keys).data
-}
-
-fun ByteArray.decompress(): ByteArray {
-    return ContainerCodec.decompress(this, intArrayOf()).data
-}
+fun ByteArray.decompress(keys: IntArray): ByteArray = ContainerCodec.decompress(this, keys).data
+fun ByteArray.decompress(): ByteArray = ContainerCodec.decompress(this, intArrayOf()).data

cache/src/main/kotlin/com/runetopic/cache/codec/impl/BZip2Codec.kt

@@ -37,11 +37,7 @@ internal class BZip2Codec: IFileCodec {
         System.arraycopy(data, 0, buffer, BZIP_HEADER.size, length)
 
         val stream = ByteArrayOutputStream()
-
-        BZip2CompressorInputStream(ByteArrayInputStream(buffer)).use {
-            IOUtils.copy(it, stream)
-        }
-
+        BZip2CompressorInputStream(ByteArrayInputStream(buffer)).use { IOUtils.copy(it, stream) }
         return stream.toByteArray()
     }
 }

cache/src/main/kotlin/com/runetopic/cache/codec/impl/NoFileCodec.kt

@@ -7,11 +7,6 @@ import com.runetopic.cache.codec.IFileCodec
  * @email <[email protected]>
  */
 internal class NoFileCodec: IFileCodec {
-    override fun compress(data: ByteArray, length: Int, keys: IntArray): ByteArray {
-        throw NotImplementedError("No codec provided.")
-    }
-
-    override fun decompress(data: ByteArray, length: Int, keys: IntArray): ByteArray {
-        throw NotImplementedError("No codec provided.")
-    }
+    override fun compress(data: ByteArray, length: Int, keys: IntArray): ByteArray = throw NotImplementedError("No codec provided.")
+    override fun decompress(data: ByteArray, length: Int, keys: IntArray): ByteArray = throw NotImplementedError("No codec provided.")
 }

cache/src/main/kotlin/com/runetopic/cache/extension/ByteArray.kt

@@ -0,0 +1,8 @@
+package com.runetopic.cache.extension
+
+import java.nio.ByteBuffer
+
+/**
+ * @author Jordan Abraham
+ */
+fun ByteArray.toByteBuffer(): ByteBuffer = ByteBuffer.wrap(this)

cache/src/main/kotlin/com/runetopic/cache/extension/ByteBuffer.kt

@@ -4,7 +4,7 @@ import java.nio.ByteBuffer
 
 internal fun ByteBuffer.readUnsignedByte(): Int = get().toInt() and 0xFF
 internal fun ByteBuffer.readUnsignedShort(): Int = short.toInt() and 0xFFFF
-internal fun ByteBuffer.readUnsignedMedium(): Int = ((get().toInt() and 0xFF shl 16) or (get().toInt() and 0xFF shl 8) or (get().toInt() and 0xFF))
+internal fun ByteBuffer.readUnsignedMedium(): Int = ((readUnsignedByte() shl 16) or (readUnsignedByte() shl 8) or readUnsignedByte())
 internal fun ByteBuffer.readUnsignedIntShortSmart(): Int = if (get(position()).toInt() < 0) int and Int.MAX_VALUE else readUnsignedShort()
 
 internal fun ByteBuffer.remainingBytes(): ByteArray {

cache/src/main/kotlin/com/runetopic/cache/hierarchy/ReferenceTable.kt

@@ -1,47 +1,35 @@
 package com.runetopic.cache.hierarchy
 
-import com.runetopic.cache.store.storage.js5.IIdxFile
-import java.util.*
-
 /**
  * @author Tyler Telis
  * @email <[email protected]>
  *
  * @author Jordan Abraham
  */
 internal data class ReferenceTable(
-    val idxFile: IIdxFile,
     val id: Int,
     val sector: Int,
     val length: Int
 ) {
     fun exists(): Boolean = (length != 0 && sector != 0)
 
-    override fun hashCode(): Int {
-        var hash = 7
-        hash = 19 * hash + Objects.hashCode(this.idxFile)
-        hash = 19 * hash + this.id
-        hash = 19 * hash + this.sector
-        hash = 19 * hash + this.length
-        return hash
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as ReferenceTable
+
+        if (id != other.id) return false
+        if (sector != other.sector) return false
+        if (length != other.length) return false
+
+        return true
     }
 
-    override fun equals(other: Any?): Boolean {
-        when (other) {
-            null -> return false
-            else -> return when {
-                javaClass != other.javaClass -> false
-                else -> {
-                    val referenceTable: ReferenceTable = other as ReferenceTable
-                    when {
-                        idxFile != referenceTable.idxFile -> false
-                        id != referenceTable.id -> false
-                        sector != referenceTable.sector -> false
-                        length != referenceTable.length -> false
-                        else -> true
-                    }
-                }
-            }
-        }
+    override fun hashCode(): Int {
+        var result = id
+        result = 31 * result + sector
+        result = 31 * result + length
+        return result
     }
 }

cache/src/main/kotlin/com/runetopic/cache/store/Constants.kt

@@ -10,12 +10,10 @@ internal object Constants {
     const val MAIN_FILE_DAT = "$PREFIX.dat2"
     const val MAIN_FILE_255 = "$PREFIX.idx255"
 
-    const val SECTOR_SIZE = 520
+    const val IDX_SIZE = 6
+    const val DAT_SIZE = 520
     const val MASTER_INDEX_ID = 255
 
-
-
-
     val BZIP_HEADER = byteArrayOf(
         'B'.code.toByte(),
         'Z'.code.toByte(),