src/Pure/PIDE/command.scala
author wenzelm
Tue Apr 08 19:17:28 2014 +0200 (2014-04-08 ago)
changeset 56470 8eda56033203
parent 56469 ffc94a271633
child 56473 5b5c750e9763
permissions -rw-r--r--
accumulate markup reports for "other" command ids, which are later retargeted and merged for rendering (in erratic order);
wenzelm@36676
     1
/*  Title:      Pure/PIDE/command.scala
wenzelm@36676
     2
    Author:     Fabian Immler, TU Munich
wenzelm@36676
     3
    Author:     Makarius
wenzelm@36676
     4
wenzelm@52536
     5
Prover commands with accumulated results from execution.
wenzelm@36676
     6
*/
wenzelm@34407
     7
wenzelm@34871
     8
package isabelle
wenzelm@34318
     9
wenzelm@34451
    10
wenzelm@45644
    11
import scala.collection.mutable
wenzelm@38872
    12
import scala.collection.immutable.SortedMap
wenzelm@38872
    13
wenzelm@38872
    14
wenzelm@34637
    15
object Command
wenzelm@34637
    16
{
wenzelm@52849
    17
  type Edit = (Option[Command], Option[Command])
wenzelm@56468
    18
  type Blob = Exn.Result[(Document.Node.Name, Option[(SHA1.Digest, Text.Chunk.File)])]
wenzelm@55648
    19
wenzelm@52849
    20
wenzelm@52849
    21
wenzelm@38361
    22
  /** accumulated results from prover **/
wenzelm@38361
    23
wenzelm@50507
    24
  /* results */
wenzelm@50507
    25
wenzelm@50507
    26
  object Results
wenzelm@50507
    27
  {
wenzelm@51496
    28
    type Entry = (Long, XML.Tree)
wenzelm@50507
    29
    val empty = new Results(SortedMap.empty)
wenzelm@56299
    30
    def make(es: List[Results.Entry]): Results = (empty /: es)(_ + _)
wenzelm@56299
    31
    def merge(rs: List[Results]): Results = (empty /: rs)(_ ++ _)
wenzelm@50507
    32
  }
wenzelm@50507
    33
wenzelm@51494
    34
  final class Results private(private val rep: SortedMap[Long, XML.Tree])
wenzelm@50507
    35
  {
wenzelm@50507
    36
    def defined(serial: Long): Boolean = rep.isDefinedAt(serial)
wenzelm@50507
    37
    def get(serial: Long): Option[XML.Tree] = rep.get(serial)
wenzelm@56372
    38
    def iterator: Iterator[Results.Entry] = rep.iterator
wenzelm@50508
    39
wenzelm@51496
    40
    def + (entry: Results.Entry): Results =
wenzelm@50508
    41
      if (defined(entry._1)) this
wenzelm@50508
    42
      else new Results(rep + entry)
wenzelm@50508
    43
wenzelm@50508
    44
    def ++ (other: Results): Results =
wenzelm@50508
    45
      if (this eq other) this
wenzelm@50508
    46
      else if (rep.isEmpty) other
wenzelm@56372
    47
      else (this /: other.iterator)(_ + _)
wenzelm@50540
    48
wenzelm@51494
    49
    override def hashCode: Int = rep.hashCode
wenzelm@51494
    50
    override def equals(that: Any): Boolean =
wenzelm@51494
    51
      that match {
wenzelm@51494
    52
        case other: Results => rep == other.rep
wenzelm@51494
    53
        case _ => false
wenzelm@51494
    54
      }
wenzelm@56372
    55
    override def toString: String = iterator.mkString("Results(", ", ", ")")
wenzelm@50507
    56
  }
wenzelm@50507
    57
wenzelm@50507
    58
wenzelm@55649
    59
  /* markup */
wenzelm@55649
    60
wenzelm@55649
    61
  object Markup_Index
wenzelm@55649
    62
  {
wenzelm@56468
    63
    val markup: Markup_Index = Markup_Index(false, Text.Chunk.Default)
wenzelm@55649
    64
  }
wenzelm@55649
    65
wenzelm@56468
    66
  sealed case class Markup_Index(status: Boolean, chunk_name: Text.Chunk.Name)
wenzelm@55649
    67
wenzelm@55649
    68
  object Markups
wenzelm@55649
    69
  {
wenzelm@55649
    70
    val empty: Markups = new Markups(Map.empty)
wenzelm@55649
    71
wenzelm@55649
    72
    def init(markup: Markup_Tree): Markups =
wenzelm@55649
    73
      new Markups(Map(Markup_Index.markup -> markup))
wenzelm@55649
    74
  }
wenzelm@55649
    75
wenzelm@55649
    76
  final class Markups private(private val rep: Map[Markup_Index, Markup_Tree])
wenzelm@55649
    77
  {
wenzelm@55649
    78
    def apply(index: Markup_Index): Markup_Tree =
wenzelm@55649
    79
      rep.getOrElse(index, Markup_Tree.empty)
wenzelm@55649
    80
wenzelm@55649
    81
    def add(index: Markup_Index, markup: Text.Markup): Markups =
wenzelm@55649
    82
      new Markups(rep + (index -> (this(index) + markup)))
wenzelm@55649
    83
wenzelm@56470
    84
    def other_id_iterator: Iterator[Document_ID.Generic] =
wenzelm@56470
    85
      for (Markup_Index(_, Text.Chunk.Id(other_id)) <- rep.keysIterator)
wenzelm@56470
    86
        yield other_id
wenzelm@56470
    87
wenzelm@56470
    88
    def retarget(other_id: Document_ID.Generic): Markups =
wenzelm@56470
    89
      new Markups(
wenzelm@56470
    90
        (for {
wenzelm@56470
    91
          (Markup_Index(status, Text.Chunk.Id(id)), markup) <- rep.iterator
wenzelm@56470
    92
          if other_id == id
wenzelm@56470
    93
        } yield (Markup_Index(status, Text.Chunk.Default), markup)).toMap)
wenzelm@56470
    94
wenzelm@55649
    95
    override def hashCode: Int = rep.hashCode
wenzelm@55649
    96
    override def equals(that: Any): Boolean =
wenzelm@55649
    97
      that match {
wenzelm@55649
    98
        case other: Markups => rep == other.rep
wenzelm@55649
    99
        case _ => false
wenzelm@55649
   100
      }
wenzelm@55649
   101
    override def toString: String = rep.iterator.mkString("Markups(", ", ", ")")
wenzelm@55649
   102
  }
wenzelm@55649
   103
wenzelm@55649
   104
wenzelm@50507
   105
  /* state */
wenzelm@50501
   106
wenzelm@56299
   107
  object State
wenzelm@56299
   108
  {
wenzelm@56299
   109
    def merge_results(states: List[State]): Command.Results =
wenzelm@56299
   110
      Results.merge(states.map(_.results))
wenzelm@56299
   111
wenzelm@56301
   112
    def merge_markup(states: List[State], index: Markup_Index,
wenzelm@56301
   113
        range: Text.Range, elements: Document.Elements): Markup_Tree =
wenzelm@56301
   114
      Markup_Tree.merge(states.map(_.markup(index)), range, elements)
wenzelm@56299
   115
  }
wenzelm@56299
   116
wenzelm@43714
   117
  sealed case class State(
wenzelm@50501
   118
    command: Command,
wenzelm@50501
   119
    status: List[Markup] = Nil,
wenzelm@50507
   120
    results: Results = Results.empty,
wenzelm@55649
   121
    markups: Markups = Markups.empty)
wenzelm@38361
   122
  {
wenzelm@56395
   123
    lazy val protocol_status: Protocol.Status =
wenzelm@56395
   124
    {
wenzelm@56395
   125
      val warnings =
wenzelm@56395
   126
        if (results.iterator.exists(p => Protocol.is_warning(p._2)))
wenzelm@56395
   127
          List(Markup(Markup.WARNING, Nil))
wenzelm@56395
   128
        else Nil
wenzelm@56395
   129
      val errors =
wenzelm@56395
   130
        if (results.iterator.exists(p => Protocol.is_error(p._2)))
wenzelm@56395
   131
          List(Markup(Markup.ERROR, Nil))
wenzelm@56395
   132
        else Nil
wenzelm@56395
   133
      Protocol.Status.make((warnings ::: errors ::: status).iterator)
wenzelm@56395
   134
    }
wenzelm@55432
   135
wenzelm@55650
   136
    def markup(index: Markup_Index): Markup_Tree = markups(index)
wenzelm@55432
   137
wenzelm@56470
   138
    def retarget(other_command: Command): State =
wenzelm@56470
   139
      new State(other_command, Nil, Results.empty, markups.retarget(other_command.id))
wenzelm@56470
   140
wenzelm@49614
   141
wenzelm@51494
   142
    def eq_content(other: State): Boolean =
wenzelm@51494
   143
      command.source == other.command.source &&
wenzelm@51494
   144
      status == other.status &&
wenzelm@51494
   145
      results == other.results &&
wenzelm@55434
   146
      markups == other.markups
wenzelm@38361
   147
wenzelm@55649
   148
    private def add_status(st: Markup): State =
wenzelm@55649
   149
      copy(status = st :: status)
wenzelm@55432
   150
wenzelm@56468
   151
    private def add_markup(status: Boolean, chunk_name: Text.Chunk.Name, m: Text.Markup): State =
wenzelm@55649
   152
    {
wenzelm@55649
   153
      val markups1 =
wenzelm@56395
   154
        if (status || Protocol.liberal_status_elements(m.info.name))
wenzelm@56462
   155
          markups.add(Markup_Index(true, chunk_name), m)
wenzelm@55649
   156
        else markups
wenzelm@56462
   157
      copy(markups = markups1.add(Markup_Index(false, chunk_name), m))
wenzelm@55649
   158
    }
wenzelm@38361
   159
wenzelm@56470
   160
    def accumulate(
wenzelm@56470
   161
        self_id: Document_ID.Generic => Boolean,
wenzelm@56470
   162
        other_id: Document_ID.Generic => Option[(Text.Chunk.Id, Text.Chunk)],
wenzelm@56470
   163
        message: XML.Elem): State =
wenzelm@38361
   164
      message match {
wenzelm@50201
   165
        case XML.Elem(Markup(Markup.STATUS, _), msgs) =>
wenzelm@38714
   166
          (this /: msgs)((state, msg) =>
wenzelm@38714
   167
            msg match {
wenzelm@46152
   168
              case elem @ XML.Elem(markup, Nil) =>
wenzelm@55649
   169
                state.
wenzelm@55649
   170
                  add_status(markup).
wenzelm@56468
   171
                  add_markup(true, Text.Chunk.Default, Text.Info(command.proper_range, elem))
wenzelm@52536
   172
              case _ =>
wenzelm@55618
   173
                System.err.println("Ignored status message: " + msg)
wenzelm@52536
   174
                state
wenzelm@38714
   175
            })
wenzelm@38581
   176
wenzelm@50201
   177
        case XML.Elem(Markup(Markup.REPORT, _), msgs) =>
wenzelm@38572
   178
          (this /: msgs)((state, msg) =>
wenzelm@55432
   179
            {
wenzelm@55618
   180
              def bad(): Unit = System.err.println("Ignored report message: " + msg)
wenzelm@55432
   181
wenzelm@55432
   182
              msg match {
wenzelm@56470
   183
                case XML.Elem(
wenzelm@56470
   184
                    Markup(name, atts @ Position.Reported(id, chunk_name, symbol_range)), args) =>
wenzelm@56470
   185
wenzelm@56470
   186
                  val target =
wenzelm@56470
   187
                    if (self_id(id) && command.chunks.isDefinedAt(chunk_name))
wenzelm@56470
   188
                      Some((chunk_name, command.chunks(chunk_name)))
wenzelm@56470
   189
                    else if (chunk_name == Text.Chunk.Default) other_id(id)
wenzelm@56470
   190
                    else None
wenzelm@56470
   191
wenzelm@56470
   192
                  target match {
wenzelm@56470
   193
                    case Some((target_name, target_chunk)) =>
wenzelm@56470
   194
                      target_chunk.incorporate(symbol_range) match {
wenzelm@55550
   195
                        case Some(range) =>
wenzelm@55822
   196
                          val props = Position.purge(atts)
wenzelm@55822
   197
                          val info = Text.Info(range, XML.Elem(Markup(name, props), args))
wenzelm@56470
   198
                          state.add_markup(false, target_name, info)
wenzelm@55550
   199
                        case None => bad(); state
wenzelm@55432
   200
                      }
wenzelm@56470
   201
                    case None => /* FIXME bad(); */ state
wenzelm@55432
   202
                  }
wenzelm@55432
   203
wenzelm@55432
   204
                case XML.Elem(Markup(name, atts), args)
wenzelm@55432
   205
                if !atts.exists({ case (a, _) => Markup.POSITION_PROPERTIES(a) }) =>
wenzelm@55432
   206
                  val range = command.proper_range
wenzelm@55432
   207
                  val props = Position.purge(atts)
wenzelm@55432
   208
                  val info: Text.Markup = Text.Info(range, XML.Elem(Markup(name, props), args))
wenzelm@56468
   209
                  state.add_markup(false, Text.Chunk.Default, info)
wenzelm@55432
   210
wenzelm@56470
   211
                case _ => bad(); state
wenzelm@55432
   212
              }
wenzelm@38361
   213
            })
wenzelm@52930
   214
        case XML.Elem(Markup(name, props), body) =>
wenzelm@52930
   215
          props match {
wenzelm@50201
   216
            case Markup.Serial(i) =>
wenzelm@50201
   217
              val message1 = XML.Elem(Markup(Markup.message(name), props), body)
wenzelm@50163
   218
              val message2 = XML.Elem(Markup(name, props), body)
wenzelm@50163
   219
wenzelm@55433
   220
              var st = copy(results = results + (i -> message1))
wenzelm@55433
   221
              if (Protocol.is_inlined(message)) {
wenzelm@55433
   222
                for {
wenzelm@56469
   223
                  (chunk_name, chunk) <- command.chunks.iterator
wenzelm@56470
   224
                  range <- Protocol.message_positions(self_id, chunk_name, chunk, message)
wenzelm@56462
   225
                } st = st.add_markup(false, chunk_name, Text.Info(range, message2))
wenzelm@55433
   226
              }
wenzelm@55433
   227
              st
wenzelm@55432
   228
wenzelm@52536
   229
            case _ =>
wenzelm@55618
   230
              System.err.println("Ignored message without serial number: " + message)
wenzelm@52536
   231
              this
wenzelm@38872
   232
          }
wenzelm@56295
   233
    }
wenzelm@38361
   234
  }
wenzelm@38367
   235
wenzelm@38367
   236
wenzelm@55431
   237
wenzelm@55431
   238
  /** static content **/
wenzelm@55431
   239
wenzelm@45644
   240
  /* make commands */
wenzelm@45644
   241
wenzelm@54462
   242
  def name(span: List[Token]): String =
wenzelm@54462
   243
    span.find(_.is_command) match { case Some(tok) => tok.source case _ => "" }
wenzelm@48745
   244
wenzelm@55648
   245
  private def source_span(span: List[Token]): (String, List[Token]) =
wenzelm@45644
   246
  {
wenzelm@45644
   247
    val source: String =
wenzelm@48745
   248
      span match {
wenzelm@45644
   249
        case List(tok) => tok.source
wenzelm@48745
   250
        case _ => span.map(_.source).mkString
wenzelm@45644
   251
      }
wenzelm@45644
   252
wenzelm@48745
   253
    val span1 = new mutable.ListBuffer[Token]
wenzelm@45644
   254
    var i = 0
wenzelm@48745
   255
    for (Token(kind, s) <- span) {
wenzelm@45644
   256
      val n = s.length
wenzelm@45644
   257
      val s1 = source.substring(i, i + n)
wenzelm@48745
   258
      span1 += Token(kind, s1)
wenzelm@45644
   259
      i += n
wenzelm@45644
   260
    }
wenzelm@55648
   261
    (source, span1.toList)
wenzelm@45644
   262
  }
wenzelm@45644
   263
wenzelm@55648
   264
  def apply(
wenzelm@55648
   265
    id: Document_ID.Command,
wenzelm@55648
   266
    node_name: Document.Node.Name,
wenzelm@55648
   267
    blobs: List[Blob],
wenzelm@55648
   268
    span: List[Token]): Command =
wenzelm@55648
   269
  {
wenzelm@55648
   270
    val (source, span1) = source_span(span)
wenzelm@55648
   271
    new Command(id, node_name, blobs, span1, source, Results.empty, Markup_Tree.empty)
wenzelm@55648
   272
  }
wenzelm@49414
   273
wenzelm@55648
   274
  val empty: Command = Command(Document_ID.none, Document.Node.Name.empty, Nil, Nil)
wenzelm@55648
   275
wenzelm@55648
   276
  def unparsed(
wenzelm@55648
   277
    id: Document_ID.Command,
wenzelm@55648
   278
    source: String,
wenzelm@55648
   279
    results: Results,
wenzelm@55648
   280
    markup: Markup_Tree): Command =
wenzelm@55648
   281
  {
wenzelm@55648
   282
    val (source1, span) = source_span(List(Token(Token.Kind.UNPARSED, source)))
wenzelm@55648
   283
    new Command(id, Document.Node.Name.empty, Nil, span, source1, results, markup)
wenzelm@55648
   284
  }
wenzelm@49414
   285
wenzelm@50501
   286
  def unparsed(source: String): Command =
wenzelm@52530
   287
    unparsed(Document_ID.none, source, Results.empty, Markup_Tree.empty)
wenzelm@44384
   288
wenzelm@52530
   289
  def rich_text(id: Document_ID.Command, results: Results, body: XML.Body): Command =
wenzelm@49414
   290
  {
wenzelm@49466
   291
    val text = XML.content(body)
wenzelm@49466
   292
    val markup = Markup_Tree.from_XML(body)
wenzelm@50501
   293
    unparsed(id, text, results, markup)
wenzelm@49414
   294
  }
wenzelm@49359
   295
wenzelm@44384
   296
wenzelm@44384
   297
  /* perspective */
wenzelm@44384
   298
wenzelm@44474
   299
  object Perspective
wenzelm@44474
   300
  {
wenzelm@44474
   301
    val empty: Perspective = Perspective(Nil)
wenzelm@44474
   302
  }
wenzelm@44385
   303
wenzelm@44474
   304
  sealed case class Perspective(commands: List[Command])  // visible commands in canonical order
wenzelm@44385
   305
  {
wenzelm@44474
   306
    def same(that: Perspective): Boolean =
wenzelm@44474
   307
    {
wenzelm@44474
   308
      val cmds1 = this.commands
wenzelm@44474
   309
      val cmds2 = that.commands
wenzelm@48754
   310
      require(!cmds1.exists(_.is_undefined))
wenzelm@48754
   311
      require(!cmds2.exists(_.is_undefined))
wenzelm@44474
   312
      cmds1.length == cmds2.length &&
wenzelm@44474
   313
        (cmds1.iterator zip cmds2.iterator).forall({ case (c1, c2) => c1.id == c2.id })
wenzelm@44474
   314
    }
wenzelm@44385
   315
  }
wenzelm@34318
   316
}
wenzelm@34318
   317
wenzelm@38361
   318
wenzelm@46712
   319
final class Command private(
wenzelm@52530
   320
    val id: Document_ID.Command,
wenzelm@44615
   321
    val node_name: Document.Node.Name,
wenzelm@54519
   322
    val blobs: List[Command.Blob],
wenzelm@52535
   323
    val span: List[Token],
wenzelm@49414
   324
    val source: String,
wenzelm@50501
   325
    val init_results: Command.Results,
wenzelm@49414
   326
    val init_markup: Markup_Tree)
wenzelm@34451
   327
{
wenzelm@34859
   328
  /* classification */
wenzelm@34500
   329
wenzelm@52530
   330
  def is_undefined: Boolean = id == Document_ID.none
wenzelm@48754
   331
  val is_unparsed: Boolean = span.exists(_.is_unparsed)
wenzelm@48754
   332
  val is_unfinished: Boolean = span.exists(_.is_unfinished)
wenzelm@44385
   333
wenzelm@48599
   334
  val is_ignored: Boolean = !span.exists(_.is_proper)
wenzelm@48754
   335
  val is_malformed: Boolean = !is_ignored && (!span.head.is_command || span.exists(_.is_error))
wenzelm@47012
   336
  def is_command: Boolean = !is_ignored && !is_malformed
wenzelm@34859
   337
wenzelm@54462
   338
  def name: String = Command.name(span)
wenzelm@47012
   339
wenzelm@37129
   340
  override def toString =
wenzelm@37373
   341
    id + "/" + (if (is_command) name else if (is_ignored) "IGNORED" else "MALFORMED")
wenzelm@34495
   342
wenzelm@34859
   343
wenzelm@54519
   344
  /* blobs */
wenzelm@54519
   345
wenzelm@55785
   346
  def blobs_changed(doc_blobs: Document.Blobs): Boolean =
wenzelm@55785
   347
    blobs.exists({ case Exn.Res((name, _)) => doc_blobs.changed(name) case _ => false })
wenzelm@55785
   348
wenzelm@54530
   349
  def blobs_names: List[Document.Node.Name] =
wenzelm@54530
   350
    for (Exn.Res((name, _)) <- blobs) yield name
wenzelm@54530
   351
wenzelm@54519
   352
  def blobs_digests: List[SHA1.Digest] =
wenzelm@55431
   353
    for (Exn.Res((_, Some((digest, _)))) <- blobs) yield digest
wenzelm@54519
   354
wenzelm@55432
   355
wenzelm@56462
   356
  /* source chunks */
wenzelm@55431
   357
wenzelm@46813
   358
  def length: Int = source.length
wenzelm@46813
   359
  val range: Text.Range = Text.Range(0, length)
wenzelm@46813
   360
wenzelm@46813
   361
  val proper_range: Text.Range =
wenzelm@51048
   362
    Text.Range(0, (length /: span.reverse.iterator.takeWhile(_.is_improper))(_ - _.source.length))
wenzelm@46813
   363
wenzelm@38426
   364
  def source(range: Text.Range): String = source.substring(range.start, range.stop)
wenzelm@38572
   365
wenzelm@56468
   366
  val chunk: Text.Chunk =
wenzelm@56468
   367
    new Text.Chunk {
wenzelm@56462
   368
      def range: Text.Range = Command.this.range
wenzelm@56462
   369
      lazy val symbol_index = Symbol.Index(source)
wenzelm@56462
   370
    }
wenzelm@56462
   371
wenzelm@56468
   372
  val chunks: Map[Text.Chunk.Name, Text.Chunk] =
wenzelm@56468
   373
    ((Text.Chunk.Default -> chunk) ::
wenzelm@56462
   374
      (for (Exn.Res((name, Some((_, file)))) <- blobs)
wenzelm@56468
   375
        yield (Text.Chunk.File_Name(name.node) -> file))).toMap
wenzelm@38370
   376
wenzelm@38370
   377
wenzelm@38370
   378
  /* accumulated results */
wenzelm@38370
   379
wenzelm@50501
   380
  val init_state: Command.State =
wenzelm@55649
   381
    Command.State(this, results = init_results, markups = Command.Markups.init(init_markup))
wenzelm@52527
   382
wenzelm@52527
   383
  val empty_state: Command.State = Command.State(this)
immler@34676
   384
}