reactify.Var.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of reactify_3 Show documentation
reactify
The newest version!
package reactify

import java.util.concurrent.atomic.AtomicBoolean

import reactify.bind.{BindSet, Binding}
import reactify.group.VarGroup
import reactify.transaction.Transaction

import scala.language.implicitConversions

/**
  * Var represents the combination of `Val` and `Channel` into a stateful and mutable underlying value.
  *
  * @tparam T the type of value this Reactive receives
  */
class Var[T] protected() extends Val[T]() with Mutable[T] {
  def this(f: => T) = {
    this()

    set(f)
  }

  /**
    * Sets a new functional value to this var
    *
    * @param value the functional value to assign
    */
  override def set(value: => T): Unit = {
    Transaction.change(this, this.function, () => value)
    Val.set(this, value)
  }

  /**
    * Statically sets a value without monitoring effects
    *
    * @param value the value to assign
    */
  override def static(value: T): Unit = super.static(value)

  /**
    * Group multiple Vars together
    */
  def &(that: Var[T]): Var[T] = and(that)

  /**
    * Group multiple Vars together
    */
  def and(that: Var[T]): Var[T] = VarGroup[T](List(this, that))

  /**
    * Maps this Var to another type.
    *
    * Note: this mapping loses all meaning if the new Var gets set explicitly with a new value
    */
  override def map[R](f: T => R): Var[R] = Var(f(get))

  /**
    * Convenience method to create a binding between two `Var`s
    *
    * @param that the second `Var` to bind between
    * @param setNow the `BindSet` value (Defaults to LeftToRight)
    * @param t2v implicit function conversion from T to V
    * @param v2t implicit function conversion from V to T
    * @tparam V the type of the second `Var`
    * @return Binding[T, V]
    */
  def bind[V](that: Var[V], setNow: BindSet = BindSet.LeftToRight)
             (implicit t2v: T => V, v2t: V => T): Binding[T, V] = {
    setNow match {
      case BindSet.LeftToRight => that := t2v(this)
      case BindSet.RightToLeft => this := v2t(that)
      case BindSet.None => // Nothing
    }
    val changing = new AtomicBoolean(false)
    val leftToRight = this.attach { t =>
      if (changing.compareAndSet(false, true)) {
        try {
          that := t2v(get)
        } finally {
          changing.set(false)
        }
      }
    }
    val rightToLeft = that.attach { t =>
      if (changing.compareAndSet(false, true)) {
        try {
          set(v2t(that.get))
        } finally {
          changing.set(false)
        }
      }
    }
    new Binding(this, that, leftToRight, rightToLeft)
  }
}

object Var {
  def apply[T](f: => T): Var[T] = {
    val v = new Var[T]
    v.set(f)
    v
  }
}