added scalajs compat

Author: Richard Whaling

scalajs-compat/Handles.scala

@@ -0,0 +1,36 @@
+/*
+ * Scala.js (https://www.scala-js.org/)
+ *
+ * Copyright EPFL.
+ *
+ * Licensed under Apache License 2.0
+ * (https://www.apache.org/licenses/LICENSE-2.0).
+ *
+ * See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ */
+
+package scala.scalajs.js.timers
+
+import scalanative.unsafe.Zone
+import scalanative.loop.LibUV.TimerHandle
+
+/** <span class="badge badge-non-std" style="float: right;">Non-Standard</span>
+ *  A handle returned from a call to
+ * [[setTimeout(interval:scala\.concurrent\.duration\.FiniteDuration)* setTimeout]].
+ *
+ *  May only be used to pass to [[clearTimeout]].
+ */
+trait SetTimeoutHandle {
+  private[timers] val timerHandle: TimerHandle
+}
+
+/** <span class="badge badge-non-std" style="float: right;">Non-Standard</span>
+ *  A handle returned from a call to
+ *  [[setInterval(interval:scala\.concurrent\.duration\.FiniteDuration)* setInterval]].
+ *
+ *  May only be used to pass to [[clearInterval]].
+ */
+trait SetIntervalHandle {
+  private[timers] val timerHandle: TimerHandle
+}

scalajs-compat/RawTimers.scala

@@ -0,0 +1,79 @@
+/*
+ * Scala.js (https://www.scala-js.org/)
+ *
+ * Copyright EPFL.
+ *
+ * Licensed under Apache License 2.0
+ * (https://www.apache.org/licenses/LICENSE-2.0).
+ *
+ * See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ */
+
+package scala.scalajs.js.timers
+
+import scalanative.unsafe.Zone
+import scalanative.libc.stdlib
+import scalanative.loop.Timer
+import scalanative.loop.LibUV.{TimerHandle, uv_timer_stop}
+import scalanative.loop.LibUVConstants.check
+
+/**
+ *  <span class="badge badge-non-std" style="float: right;">Non-Standard</span>
+ *  Raw JavaScript timer methods.
+ *
+ *  The methods on this object expose the raw JavaScript methods for timers. In
+ *  general it is more advisable to use the methods directly defined on
+ *  [[timers]] as they are more Scala-like.
+ */
+object RawTimers {
+
+  /** Schedule `handler` for execution in `interval` milliseconds.
+   *
+   *  @param handler the function to call after `interval` has passed
+   *  @param interval duration in milliseconds to wait
+   *  @return A handle that can be used to cancel the timeout by passing it
+   *          to [[clearTimeout]].
+   */
+  def setTimeout(handler: () => Unit, interval: Double): SetTimeoutHandle = {
+    val t = Timer.oneTime(interval, handler)
+    new SetTimeoutHandle {
+      val timerHandle = t
+    }
+  }
+
+  /** Cancel a timeout execution
+   *  @param handle The handle returned by [[setTimeout]]
+   */
+  def clearTimeout(handle: SetTimeoutHandle): Unit = {
+    if (handle.timerHandle != null) {
+      check(uv_timer_stop(handle.timerHandle),"uv_timer_stop")
+      stdlib.free(handle.timerHandle)
+    }
+  }
+
+  /** Schedule `handler` for repeated execution every `interval`
+   *  milliseconds.
+   *
+   *  @param handler the function to call after each `interval`
+   *  @param interval duration in milliseconds between executions
+   *  @return A handle that can be used to cancel the interval by passing it
+   *          to [[clearInterval]].
+   */
+  def setInterval(handler: () => Unit, interval: Double): SetIntervalHandle = {
+    val t = Timer.repeat(interval, handler)
+    new SetIntervalHandle {
+      val timerHandle = t
+    }
+  }
+
+  /** Cancel an interval execution
+   *  @param handle The handle returned by [[setInterval]]
+   */
+  def clearInterval(handle: SetIntervalHandle): Unit = {
+    if (handle.timerHandle != null) {
+      check(uv_timer_stop(handle.timerHandle),"uv_timer_stop")
+      stdlib.free(handle.timerHandle)
+    }
+  }
+}

scalajs-compat/package.scala

@@ -0,0 +1,87 @@
+/*
+ * Scala.js (https://www.scala-js.org/)
+ *
+ * Copyright EPFL.
+ *
+ * Licensed under Apache License 2.0
+ * (https://www.apache.org/licenses/LICENSE-2.0).
+ *
+ * See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership.
+ */
+
+package scala.scalajs.js
+
+import scala.concurrent.duration.FiniteDuration
+
+/**
+ *  <span class="badge badge-non-std" style="float: right;">Non-Standard</span>
+ *  Non-standard, but in general well supported methods to schedule asynchronous
+ *  execution.
+ *
+ *  The methods in this package work in all JavaScript virtual machines
+ *  supporting `setTimeout` and `setInterval`.
+ */
+package object timers {
+
+  /** Schedule something for execution in `interval` milliseconds.
+   *
+   *  @param interval duration in milliseconds to wait
+   *  @param body code to execute after `interval` has passed
+   *  @return A handle that can be used to cancel the timeout by passing it
+   *          to [[clearTimeout]].
+   *  @note Uses JavaScript's non-standard `setTimeout`
+   */
+  def setTimeout(interval: Double)(body: => Unit): SetTimeoutHandle =
+    RawTimers.setTimeout(() => body, interval)
+
+  /** Schedule something for execution after a duration.
+   *
+   *  @param interval duration to wait
+   *  @param body code to execute after `interval` has passed
+   *  @return A handle that can be used to cancel the timeout by passing it
+   *          to [[clearTimeout]].
+   *  @note Uses JavaScript's non-standard `setTimeout`
+   */
+  def setTimeout(interval: FiniteDuration)(body: => Unit): SetTimeoutHandle =
+    RawTimers.setTimeout(() => body, interval.toMillis.toDouble)
+
+  /** Cancel a timeout execution
+   *  @param handle The handle returned by
+   *         [[setTimeout(interval:scala\.concurrent\.duration\.FiniteDuration)* setTimeout]].
+   *  @note Uses JavaScript's non-standard `clearTimeout`
+   */
+  def clearTimeout(handle: SetTimeoutHandle): Unit =
+    RawTimers.clearTimeout(handle)
+
+  /** Schedule something for repeated execution every `interval` milliseconds.
+   *
+   *  @param interval duration in milliseconds between executions
+   *  @param body code to execute after each `interval`
+   *  @return A handle that can be used to cancel the interval by passing it
+   *          to [[clearInterval]].
+   *  @note Uses JavaScript's non-standard `setInterval`
+   */
+  def setInterval(interval: Double)(body: => Unit): SetIntervalHandle =
+    RawTimers.setInterval(() => body, interval)
+
+  /** Schedule something for repeated execution every duration.
+   *
+   *  @param interval duration between executions
+   *  @param body code to execute after each `interval`
+   *  @return A handle that can be used to cancel the interval by passing it
+   *          to [[clearInterval]].
+   *  @note Uses JavaScript's non-standard `setInterval`
+   */
+  def setInterval(interval: FiniteDuration)(body: => Unit): SetIntervalHandle =
+    RawTimers.setInterval(() => body, interval.toMillis.toDouble)
+
+  /** Cancel an interval execution
+   *  @param handle The handle returned by
+   *         [[setInterval(interval:scala\.concurrent\.duration\.FiniteDuration)* setInterval]].
+   *  @note Uses JavaScript's non-standard `clearInterval`
+   */
+  def clearInterval(handle: SetIntervalHandle): Unit =
+    RawTimers.clearInterval(handle)
+
+}