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