Further cleanups and improved documentation

libquassel-client/src/main/kotlin/de/justjanne/libquassel/client/io/FixedDeflaterOutputStream.kt

@@ -29,6 +29,9 @@ import java.util.zip.DeflaterOutputStream
 class FixedDeflaterOutputStream(
   stream: OutputStream
 ) : DeflaterOutputStream(stream, true) {
+  /**
+   * Close the underlying stream and deflater
+   */
   override fun close() {
     try {
       super.close()

libquassel-client/src/main/kotlin/de/justjanne/libquassel/client/io/ReadableWrappedChannel.kt

@@ -24,12 +24,19 @@ import java.nio.ByteBuffer
 import java.nio.channels.ReadableByteChannel
 import java.nio.channels.spi.AbstractInterruptibleChannel
 
+/**
+ * Utility function to wrap an input stream into a readable channel
+ */
 class ReadableWrappedChannel(
   private var backingStream: InputStream
 ) : AbstractInterruptibleChannel(), ReadableByteChannel {
   private val buffer = ByteBuffer.allocate(PAGE_SIZE)
   private val lock = Any()
 
+  /**
+   * Reads from the channel into a given byte buffer and returns the amount of
+   * written bytes
+   */
   override fun read(dst: ByteBuffer): Int {
     val totalData = dst.remaining()
     var remainingData = totalData
@@ -81,6 +88,9 @@ class ReadableWrappedChannel(
     return (totalData - remainingData)
   }
 
+  /**
+   * Close the underlying stream
+   */
   override fun implCloseChannel() = backingStream.close()
 
   companion object {

libquassel-client/src/main/kotlin/de/justjanne/libquassel/client/io/WritableWrappedChannel.kt

@@ -24,12 +24,19 @@ import java.nio.ByteBuffer
 import java.nio.channels.WritableByteChannel
 import java.nio.channels.spi.AbstractInterruptibleChannel
 
+/**
+ * Utility function to wrap an output stream into a writable channel
+ */
 class WritableWrappedChannel(
   private var backingStream: OutputStream
 ) : AbstractInterruptibleChannel(), WritableByteChannel {
   private val buffer = ByteBuffer.allocate(PAGE_SIZE)
   private val lock = Any()
 
+  /**
+   * Write a given byte buffer to the channel and return the amount of written
+   * bytes
+   */
   override fun write(src: ByteBuffer): Int {
     val totalData = src.remaining()
     var remainingData = totalData
@@ -63,6 +70,9 @@ class WritableWrappedChannel(
     }
   }
 
+  /**
+   * Close the underlying stream
+   */
   override fun implCloseChannel() = backingStream.close()
 
   companion object {

libquassel-client/src/main/kotlin/de/justjanne/libquassel/client/util/X509Helper.kt

@@ -26,6 +26,10 @@ import java.security.cert.X509Certificate
 
 private val certificateFactory = CertificateFactory.getInstance("X.509")
 
+/**
+ * Utility function to extract, if available, an X509 Certificate from a given
+ * certificate
+ */
 fun Certificate.toX509(): X509Certificate =
   certificateFactory.generateCertificate(ByteArrayInputStream(this.encoded))
     as X509Certificate

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/io/ChainedByteBuffer.kt

@@ -204,11 +204,3 @@ class ChainedByteBuffer(
       buffer.bufferList[index++].duplicate().flip()
   }
 }
-
-inline fun ChainedByteBuffer.use(
-  function: (ChainedByteBuffer) -> Unit
-): ByteBuffer {
-  val buffer = ChainedByteBuffer()
-  function(buffer)
-  return buffer.toBuffer()
-}

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/io/useChainedByteBuffer.kt

+package de.justjanne.libquassel.protocol.io
+
+import java.nio.ByteBuffer
+
+/**
+ * Utility function to apply a closure to a chained byte buffer and return its data
+ */
+inline fun useChainedByteBuffer(
+  function: (ChainedByteBuffer) -> Unit
+): ByteBuffer {
+  val buffer = ChainedByteBuffer()
+  function(buffer)
+  return buffer.toBuffer()
+}

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/models/DccIpDetectionMode.kt

@@ -28,10 +28,14 @@ enum class DccIpDetectionMode(
    */
   val value: UByte,
 ) {
-  /** Automatic detection (network socket or USERHOST) */
+  /**
+   * Automatic detection
+   */
   Automatic(0x00u),
 
-  /** Manually specified IP */
+  /**
+   * Manually specified
+   */
   Manual(0x01u);
 
   companion object {

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/models/DccPortSelectionMode.kt

@@ -28,10 +28,14 @@ enum class DccPortSelectionMode(
    */
   val value: UByte,
 ) {
-  /** Automatic port selection */
+  /**
+   * Automatic port selection
+   */
   Automatic(0x00u),
 
-  /** Manually specified port range */
+  /**
+   * Manually specified port range
+   */
   Manual(0x01u);
 
   companion object {

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/serializers/signalproxy/HeartBeatReplySerializer.kt

@@ -8,6 +8,9 @@ import de.justjanne.libquassel.protocol.variant.into
 import de.justjanne.libquassel.protocol.variant.qVariant
 import org.threeten.bp.Instant
 
+/**
+ * Serializer for [SignalProxyMessage.HeartBeatReply]
+ */
 object HeartBeatReplySerializer : SignalProxySerializer<SignalProxyMessage.HeartBeatReply> {
   override val type: Int = 6
 

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/serializers/signalproxy/HeartBeatSerializer.kt

@@ -8,6 +8,9 @@ import de.justjanne.libquassel.protocol.variant.into
 import de.justjanne.libquassel.protocol.variant.qVariant
 import org.threeten.bp.Instant
 
+/**
+ * Serializer for [SignalProxyMessage.HeartBeat]
+ */
 object HeartBeatSerializer : SignalProxySerializer<SignalProxyMessage.HeartBeat> {
   override val type: Int = 5
 

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/serializers/signalproxy/InitDataSerializer.kt

@@ -11,6 +11,9 @@ import de.justjanne.libquassel.protocol.variant.toVariantList
 import de.justjanne.libquassel.protocol.variant.toVariantMap
 import java.nio.ByteBuffer
 
+/**
+ * Serializer for [SignalProxyMessage.InitData]
+ */
 object InitDataSerializer : SignalProxySerializer<SignalProxyMessage.InitData> {
   override val type: Int = 4
 

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/serializers/signalproxy/InitRequestSerializer.kt

@@ -9,6 +9,9 @@ import de.justjanne.libquassel.protocol.variant.into
 import de.justjanne.libquassel.protocol.variant.qVariant
 import java.nio.ByteBuffer
 
+/**
+ * Serializer for [SignalProxyMessage.InitRequest]
+ */
 object InitRequestSerializer : SignalProxySerializer<SignalProxyMessage.InitRequest> {
   override val type: Int = 3
 

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/serializers/signalproxy/RpcSerializer.kt

@@ -9,6 +9,9 @@ import de.justjanne.libquassel.protocol.variant.into
 import de.justjanne.libquassel.protocol.variant.qVariant
 import java.nio.ByteBuffer
 
+/**
+ * Serializer for [SignalProxyMessage.Rpc]
+ */
 object RpcSerializer : SignalProxySerializer<SignalProxyMessage.Rpc> {
   override val type: Int = 2
 

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/serializers/signalproxy/SyncSerializer.kt

@@ -9,6 +9,9 @@ import de.justjanne.libquassel.protocol.variant.into
 import de.justjanne.libquassel.protocol.variant.qVariant
 import java.nio.ByteBuffer
 
+/**
+ * Serializer for [SignalProxyMessage.Sync]
+ */
 object SyncSerializer : SignalProxySerializer<SignalProxyMessage.Sync> {
   override val type: Int = 1
 

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/variant/QVariantList.kt

@@ -5,7 +5,10 @@ package de.justjanne.libquassel.protocol.variant
  */
 typealias QVariantList = List<QVariant_>
 
+/**
+ * Transform a QVariantList of interleaved keys and values into a QVariantMap
+ */
 fun QVariantList.toVariantMap(): QVariantMap =
-  this.zipWithNext().map { (key, value) ->
+  zipWithNext { key, value ->
     Pair(key.into(""), value)
   }.toMap()

libquassel-protocol/src/main/kotlin/de/justjanne/libquassel/protocol/variant/QVariantMap.kt

@@ -7,7 +7,10 @@ import de.justjanne.libquassel.protocol.models.types.QtType
  */
 typealias QVariantMap = Map<String, QVariant_>
 
+/**
+ * Transform a QVariantMap into a QVariantList of interleaved keys and values
+ */
 fun QVariantMap.toVariantList(): QVariantList =
-  this.toList().flatMap { (key, value) ->
+  flatMap { (key, value) ->
     listOf(qVariant(key, QtType.QString), value)
   }

libquassel-protocol/src/test/kotlin/de/justjanne/libquassel/protocol/testutil/handshakeSerializerTest.kt

@@ -19,8 +19,7 @@
 package de.justjanne.libquassel.protocol.testutil
 
 import de.justjanne.libquassel.protocol.features.FeatureSet
-import de.justjanne.libquassel.protocol.io.ChainedByteBuffer
-import de.justjanne.libquassel.protocol.io.use
+import de.justjanne.libquassel.protocol.io.useChainedByteBuffer
 import de.justjanne.libquassel.protocol.models.HandshakeMessage
 import de.justjanne.libquassel.protocol.serializers.HandshakeMessageSerializer
 import de.justjanne.libquassel.protocol.testutil.matchers.ByteBufferMatcher
@@ -48,7 +47,7 @@ inline fun <reified T : HandshakeMessage> handshakeSerializerTest(
     }
     if (serializeFeatureSet != null) {
       assertThat(
-        ChainedByteBuffer().use {
+        useChainedByteBuffer {
           HandshakeMessageSerializer.serialize(it, value, serializeFeatureSet)
         },
         ByteBufferMatcher(encoded.rewind())
@@ -57,7 +56,7 @@ inline fun <reified T : HandshakeMessage> handshakeSerializerTest(
   }
   for (featureSet in featureSets) {
     val after = HandshakeMessageSerializer.deserialize(
-      ChainedByteBuffer().use {
+      useChainedByteBuffer {
         HandshakeMessageSerializer.serialize(it, value, featureSet)
       },
       featureSet

libquassel-protocol/src/test/kotlin/de/justjanne/libquassel/protocol/testutil/primitiveSerializerTest.kt

@@ -19,8 +19,7 @@
 package de.justjanne.libquassel.protocol.testutil
 
 import de.justjanne.libquassel.protocol.features.FeatureSet
-import de.justjanne.libquassel.protocol.io.ChainedByteBuffer
-import de.justjanne.libquassel.protocol.io.use
+import de.justjanne.libquassel.protocol.io.useChainedByteBuffer
 import de.justjanne.libquassel.protocol.models.types.QtType
 import de.justjanne.libquassel.protocol.models.types.QuasselType
 import de.justjanne.libquassel.protocol.serializers.PrimitiveSerializer
@@ -86,7 +85,7 @@ inline fun <reified T : Any?> primitiveSerializerTest(
       }
     }
     if (serializeFeatureSet != null) {
-      val after = ChainedByteBuffer().use {
+      val after = useChainedByteBuffer {
         serializer.serialize(it, value, serializeFeatureSet)
       }
       assertThat(after, ByteBufferMatcher(encoded.rewind()))

libquassel-protocol/src/test/kotlin/de/justjanne/libquassel/protocol/testutil/serializerTest.kt

@@ -19,8 +19,7 @@
 package de.justjanne.libquassel.protocol.testutil
 
 import de.justjanne.libquassel.protocol.features.FeatureSet
-import de.justjanne.libquassel.protocol.io.ChainedByteBuffer
-import de.justjanne.libquassel.protocol.io.use
+import de.justjanne.libquassel.protocol.io.useChainedByteBuffer
 import de.justjanne.libquassel.protocol.serializers.PrimitiveSerializer
 import de.justjanne.libquassel.protocol.testutil.matchers.ByteBufferMatcher
 import org.hamcrest.Matcher
@@ -47,7 +46,7 @@ fun <T : Any?> serializerTest(
       }
     }
     if (serializeFeatureSet != null) {
-      val after = ChainedByteBuffer().use {
+      val after = useChainedByteBuffer {
         serializer.serialize(it, value, serializeFeatureSet)
       }
       assertThat(after, ByteBufferMatcher(encoded.rewind()))

libquassel-protocol/src/test/kotlin/de/justjanne/libquassel/protocol/testutil/signalProxySerializerTest.kt

@@ -19,8 +19,7 @@
 package de.justjanne.libquassel.protocol.testutil
 
 import de.justjanne.libquassel.protocol.features.FeatureSet
-import de.justjanne.libquassel.protocol.io.ChainedByteBuffer
-import de.justjanne.libquassel.protocol.io.use
+import de.justjanne.libquassel.protocol.io.useChainedByteBuffer
 import de.justjanne.libquassel.protocol.models.SignalProxyMessage
 import de.justjanne.libquassel.protocol.serializers.SignalProxyMessageSerializer
 import de.justjanne.libquassel.protocol.testutil.matchers.ByteBufferMatcher
@@ -48,7 +47,7 @@ inline fun <reified T : SignalProxyMessage> signalProxySerializerTest(
     }
     if (serializeFeatureSet != null) {
       assertThat(
-        ChainedByteBuffer().use {
+        useChainedByteBuffer {
           SignalProxyMessageSerializer.serialize(it, value, serializeFeatureSet)
         },
         ByteBufferMatcher(encoded.rewind())
@@ -57,7 +56,7 @@ inline fun <reified T : SignalProxyMessage> signalProxySerializerTest(
   }
   for (featureSet in featureSets) {
     val after = SignalProxyMessageSerializer.deserialize(
-      ChainedByteBuffer().use {
+      useChainedByteBuffer {
         SignalProxyMessageSerializer.serialize(it, value, featureSet)
       },
       featureSet