src/Pure/PIDE/command.scala
author wenzelm
Wed Jul 23 13:01:30 2014 +0200 (2014-07-23 ago)
changeset 57615 df1b3452d71c
parent 56782 433cf57550fa
child 57842 8e4ae2db1849
permissions -rw-r--r--
more explicit discrimination of empty nodes -- suppress from Theories panel;
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@56746
    18
  type Blob = Exn.Result[(Document.Node.Name, Option[(SHA1.Digest, Symbol.Text_Chunk)])]
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@56746
    63
    val markup: Markup_Index = Markup_Index(false, Symbol.Text_Chunk.Default)
wenzelm@55649
    64
  }
wenzelm@55649
    65
wenzelm@56746
    66
  sealed case class Markup_Index(status: Boolean, chunk_name: Symbol.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@56489
    78
    def is_empty: Boolean = rep.isEmpty
wenzelm@56489
    79
wenzelm@55649
    80
    def apply(index: Markup_Index): Markup_Tree =
wenzelm@55649
    81
      rep.getOrElse(index, Markup_Tree.empty)
wenzelm@55649
    82
wenzelm@55649
    83
    def add(index: Markup_Index, markup: Text.Markup): Markups =
wenzelm@55649
    84
      new Markups(rep + (index -> (this(index) + markup)))
wenzelm@55649
    85
wenzelm@56475
    86
    def redirection_iterator: Iterator[Document_ID.Generic] =
wenzelm@56746
    87
      for (Markup_Index(_, Symbol.Text_Chunk.Id(id)) <- rep.keysIterator)
wenzelm@56475
    88
        yield id
wenzelm@56470
    89
wenzelm@56475
    90
    def redirect(other_id: Document_ID.Generic): Markups =
wenzelm@56489
    91
    {
wenzelm@56489
    92
      val rep1 =
wenzelm@56470
    93
        (for {
wenzelm@56746
    94
          (Markup_Index(status, Symbol.Text_Chunk.Id(id)), markup) <- rep.iterator
wenzelm@56470
    95
          if other_id == id
wenzelm@56746
    96
        } yield (Markup_Index(status, Symbol.Text_Chunk.Default), markup)).toMap
wenzelm@56489
    97
      if (rep1.isEmpty) Markups.empty else new Markups(rep1)
wenzelm@56489
    98
    }
wenzelm@56470
    99
wenzelm@55649
   100
    override def hashCode: Int = rep.hashCode
wenzelm@55649
   101
    override def equals(that: Any): Boolean =
wenzelm@55649
   102
      that match {
wenzelm@55649
   103
        case other: Markups => rep == other.rep
wenzelm@55649
   104
        case _ => false
wenzelm@55649
   105
      }
wenzelm@55649
   106
    override def toString: String = rep.iterator.mkString("Markups(", ", ", ")")
wenzelm@55649
   107
  }
wenzelm@55649
   108
wenzelm@55649
   109
wenzelm@50507
   110
  /* state */
wenzelm@50501
   111
wenzelm@56299
   112
  object State
wenzelm@56299
   113
  {
wenzelm@56299
   114
    def merge_results(states: List[State]): Command.Results =
wenzelm@56299
   115
      Results.merge(states.map(_.results))
wenzelm@56299
   116
wenzelm@56301
   117
    def merge_markup(states: List[State], index: Markup_Index,
wenzelm@56743
   118
        range: Text.Range, elements: Markup.Elements): Markup_Tree =
wenzelm@56301
   119
      Markup_Tree.merge(states.map(_.markup(index)), range, elements)
wenzelm@56299
   120
  }
wenzelm@56299
   121
wenzelm@43714
   122
  sealed case class State(
wenzelm@50501
   123
    command: Command,
wenzelm@50501
   124
    status: List[Markup] = Nil,
wenzelm@50507
   125
    results: Results = Results.empty,
wenzelm@55649
   126
    markups: Markups = Markups.empty)
wenzelm@38361
   127
  {
wenzelm@56395
   128
    lazy val protocol_status: Protocol.Status =
wenzelm@56395
   129
    {
wenzelm@56395
   130
      val warnings =
wenzelm@56395
   131
        if (results.iterator.exists(p => Protocol.is_warning(p._2)))
wenzelm@56395
   132
          List(Markup(Markup.WARNING, Nil))
wenzelm@56395
   133
        else Nil
wenzelm@56395
   134
      val errors =
wenzelm@56395
   135
        if (results.iterator.exists(p => Protocol.is_error(p._2)))
wenzelm@56395
   136
          List(Markup(Markup.ERROR, Nil))
wenzelm@56395
   137
        else Nil
wenzelm@56395
   138
      Protocol.Status.make((warnings ::: errors ::: status).iterator)
wenzelm@56395
   139
    }
wenzelm@55432
   140
wenzelm@55650
   141
    def markup(index: Markup_Index): Markup_Tree = markups(index)
wenzelm@55432
   142
wenzelm@56489
   143
    def redirect(other_command: Command): Option[State] =
wenzelm@56489
   144
    {
wenzelm@56489
   145
      val markups1 = markups.redirect(other_command.id)
wenzelm@56489
   146
      if (markups1.is_empty) None
wenzelm@56489
   147
      else Some(new State(other_command, Nil, Results.empty, markups1))
wenzelm@56489
   148
    }
wenzelm@49614
   149
wenzelm@51494
   150
    def eq_content(other: State): Boolean =
wenzelm@51494
   151
      command.source == other.command.source &&
wenzelm@51494
   152
      status == other.status &&
wenzelm@51494
   153
      results == other.results &&
wenzelm@55434
   154
      markups == other.markups
wenzelm@38361
   155
wenzelm@55649
   156
    private def add_status(st: Markup): State =
wenzelm@55649
   157
      copy(status = st :: status)
wenzelm@55432
   158
wenzelm@56746
   159
    private def add_markup(
wenzelm@56746
   160
      status: Boolean, chunk_name: Symbol.Text_Chunk.Name, m: Text.Markup): State =
wenzelm@55649
   161
    {
wenzelm@55649
   162
      val markups1 =
wenzelm@56395
   163
        if (status || Protocol.liberal_status_elements(m.info.name))
wenzelm@56462
   164
          markups.add(Markup_Index(true, chunk_name), m)
wenzelm@55649
   165
        else markups
wenzelm@56462
   166
      copy(markups = markups1.add(Markup_Index(false, chunk_name), m))
wenzelm@55649
   167
    }
wenzelm@38361
   168
wenzelm@56470
   169
    def accumulate(
wenzelm@56470
   170
        self_id: Document_ID.Generic => Boolean,
wenzelm@56746
   171
        other_id: Document_ID.Generic => Option[(Symbol.Text_Chunk.Id, Symbol.Text_Chunk)],
wenzelm@56470
   172
        message: XML.Elem): State =
wenzelm@38361
   173
      message match {
wenzelm@50201
   174
        case XML.Elem(Markup(Markup.STATUS, _), msgs) =>
wenzelm@38714
   175
          (this /: msgs)((state, msg) =>
wenzelm@38714
   176
            msg match {
wenzelm@46152
   177
              case elem @ XML.Elem(markup, Nil) =>
wenzelm@55649
   178
                state.
wenzelm@55649
   179
                  add_status(markup).
wenzelm@56746
   180
                  add_markup(true, Symbol.Text_Chunk.Default, Text.Info(command.proper_range, elem))
wenzelm@52536
   181
              case _ =>
wenzelm@56782
   182
                Output.warning("Ignored status message: " + msg)
wenzelm@52536
   183
                state
wenzelm@38714
   184
            })
wenzelm@38581
   185
wenzelm@50201
   186
        case XML.Elem(Markup(Markup.REPORT, _), msgs) =>
wenzelm@38572
   187
          (this /: msgs)((state, msg) =>
wenzelm@55432
   188
            {
wenzelm@56782
   189
              def bad(): Unit = Output.warning("Ignored report message: " + msg)
wenzelm@55432
   190
wenzelm@55432
   191
              msg match {
wenzelm@56470
   192
                case XML.Elem(
wenzelm@56470
   193
                    Markup(name, atts @ Position.Reported(id, chunk_name, symbol_range)), args) =>
wenzelm@56470
   194
wenzelm@56470
   195
                  val target =
wenzelm@56470
   196
                    if (self_id(id) && command.chunks.isDefinedAt(chunk_name))
wenzelm@56470
   197
                      Some((chunk_name, command.chunks(chunk_name)))
wenzelm@56746
   198
                    else if (chunk_name == Symbol.Text_Chunk.Default) other_id(id)
wenzelm@56470
   199
                    else None
wenzelm@56470
   200
wenzelm@56470
   201
                  target match {
wenzelm@56470
   202
                    case Some((target_name, target_chunk)) =>
wenzelm@56470
   203
                      target_chunk.incorporate(symbol_range) match {
wenzelm@55550
   204
                        case Some(range) =>
wenzelm@55822
   205
                          val props = Position.purge(atts)
wenzelm@55822
   206
                          val info = Text.Info(range, XML.Elem(Markup(name, props), args))
wenzelm@56470
   207
                          state.add_markup(false, target_name, info)
wenzelm@55550
   208
                        case None => bad(); state
wenzelm@55432
   209
                      }
wenzelm@56476
   210
                    case None =>
wenzelm@56514
   211
                      // silently ignore excessive reports
wenzelm@56476
   212
                      state
wenzelm@55432
   213
                  }
wenzelm@55432
   214
wenzelm@55432
   215
                case XML.Elem(Markup(name, atts), args)
wenzelm@55432
   216
                if !atts.exists({ case (a, _) => Markup.POSITION_PROPERTIES(a) }) =>
wenzelm@55432
   217
                  val range = command.proper_range
wenzelm@55432
   218
                  val props = Position.purge(atts)
wenzelm@55432
   219
                  val info: Text.Markup = Text.Info(range, XML.Elem(Markup(name, props), args))
wenzelm@56746
   220
                  state.add_markup(false, Symbol.Text_Chunk.Default, info)
wenzelm@55432
   221
wenzelm@56470
   222
                case _ => bad(); state
wenzelm@55432
   223
              }
wenzelm@38361
   224
            })
wenzelm@52930
   225
        case XML.Elem(Markup(name, props), body) =>
wenzelm@52930
   226
          props match {
wenzelm@50201
   227
            case Markup.Serial(i) =>
wenzelm@50201
   228
              val message1 = XML.Elem(Markup(Markup.message(name), props), body)
wenzelm@50163
   229
              val message2 = XML.Elem(Markup(name, props), body)
wenzelm@50163
   230
wenzelm@55433
   231
              var st = copy(results = results + (i -> message1))
wenzelm@55433
   232
              if (Protocol.is_inlined(message)) {
wenzelm@55433
   233
                for {
wenzelm@56469
   234
                  (chunk_name, chunk) <- command.chunks.iterator
wenzelm@56470
   235
                  range <- Protocol.message_positions(self_id, chunk_name, chunk, message)
wenzelm@56462
   236
                } st = st.add_markup(false, chunk_name, Text.Info(range, message2))
wenzelm@55433
   237
              }
wenzelm@55433
   238
              st
wenzelm@55432
   239
wenzelm@52536
   240
            case _ =>
wenzelm@56782
   241
              Output.warning("Ignored message without serial number: " + message)
wenzelm@52536
   242
              this
wenzelm@38872
   243
          }
wenzelm@56295
   244
    }
wenzelm@38361
   245
  }
wenzelm@38367
   246
wenzelm@38367
   247
wenzelm@55431
   248
wenzelm@55431
   249
  /** static content **/
wenzelm@55431
   250
wenzelm@45644
   251
  /* make commands */
wenzelm@45644
   252
wenzelm@54462
   253
  def name(span: List[Token]): String =
wenzelm@54462
   254
    span.find(_.is_command) match { case Some(tok) => tok.source case _ => "" }
wenzelm@48745
   255
wenzelm@55648
   256
  private def source_span(span: List[Token]): (String, List[Token]) =
wenzelm@45644
   257
  {
wenzelm@45644
   258
    val source: String =
wenzelm@48745
   259
      span match {
wenzelm@45644
   260
        case List(tok) => tok.source
wenzelm@48745
   261
        case _ => span.map(_.source).mkString
wenzelm@45644
   262
      }
wenzelm@45644
   263
wenzelm@48745
   264
    val span1 = new mutable.ListBuffer[Token]
wenzelm@45644
   265
    var i = 0
wenzelm@48745
   266
    for (Token(kind, s) <- span) {
wenzelm@45644
   267
      val n = s.length
wenzelm@45644
   268
      val s1 = source.substring(i, i + n)
wenzelm@48745
   269
      span1 += Token(kind, s1)
wenzelm@45644
   270
      i += n
wenzelm@45644
   271
    }
wenzelm@55648
   272
    (source, span1.toList)
wenzelm@45644
   273
  }
wenzelm@45644
   274
wenzelm@55648
   275
  def apply(
wenzelm@55648
   276
    id: Document_ID.Command,
wenzelm@55648
   277
    node_name: Document.Node.Name,
wenzelm@55648
   278
    blobs: List[Blob],
wenzelm@55648
   279
    span: List[Token]): Command =
wenzelm@55648
   280
  {
wenzelm@55648
   281
    val (source, span1) = source_span(span)
wenzelm@55648
   282
    new Command(id, node_name, blobs, span1, source, Results.empty, Markup_Tree.empty)
wenzelm@55648
   283
  }
wenzelm@49414
   284
wenzelm@55648
   285
  val empty: Command = Command(Document_ID.none, Document.Node.Name.empty, Nil, Nil)
wenzelm@55648
   286
wenzelm@55648
   287
  def unparsed(
wenzelm@55648
   288
    id: Document_ID.Command,
wenzelm@55648
   289
    source: String,
wenzelm@55648
   290
    results: Results,
wenzelm@55648
   291
    markup: Markup_Tree): Command =
wenzelm@55648
   292
  {
wenzelm@55648
   293
    val (source1, span) = source_span(List(Token(Token.Kind.UNPARSED, source)))
wenzelm@55648
   294
    new Command(id, Document.Node.Name.empty, Nil, span, source1, results, markup)
wenzelm@55648
   295
  }
wenzelm@49414
   296
wenzelm@50501
   297
  def unparsed(source: String): Command =
wenzelm@52530
   298
    unparsed(Document_ID.none, source, Results.empty, Markup_Tree.empty)
wenzelm@44384
   299
wenzelm@52530
   300
  def rich_text(id: Document_ID.Command, results: Results, body: XML.Body): Command =
wenzelm@49414
   301
  {
wenzelm@49466
   302
    val text = XML.content(body)
wenzelm@49466
   303
    val markup = Markup_Tree.from_XML(body)
wenzelm@50501
   304
    unparsed(id, text, results, markup)
wenzelm@49414
   305
  }
wenzelm@49359
   306
wenzelm@44384
   307
wenzelm@44384
   308
  /* perspective */
wenzelm@44384
   309
wenzelm@44474
   310
  object Perspective
wenzelm@44474
   311
  {
wenzelm@44474
   312
    val empty: Perspective = Perspective(Nil)
wenzelm@44474
   313
  }
wenzelm@44385
   314
wenzelm@44474
   315
  sealed case class Perspective(commands: List[Command])  // visible commands in canonical order
wenzelm@44385
   316
  {
wenzelm@57615
   317
    def is_empty: Boolean = commands.isEmpty
wenzelm@57615
   318
wenzelm@44474
   319
    def same(that: Perspective): Boolean =
wenzelm@44474
   320
    {
wenzelm@44474
   321
      val cmds1 = this.commands
wenzelm@44474
   322
      val cmds2 = that.commands
wenzelm@48754
   323
      require(!cmds1.exists(_.is_undefined))
wenzelm@48754
   324
      require(!cmds2.exists(_.is_undefined))
wenzelm@44474
   325
      cmds1.length == cmds2.length &&
wenzelm@44474
   326
        (cmds1.iterator zip cmds2.iterator).forall({ case (c1, c2) => c1.id == c2.id })
wenzelm@44474
   327
    }
wenzelm@44385
   328
  }
wenzelm@34318
   329
}
wenzelm@34318
   330
wenzelm@38361
   331
wenzelm@46712
   332
final class Command private(
wenzelm@52530
   333
    val id: Document_ID.Command,
wenzelm@44615
   334
    val node_name: Document.Node.Name,
wenzelm@54519
   335
    val blobs: List[Command.Blob],
wenzelm@52535
   336
    val span: List[Token],
wenzelm@49414
   337
    val source: String,
wenzelm@50501
   338
    val init_results: Command.Results,
wenzelm@49414
   339
    val init_markup: Markup_Tree)
wenzelm@34451
   340
{
wenzelm@34859
   341
  /* classification */
wenzelm@34500
   342
wenzelm@52530
   343
  def is_undefined: Boolean = id == Document_ID.none
wenzelm@48754
   344
  val is_unparsed: Boolean = span.exists(_.is_unparsed)
wenzelm@48754
   345
  val is_unfinished: Boolean = span.exists(_.is_unfinished)
wenzelm@44385
   346
wenzelm@48599
   347
  val is_ignored: Boolean = !span.exists(_.is_proper)
wenzelm@48754
   348
  val is_malformed: Boolean = !is_ignored && (!span.head.is_command || span.exists(_.is_error))
wenzelm@47012
   349
  def is_command: Boolean = !is_ignored && !is_malformed
wenzelm@34859
   350
wenzelm@54462
   351
  def name: String = Command.name(span)
wenzelm@47012
   352
wenzelm@37129
   353
  override def toString =
wenzelm@37373
   354
    id + "/" + (if (is_command) name else if (is_ignored) "IGNORED" else "MALFORMED")
wenzelm@34495
   355
wenzelm@34859
   356
wenzelm@54519
   357
  /* blobs */
wenzelm@54519
   358
wenzelm@55785
   359
  def blobs_changed(doc_blobs: Document.Blobs): Boolean =
wenzelm@55785
   360
    blobs.exists({ case Exn.Res((name, _)) => doc_blobs.changed(name) case _ => false })
wenzelm@55785
   361
wenzelm@54530
   362
  def blobs_names: List[Document.Node.Name] =
wenzelm@54530
   363
    for (Exn.Res((name, _)) <- blobs) yield name
wenzelm@54530
   364
wenzelm@54519
   365
  def blobs_digests: List[SHA1.Digest] =
wenzelm@55431
   366
    for (Exn.Res((_, Some((digest, _)))) <- blobs) yield digest
wenzelm@54519
   367
wenzelm@55432
   368
wenzelm@56462
   369
  /* source chunks */
wenzelm@55431
   370
wenzelm@56746
   371
  val chunk: Symbol.Text_Chunk = Symbol.Text_Chunk(source)
wenzelm@56473
   372
wenzelm@56746
   373
  val chunks: Map[Symbol.Text_Chunk.Name, Symbol.Text_Chunk] =
wenzelm@56746
   374
    ((Symbol.Text_Chunk.Default -> chunk) ::
wenzelm@56473
   375
      (for (Exn.Res((name, Some((_, file)))) <- blobs)
wenzelm@56746
   376
        yield (Symbol.Text_Chunk.File(name.node) -> file))).toMap
wenzelm@56473
   377
wenzelm@46813
   378
  def length: Int = source.length
wenzelm@56473
   379
  def range: Text.Range = chunk.range
wenzelm@46813
   380
wenzelm@46813
   381
  val proper_range: Text.Range =
wenzelm@51048
   382
    Text.Range(0, (length /: span.reverse.iterator.takeWhile(_.is_improper))(_ - _.source.length))
wenzelm@46813
   383
wenzelm@38426
   384
  def source(range: Text.Range): String = source.substring(range.start, range.stop)
wenzelm@38572
   385
wenzelm@38370
   386
wenzelm@38370
   387
  /* accumulated results */
wenzelm@38370
   388
wenzelm@50501
   389
  val init_state: Command.State =
wenzelm@55649
   390
    Command.State(this, results = init_results, markups = Command.Markups.init(init_markup))
wenzelm@52527
   391
wenzelm@52527
   392
  val empty_state: Command.State = Command.State(this)
immler@34676
   393
}