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@44476:   object Assign
wenzelm@44476:   {
wenzelm@44661:     def unapply(text: String): Option[(Document.Version_ID, Document.Assign)] =
wenzelm@44661:       try {
wenzelm@44661:         import XML.Decode._
wenzelm@44661:         val body = YXML.parse_body(text)
wenzelm@44661:         Some(pair(long, pair(list(pair(long, option(long))), list(pair(string, option(long)))))(body))
wenzelm@44661:       }
wenzelm@44661:       catch {
wenzelm@44661:         case ERROR(_) => None
wenzelm@44661:         case _: XML.XML_Atom => None
wenzelm@44661:         case _: XML.XML_Body => None
wenzelm@38412:       }
wenzelm@38412:   }
wenzelm@38567: 
wenzelm@44676:   object Removed
wenzelm@44676:   {
wenzelm@44676:     def unapply(text: String): Option[List[Document.Version_ID]] =
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@44676:         case _: XML.XML_Atom => None
wenzelm@44676:         case _: XML.XML_Body => 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@46910:     private val parsed: Boolean = false,
wenzelm@46166:     private val finished: Boolean = false,
wenzelm@46166:     private val failed: Boolean = false,
wenzelm@46166:     forks: Int = 0)
wenzelm@38567:   {
wenzelm@46910:     def is_unprocessed: Boolean = parsed && !finished && !failed && forks == 0
wenzelm@46166:     def is_running: Boolean = forks != 0
wenzelm@46166:     def is_finished: Boolean = finished && forks == 0
wenzelm@46166:     def is_failed: Boolean = failed && forks == 0
wenzelm@46227:     def + (that: Status): Status =
wenzelm@46910:       Status(parsed || that.parsed, finished || that.finished,
wenzelm@46910:         failed || that.failed, forks + that.forks)
wenzelm@46166:   }
wenzelm@46166: 
wenzelm@46166:   val command_status_markup: Set[String] =
wenzelm@46910:     Set(Isabelle_Markup.PARSED, Isabelle_Markup.FINISHED, Isabelle_Markup.FAILED,
wenzelm@46166:       Isabelle_Markup.FORKED, Isabelle_Markup.JOINED)
wenzelm@46166: 
wenzelm@46166:   def command_status(status: Status, markup: Markup): Status =
wenzelm@46166:     markup match {
wenzelm@46910:       case Markup(Isabelle_Markup.PARSED, _) => status.copy(parsed = true)
wenzelm@46166:       case Markup(Isabelle_Markup.FINISHED, _) => status.copy(finished = true)
wenzelm@46166:       case Markup(Isabelle_Markup.FAILED, _) => status.copy(failed = true)
wenzelm@46166:       case Markup(Isabelle_Markup.FORKED, _) => status.copy(forks = status.forks + 1)
wenzelm@46166:       case Markup(Isabelle_Markup.JOINED, _) => status.copy(forks = status.forks - 1)
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@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@46688:           if (st.results.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@39441:   /* result messages */
wenzelm@39439: 
wenzelm@39439:   def clean_message(body: XML.Body): XML.Body =
wenzelm@45666:     body filter { case XML.Elem(Markup(Isabelle_Markup.NO_REPORT, _), _) => false case _ => true } map
wenzelm@39439:       { case XML.Elem(markup, ts) => XML.Elem(markup, clean_message(ts)) case t => t }
wenzelm@39439: 
wenzelm@39441:   def message_reports(msg: XML.Tree): List[XML.Elem] =
wenzelm@39441:     msg match {
wenzelm@45666:       case elem @ XML.Elem(Markup(Isabelle_Markup.REPORT, _), _) => List(elem)
wenzelm@39441:       case XML.Elem(_, body) => body.flatMap(message_reports)
wenzelm@39441:       case XML.Text(_) => Nil
wenzelm@39441:     }
wenzelm@39441: 
wenzelm@39439: 
wenzelm@39511:   /* specific messages */
wenzelm@39511: 
wenzelm@39625:  def is_tracing(msg: XML.Tree): Boolean =
wenzelm@39622:     msg match {
wenzelm@45666:       case XML.Elem(Markup(Isabelle_Markup.TRACING, _), _) => true
wenzelm@39622:       case _ => false
wenzelm@39622:     }
wenzelm@39622: 
wenzelm@39511:   def is_warning(msg: XML.Tree): Boolean =
wenzelm@39511:     msg match {
wenzelm@45666:       case XML.Elem(Markup(Isabelle_Markup.WARNING, _), _) => true
wenzelm@39511:       case _ => false
wenzelm@39511:     }
wenzelm@39511: 
wenzelm@39511:   def is_error(msg: XML.Tree): Boolean =
wenzelm@39511:     msg match {
wenzelm@45666:       case XML.Elem(Markup(Isabelle_Markup.ERROR, _), _) => true
wenzelm@39511:       case _ => false
wenzelm@39511:     }
wenzelm@38887: 
wenzelm@39441:   def is_state(msg: XML.Tree): Boolean =
wenzelm@39170:     msg match {
wenzelm@45666:       case XML.Elem(Markup(Isabelle_Markup.WRITELN, _),
wenzelm@45666:         List(XML.Elem(Markup(Isabelle_Markup.STATE, _), _))) => true
wenzelm@39170:       case _ => false
wenzelm@39170:     }
wenzelm@39170: 
wenzelm@39511: 
wenzelm@39511:   /* reported positions */
wenzelm@39511: 
wenzelm@39627:   private val include_pos =
wenzelm@45666:     Set(Isabelle_Markup.BINDING, Isabelle_Markup.ENTITY, Isabelle_Markup.REPORT,
wenzelm@45666:       Isabelle_Markup.POSITION)
wenzelm@39441: 
wenzelm@39441:   def message_positions(command: Command, message: XML.Elem): Set[Text.Range] =
wenzelm@38887:   {
wenzelm@39441:     def positions(set: Set[Text.Range], tree: XML.Tree): Set[Text.Range] =
wenzelm@38887:       tree match {
wenzelm@39172:         case XML.Elem(Markup(name, Position.Id_Range(id, raw_range)), body)
wenzelm@39172:         if include_pos(name) && id == command.id =>
wenzelm@39172:           val range = command.decode(raw_range).restrict(command.range)
wenzelm@39441:           body.foldLeft(if (range.is_singularity) set else set + range)(positions)
wenzelm@39441:         case XML.Elem(Markup(name, _), body) => body.foldLeft(set)(positions)
wenzelm@39042:         case _ => set
wenzelm@38887:       }
wenzelm@39441:     val set = positions(Set.empty, message)
wenzelm@39170:     if (set.isEmpty && !is_state(message))
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@38412:   /* commands */
wenzelm@38412: 
wenzelm@44644:   def define_command(command: Command): Unit =
wenzelm@45709:     input("Document.define_command",
wenzelm@44644:       Document.ID(command.id), Symbol.encode(command.name), Symbol.encode(command.source))
wenzelm@38412: 
wenzelm@38412: 
wenzelm@38417:   /* document versions */
wenzelm@38412: 
wenzelm@47343:   def discontinue_execution() { input("Document.discontinue_execution") }
wenzelm@47343: 
wenzelm@47343:   def cancel_execution() { input("Document.cancel_execution") }
wenzelm@44612: 
wenzelm@44436:   def update_perspective(old_id: Document.Version_ID, new_id: Document.Version_ID,
wenzelm@44615:     name: Document.Node.Name, perspective: Command.Perspective)
wenzelm@44436:   {
wenzelm@44436:     val ids =
wenzelm@44436:     { import XML.Encode._
wenzelm@44474:       list(long)(perspective.commands.map(_.id)) }
wenzelm@44436: 
wenzelm@45709:     input("Document.update_perspective", Document.ID(old_id), Document.ID(new_id),
wenzelm@44615:       name.node, YXML.string_of_body(ids))
wenzelm@44436:   }
wenzelm@44436: 
wenzelm@44481:   def update(old_id: Document.Version_ID, new_id: Document.Version_ID,
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@46770:       def symbol_string: T[String] = (s => string(Symbol.encode(s)))
wenzelm@46737:       def encode_edit(name: Document.Node.Name)
wenzelm@44979:           : T[Document.Node.Edit[(Option[Command], Option[Command]), Command.Perspective]] =
wenzelm@44979:         variant(List(
wenzelm@44979:           { case Document.Node.Clear() => (Nil, Nil) },
wenzelm@44979:           { case Document.Node.Edits(a) => (Nil, list(pair(option(id), option(id)))(a)) },
wenzelm@46737:           { case Document.Node.Header(Exn.Res(deps)) =>
wenzelm@46770:               val dir = Isabelle_System.posix_path(name.dir)
wenzelm@46737:               val imports = deps.imports.map(_.node)
wenzelm@46770:               // FIXME val uses = deps.uses.map(p => (Isabelle_System.posix_path(p._1), p._2))
wenzelm@46770:               val uses = deps.uses
wenzelm@44979:               (Nil,
wenzelm@46938:                 pair(pair(pair(pair(symbol_string, symbol_string), list(symbol_string)),
wenzelm@46938:                   list(pair(symbol_string, option(pair(symbol_string, list(symbol_string)))))),
wenzelm@46938:                     list(pair(symbol_string, bool)))(
wenzelm@46938:                 (((dir, name.theory), imports), deps.keywords), uses)) },
wenzelm@46755:           { case Document.Node.Header(Exn.Exn(e)) => (List(Symbol.encode(Exn.message(e))), Nil) },
wenzelm@44979:           { case Document.Node.Perspective(a) => (a.commands.map(c => long_atom(c.id)), Nil) }))
wenzelm@44979:       def encode: 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@44157:       YXML.string_of_body(encode(edits)) }
wenzelm@45709:     input("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@45709:     input("Document.remove_versions", versions_yxml)
wenzelm@44673:   }
wenzelm@44673: 
wenzelm@43748: 
wenzelm@43748:   /* method invocation service */
wenzelm@43748: 
wenzelm@43748:   def invoke_scala(id: String, tag: Invoke_Scala.Tag.Value, res: String)
wenzelm@43748:   {
wenzelm@45709:     input("Document.invoke_scala", id, tag.toString, res)
wenzelm@43748:   }
wenzelm@38412: }