src/Pure/PIDE/document.scala
author wenzelm
Sat Apr 26 13:34:10 2014 +0200 (2014-04-26)
changeset 56746 d37a5d09a277
parent 56743 81370dfadb1d
child 56801 8dd9df88f647
permissions -rw-r--r--
tuned signature;
wenzelm@36676
     1
/*  Title:      Pure/PIDE/document.scala
wenzelm@36676
     2
    Author:     Makarius
wenzelm@36676
     3
wenzelm@38150
     4
Document as collection of named nodes, each consisting of an editable
wenzelm@38418
     5
list of commands, associated with asynchronous execution process.
wenzelm@36676
     6
*/
wenzelm@34407
     7
wenzelm@34871
     8
package isabelle
wenzelm@34318
     9
wenzelm@34760
    10
wenzelm@38150
    11
import scala.collection.mutable
wenzelm@37073
    12
wenzelm@37073
    13
wenzelm@34823
    14
object Document
wenzelm@34483
    15
{
wenzelm@38424
    16
  /** document structure **/
wenzelm@38424
    17
wenzelm@52977
    18
  /* overlays -- print functions with arguments */
wenzelm@52977
    19
wenzelm@52977
    20
  object Overlays
wenzelm@52977
    21
  {
wenzelm@52977
    22
    val empty = new Overlays(Map.empty)
wenzelm@52977
    23
  }
wenzelm@52977
    24
wenzelm@52977
    25
  final class Overlays private(rep: Map[Node.Name, Node.Overlays])
wenzelm@52977
    26
  {
wenzelm@52977
    27
    def apply(name: Document.Node.Name): Node.Overlays =
wenzelm@52977
    28
      rep.getOrElse(name, Node.Overlays.empty)
wenzelm@52977
    29
wenzelm@52977
    30
    private def update(name: Node.Name, f: Node.Overlays => Node.Overlays): Overlays =
wenzelm@52977
    31
    {
wenzelm@52977
    32
      val node_overlays = f(apply(name))
wenzelm@52977
    33
      new Overlays(if (node_overlays.is_empty) rep - name else rep + (name -> node_overlays))
wenzelm@52977
    34
    }
wenzelm@52977
    35
wenzelm@52977
    36
    def insert(command: Command, fn: String, args: List[String]): Overlays =
wenzelm@52977
    37
      update(command.node_name, _.insert(command, fn, args))
wenzelm@52977
    38
wenzelm@52977
    39
    def remove(command: Command, fn: String, args: List[String]): Overlays =
wenzelm@52977
    40
      update(command.node_name, _.remove(command, fn, args))
wenzelm@55800
    41
wenzelm@55800
    42
    override def toString: String = rep.mkString("Overlays(", ",", ")")
wenzelm@52977
    43
  }
wenzelm@52977
    44
wenzelm@52977
    45
wenzelm@55783
    46
  /* document blobs: auxiliary files */
wenzelm@55783
    47
wenzelm@56746
    48
  sealed case class Blob(bytes: Bytes, chunk: Symbol.Text_Chunk, changed: Boolean)
wenzelm@56335
    49
  {
wenzelm@56335
    50
    def unchanged: Blob = copy(changed = false)
wenzelm@56335
    51
  }
wenzelm@55783
    52
wenzelm@55783
    53
  object Blobs
wenzelm@55783
    54
  {
wenzelm@56336
    55
    def apply(blobs: Map[Node.Name, Blob]): Blobs = new Blobs(blobs)
wenzelm@55783
    56
    val empty: Blobs = apply(Map.empty)
wenzelm@55783
    57
  }
wenzelm@55783
    58
wenzelm@56336
    59
  final class Blobs private(blobs: Map[Node.Name, Blob])
wenzelm@55783
    60
  {
wenzelm@55801
    61
    private lazy val digests: Map[SHA1.Digest, Blob] =
wenzelm@55801
    62
      for ((_, blob) <- blobs) yield (blob.bytes.sha1_digest, blob)
wenzelm@55801
    63
wenzelm@55801
    64
    def get(digest: SHA1.Digest): Option[Blob] = digests.get(digest)
wenzelm@56336
    65
    def get(name: Node.Name): Option[Blob] = blobs.get(name)
wenzelm@55783
    66
wenzelm@55783
    67
    def changed(name: Node.Name): Boolean =
wenzelm@55783
    68
      get(name) match {
wenzelm@55783
    69
        case Some(blob) => blob.changed
wenzelm@55783
    70
        case None => false
wenzelm@55783
    71
      }
wenzelm@55783
    72
wenzelm@55800
    73
    override def toString: String = blobs.mkString("Blobs(", ",", ")")
wenzelm@55783
    74
  }
wenzelm@55783
    75
wenzelm@55783
    76
wenzelm@55783
    77
  /* document nodes: theories and auxiliary files */
wenzelm@38424
    78
wenzelm@44615
    79
  type Edit[A, B] = (Node.Name, Node.Edit[A, B])
wenzelm@44384
    80
  type Edit_Text = Edit[Text.Edit, Text.Perspective]
wenzelm@52849
    81
  type Edit_Command = Edit[Command.Edit, Command.Perspective]
wenzelm@38151
    82
wenzelm@38151
    83
  object Node
wenzelm@38151
    84
  {
wenzelm@52887
    85
    val empty: Node = new Node()
wenzelm@52887
    86
wenzelm@52887
    87
wenzelm@52887
    88
    /* header and name */
wenzelm@52887
    89
wenzelm@48707
    90
    sealed case class Header(
wenzelm@46938
    91
      imports: List[Name],
wenzelm@48706
    92
      keywords: Thy_Header.Keywords,
wenzelm@48707
    93
      errors: List[String] = Nil)
wenzelm@48707
    94
    {
wenzelm@48707
    95
      def error(msg: String): Header = copy(errors = errors ::: List(msg))
wenzelm@54549
    96
wenzelm@54549
    97
      def cat_errors(msg2: String): Header =
wenzelm@54549
    98
        copy(errors = errors.map(msg1 => Library.cat_message(msg1, msg2)))
wenzelm@48707
    99
    }
wenzelm@48707
   100
wenzelm@51294
   101
    def bad_header(msg: String): Header = Header(Nil, Nil, List(msg))
wenzelm@46737
   102
wenzelm@54509
   103
    val no_header = bad_header("No theory header")
wenzelm@54509
   104
wenzelm@44957
   105
    object Name
wenzelm@44957
   106
    {
wenzelm@54515
   107
      val empty = Name("")
wenzelm@46723
   108
wenzelm@46723
   109
      object Ordering extends scala.math.Ordering[Name]
wenzelm@46723
   110
      {
wenzelm@46723
   111
        def compare(name1: Name, name2: Name): Int = name1.node compare name2.node
wenzelm@46723
   112
      }
wenzelm@44957
   113
    }
wenzelm@52887
   114
wenzelm@54515
   115
    sealed case class Name(node: String, master_dir: String = "", theory: String = "")
wenzelm@44615
   116
    {
wenzelm@44615
   117
      override def hashCode: Int = node.hashCode
wenzelm@44615
   118
      override def equals(that: Any): Boolean =
wenzelm@44615
   119
        that match {
wenzelm@44615
   120
          case other: Name => node == other.node
wenzelm@44615
   121
          case _ => false
wenzelm@44615
   122
        }
wenzelm@54509
   123
wenzelm@54509
   124
      def is_theory: Boolean = !theory.isEmpty
wenzelm@54510
   125
      override def toString: String = if (is_theory) theory else node
wenzelm@44615
   126
    }
wenzelm@44615
   127
wenzelm@52887
   128
wenzelm@52977
   129
    /* node overlays */
wenzelm@52887
   130
wenzelm@52887
   131
    object Overlays
wenzelm@52887
   132
    {
wenzelm@52976
   133
      val empty = new Overlays(Multi_Map.empty)
wenzelm@52887
   134
    }
wenzelm@52887
   135
wenzelm@52977
   136
    final class Overlays private(rep: Multi_Map[Command, (String, List[String])])
wenzelm@52887
   137
    {
wenzelm@52887
   138
      def commands: Set[Command] = rep.keySet
wenzelm@52887
   139
      def is_empty: Boolean = rep.isEmpty
wenzelm@52977
   140
      def dest: List[(Command, (String, List[String]))] = rep.iterator.toList
wenzelm@52977
   141
      def insert(cmd: Command, fn: String, args: List[String]): Overlays =
wenzelm@52977
   142
        new Overlays(rep.insert(cmd, (fn, args)))
wenzelm@52977
   143
      def remove(cmd: Command, fn: String, args: List[String]): Overlays =
wenzelm@52977
   144
        new Overlays(rep.remove(cmd, (fn, args)))
wenzelm@55800
   145
wenzelm@55800
   146
      override def toString: String = rep.mkString("Node.Overlays(", ",", ")")
wenzelm@52887
   147
    }
wenzelm@52887
   148
wenzelm@52887
   149
wenzelm@52887
   150
    /* edits */
wenzelm@52887
   151
wenzelm@44384
   152
    sealed abstract class Edit[A, B]
wenzelm@44156
   153
    {
wenzelm@44383
   154
      def foreach(f: A => Unit)
wenzelm@44383
   155
      {
wenzelm@44156
   156
        this match {
wenzelm@44383
   157
          case Edits(es) => es.foreach(f)
wenzelm@44383
   158
          case _ =>
wenzelm@44156
   159
        }
wenzelm@44383
   160
      }
wenzelm@44156
   161
    }
wenzelm@44384
   162
    case class Clear[A, B]() extends Edit[A, B]
wenzelm@56335
   163
    case class Blob[A, B](blob: Document.Blob) extends Edit[A, B]
wenzelm@54562
   164
wenzelm@44384
   165
    case class Edits[A, B](edits: List[A]) extends Edit[A, B]
wenzelm@48707
   166
    case class Deps[A, B](header: Header) extends Edit[A, B]
wenzelm@52849
   167
    case class Perspective[A, B](required: Boolean, visible: B, overlays: Overlays) extends Edit[A, B]
wenzelm@52808
   168
    type Perspective_Text = Perspective[Text.Edit, Text.Perspective]
wenzelm@52849
   169
    type Perspective_Command = Perspective[Command.Edit, Command.Perspective]
wenzelm@44156
   170
wenzelm@52887
   171
wenzelm@52887
   172
    /* commands */
wenzelm@52887
   173
wenzelm@52901
   174
    object Commands
wenzelm@52901
   175
    {
wenzelm@52901
   176
      def apply(commands: Linear_Set[Command]): Commands = new Commands(commands)
wenzelm@52901
   177
      val empty: Commands = apply(Linear_Set.empty)
wenzelm@52901
   178
wenzelm@52901
   179
      def starts(commands: Iterator[Command], offset: Text.Offset = 0)
wenzelm@52901
   180
        : Iterator[(Command, Text.Offset)] =
wenzelm@52901
   181
      {
wenzelm@52901
   182
        var i = offset
wenzelm@52901
   183
        for (command <- commands) yield {
wenzelm@52901
   184
          val start = i
wenzelm@52901
   185
          i += command.length
wenzelm@52901
   186
          (command, start)
wenzelm@52901
   187
        }
wenzelm@52901
   188
      }
wenzelm@52901
   189
wenzelm@56398
   190
      private val block_size = 256
wenzelm@52901
   191
    }
wenzelm@52901
   192
wenzelm@52901
   193
    final class Commands private(val commands: Linear_Set[Command])
wenzelm@38227
   194
    {
wenzelm@56314
   195
      lazy val load_commands: List[Command] =
wenzelm@54513
   196
        commands.iterator.filter(cmd => !cmd.blobs.isEmpty).toList
wenzelm@54462
   197
wenzelm@52901
   198
      private lazy val full_index: (Array[(Command, Text.Offset)], Text.Range) =
wenzelm@52901
   199
      {
wenzelm@52901
   200
        val blocks = new mutable.ListBuffer[(Command, Text.Offset)]
wenzelm@52901
   201
        var next_block = 0
wenzelm@52901
   202
        var last_stop = 0
wenzelm@52901
   203
        for ((command, start) <- Commands.starts(commands.iterator)) {
wenzelm@52901
   204
          last_stop = start + command.length
wenzelm@52901
   205
          while (last_stop + 1 > next_block) {
wenzelm@52901
   206
            blocks += (command -> start)
wenzelm@52901
   207
            next_block += Commands.block_size
wenzelm@52901
   208
          }
wenzelm@52901
   209
        }
wenzelm@52901
   210
        (blocks.toArray, Text.Range(0, last_stop))
wenzelm@52901
   211
      }
wenzelm@52901
   212
wenzelm@52901
   213
      private def full_range: Text.Range = full_index._2
wenzelm@52901
   214
wenzelm@56373
   215
      def iterator(i: Text.Offset = 0): Iterator[(Command, Text.Offset)] =
wenzelm@52901
   216
      {
wenzelm@52901
   217
        if (!commands.isEmpty && full_range.contains(i)) {
wenzelm@52901
   218
          val (cmd0, start0) = full_index._1(i / Commands.block_size)
wenzelm@52901
   219
          Node.Commands.starts(commands.iterator(cmd0), start0) dropWhile {
wenzelm@52901
   220
            case (cmd, start) => start + cmd.length <= i }
wenzelm@52901
   221
        }
wenzelm@52901
   222
        else Iterator.empty
wenzelm@38227
   223
      }
wenzelm@38227
   224
    }
wenzelm@38151
   225
  }
wenzelm@38151
   226
wenzelm@46712
   227
  final class Node private(
wenzelm@56335
   228
    val get_blob: Option[Document.Blob] = None,
wenzelm@48707
   229
    val header: Node.Header = Node.bad_header("Bad theory header"),
wenzelm@52849
   230
    val perspective: Node.Perspective_Command =
wenzelm@52887
   231
      Node.Perspective(false, Command.Perspective.empty, Node.Overlays.empty),
wenzelm@52901
   232
    _commands: Node.Commands = Node.Commands.empty)
wenzelm@38151
   233
  {
wenzelm@46680
   234
    def clear: Node = new Node(header = header)
wenzelm@46680
   235
wenzelm@56335
   236
    def init_blob(blob: Document.Blob): Node = new Node(Some(blob.unchanged))
wenzelm@55435
   237
wenzelm@48707
   238
    def update_header(new_header: Node.Header): Node =
wenzelm@56335
   239
      new Node(get_blob, new_header, perspective, _commands)
wenzelm@46680
   240
wenzelm@52849
   241
    def update_perspective(new_perspective: Node.Perspective_Command): Node =
wenzelm@56335
   242
      new Node(get_blob, header, new_perspective, _commands)
wenzelm@46680
   243
wenzelm@52849
   244
    def same_perspective(other_perspective: Node.Perspective_Command): Boolean =
wenzelm@52849
   245
      perspective.required == other_perspective.required &&
wenzelm@52849
   246
      perspective.visible.same(other_perspective.visible) &&
wenzelm@52849
   247
      perspective.overlays == other_perspective.overlays
wenzelm@52808
   248
wenzelm@52901
   249
    def commands: Linear_Set[Command] = _commands.commands
wenzelm@56314
   250
    def load_commands: List[Command] = _commands.load_commands
wenzelm@43697
   251
wenzelm@52901
   252
    def update_commands(new_commands: Linear_Set[Command]): Node =
wenzelm@52918
   253
      if (new_commands eq _commands.commands) this
wenzelm@56335
   254
      else new Node(get_blob, header, perspective, Node.Commands(new_commands))
wenzelm@38151
   255
wenzelm@56373
   256
    def command_iterator(i: Text.Offset = 0): Iterator[(Command, Text.Offset)] =
wenzelm@56373
   257
      _commands.iterator(i)
wenzelm@38151
   258
wenzelm@56373
   259
    def command_iterator(range: Text.Range): Iterator[(Command, Text.Offset)] =
wenzelm@56373
   260
      command_iterator(range.start) takeWhile { case (_, start) => start < range.stop }
wenzelm@38151
   261
wenzelm@38879
   262
    def command_start(cmd: Command): Option[Text.Offset] =
wenzelm@52901
   263
      Node.Commands.starts(commands.iterator).find(_._1 == cmd).map(_._2)
wenzelm@38151
   264
  }
wenzelm@38151
   265
wenzelm@38151
   266
wenzelm@46723
   267
  /* development graph */
wenzelm@46723
   268
wenzelm@46723
   269
  object Nodes
wenzelm@46723
   270
  {
wenzelm@46723
   271
    val empty: Nodes = new Nodes(Graph.empty(Node.Name.Ordering))
wenzelm@46723
   272
  }
wenzelm@46723
   273
wenzelm@46723
   274
  final class Nodes private(graph: Graph[Node.Name, Node])
wenzelm@46723
   275
  {
wenzelm@46723
   276
    def get_name(s: String): Option[Node.Name] =
wenzelm@56372
   277
      graph.keys_iterator.find(name => name.node == s)
wenzelm@46723
   278
wenzelm@46723
   279
    def apply(name: Node.Name): Node =
wenzelm@46723
   280
      graph.default_node(name, Node.empty).get_node(name)
wenzelm@46723
   281
wenzelm@46723
   282
    def + (entry: (Node.Name, Node)): Nodes =
wenzelm@46723
   283
    {
wenzelm@46723
   284
      val (name, node) = entry
wenzelm@48707
   285
      val imports = node.header.imports
wenzelm@46723
   286
      val graph1 =
wenzelm@46739
   287
        (graph.default_node(name, Node.empty) /: imports)((g, p) => g.default_node(p, Node.empty))
wenzelm@46723
   288
      val graph2 = (graph1 /: graph1.imm_preds(name))((g, dep) => g.del_edge(dep, name))
wenzelm@46739
   289
      val graph3 = (graph2 /: imports)((g, dep) => g.add_edge(dep, name))
wenzelm@46723
   290
      new Nodes(graph3.map_node(name, _ => node))
wenzelm@46723
   291
    }
wenzelm@46723
   292
wenzelm@56372
   293
    def iterator: Iterator[(Node.Name, Node)] =
wenzelm@56372
   294
      graph.iterator.map({ case (name, (node, _)) => (name, node) })
wenzelm@46723
   295
wenzelm@56314
   296
    def load_commands(file_name: Node.Name): List[Command] =
wenzelm@54528
   297
      (for {
wenzelm@56372
   298
        (_, node) <- iterator
wenzelm@56314
   299
        cmd <- node.load_commands.iterator
wenzelm@54530
   300
        name <- cmd.blobs_names.iterator
wenzelm@54528
   301
        if name == file_name
wenzelm@54528
   302
      } yield cmd).toList
wenzelm@54528
   303
wenzelm@46942
   304
    def descendants(names: List[Node.Name]): List[Node.Name] = graph.all_succs(names)
wenzelm@46723
   305
    def topological_order: List[Node.Name] = graph.topological_order
wenzelm@56337
   306
wenzelm@56337
   307
    override def toString: String = topological_order.mkString("Nodes(", ",", ")")
wenzelm@46723
   308
  }
wenzelm@46723
   309
wenzelm@46723
   310
wenzelm@38424
   311
wenzelm@38424
   312
  /** versioning **/
wenzelm@38424
   313
wenzelm@38424
   314
  /* particular document versions */
wenzelm@34485
   315
wenzelm@38417
   316
  object Version
wenzelm@38417
   317
  {
wenzelm@46681
   318
    val init: Version = new Version()
wenzelm@46681
   319
wenzelm@56394
   320
    def make(syntax: Option[Prover.Syntax], nodes: Nodes): Version =
wenzelm@52530
   321
      new Version(Document_ID.make(), syntax, nodes)
wenzelm@38417
   322
  }
wenzelm@38417
   323
wenzelm@46712
   324
  final class Version private(
wenzelm@52530
   325
    val id: Document_ID.Version = Document_ID.none,
wenzelm@56394
   326
    val syntax: Option[Prover.Syntax] = None,
wenzelm@46723
   327
    val nodes: Nodes = Nodes.empty)
wenzelm@46941
   328
  {
wenzelm@55777
   329
    override def toString: String = "Version(" + id + ")"
wenzelm@46941
   330
  }
immler@34660
   331
wenzelm@34859
   332
wenzelm@38424
   333
  /* changes of plain text, eventually resulting in document edits */
wenzelm@38227
   334
wenzelm@38227
   335
  object Change
wenzelm@38227
   336
  {
wenzelm@46678
   337
    val init: Change = new Change()
wenzelm@46678
   338
wenzelm@46678
   339
    def make(previous: Future[Version], edits: List[Edit_Text], version: Future[Version]): Change =
wenzelm@46678
   340
      new Change(Some(previous), edits, version)
wenzelm@38227
   341
  }
wenzelm@38227
   342
wenzelm@46712
   343
  final class Change private(
wenzelm@46677
   344
    val previous: Option[Future[Version]] = Some(Future.value(Version.init)),
wenzelm@46677
   345
    val edits: List[Edit_Text] = Nil,
wenzelm@46677
   346
    val version: Future[Version] = Future.value(Version.init))
wenzelm@38227
   347
  {
wenzelm@44672
   348
    def is_finished: Boolean =
wenzelm@44672
   349
      (previous match { case None => true case Some(future) => future.is_finished }) &&
wenzelm@44672
   350
      version.is_finished
wenzelm@44672
   351
wenzelm@46678
   352
    def truncate: Change = new Change(None, Nil, version)
wenzelm@38227
   353
  }
wenzelm@38227
   354
wenzelm@38227
   355
wenzelm@38841
   356
  /* history navigation */
wenzelm@38841
   357
wenzelm@38841
   358
  object History
wenzelm@38841
   359
  {
wenzelm@46679
   360
    val init: History = new History()
wenzelm@38841
   361
  }
wenzelm@38841
   362
wenzelm@46712
   363
  final class History private(
wenzelm@46679
   364
    val undo_list: List[Change] = List(Change.init))  // non-empty list
wenzelm@38841
   365
  {
wenzelm@46679
   366
    def tip: Change = undo_list.head
wenzelm@46679
   367
    def + (change: Change): History = new History(change :: undo_list)
wenzelm@38841
   368
wenzelm@46679
   369
    def prune(check: Change => Boolean, retain: Int): Option[(List[Change], History)] =
wenzelm@46679
   370
    {
wenzelm@46679
   371
      val n = undo_list.iterator.zipWithIndex.find(p => check(p._1)).get._2 + 1
wenzelm@46679
   372
      val (retained, dropped) = undo_list.splitAt(n max retain)
wenzelm@46679
   373
wenzelm@46679
   374
      retained.splitAt(retained.length - 1) match {
wenzelm@46679
   375
        case (prefix, List(last)) => Some(dropped, new History(prefix ::: List(last.truncate)))
wenzelm@46679
   376
        case _ => None
wenzelm@46679
   377
      }
wenzelm@46679
   378
    }
wenzelm@38841
   379
  }
wenzelm@38841
   380
wenzelm@38841
   381
wenzelm@55820
   382
  /* snapshot */
wenzelm@38424
   383
wenzelm@52972
   384
  object Snapshot
wenzelm@52972
   385
  {
wenzelm@52972
   386
    val init = State.init.snapshot()
wenzelm@52972
   387
  }
wenzelm@52972
   388
wenzelm@38424
   389
  abstract class Snapshot
wenzelm@38424
   390
  {
wenzelm@44582
   391
    val state: State
wenzelm@38424
   392
    val version: Version
wenzelm@38424
   393
    val is_outdated: Boolean
wenzelm@55649
   394
wenzelm@38427
   395
    def convert(i: Text.Offset): Text.Offset
wenzelm@52889
   396
    def revert(i: Text.Offset): Text.Offset
wenzelm@39177
   397
    def convert(range: Text.Range): Text.Range
wenzelm@39177
   398
    def revert(range: Text.Range): Text.Range
wenzelm@52972
   399
wenzelm@52972
   400
    val node_name: Node.Name
wenzelm@52972
   401
    val node: Node
wenzelm@56314
   402
    val load_commands: List[Command]
wenzelm@56176
   403
    def is_loaded: Boolean
wenzelm@51494
   404
    def eq_content(other: Snapshot): Boolean
wenzelm@55649
   405
wenzelm@55651
   406
    def cumulate[A](
wenzelm@55649
   407
      range: Text.Range,
wenzelm@55649
   408
      info: A,
wenzelm@56743
   409
      elements: Markup.Elements,
wenzelm@56354
   410
      result: List[Command.State] => (A, Text.Markup) => Option[A],
wenzelm@55651
   411
      status: Boolean = false): List[Text.Info[A]]
wenzelm@55651
   412
wenzelm@55651
   413
    def select[A](
wenzelm@55649
   414
      range: Text.Range,
wenzelm@56743
   415
      elements: Markup.Elements,
wenzelm@56354
   416
      result: List[Command.State] => Text.Markup => Option[A],
wenzelm@55651
   417
      status: Boolean = false): List[Text.Info[A]]
wenzelm@38424
   418
  }
wenzelm@38424
   419
wenzelm@55820
   420
wenzelm@55820
   421
wenzelm@55820
   422
  /** global state -- document structure, execution process, editing history **/
wenzelm@55820
   423
wenzelm@52563
   424
  type Assign_Update =
wenzelm@52563
   425
    List[(Document_ID.Command, List[Document_ID.Exec])]  // update of exec state assignment
wenzelm@44476
   426
wenzelm@38370
   427
  object State
wenzelm@38370
   428
  {
wenzelm@38373
   429
    class Fail(state: State) extends Exception
wenzelm@38373
   430
wenzelm@44479
   431
    object Assignment
wenzelm@44479
   432
    {
wenzelm@46683
   433
      val init: Assignment = new Assignment()
wenzelm@44479
   434
    }
wenzelm@38370
   435
wenzelm@46712
   436
    final class Assignment private(
wenzelm@52530
   437
      val command_execs: Map[Document_ID.Command, List[Document_ID.Exec]] = Map.empty,
wenzelm@46677
   438
      val is_finished: Boolean = false)
wenzelm@38370
   439
    {
wenzelm@44477
   440
      def check_finished: Assignment = { require(is_finished); this }
wenzelm@47388
   441
      def unfinished: Assignment = new Assignment(command_execs, false)
wenzelm@44479
   442
wenzelm@52563
   443
      def assign(update: Assign_Update): Assignment =
wenzelm@38370
   444
      {
wenzelm@38976
   445
        require(!is_finished)
wenzelm@44479
   446
        val command_execs1 =
wenzelm@52563
   447
          (command_execs /: update) {
wenzelm@52563
   448
            case (res, (command_id, exec_ids)) =>
wenzelm@52563
   449
              if (exec_ids.isEmpty) res - command_id
wenzelm@52563
   450
              else res + (command_id -> exec_ids)
wenzelm@44479
   451
          }
wenzelm@47388
   452
        new Assignment(command_execs1, true)
wenzelm@38150
   453
      }
wenzelm@38370
   454
    }
wenzelm@46682
   455
wenzelm@46682
   456
    val init: State =
wenzelm@52563
   457
      State().define_version(Version.init, Assignment.init).assign(Version.init.id, Nil)._2
wenzelm@38370
   458
  }
wenzelm@38370
   459
wenzelm@46712
   460
  final case class State private(
wenzelm@56470
   461
    /*reachable versions*/
wenzelm@52530
   462
    val versions: Map[Document_ID.Version, Version] = Map.empty,
wenzelm@56470
   463
    /*inlined auxiliary files*/
wenzelm@56470
   464
    val blobs: Set[SHA1.Digest] = Set.empty,
wenzelm@56470
   465
    /*static markup from define_command*/
wenzelm@56470
   466
    val commands: Map[Document_ID.Command, Command.State] = Map.empty,
wenzelm@56470
   467
    /*dynamic markup from execution*/
wenzelm@56470
   468
    val execs: Map[Document_ID.Exec, Command.State] = Map.empty,
wenzelm@56470
   469
    /*command-exec assignment for each version*/
wenzelm@52530
   470
    val assignments: Map[Document_ID.Version, State.Assignment] = Map.empty,
wenzelm@56470
   471
    /*commands with markup produced by other commands (imm_succs)*/
wenzelm@56475
   472
    val commands_redirection: Graph[Document_ID.Command, Unit] = Graph.long,
wenzelm@56470
   473
    /*explicit (linear) history*/
wenzelm@38841
   474
    val history: History = History.init)
wenzelm@38370
   475
  {
wenzelm@38373
   476
    private def fail[A]: A = throw new State.Fail(this)
wenzelm@38370
   477
wenzelm@44479
   478
    def define_version(version: Version, assignment: State.Assignment): State =
wenzelm@38370
   479
    {
wenzelm@38417
   480
      val id = version.id
wenzelm@38417
   481
      copy(versions = versions + (id -> version),
wenzelm@44479
   482
        assignments = assignments + (id -> assignment.unfinished))
wenzelm@38370
   483
    }
wenzelm@38370
   484
wenzelm@54519
   485
    def define_blob(digest: SHA1.Digest): State = copy(blobs = blobs + digest)
wenzelm@54519
   486
    def defined_blob(digest: SHA1.Digest): Boolean = blobs.contains(digest)
wenzelm@54519
   487
wenzelm@38373
   488
    def define_command(command: Command): State =
wenzelm@38373
   489
    {
wenzelm@38373
   490
      val id = command.id
wenzelm@49414
   491
      copy(commands = commands + (id -> command.init_state))
wenzelm@38373
   492
    }
wenzelm@38373
   493
wenzelm@52530
   494
    def defined_command(id: Document_ID.Command): Boolean = commands.isDefinedAt(id)
wenzelm@44582
   495
wenzelm@52531
   496
    def find_command(version: Version, id: Document_ID.Generic): Option[(Node, Command)] =
wenzelm@44582
   497
      commands.get(id) orElse execs.get(id) match {
wenzelm@44582
   498
        case None => None
wenzelm@44582
   499
        case Some(st) =>
wenzelm@44582
   500
          val command = st.command
wenzelm@46681
   501
          val node = version.nodes(command.node_name)
wenzelm@54328
   502
          if (node.commands.contains(command)) Some((node, command)) else None
wenzelm@44582
   503
      }
wenzelm@38373
   504
wenzelm@52530
   505
    def the_version(id: Document_ID.Version): Version = versions.getOrElse(id, fail)
wenzelm@52564
   506
    def the_static_state(id: Document_ID.Command): Command.State = commands.getOrElse(id, fail)
wenzelm@52564
   507
    def the_dynamic_state(id: Document_ID.Exec): Command.State = execs.getOrElse(id, fail)
wenzelm@52563
   508
    def the_assignment(version: Version): State.Assignment = assignments.getOrElse(version.id, fail)
wenzelm@38370
   509
wenzelm@56470
   510
    private def self_id(st: Command.State)(id: Document_ID.Generic): Boolean =
wenzelm@56295
   511
      id == st.command.id ||
wenzelm@56295
   512
      (execs.get(id) match { case Some(st1) => st1.command.id == st.command.id case None => false })
wenzelm@56295
   513
wenzelm@56746
   514
    private def other_id(id: Document_ID.Generic)
wenzelm@56746
   515
      : Option[(Symbol.Text_Chunk.Id, Symbol.Text_Chunk)] = None
wenzelm@56514
   516
    /* FIXME
wenzelm@56470
   517
      (execs.get(id) orElse commands.get(id)).map(st =>
wenzelm@56746
   518
        ((Symbol.Text_Chunk.Id(st.command.id), st.command.chunk)))
wenzelm@56514
   519
    */
wenzelm@56470
   520
wenzelm@56475
   521
    private def redirection(st: Command.State): Graph[Document_ID.Command, Unit] =
wenzelm@56475
   522
      (commands_redirection /: st.markups.redirection_iterator)({ case (graph, id) =>
wenzelm@56470
   523
        graph.default_node(id, ()).default_node(st.command.id, ()).add_edge(id, st.command.id) })
wenzelm@56470
   524
wenzelm@52531
   525
    def accumulate(id: Document_ID.Generic, message: XML.Elem): (Command.State, State) =
wenzelm@56470
   526
    {
wenzelm@38370
   527
      execs.get(id) match {
wenzelm@44446
   528
        case Some(st) =>
wenzelm@56470
   529
          val new_st = st.accumulate(self_id(st), other_id _, message)
wenzelm@56470
   530
          val execs1 = execs + (id -> new_st)
wenzelm@56475
   531
          (new_st, copy(execs = execs1, commands_redirection = redirection(new_st)))
wenzelm@38370
   532
        case None =>
wenzelm@38370
   533
          commands.get(id) match {
wenzelm@38370
   534
            case Some(st) =>
wenzelm@56470
   535
              val new_st = st.accumulate(self_id(st), other_id _, message)
wenzelm@56470
   536
              val commands1 = commands + (id -> new_st)
wenzelm@56475
   537
              (new_st, copy(commands = commands1, commands_redirection = redirection(new_st)))
wenzelm@38370
   538
            case None => fail
wenzelm@38370
   539
          }
wenzelm@38370
   540
      }
wenzelm@56470
   541
    }
wenzelm@38370
   542
wenzelm@52563
   543
    def assign(id: Document_ID.Version, update: Assign_Update): (List[Command], State) =
wenzelm@38370
   544
    {
wenzelm@38417
   545
      val version = the_version(id)
wenzelm@38370
   546
wenzelm@52566
   547
      def upd(exec_id: Document_ID.Exec, st: Command.State)
wenzelm@52566
   548
          : Option[(Document_ID.Exec, Command.State)] =
wenzelm@52566
   549
        if (execs.isDefinedAt(exec_id)) None else Some(exec_id -> st)
wenzelm@52566
   550
wenzelm@44543
   551
      val (changed_commands, new_execs) =
wenzelm@52563
   552
        ((Nil: List[Command], execs) /: update) {
wenzelm@52566
   553
          case ((commands1, execs1), (command_id, exec)) =>
wenzelm@52566
   554
            val st = the_static_state(command_id)
wenzelm@52566
   555
            val command = st.command
wenzelm@52527
   556
            val commands2 = command :: commands1
wenzelm@44543
   557
            val execs2 =
wenzelm@44543
   558
              exec match {
wenzelm@52527
   559
                case Nil => execs1
wenzelm@52527
   560
                case eval_id :: print_ids =>
wenzelm@52566
   561
                  execs1 ++ upd(eval_id, st) ++
wenzelm@52566
   562
                    (for (id <- print_ids; up <- upd(id, command.empty_state)) yield up)
wenzelm@44543
   563
              }
wenzelm@44543
   564
            (commands2, execs2)
wenzelm@38370
   565
        }
wenzelm@52563
   566
      val new_assignment = the_assignment(version).assign(update)
wenzelm@43722
   567
      val new_state = copy(assignments = assignments + (id -> new_assignment), execs = new_execs)
wenzelm@44476
   568
wenzelm@44543
   569
      (changed_commands, new_state)
wenzelm@38370
   570
    }
wenzelm@38370
   571
wenzelm@38417
   572
    def is_assigned(version: Version): Boolean =
wenzelm@43722
   573
      assignments.get(version.id) match {
wenzelm@38370
   574
        case Some(assgn) => assgn.is_finished
wenzelm@38370
   575
        case None => false
wenzelm@38370
   576
      }
wenzelm@38370
   577
wenzelm@44436
   578
    def is_stable(change: Change): Boolean =
wenzelm@44436
   579
      change.is_finished && is_assigned(change.version.get_finished)
wenzelm@44436
   580
wenzelm@46944
   581
    def recent_finished: Change = history.undo_list.find(_.is_finished) getOrElse fail
wenzelm@44672
   582
    def recent_stable: Change = history.undo_list.find(is_stable) getOrElse fail
wenzelm@44436
   583
    def tip_stable: Boolean = is_stable(history.tip)
wenzelm@44475
   584
    def tip_version: Version = history.tip.version.get_finished
wenzelm@44436
   585
wenzelm@44446
   586
    def continue_history(
wenzelm@56711
   587
      previous: Future[Version],
wenzelm@56711
   588
      edits: List[Edit_Text],
wenzelm@56711
   589
      version: Future[Version]): State =
wenzelm@38841
   590
    {
wenzelm@46678
   591
      val change = Change.make(previous, edits, version)
wenzelm@56711
   592
      copy(history = history + change)
wenzelm@38841
   593
    }
wenzelm@38841
   594
wenzelm@44672
   595
    def prune_history(retain: Int = 0): (List[Version], State) =
wenzelm@44672
   596
    {
wenzelm@46679
   597
      history.prune(is_stable, retain) match {
wenzelm@46679
   598
        case Some((dropped, history1)) =>
wenzelm@44672
   599
          val dropped_versions = dropped.map(change => change.version.get_finished)
wenzelm@46679
   600
          val state1 = copy(history = history1)
wenzelm@44672
   601
          (dropped_versions, state1)
wenzelm@46679
   602
        case None => fail
wenzelm@44672
   603
      }
wenzelm@44672
   604
    }
wenzelm@44672
   605
wenzelm@52530
   606
    def removed_versions(removed: List[Document_ID.Version]): State =
wenzelm@44676
   607
    {
wenzelm@44676
   608
      val versions1 = versions -- removed
wenzelm@44676
   609
      val assignments1 = assignments -- removed
wenzelm@54519
   610
      var blobs1 = Set.empty[SHA1.Digest]
wenzelm@52530
   611
      var commands1 = Map.empty[Document_ID.Command, Command.State]
wenzelm@52530
   612
      var execs1 = Map.empty[Document_ID.Exec, Command.State]
wenzelm@44676
   613
      for {
wenzelm@44676
   614
        (version_id, version) <- versions1.iterator
wenzelm@46997
   615
        command_execs = assignments1(version_id).command_execs
wenzelm@56372
   616
        (_, node) <- version.nodes.iterator
wenzelm@44676
   617
        command <- node.commands.iterator
wenzelm@44676
   618
      } {
wenzelm@54519
   619
        for (digest <- command.blobs_digests; if !blobs1.contains(digest))
wenzelm@54519
   620
          blobs1 += digest
wenzelm@54519
   621
wenzelm@52568
   622
        if (!commands1.isDefinedAt(command.id))
wenzelm@52568
   623
          commands.get(command.id).foreach(st => commands1 += (command.id -> st))
wenzelm@54519
   624
wenzelm@52568
   625
        for (exec_id <- command_execs.getOrElse(command.id, Nil)) {
wenzelm@52527
   626
          if (!execs1.isDefinedAt(exec_id))
wenzelm@52527
   627
            execs.get(exec_id).foreach(st => execs1 += (exec_id -> st))
wenzelm@44676
   628
        }
wenzelm@44676
   629
      }
wenzelm@56470
   630
      copy(
wenzelm@56470
   631
        versions = versions1,
wenzelm@56470
   632
        blobs = blobs1,
wenzelm@56470
   633
        commands = commands1,
wenzelm@56470
   634
        execs = execs1,
wenzelm@56475
   635
        commands_redirection = commands_redirection.restrict(commands1.isDefinedAt(_)),
wenzelm@54519
   636
        assignments = assignments1)
wenzelm@44676
   637
    }
wenzelm@44676
   638
wenzelm@56470
   639
    private def command_states_self(version: Version, command: Command)
wenzelm@56470
   640
      : List[(Document_ID.Generic, Command.State)] =
wenzelm@44613
   641
    {
wenzelm@44613
   642
      require(is_assigned(version))
wenzelm@44613
   643
      try {
wenzelm@52527
   644
        the_assignment(version).check_finished.command_execs.getOrElse(command.id, Nil)
wenzelm@56470
   645
          .map(id => id -> the_dynamic_state(id)) match {
wenzelm@52527
   646
            case Nil => fail
wenzelm@56470
   647
            case res => res
wenzelm@52527
   648
          }
wenzelm@44613
   649
      }
wenzelm@47395
   650
      catch {
wenzelm@47395
   651
        case _: State.Fail =>
wenzelm@56470
   652
          try { List(command.id -> the_static_state(command.id)) }
wenzelm@56470
   653
          catch { case _: State.Fail => List(command.id -> command.init_state) }
wenzelm@47395
   654
      }
wenzelm@44613
   655
    }
wenzelm@44613
   656
wenzelm@56470
   657
    def command_states(version: Version, command: Command): List[Command.State] =
wenzelm@56470
   658
    {
wenzelm@56470
   659
      val self = command_states_self(version, command)
wenzelm@56470
   660
      val others =
wenzelm@56475
   661
        if (commands_redirection.defined(command.id)) {
wenzelm@56470
   662
          (for {
wenzelm@56475
   663
            command_id <- commands_redirection.imm_succs(command.id).iterator
wenzelm@56470
   664
            (id, st) <- command_states_self(version, the_static_state(command_id).command)
wenzelm@56470
   665
            if !self.exists(_._1 == id)
wenzelm@56470
   666
          } yield (id, st)).toMap.valuesIterator.toList
wenzelm@56470
   667
        }
wenzelm@56470
   668
        else Nil
wenzelm@56489
   669
      self.map(_._2) ::: others.flatMap(_.redirect(command))
wenzelm@56470
   670
    }
wenzelm@56470
   671
wenzelm@56299
   672
    def command_results(version: Version, command: Command): Command.Results =
wenzelm@56299
   673
      Command.State.merge_results(command_states(version, command))
wenzelm@56299
   674
wenzelm@56301
   675
    def command_markup(version: Version, command: Command, index: Command.Markup_Index,
wenzelm@56743
   676
        range: Text.Range, elements: Markup.Elements): Markup_Tree =
wenzelm@56301
   677
      Command.State.merge_markup(command_states(version, command), index, range, elements)
wenzelm@56299
   678
wenzelm@56743
   679
    def markup_to_XML(version: Version, node: Node, elements: Markup.Elements): XML.Body =
wenzelm@56299
   680
      (for {
wenzelm@56299
   681
        command <- node.commands.iterator
wenzelm@56301
   682
        markup =
wenzelm@56301
   683
          command_markup(version, command, Command.Markup_Index.markup, command.range, elements)
wenzelm@56300
   684
        tree <- markup.to_XML(command.range, command.source, elements)
wenzelm@56299
   685
      } yield tree).toList
wenzelm@38841
   686
wenzelm@38841
   687
    // persistent user-view
wenzelm@49346
   688
    def snapshot(name: Node.Name = Node.Name.empty, pending_edits: List[Text.Edit] = Nil)
wenzelm@49346
   689
      : Snapshot =
wenzelm@38370
   690
    {
wenzelm@44672
   691
      val stable = recent_stable
wenzelm@44436
   692
      val latest = history.tip
wenzelm@38841
   693
wenzelm@44156
   694
      // FIXME proper treatment of removed nodes
wenzelm@38841
   695
      val edits =
wenzelm@38841
   696
        (pending_edits /: history.undo_list.takeWhile(_ != stable))((edits, change) =>
wenzelm@44156
   697
            (for ((a, Node.Edits(es)) <- change.edits if a == name) yield es).flatten ::: edits)
wenzelm@38841
   698
      lazy val reverse_edits = edits.reverse
wenzelm@38841
   699
wenzelm@38841
   700
      new Snapshot
wenzelm@38841
   701
      {
wenzelm@52972
   702
        /* global information */
wenzelm@52972
   703
wenzelm@44582
   704
        val state = State.this
wenzelm@39698
   705
        val version = stable.version.get_finished
wenzelm@38841
   706
        val is_outdated = !(pending_edits.isEmpty && latest == stable)
wenzelm@38841
   707
wenzelm@55649
   708
wenzelm@55649
   709
        /* local node content */
wenzelm@55649
   710
wenzelm@38841
   711
        def convert(offset: Text.Offset) = (offset /: edits)((i, edit) => edit.convert(i))
wenzelm@38841
   712
        def revert(offset: Text.Offset) = (offset /: reverse_edits)((i, edit) => edit.revert(i))
wenzelm@43425
   713
        def convert(range: Text.Range) = (range /: edits)((r, edit) => edit.convert(r))
wenzelm@43425
   714
        def revert(range: Text.Range) = (range /: reverse_edits)((r, edit) => edit.revert(r))
wenzelm@39177
   715
wenzelm@52972
   716
        val node_name = name
wenzelm@52972
   717
        val node = version.nodes(name)
wenzelm@52972
   718
wenzelm@56314
   719
        val load_commands: List[Command] =
wenzelm@55432
   720
          if (node_name.is_theory) Nil
wenzelm@56314
   721
          else version.nodes.load_commands(node_name)
wenzelm@55432
   722
wenzelm@56314
   723
        val is_loaded: Boolean = node_name.is_theory || !load_commands.isEmpty
wenzelm@56176
   724
wenzelm@51494
   725
        def eq_content(other: Snapshot): Boolean =
wenzelm@55434
   726
        {
wenzelm@55434
   727
          def eq_commands(commands: (Command, Command)): Boolean =
wenzelm@56299
   728
          {
wenzelm@56299
   729
            val states1 = state.command_states(version, commands._1)
wenzelm@56299
   730
            val states2 = other.state.command_states(other.version, commands._2)
wenzelm@56299
   731
            states1.length == states2.length &&
wenzelm@56299
   732
            (states1 zip states2).forall({ case (st1, st2) => st1 eq_content st2 })
wenzelm@56299
   733
          }
wenzelm@55434
   734
wenzelm@49346
   735
          !is_outdated && !other.is_outdated &&
wenzelm@55434
   736
          node.commands.size == other.node.commands.size &&
wenzelm@55434
   737
          (node.commands.iterator zip other.node.commands.iterator).forall(eq_commands) &&
wenzelm@56314
   738
          load_commands.length == other.load_commands.length &&
wenzelm@56314
   739
          (load_commands zip other.load_commands).forall(eq_commands)
wenzelm@55434
   740
        }
wenzelm@49346
   741
wenzelm@55649
   742
wenzelm@55649
   743
        /* cumulate markup */
wenzelm@55649
   744
wenzelm@55651
   745
        def cumulate[A](
wenzelm@55649
   746
          range: Text.Range,
wenzelm@55649
   747
          info: A,
wenzelm@56743
   748
          elements: Markup.Elements,
wenzelm@56354
   749
          result: List[Command.State] => (A, Text.Markup) => Option[A],
wenzelm@55651
   750
          status: Boolean = false): List[Text.Info[A]] =
wenzelm@45459
   751
        {
wenzelm@56590
   752
          val former_range = revert(range).inflate_singularity
wenzelm@56462
   753
          val (chunk_name, command_iterator) =
wenzelm@56314
   754
            load_commands match {
wenzelm@56746
   755
              case command :: _ => (Symbol.Text_Chunk.File(node_name.node), Iterator((command, 0)))
wenzelm@56746
   756
              case _ => (Symbol.Text_Chunk.Default, node.command_iterator(former_range))
wenzelm@56309
   757
            }
wenzelm@56462
   758
          val markup_index = Command.Markup_Index(status, chunk_name)
wenzelm@56309
   759
          (for {
wenzelm@56373
   760
            (command, command_start) <- command_iterator
wenzelm@56462
   761
            chunk <- command.chunks.get(chunk_name).iterator
wenzelm@56309
   762
            states = state.command_states(version, command)
wenzelm@56354
   763
            res = result(states)
wenzelm@56590
   764
            markup_range <- (former_range - command_start).try_restrict(chunk.range).iterator
wenzelm@56590
   765
            markup = Command.State.merge_markup(states, markup_index, markup_range, elements)
wenzelm@56590
   766
            Text.Info(r0, a) <- markup.cumulate[A](markup_range, info, elements,
wenzelm@56309
   767
              {
wenzelm@56309
   768
                case (a, Text.Info(r0, b)) => res(a, Text.Info(convert(r0 + command_start), b))
wenzelm@56309
   769
              }).iterator
wenzelm@56590
   770
            r1 <- convert(r0 + command_start).try_restrict(range).iterator
wenzelm@56590
   771
          } yield Text.Info(r1, a)).toList
wenzelm@45459
   772
        }
wenzelm@45459
   773
wenzelm@55651
   774
        def select[A](
wenzelm@55651
   775
          range: Text.Range,
wenzelm@56743
   776
          elements: Markup.Elements,
wenzelm@56354
   777
          result: List[Command.State] => Text.Markup => Option[A],
wenzelm@55651
   778
          status: Boolean = false): List[Text.Info[A]] =
wenzelm@38845
   779
        {
wenzelm@56354
   780
          def result1(states: List[Command.State]): (Option[A], Text.Markup) => Option[Option[A]] =
wenzelm@50500
   781
          {
wenzelm@56354
   782
            val res = result(states)
wenzelm@52889
   783
            (_: Option[A], x: Text.Markup) =>
wenzelm@52889
   784
              res(x) match {
wenzelm@52889
   785
                case None => None
wenzelm@52889
   786
                case some => Some(some)
wenzelm@52889
   787
              }
wenzelm@50500
   788
          }
wenzelm@55651
   789
          for (Text.Info(r, Some(x)) <- cumulate(range, None, elements, result1 _, status))
wenzelm@46198
   790
            yield Text.Info(r, x)
wenzelm@38845
   791
        }
wenzelm@55800
   792
wenzelm@55800
   793
wenzelm@55800
   794
        /* output */
wenzelm@55800
   795
wenzelm@55800
   796
        override def toString: String =
wenzelm@55800
   797
          "Snapshot(node = " + node_name.node + ", version = " + version.id +
wenzelm@55800
   798
            (if (is_outdated) ", outdated" else "") + ")"
wenzelm@38841
   799
      }
wenzelm@38150
   800
    }
wenzelm@34485
   801
  }
wenzelm@34840
   802
}
wenzelm@34840
   803