src/Pure/PIDE/isar_document.scala
author wenzelm
Fri Sep 17 17:10:44 2010 +0200 (2010-09-17 ago)
changeset 39441 4110cc1b8f9f
parent 39439 1c294d150ded
child 39511 5f318522e6fe
permissions -rw-r--r--
allow embedded reports in regular prover messages, to avoid side-effects for errors for example;
wenzelm@38483
     1
/*  Title:      Pure/PIDE/isar_document.scala
wenzelm@38412
     2
    Author:     Makarius
wenzelm@38412
     3
wenzelm@38567
     4
Protocol message formats for interactive Isar documents.
wenzelm@38412
     5
*/
wenzelm@38412
     6
wenzelm@38412
     7
package isabelle
wenzelm@38412
     8
wenzelm@38412
     9
wenzelm@38412
    10
object Isar_Document
wenzelm@38412
    11
{
wenzelm@38567
    12
  /* document editing */
wenzelm@38412
    13
wenzelm@38412
    14
  object Assign {
wenzelm@38414
    15
    def unapply(msg: XML.Tree)
wenzelm@38414
    16
        : Option[(Document.Version_ID, List[(Document.Command_ID, Document.Exec_ID)])] =
wenzelm@38412
    17
      msg match {
wenzelm@38414
    18
        case XML.Elem(Markup(Markup.ASSIGN, List((Markup.VERSION, Document.ID(id)))), edits) =>
wenzelm@38412
    19
          val id_edits = edits.map(Edit.unapply)
wenzelm@38414
    20
          if (id_edits.forall(_.isDefined)) Some((id, id_edits.map(_.get)))
wenzelm@38412
    21
          else None
wenzelm@38412
    22
        case _ => None
wenzelm@38412
    23
      }
wenzelm@38412
    24
  }
wenzelm@38412
    25
wenzelm@38412
    26
  object Edit {
wenzelm@38412
    27
    def unapply(msg: XML.Tree): Option[(Document.Command_ID, Document.Exec_ID)] =
wenzelm@38412
    28
      msg match {
wenzelm@38414
    29
        case XML.Elem(
wenzelm@38414
    30
          Markup(Markup.EDIT,
wenzelm@38414
    31
            List((Markup.ID, Document.ID(i)), (Markup.EXEC, Document.ID(j)))), Nil) => Some((i, j))
wenzelm@38412
    32
        case _ => None
wenzelm@38412
    33
      }
wenzelm@38412
    34
  }
wenzelm@38567
    35
wenzelm@38567
    36
wenzelm@38567
    37
  /* toplevel transactions */
wenzelm@38567
    38
wenzelm@38567
    39
  sealed abstract class Status
wenzelm@38567
    40
  case class Forked(forks: Int) extends Status
wenzelm@38567
    41
  case object Unprocessed extends Status
wenzelm@38567
    42
  case object Finished extends Status
wenzelm@38567
    43
  case object Failed extends Status
wenzelm@38567
    44
wenzelm@38581
    45
  def command_status(markup: List[Markup]): Status =
wenzelm@38567
    46
  {
wenzelm@38567
    47
    val forks = (0 /: markup) {
wenzelm@38581
    48
      case (i, Markup(Markup.FORKED, _)) => i + 1
wenzelm@38581
    49
      case (i, Markup(Markup.JOINED, _)) => i - 1
wenzelm@38567
    50
      case (i, _) => i
wenzelm@38567
    51
    }
wenzelm@38567
    52
    if (forks != 0) Forked(forks)
wenzelm@38581
    53
    else if (markup.exists(_.name == Markup.FAILED)) Failed
wenzelm@38581
    54
    else if (markup.exists(_.name == Markup.FINISHED)) Finished
wenzelm@38567
    55
    else Unprocessed
wenzelm@38567
    56
  }
wenzelm@38887
    57
wenzelm@38887
    58
wenzelm@39441
    59
  /* result messages */
wenzelm@39439
    60
wenzelm@39439
    61
  def clean_message(body: XML.Body): XML.Body =
wenzelm@39439
    62
    body filter { case XML.Elem(Markup(Markup.NO_REPORT, _), _) => false case _ => true } map
wenzelm@39439
    63
      { case XML.Elem(markup, ts) => XML.Elem(markup, clean_message(ts)) case t => t }
wenzelm@39439
    64
wenzelm@39441
    65
  def message_reports(msg: XML.Tree): List[XML.Elem] =
wenzelm@39441
    66
    msg match {
wenzelm@39441
    67
      case elem @ XML.Elem(Markup(Markup.REPORT, _), _) => List(elem)
wenzelm@39441
    68
      case XML.Elem(_, body) => body.flatMap(message_reports)
wenzelm@39441
    69
      case XML.Text(_) => Nil
wenzelm@39441
    70
    }
wenzelm@39441
    71
wenzelm@39439
    72
wenzelm@38887
    73
  /* reported positions */
wenzelm@38887
    74
wenzelm@39441
    75
  def is_state(msg: XML.Tree): Boolean =
wenzelm@39170
    76
    msg match {
wenzelm@39170
    77
      case XML.Elem(Markup(Markup.WRITELN, _), List(XML.Elem(Markup(Markup.STATE, _), _))) => true
wenzelm@39170
    78
      case _ => false
wenzelm@39170
    79
    }
wenzelm@39170
    80
wenzelm@39441
    81
  private val include_pos = Set(Markup.BINDING, Markup.ENTITY, Markup.REPORT, Markup.POSITION)
wenzelm@39441
    82
wenzelm@39441
    83
  def message_positions(command: Command, message: XML.Elem): Set[Text.Range] =
wenzelm@38887
    84
  {
wenzelm@39441
    85
    def positions(set: Set[Text.Range], tree: XML.Tree): Set[Text.Range] =
wenzelm@38887
    86
      tree match {
wenzelm@39172
    87
        case XML.Elem(Markup(name, Position.Id_Range(id, raw_range)), body)
wenzelm@39172
    88
        if include_pos(name) && id == command.id =>
wenzelm@39172
    89
          val range = command.decode(raw_range).restrict(command.range)
wenzelm@39441
    90
          body.foldLeft(if (range.is_singularity) set else set + range)(positions)
wenzelm@39441
    91
        case XML.Elem(Markup(name, _), body) => body.foldLeft(set)(positions)
wenzelm@39042
    92
        case _ => set
wenzelm@38887
    93
      }
wenzelm@39441
    94
    val set = positions(Set.empty, message)
wenzelm@39170
    95
    if (set.isEmpty && !is_state(message))
wenzelm@39172
    96
      set ++ Position.Range.unapply(message.markup.properties).map(command.decode(_))
wenzelm@39042
    97
    else set
wenzelm@38887
    98
  }
wenzelm@38412
    99
}
wenzelm@38412
   100
wenzelm@38412
   101
wenzelm@38412
   102
trait Isar_Document extends Isabelle_Process
wenzelm@38412
   103
{
wenzelm@38412
   104
  import Isar_Document._
wenzelm@38412
   105
wenzelm@38412
   106
wenzelm@38412
   107
  /* commands */
wenzelm@38412
   108
wenzelm@38412
   109
  def define_command(id: Document.Command_ID, text: String): Unit =
wenzelm@38414
   110
    input("Isar_Document.define_command", Document.ID(id), text)
wenzelm@38412
   111
wenzelm@38412
   112
wenzelm@38417
   113
  /* document versions */
wenzelm@38412
   114
wenzelm@38417
   115
  def edit_version(old_id: Document.Version_ID, new_id: Document.Version_ID,
wenzelm@38412
   116
      edits: List[Document.Edit[Document.Command_ID]])
wenzelm@38412
   117
  {
wenzelm@38412
   118
    val arg =
wenzelm@38412
   119
      XML_Data.make_list(
wenzelm@38412
   120
        XML_Data.make_pair(XML_Data.make_string)(
wenzelm@38412
   121
          XML_Data.make_option(XML_Data.make_list(
wenzelm@38448
   122
              XML_Data.make_pair(
wenzelm@38448
   123
                XML_Data.make_option(XML_Data.make_long))(
wenzelm@38448
   124
                XML_Data.make_option(XML_Data.make_long))))))(edits)
wenzelm@38412
   125
wenzelm@38417
   126
    input("Isar_Document.edit_version",
wenzelm@38414
   127
      Document.ID(old_id), Document.ID(new_id), YXML.string_of_body(arg))
wenzelm@38412
   128
  }
wenzelm@38412
   129
}