src/Pure/System/session.scala
author wenzelm
Tue Aug 23 12:20:12 2011 +0200 (2011-08-23)
changeset 44385 e7fdb008aa7d
parent 44384 8f6054a63f96
child 44436 546adfa8a6fc
permissions -rw-r--r--
propagate editor perspective through document model;
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@44385
   167
  private case class Init_Node(name: String, master_dir: String,
wenzelm@44385
   168
    header: Document.Node_Header, perspective: Text.Perspective, text: String)
wenzelm@44385
   169
  private case class Edit_Node(name: String, master_dir: String,
wenzelm@44385
   170
    header: Document.Node_Header, perspective: Text.Perspective, 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@44384
   186
        header: Document.Node_Header, edits: List[Document.Node.Edit[Text.Edit, Text.Perspective]])
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@44384
   199
      val norm_header =
wenzelm@44384
   200
        Document.Node.norm_header[Text.Edit, Text.Perspective](norm_import, norm_use, header)
wenzelm@44222
   201
wenzelm@44185
   202
      val text_edits = (name, norm_header) :: edits.map(edit => (name, edit))
wenzelm@44185
   203
      val result = Future.fork { Thy_Syntax.text_edits(syntax, previous.join, text_edits) }
wenzelm@43722
   204
      val change =
wenzelm@44185
   205
        global_state.change_yield(_.extend_history(previous, text_edits, result.map(_._2)))
wenzelm@43716
   206
wenzelm@43722
   207
      result.map {
wenzelm@44157
   208
        case (doc_edits, _) =>
wenzelm@43722
   209
          assignments.await { global_state().is_assigned(previous.get_finished) }
wenzelm@44157
   210
          this_actor ! Change_Node(name, doc_edits, previous.join, change.version.join)
wenzelm@43722
   211
      }
wenzelm@43716
   212
    }
wenzelm@43716
   213
    //}}}
wenzelm@43716
   214
wenzelm@43716
   215
wenzelm@43716
   216
    /* resulting changes */
wenzelm@34809
   217
wenzelm@43722
   218
    def handle_change(change: Change_Node)
wenzelm@38221
   219
    //{{{
wenzelm@34809
   220
    {
wenzelm@43722
   221
      val previous = change.previous
wenzelm@43722
   222
      val version = change.version
wenzelm@43722
   223
      val name = change.name
wenzelm@43722
   224
      val doc_edits = change.doc_edits
wenzelm@38366
   225
wenzelm@43719
   226
      var former_assignment = global_state().the_assignment(previous).get_finished
wenzelm@38370
   227
      for {
wenzelm@44156
   228
        (name, Document.Node.Edits(cmd_edits)) <- doc_edits  // FIXME proper coverage!?
wenzelm@38370
   229
        (prev, None) <- cmd_edits
wenzelm@38417
   230
        removed <- previous.nodes(name).commands.get_after(prev)
wenzelm@38370
   231
      } former_assignment -= removed
wenzelm@38370
   232
wenzelm@44383
   233
      def id_command(command: Command)
wenzelm@43720
   234
      {
wenzelm@43720
   235
        if (global_state().lookup_command(command.id).isEmpty) {
wenzelm@43720
   236
          global_state.change(_.define_command(command))
wenzelm@43720
   237
          prover.get.define_command(command.id, Symbol.encode(command.source))
wenzelm@43720
   238
        }
wenzelm@43720
   239
      }
wenzelm@44383
   240
      doc_edits foreach {
wenzelm@44383
   241
        case (_, edit) =>
wenzelm@44383
   242
          edit foreach { case (c1, c2) => c1 foreach id_command; c2 foreach id_command }
wenzelm@44383
   243
      }
wenzelm@43722
   244
wenzelm@39698
   245
      global_state.change(_.define_version(version, former_assignment))
wenzelm@44383
   246
      prover.get.edit_version(previous.id, version.id, doc_edits)
wenzelm@34809
   247
    }
wenzelm@38221
   248
    //}}}
wenzelm@34809
   249
wenzelm@34809
   250
wenzelm@34809
   251
    /* prover results */
wenzelm@34809
   252
wenzelm@34809
   253
    def handle_result(result: Isabelle_Process.Result)
wenzelm@38221
   254
    //{{{
wenzelm@34809
   255
    {
wenzelm@43716
   256
      def bad_result(result: Isabelle_Process.Result)
wenzelm@43716
   257
      {
wenzelm@43716
   258
        if (verbose)
wenzelm@43716
   259
          System.err.println("Ignoring prover result: " + result.message.toString)
wenzelm@43716
   260
      }
wenzelm@43716
   261
wenzelm@38722
   262
      result.properties match {
wenzelm@43748
   263
        case Position.Id(state_id) if !result.is_raw =>
wenzelm@38370
   264
          try {
wenzelm@38841
   265
            val st = global_state.change_yield(_.accumulate(state_id, result.message))
wenzelm@38841
   266
            command_change_buffer ! st.command
wenzelm@38370
   267
          }
wenzelm@43748
   268
          catch {
wenzelm@43748
   269
            case _: Document.State.Fail => bad_result(result)
wenzelm@43748
   270
          }
wenzelm@43748
   271
        case Markup.Invoke_Scala(name, id) if result.is_raw =>
wenzelm@43748
   272
          Future.fork {
wenzelm@43748
   273
            val arg = XML.content(result.body).mkString
wenzelm@43748
   274
            val (tag, res) = Invoke_Scala.method(name, arg)
wenzelm@43748
   275
            prover.get.invoke_scala(id, tag, res)
wenzelm@43748
   276
          }
wenzelm@44298
   277
        case Markup.Cancel_Scala(id) =>
wenzelm@44298
   278
          System.err.println("cancel_scala " + id)  // FIXME cancel JVM task
wenzelm@38722
   279
        case _ =>
wenzelm@39630
   280
          if (result.is_syslog) {
wenzelm@39630
   281
            reverse_syslog ::= result.message
wenzelm@40533
   282
            if (result.is_ready) {
wenzelm@43716
   283
              // FIXME move to ML side (!?)
wenzelm@40533
   284
              syntax += ("hence", Keyword.PRF_ASM_GOAL, "then have")
wenzelm@40533
   285
              syntax += ("thus", Keyword.PRF_ASM_GOAL, "then show")
wenzelm@40533
   286
              phase = Session.Ready
wenzelm@40533
   287
            }
wenzelm@39701
   288
            else if (result.is_exit && phase == Session.Startup) phase = Session.Failed
wenzelm@39696
   289
            else if (result.is_exit) phase = Session.Inactive
wenzelm@39630
   290
          }
wenzelm@39626
   291
          else if (result.is_stdout) { }
wenzelm@39625
   292
          else if (result.is_status) {
wenzelm@38370
   293
            result.body match {
wenzelm@38417
   294
              case List(Isar_Document.Assign(id, edits)) =>
wenzelm@38849
   295
                try {
wenzelm@38882
   296
                  val cmds: List[Command] = global_state.change_yield(_.assign(id, edits))
wenzelm@38882
   297
                  for (cmd <- cmds) command_change_buffer ! cmd
wenzelm@38849
   298
                  assignments.event(Session.Assignment)
wenzelm@38849
   299
                }
wenzelm@38414
   300
                catch { case _: Document.State.Fail => bad_result(result) }
wenzelm@38370
   301
              case List(Keyword.Command_Decl(name, kind)) => syntax += (name, kind)
wenzelm@38370
   302
              case List(Keyword.Keyword_Decl(name)) => syntax += name
wenzelm@43673
   303
              case List(Thy_Info.Loaded_Theory(name)) => loaded_theories += name
wenzelm@39625
   304
              case _ => bad_result(result)
wenzelm@38370
   305
            }
wenzelm@38370
   306
          }
wenzelm@39625
   307
          else bad_result(result)
wenzelm@43748
   308
      }
wenzelm@34809
   309
    }
wenzelm@38221
   310
    //}}}
wenzelm@34809
   311
wenzelm@34820
   312
wenzelm@39630
   313
    /* main loop */
wenzelm@34809
   314
wenzelm@43716
   315
    //{{{
wenzelm@38639
   316
    var finished = false
wenzelm@38639
   317
    while (!finished) {
wenzelm@38639
   318
      receive {
wenzelm@43649
   319
        case Start(timeout, args) if prover.isEmpty =>
wenzelm@39701
   320
          if (phase == Session.Inactive || phase == Session.Failed) {
wenzelm@39701
   321
            phase = Session.Startup
wenzelm@43661
   322
            prover = Some(new Isabelle_Process(timeout, this_actor, args:_*) with Isar_Document)
wenzelm@39701
   323
          }
wenzelm@38841
   324
wenzelm@39701
   325
        case Stop =>
wenzelm@39701
   326
          if (phase == Session.Ready) {
wenzelm@39701
   327
            global_state.change(_ => Document.State.init)  // FIXME event bus!?
wenzelm@39701
   328
            phase = Session.Shutdown
wenzelm@43649
   329
            prover.get.terminate
wenzelm@43717
   330
            prover = None
wenzelm@39701
   331
            phase = Session.Inactive
wenzelm@39701
   332
          }
wenzelm@39630
   333
          finished = true
wenzelm@39630
   334
          reply(())
wenzelm@38850
   335
wenzelm@43717
   336
        case Interrupt if prover.isDefined =>
wenzelm@43717
   337
          prover.get.interrupt
wenzelm@43716
   338
wenzelm@44385
   339
        case Init_Node(name, master_dir, header, perspective, text) if prover.isDefined =>
wenzelm@43716
   340
          // FIXME compare with existing node
wenzelm@44182
   341
          handle_edits(name, master_dir, header,
wenzelm@44385
   342
            List(Document.Node.Clear(),
wenzelm@44385
   343
              Document.Node.Edits(List(Text.Edit.insert(0, text))),
wenzelm@44385
   344
              Document.Node.Perspective(perspective)))
wenzelm@43716
   345
          reply(())
wenzelm@43716
   346
wenzelm@44385
   347
        case Edit_Node(name, master_dir, header, perspective, text_edits) if prover.isDefined =>
wenzelm@44385
   348
          handle_edits(name, master_dir, header,
wenzelm@44385
   349
            List(Document.Node.Edits(text_edits),
wenzelm@44385
   350
              Document.Node.Perspective(perspective)))
wenzelm@43718
   351
          reply(())
wenzelm@43718
   352
wenzelm@43722
   353
        case change: Change_Node if prover.isDefined =>
wenzelm@43722
   354
          handle_change(change)
wenzelm@43716
   355
wenzelm@43721
   356
        case input: Isabelle_Process.Input =>
wenzelm@43721
   357
          raw_messages.event(input)
wenzelm@43721
   358
wenzelm@43716
   359
        case result: Isabelle_Process.Result =>
wenzelm@43716
   360
          handle_result(result)
wenzelm@43721
   361
          raw_messages.event(result)
wenzelm@43716
   362
wenzelm@43717
   363
        case bad => System.err.println("session_actor: ignoring bad message " + bad)
wenzelm@34777
   364
      }
wenzelm@34777
   365
    }
wenzelm@43716
   366
    //}}}
wenzelm@34777
   367
  }
wenzelm@34777
   368
wenzelm@34809
   369
wenzelm@43716
   370
  /* actions */
wenzelm@34809
   371
wenzelm@40848
   372
  def start(timeout: Time, args: List[String]) { session_actor ! Start(timeout, args) }
wenzelm@34820
   373
wenzelm@39630
   374
  def stop() { command_change_buffer !? Stop; session_actor !? Stop }
wenzelm@38841
   375
wenzelm@43716
   376
  def interrupt() { session_actor ! Interrupt }
wenzelm@43648
   377
wenzelm@44385
   378
  // FIXME simplify signature
wenzelm@44385
   379
  def init_node(name: String, master_dir: String,
wenzelm@44385
   380
    header: Document.Node_Header, perspective: Text.Perspective, text: String)
wenzelm@44385
   381
  { session_actor !? Init_Node(name, master_dir, header, perspective, text) }
wenzelm@38221
   382
wenzelm@44385
   383
  // FIXME simplify signature
wenzelm@44385
   384
  def edit_node(name: String, master_dir: String, header: Document.Node_Header,
wenzelm@44385
   385
    perspective: Text.Perspective, edits: List[Text.Edit])
wenzelm@44385
   386
  { session_actor !? Edit_Node(name, master_dir, header, perspective, edits) }
wenzelm@34777
   387
}