src/Pure/Concurrent/future.scala
author wenzelm
Mon, 04 Jan 2010 18:54:22 +0100
changeset 34240 3274571e45c1
parent 34217 67e1ac2d3b2c
child 34262 a6d2d9c07e46
permissions -rw-r--r--
added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
34217
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/Concurrent/future.scala
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
     3
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
     4
Future values.
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
     5
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
     6
Notable differences to scala.actors.Future (as of Scala 2.7.7):
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
     7
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
     8
  * We capture/release exceptions as in the ML variant.
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
     9
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    10
  * Future.join works for *any* actor, not just the one of the
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    11
    original fork.
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    12
*/
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    13
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    14
package isabelle
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    15
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    16
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    17
import scala.actors.Actor._
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    18
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    19
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    20
object Future
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    21
{
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    22
  def value[A](x: A): Future[A] = new Finished_Future(x)
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    23
  def fork[A](body: => A): Future[A] = new Pending_Future(body)
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    24
  def promise[A]: Promise[A] = new Promise_Future
34217
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    25
}
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    26
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    27
abstract class Future[A]
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    28
{
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    29
  def peek: Option[Exn.Result[A]]
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    30
  def is_finished: Boolean = peek.isDefined
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    31
  def join: A
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    32
  def map[B](f: A => B): Future[B] = Future.fork { f(join) }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    33
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    34
  override def toString =
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    35
    peek match {
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    36
      case None => "<future>"
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    37
      case Some(Exn.Exn(_)) => "<failed>"
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    38
      case Some(Exn.Res(x)) => x.toString
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    39
    }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    40
}
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    41
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    42
abstract class Promise[A] extends Future[A]
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    43
{
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    44
  def fulfill(x: A): Unit
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    45
}
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    46
34217
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    47
private class Finished_Future[A](x: A) extends Future[A]
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    48
{
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    49
  val peek: Option[Exn.Result[A]] = Some(Exn.Res(x))
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    50
  val join: A = x
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    51
}
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    52
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    53
private class Pending_Future[A](body: => A) extends Future[A]
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    54
{
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    55
  @volatile private var result: Option[Exn.Result[A]] = None
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    56
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    57
  private val evaluator = actor {
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    58
    result = Some(Exn.capture(body))
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    59
    loop { react { case _ => reply(result.get) } }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    60
  }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    61
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    62
  def peek: Option[Exn.Result[A]] = result
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    63
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    64
  def join: A =
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    65
    Exn.release {
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    66
      peek match {
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    67
        case Some(res) => res
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    68
        case None => (evaluator !? ()).asInstanceOf[Exn.Result[A]]
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    69
      }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    70
    }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    71
}
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    72
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    73
private class Promise_Future[A] extends Promise[A]
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    74
{
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    75
  @volatile private var result: Option[A] = None
34217
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    76
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    77
  private case object Read
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    78
  private case class Write(x: A)
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    79
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    80
  private val receiver = actor {
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    81
    loop {
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    82
      react {
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    83
        case Read if result.isDefined => reply(result.get)
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    84
        case Write(x) =>
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    85
          if (result.isDefined) reply(false)
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    86
          else { result = Some(x); reply(true) }
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    87
      }
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    88
    }
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    89
  }
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    90
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    91
  def peek: Option[Exn.Result[A]] = result.map(Exn.Res(_))
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    92
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    93
  def join: A =
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    94
    result match {
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    95
      case Some(res) => res
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    96
      case None => (receiver !? Read).asInstanceOf[A]
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    97
    }
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    98
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    99
  def fulfill(x: A) {
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   100
    receiver !? Write(x) match {
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   101
      case false => error("Duplicate fulfillment of promise")
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   102
      case _ =>
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   103
    }
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   104
  }
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   105
}
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   106