src/Pure/Thy/thy_syntax.scala
author wenzelm
Sun Nov 17 17:22:55 2013 +0100 (2013-11-17)
changeset 54462 c9bb76303348
parent 53843 88c6e630c15f
child 54509 1f77110c94ef
permissions -rw-r--r--
explicit indication of thy_load commands;
wenzelm@34268
     1
/*  Title:      Pure/Thy/thy_syntax.scala
wenzelm@34268
     2
    Author:     Makarius
wenzelm@34268
     3
wenzelm@38374
     4
Superficial theory syntax: tokens and spans.
wenzelm@34268
     5
*/
wenzelm@34268
     6
wenzelm@34268
     7
package isabelle
wenzelm@34268
     8
wenzelm@34268
     9
wenzelm@38239
    10
import scala.collection.mutable
wenzelm@38374
    11
import scala.annotation.tailrec
wenzelm@38239
    12
wenzelm@38239
    13
wenzelm@34303
    14
object Thy_Syntax
wenzelm@34268
    15
{
wenzelm@40454
    16
  /** nested structure **/
wenzelm@40454
    17
wenzelm@40454
    18
  object Structure
wenzelm@40454
    19
  {
wenzelm@40478
    20
    sealed abstract class Entry { def length: Int }
wenzelm@40454
    21
    case class Block(val name: String, val body: List[Entry]) extends Entry
wenzelm@40454
    22
    {
wenzelm@40454
    23
      val length: Int = (0 /: body)(_ + _.length)
wenzelm@40454
    24
    }
wenzelm@40454
    25
    case class Atom(val command: Command) extends Entry
wenzelm@40454
    26
    {
wenzelm@40454
    27
      def length: Int = command.length
wenzelm@40454
    28
    }
wenzelm@40454
    29
wenzelm@46811
    30
    def parse(syntax: Outer_Syntax, node_name: Document.Node.Name, text: CharSequence): Entry =
wenzelm@40454
    31
    {
wenzelm@40454
    32
      /* stack operations */
wenzelm@40454
    33
wenzelm@40454
    34
      def buffer(): mutable.ListBuffer[Entry] = new mutable.ListBuffer[Entry]
wenzelm@44615
    35
      var stack: List[(Int, String, mutable.ListBuffer[Entry])] =
wenzelm@48718
    36
        List((0, node_name.theory, buffer()))
wenzelm@40454
    37
wenzelm@40454
    38
      @tailrec def close(level: Int => Boolean)
wenzelm@40454
    39
      {
wenzelm@40454
    40
        stack match {
wenzelm@40454
    41
          case (lev, name, body) :: (_, _, body2) :: rest if level(lev) =>
wenzelm@40454
    42
            body2 += Block(name, body.toList)
wenzelm@40454
    43
            stack = stack.tail
wenzelm@40454
    44
            close(level)
wenzelm@40454
    45
          case _ =>
wenzelm@40454
    46
        }
wenzelm@40454
    47
      }
wenzelm@40454
    48
wenzelm@40454
    49
      def result(): Entry =
wenzelm@40454
    50
      {
wenzelm@40454
    51
        close(_ => true)
wenzelm@40454
    52
        val (_, name, body) = stack.head
wenzelm@40454
    53
        Block(name, body.toList)
wenzelm@40454
    54
      }
wenzelm@40454
    55
wenzelm@40454
    56
      def add(command: Command)
wenzelm@40454
    57
      {
wenzelm@40454
    58
        syntax.heading_level(command) match {
wenzelm@40454
    59
          case Some(i) =>
wenzelm@46969
    60
            close(_ > i)
wenzelm@46969
    61
            stack = (i + 1, command.source, buffer()) :: stack
wenzelm@40454
    62
          case None =>
wenzelm@40454
    63
        }
wenzelm@40454
    64
        stack.head._3 += Atom(command)
wenzelm@40454
    65
      }
wenzelm@40454
    66
wenzelm@40454
    67
wenzelm@40454
    68
      /* result structure */
wenzelm@40454
    69
wenzelm@40454
    70
      val spans = parse_spans(syntax.scan(text))
wenzelm@54462
    71
      spans.foreach(span => add(Command(Document_ID.none, node_name, span, syntax.thy_load(span))))
wenzelm@40454
    72
      result()
wenzelm@40454
    73
    }
wenzelm@40454
    74
  }
wenzelm@40454
    75
wenzelm@40454
    76
wenzelm@40454
    77
wenzelm@38374
    78
  /** parse spans **/
wenzelm@38374
    79
wenzelm@52535
    80
  def parse_spans(toks: List[Token]): List[List[Token]] =
wenzelm@34268
    81
  {
wenzelm@52535
    82
    val result = new mutable.ListBuffer[List[Token]]
wenzelm@38239
    83
    val span = new mutable.ListBuffer[Token]
wenzelm@53843
    84
    val improper = new mutable.ListBuffer[Token]
wenzelm@34268
    85
wenzelm@53843
    86
    def flush()
wenzelm@53843
    87
    {
wenzelm@53843
    88
      if (!span.isEmpty) { result += span.toList; span.clear }
wenzelm@53843
    89
      if (!improper.isEmpty) { result += improper.toList; improper.clear }
wenzelm@53843
    90
    }
wenzelm@53843
    91
    for (tok <- toks) {
wenzelm@53843
    92
      if (tok.is_command) { flush(); span += tok }
wenzelm@53843
    93
      else if (tok.is_improper) improper += tok
wenzelm@53843
    94
      else { span ++= improper; improper.clear; span += tok }
wenzelm@53843
    95
    }
wenzelm@46811
    96
    flush()
wenzelm@53843
    97
wenzelm@38239
    98
    result.toList
wenzelm@34268
    99
  }
wenzelm@38374
   100
wenzelm@38374
   101
wenzelm@38374
   102
wenzelm@44436
   103
  /** perspective **/
wenzelm@44388
   104
wenzelm@52861
   105
  def command_perspective(
wenzelm@52861
   106
      node: Document.Node,
wenzelm@52861
   107
      perspective: Text.Perspective,
wenzelm@52887
   108
      overlays: Document.Node.Overlays): (Command.Perspective, Command.Perspective) =
wenzelm@44388
   109
  {
wenzelm@52861
   110
    if (perspective.is_empty && overlays.is_empty)
wenzelm@52861
   111
      (Command.Perspective.empty, Command.Perspective.empty)
wenzelm@44388
   112
    else {
wenzelm@52861
   113
      val has_overlay = overlays.commands
wenzelm@52861
   114
      val visible = new mutable.ListBuffer[Command]
wenzelm@52861
   115
      val visible_overlay = new mutable.ListBuffer[Command]
wenzelm@44388
   116
      @tailrec
wenzelm@44388
   117
      def check_ranges(ranges: List[Text.Range], commands: Stream[(Command, Text.Offset)])
wenzelm@44388
   118
      {
wenzelm@44388
   119
        (ranges, commands) match {
wenzelm@44388
   120
          case (range :: more_ranges, (command, offset) #:: more_commands) =>
wenzelm@44388
   121
            val command_range = command.range + offset
wenzelm@44388
   122
            range compare command_range match {
wenzelm@44388
   123
              case 0 =>
wenzelm@52861
   124
                visible += command
wenzelm@52861
   125
                visible_overlay += command
wenzelm@44388
   126
                check_ranges(ranges, more_commands)
wenzelm@52861
   127
              case c =>
wenzelm@52861
   128
                if (has_overlay(command)) visible_overlay += command
wenzelm@52861
   129
wenzelm@52861
   130
                if (c < 0) check_ranges(more_ranges, commands)
wenzelm@52861
   131
                else check_ranges(ranges, more_commands)
wenzelm@44388
   132
            }
wenzelm@52861
   133
wenzelm@52861
   134
          case (Nil, (command, _) #:: more_commands) =>
wenzelm@52861
   135
            if (has_overlay(command)) visible_overlay += command
wenzelm@52861
   136
wenzelm@52861
   137
            check_ranges(Nil, more_commands)
wenzelm@52861
   138
wenzelm@44388
   139
          case _ =>
wenzelm@44388
   140
        }
wenzelm@44388
   141
      }
wenzelm@52861
   142
wenzelm@52861
   143
      val commands =
wenzelm@52861
   144
        if (overlays.is_empty) node.command_range(perspective.range)
wenzelm@52861
   145
        else node.command_range()
wenzelm@52861
   146
      check_ranges(perspective.ranges, commands.toStream)
wenzelm@52861
   147
      (Command.Perspective(visible.toList), Command.Perspective(visible_overlay.toList))
wenzelm@44388
   148
    }
wenzelm@44388
   149
  }
wenzelm@44388
   150
wenzelm@44388
   151
wenzelm@44388
   152
wenzelm@46946
   153
  /** header edits: structure and outer syntax **/
wenzelm@46946
   154
wenzelm@46946
   155
  private def header_edits(
wenzelm@46946
   156
    base_syntax: Outer_Syntax,
wenzelm@46946
   157
    previous: Document.Version,
wenzelm@46946
   158
    edits: List[Document.Edit_Text])
wenzelm@46946
   159
    : (Outer_Syntax, List[Document.Node.Name], Document.Nodes, List[Document.Edit_Command]) =
wenzelm@46946
   160
  {
wenzelm@47987
   161
    var updated_imports = false
wenzelm@47987
   162
    var updated_keywords = false
wenzelm@46946
   163
    var nodes = previous.nodes
wenzelm@46946
   164
    val doc_edits = new mutable.ListBuffer[Document.Edit_Command]
wenzelm@46946
   165
wenzelm@46946
   166
    edits foreach {
wenzelm@48707
   167
      case (name, Document.Node.Deps(header)) =>
wenzelm@46946
   168
        val node = nodes(name)
wenzelm@46946
   169
        val update_header =
wenzelm@48707
   170
          !node.header.errors.isEmpty || !header.errors.isEmpty || node.header != header
wenzelm@46946
   171
        if (update_header) {
wenzelm@46946
   172
          val node1 = node.update_header(header)
wenzelm@48707
   173
          updated_imports = updated_imports || (node.header.imports != node1.header.imports)
wenzelm@48707
   174
          updated_keywords = updated_keywords || (node.header.keywords != node1.header.keywords)
wenzelm@46946
   175
          nodes += (name -> node1)
wenzelm@48707
   176
          doc_edits += (name -> Document.Node.Deps(header))
wenzelm@46946
   177
        }
wenzelm@46946
   178
      case _ =>
wenzelm@46946
   179
    }
wenzelm@46946
   180
wenzelm@46946
   181
    val syntax =
wenzelm@47987
   182
      if (previous.is_init || updated_keywords)
wenzelm@48873
   183
        (base_syntax /: nodes.entries) {
wenzelm@48873
   184
          case (syn, (_, node)) => syn.add_keywords(node.header.keywords)
wenzelm@48873
   185
        }
wenzelm@46946
   186
      else previous.syntax
wenzelm@46946
   187
wenzelm@46946
   188
    val reparse =
wenzelm@47987
   189
      if (updated_imports || updated_keywords)
wenzelm@47987
   190
        nodes.descendants(doc_edits.iterator.map(_._1).toList)
wenzelm@46946
   191
      else Nil
wenzelm@46946
   192
wenzelm@46946
   193
    (syntax, reparse, nodes, doc_edits.toList)
wenzelm@46946
   194
  }
wenzelm@46946
   195
wenzelm@46946
   196
wenzelm@46946
   197
wenzelm@38374
   198
  /** text edits **/
wenzelm@38374
   199
wenzelm@48755
   200
  /* edit individual command source */
wenzelm@46946
   201
wenzelm@50761
   202
  @tailrec def edit_text(eds: List[Text.Edit], commands: Linear_Set[Command]): Linear_Set[Command] =
wenzelm@46946
   203
  {
wenzelm@46946
   204
    eds match {
wenzelm@46946
   205
      case e :: es =>
wenzelm@52901
   206
        Document.Node.Commands.starts(commands.iterator).find {
wenzelm@46946
   207
          case (cmd, cmd_start) =>
wenzelm@46946
   208
            e.can_edit(cmd.source, cmd_start) ||
wenzelm@46946
   209
              e.is_insert && e.start == cmd_start + cmd.length
wenzelm@46946
   210
        } match {
wenzelm@46946
   211
          case Some((cmd, cmd_start)) if e.can_edit(cmd.source, cmd_start) =>
wenzelm@46946
   212
            val (rest, text) = e.edit(cmd.source, cmd_start)
wenzelm@46946
   213
            val new_commands = commands.insert_after(Some(cmd), Command.unparsed(text)) - cmd
wenzelm@46946
   214
            edit_text(rest.toList ::: es, new_commands)
wenzelm@46946
   215
wenzelm@46946
   216
          case Some((cmd, cmd_start)) =>
wenzelm@46946
   217
            edit_text(es, commands.insert_after(Some(cmd), Command.unparsed(e.text)))
wenzelm@46946
   218
wenzelm@46946
   219
          case None =>
wenzelm@46946
   220
            require(e.is_insert && e.start == 0)
wenzelm@46946
   221
            edit_text(es, commands.insert_after(None, Command.unparsed(e.text)))
wenzelm@46946
   222
        }
wenzelm@46946
   223
      case Nil => commands
wenzelm@46946
   224
    }
wenzelm@46946
   225
  }
wenzelm@46946
   226
wenzelm@46946
   227
wenzelm@48755
   228
  /* reparse range of command spans */
wenzelm@46946
   229
wenzelm@48748
   230
  @tailrec private def chop_common(
wenzelm@52535
   231
      cmds: List[Command], spans: List[List[Token]]): (List[Command], List[List[Token]]) =
wenzelm@48748
   232
    (cmds, spans) match {
wenzelm@48748
   233
      case (c :: cs, s :: ss) if c.span == s => chop_common(cs, ss)
wenzelm@48748
   234
      case _ => (cmds, spans)
wenzelm@48748
   235
    }
wenzelm@48748
   236
wenzelm@48754
   237
  private def reparse_spans(
wenzelm@48754
   238
    syntax: Outer_Syntax,
wenzelm@48754
   239
    name: Document.Node.Name,
wenzelm@48754
   240
    commands: Linear_Set[Command],
wenzelm@48754
   241
    first: Command, last: Command): Linear_Set[Command] =
wenzelm@48748
   242
  {
wenzelm@48754
   243
    val cmds0 = commands.iterator(first, last).toList
wenzelm@48754
   244
    val spans0 = parse_spans(syntax.scan(cmds0.iterator.map(_.source).mkString))
wenzelm@48754
   245
wenzelm@48754
   246
    val (cmds1, spans1) = chop_common(cmds0, spans0)
wenzelm@48754
   247
wenzelm@48748
   248
    val (rev_cmds2, rev_spans2) = chop_common(cmds1.reverse, spans1.reverse)
wenzelm@48754
   249
    val cmds2 = rev_cmds2.reverse
wenzelm@48754
   250
    val spans2 = rev_spans2.reverse
wenzelm@48754
   251
wenzelm@48754
   252
    cmds2 match {
wenzelm@48754
   253
      case Nil =>
wenzelm@48754
   254
        assert(spans2.isEmpty)
wenzelm@48754
   255
        commands
wenzelm@48754
   256
      case cmd :: _ =>
wenzelm@48754
   257
        val hook = commands.prev(cmd)
wenzelm@54462
   258
        val inserted =
wenzelm@54462
   259
          spans2.map(span => Command(Document_ID.make(), name, span, syntax.thy_load(span)))
wenzelm@48754
   260
        (commands /: cmds2)(_ - _).append_after(hook, inserted)
wenzelm@48754
   261
    }
wenzelm@48748
   262
  }
wenzelm@48748
   263
wenzelm@48754
   264
wenzelm@48755
   265
  /* recover command spans after edits */
wenzelm@48754
   266
wenzelm@48755
   267
  // FIXME somewhat slow
wenzelm@48746
   268
  private def recover_spans(
wenzelm@46946
   269
    syntax: Outer_Syntax,
wenzelm@48754
   270
    name: Document.Node.Name,
wenzelm@48748
   271
    perspective: Command.Perspective,
wenzelm@48754
   272
    commands: Linear_Set[Command]): Linear_Set[Command] =
wenzelm@46946
   273
  {
wenzelm@48754
   274
    val visible = perspective.commands.toSet
wenzelm@48748
   275
wenzelm@48754
   276
    def next_invisible_command(cmds: Linear_Set[Command], from: Command): Command =
wenzelm@48754
   277
      cmds.iterator(from).dropWhile(cmd => !cmd.is_command || visible(cmd))
wenzelm@48754
   278
        .find(_.is_command) getOrElse cmds.last
wenzelm@48746
   279
wenzelm@48754
   280
    @tailrec def recover(cmds: Linear_Set[Command]): Linear_Set[Command] =
wenzelm@48754
   281
      cmds.find(_.is_unparsed) match {
wenzelm@48754
   282
        case Some(first_unparsed) =>
wenzelm@48754
   283
          val first = next_invisible_command(cmds.reverse, first_unparsed)
wenzelm@48754
   284
          val last = next_invisible_command(cmds, first_unparsed)
wenzelm@48754
   285
          recover(reparse_spans(syntax, name, cmds, first, last))
wenzelm@48754
   286
        case None => cmds
wenzelm@48746
   287
      }
wenzelm@48754
   288
    recover(commands)
wenzelm@46946
   289
  }
wenzelm@46946
   290
wenzelm@46946
   291
wenzelm@48755
   292
  /* consolidate unfinished spans */
wenzelm@46946
   293
wenzelm@48754
   294
  private def consolidate_spans(
wenzelm@46946
   295
    syntax: Outer_Syntax,
wenzelm@49524
   296
    reparse_limit: Int,
wenzelm@48754
   297
    name: Document.Node.Name,
wenzelm@48754
   298
    perspective: Command.Perspective,
wenzelm@46946
   299
    commands: Linear_Set[Command]): Linear_Set[Command] =
wenzelm@46946
   300
  {
wenzelm@48754
   301
    if (perspective.commands.isEmpty) commands
wenzelm@48754
   302
    else {
wenzelm@48754
   303
      commands.find(_.is_unfinished) match {
wenzelm@48754
   304
        case Some(first_unfinished) =>
wenzelm@48754
   305
          val visible = perspective.commands.toSet
wenzelm@48754
   306
          commands.reverse.find(visible) match {
wenzelm@48754
   307
            case Some(last_visible) =>
wenzelm@49524
   308
              val it = commands.iterator(last_visible)
wenzelm@49524
   309
              var last = last_visible
wenzelm@49524
   310
              var i = 0
wenzelm@49524
   311
              while (i < reparse_limit && it.hasNext) {
wenzelm@49524
   312
                last = it.next
wenzelm@49524
   313
                i += last.length
wenzelm@49524
   314
              }
wenzelm@49524
   315
              reparse_spans(syntax, name, commands, first_unfinished, last)
wenzelm@48754
   316
            case None => commands
wenzelm@48754
   317
          }
wenzelm@48754
   318
        case None => commands
wenzelm@48754
   319
      }
wenzelm@48754
   320
    }
wenzelm@46946
   321
  }
wenzelm@46946
   322
wenzelm@46946
   323
wenzelm@48755
   324
  /* main */
wenzelm@46946
   325
wenzelm@50761
   326
  def diff_commands(old_cmds: Linear_Set[Command], new_cmds: Linear_Set[Command])
wenzelm@52849
   327
    : List[Command.Edit] =
wenzelm@48754
   328
  {
wenzelm@48754
   329
    val removed = old_cmds.iterator.filter(!new_cmds.contains(_)).toList
wenzelm@48754
   330
    val inserted = new_cmds.iterator.filter(!old_cmds.contains(_)).toList
wenzelm@48754
   331
wenzelm@48754
   332
    removed.reverse.map(cmd => (old_cmds.prev(cmd), None)) :::
wenzelm@48754
   333
    inserted.map(cmd => (new_cmds.prev(cmd), Some(cmd)))
wenzelm@48754
   334
  }
wenzelm@48754
   335
wenzelm@49524
   336
  private def text_edit(syntax: Outer_Syntax, reparse_limit: Int,
wenzelm@48755
   337
    node: Document.Node, edit: Document.Edit_Text): Document.Node =
wenzelm@48755
   338
  {
wenzelm@48755
   339
    edit match {
wenzelm@48755
   340
      case (_, Document.Node.Clear()) => node.clear
wenzelm@48755
   341
wenzelm@48755
   342
      case (name, Document.Node.Edits(text_edits)) =>
wenzelm@48755
   343
        val commands0 = node.commands
wenzelm@48755
   344
        val commands1 = edit_text(text_edits, commands0)
wenzelm@52849
   345
        val commands2 = recover_spans(syntax, name, node.perspective.visible, commands1)
wenzelm@48755
   346
        node.update_commands(commands2)
wenzelm@48755
   347
wenzelm@48755
   348
      case (_, Document.Node.Deps(_)) => node
wenzelm@48755
   349
wenzelm@52849
   350
      case (name, Document.Node.Perspective(required, text_perspective, overlays)) =>
wenzelm@52861
   351
        val (visible, visible_overlay) = command_perspective(node, text_perspective, overlays)
wenzelm@52849
   352
        val perspective: Document.Node.Perspective_Command =
wenzelm@52861
   353
          Document.Node.Perspective(required, visible_overlay, overlays)
wenzelm@52808
   354
        if (node.same_perspective(perspective)) node
wenzelm@48755
   355
        else
wenzelm@49524
   356
          node.update_perspective(perspective).update_commands(
wenzelm@52861
   357
            consolidate_spans(syntax, reparse_limit, name, visible, node.commands))
wenzelm@48755
   358
    }
wenzelm@48755
   359
  }
wenzelm@48755
   360
wenzelm@43722
   361
  def text_edits(
wenzelm@46942
   362
      base_syntax: Outer_Syntax,
wenzelm@49524
   363
      reparse_limit: Int,
wenzelm@43722
   364
      previous: Document.Version,
wenzelm@44157
   365
      edits: List[Document.Edit_Text])
wenzelm@44157
   366
    : (List[Document.Edit_Command], Document.Version) =
wenzelm@38374
   367
  {
wenzelm@46946
   368
    val (syntax, reparse, nodes0, doc_edits0) = header_edits(base_syntax, previous, edits)
wenzelm@46946
   369
    val reparse_set = reparse.toSet
wenzelm@46946
   370
wenzelm@46946
   371
    var nodes = nodes0
wenzelm@46946
   372
    val doc_edits = new mutable.ListBuffer[Document.Edit_Command]; doc_edits ++= doc_edits0
wenzelm@38374
   373
wenzelm@48755
   374
    val node_edits =
wenzelm@48755
   375
      (edits ::: reparse.map((_, Document.Node.Edits(Nil)))).groupBy(_._1)
wenzelm@48755
   376
        .asInstanceOf[Map[Document.Node.Name, List[Document.Edit_Text]]]  // FIXME ???
wenzelm@48754
   377
wenzelm@48755
   378
    node_edits foreach {
wenzelm@48755
   379
      case (name, edits) =>
wenzelm@48755
   380
        val node = nodes(name)
wenzelm@48755
   381
        val commands = node.commands
wenzelm@38374
   382
wenzelm@48755
   383
        val node1 =
wenzelm@48755
   384
          if (reparse_set(name) && !commands.isEmpty)
wenzelm@48755
   385
            node.update_commands(reparse_spans(syntax, name, commands, commands.head, commands.last))
wenzelm@48755
   386
          else node
wenzelm@49524
   387
        val node2 = (node1 /: edits)(text_edit(syntax, reparse_limit, _, _))
wenzelm@38374
   388
wenzelm@52808
   389
        if (!(node.same_perspective(node2.perspective)))
wenzelm@52849
   390
          doc_edits += (name -> node2.perspective)
wenzelm@48755
   391
wenzelm@48755
   392
        doc_edits += (name -> Document.Node.Edits(diff_commands(commands, node2.commands)))
wenzelm@48755
   393
wenzelm@48755
   394
        nodes += (name -> node2)
wenzelm@38374
   395
    }
wenzelm@48754
   396
wenzelm@46946
   397
    (doc_edits.toList, Document.Version.make(syntax, nodes))
wenzelm@38374
   398
  }
wenzelm@34268
   399
}