Updated Kotlin version and some cleanups for the new code (#121)

Author: StefanOltmann

README.md

@@ -1,6 +1,6 @@
 # Kim - Kotlin Image Metadata
 
-[![Kotlin](https://img.shields.io/badge/kotlin-2.1.10-blue.svg?logo=kotlin)](httpw://kotlinlang.org)
+[![Kotlin](https://img.shields.io/badge/kotlin-2.1.20-blue.svg?logo=kotlin)](httpw://kotlinlang.org)
 ![JVM](https://img.shields.io/badge/-JVM-gray.svg?style=flat)
 ![Android](https://img.shields.io/badge/-Android-gray.svg?style=flat)
 ![iOS](https://img.shields.io/badge/-iOS-gray.svg?style=flat)
@@ -39,7 +39,7 @@ of Ashampoo Photo Organizer, which, in turn, is driven by user community feedbac
 ## Installation
 
 ```
-implementation("com.ashampoo:kim:0.23")
+implementation("com.ashampoo:kim:0.24")
 ```
 
 For the targets `wasmJs` & `js` you also need to specify this:

build.gradle.kts

@@ -4,7 +4,7 @@ import org.jetbrains.kotlin.gradle.plugin.mpp.NativeBuildType
 import org.jetbrains.kotlin.gradle.plugin.mpp.apple.XCFramework
 
 plugins {
-    kotlin("multiplatform") version "2.1.10"
+    kotlin("multiplatform") version "2.1.20"
     id("com.android.library") version "8.5.0"
     id("maven-publish")
     id("signing")
@@ -25,7 +25,7 @@ repositories {
 
 val productName: String = "Ashampoo Kim"
 
-val ktorVersion: String = "3.1.1"
+val ktorVersion: String = "3.1.2"
 val xmpCoreVersion: String = "1.5.1"
 val dateTimeVersion: String = "0.6.2"
 val kotlinxIoVersion: String = "0.7.0"

src/commonMain/kotlin/com/ashampoo/kim/format/gif/GifChunkType.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2025 Ramon Bouckaert
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package com.ashampoo.kim.format.gif
 
 public enum class GifChunkType {

src/commonMain/kotlin/com/ashampoo/kim/format/gif/GifConstants.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2025 Ramon Bouckaert
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package com.ashampoo.kim.format.gif
 
 import com.ashampoo.kim.common.ByteOrder

src/commonMain/kotlin/com/ashampoo/kim/format/gif/GifImageParser.kt

@@ -1,3 +1,19 @@
+/*
+ * Copyright 2025 Ramon Bouckaert
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 package com.ashampoo.kim.format.gif
 
 import com.ashampoo.kim.common.ImageReadException
@@ -31,11 +47,11 @@ public object GifImageParser : ImageParser {
     @Throws(ImageReadException::class)
     override fun parseMetadata(byteReader: ByteReader): ImageMetadata =
         tryWithImageReadException {
+
             val chunks = readChunks(byteReader, metadataChunkTypes)
 
-            if (chunks.isEmpty()) {
+            if (chunks.isEmpty())
                 throw ImageReadException("Did not find any chunks in file.")
-            }
 
             return@tryWithImageReadException parseMetadataFromChunks(chunks)
         }
@@ -52,7 +68,7 @@ public object GifImageParser : ImageParser {
 
         checkNotNull(headerChunk) {
             "Did not find mandatory header chunk. " +
-                    "Found chunk types: ${chunks.map { it.type }}"
+                "Found chunk types: ${chunks.map { it.type }}"
         }
 
         val version = headerChunk.version
@@ -61,13 +77,16 @@ public object GifImageParser : ImageParser {
 
         checkNotNull(firstImageDescriptorChunk) {
             "Did not find mandatory image descriptor chunk. " +
-                    "Found chunk types: ${chunks.map { it.type }}"
+                "Found chunk types: ${chunks.map { it.type }}"
         }
 
         val imageSize = firstImageDescriptorChunk.imageSize
 
-        // Only GIF89A supports XMP metadata
-        val xmp = if (version == GifVersion.GIF89A) getXmpXml(chunks) else null
+        /* Only GIF89A supports XMP metadata */
+        val xmp = if (version == GifVersion.GIF89A)
+            getXmpXml(chunks)
+        else
+            null
 
         return@tryWithImageReadException ImageMetadata(
             imageFormat = ImageFormat.GIF,
@@ -89,36 +108,47 @@ public object GifImageParser : ImageParser {
         byteReader: ByteReader,
         chunkTypeFilter: List<GifChunkType>?
     ): List<GifChunk> {
+
         val chunks = mutableListOf<GifChunk>()
 
-        // Read header chunk
+        /* Read header chunk */
         val headerBytes = byteReader.readBytes(6)
-        if (chunkTypeFilter?.contains(GifChunkType.HEADER) != false) chunks.add(GifChunkHeader(headerBytes))
 
-        // Read logical screen descriptor chunk
+        if (chunkTypeFilter?.contains(GifChunkType.HEADER) != false)
+            chunks.add(GifChunkHeader(headerBytes))
+
+        /* Read logical screen descriptor chunk */
         val logicalScreenDescriptorBytes = byteReader.readBytes(7)
         val logicalScreenDescriptorChunk = GifChunkLogicalScreenDescriptor(logicalScreenDescriptorBytes)
+
         if (chunkTypeFilter?.contains(GifChunkType.LOGICAL_SCREEN_DESCRIPTOR) != false)
             chunks.add(logicalScreenDescriptorChunk)
 
-        // Read global color table chunk if present
+        /* Read global color table chunk if present */
         if (logicalScreenDescriptorChunk.globalColorTableFlag) {
+
             val globalColorTableSize = 3 * (1 shl (logicalScreenDescriptorChunk.globalColorTableSize + 1))
+
             val globalColorTableBytes = byteReader.readBytes(globalColorTableSize)
-            if (chunkTypeFilter?.contains(GifChunkType.GLOBAL_COLOR_TABLE) != false) {
+
+            if (chunkTypeFilter?.contains(GifChunkType.GLOBAL_COLOR_TABLE) != false)
                 chunks.add(GifChunk(GifChunkType.GLOBAL_COLOR_TABLE, globalColorTableBytes))
-            }
         }
 
-        // Read remaining chunks
+        /* Read remaining chunks */
         while (true) {
+
             when (byteReader.readByte("introducer")) {
+
                 GifConstants.IMAGE_SEPARATOR -> chunks.addAll(readImageChunks(byteReader, chunkTypeFilter))
+
                 GifConstants.EXTENSION_INTRODUCER -> readExtensionChunk(byteReader, chunkTypeFilter)?.also(chunks::add)
+
                 GifConstants.GIF_TERMINATOR -> {
-                    if (chunkTypeFilter?.contains(GifChunkType.TERMINATOR) != false) {
+
+                    if (chunkTypeFilter?.contains(GifChunkType.TERMINATOR) != false)
                         chunks.add(GifChunkTerminator(byteArrayOf(GifConstants.GIF_TERMINATOR)))
-                    }
+
                     break
                 }
             }
@@ -127,91 +157,107 @@ public object GifImageParser : ImageParser {
         return chunks
     }
 
-    private fun readImageChunks(byteReader: ByteReader, chunkTypeFilter: List<GifChunkType>?): List<GifChunk> {
+    private fun readImageChunks(
+        byteReader: ByteReader,
+        chunkTypeFilter: List<GifChunkType>?
+    ): List<GifChunk> {
+
         val chunks = mutableListOf<GifChunk>()
 
-        // Read image descriptor
+        /* Read image descriptor */
         val imageDescriptorBytes = byteReader.readBytes("image descriptor", 9)
+
         val imageDescriptorChunk = GifChunkImageDescriptor(
             byteArrayOf(GifConstants.IMAGE_SEPARATOR) + imageDescriptorBytes
         )
+
         if (chunkTypeFilter?.contains(GifChunkType.IMAGE_DESCRIPTOR) != false)
             chunks.add(imageDescriptorChunk)
 
-        // Read local color table if present
+        /* Read local color table if present */
         if (imageDescriptorChunk.localColorTableFlag) {
+
             val localColorTableSize = 3 * (1 shl (imageDescriptorChunk.localColorTableSize + 1))
             val localColorTableBytes = byteReader.readBytes("local color table", localColorTableSize)
-            if (chunkTypeFilter?.contains(GifChunkType.LOCAL_COLOR_TABLE) != false) {
+
+            if (chunkTypeFilter?.contains(GifChunkType.LOCAL_COLOR_TABLE) != false)
                 chunks.add(GifChunk(GifChunkType.LOCAL_COLOR_TABLE, localColorTableBytes))
-            }
         }
 
-        // Read image data
+        /* Read image data */
         val lzwMinimumCodeSize = byteReader.readByte("LZW minimum code size")
         val subChunks = byteReader.parseGifSubChunksUntilEmpty("image data")
-        if (chunkTypeFilter?.contains(GifChunkType.IMAGE_DATA) != false) {
+
+        if (chunkTypeFilter?.contains(GifChunkType.IMAGE_DATA) != false)
             chunks.add(GifChunkImageData(lzwMinimumCodeSize, subChunks))
-        }
 
         return chunks
     }
 
-    private fun readExtensionChunk(byteReader: ByteReader, chunkTypeFilter: List<GifChunkType>?): GifChunk? =
+    private fun readExtensionChunk(
+        byteReader: ByteReader,
+        chunkTypeFilter: List<GifChunkType>?
+    ): GifChunk? =
         when (byteReader.readByte("extension label")) {
+
             GifConstants.GRAPHICS_CONTROL_EXTENSION_LABEL -> {
+
                 val graphicsControlExtensionBytes = byteReader.readBytes("graphics control extension", 6)
+
                 val graphicsControlExtensionChunk = GifChunk(
                     GifChunkType.GRAPHICS_CONTROL_EXTENSION,
                     byteArrayOf(
                         GifConstants.EXTENSION_INTRODUCER,
                         GifConstants.GRAPHICS_CONTROL_EXTENSION_LABEL
                     ) + graphicsControlExtensionBytes
                 )
-                if (chunkTypeFilter?.contains(GifChunkType.GRAPHICS_CONTROL_EXTENSION) != false) {
+
+                if (chunkTypeFilter?.contains(GifChunkType.GRAPHICS_CONTROL_EXTENSION) != false)
                     graphicsControlExtensionChunk
-                } else {
+                else
                     null
-                }
             }
 
             GifConstants.APPLICATION_EXTENSION_LABEL -> {
+
                 val subChunks = byteReader.parseGifSubChunksUntilEmpty("application extension")
-                if (chunkTypeFilter?.contains(GifChunkType.APPLICATION_EXTENSION) != false) {
+
+                if (chunkTypeFilter?.contains(GifChunkType.APPLICATION_EXTENSION) != false)
                     GifChunkApplicationExtension(
                         byteArrayOf(
                             GifConstants.EXTENSION_INTRODUCER,
                             GifConstants.APPLICATION_EXTENSION_LABEL
                         ),
                         subChunks
                     )
-                } else {
+                else
                     null
-                }
             }
 
             GifConstants.COMMENT_EXTENSION_LABEL -> {
+
                 val subChunks = byteReader.parseGifSubChunksUntilEmpty("comment extension")
-                if (chunkTypeFilter?.contains(GifChunkType.COMMENT_EXTENSION) != false) {
+
+                if (chunkTypeFilter?.contains(GifChunkType.COMMENT_EXTENSION) != false)
                     GifChunkCommentExtension(
                         byteArrayOf(GifConstants.EXTENSION_INTRODUCER, GifConstants.COMMENT_EXTENSION_LABEL),
                         subChunks
                     )
-                } else {
+                else
                     null
-                }
             }
 
             GifConstants.PLAIN_TEXT_EXTENSION_LABEL -> {
+
                 val subChunks = byteReader.parseGifSubChunksUntilEmpty("plain text extension")
-                if (chunkTypeFilter?.contains(GifChunkType.PLAIN_TEXT_EXTENSION) != false) {
+
+                if (chunkTypeFilter?.contains(GifChunkType.PLAIN_TEXT_EXTENSION) != false)
                     GifChunkPlainTextExtension(
                         byteArrayOf(GifConstants.EXTENSION_INTRODUCER, GifConstants.PLAIN_TEXT_EXTENSION_LABEL),
                         subChunks
                     )
-                } else {
+                else
                     null
-                }
             }
 
             else -> null
@@ -220,13 +266,22 @@ public object GifImageParser : ImageParser {
     internal fun ByteReader.parseGifSubChunksUntilEmpty(
         fieldName: String
     ): List<ByteArray> {
+
         val subChunks = mutableListOf<ByteArray>()
+
         while (true) {
+
             val subChunkSize = this.readByteAsInt()
-            if (subChunkSize == 0) break // End of sub chunks
+
+            /* Break at the end of sub chunks */
+            if (subChunkSize == 0)
+                break
+
             val subChunkBytes = this.readBytes("$fieldName sub chunk", subChunkSize)
+
             subChunks.add(byteArrayOf(subChunkSize.toByte()) + subChunkBytes)
         }
+
         return subChunks
     }
 }