src/Pure/Concurrent/future.scala
author bulwahn
Thu, 07 Jul 2011 23:33:14 +0200
changeset 43704 47b0be18ccbe
parent 38848 9483bb678d96
child 45667 546d78f0d81f
permissions -rw-r--r--
floor and ceiling definitions are not code equations -- this enables trivial evaluation of floor and ceiling
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
38848
9483bb678d96 use Future.get_finished where this is the intended meaning -- prefer immediate crash over deadlock due to promises that are never fulfilled;
wenzelm
parents: 34262
diff changeset
    31
  def get_finished: A = { require(is_finished); Exn.release(peek.get) }
34217
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    32
  def join: A
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    33
  def map[B](f: A => B): Future[B] = Future.fork { f(join) }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    34
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    35
  override def toString =
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    36
    peek match {
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    37
      case None => "<future>"
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    38
      case Some(Exn.Exn(_)) => "<failed>"
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    39
      case Some(Exn.Res(x)) => x.toString
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    40
    }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    41
}
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    42
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    43
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
    44
{
34262
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
    45
  def fulfill_result(res: Exn.Result[A]): Unit
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
    46
  def fulfill(x: A) { fulfill_result(Exn.Res(x)) }
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    47
}
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    48
34217
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    49
private class Finished_Future[A](x: A) extends Future[A]
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    50
{
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    51
  val peek: Option[Exn.Result[A]] = Some(Exn.Res(x))
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    52
  val join: A = x
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    53
}
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    54
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    55
private class Pending_Future[A](body: => A) extends Future[A]
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    56
{
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    57
  @volatile private var result: Option[Exn.Result[A]] = None
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    58
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    59
  private val evaluator = actor {
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    60
    result = Some(Exn.capture(body))
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    61
    loop { react { case _ => reply(result.get) } }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    62
  }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    63
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    64
  def peek: Option[Exn.Result[A]] = result
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    65
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    66
  def join: A =
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    67
    Exn.release {
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    68
      peek match {
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    69
        case Some(res) => res
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    70
        case None => (evaluator !? ()).asInstanceOf[Exn.Result[A]]
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    71
      }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    72
    }
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    73
}
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    74
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    75
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
    76
{
34262
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
    77
  @volatile private var result: Option[Exn.Result[A]] = None
34217
67e1ac2d3b2c Future values -- Scala version.
wenzelm
parents:
diff changeset
    78
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    79
  private case object Read
34262
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
    80
  private case class Write(res: Exn.Result[A])
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    81
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    82
  private val receiver = actor {
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    83
    loop {
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    84
      react {
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    85
        case Read if result.isDefined => reply(result.get)
34262
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
    86
        case Write(res) =>
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    87
          if (result.isDefined) reply(false)
34262
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
    88
          else { result = Some(res); reply(true) }
34240
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
  }
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    92
34262
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
    93
  def peek: Option[Exn.Result[A]] = result
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    94
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
    95
  def join: A =
34262
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
    96
    Exn.release {
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
    97
      result match {
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
    98
        case Some(res) => res
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
    99
        case None => (receiver !? Read).asInstanceOf[Exn.Result[A]]
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
   100
      }
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   101
    }
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   102
34262
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
   103
  def fulfill_result(res: Exn.Result[A]) {
a6d2d9c07e46 added Promise.fulfill_result;
wenzelm
parents: 34240
diff changeset
   104
    receiver !? Write(res) match {
34240
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   105
      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
   106
      case _ =>
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   107
    }
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   108
  }
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   109
}
3274571e45c1 added Future.promise -- essentially a single-assignment variable with signalling, using the Future interface;
wenzelm
parents: 34217
diff changeset
   110