Fix issue #168: Change inline classes to value classes (#171)

arsvechkarev · web-flow · commit 0cf0081ef65a · 2021-05-25T09:49:16.000+02:00
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/Date.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/Date.kt
@@ -1,14 +1,16 @@
 package com.soywiz.klock
 
 import com.soywiz.klock.internal.Serializable
+import kotlin.jvm.JvmInline
 import kotlin.math.abs
 
 /**
  * Represents a triple of [year], [month] and [day].
  *
- * It is packed in an inline class wrapping an Int to prevent allocations.
+ * It is packed in a value class wrapping an Int to prevent allocations.
  */
-inline class Date(val encoded: Int) : Comparable<Date>, Serializable {
+@JvmInline
+value class Date(val encoded: Int) : Comparable<Date>, Serializable {
 	companion object {
         @Suppress("MayBeConstant", "unused")
         private const val serialVersionUID = 1L
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/DateTime.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/DateTime.kt
@@ -1,6 +1,7 @@
 package com.soywiz.klock
 
 import com.soywiz.klock.internal.*
+import kotlin.jvm.JvmInline
 import kotlin.math.*
 
 /**
@@ -11,7 +12,8 @@ import kotlin.math.*
  * - Thu Aug 10 -140744 07:15:45 GMT-0014 (Central European Summer Time)
  * - Wed May 23 144683 18:29:30 GMT+0200 (Central European Summer Time)
  */
-inline class DateTime(
+@JvmInline
+value class DateTime(
     /** Number of milliseconds since UNIX [EPOCH] */
     val unixMillis: Double
 ) : Comparable<DateTime>, Serializable {
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/Frequency.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/Frequency.kt
@@ -1,6 +1,7 @@
 package com.soywiz.klock
 
 import com.soywiz.klock.hr.hr
+import kotlin.jvm.JvmInline
 
 val TimeSpan.hz get() = timesPerSecond
 val Int.hz get() = timesPerSecond
@@ -12,7 +13,8 @@ val TimeSpan.timesPerSecond get() = Frequency(1.0 / this.seconds)
 val Int.timesPerSecond get() = Frequency(this.toDouble())
 val Double.timesPerSecond get() = Frequency(this)
 
-inline class Frequency(val hertz: Double) {
+@JvmInline
+value class Frequency(val hertz: Double) {
     companion object {
         fun from(timeSpan: TimeSpan) = timeSpan.toFrequency()
     }
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/MonthSpan.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/MonthSpan.kt
@@ -1,6 +1,7 @@
 package com.soywiz.klock
 
 import com.soywiz.klock.internal.Serializable
+import kotlin.jvm.JvmInline
 
 /**
  * Creates a [MonthSpan] representing these years.
@@ -15,7 +16,8 @@ inline val Int.months get() = MonthSpan(this)
 /**
  * Represents a number of years and months temporal distance.
  */
-inline class MonthSpan(
+@JvmInline
+value class MonthSpan(
     /** Total months of this [MonthSpan] as integer */
     val totalMonths: Int
 ) : Comparable<MonthSpan>, Serializable {
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/NumberOfTimes.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/NumberOfTimes.kt
@@ -1,9 +1,12 @@
 package com.soywiz.klock
 
+import kotlin.jvm.JvmInline
+
 val infiniteTimes get() = NumberOfTimes.INFINITE
 inline val Int.times get() = NumberOfTimes(this)
 
-inline class NumberOfTimes(val count: Int) {
+@JvmInline
+value class NumberOfTimes(val count: Int) {
     companion object {
         val ZERO = NumberOfTimes(0)
         val ONE = NumberOfTimes(1)
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/Time.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/Time.kt
@@ -1,12 +1,14 @@
 package com.soywiz.klock
 
 import com.soywiz.klock.internal.Serializable
+import kotlin.jvm.JvmInline
 import kotlin.math.abs
 
 /**
  * Represents a union of [millisecond], [second], [minute] and [hour].
  */
-inline class Time(val encoded: TimeSpan) : Comparable<Time>, Serializable {
+@JvmInline
+value class Time(val encoded: TimeSpan) : Comparable<Time>, Serializable {
 	companion object {
         @Suppress("MayBeConstant", "unused")
         private const val serialVersionUID = 1L
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/TimeSpan.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/TimeSpan.kt
@@ -1,6 +1,7 @@
 package com.soywiz.klock
 
 import com.soywiz.klock.internal.*
+import kotlin.jvm.JvmInline
 import kotlin.math.*
 
 /** [TimeSpan] representing this number as [nanoseconds] or 1 / 1_000_000_000 [seconds]. */
@@ -75,9 +76,10 @@ inline val Double.weeks get() = TimeSpan.fromWeeks(this)
 /**
  * Represents a span of time, with [milliseconds] precision.
  *
- * It is an inline class wrapping [Double] instead of [Long] to work on JavaScript without allocations.
+ * It is a value class wrapping [Double] instead of [Long] to work on JavaScript without allocations.
  */
-inline class TimeSpan(
+@JvmInline
+value class TimeSpan(
     /** Returns the total number of [milliseconds] for this [TimeSpan] (1 / 1_000 [seconds]) */
     val milliseconds: Double
 ) : Comparable<TimeSpan>, Serializable {
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/TimezoneOffset.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/TimezoneOffset.kt
@@ -1,6 +1,7 @@
 package com.soywiz.klock
 
 import com.soywiz.klock.internal.*
+import kotlin.jvm.JvmInline
 import kotlin.math.*
 
 /**
@@ -9,7 +10,8 @@ import kotlin.math.*
  *
  * This class is inlined so no boxing should be required.
  */
-inline class TimezoneOffset(
+@JvmInline
+value class TimezoneOffset(
     /** [TimezoneOffset] in [totalMilliseconds] */
     val totalMilliseconds: Double
 ) : Comparable<TimezoneOffset>, Serializable {
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/Year.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/Year.kt
@@ -1,6 +1,7 @@
 package com.soywiz.klock
 
 import com.soywiz.klock.internal.Serializable
+import kotlin.jvm.JvmInline
 import kotlin.math.*
 
 /**
@@ -11,7 +12,8 @@ import kotlin.math.*
  *
  * The integrated model is capable of determine if a year is leap for years 1 until 9999 inclusive.
  */
-inline class Year(val year: Int) : Comparable<Year>, Serializable {
+@JvmInline
+value class Year(val year: Int) : Comparable<Year>, Serializable {
     companion object {
         @Suppress("MayBeConstant", "unused")
         private const val serialVersionUID = 1L
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/YearMonth.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/YearMonth.kt
@@ -1,13 +1,15 @@
 package com.soywiz.klock
 
 import com.soywiz.klock.internal.Serializable
+import kotlin.jvm.JvmInline
 
 /**
  * Represents a couple of [year] and [month].
  *
- * It is packed in an inline class wrapping an Int to prevent allocations.
+ * It is packed in a value class wrapping an Int to prevent allocations.
  */
-inline class YearMonth(internal val internalPackedInfo: Int) : Serializable {
+@JvmInline
+value class YearMonth(internal val internalPackedInfo: Int) : Serializable {
     companion object {
         @Suppress("MayBeConstant", "unused")
         private const val serialVersionUID = 1L
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/hr/HRTimeSpan.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/hr/HRTimeSpan.kt
@@ -1,6 +1,7 @@
 package com.soywiz.klock.hr
 
 import com.soywiz.klock.*
+import kotlin.jvm.JvmInline
 import kotlin.math.round
 
 /** Converts a [TimeSpan] into a high-resolution [HRTimeSpan] */
@@ -11,7 +12,8 @@ val HRTimeSpan.timeSpan get() = nanosecondsRaw.nanoseconds
 
 // @TODO: Ensure nanosecondsRaw has no decimals
 /** A High-Resolution TimeSpan that stores its values as nanoseconds. Just uses 52-bits and won't store decimals */
-inline class HRTimeSpan constructor(val nanosecondsRaw: Double) : Comparable<HRTimeSpan> {
+@JvmInline
+value class HRTimeSpan constructor(val nanosecondsRaw: Double) : Comparable<HRTimeSpan> {
     companion object {
         val ZERO = HRTimeSpan(0.0)
         val NIL = HRTimeSpan(Double.NaN)
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/internal/GenericBinarySearch.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/internal/GenericBinarySearch.kt
@@ -1,5 +1,7 @@
 package com.soywiz.klock.internal
 
+import kotlin.jvm.JvmInline
+
 // Original implementation grabbed from Kds to prevent additional dependencies:
 // - https://github.com/korlibs/kds/blob/965f6017d7ad82e4bad714acf26cd7189186bdb3/kds/src/commonMain/kotlin/com/soywiz/kds/_Extensions.kt#L48
 internal inline fun genericBinarySearch(
@@ -24,7 +26,8 @@ internal inline fun genericBinarySearch(
 	return invalid(fromIndex, toIndex, low, high)
 }
 
-internal inline class BSearchResult(val raw: Int) {
+@JvmInline
+internal value class BSearchResult(val raw: Int) {
 	val found: Boolean get() = raw >= 0
 	val index: Int get() = if (found) raw else -1
 	val nearIndex: Int get() = if (found) raw else -raw - 1
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WDate.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WDate.kt
@@ -8,11 +8,11 @@ import com.soywiz.klock.internal.Serializable
 val Date.wrapped get() = WDate(this)
 
 /**
- * Wrapped Version, that is not inline. You can use [value] to get the wrapped inline class.
+ * Wrapped Version, that is not inline. You can use [value] to get the wrapped value class.
  *
  * Represents a triple of [year], [month] and [day].
  *
- * It is packed in an inline class wrapping an Int to prevent allocations.
+ * It is packed in a value class wrapping an Int to prevent allocations.
  */
 @KlockExperimental
 data class WDate(val value: Date) : Comparable<WDate>, Serializable {
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WDateTime.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WDateTime.kt
@@ -8,7 +8,7 @@ import com.soywiz.klock.internal.*
 val DateTime.wrapped get() = WDateTime(this)
 
 /**
- * Wrapped Version, that is not inline. You can use [value] to get the wrapped inline class.
+ * Wrapped Version, that is not inline. You can use [value] to get the wrapped value class.
  *
  * Represents a Date in UTC (GMT+00) with millisecond precision.
  *
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WMonthSpan.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WMonthSpan.kt
@@ -8,7 +8,7 @@ import com.soywiz.klock.internal.Serializable
 val MonthSpan.wrapped get() = WMonthSpan(this)
 
 /**
- * Wrapped Version, that is not inline. You can use [value] to get the wrapped inline class.
+ * Wrapped Version, that is not inline. You can use [value] to get the wrapped value class.
  *
  * Represents a number of years and months temporal distance.
  */
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WTime.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WTime.kt
@@ -8,7 +8,7 @@ import com.soywiz.klock.internal.Serializable
 val Time.wrapped get() = WTime(this)
 
 /**
- * Wrapped Version, that is not inline. You can use [value] to get the wrapped inline class.
+ * Wrapped Version, that is not inline. You can use [value] to get the wrapped value class.
  *
  * Represents a union of [millisecond], [second], [minute] and [hour].
  */
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WTimeSpan.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WTimeSpan.kt
@@ -8,11 +8,11 @@ import com.soywiz.klock.internal.*
 val TimeSpan.wrapped get() = WTimeSpan(this)
 
 /**
- * Wrapped Version, that is not inline. You can use [value] to get the wrapped inline class.
+ * Wrapped Version, that is not inline. You can use [value] to get the wrapped value class.
  *
  * Represents a span of time, with [milliseconds] precision.
  *
- * It is an inline class wrapping [Double] instead of [Long] to work on JavaScript without allocations.
+ * It is a value class wrapping [Double] instead of [Long] to work on JavaScript without allocations.
  */
 @KlockExperimental
 data class WTimeSpan(val value: TimeSpan) : Comparable<WTimeSpan>, Serializable {
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WTimezoneOffset.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WTimezoneOffset.kt
@@ -8,7 +8,7 @@ import com.soywiz.klock.internal.Serializable
 val TimezoneOffset.wrapped get() = WTimezoneOffset(this)
 
 /**
- * Wrapped Version, that is not inline. You can use [value] to get the wrapped inline class.
+ * Wrapped Version, that is not inline. You can use [value] to get the wrapped value class.
  *
  * Represents a time zone offset with millisecond precision. Usually minute is enough.
  * Can be used along [WDateTimeTz] to construct non universal, local times.
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WYear.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WYear.kt
@@ -8,7 +8,7 @@ import com.soywiz.klock.internal.Serializable
 val Year.wrapped get() = WYear(this)
 
 /**
- * Wrapped Version, that is not inline. You can use [value] to get the wrapped inline class.
+ * Wrapped Version, that is not inline. You can use [value] to get the wrapped value class.
  *
  * Represents a Year in a typed way.
  *
diff --git a/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WYearMonth.kt b/klock/src/commonMain/kotlin/com/soywiz/klock/wrapped/WYearMonth.kt
@@ -8,7 +8,7 @@ import com.soywiz.klock.internal.Serializable
 val YearMonth.wrapped get() = WYearMonth(this)
 
 /**
- * Wrapped Version, that is not inline. You can use [value] to get the wrapped inline class.
+ * Wrapped Version, that is not inline. You can use [value] to get the wrapped value class.
  *
  * Represents a couple of [year] and [month].
  */
