More documentation and tidying

build.gradle.kts

@@ -141,4 +141,4 @@ bintray {
         setLicenses("MIT")
         vcsUrl = "https://g.c5h.io/public/ktirc"
     }
-}
+}

src/main/kotlin/com/dmdirc/ktirc/events/CapabilitiesHandler.kt

@@ -51,4 +51,4 @@ internal class CapabilitiesHandler : EventHandler {
         }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/events/ChannelStateHandler.kt

@@ -64,4 +64,4 @@ internal class ChannelStateHandler : EventHandler {
         client.channelState.forEach { it.users -= event.user.nickname }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/events/EventHandler.kt

@@ -15,4 +15,4 @@ internal val eventHandlers = listOf(
         PingHandler(),
         ServerStateHandler(),
         UserStateHandler()
-)
+)

src/main/kotlin/com/dmdirc/ktirc/events/EventUtils.kt

@@ -8,7 +8,7 @@ internal fun ChannelNamesReceived.toModesAndUsers(client: IrcClient) = sequence
     val modePrefixes = client.serverState.features[ServerFeature.ModePrefixes]!!
     for (user in names) {
         user.takeWhile { modePrefixes.isPrefix(it) }.let { prefix ->
-            yield(Pair(modePrefixes.getModes(prefix), user.substring(prefix.length).asUser()))
+            yield(modePrefixes.getModes(prefix) to user.substring(prefix.length).asUser())
         }
     }
 }.toList()

src/main/kotlin/com/dmdirc/ktirc/events/Events.kt

@@ -5,6 +5,7 @@ import com.dmdirc.ktirc.model.ServerFeatureMap
 import com.dmdirc.ktirc.model.User
 import java.time.LocalDateTime
 
+/** Base class for all events. */
 sealed class IrcEvent(val time: LocalDateTime)
 
 /** Raised when the server initially welcomes us to the IRC network. */
@@ -45,4 +46,4 @@ class ServerCapabilitiesReceived(time: LocalDateTime, val capabilities: Map<Capa
 class ServerCapabilitiesAcknowledged(time: LocalDateTime, val capabilities: Map<Capability, String>) : IrcEvent(time)
 
 /** Raised when the server has finished sending us capabilities. */
-class ServerCapabilitiesFinished(time: LocalDateTime) : IrcEvent(time)
+class ServerCapabilitiesFinished(time: LocalDateTime) : IrcEvent(time)

src/main/kotlin/com/dmdirc/ktirc/events/PingHandler.kt

@@ -11,4 +11,4 @@ internal class PingHandler : EventHandler {
         }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/events/ServerStateHandler.kt

@@ -11,4 +11,4 @@ internal class ServerStateHandler : EventHandler {
         }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/events/UserStateHandler.kt

@@ -45,4 +45,4 @@ internal class UserStateHandler : EventHandler {
         state -= event.user
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/io/CaseMapping.kt

@@ -23,4 +23,4 @@ enum class CaseMapping(private val lowerToUpperMapping: Pair<IntRange, IntRange>
     private fun areEquivalent(char1: Char, char2: Char) = char1 == char2 || char1.toUpper() == char2.toUpper()
     private fun Char.toUpper() = this + if (this.toInt() in lowerToUpperMapping.first) lowerToUpperMapping.second.start - lowerToUpperMapping.first.start else 0
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/io/LineBufferedSocket.kt

@@ -42,7 +42,7 @@ internal class KtorLineBufferedSocket(private val host: String, private val port
         const val LINE_FEED = '\n'.toByte()
     }
 
-    public var tlsTrustManager: X509TrustManager? = null
+    var tlsTrustManager: X509TrustManager? = null
 
     private val log by logger()
 
@@ -100,4 +100,4 @@ internal class KtorLineBufferedSocket(private val host: String, private val port
             index = count + index - start
         }
     }
-}
+}

src/main/kotlin/com/dmdirc/ktirc/io/MessageHandler.kt

@@ -28,4 +28,4 @@ internal class MessageHandler(private val processors: List<MessageProcessor>, va
         null
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/io/MessageParser.kt

@@ -89,7 +89,7 @@ internal class MessageParser {
             val index = tag.indexOf('=')
             val name = if (index == -1) tag else tag.substring(0 until index)
             messageTags[name]?.let {
-                yield(Pair(it, if (index == -1) "" else tag.substring(index + 1).unescapeTagValue()))
+                yield(it to if (index == -1) "" else tag.substring(index + 1).unescapeTagValue())
             } ?: log.severe { "Unknown message tag: $name"}
         }
     }.toMap()
@@ -175,4 +175,4 @@ internal class CursorByteArray(private val data: ByteArray, var cursor: Int = 0)
         return cursor
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/CapabilityProcessor.kt

@@ -41,8 +41,8 @@ internal class CapabilityProcessor : MessageProcessor {
             val index = cap.indexOf('=')
             val name = if (index == -1) cap else cap.substring(0 until index)
             val value = if (index == -1) "" else cap.substring(index + 1)
-            capabilities[name]?.let { yield(Pair(it, value)) } ?: log.info { "Unknown capability: $name (value: $value)" }
+            capabilities[name]?.let { yield(it to value) } ?: log.info { "Unknown capability: $name (value: $value)" }
         }
     }.toMap()
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/ISupportProcessor.kt

@@ -68,4 +68,4 @@ internal class ISupportProcessor : MessageProcessor {
         }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/JoinProcessor.kt

@@ -20,4 +20,4 @@ internal class JoinProcessor : MessageProcessor {
         }
     }
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/MessageBuilders.kt

@@ -1,10 +1,18 @@
 package com.dmdirc.ktirc.messages
 
-fun capabilityEndMessage() = "CAP END"
-fun capabilityRequestMessage(capabilities: List<String>) = "CAP REQ :${capabilities.joinToString(" ")}"
+/** Construct a message indicating the end of capability negotiation. */
+internal fun capabilityEndMessage() = "CAP END"
+/** Construct a message requesting the specified caps are enabled. */
+internal fun capabilityRequestMessage(capabilities: List<String>) = "CAP REQ :${capabilities.joinToString(" ")}"
+/** Construct a message to join the given channel. */
 fun joinMessage(channel: String) = "JOIN :$channel"
+/** Construct a message to change to the given nickname. */
 fun nickMessage(nick: String) = "NICK :$nick"
-fun passwordMessage(password: String) = "PASS :$password"
-fun pongMessage(nonce: ByteArray) = "PONG :${String(nonce)}"
+/** Construct a message to provide the connection password to the server. */
+internal fun passwordMessage(password: String) = "PASS :$password"
+/** Construct a message to reply to a PING event. */
+internal fun pongMessage(nonce: ByteArray) = "PONG :${String(nonce)}"
+/** Construct a message to send a private message to a user or channel. */
 fun privmsgMessage(target: String, message: String) = "PRIVMSG $target :$message"
-fun userMessage(userName: String, localHostName: String, serverHostName: String, realName: String) = "USER $userName $localHostName $serverHostName :$realName"
+/** Construct a message to register a user with the server. */
+internal fun userMessage(userName: String, localHostName: String, serverHostName: String, realName: String) = "USER $userName $localHostName $serverHostName :$realName"

src/main/kotlin/com/dmdirc/ktirc/messages/MessageProcessor.kt

@@ -27,4 +27,4 @@ internal val messageProcessors = setOf(
         PrivmsgProcessor(),
         QuitProcessor(),
         WelcomeProcessor()
-)
+)

src/main/kotlin/com/dmdirc/ktirc/messages/PartProcessor.kt

@@ -17,4 +17,4 @@ internal class PartProcessor : MessageProcessor {
     private val IrcMessage.reason
         get() = if (params.size > 1) String(params[1]) else ""
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/PingProcessor.kt

@@ -9,4 +9,4 @@ internal class PingProcessor : MessageProcessor {
 
     override fun process(message: IrcMessage) = listOf(PingReceived(message.time, message.params[0]))
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/PrivmsgProcessor.kt

@@ -11,4 +11,4 @@ internal class PrivmsgProcessor : MessageProcessor {
         listOf(MessageReceived(message.time, user, String(message.params[0]), String(message.params[1])))
     } ?: emptyList()
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/QuitProcessor.kt

@@ -14,4 +14,4 @@ internal class QuitProcessor : MessageProcessor {
     private val IrcMessage.reason
         get() = if (params.isNotEmpty()) String(params[0]) else ""
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/messages/WelcomeProcessor.kt

@@ -9,4 +9,4 @@ internal class WelcomeProcessor : MessageProcessor {
 
     override fun process(message: IrcMessage) = listOf(ServerWelcome(message.time, String(message.params[0])))
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/model/CaseInsensitiveSet.kt

@@ -28,4 +28,4 @@ class CaseInsensitiveSet(private val caseMappingProvider: () -> CaseMapping) : I
 
     fun isEmpty() = items.isEmpty()
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/model/IrcMessage.kt

@@ -32,4 +32,4 @@ sealed class MessageTag(val name: String) {
 
 internal val messageTags: Map<String, MessageTag> by lazy {
     MessageTag::class.nestedClasses.map { it.objectInstance as MessageTag }.associateBy { it.name }
-}
+}

src/main/kotlin/com/dmdirc/ktirc/model/Server.kt

@@ -1,3 +1,3 @@
 package com.dmdirc.ktirc.model
 
-data class Server(val host: String, val port: Int, val tls: Boolean = false, val password: String? = null)
+data class Server(val host: String, val port: Int, val tls: Boolean = false, val password: String? = null)

src/main/kotlin/com/dmdirc/ktirc/model/ServerState.kt

@@ -47,4 +47,4 @@ sealed class ServerFeature<T : Any>(val name: String, val type: KClass<T>, val d
 
 internal val serverFeatures: Map<String, ServerFeature<*>> by lazy {
     ServerFeature::class.nestedClasses.map { it.objectInstance as ServerFeature<*> }.associateBy { it.name }
-}
+}

src/main/kotlin/com/dmdirc/ktirc/model/User.kt

@@ -32,4 +32,4 @@ internal fun String.asUser(): User {
     } else {
         User(this)
     }
-}
+}

src/main/kotlin/com/dmdirc/ktirc/model/UserState.kt

@@ -38,4 +38,4 @@ class KnownUser(caseMappingProvider: () -> CaseMapping, val details: User) {
     operator fun minusAssign(channel: String) { channels -= channel }
     operator fun contains(channel: String) = channel in channels
 
-}
+}

src/main/kotlin/com/dmdirc/ktirc/util/Logging.kt

@@ -9,4 +9,4 @@ private fun <T: Any> logger(forClass: KClass<T>): Logger {
 
 internal fun <R : Any> R.logger(): Lazy<Logger> {
     return lazy { logger(this::class) }
-}
+}