src/Pure/System/session.scala
author wenzelm
Fri Aug 19 14:01:20 2011 +0200 (2011-08-19 ago)
changeset 44298 b8f8488704e2
parent 44225 a8f921e6484f
child 44383 f99906c2a1d3
permissions -rw-r--r--
Future.promise: explicit abort operation (like uninterruptible future job);
explicit cancel_scala message -- still unused;
wenzelm@36676
     1
/*  Title:      Pure/System/session.scala
wenzelm@36676
     2
    Author:     Makarius
wenzelm@38221
     3
    Options:    :folding=explicit:collapseFolds=1:
wenzelm@36676
     4
wenzelm@43651
     5
Main Isabelle/Scala session, potentially with running prover process.
wenzelm@36676
     6
*/
wenzelm@34777
     7
wenzelm@34871
     8
package isabelle
wenzelm@34777
     9
wenzelm@43520
    10
import java.lang.System
wenzelm@34777
    11
wenzelm@34820
    12
import scala.actors.TIMEOUT
wenzelm@38226
    13
import scala.actors.Actor
wenzelm@34777
    14
import scala.actors.Actor._
wenzelm@34777
    15
wenzelm@34815
    16
wenzelm@34791
    17
object Session
wenzelm@34791
    18
{
wenzelm@43716
    19
  /* file store */
wenzelm@43645
    20
wenzelm@43645
    21
  abstract class File_Store
wenzelm@43645
    22
  {
wenzelm@44163
    23
    def append(master_dir: String, path: Path): String
wenzelm@44163
    24
    def require(file: String): Unit
wenzelm@43645
    25
  }
wenzelm@43645
    26
wenzelm@43645
    27
wenzelm@34813
    28
  /* events */
wenzelm@34813
    29
wenzelm@43716
    30
  //{{{
wenzelm@34791
    31
  case object Global_Settings
wenzelm@37849
    32
  case object Perspective
wenzelm@38849
    33
  case object Assignment
wenzelm@38360
    34
  case class Commands_Changed(set: Set[Command])
wenzelm@39630
    35
wenzelm@39630
    36
  sealed abstract class Phase
wenzelm@39630
    37
  case object Inactive extends Phase
wenzelm@39701
    38
  case object Startup extends Phase  // transient
wenzelm@39701
    39
  case object Failed extends Phase
wenzelm@39630
    40
  case object Ready extends Phase
wenzelm@39701
    41
  case object Shutdown extends Phase  // transient
wenzelm@43716
    42
  //}}}
wenzelm@34791
    43
}
wenzelm@34791
    44
wenzelm@34777
    45
wenzelm@43661
    46
class Session(val file_store: Session.File_Store)
wenzelm@34777
    47
{
wenzelm@37849
    48
  /* real time parameters */  // FIXME properties or settings (!?)
wenzelm@37849
    49
wenzelm@43716
    50
  val input_delay = Time.seconds(0.3)  // user input (e.g. text edits, cursor movement)
wenzelm@43716
    51
  val output_delay = Time.seconds(0.1)  // prover output (markup, common messages)
wenzelm@43716
    52
  val update_delay = Time.seconds(0.5)  // GUI layout updates
wenzelm@37849
    53
wenzelm@37849
    54
wenzelm@34809
    55
  /* pervasive event buses */
wenzelm@34809
    56
wenzelm@34809
    57
  val global_settings = new Event_Bus[Session.Global_Settings.type]
wenzelm@37849
    58
  val perspective = new Event_Bus[Session.Perspective.type]
wenzelm@38849
    59
  val assignments = new Event_Bus[Session.Assignment.type]
wenzelm@43716
    60
  val commands_changed = new Event_Bus[Session.Commands_Changed]
wenzelm@43716
    61
  val phase_changed = new Event_Bus[Session.Phase]
wenzelm@43721
    62
  val raw_messages = new Event_Bus[Isabelle_Process.Message]
wenzelm@43716
    63
wenzelm@34809
    64
wenzelm@34809
    65
wenzelm@38841
    66
  /** buffered command changes (delay_first discipline) **/
wenzelm@38841
    67
wenzelm@43716
    68
  //{{{
wenzelm@38841
    69
  private case object Stop
wenzelm@38841
    70
wenzelm@39572
    71
  private val (_, command_change_buffer) =
wenzelm@39572
    72
    Simple_Thread.actor("command_change_buffer", daemon = true)
wenzelm@38841
    73
  {
wenzelm@38841
    74
    var changed: Set[Command] = Set()
wenzelm@38841
    75
    var flush_time: Option[Long] = None
wenzelm@38841
    76
wenzelm@38841
    77
    def flush_timeout: Long =
wenzelm@38841
    78
      flush_time match {
wenzelm@38841
    79
        case None => 5000L
wenzelm@40848
    80
        case Some(time) => (time - System.currentTimeMillis()) max 0
wenzelm@38841
    81
      }
wenzelm@38841
    82
wenzelm@38841
    83
    def flush()
wenzelm@38841
    84
    {
wenzelm@38841
    85
      if (!changed.isEmpty) commands_changed.event(Session.Commands_Changed(changed))
wenzelm@38841
    86
      changed = Set()
wenzelm@38841
    87
      flush_time = None
wenzelm@38841
    88
    }
wenzelm@38841
    89
wenzelm@38841
    90
    def invoke()
wenzelm@38841
    91
    {
wenzelm@40848
    92
      val now = System.currentTimeMillis()
wenzelm@38841
    93
      flush_time match {
wenzelm@40848
    94
        case None => flush_time = Some(now + output_delay.ms)
wenzelm@38841
    95
        case Some(time) => if (now >= time) flush()
wenzelm@38841
    96
      }
wenzelm@38841
    97
    }
wenzelm@38841
    98
wenzelm@38841
    99
    var finished = false
wenzelm@38841
   100
    while (!finished) {
wenzelm@38841
   101
      receiveWithin(flush_timeout) {
wenzelm@38841
   102
        case command: Command => changed += command; invoke()
wenzelm@38841
   103
        case TIMEOUT => flush()
wenzelm@39630
   104
        case Stop => finished = true; reply(())
wenzelm@38841
   105
        case bad => System.err.println("command_change_buffer: ignoring bad message " + bad)
wenzelm@38841
   106
      }
wenzelm@38841
   107
    }
wenzelm@38841
   108
  }
wenzelm@38841
   109
  //}}}
wenzelm@38841
   110
wenzelm@38841
   111
wenzelm@38841
   112
wenzelm@38841
   113
  /** main protocol actor **/
wenzelm@34809
   114
wenzelm@43651
   115
  /* global state */
wenzelm@43644
   116
wenzelm@43716
   117
  @volatile var verbose: Boolean = false
wenzelm@43716
   118
wenzelm@43716
   119
  @volatile private var loaded_theories: Set[String] = Set()
wenzelm@43673
   120
wenzelm@43695
   121
  @volatile private var syntax = new Outer_Syntax
wenzelm@38569
   122
  def current_syntax(): Outer_Syntax = syntax
wenzelm@34809
   123
wenzelm@39626
   124
  @volatile private var reverse_syslog = List[XML.Elem]()
wenzelm@39629
   125
  def syslog(): String = reverse_syslog.reverse.map(msg => XML.content(msg).mkString).mkString("\n")
wenzelm@39626
   126
wenzelm@39630
   127
  @volatile private var _phase: Session.Phase = Session.Inactive
wenzelm@39633
   128
  private def phase_=(new_phase: Session.Phase)
wenzelm@39630
   129
  {
wenzelm@39630
   130
    _phase = new_phase
wenzelm@39701
   131
    phase_changed.event(new_phase)
wenzelm@39630
   132
  }
wenzelm@43716
   133
  def phase = _phase
wenzelm@43553
   134
  def is_ready: Boolean = phase == Session.Ready
wenzelm@39630
   135
wenzelm@38841
   136
  private val global_state = new Volatile(Document.State.init)
wenzelm@43719
   137
  def current_state(): Document.State = global_state()
wenzelm@34816
   138
wenzelm@43716
   139
  def snapshot(name: String, pending_edits: List[Text.Edit]): Document.Snapshot =
wenzelm@43719
   140
    global_state().snapshot(name, pending_edits)
wenzelm@43716
   141
wenzelm@43651
   142
wenzelm@43651
   143
  /* theory files */
wenzelm@43651
   144
wenzelm@43651
   145
  val thy_load = new Thy_Load
wenzelm@43651
   146
  {
wenzelm@43673
   147
    override def is_loaded(name: String): Boolean =
wenzelm@43673
   148
      loaded_theories.contains(name)
wenzelm@43673
   149
wenzelm@44159
   150
    override def check_thy(dir: Path, name: String): (String, Thy_Header) =
wenzelm@43651
   151
    {
wenzelm@43661
   152
      val file = Isabelle_System.platform_file(dir + Thy_Header.thy_path(name))
wenzelm@43652
   153
      if (!file.exists || !file.isFile) error("No such file: " + quote(file.toString))
wenzelm@43651
   154
      val text = Standard_System.read_file(file)
wenzelm@43661
   155
      val header = Thy_Header.read(text)
wenzelm@43651
   156
      (text, header)
wenzelm@43651
   157
    }
wenzelm@43651
   158
  }
wenzelm@43651
   159
wenzelm@43651
   160
  val thy_info = new Thy_Info(thy_load)
wenzelm@43651
   161
wenzelm@43651
   162
wenzelm@43651
   163
  /* actor messages */
wenzelm@43651
   164
wenzelm@43716
   165
  private case class Start(timeout: Time, args: List[String])
wenzelm@43716
   166
  private case object Interrupt
wenzelm@44182
   167
  private case class Init_Node(
wenzelm@44182
   168
    name: String, master_dir: String, header: Document.Node_Header, text: String)
wenzelm@44182
   169
  private case class Edit_Node(
wenzelm@44182
   170
    name: String, master_dir: String, header: Document.Node_Header, edits: List[Text.Edit])
wenzelm@43722
   171
  private case class Change_Node(
wenzelm@43722
   172
    name: String,
wenzelm@43722
   173
    doc_edits: List[Document.Edit_Command],
wenzelm@43722
   174
    previous: Document.Version,
wenzelm@43722
   175
    version: Document.Version)
wenzelm@41534
   176
wenzelm@39572
   177
  private val (_, session_actor) = Simple_Thread.actor("session_actor", daemon = true)
wenzelm@38639
   178
  {
wenzelm@43648
   179
    val this_actor = self
wenzelm@43649
   180
    var prover: Option[Isabelle_Process with Isar_Document] = None
wenzelm@34809
   181
wenzelm@34809
   182
wenzelm@43716
   183
    /* incoming edits */
wenzelm@43716
   184
wenzelm@44182
   185
    def handle_edits(name: String, master_dir: String,
wenzelm@44182
   186
        header: Document.Node_Header, edits: List[Document.Node.Edit[Text.Edit]])
wenzelm@43716
   187
    //{{{
wenzelm@43716
   188
    {
wenzelm@43716
   189
      val syntax = current_syntax()
wenzelm@43719
   190
      val previous = global_state().history.tip.version
wenzelm@44185
   191
wenzelm@44222
   192
      def norm_import(s: String): String =
wenzelm@44222
   193
      {
wenzelm@44225
   194
        val name = Thy_Header.base_name(s)
wenzelm@44222
   195
        if (thy_load.is_loaded(name)) name
wenzelm@44222
   196
        else file_store.append(master_dir, Thy_Header.thy_path(Path.explode(s)))
wenzelm@44222
   197
      }
wenzelm@44222
   198
      def norm_use(s: String): String = file_store.append(master_dir, Path.explode(s))
wenzelm@44222
   199
      val norm_header = Document.Node.norm_header[Text.Edit](norm_import, norm_use, header)
wenzelm@44222
   200
wenzelm@44185
   201
      val text_edits = (name, norm_header) :: edits.map(edit => (name, edit))
wenzelm@44185
   202
      val result = Future.fork { Thy_Syntax.text_edits(syntax, previous.join, text_edits) }
wenzelm@43722
   203
      val change =
wenzelm@44185
   204
        global_state.change_yield(_.extend_history(previous, text_edits, result.map(_._2)))
wenzelm@43716
   205
wenzelm@43722
   206
      result.map {
wenzelm@44157
   207
        case (doc_edits, _) =>
wenzelm@43722
   208
          assignments.await { global_state().is_assigned(previous.get_finished) }
wenzelm@44157
   209
          this_actor ! Change_Node(name, doc_edits, previous.join, change.version.join)
wenzelm@43722
   210
      }
wenzelm@43716
   211
    }
wenzelm@43716
   212
    //}}}
wenzelm@43716
   213
wenzelm@43716
   214
wenzelm@43716
   215
    /* resulting changes */
wenzelm@34809
   216
wenzelm@43722
   217
    def handle_change(change: Change_Node)
wenzelm@38221
   218
    //{{{
wenzelm@34809
   219
    {
wenzelm@43722
   220
      val previous = change.previous
wenzelm@43722
   221
      val version = change.version
wenzelm@43722
   222
      val name = change.name
wenzelm@43722
   223
      val doc_edits = change.doc_edits
wenzelm@38366
   224
wenzelm@43719
   225
      var former_assignment = global_state().the_assignment(previous).get_finished
wenzelm@38370
   226
      for {
wenzelm@44156
   227
        (name, Document.Node.Edits(cmd_edits)) <- doc_edits  // FIXME proper coverage!?
wenzelm@38370
   228
        (prev, None) <- cmd_edits
wenzelm@38417
   229
        removed <- previous.nodes(name).commands.get_after(prev)
wenzelm@38370
   230
      } former_assignment -= removed
wenzelm@38370
   231
wenzelm@43720
   232
      def id_command(command: Command): Document.Command_ID =
wenzelm@43720
   233
      {
wenzelm@43720
   234
        if (global_state().lookup_command(command.id).isEmpty) {
wenzelm@43720
   235
          global_state.change(_.define_command(command))
wenzelm@43720
   236
          prover.get.define_command(command.id, Symbol.encode(command.source))
wenzelm@43720
   237
        }
wenzelm@43720
   238
        command.id
wenzelm@43720
   239
      }
wenzelm@38150
   240
      val id_edits =
wenzelm@43722
   241
        doc_edits map {
wenzelm@44156
   242
          case (name, edit) =>
wenzelm@44156
   243
            (name, edit.map({ case (c1, c2) => (c1.map(id_command), c2.map(id_command)) }))
wenzelm@38150
   244
        }
wenzelm@43722
   245
wenzelm@39698
   246
      global_state.change(_.define_version(version, former_assignment))
wenzelm@44157
   247
      prover.get.edit_version(previous.id, version.id, id_edits)
wenzelm@34809
   248
    }
wenzelm@38221
   249
    //}}}
wenzelm@34809
   250
wenzelm@34809
   251
wenzelm@34809
   252
    /* prover results */
wenzelm@34809
   253
wenzelm@34809
   254
    def handle_result(result: Isabelle_Process.Result)
wenzelm@38221
   255
    //{{{
wenzelm@34809
   256
    {
wenzelm@43716
   257
      def bad_result(result: Isabelle_Process.Result)
wenzelm@43716
   258
      {
wenzelm@43716
   259
        if (verbose)
wenzelm@43716
   260
          System.err.println("Ignoring prover result: " + result.message.toString)
wenzelm@43716
   261
      }
wenzelm@43716
   262
wenzelm@38722
   263
      result.properties match {
wenzelm@43748
   264
        case Position.Id(state_id) if !result.is_raw =>
wenzelm@38370
   265
          try {
wenzelm@38841
   266
            val st = global_state.change_yield(_.accumulate(state_id, result.message))
wenzelm@38841
   267
            command_change_buffer ! st.command
wenzelm@38370
   268
          }
wenzelm@43748
   269
          catch {
wenzelm@43748
   270
            case _: Document.State.Fail => bad_result(result)
wenzelm@43748
   271
          }
wenzelm@43748
   272
        case Markup.Invoke_Scala(name, id) if result.is_raw =>
wenzelm@43748
   273
          Future.fork {
wenzelm@43748
   274
            val arg = XML.content(result.body).mkString
wenzelm@43748
   275
            val (tag, res) = Invoke_Scala.method(name, arg)
wenzelm@43748
   276
            prover.get.invoke_scala(id, tag, res)
wenzelm@43748
   277
          }
wenzelm@44298
   278
        case Markup.Cancel_Scala(id) =>
wenzelm@44298
   279
          System.err.println("cancel_scala " + id)  // FIXME cancel JVM task
wenzelm@38722
   280
        case _ =>
wenzelm@39630
   281
          if (result.is_syslog) {
wenzelm@39630
   282
            reverse_syslog ::= result.message
wenzelm@40533
   283
            if (result.is_ready) {
wenzelm@43716
   284
              // FIXME move to ML side (!?)
wenzelm@40533
   285
              syntax += ("hence", Keyword.PRF_ASM_GOAL, "then have")
wenzelm@40533
   286
              syntax += ("thus", Keyword.PRF_ASM_GOAL, "then show")
wenzelm@40533
   287
              phase = Session.Ready
wenzelm@40533
   288
            }
wenzelm@39701
   289
            else if (result.is_exit && phase == Session.Startup) phase = Session.Failed
wenzelm@39696
   290
            else if (result.is_exit) phase = Session.Inactive
wenzelm@39630
   291
          }
wenzelm@39626
   292
          else if (result.is_stdout) { }
wenzelm@39625
   293
          else if (result.is_status) {
wenzelm@38370
   294
            result.body match {
wenzelm@38417
   295
              case List(Isar_Document.Assign(id, edits)) =>
wenzelm@38849
   296
                try {
wenzelm@38882
   297
                  val cmds: List[Command] = global_state.change_yield(_.assign(id, edits))
wenzelm@38882
   298
                  for (cmd <- cmds) command_change_buffer ! cmd
wenzelm@38849
   299
                  assignments.event(Session.Assignment)
wenzelm@38849
   300
                }
wenzelm@38414
   301
                catch { case _: Document.State.Fail => bad_result(result) }
wenzelm@38370
   302
              case List(Keyword.Command_Decl(name, kind)) => syntax += (name, kind)
wenzelm@38370
   303
              case List(Keyword.Keyword_Decl(name)) => syntax += name
wenzelm@43673
   304
              case List(Thy_Info.Loaded_Theory(name)) => loaded_theories += name
wenzelm@39625
   305
              case _ => bad_result(result)
wenzelm@38370
   306
            }
wenzelm@38370
   307
          }
wenzelm@39625
   308
          else bad_result(result)
wenzelm@43748
   309
      }
wenzelm@34809
   310
    }
wenzelm@38221
   311
    //}}}
wenzelm@34809
   312
wenzelm@34820
   313
wenzelm@39630
   314
    /* main loop */
wenzelm@34809
   315
wenzelm@43716
   316
    //{{{
wenzelm@38639
   317
    var finished = false
wenzelm@38639
   318
    while (!finished) {
wenzelm@38639
   319
      receive {
wenzelm@43649
   320
        case Start(timeout, args) if prover.isEmpty =>
wenzelm@39701
   321
          if (phase == Session.Inactive || phase == Session.Failed) {
wenzelm@39701
   322
            phase = Session.Startup
wenzelm@43661
   323
            prover = Some(new Isabelle_Process(timeout, this_actor, args:_*) with Isar_Document)
wenzelm@39701
   324
          }
wenzelm@38841
   325
wenzelm@39701
   326
        case Stop =>
wenzelm@39701
   327
          if (phase == Session.Ready) {
wenzelm@39701
   328
            global_state.change(_ => Document.State.init)  // FIXME event bus!?
wenzelm@39701
   329
            phase = Session.Shutdown
wenzelm@43649
   330
            prover.get.terminate
wenzelm@43717
   331
            prover = None
wenzelm@39701
   332
            phase = Session.Inactive
wenzelm@39701
   333
          }
wenzelm@39630
   334
          finished = true
wenzelm@39630
   335
          reply(())
wenzelm@38850
   336
wenzelm@43717
   337
        case Interrupt if prover.isDefined =>
wenzelm@43717
   338
          prover.get.interrupt
wenzelm@43716
   339
wenzelm@44182
   340
        case Init_Node(name, master_dir, header, text) if prover.isDefined =>
wenzelm@43716
   341
          // FIXME compare with existing node
wenzelm@44182
   342
          handle_edits(name, master_dir, header,
wenzelm@44185
   343
            List(Document.Node.Clear(), Document.Node.Edits(List(Text.Edit.insert(0, text)))))
wenzelm@43716
   344
          reply(())
wenzelm@43716
   345
wenzelm@44182
   346
        case Edit_Node(name, master_dir, header, text_edits) if prover.isDefined =>
wenzelm@44182
   347
          handle_edits(name, master_dir, header, List(Document.Node.Edits(text_edits)))
wenzelm@43718
   348
          reply(())
wenzelm@43718
   349
wenzelm@43722
   350
        case change: Change_Node if prover.isDefined =>
wenzelm@43722
   351
          handle_change(change)
wenzelm@43716
   352
wenzelm@43721
   353
        case input: Isabelle_Process.Input =>
wenzelm@43721
   354
          raw_messages.event(input)
wenzelm@43721
   355
wenzelm@43716
   356
        case result: Isabelle_Process.Result =>
wenzelm@43716
   357
          handle_result(result)
wenzelm@43721
   358
          raw_messages.event(result)
wenzelm@43716
   359
wenzelm@43717
   360
        case bad => System.err.println("session_actor: ignoring bad message " + bad)
wenzelm@34777
   361
      }
wenzelm@34777
   362
    }
wenzelm@43716
   363
    //}}}
wenzelm@34777
   364
  }
wenzelm@34777
   365
wenzelm@34809
   366
wenzelm@43716
   367
  /* actions */
wenzelm@34809
   368
wenzelm@40848
   369
  def start(timeout: Time, args: List[String]) { session_actor ! Start(timeout, args) }
wenzelm@34820
   370
wenzelm@39630
   371
  def stop() { command_change_buffer !? Stop; session_actor !? Stop }
wenzelm@38841
   372
wenzelm@43716
   373
  def interrupt() { session_actor ! Interrupt }
wenzelm@43648
   374
wenzelm@44182
   375
  def init_node(name: String, master_dir: String, header: Document.Node_Header, text: String)
wenzelm@44182
   376
  { session_actor !? Init_Node(name, master_dir, header, text) }
wenzelm@38221
   377
wenzelm@44182
   378
  def edit_node(name: String, master_dir: String, header: Document.Node_Header, edits: List[Text.Edit])
wenzelm@44182
   379
  { session_actor !? Edit_Node(name, master_dir, header, edits) }
wenzelm@34777
   380
}