src/Pure/PIDE/command.scala
author wenzelm
Fri Feb 21 15:12:50 2014 +0100 (2014-02-21 ago)
changeset 55649 1532ab0dc67b
parent 55648 38f264741609
child 55650 349afd0fa0c4
permissions -rw-r--r--
more general / abstract Command.Markups, with separate index for status elements;
slightly faster Rendering.overview_color;
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@55648
    18
  type Blob = Exn.Result[(Document.Node.Name, Option[(SHA1.Digest, 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@51496
    30
    def make(es: Iterable[Results.Entry]): Results = (empty /: es.iterator)(_ + _)
wenzelm@50507
    31
    def merge(rs: Iterable[Results]): Results = (empty /: rs.iterator)(_ ++ _)
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@51496
    38
    def entries: 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@50508
    47
      else (this /: other.entries)(_ + _)
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@50540
    55
    override def toString: String = entries.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@55649
    63
    val markup: Markup_Index = Markup_Index(false, "")
wenzelm@55649
    64
  }
wenzelm@55649
    65
wenzelm@55649
    66
  sealed case class Markup_Index(status: Boolean, file_name: String)
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@55649
    84
    def ++ (other: Markups): Markups =
wenzelm@55649
    85
      new Markups(
wenzelm@55649
    86
        (rep.keySet ++ other.rep.keySet)
wenzelm@55649
    87
          .map(index => index -> (this(index) ++ other(index))).toMap)
wenzelm@55649
    88
wenzelm@55649
    89
    override def hashCode: Int = rep.hashCode
wenzelm@55649
    90
    override def equals(that: Any): Boolean =
wenzelm@55649
    91
      that match {
wenzelm@55649
    92
        case other: Markups => rep == other.rep
wenzelm@55649
    93
        case _ => false
wenzelm@55649
    94
      }
wenzelm@55649
    95
    override def toString: String = rep.iterator.mkString("Markups(", ", ", ")")
wenzelm@55649
    96
  }
wenzelm@55649
    97
wenzelm@55649
    98
wenzelm@50507
    99
  /* state */
wenzelm@50501
   100
wenzelm@43714
   101
  sealed case class State(
wenzelm@50501
   102
    command: Command,
wenzelm@50501
   103
    status: List[Markup] = Nil,
wenzelm@50507
   104
    results: Results = Results.empty,
wenzelm@55649
   105
    markups: Markups = Markups.empty)
wenzelm@38361
   106
  {
wenzelm@55649
   107
    /* markup */
wenzelm@55432
   108
wenzelm@55649
   109
    def get_markup(index: Markup_Index): Markup_Tree = markups(index)
wenzelm@55649
   110
wenzelm@55649
   111
    def markup: Markup_Tree = get_markup(Markup_Index.markup)
wenzelm@55432
   112
wenzelm@49645
   113
    def markup_to_XML(filter: XML.Elem => Boolean): XML.Body =
wenzelm@49645
   114
      markup.to_XML(command.range, command.source, filter)
wenzelm@49614
   115
wenzelm@49614
   116
wenzelm@51494
   117
    /* content */
wenzelm@51494
   118
wenzelm@51494
   119
    def eq_content(other: State): Boolean =
wenzelm@51494
   120
      command.source == other.command.source &&
wenzelm@51494
   121
      status == other.status &&
wenzelm@51494
   122
      results == other.results &&
wenzelm@55434
   123
      markups == other.markups
wenzelm@38361
   124
wenzelm@55649
   125
    private def add_status(st: Markup): State =
wenzelm@55649
   126
      copy(status = st :: status)
wenzelm@55432
   127
wenzelm@55649
   128
    private def add_markup(status: Boolean, file_name: String, m: Text.Markup): State =
wenzelm@55649
   129
    {
wenzelm@55649
   130
      val markups1 =
wenzelm@55649
   131
        if (status || Protocol.status_elements(m.info.name))
wenzelm@55649
   132
          markups.add(Markup_Index(true, file_name), m)
wenzelm@55649
   133
        else markups
wenzelm@55649
   134
      copy(markups = markups1.add(Markup_Index(false, file_name), m))
wenzelm@55649
   135
    }
wenzelm@38361
   136
wenzelm@52531
   137
    def + (alt_id: Document_ID.Generic, message: XML.Elem): State =
wenzelm@38361
   138
      message match {
wenzelm@50201
   139
        case XML.Elem(Markup(Markup.STATUS, _), msgs) =>
wenzelm@38714
   140
          (this /: msgs)((state, msg) =>
wenzelm@38714
   141
            msg match {
wenzelm@46152
   142
              case elem @ XML.Elem(markup, Nil) =>
wenzelm@55649
   143
                state.
wenzelm@55649
   144
                  add_status(markup).
wenzelm@55649
   145
                  add_markup(true, "", Text.Info(command.proper_range, elem))
wenzelm@52536
   146
              case _ =>
wenzelm@55618
   147
                System.err.println("Ignored status message: " + msg)
wenzelm@52536
   148
                state
wenzelm@38714
   149
            })
wenzelm@38581
   150
wenzelm@50201
   151
        case XML.Elem(Markup(Markup.REPORT, _), msgs) =>
wenzelm@38572
   152
          (this /: msgs)((state, msg) =>
wenzelm@55432
   153
            {
wenzelm@55618
   154
              def bad(): Unit = System.err.println("Ignored report message: " + msg)
wenzelm@55432
   155
wenzelm@55432
   156
              msg match {
wenzelm@55432
   157
                case XML.Elem(Markup(name, atts @ Position.Reported(id, file_name, raw_range)), args)
wenzelm@55432
   158
                if id == command.id || id == alt_id =>
wenzelm@55432
   159
                  command.chunks.get(file_name) match {
wenzelm@55432
   160
                    case Some(chunk) =>
wenzelm@55550
   161
                      chunk.decode(raw_range).try_restrict(chunk.range) match {
wenzelm@55550
   162
                        case Some(range) =>
wenzelm@55550
   163
                          if (!range.is_singularity) {
wenzelm@55550
   164
                            val props = Position.purge(atts)
wenzelm@55649
   165
                            val info = Text.Info(range, XML.Elem(Markup(name, props), args))
wenzelm@55649
   166
                            state.add_markup(false, file_name, info)
wenzelm@55550
   167
                          }
wenzelm@55550
   168
                          else state
wenzelm@55550
   169
                        case None => bad(); state
wenzelm@55432
   170
                      }
wenzelm@55550
   171
                    case None => bad(); state
wenzelm@55432
   172
                  }
wenzelm@55432
   173
wenzelm@55432
   174
                case XML.Elem(Markup(name, atts), args)
wenzelm@55432
   175
                if !atts.exists({ case (a, _) => Markup.POSITION_PROPERTIES(a) }) =>
wenzelm@55432
   176
                  val range = command.proper_range
wenzelm@55432
   177
                  val props = Position.purge(atts)
wenzelm@55432
   178
                  val info: Text.Markup = Text.Info(range, XML.Elem(Markup(name, props), args))
wenzelm@55649
   179
                  state.add_markup(false, "", info)
wenzelm@55432
   180
wenzelm@55550
   181
                case _ => /* FIXME bad(); */ state
wenzelm@55432
   182
              }
wenzelm@38361
   183
            })
wenzelm@52930
   184
        case XML.Elem(Markup(name, props), body) =>
wenzelm@52930
   185
          props match {
wenzelm@50201
   186
            case Markup.Serial(i) =>
wenzelm@50201
   187
              val message1 = XML.Elem(Markup(Markup.message(name), props), body)
wenzelm@50163
   188
              val message2 = XML.Elem(Markup(name, props), body)
wenzelm@50163
   189
wenzelm@55433
   190
              var st = copy(results = results + (i -> message1))
wenzelm@55433
   191
              if (Protocol.is_inlined(message)) {
wenzelm@55433
   192
                for {
wenzelm@55433
   193
                  (file_name, chunk) <- command.chunks
wenzelm@55433
   194
                  range <- Protocol.message_positions(command.id, alt_id, chunk, message)
wenzelm@55649
   195
                } st = st.add_markup(false, file_name, Text.Info(range, message2))
wenzelm@55433
   196
              }
wenzelm@55433
   197
              st
wenzelm@55432
   198
wenzelm@52536
   199
            case _ =>
wenzelm@55618
   200
              System.err.println("Ignored message without serial number: " + message)
wenzelm@52536
   201
              this
wenzelm@38872
   202
          }
wenzelm@38361
   203
      }
wenzelm@52527
   204
wenzelm@52527
   205
    def ++ (other: State): State =
wenzelm@52642
   206
      copy(
wenzelm@52642
   207
        status = other.status ::: status,
wenzelm@52642
   208
        results = results ++ other.results,
wenzelm@55649
   209
        markups = markups ++ other.markups
wenzelm@55432
   210
      )
wenzelm@38361
   211
  }
wenzelm@38367
   212
wenzelm@38367
   213
wenzelm@55431
   214
wenzelm@55431
   215
  /** static content **/
wenzelm@55431
   216
wenzelm@55431
   217
  /* text chunks */
wenzelm@55431
   218
wenzelm@55431
   219
  abstract class Chunk
wenzelm@55431
   220
  {
wenzelm@55431
   221
    def file_name: String
wenzelm@55431
   222
    def length: Int
wenzelm@55431
   223
    def range: Text.Range
wenzelm@55431
   224
    def decode(r: Text.Range): Text.Range
wenzelm@55431
   225
  }
wenzelm@55431
   226
wenzelm@55431
   227
  class File(val file_name: String, text: CharSequence) extends Chunk
wenzelm@55431
   228
  {
wenzelm@55431
   229
    val length = text.length
wenzelm@55431
   230
    val range = Text.Range(0, length)
wenzelm@55431
   231
    private val symbol_index = Symbol.Index(text)
wenzelm@55431
   232
    def decode(r: Text.Range): Text.Range = symbol_index.decode(r)
wenzelm@55431
   233
  }
wenzelm@55431
   234
wenzelm@55431
   235
wenzelm@45644
   236
  /* make commands */
wenzelm@45644
   237
wenzelm@54462
   238
  def name(span: List[Token]): String =
wenzelm@54462
   239
    span.find(_.is_command) match { case Some(tok) => tok.source case _ => "" }
wenzelm@48745
   240
wenzelm@55648
   241
  private def source_span(span: List[Token]): (String, List[Token]) =
wenzelm@45644
   242
  {
wenzelm@45644
   243
    val source: String =
wenzelm@48745
   244
      span match {
wenzelm@45644
   245
        case List(tok) => tok.source
wenzelm@48745
   246
        case _ => span.map(_.source).mkString
wenzelm@45644
   247
      }
wenzelm@45644
   248
wenzelm@48745
   249
    val span1 = new mutable.ListBuffer[Token]
wenzelm@45644
   250
    var i = 0
wenzelm@48745
   251
    for (Token(kind, s) <- span) {
wenzelm@45644
   252
      val n = s.length
wenzelm@45644
   253
      val s1 = source.substring(i, i + n)
wenzelm@48745
   254
      span1 += Token(kind, s1)
wenzelm@45644
   255
      i += n
wenzelm@45644
   256
    }
wenzelm@55648
   257
    (source, span1.toList)
wenzelm@45644
   258
  }
wenzelm@45644
   259
wenzelm@55648
   260
  def apply(
wenzelm@55648
   261
    id: Document_ID.Command,
wenzelm@55648
   262
    node_name: Document.Node.Name,
wenzelm@55648
   263
    blobs: List[Blob],
wenzelm@55648
   264
    span: List[Token]): Command =
wenzelm@55648
   265
  {
wenzelm@55648
   266
    val (source, span1) = source_span(span)
wenzelm@55648
   267
    new Command(id, node_name, blobs, span1, source, Results.empty, Markup_Tree.empty)
wenzelm@55648
   268
  }
wenzelm@49414
   269
wenzelm@55648
   270
  val empty: Command = Command(Document_ID.none, Document.Node.Name.empty, Nil, Nil)
wenzelm@55648
   271
wenzelm@55648
   272
  def unparsed(
wenzelm@55648
   273
    id: Document_ID.Command,
wenzelm@55648
   274
    source: String,
wenzelm@55648
   275
    results: Results,
wenzelm@55648
   276
    markup: Markup_Tree): Command =
wenzelm@55648
   277
  {
wenzelm@55648
   278
    val (source1, span) = source_span(List(Token(Token.Kind.UNPARSED, source)))
wenzelm@55648
   279
    new Command(id, Document.Node.Name.empty, Nil, span, source1, results, markup)
wenzelm@55648
   280
  }
wenzelm@49414
   281
wenzelm@50501
   282
  def unparsed(source: String): Command =
wenzelm@52530
   283
    unparsed(Document_ID.none, source, Results.empty, Markup_Tree.empty)
wenzelm@44384
   284
wenzelm@52530
   285
  def rich_text(id: Document_ID.Command, results: Results, body: XML.Body): Command =
wenzelm@49414
   286
  {
wenzelm@49466
   287
    val text = XML.content(body)
wenzelm@49466
   288
    val markup = Markup_Tree.from_XML(body)
wenzelm@50501
   289
    unparsed(id, text, results, markup)
wenzelm@49414
   290
  }
wenzelm@49359
   291
wenzelm@44384
   292
wenzelm@44384
   293
  /* perspective */
wenzelm@44384
   294
wenzelm@44474
   295
  object Perspective
wenzelm@44474
   296
  {
wenzelm@44474
   297
    val empty: Perspective = Perspective(Nil)
wenzelm@44474
   298
  }
wenzelm@44385
   299
wenzelm@44474
   300
  sealed case class Perspective(commands: List[Command])  // visible commands in canonical order
wenzelm@44385
   301
  {
wenzelm@44474
   302
    def same(that: Perspective): Boolean =
wenzelm@44474
   303
    {
wenzelm@44474
   304
      val cmds1 = this.commands
wenzelm@44474
   305
      val cmds2 = that.commands
wenzelm@48754
   306
      require(!cmds1.exists(_.is_undefined))
wenzelm@48754
   307
      require(!cmds2.exists(_.is_undefined))
wenzelm@44474
   308
      cmds1.length == cmds2.length &&
wenzelm@44474
   309
        (cmds1.iterator zip cmds2.iterator).forall({ case (c1, c2) => c1.id == c2.id })
wenzelm@44474
   310
    }
wenzelm@44385
   311
  }
wenzelm@34318
   312
}
wenzelm@34318
   313
wenzelm@38361
   314
wenzelm@46712
   315
final class Command private(
wenzelm@52530
   316
    val id: Document_ID.Command,
wenzelm@44615
   317
    val node_name: Document.Node.Name,
wenzelm@54519
   318
    val blobs: List[Command.Blob],
wenzelm@52535
   319
    val span: List[Token],
wenzelm@49414
   320
    val source: String,
wenzelm@50501
   321
    val init_results: Command.Results,
wenzelm@49414
   322
    val init_markup: Markup_Tree)
wenzelm@55431
   323
  extends Command.Chunk
wenzelm@34451
   324
{
wenzelm@34859
   325
  /* classification */
wenzelm@34500
   326
wenzelm@52530
   327
  def is_undefined: Boolean = id == Document_ID.none
wenzelm@48754
   328
  val is_unparsed: Boolean = span.exists(_.is_unparsed)
wenzelm@48754
   329
  val is_unfinished: Boolean = span.exists(_.is_unfinished)
wenzelm@44385
   330
wenzelm@48599
   331
  val is_ignored: Boolean = !span.exists(_.is_proper)
wenzelm@48754
   332
  val is_malformed: Boolean = !is_ignored && (!span.head.is_command || span.exists(_.is_error))
wenzelm@47012
   333
  def is_command: Boolean = !is_ignored && !is_malformed
wenzelm@34859
   334
wenzelm@54462
   335
  def name: String = Command.name(span)
wenzelm@47012
   336
wenzelm@37129
   337
  override def toString =
wenzelm@37373
   338
    id + "/" + (if (is_command) name else if (is_ignored) "IGNORED" else "MALFORMED")
wenzelm@34495
   339
wenzelm@34859
   340
wenzelm@54519
   341
  /* blobs */
wenzelm@54519
   342
wenzelm@54530
   343
  def blobs_names: List[Document.Node.Name] =
wenzelm@54530
   344
    for (Exn.Res((name, _)) <- blobs) yield name
wenzelm@54530
   345
wenzelm@54519
   346
  def blobs_digests: List[SHA1.Digest] =
wenzelm@55431
   347
    for (Exn.Res((_, Some((digest, _)))) <- blobs) yield digest
wenzelm@54519
   348
wenzelm@55432
   349
  val chunks: Map[String, Command.Chunk] =
wenzelm@55432
   350
    (("" -> this) ::
wenzelm@55432
   351
      (for (Exn.Res((name, Some((_, file)))) <- blobs) yield (name.node -> file))).toMap
wenzelm@55432
   352
wenzelm@54519
   353
wenzelm@52509
   354
  /* source */
wenzelm@34451
   355
wenzelm@55431
   356
  def file_name: String = ""
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@55430
   366
  private lazy val symbol_index = Symbol.Index(source)
wenzelm@38579
   367
  def decode(i: Text.Offset): Text.Offset = symbol_index.decode(i)
wenzelm@38579
   368
  def decode(r: Text.Range): Text.Range = symbol_index.decode(r)
wenzelm@38370
   369
wenzelm@38370
   370
wenzelm@38370
   371
  /* accumulated results */
wenzelm@38370
   372
wenzelm@50501
   373
  val init_state: Command.State =
wenzelm@55649
   374
    Command.State(this, results = init_results, markups = Command.Markups.init(init_markup))
wenzelm@52527
   375
wenzelm@52527
   376
  val empty_state: Command.State = Command.State(this)
immler@34676
   377
}