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@56359:   object Status
wenzelm@56359:   {
wenzelm@56359:     def make(markup_iterator: Iterator[Markup]): Status =
wenzelm@56359:     {
wenzelm@56359:       var touched = false
wenzelm@56359:       var accepted = false
wenzelm@56395:       var warned = false
wenzelm@56359:       var failed = false
wenzelm@56359:       var forks = 0
wenzelm@56359:       var runs = 0
wenzelm@56359:       for (markup <- markup_iterator) {
wenzelm@56359:         markup.name match {
wenzelm@56359:           case Markup.ACCEPTED => accepted = true
wenzelm@56359:           case Markup.FORKED => touched = true; forks += 1
wenzelm@56359:           case Markup.JOINED => forks -= 1
wenzelm@56359:           case Markup.RUNNING => touched = true; runs += 1
wenzelm@56359:           case Markup.FINISHED => runs -= 1
wenzelm@59203:           case Markup.WARNING | Markup.LEGACY => warned = true
wenzelm@56395:           case Markup.FAILED | Markup.ERROR => failed = true
wenzelm@56359:           case _ =>
wenzelm@56359:         }
wenzelm@56359:       }
wenzelm@56395:       Status(touched, accepted, warned, failed, forks, runs)
wenzelm@56359:     }
wenzelm@56359: 
wenzelm@56359:     val empty = make(Iterator.empty)
wenzelm@56359: 
wenzelm@56359:     def merge(status_iterator: Iterator[Status]): Status =
wenzelm@56359:       if (status_iterator.hasNext) {
wenzelm@56359:         val status0 = status_iterator.next
wenzelm@56359:         (status0 /: status_iterator)(_ + _)
wenzelm@56359:       }
wenzelm@56359:       else empty
wenzelm@56359:   }
wenzelm@56359: 
wenzelm@46166:   sealed case class Status(
wenzelm@56352:     private val touched: Boolean,
wenzelm@56352:     private val accepted: Boolean,
wenzelm@56395:     private val warned: Boolean,
wenzelm@56352:     private val failed: Boolean,
wenzelm@56352:     forks: Int,
wenzelm@56352:     runs: Int)
wenzelm@38567:   {
wenzelm@56359:     def + (that: Status): Status =
wenzelm@56395:       Status(
wenzelm@56395:         touched || that.touched,
wenzelm@56395:         accepted || that.accepted,
wenzelm@56395:         warned || that.warned,
wenzelm@56395:         failed || that.failed,
wenzelm@56395:         forks + that.forks,
wenzelm@56395:         runs + that.runs)
wenzelm@56359: 
wenzelm@49036:     def is_unprocessed: Boolean = accepted && !failed && (!touched || (forks != 0 && runs == 0))
wenzelm@49036:     def is_running: Boolean = runs != 0
wenzelm@56474:     def is_warned: Boolean = warned
wenzelm@56474:     def is_failed: Boolean = failed
wenzelm@49039:     def is_finished: Boolean = !failed && touched && forks == 0 && runs == 0
wenzelm@46166:   }
wenzelm@46166: 
wenzelm@56395:   val proper_status_elements =
wenzelm@56743:     Markup.Elements(Markup.ACCEPTED, Markup.FORKED, Markup.JOINED, Markup.RUNNING,
wenzelm@55646:       Markup.FINISHED, Markup.FAILED)
wenzelm@55646: 
wenzelm@56395:   val liberal_status_elements =
wenzelm@59203:     proper_status_elements + Markup.WARNING + Markup.LEGACY + Markup.ERROR
wenzelm@55646: 
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@56474:     unprocessed: Int, running: Int, warned: Int, failed: Int, finished: Int)
wenzelm@44866:   {
wenzelm@56474:     def total: Int = unprocessed + running + warned + failed + finished
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@46688:     var warned = 0
wenzelm@44613:     var failed = 0
wenzelm@56474:     var finished = 0
wenzelm@56356:     for (command <- node.commands.iterator) {
wenzelm@56355:       val states = state.command_states(version, command)
wenzelm@56359:       val status = Status.merge(states.iterator.map(_.protocol_status))
wenzelm@56355: 
wenzelm@56299:       if (status.is_running) running += 1
wenzelm@57843:       else if (status.is_failed) failed += 1
wenzelm@56395:       else if (status.is_warned) warned += 1
wenzelm@56395:       else if (status.is_finished) finished += 1
wenzelm@56299:       else unprocessed += 1
wenzelm@56299:     }
wenzelm@56474:     Node_Status(unprocessed, running, warned, failed, finished)
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@56299:       st <- state.command_states(version, command)
wenzelm@56356:     } {
wenzelm@56356:       val 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:       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@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@59184:   def is_state(msg: XML.Tree): Boolean =
wenzelm@50500:     msg match {
wenzelm@59184:       case XML.Elem(Markup(Markup.STATE, _), _) => true
wenzelm@59184:       case XML.Elem(Markup(Markup.STATE_MESSAGE, _), _) => true
wenzelm@59184:       case _ => false
wenzelm@59184:     }
wenzelm@59184: 
wenzelm@59184:   def is_information(msg: XML.Tree): Boolean =
wenzelm@59184:     msg match {
wenzelm@59184:       case XML.Elem(Markup(Markup.INFORMATION, _), _) => true
wenzelm@59184:       case XML.Elem(Markup(Markup.INFORMATION_MESSAGE, _), _) => true
wenzelm@50500:       case _ => false
wenzelm@50500:     }
wenzelm@50500: 
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@59203:   def is_legacy(msg: XML.Tree): Boolean =
wenzelm@59203:     msg match {
wenzelm@59203:       case XML.Elem(Markup(Markup.LEGACY, _), _) => true
wenzelm@59203:       case XML.Elem(Markup(Markup.LEGACY_MESSAGE, _), _) => true
wenzelm@59203:       case _ => false
wenzelm@59203:     }
wenzelm@59203: 
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@56495:   def is_inlined(msg: XML.Tree): Boolean =
wenzelm@56495:     !(is_result(msg) || is_tracing(msg) || is_state(msg))
wenzelm@56495: 
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@38412: }
wenzelm@38412: 
wenzelm@38412: 
wenzelm@57916: trait Protocol
wenzelm@38412: {
wenzelm@57916:   /* text */
wenzelm@57916: 
wenzelm@57916:   def encode(s: String): String
wenzelm@57916:   def decode(s: String): String
wenzelm@57916: 
wenzelm@57916:   object Encode
wenzelm@57916:   {
wenzelm@57916:     val string: XML.Encode.T[String] = (s => XML.Encode.string(encode(s)))
wenzelm@57916:   }
wenzelm@57916: 
wenzelm@57916: 
wenzelm@57916:   /* protocol commands */
wenzelm@57916: 
wenzelm@57916:   def protocol_command_bytes(name: String, args: Bytes*): Unit
wenzelm@57916:   def protocol_command(name: String, args: String*): Unit
wenzelm@57916: 
wenzelm@57916: 
wenzelm@56387:   /* options */
wenzelm@56387: 
wenzelm@56387:   def options(opts: Options): Unit =
wenzelm@56387:     protocol_command("Prover.options", YXML.string_of_body(opts.encode))
wenzelm@56387: 
wenzelm@56387: 
wenzelm@56387:   /* interned items */
wenzelm@54519: 
wenzelm@56335:   def define_blob(digest: SHA1.Digest, bytes: Bytes): Unit =
wenzelm@56387:     protocol_command_bytes("Document.define_blob", Bytes(digest.toString), bytes)
wenzelm@38412: 
wenzelm@59671:   def define_command(command: Command)
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@54526:           { case Exn.Res((a, b)) =>
wenzelm@60879:               (Nil, pair(Encode.string, option(string))((a.node, b.map(p => p._1.toString)))) },
wenzelm@60879:           { case Exn.Exn(e) => (Nil, Encode.string(Exn.message(e))) }))
wenzelm@59085: 
wenzelm@59685:       YXML.string_of_body(pair(list(encode_blob), int)(command.blobs, command.blobs_index))
wenzelm@54519:     }
wenzelm@59085: 
wenzelm@59085:     val toks = command.span.content
wenzelm@59085:     val toks_yxml =
wenzelm@59085:     { import XML.Encode._
wenzelm@59085:       val encode_tok: T[Token] =
wenzelm@59085:         (tok => pair(int, int)((tok.kind.id, Symbol.iterator(tok.source).length)))
wenzelm@59085:       YXML.string_of_body(list(encode_tok)(toks))
wenzelm@59085:     }
wenzelm@59085: 
wenzelm@52582:     protocol_command("Document.define_command",
wenzelm@59735:       (Document_ID(command.id) :: encode(command.span.name) :: blobs_yxml :: toks_yxml ::
wenzelm@59085:         toks.map(tok => encode(tok.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@44979:           { case Document.Node.Edits(a) => (Nil, list(pair(option(id), option(id)))(a)) },
wenzelm@48707:           { case Document.Node.Deps(header) =>
wenzelm@56449:               val master_dir = Isabelle_System.posix_path_url(name.master_dir)
wenzelm@56801:               val theory = Long_Name.base_name(name.theory)
wenzelm@59695:               val imports = header.imports.map({ case (a, _) => a.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@56801:                 (master_dir, (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@60879:         pair(Encode.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@59364:     { import XML.Encode._
wenzelm@59364:       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@56616: 
wenzelm@56616: 
wenzelm@59364:   /* build_theories */
wenzelm@56616: 
wenzelm@59364:   def build_theories(id: String, master_dir: Path, theories: List[(Options, List[Path])])
wenzelm@59364:   {
wenzelm@59364:     val theories_yxml =
wenzelm@59364:     { import XML.Encode._
wenzelm@59364:       YXML.string_of_body(list(pair(Options.encode, list(Path.encode)))(theories)) }
wenzelm@59364:     protocol_command("build_theories", id, master_dir.implode, theories_yxml)
wenzelm@59364:   }
wenzelm@38412: }