refactor cborint

Author: JesusMcCloud

docs/formats.md

@@ -332,7 +332,7 @@ The main concept in this part of the library is [CborElement]. Read on to learn
 #### Encoding from/to `CborElement`
 
 Bytes can be decoded into an instance of `CborElement` with the [Cbor.decodeFromByteArray] function by either manually
-specifying [CborElement.serializer()] or specifying [CborElement] as generic type parameter.  
+specifying `CborElement.serializer()` or specifying [CborElement] as generic type parameter.  
 It is also possible to encode arbitrary serializable structures to a `CborElement` through [Cbor.encodeToCborElement].
 
 Since these operations use the same code paths as regular serialization (but with specialized serializers), the config flags
@@ -417,18 +417,16 @@ A [CborElement] class has three direct subtypes, closely following CBOR grammar:
   `CborPrimitive` is itself an umbrella type (a sealed class) for the following concrete primitives:
   * [CborNull] mapping to a Kotlin `null`
   * [CborBoolean] mapping to a Kotlin `Boolean`
-  * [CborInt] which is an umbrella type (a sealed class) itself for the following concrete types
-    (it is still possible to instantiate it as the `invoke` operator on its companion is overridden accordingly):
-    * [CborPositiveInt] represents all `Long` numbers `≥0`
-    * [CborNegativeInt] represents all `Long` numbers `<0`
+  * [CborInt] represents signed CBOR integer (major type 1 encompassing `-2^64..-1`) and unsigned CBOR integer (major type 0 encompassing `0..2^64-1`).  
+  Since this exceeds the range of Kotlin's built-in `Long` type, CborInt consists of `sign` (set to `CborInt.Sing.POSITIVE`, `CborInt.Sing.NEGATIVE`, or `CborInt.Sing.ZERO`) and `value` representing the absolute value as an `ULong`. It also features a `toLong()` function, albeit incurring possible truncation for negative values exceeding `Long.MIN_VALUE`.
   * [CborString] maps to a Kotlin `String`
   * [CborFloat] maps to Kotlin `Double`
   * [CborByteString] maps to a Kotlin `ByteArray` and is used to encode them as CBOR byte string (in contrast to a list
     of individual bytes)
 
-* [CborList] represents a CBOR array. It is a Kotlin [List] of `CborElement` items.
+* [CborList] represents a CBOR array. It is a Kotlin `List` of `CborElement` items.
 
-* [CborMap] represents a CBOR map/object. It is a Kotlin [Map] from `CborElement` keys to `CborElement` values.
+* [CborMap] represents a CBOR map/object. It is a Kotlin `Map` from `CborElement` keys to `CborElement` values.
   This is typically the result of serializing an arbitrary 
 
 
@@ -1797,8 +1795,6 @@ This chapter concludes [Kotlin Serialization Guide](serialization-guide.md).
 [CborNull]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-cbor/kotlinx.serialization.cbor/-cbor-null/index.html
 [CborBoolean]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-cbor/kotlinx.serialization.cbor/-cbor-boolean/index.html
 [CborInt]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-cbor/kotlinx.serialization.cbor/-cbor-int/index.html
-[CborPositiveInt]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-cbor/kotlinx.serialization.cbor/-cbor-positive-int/index.html
-[CborNegativeInt]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-cbor/kotlinx.serialization.cbor/-cbor-negative-int/index.html
 [CborString]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-cbor/kotlinx.serialization.cbor/-cbor-string/index.html
 [CborFloat]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-cbor/kotlinx.serialization.cbor/-cbor-float/index.html
 [CborByteString]: https://kotlinlang.org/api/kotlinx.serialization/kotlinx-serialization-cbor/kotlinx.serialization.cbor/-cbor-byte-string/index.html

formats/cbor/api/kotlinx-serialization-cbor.api

@@ -133,16 +133,29 @@ public final class kotlinx/serialization/cbor/CborFloat$Companion {
 	public final fun serializer ()Lkotlinx/serialization/KSerializer;
 }
 
-public abstract class kotlinx/serialization/cbor/CborInt : kotlinx/serialization/cbor/CborPrimitive {
+public final class kotlinx/serialization/cbor/CborInt : kotlinx/serialization/cbor/CborPrimitive {
 	public static final field Companion Lkotlinx/serialization/cbor/CborInt$Companion;
-	public synthetic fun <init> ([JLjava/lang/Object;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
-	public synthetic fun <init> ([JLjava/lang/Object;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public synthetic fun <init> (JLkotlinx/serialization/cbor/CborInt$Sign;[JLkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun equals (Ljava/lang/Object;)Z
+	public final fun getSign ()Lkotlinx/serialization/cbor/CborInt$Sign;
+	public fun hashCode ()I
+	public final fun toLong ()J
+	public fun toString ()Ljava/lang/String;
 }
 
 public final class kotlinx/serialization/cbor/CborInt$Companion {
 	public final fun invoke-SIFponk (J[J)Lkotlinx/serialization/cbor/CborInt;
 	public final fun invoke-ahITK_k (J[J)Lkotlinx/serialization/cbor/CborInt;
-	public final fun serializer (Lkotlinx/serialization/KSerializer;)Lkotlinx/serialization/KSerializer;
+	public final fun serializer ()Lkotlinx/serialization/KSerializer;
+}
+
+public final class kotlinx/serialization/cbor/CborInt$Sign : java/lang/Enum {
+	public static final field NEGATIVE Lkotlinx/serialization/cbor/CborInt$Sign;
+	public static final field POSITIVE Lkotlinx/serialization/cbor/CborInt$Sign;
+	public static final field ZERO Lkotlinx/serialization/cbor/CborInt$Sign;
+	public static fun getEntries ()Lkotlin/enums/EnumEntries;
+	public static fun valueOf (Ljava/lang/String;)Lkotlinx/serialization/cbor/CborInt$Sign;
+	public static fun values ()[Lkotlinx/serialization/cbor/CborInt$Sign;
 }
 
 public final class kotlinx/serialization/cbor/CborKt {
@@ -255,15 +268,6 @@ public final class kotlinx/serialization/cbor/CborMap$Companion {
 	public final fun serializer ()Lkotlinx/serialization/KSerializer;
 }
 
-public final class kotlinx/serialization/cbor/CborNegativeInt : kotlinx/serialization/cbor/CborInt {
-	public static final field Companion Lkotlinx/serialization/cbor/CborNegativeInt$Companion;
-	public synthetic fun <init> (J[JLkotlin/jvm/internal/DefaultConstructorMarker;)V
-}
-
-public final class kotlinx/serialization/cbor/CborNegativeInt$Companion {
-	public final fun serializer ()Lkotlinx/serialization/KSerializer;
-}
-
 public final class kotlinx/serialization/cbor/CborNull : kotlinx/serialization/cbor/CborPrimitive {
 	public static final field Companion Lkotlinx/serialization/cbor/CborNull$Companion;
 	public synthetic fun <init> ([JLkotlin/jvm/internal/DefaultConstructorMarker;)V
@@ -273,15 +277,6 @@ public final class kotlinx/serialization/cbor/CborNull$Companion {
 	public final fun serializer ()Lkotlinx/serialization/KSerializer;
 }
 
-public final class kotlinx/serialization/cbor/CborPositiveInt : kotlinx/serialization/cbor/CborInt {
-	public static final field Companion Lkotlinx/serialization/cbor/CborPositiveInt$Companion;
-	public synthetic fun <init> (J[JLkotlin/jvm/internal/DefaultConstructorMarker;)V
-}
-
-public final class kotlinx/serialization/cbor/CborPositiveInt$Companion {
-	public final fun serializer ()Lkotlinx/serialization/KSerializer;
-}
-
 public abstract class kotlinx/serialization/cbor/CborPrimitive : kotlinx/serialization/cbor/CborElement {
 	public static final field Companion Lkotlinx/serialization/cbor/CborPrimitive$Companion;
 	public synthetic fun <init> (Ljava/lang/Object;[JILkotlin/jvm/internal/DefaultConstructorMarker;)V

formats/cbor/api/kotlinx-serialization-cbor.klib.api

@@ -148,6 +148,36 @@ final class kotlinx.serialization.cbor/CborFloat : kotlinx.serialization.cbor/Cb
     }
 }
 
+final class kotlinx.serialization.cbor/CborInt : kotlinx.serialization.cbor/CborPrimitive<kotlin/ULong> { // kotlinx.serialization.cbor/CborInt|null[0]
+    constructor <init>(kotlin/ULong, kotlinx.serialization.cbor/CborInt.Sign, kotlin/ULongArray...) // kotlinx.serialization.cbor/CborInt.<init>|<init>(kotlin.ULong;kotlinx.serialization.cbor.CborInt.Sign;kotlin.ULongArray...){}[0]
+
+    final val sign // kotlinx.serialization.cbor/CborInt.sign|{}sign[0]
+        final fun <get-sign>(): kotlinx.serialization.cbor/CborInt.Sign // kotlinx.serialization.cbor/CborInt.sign.<get-sign>|<get-sign>(){}[0]
+
+    final fun equals(kotlin/Any?): kotlin/Boolean // kotlinx.serialization.cbor/CborInt.equals|equals(kotlin.Any?){}[0]
+    final fun hashCode(): kotlin/Int // kotlinx.serialization.cbor/CborInt.hashCode|hashCode(){}[0]
+    final fun toLong(): kotlin/Long // kotlinx.serialization.cbor/CborInt.toLong|toLong(){}[0]
+    final fun toString(): kotlin/String // kotlinx.serialization.cbor/CborInt.toString|toString(){}[0]
+
+    final enum class Sign : kotlin/Enum<kotlinx.serialization.cbor/CborInt.Sign> { // kotlinx.serialization.cbor/CborInt.Sign|null[0]
+        enum entry NEGATIVE // kotlinx.serialization.cbor/CborInt.Sign.NEGATIVE|null[0]
+        enum entry POSITIVE // kotlinx.serialization.cbor/CborInt.Sign.POSITIVE|null[0]
+        enum entry ZERO // kotlinx.serialization.cbor/CborInt.Sign.ZERO|null[0]
+
+        final val entries // kotlinx.serialization.cbor/CborInt.Sign.entries|#static{}entries[0]
+            final fun <get-entries>(): kotlin.enums/EnumEntries<kotlinx.serialization.cbor/CborInt.Sign> // kotlinx.serialization.cbor/CborInt.Sign.entries.<get-entries>|<get-entries>#static(){}[0]
+
+        final fun valueOf(kotlin/String): kotlinx.serialization.cbor/CborInt.Sign // kotlinx.serialization.cbor/CborInt.Sign.valueOf|valueOf#static(kotlin.String){}[0]
+        final fun values(): kotlin/Array<kotlinx.serialization.cbor/CborInt.Sign> // kotlinx.serialization.cbor/CborInt.Sign.values|values#static(){}[0]
+    }
+
+    final object Companion { // kotlinx.serialization.cbor/CborInt.Companion|null[0]
+        final fun invoke(kotlin/Long, kotlin/ULongArray...): kotlinx.serialization.cbor/CborInt // kotlinx.serialization.cbor/CborInt.Companion.invoke|invoke(kotlin.Long;kotlin.ULongArray...){}[0]
+        final fun invoke(kotlin/ULong, kotlin/ULongArray...): kotlinx.serialization.cbor/CborInt // kotlinx.serialization.cbor/CborInt.Companion.invoke|invoke(kotlin.ULong;kotlin.ULongArray...){}[0]
+        final fun serializer(): kotlinx.serialization/KSerializer<kotlinx.serialization.cbor/CborInt> // kotlinx.serialization.cbor/CborInt.Companion.serializer|serializer(){}[0]
+    }
+}
+
 final class kotlinx.serialization.cbor/CborList : kotlin.collections/List<kotlinx.serialization.cbor/CborElement>, kotlinx.serialization.cbor/CborElement { // kotlinx.serialization.cbor/CborList|null[0]
     constructor <init>(kotlin.collections/List<kotlinx.serialization.cbor/CborElement>, kotlin/ULongArray...) // kotlinx.serialization.cbor/CborList.<init>|<init>(kotlin.collections.List<kotlinx.serialization.cbor.CborElement>;kotlin.ULongArray...){}[0]
 
@@ -204,14 +234,6 @@ final class kotlinx.serialization.cbor/CborMap : kotlin.collections/Map<kotlinx.
     final fun asJsReadonlyMapView(): kotlin.js.collections/JsReadonlyMap<kotlinx.serialization.cbor/CborElement, kotlinx.serialization.cbor/CborElement> // kotlinx.serialization.cbor/CborMap.asJsReadonlyMapView|asJsReadonlyMapView(){}[0]
 }
 
-final class kotlinx.serialization.cbor/CborNegativeInt : kotlinx.serialization.cbor/CborInt<kotlin/Long> { // kotlinx.serialization.cbor/CborNegativeInt|null[0]
-    constructor <init>(kotlin/Long, kotlin/ULongArray...) // kotlinx.serialization.cbor/CborNegativeInt.<init>|<init>(kotlin.Long;kotlin.ULongArray...){}[0]
-
-    final object Companion { // kotlinx.serialization.cbor/CborNegativeInt.Companion|null[0]
-        final fun serializer(): kotlinx.serialization/KSerializer<kotlinx.serialization.cbor/CborNegativeInt> // kotlinx.serialization.cbor/CborNegativeInt.Companion.serializer|serializer(){}[0]
-    }
-}
-
 final class kotlinx.serialization.cbor/CborNull : kotlinx.serialization.cbor/CborPrimitive<kotlin/Unit> { // kotlinx.serialization.cbor/CborNull|null[0]
     constructor <init>(kotlin/ULongArray...) // kotlinx.serialization.cbor/CborNull.<init>|<init>(kotlin.ULongArray...){}[0]
 
@@ -220,14 +242,6 @@ final class kotlinx.serialization.cbor/CborNull : kotlinx.serialization.cbor/Cbo
     }
 }
 
-final class kotlinx.serialization.cbor/CborPositiveInt : kotlinx.serialization.cbor/CborInt<kotlin/ULong> { // kotlinx.serialization.cbor/CborPositiveInt|null[0]
-    constructor <init>(kotlin/ULong, kotlin/ULongArray...) // kotlinx.serialization.cbor/CborPositiveInt.<init>|<init>(kotlin.ULong;kotlin.ULongArray...){}[0]
-
-    final object Companion { // kotlinx.serialization.cbor/CborPositiveInt.Companion|null[0]
-        final fun serializer(): kotlinx.serialization/KSerializer<kotlinx.serialization.cbor/CborPositiveInt> // kotlinx.serialization.cbor/CborPositiveInt.Companion.serializer|serializer(){}[0]
-    }
-}
-
 final class kotlinx.serialization.cbor/CborString : kotlinx.serialization.cbor/CborPrimitive<kotlin/String> { // kotlinx.serialization.cbor/CborString|null[0]
     constructor <init>(kotlin/String, kotlin/ULongArray...) // kotlinx.serialization.cbor/CborString.<init>|<init>(kotlin.String;kotlin.ULongArray...){}[0]
 
@@ -236,15 +250,6 @@ final class kotlinx.serialization.cbor/CborString : kotlinx.serialization.cbor/C
     }
 }
 
-sealed class <#A: kotlin/Any> kotlinx.serialization.cbor/CborInt : kotlinx.serialization.cbor/CborPrimitive<#A> { // kotlinx.serialization.cbor/CborInt|null[0]
-    final object Companion : kotlinx.serialization.internal/SerializerFactory { // kotlinx.serialization.cbor/CborInt.Companion|null[0]
-        final fun <#A2: kotlin/Any?> serializer(kotlinx.serialization/KSerializer<#A2>): kotlinx.serialization/KSerializer<kotlinx.serialization.cbor/CborInt<#A2>> // kotlinx.serialization.cbor/CborInt.Companion.serializer|serializer(kotlinx.serialization.KSerializer<0:0>){0§<kotlin.Any?>}[0]
-        final fun invoke(kotlin/Long, kotlin/ULongArray...): kotlinx.serialization.cbor/CborInt<*> // kotlinx.serialization.cbor/CborInt.Companion.invoke|invoke(kotlin.Long;kotlin.ULongArray...){}[0]
-        final fun invoke(kotlin/ULong, kotlin/ULongArray...): kotlinx.serialization.cbor/CborInt<kotlin/ULong> // kotlinx.serialization.cbor/CborInt.Companion.invoke|invoke(kotlin.ULong;kotlin.ULongArray...){}[0]
-        final fun serializer(kotlin/Array<out kotlinx.serialization/KSerializer<*>>...): kotlinx.serialization/KSerializer<*> // kotlinx.serialization.cbor/CborInt.Companion.serializer|serializer(kotlin.Array<out|kotlinx.serialization.KSerializer<*>>...){}[0]
-    }
-}
-
 sealed class <#A: kotlin/Any> kotlinx.serialization.cbor/CborPrimitive : kotlinx.serialization.cbor/CborElement { // kotlinx.serialization.cbor/CborPrimitive|null[0]
     final val value // kotlinx.serialization.cbor/CborPrimitive.value|{}value[0]
         final fun <get-value>(): #A // kotlinx.serialization.cbor/CborPrimitive.value.<get-value>|<get-value>(){}[0]

formats/cbor/commonMain/src/kotlinx/serialization/cbor/CborElement.kt

@@ -90,61 +90,90 @@ public sealed class CborPrimitive<T : Any>(
 
 /**
  * Class representing either:
- * * signed CBOR integer (major type 1)
- * * unsigned CBOR integer (major type 0)
+ * * signed CBOR integer (major type 1 encompassing `-2^64..-1`)
+ * * unsigned CBOR integer (major type 0 encompassing `0..2^64-1`)
  *
- * depending on whether a positive or a negative number was passed.
+ * depending on the value of [sign]. Note that [absoluteValue] **must** be `0` when sign is set to [Sign.ZERO]
  */
 @Serializable(with = CborIntSerializer::class)
-public sealed class CborInt<T : Any>(
-    tags: ULongArray = ulongArrayOf(),
-    value: T,
-) : CborPrimitive<T>(value, tags) {
+public class CborInt(
+    absoluteValue: ULong,
+    public val sign: Sign,
+    vararg tags: ULong
+) : CborPrimitive<ULong>(absoluteValue, tags) {
+
+    init {
+        if (sign == Sign.ZERO) require(absoluteValue == 0uL) { "Illegal absolute value $absoluteValue for Sign.ZERO" }
+    }
+
+    public enum class Sign {
+        POSITIVE,
+        NEGATIVE,
+        ZERO
+    }
+
+    /**
+     * **WARNING! Possible truncation!** E.g., `-2^64` -> `-1`
+     */
+    public fun toLong(): Long = when (sign) {
+        Sign.POSITIVE, Sign.ZERO -> value.toLong()
+        Sign.NEGATIVE -> -value.toLong()
+    }
+
+
     public companion object {
         /**
          * Creates:
-         * * signed CBOR integer (major type 1)
-         * * unsigned CBOR integer (major type 0)
+         * * signed CBOR integer (major type 1 encompassing `-2^64..-1`)
+         * * unsigned CBOR integer (major type 0 encompassing `0..2^64-1`)
          *
          * depending on whether a positive or a negative number was passed.
+         * If you want to create a negative number exceeding [Long.MIN_VALUE], manually specify sign: `CborInt(ULong.MAX_VALUE, CborInt.Sign.NEGATIVE)`
          */
         public operator fun invoke(
             value: Long,
             vararg tags: ULong
-        ): CborInt<*> =
-            if (value >= 0) CborPositiveInt(value.toULong(), tags = tags) else CborNegativeInt(value, tags = tags)
+        ): CborInt =
+            if (value == 0L) CborInt(value.toULong(), Sign.ZERO, tags = tags)
+            else if (value > 0L) CborInt(value.toULong(), Sign.POSITIVE, tags = tags)
+            else CborInt(ULong.MAX_VALUE - value.toULong() + 1uL, Sign.NEGATIVE, tags = tags)
 
         /**
          * Creates an unsigned CBOR integer (major type 0).
          */
         public operator fun invoke(
             value: ULong,
             vararg tags: ULong
-        ): CborInt<ULong> = CborPositiveInt(value, tags = tags)
+        ): CborInt = if (value == 0uL) CborInt(value, Sign.ZERO, tags = tags)
+        else CborInt(value, Sign.POSITIVE, tags = tags)
     }
-}
 
-/**
- * Class representing signed CBOR integer (major type 1).
- */
-@Serializable(with = CborNegativeIntSerializer::class)
-public class CborNegativeInt(
-    value: Long,
-    vararg tags: ULong
-) : CborInt<Long>(tags, value) {
-    init {
-        require(value < 0) { "Number must be negative: $value" }
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (other !is CborInt) return false
+        if (!super.equals(other)) return false
+
+        if (sign != other.sign) return false
+
+        return true
     }
-}
 
-/**
- * Class representing unsigned CBOR integer (major type 0).
- */
-@Serializable(with = CborPositiveIntSerializer::class)
-public class CborPositiveInt(
-    value: ULong,
-    vararg tags: ULong
-) : CborInt<ULong>(tags, value)
+    override fun hashCode(): Int {
+        var result = super.hashCode()
+        result = 31 * result + sign.hashCode()
+        return result
+    }
+
+    override fun toString(): String {
+        return "CborInt(tags=${tags.joinToString(prefix = "[", postfix = "]")}, " +
+            "value=" + when (sign) {
+            Sign.POSITIVE, Sign.ZERO -> ""
+            Sign.NEGATIVE -> "-"
+        } +
+            value +
+            ")"
+    }
+}
 
 /**
  * Class representing CBOR floating point value (major type 7).