src/Pure/System/session.scala
author wenzelm
Sat May 22 20:59:55 2010 +0200 (2010-05-22 ago)
changeset 37065 2a73253b5898
parent 37063 492bc98a8809
child 37129 4c83696b340e
permissions -rw-r--r--
separate event bus and dockable for raw output (stdout);
wenzelm@36676
     1
/*  Title:      Pure/System/session.scala
wenzelm@36676
     2
    Author:     Makarius
wenzelm@36676
     3
wenzelm@36676
     4
Isabelle session, potentially with running prover.
wenzelm@36676
     5
*/
wenzelm@34777
     6
wenzelm@34871
     7
package isabelle
wenzelm@34777
     8
wenzelm@34777
     9
wenzelm@34820
    10
import scala.actors.TIMEOUT
wenzelm@34777
    11
import scala.actors.Actor._
wenzelm@34777
    12
wenzelm@34815
    13
wenzelm@34791
    14
object Session
wenzelm@34791
    15
{
wenzelm@34813
    16
  /* events */
wenzelm@34813
    17
wenzelm@34791
    18
  case object Global_Settings
wenzelm@34813
    19
wenzelm@34813
    20
wenzelm@34813
    21
  /* managed entities */
wenzelm@34813
    22
wenzelm@34813
    23
  type Entity_ID = String
wenzelm@34813
    24
wenzelm@34813
    25
  trait Entity
wenzelm@34813
    26
  {
wenzelm@34813
    27
    val id: Entity_ID
wenzelm@34813
    28
    def consume(session: Session, message: XML.Tree): Unit
wenzelm@34813
    29
  }
wenzelm@34791
    30
}
wenzelm@34791
    31
wenzelm@34777
    32
wenzelm@34851
    33
class Session(system: Isabelle_System)
wenzelm@34777
    34
{
wenzelm@34809
    35
  /* pervasive event buses */
wenzelm@34809
    36
wenzelm@34809
    37
  val global_settings = new Event_Bus[Session.Global_Settings.type]
wenzelm@34809
    38
  val raw_results = new Event_Bus[Isabelle_Process.Result]
wenzelm@37065
    39
  val raw_output = new Event_Bus[Isabelle_Process.Result]
wenzelm@34809
    40
  val results = new Event_Bus[Command]
wenzelm@34809
    41
wenzelm@34809
    42
  val command_change = new Event_Bus[Command]
wenzelm@34809
    43
wenzelm@34809
    44
wenzelm@34778
    45
  /* unique ids */
wenzelm@34778
    46
wenzelm@34778
    47
  private var id_count: BigInt = 0
wenzelm@34813
    48
  def create_id(): Session.Entity_ID = synchronized { id_count += 1; "j" + id_count }
wenzelm@34778
    49
wenzelm@34778
    50
wenzelm@34826
    51
wenzelm@34826
    52
  /** main actor **/
wenzelm@34809
    53
wenzelm@34851
    54
  @volatile private var syntax = new Outer_Syntax(system.symbols)
wenzelm@34819
    55
  def current_syntax: Outer_Syntax = syntax
wenzelm@34809
    56
wenzelm@34816
    57
  @volatile private var entities = Map[Session.Entity_ID, Session.Entity]()
wenzelm@34816
    58
  def lookup_entity(id: Session.Entity_ID): Option[Session.Entity] = entities.get(id)
wenzelm@34835
    59
  def lookup_command(id: Session.Entity_ID): Option[Command] =
wenzelm@34835
    60
    lookup_entity(id) match {
wenzelm@34835
    61
      case Some(cmd: Command) => Some(cmd)
wenzelm@34835
    62
      case _ => None
wenzelm@34835
    63
    }
wenzelm@34816
    64
wenzelm@34820
    65
  private case class Start(timeout: Int, args: List[String])
wenzelm@34777
    66
  private case object Stop
wenzelm@34808
    67
  private case class Begin_Document(path: String)
wenzelm@34777
    68
wenzelm@34809
    69
  private val session_actor = actor {
wenzelm@34809
    70
wenzelm@34809
    71
    var prover: Isabelle_Process with Isar_Document = null
wenzelm@34809
    72
wenzelm@34816
    73
    def register(entity: Session.Entity) { entities += (entity.id -> entity) }
wenzelm@34816
    74
wenzelm@34835
    75
    var documents = Map[Isar_Document.Document_ID, Document]()
wenzelm@34835
    76
    def register_document(doc: Document) { documents += (doc.id -> doc) }
wenzelm@34835
    77
wenzelm@34809
    78
wenzelm@34809
    79
    /* document changes */
wenzelm@34809
    80
wenzelm@34809
    81
    def handle_change(change: Change)
wenzelm@34809
    82
    {
wenzelm@34824
    83
      require(change.parent.isDefined)
wenzelm@34809
    84
wenzelm@34853
    85
      val (changes, doc) = change.result.join
wenzelm@34809
    86
      val id_changes = changes map {
wenzelm@34809
    87
        case (c1, c2) =>
wenzelm@34809
    88
          (c1.map(_.id).getOrElse(""),
wenzelm@34809
    89
           c2 match {
wenzelm@34809
    90
              case None => None
wenzelm@34835
    91
              case Some(command) =>
wenzelm@34835
    92
                if (!lookup_command(command.id).isDefined) {
wenzelm@34835
    93
                  register(command)
wenzelm@34859
    94
                  prover.define_command(command.id, system.symbols.encode(command.source))
wenzelm@34835
    95
                }
wenzelm@34809
    96
                Some(command.id)
wenzelm@34809
    97
            })
wenzelm@34809
    98
      }
wenzelm@34835
    99
      register_document(doc)
wenzelm@34833
   100
      prover.edit_document(change.parent.get.id, doc.id, id_changes)
wenzelm@34809
   101
    }
wenzelm@34809
   102
wenzelm@34809
   103
wenzelm@34809
   104
    /* prover results */
wenzelm@34809
   105
wenzelm@34836
   106
    def bad_result(result: Isabelle_Process.Result)
wenzelm@34836
   107
    {
wenzelm@37041
   108
      System.err.println("Ignoring prover result: " + result.message.toString)
wenzelm@34836
   109
    }
wenzelm@34836
   110
wenzelm@34809
   111
    def handle_result(result: Isabelle_Process.Result)
wenzelm@34809
   112
    {
wenzelm@34809
   113
      raw_results.event(result)
wenzelm@34799
   114
wenzelm@34835
   115
      val target_id: Option[Session.Entity_ID] = Position.get_id(result.props)
wenzelm@34813
   116
      val target: Option[Session.Entity] =
wenzelm@34835
   117
        target_id match {
wenzelm@34809
   118
          case None => None
wenzelm@34835
   119
          case Some(id) => lookup_entity(id)
wenzelm@34809
   120
        }
wenzelm@34813
   121
      if (target.isDefined) target.get.consume(this, result.message)
wenzelm@34809
   122
      else if (result.kind == Isabelle_Process.Kind.STATUS) {
wenzelm@34818
   123
        // global status message
wenzelm@34836
   124
        result.body match {
wenzelm@34835
   125
wenzelm@35013
   126
          // document state assignment
wenzelm@36682
   127
          case List(Isar_Document.Assign(edits)) if target_id.isDefined =>
wenzelm@34836
   128
            documents.get(target_id.get) match {
wenzelm@34836
   129
              case Some(doc) =>
wenzelm@34836
   130
                val states =
wenzelm@34836
   131
                  for {
wenzelm@36682
   132
                    Isar_Document.Edit(cmd_id, state_id) <- edits
wenzelm@34836
   133
                    cmd <- lookup_command(cmd_id)
wenzelm@34836
   134
                  } yield {
wenzelm@34836
   135
                    val st = cmd.assign_state(state_id)
wenzelm@34836
   136
                    register(st)
wenzelm@34836
   137
                    (cmd, st)
wenzelm@34836
   138
                  }
wenzelm@34836
   139
                doc.assign_states(states)
wenzelm@34836
   140
              case None => bad_result(result)
wenzelm@34836
   141
            }
wenzelm@34809
   142
wenzelm@36682
   143
          // keyword declarations
wenzelm@36947
   144
          case List(Keyword.Command_Decl(name, kind)) => syntax += (name, kind)
wenzelm@36947
   145
          case List(Keyword.Keyword_Decl(name)) => syntax += name
wenzelm@34836
   146
wenzelm@34839
   147
          case _ => if (!result.is_ready) bad_result(result)
wenzelm@34809
   148
        }
wenzelm@34809
   149
      }
wenzelm@34809
   150
      else if (result.kind == Isabelle_Process.Kind.EXIT)
wenzelm@34809
   151
        prover = null
wenzelm@37065
   152
      else if (result.is_raw)
wenzelm@37065
   153
        raw_output.event(result)
wenzelm@37063
   154
      else if (!result.is_system)   // FIXME syslog (!?)
wenzelm@34837
   155
        bad_result(result)
wenzelm@34809
   156
    }
wenzelm@34809
   157
wenzelm@34820
   158
wenzelm@34820
   159
    /* prover startup */
wenzelm@34820
   160
wenzelm@34820
   161
    def startup_error(): String =
wenzelm@34820
   162
    {
wenzelm@34820
   163
      val buf = new StringBuilder
wenzelm@34820
   164
      while (
wenzelm@34820
   165
        receiveWithin(0) {
wenzelm@34820
   166
          case result: Isabelle_Process.Result =>
wenzelm@34820
   167
            if (result.is_raw) {
wenzelm@34820
   168
              for (text <- XML.content(result.message))
wenzelm@34820
   169
                buf.append(text)
wenzelm@34820
   170
            }
wenzelm@34820
   171
            true
wenzelm@34820
   172
          case TIMEOUT => false
wenzelm@34820
   173
        }) {}
wenzelm@34820
   174
      buf.toString
wenzelm@34820
   175
    }
wenzelm@34820
   176
wenzelm@34820
   177
    def prover_startup(timeout: Int): Option[String] =
wenzelm@34820
   178
    {
wenzelm@34820
   179
      receiveWithin(timeout) {
wenzelm@34820
   180
        case result: Isabelle_Process.Result
wenzelm@34820
   181
          if result.kind == Isabelle_Process.Kind.INIT =>
wenzelm@34820
   182
          while (receive {
wenzelm@34820
   183
            case result: Isabelle_Process.Result =>
wenzelm@34820
   184
              handle_result(result); !result.is_ready
wenzelm@34820
   185
            }) {}
wenzelm@34820
   186
          None
wenzelm@34820
   187
wenzelm@34820
   188
        case result: Isabelle_Process.Result
wenzelm@34820
   189
          if result.kind == Isabelle_Process.Kind.EXIT =>
wenzelm@34820
   190
          Some(startup_error())
wenzelm@34820
   191
wenzelm@34820
   192
        case TIMEOUT =>  // FIXME clarify
wenzelm@34820
   193
          prover.kill; Some(startup_error())
wenzelm@34820
   194
      }
wenzelm@34820
   195
    }
wenzelm@34809
   196
wenzelm@34809
   197
wenzelm@34809
   198
    /* main loop */
wenzelm@34809
   199
wenzelm@34820
   200
    val xml_cache = new XML.Cache(131071)
wenzelm@34820
   201
wenzelm@34777
   202
    loop {
wenzelm@34777
   203
      react {
wenzelm@34820
   204
        case Start(timeout, args) =>
wenzelm@34777
   205
          if (prover == null) {
wenzelm@34851
   206
            prover = new Isabelle_Process(system, self, args:_*) with Isar_Document
wenzelm@34820
   207
            val origin = sender
wenzelm@34820
   208
            val opt_err = prover_startup(timeout)
wenzelm@34820
   209
            if (opt_err.isDefined) prover = null
wenzelm@34820
   210
            origin ! opt_err
wenzelm@34820
   211
          }
wenzelm@34820
   212
          else reply(None)
wenzelm@34820
   213
wenzelm@34820
   214
        case Stop =>  // FIXME clarify; synchronous
wenzelm@34820
   215
          if (prover != null) {
wenzelm@34820
   216
            prover.kill
wenzelm@34820
   217
            prover = null
wenzelm@34777
   218
          }
wenzelm@34777
   219
wenzelm@34820
   220
        case Begin_Document(path: String) if prover != null =>
wenzelm@34808
   221
          val id = create_id()
wenzelm@34823
   222
          val doc = Document.empty(id)
wenzelm@34835
   223
          register_document(doc)
wenzelm@34808
   224
          prover.begin_document(id, path)
wenzelm@34808
   225
          reply(doc)
wenzelm@34809
   226
wenzelm@34820
   227
        case change: Change if prover != null =>
wenzelm@34777
   228
          handle_change(change)
wenzelm@34777
   229
wenzelm@34777
   230
        case result: Isabelle_Process.Result =>
wenzelm@34795
   231
          handle_result(result.cache(xml_cache))
wenzelm@34777
   232
wenzelm@36782
   233
        case TIMEOUT =>  // FIXME clarify!
wenzelm@36782
   234
wenzelm@34820
   235
        case bad if prover != null =>
wenzelm@34777
   236
          System.err.println("session_actor: ignoring bad message " + bad)
wenzelm@34777
   237
      }
wenzelm@34777
   238
    }
wenzelm@34777
   239
  }
wenzelm@34777
   240
wenzelm@34809
   241
wenzelm@34809
   242
  /* main methods */
wenzelm@34809
   243
wenzelm@34820
   244
  def start(timeout: Int, args: List[String]): Option[String] =
wenzelm@34820
   245
    (session_actor !? Start(timeout, args)).asInstanceOf[Option[String]]
wenzelm@34820
   246
wenzelm@34777
   247
  def stop() { session_actor ! Stop }
wenzelm@34777
   248
  def input(change: Change) { session_actor ! change }
wenzelm@34777
   249
wenzelm@34823
   250
  def begin_document(path: String): Document =
wenzelm@34823
   251
    (session_actor !? Begin_Document(path)).asInstanceOf[Document]
wenzelm@34777
   252
}