Refactor native TimeZoneImpl

ilya-g · ilya-g · commit 44b8ee3caad8 · 2021-07-08T11:38:33.000+03:00
- Remove need in ZoneOffsetImpl wrapping UtcOffset
- Remove the interface TimeZoneImpl and merge it into RegionTimeZone class
diff --git a/core/darwin/src/TimeZoneNative.kt b/core/darwin/src/TimeZoneNative.kt
@@ -26,17 +26,17 @@ private fun systemDateByLocalDate(zone: NSTimeZone, localDate: NSDate): NSDate?
     return iso8601.dateFromComponents(dateComponents)
 }
 
-internal actual class PlatformTimeZoneImpl(private val value: NSTimeZone, override val id: String): TimeZoneImpl {
+internal actual class RegionTimeZone(private val value: NSTimeZone, actual override val id: String): TimeZone() {
     actual companion object {
-        actual fun of(zoneId: String): PlatformTimeZoneImpl {
+        actual fun of(zoneId: String): RegionTimeZone {
             val abbreviations = NSTimeZone.abbreviationDictionary
             val trueZoneId = abbreviations[zoneId] as String? ?: zoneId
             val zone = NSTimeZone.timeZoneWithName(trueZoneId)
                 ?: throw IllegalTimeZoneException("No timezone found with zone ID '$zoneId'")
-            return PlatformTimeZoneImpl(zone, zoneId)
+            return RegionTimeZone(zone, zoneId)
         }
 
-        actual fun currentSystemDefault(): PlatformTimeZoneImpl {
+        actual fun currentSystemDefault(): RegionTimeZone {
             /* The framework has its own cache of the system timezone. Calls to
             [NSTimeZone systemTimeZone] do not reflect changes to the system timezone
             and instead just return the cached value. Thus, to acquire the current
@@ -86,7 +86,7 @@ internal actual class PlatformTimeZoneImpl(private val value: NSTimeZone, overri
             */
             NSTimeZone.resetSystemTimeZone()
             val zone = NSTimeZone.systemTimeZone
-            return PlatformTimeZoneImpl(zone, zone.name)
+            return RegionTimeZone(zone, zone.name)
         }
 
         actual val availableZoneIds: Set<String>
@@ -110,7 +110,7 @@ internal actual class PlatformTimeZoneImpl(private val value: NSTimeZone, overri
             }
     }
 
-    override fun atStartOfDay(date: LocalDate): Instant {
+    actual override fun atStartOfDay(date: LocalDate): Instant {
         val ldt = LocalDateTime(date, LocalTime.MIN)
         val epochSeconds = ldt.toEpochSecond(UtcOffset.ZERO)
         // timezone
@@ -132,15 +132,15 @@ internal actual class PlatformTimeZoneImpl(private val value: NSTimeZone, overri
         return Instant(midnight.timeIntervalSince1970.toLong(), 0)
     }
 
-    override fun atZone(dateTime: LocalDateTime, preferred: UtcOffset?): ZonedDateTime {
+    actual override fun atZone(dateTime: LocalDateTime, preferred: UtcOffset?): ZonedDateTime {
         val epochSeconds = dateTime.toEpochSecond(UtcOffset.ZERO)
         var offset = preferred?.totalSeconds ?: Int.MAX_VALUE
         val transitionDuration = run {
             /* a date in an unspecified timezone, defined by the number of seconds since
                the start of the epoch in *that* unspecified timezone */
             val date = dateWithTimeIntervalSince1970Saturating(epochSeconds)
             val newDate = systemDateByLocalDate(value, date)
-                ?: throw RuntimeException("Unable to acquire the offset at $dateTime for zone ${this@PlatformTimeZoneImpl}")
+                ?: throw RuntimeException("Unable to acquire the offset at $dateTime for zone ${this@RegionTimeZone}")
             // we now know the offset of that timezone at this time.
             offset = value.secondsFromGMTForDate(newDate).toInt()
             /* `dateFromComponents` automatically corrects the date to avoid gaps. We
@@ -155,23 +155,14 @@ internal actual class PlatformTimeZoneImpl(private val value: NSTimeZone, overri
         } catch (e: ArithmeticException) {
             throw RuntimeException("Anomalously long timezone transition gap reported", e)
         }
-        return ZonedDateTime(correctedDateTime, TimeZone(this), UtcOffset.ofSeconds(offset))
+        return ZonedDateTime(correctedDateTime, this@RegionTimeZone, UtcOffset.ofSeconds(offset))
     }
 
-    override fun offsetAt(instant: Instant): UtcOffset {
+    actual override fun offsetAtImpl(instant: Instant): UtcOffset {
         val date = dateWithTimeIntervalSince1970Saturating(instant.epochSeconds)
         return UtcOffset.ofSeconds(value.secondsFromGMTForDate(date).toInt())
     }
 
-    // org.threeten.bp.ZoneId#equals
-    override fun equals(other: Any?): Boolean =
-        this === other || other is PlatformTimeZoneImpl && this.id == other.id
-
-    // org.threeten.bp.ZoneId#hashCode
-    override fun hashCode(): Int = id.hashCode()
-
-    // org.threeten.bp.ZoneId#toString
-    override fun toString(): String = id
 }
 
 internal actual fun currentTime(): Instant = NSDate.date().toKotlinInstant()
diff --git a/core/darwin/test/ConvertersTest.kt b/core/darwin/test/ConvertersTest.kt
@@ -48,7 +48,7 @@ class ConvertersTest {
         for (id in TimeZone.availableZoneIds) {
             val normalizedId = (NSTimeZone.abbreviationDictionary[id] ?: id) as String
             val timeZone = TimeZone.of(normalizedId)
-            if (timeZone.value is ZoneOffsetImpl) {
+            if (timeZone is FixedOffsetTimeZone) {
                 continue
             }
             val nsTimeZone = timeZone.toNSTimeZone()
diff --git a/core/native/cinterop_actuals/TimeZoneNative.kt b/core/native/cinterop_actuals/TimeZoneNative.kt
@@ -8,23 +8,23 @@ import kotlinx.datetime.internal.*
 import kotlinx.cinterop.*
 import platform.posix.free
 
-internal actual class PlatformTimeZoneImpl(private val tzid: TZID, override val id: String): TimeZoneImpl {
+internal actual class RegionTimeZone(private val tzid: TZID, actual override val id: String): TimeZone() {
     actual companion object {
-        actual fun of(zoneId: String): PlatformTimeZoneImpl {
+        actual fun of(zoneId: String): RegionTimeZone {
             val tzid = timezone_by_name(zoneId)
             if (tzid == TZID_INVALID) {
                 throw IllegalTimeZoneException("No timezone found with zone ID '$zoneId'")
             }
-            return PlatformTimeZoneImpl(tzid, zoneId)
+            return RegionTimeZone(tzid, zoneId)
         }
 
-        actual fun currentSystemDefault(): PlatformTimeZoneImpl = memScoped {
+        actual fun currentSystemDefault(): RegionTimeZone = memScoped {
             val tzid = alloc<TZIDVar>()
             val string = get_system_timezone(tzid.ptr)
                 ?: throw RuntimeException("Failed to get the system timezone.")
             val kotlinString = string.toKString()
             free(string)
-            PlatformTimeZoneImpl(tzid.value, kotlinString)
+            RegionTimeZone(tzid.value, kotlinString)
         }
 
         actual val availableZoneIds: Set<String>
@@ -45,7 +45,7 @@ internal actual class PlatformTimeZoneImpl(private val tzid: TZID, override val
             }
     }
 
-    override fun atStartOfDay(date: LocalDate): Instant = memScoped {
+    actual override fun atStartOfDay(date: LocalDate): Instant = memScoped {
         val ldt = LocalDateTime(date, LocalTime.MIN)
         val epochSeconds = ldt.toEpochSecond(UtcOffset.ZERO)
         val midnightInstantSeconds = at_start_of_day(tzid, epochSeconds)
@@ -55,13 +55,13 @@ internal actual class PlatformTimeZoneImpl(private val tzid: TZID, override val
         Instant(midnightInstantSeconds, 0)
     }
 
-    override fun atZone(dateTime: LocalDateTime, preferred: UtcOffset?): ZonedDateTime = memScoped {
+    actual override fun atZone(dateTime: LocalDateTime, preferred: UtcOffset?): ZonedDateTime = memScoped {
         val epochSeconds = dateTime.toEpochSecond(UtcOffset.ZERO)
         val offset = alloc<IntVar>()
         offset.value = preferred?.totalSeconds ?: Int.MAX_VALUE
         val transitionDuration = offset_at_datetime(tzid, epochSeconds, offset.ptr)
         if (offset.value == Int.MAX_VALUE) {
-            throw RuntimeException("Unable to acquire the offset at $dateTime for zone ${this@PlatformTimeZoneImpl}")
+            throw RuntimeException("Unable to acquire the offset at $dateTime for zone ${this@RegionTimeZone}")
         }
         val correctedDateTime = try {
             dateTime.plusSeconds(transitionDuration)
@@ -70,26 +70,17 @@ internal actual class PlatformTimeZoneImpl(private val tzid: TZID, override val
         } catch (e: ArithmeticException) {
             throw RuntimeException("Anomalously long timezone transition gap reported", e)
         }
-        ZonedDateTime(correctedDateTime, TimeZone(this@PlatformTimeZoneImpl), UtcOffset.ofSeconds(offset.value))
+        ZonedDateTime(correctedDateTime, this@RegionTimeZone, UtcOffset.ofSeconds(offset.value))
     }
 
-    override fun offsetAt(instant: Instant): UtcOffset {
+    actual override fun offsetAtImpl(instant: Instant): UtcOffset {
         val offset = offset_at_instant(tzid, instant.epochSeconds)
         if (offset == Int.MAX_VALUE) {
             throw RuntimeException("Unable to acquire the offset at instant $instant for zone $this")
         }
         return UtcOffset.ofSeconds(offset)
     }
 
-    // org.threeten.bp.ZoneId#equals
-    override fun equals(other: Any?): Boolean =
-        this === other || other is PlatformTimeZoneImpl && this.id == other.id
-
-    // org.threeten.bp.ZoneId#hashCode
-    override fun hashCode(): Int = id.hashCode()
-
-    // org.threeten.bp.ZoneId#toString
-    override fun toString(): String = id
 }
 
 internal actual fun currentTime(): Instant = memScoped {
diff --git a/core/native/src/TimeZone.kt b/core/native/src/TimeZone.kt
@@ -12,11 +12,13 @@ import kotlinx.datetime.serializers.*
 import kotlinx.serialization.Serializable
 
 @Serializable(with = TimeZoneSerializer::class)
-public actual open class TimeZone internal constructor(internal val value: TimeZoneImpl) {
+public actual open class TimeZone internal constructor() {
 
     public actual companion object {
 
-        public actual fun currentSystemDefault(): TimeZone = PlatformTimeZoneImpl.currentSystemDefault().let(::TimeZone)
+        public actual fun currentSystemDefault(): TimeZone =
+            // TODO: probably check if currentSystemDefault name is parseable as FixedOffsetTimeZone?
+            RegionTimeZone.currentSystemDefault()
 
         public actual val UTC: FixedOffsetTimeZone = UtcOffset.ZERO.asTimeZone()
 
@@ -56,23 +58,24 @@ public actual open class TimeZone internal constructor(internal val value: TimeZ
             } catch (e: DateTimeFormatException) {
                 throw IllegalTimeZoneException(e)
             }
-            return TimeZone(PlatformTimeZoneImpl.of(zoneId))
+            return RegionTimeZone.of(zoneId)
         }
 
         public actual val availableZoneIds: Set<String>
-            get() = PlatformTimeZoneImpl.availableZoneIds
+            get() = RegionTimeZone.availableZoneIds
     }
 
-    public actual val id: String
-        get() = value.id
+    public actual open val id: String
+        get() = error("Should be overridden")
 
     public actual fun Instant.toLocalDateTime(): LocalDateTime = instantToLocalDateTime(this)
     public actual fun LocalDateTime.toInstant(): Instant = localDateTimeToInstant(this)
 
-    internal open fun atStartOfDay(date: LocalDate): Instant = value.atStartOfDay(date)
+    internal open fun atStartOfDay(date: LocalDate): Instant = error("Should be overridden") //value.atStartOfDay(date)
+    internal open fun offsetAtImpl(instant: Instant): UtcOffset = error("Should be overridden")
 
     internal open fun instantToLocalDateTime(instant: Instant): LocalDateTime = try {
-        instant.toLocalDateTimeImpl(offsetAt(instant))
+        instant.toLocalDateTimeImpl(offsetAtImpl(instant))
     } catch (e: IllegalArgumentException) {
         throw DateTimeArithmeticException("Instant $instant is not representable as LocalDateTime.", e)
     }
@@ -81,32 +84,53 @@ public actual open class TimeZone internal constructor(internal val value: TimeZ
         atZone(dateTime).toInstant()
 
     internal open fun atZone(dateTime: LocalDateTime, preferred: UtcOffset? = null): ZonedDateTime =
-        value.atZone(dateTime, preferred)
+        error("Should be overridden")
 
     override fun equals(other: Any?): Boolean =
-        this === other || other is TimeZone && this.value == other.value
+        this === other || other is TimeZone && this.id == other.id
 
-    override fun hashCode(): Int = value.hashCode()
+    override fun hashCode(): Int = id.hashCode()
 
-    override fun toString(): String = value.toString()
+    override fun toString(): String = id
+}
+
+internal expect class RegionTimeZone : TimeZone {
+    override val id: String
+    override fun atStartOfDay(date: LocalDate): Instant
+    override fun offsetAtImpl(instant: Instant): UtcOffset
+    override fun atZone(dateTime: LocalDateTime, preferred: UtcOffset?): ZonedDateTime
+
+    companion object {
+        fun of(zoneId: String): RegionTimeZone
+        fun currentSystemDefault(): RegionTimeZone
+        val availableZoneIds: Set<String>
+    }
 }
 
 
 @Serializable(with = FixedOffsetTimeZoneSerializer::class)
-public actual class FixedOffsetTimeZone internal constructor(public actual val offset: UtcOffset, id: String) : TimeZone(ZoneOffsetImpl(offset, id)) {
+public actual class FixedOffsetTimeZone internal constructor(public actual val offset: UtcOffset, override val id: String) : TimeZone() {
 
     public actual constructor(offset: UtcOffset) : this(offset, offset.toString())
 
     @Deprecated("Use offset.totalSeconds", ReplaceWith("offset.totalSeconds"))
     public actual val totalSeconds: Int get() = offset.totalSeconds
 
+    override fun atStartOfDay(date: LocalDate): Instant =
+        LocalDateTime(date, LocalTime.MIN).toInstant(offset)
+
+    override fun offsetAtImpl(instant: Instant): UtcOffset = offset
+
+    override fun atZone(dateTime: LocalDateTime, preferred: UtcOffset?): ZonedDateTime =
+        ZonedDateTime(dateTime, this, offset)
+
     override fun instantToLocalDateTime(instant: Instant): LocalDateTime = instant.toLocalDateTime(offset)
     override fun localDateTimeToInstant(dateTime: LocalDateTime): Instant = dateTime.toInstant(offset)
 }
 
 
 public actual fun TimeZone.offsetAt(instant: Instant): UtcOffset =
-    value.offsetAt(instant)
+    offsetAtImpl(instant)
 
 public actual fun Instant.toLocalDateTime(timeZone: TimeZone): LocalDateTime =
     timeZone.instantToLocalDateTime(this)
diff --git a/core/native/src/TimeZoneImpl.kt b/core/native/src/TimeZoneImpl.kt

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ class ConvertersTest {`
`48`	`48`	`for (id in TimeZone.availableZoneIds) {`
`49`	`49`	`val normalizedId = (NSTimeZone.abbreviationDictionary[id] ?: id) as String`
`50`	`50`	`val timeZone = TimeZone.of(normalizedId)`
`51`		`- if (timeZone.value is ZoneOffsetImpl) {`
	`51`	`+ if (timeZone is FixedOffsetTimeZone) {`
`52`	`52`	`continue`
`53`	`53`	`}`
`54`	`54`	`val nsTimeZone = timeZone.toNSTimeZone()`