wenzelm@45709: /*  Title:      Pure/PIDE/protocol.scala
wenzelm@38412:     Author:     Makarius
wenzelm@38412: 
wenzelm@45709: Protocol message formats for interactive proof documents.
wenzelm@38412: */
wenzelm@38412: 
wenzelm@38412: package isabelle
wenzelm@38412: 
wenzelm@38412: 
wenzelm@45709: object Protocol
wenzelm@38412: {
wenzelm@38567:   /* document editing */
wenzelm@38412: 
wenzelm@52563:   object Assign_Update
wenzelm@44476:   {
wenzelm@52563:     def unapply(text: String): Option[(Document_ID.Version, Document.Assign_Update)] =
wenzelm@44661:       try {
wenzelm@44661:         import XML.Decode._
wenzelm@44661:         val body = YXML.parse_body(text)
wenzelm@52527:         Some(pair(long, list(pair(long, list(long))))(body))
wenzelm@44661:       }
wenzelm@44661:       catch {
wenzelm@44661:         case ERROR(_) => None
wenzelm@51987:         case _: XML.Error => None
wenzelm@38412:       }
wenzelm@38412:   }
wenzelm@38567: 
wenzelm@44676:   object Removed
wenzelm@44676:   {
wenzelm@52530:     def unapply(text: String): Option[List[Document_ID.Version]] =
wenzelm@44676:       try {
wenzelm@44676:         import XML.Decode._
wenzelm@44676:         Some(list(long)(YXML.parse_body(text)))
wenzelm@44676:       }
wenzelm@44676:       catch {
wenzelm@44676:         case ERROR(_) => None
wenzelm@51987:         case _: XML.Error => None
wenzelm@44676:       }
wenzelm@44676:   }
wenzelm@44676: 
wenzelm@38567: 
wenzelm@46209:   /* command status */
wenzelm@38567: 
wenzelm@46227:   object Status
wenzelm@46227:   {
wenzelm@46227:     val init = Status()
wenzelm@46227:   }
wenzelm@46227: 
wenzelm@46166:   sealed case class Status(
wenzelm@49036:     private val touched: Boolean = false,
wenzelm@47395:     private val accepted: Boolean = false,
wenzelm@46166:     private val failed: Boolean = false,
wenzelm@49036:     forks: Int = 0,
wenzelm@49036:     runs: Int = 0)
wenzelm@38567:   {
wenzelm@46227:     def + (that: Status): Status =
wenzelm@49036:       Status(touched || that.touched, accepted || that.accepted, failed || that.failed,
wenzelm@49036:         forks + that.forks, runs + that.runs)
wenzelm@49036: 
wenzelm@49036:     def is_unprocessed: Boolean = accepted && !failed && (!touched || (forks != 0 && runs == 0))
wenzelm@49036:     def is_running: Boolean = runs != 0
wenzelm@49039:     def is_finished: Boolean = !failed && touched && forks == 0 && runs == 0
wenzelm@49036:     def is_failed: Boolean = failed
wenzelm@46166:   }
wenzelm@46166: 
wenzelm@46166:   val command_status_markup: Set[String] =
wenzelm@50201:     Set(Markup.ACCEPTED, Markup.FORKED, Markup.JOINED, Markup.RUNNING,
wenzelm@50201:       Markup.FINISHED, Markup.FAILED)
wenzelm@46166: 
wenzelm@46166:   def command_status(status: Status, markup: Markup): Status =
wenzelm@46166:     markup match {
wenzelm@50201:       case Markup(Markup.ACCEPTED, _) => status.copy(accepted = true)
wenzelm@50201:       case Markup(Markup.FORKED, _) => status.copy(touched = true, forks = status.forks + 1)
wenzelm@50201:       case Markup(Markup.JOINED, _) => status.copy(forks = status.forks - 1)
wenzelm@50201:       case Markup(Markup.RUNNING, _) => status.copy(touched = true, runs = status.runs + 1)
wenzelm@50201:       case Markup(Markup.FINISHED, _) => status.copy(runs = status.runs - 1)
wenzelm@50201:       case Markup(Markup.FAILED, _) => status.copy(failed = true)
wenzelm@46166:       case _ => status
wenzelm@38567:     }
wenzelm@46166: 
wenzelm@46166:   def command_status(markups: List[Markup]): Status =
wenzelm@46227:     (Status.init /: markups)(command_status(_, _))
wenzelm@38887: 
wenzelm@46209: 
wenzelm@51818:   /* command timing */
wenzelm@51818: 
wenzelm@51818:   object Command_Timing
wenzelm@51818:   {
wenzelm@52531:     def unapply(props: Properties.T): Option[(Document_ID.Generic, isabelle.Timing)] =
wenzelm@51818:       props match {
wenzelm@51818:         case (Markup.FUNCTION, Markup.COMMAND_TIMING) :: args =>
wenzelm@51818:           (args, args) match {
wenzelm@51818:             case (Position.Id(id), Markup.Timing_Properties(timing)) => Some((id, timing))
wenzelm@51818:             case _ => None
wenzelm@51818:           }
wenzelm@51818:         case _ => None
wenzelm@51818:       }
wenzelm@51818:   }
wenzelm@51818: 
wenzelm@51818: 
wenzelm@46209:   /* node status */
wenzelm@46209: 
wenzelm@46688:   sealed case class Node_Status(
wenzelm@46688:     unprocessed: Int, running: Int, finished: Int, warned: Int, failed: Int)
wenzelm@44866:   {
wenzelm@46688:     def total: Int = unprocessed + running + finished + warned + failed
wenzelm@44866:   }
wenzelm@44613: 
wenzelm@44613:   def node_status(
wenzelm@44613:     state: Document.State, version: Document.Version, node: Document.Node): Node_Status =
wenzelm@44613:   {
wenzelm@44613:     var unprocessed = 0
wenzelm@44613:     var running = 0
wenzelm@44613:     var finished = 0
wenzelm@46688:     var warned = 0
wenzelm@44613:     var failed = 0
wenzelm@44613:     node.commands.foreach(command =>
wenzelm@46166:       {
wenzelm@46688:         val st = state.command_state(version, command)
wenzelm@46688:         val status = command_status(st.status)
wenzelm@46166:         if (status.is_running) running += 1
wenzelm@46688:         else if (status.is_finished) {
wenzelm@50507:           if (st.results.entries.exists(p => is_warning(p._2))) warned += 1
wenzelm@46688:           else finished += 1
wenzelm@46688:         }
wenzelm@46166:         else if (status.is_failed) failed += 1
wenzelm@46166:         else unprocessed += 1
wenzelm@44613:       })
wenzelm@46688:     Node_Status(unprocessed, running, finished, warned, failed)
wenzelm@44613:   }
wenzelm@44613: 
wenzelm@38887: 
wenzelm@51533:   /* node timing */
wenzelm@51533: 
wenzelm@51533:   sealed case class Node_Timing(total: Double, commands: Map[Command, Double])
wenzelm@51533: 
wenzelm@51533:   val empty_node_timing = Node_Timing(0.0, Map.empty)
wenzelm@51533: 
wenzelm@51533:   def node_timing(
wenzelm@51533:     state: Document.State,
wenzelm@51533:     version: Document.Version,
wenzelm@51533:     node: Document.Node,
wenzelm@51533:     threshold: Double): Node_Timing =
wenzelm@51533:   {
wenzelm@51533:     var total = 0.0
wenzelm@51533:     var commands = Map.empty[Command, Double]
wenzelm@51533:     for {
wenzelm@51533:       command <- node.commands.iterator
wenzelm@51533:       st = state.command_state(version, command)
wenzelm@51533:       command_timing =
wenzelm@51533:         (0.0 /: st.status)({
wenzelm@51533:           case (timing, Markup.Timing(t)) => timing + t.elapsed.seconds
wenzelm@51533:           case (timing, _) => timing
wenzelm@51533:         })
wenzelm@51533:     } {
wenzelm@51533:       total += command_timing
wenzelm@51533:       if (command_timing >= threshold) commands += (command -> command_timing)
wenzelm@51533:     }
wenzelm@51533:     Node_Timing(total, commands)
wenzelm@51533:   }
wenzelm@51533: 
wenzelm@51533: 
wenzelm@39441:   /* result messages */
wenzelm@39439: 
wenzelm@50450:   private val clean = Set(Markup.REPORT, Markup.NO_REPORT)
wenzelm@50450: 
wenzelm@39439:   def clean_message(body: XML.Body): XML.Body =
wenzelm@49445:     body filter {
wenzelm@50450:       case XML.Wrapped_Elem(Markup(name, _), _, _) => !clean(name)
wenzelm@50450:       case XML.Elem(Markup(name, _), _) => !clean(name)
wenzelm@49445:       case _ => true
wenzelm@49650:     } map {
wenzelm@49650:       case XML.Wrapped_Elem(markup, body, ts) => XML.Wrapped_Elem(markup, body, clean_message(ts))
wenzelm@49650:       case XML.Elem(markup, ts) => XML.Elem(markup, clean_message(ts))
wenzelm@49650:       case t => t
wenzelm@49650:     }
wenzelm@39439: 
wenzelm@49445:   def message_reports(props: Properties.T, body: XML.Body): List[XML.Elem] =
wenzelm@49445:     body flatMap {
wenzelm@50450:       case XML.Wrapped_Elem(Markup(Markup.REPORT, ps), body, ts) =>
wenzelm@50450:         List(XML.Wrapped_Elem(Markup(Markup.REPORT, props ::: ps), body, ts))
wenzelm@50201:       case XML.Elem(Markup(Markup.REPORT, ps), ts) =>
wenzelm@50201:         List(XML.Elem(Markup(Markup.REPORT, props ::: ps), ts))
wenzelm@49650:       case XML.Wrapped_Elem(_, _, ts) => message_reports(props, ts)
wenzelm@49445:       case XML.Elem(_, ts) => message_reports(props, ts)
wenzelm@39441:       case XML.Text(_) => Nil
wenzelm@39441:     }
wenzelm@39441: 
wenzelm@39439: 
wenzelm@39511:   /* specific messages */
wenzelm@39511: 
wenzelm@50500:   def is_inlined(msg: XML.Tree): Boolean =
wenzelm@50500:     !(is_result(msg) || is_tracing(msg) || is_state(msg))
wenzelm@50500: 
wenzelm@50500:   def is_result(msg: XML.Tree): Boolean =
wenzelm@50500:     msg match {
wenzelm@50500:       case XML.Elem(Markup(Markup.RESULT, _), _) => true
wenzelm@50500:       case _ => false
wenzelm@50500:     }
wenzelm@50500: 
wenzelm@50157:   def is_tracing(msg: XML.Tree): Boolean =
wenzelm@39622:     msg match {
wenzelm@50201:       case XML.Elem(Markup(Markup.TRACING, _), _) => true
wenzelm@50201:       case XML.Elem(Markup(Markup.TRACING_MESSAGE, _), _) => true
wenzelm@39622:       case _ => false
wenzelm@39622:     }
wenzelm@39622: 
wenzelm@52650:   def is_writeln_markup(msg: XML.Tree, name: String): Boolean =
wenzelm@50500:     msg match {
wenzelm@50500:       case XML.Elem(Markup(Markup.WRITELN, _),
wenzelm@52650:         List(XML.Elem(markup, _))) => markup.name == name
wenzelm@50500:       case XML.Elem(Markup(Markup.WRITELN_MESSAGE, _),
wenzelm@52650:         List(XML.Elem(markup, _))) => markup.name == name
wenzelm@50500:       case _ => false
wenzelm@50500:     }
wenzelm@50500: 
wenzelm@52650:   def is_state(msg: XML.Tree): Boolean = is_writeln_markup(msg, Markup.STATE)
wenzelm@52650:   def is_information(msg: XML.Tree): Boolean = is_writeln_markup(msg, Markup.INFORMATION)
wenzelm@52650: 
wenzelm@39511:   def is_warning(msg: XML.Tree): Boolean =
wenzelm@39511:     msg match {
wenzelm@50201:       case XML.Elem(Markup(Markup.WARNING, _), _) => true
wenzelm@50201:       case XML.Elem(Markup(Markup.WARNING_MESSAGE, _), _) => true
wenzelm@39511:       case _ => false
wenzelm@39511:     }
wenzelm@39511: 
wenzelm@39511:   def is_error(msg: XML.Tree): Boolean =
wenzelm@39511:     msg match {
wenzelm@50201:       case XML.Elem(Markup(Markup.ERROR, _), _) => true
wenzelm@50201:       case XML.Elem(Markup(Markup.ERROR_MESSAGE, _), _) => true
wenzelm@39511:       case _ => false
wenzelm@39511:     }
wenzelm@38887: 
wenzelm@50500: 
wenzelm@50500:   /* dialogs */
wenzelm@50500: 
wenzelm@50500:   object Dialog_Args
wenzelm@50500:   {
wenzelm@52531:     def unapply(props: Properties.T): Option[(Document_ID.Generic, Long, String)] =
wenzelm@50500:       (props, props, props) match {
wenzelm@50500:         case (Position.Id(id), Markup.Serial(serial), Markup.Result(result)) =>
wenzelm@50500:           Some((id, serial, result))
wenzelm@50500:         case _ => None
wenzelm@50500:       }
wenzelm@50500:   }
wenzelm@50500: 
wenzelm@50500:   object Dialog
wenzelm@50500:   {
wenzelm@52531:     def unapply(tree: XML.Tree): Option[(Document_ID.Generic, Long, String)] =
wenzelm@50500:       tree match {
wenzelm@50500:         case XML.Elem(Markup(Markup.DIALOG, Dialog_Args(id, serial, result)), _) =>
wenzelm@50500:           Some((id, serial, result))
wenzelm@50500:         case _ => None
wenzelm@50500:       }
wenzelm@50500:   }
wenzelm@50500: 
wenzelm@50500:   object Dialog_Result
wenzelm@50500:   {
wenzelm@52531:     def apply(id: Document_ID.Generic, serial: Long, result: String): XML.Elem =
wenzelm@50501:     {
wenzelm@50501:       val props = Position.Id(id) ::: Markup.Serial(serial)
wenzelm@50501:       XML.Elem(Markup(Markup.RESULT, props), List(XML.Text(result)))
wenzelm@50501:     }
wenzelm@50500: 
wenzelm@50501:     def unapply(tree: XML.Tree): Option[String] =
wenzelm@50500:       tree match {
wenzelm@50501:         case XML.Elem(Markup(Markup.RESULT, _), List(XML.Text(result))) => Some(result)
wenzelm@50500:         case _ => None
wenzelm@50500:       }
wenzelm@50500:   }
wenzelm@39170: 
wenzelm@39511: 
wenzelm@39511:   /* reported positions */
wenzelm@39511: 
wenzelm@50201:   private val include_pos = Set(Markup.BINDING, Markup.ENTITY, Markup.REPORT, Markup.POSITION)
wenzelm@39441: 
wenzelm@39441:   def message_positions(command: Command, message: XML.Elem): Set[Text.Range] =
wenzelm@38887:   {
wenzelm@49650:     def elem_positions(raw_range: Text.Range, set: Set[Text.Range], body: XML.Body)
wenzelm@49650:       : Set[Text.Range] =
wenzelm@49650:     {
wenzelm@49650:       val range = command.decode(raw_range).restrict(command.range)
wenzelm@49650:       body.foldLeft(if (range.is_singularity) set else set + range)(positions)
wenzelm@49650:     }
wenzelm@50157: 
wenzelm@39441:     def positions(set: Set[Text.Range], tree: XML.Tree): Set[Text.Range] =
wenzelm@38887:       tree match {
wenzelm@49650:         case XML.Wrapped_Elem(Markup(name, Position.Id_Range(id, range)), _, body)
wenzelm@49650:         if include_pos(name) && id == command.id => elem_positions(range, set, body)
wenzelm@49650: 
wenzelm@49650:         case XML.Elem(Markup(name, Position.Id_Range(id, range)), body)
wenzelm@49650:         if include_pos(name) && id == command.id => elem_positions(range, set, body)
wenzelm@49650: 
wenzelm@49650:         case XML.Wrapped_Elem(_, _, body) => body.foldLeft(set)(positions)
wenzelm@49650: 
wenzelm@49650:         case XML.Elem(_, body) => body.foldLeft(set)(positions)
wenzelm@49650: 
wenzelm@39042:         case _ => set
wenzelm@38887:       }
wenzelm@50157: 
wenzelm@39441:     val set = positions(Set.empty, message)
wenzelm@50500:     if (set.isEmpty)
wenzelm@39172:       set ++ Position.Range.unapply(message.markup.properties).map(command.decode(_))
wenzelm@39042:     else set
wenzelm@38887:   }
wenzelm@38412: }
wenzelm@38412: 
wenzelm@38412: 
wenzelm@45709: trait Protocol extends Isabelle_Process
wenzelm@38412: {
wenzelm@54519:   /* inlined files */
wenzelm@54519: 
wenzelm@54519:   def define_blob(blob: Bytes): Unit =
wenzelm@54519:     protocol_command_raw("Document.define_blob", Bytes(blob.sha1_digest.toString), blob)
wenzelm@54519: 
wenzelm@54519: 
wenzelm@38412:   /* commands */
wenzelm@38412: 
wenzelm@44644:   def define_command(command: Command): Unit =
wenzelm@54519:   {
wenzelm@54519:     val blobs_yxml =
wenzelm@54519:     { import XML.Encode._
wenzelm@54519:       val encode_blob: T[Command.Blob] =
wenzelm@54519:         variant(List(
wenzelm@54519:           { case Exn.Res((a, b)) => (List(a.node, b.toString), Nil) },
wenzelm@54519:           { case Exn.Exn(e) => (List(Exn.message(e)), Nil) }))
wenzelm@54519:       YXML.string_of_body(list(encode_blob)(command.blobs))
wenzelm@54519:     }
wenzelm@52582:     protocol_command("Document.define_command",
wenzelm@54519:       Document_ID(command.id), encode(command.name), blobs_yxml, encode(command.source))
wenzelm@54519:   }
wenzelm@38412: 
wenzelm@38412: 
wenzelm@52931:   /* execution */
wenzelm@52931: 
wenzelm@52931:   def discontinue_execution(): Unit =
wenzelm@52931:     protocol_command("Document.discontinue_execution")
wenzelm@38412: 
wenzelm@52931:   def cancel_exec(id: Document_ID.Exec): Unit =
wenzelm@52931:     protocol_command("Document.cancel_exec", Document_ID(id))
wenzelm@52931: 
wenzelm@52931: 
wenzelm@52931:   /* document versions */
wenzelm@47343: 
wenzelm@52530:   def update(old_id: Document_ID.Version, new_id: Document_ID.Version,
wenzelm@44383:     edits: List[Document.Edit_Command])
wenzelm@38412:   {
wenzelm@44157:     val edits_yxml =
wenzelm@43767:     { import XML.Encode._
wenzelm@44383:       def id: T[Command] = (cmd => long(cmd.id))
wenzelm@46737:       def encode_edit(name: Document.Node.Name)
wenzelm@52849:           : T[Document.Node.Edit[Command.Edit, Command.Perspective]] =
wenzelm@44979:         variant(List(
wenzelm@54509:           // FIXME Document.Node.Blob (!??)
wenzelm@48755:           { case Document.Node.Clear() => (Nil, Nil) },  // FIXME unused !?
wenzelm@44979:           { case Document.Node.Edits(a) => (Nil, list(pair(option(id), option(id)))(a)) },
wenzelm@48707:           { case Document.Node.Deps(header) =>
wenzelm@54515:               val master_dir = Isabelle_System.posix_path(name.master_dir)
wenzelm@48707:               val imports = header.imports.map(_.node)
wenzelm@50128:               val keywords = header.keywords.map({ case (a, b, _) => (a, b) })
wenzelm@44979:               (Nil,
wenzelm@48707:                 pair(Encode.string, pair(Encode.string, pair(list(Encode.string),
wenzelm@48864:                   pair(list(pair(Encode.string,
wenzelm@48864:                     option(pair(pair(Encode.string, list(Encode.string)), list(Encode.string))))),
wenzelm@51294:                   list(Encode.string)))))(
wenzelm@54515:                 (master_dir, (name.theory, (imports, (keywords, header.errors)))))) },
wenzelm@52849:           { case Document.Node.Perspective(a, b, c) =>
wenzelm@52849:               (bool_atom(a) :: b.commands.map(cmd => long_atom(cmd.id)),
wenzelm@52862:                 list(pair(id, pair(Encode.string, list(Encode.string))))(c.dest)) }))
wenzelm@48705:       def encode_edits: T[List[Document.Edit_Command]] = list((node_edit: Document.Edit_Command) =>
wenzelm@44979:       {
wenzelm@44979:         val (name, edit) = node_edit
wenzelm@46737:         pair(string, encode_edit(name))(name.node, edit)
wenzelm@44979:       })
wenzelm@48705:       YXML.string_of_body(encode_edits(edits)) }
wenzelm@52582:     protocol_command("Document.update", Document_ID(old_id), Document_ID(new_id), edits_yxml)
wenzelm@38412:   }
wenzelm@43748: 
wenzelm@44673:   def remove_versions(versions: List[Document.Version])
wenzelm@44673:   {
wenzelm@44673:     val versions_yxml =
wenzelm@44673:       { import XML.Encode._
wenzelm@44673:         YXML.string_of_body(list(long)(versions.map(_.id))) }
wenzelm@52582:     protocol_command("Document.remove_versions", versions_yxml)
wenzelm@44673:   }
wenzelm@44673: 
wenzelm@43748: 
wenzelm@50498:   /* dialog via document content */
wenzelm@50498: 
wenzelm@52931:   def dialog_result(serial: Long, result: String): Unit =
wenzelm@52582:     protocol_command("Document.dialog_result", Properties.Value.Long(serial), result)
wenzelm@38412: }