src/Pure/PIDE/document.scala
author wenzelm
Wed Nov 20 12:24:54 2013 +0100 (2013-11-20)
changeset 54528 842adea880a4
parent 54521 744ea0025e11
child 54530 2c1440f70028
permissions -rw-r--r--
refer to thy_load command of auxiliary file;
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@52977
    41
  }
wenzelm@52977
    42
wenzelm@52977
    43
wenzelm@46723
    44
  /* individual nodes */
wenzelm@38424
    45
wenzelm@44615
    46
  type Edit[A, B] = (Node.Name, Node.Edit[A, B])
wenzelm@44384
    47
  type Edit_Text = Edit[Text.Edit, Text.Perspective]
wenzelm@52849
    48
  type Edit_Command = Edit[Command.Edit, Command.Perspective]
wenzelm@38151
    49
wenzelm@54521
    50
  type Blobs = Map[Node.Name, Bytes]
wenzelm@54521
    51
wenzelm@38151
    52
  object Node
wenzelm@38151
    53
  {
wenzelm@52887
    54
    val empty: Node = new Node()
wenzelm@52887
    55
wenzelm@52887
    56
wenzelm@52887
    57
    /* header and name */
wenzelm@52887
    58
wenzelm@48707
    59
    sealed case class Header(
wenzelm@46938
    60
      imports: List[Name],
wenzelm@48706
    61
      keywords: Thy_Header.Keywords,
wenzelm@48707
    62
      errors: List[String] = Nil)
wenzelm@48707
    63
    {
wenzelm@48707
    64
      def error(msg: String): Header = copy(errors = errors ::: List(msg))
wenzelm@48707
    65
    }
wenzelm@48707
    66
wenzelm@51294
    67
    def bad_header(msg: String): Header = Header(Nil, Nil, List(msg))
wenzelm@46737
    68
wenzelm@54509
    69
    val no_header = bad_header("No theory header")
wenzelm@54509
    70
wenzelm@44957
    71
    object Name
wenzelm@44957
    72
    {
wenzelm@54515
    73
      val empty = Name("")
wenzelm@46723
    74
wenzelm@46723
    75
      object Ordering extends scala.math.Ordering[Name]
wenzelm@46723
    76
      {
wenzelm@46723
    77
        def compare(name1: Name, name2: Name): Int = name1.node compare name2.node
wenzelm@46723
    78
      }
wenzelm@44957
    79
    }
wenzelm@52887
    80
wenzelm@54515
    81
    sealed case class Name(node: String, master_dir: String = "", theory: String = "")
wenzelm@44615
    82
    {
wenzelm@44615
    83
      override def hashCode: Int = node.hashCode
wenzelm@44615
    84
      override def equals(that: Any): Boolean =
wenzelm@44615
    85
        that match {
wenzelm@44615
    86
          case other: Name => node == other.node
wenzelm@44615
    87
          case _ => false
wenzelm@44615
    88
        }
wenzelm@54509
    89
wenzelm@54509
    90
      def is_theory: Boolean = !theory.isEmpty
wenzelm@54510
    91
      override def toString: String = if (is_theory) theory else node
wenzelm@44615
    92
    }
wenzelm@44615
    93
wenzelm@52887
    94
wenzelm@52977
    95
    /* node overlays */
wenzelm@52887
    96
wenzelm@52887
    97
    object Overlays
wenzelm@52887
    98
    {
wenzelm@52976
    99
      val empty = new Overlays(Multi_Map.empty)
wenzelm@52887
   100
    }
wenzelm@52887
   101
wenzelm@52977
   102
    final class Overlays private(rep: Multi_Map[Command, (String, List[String])])
wenzelm@52887
   103
    {
wenzelm@52887
   104
      def commands: Set[Command] = rep.keySet
wenzelm@52887
   105
      def is_empty: Boolean = rep.isEmpty
wenzelm@52977
   106
      def dest: List[(Command, (String, List[String]))] = rep.iterator.toList
wenzelm@52977
   107
      def insert(cmd: Command, fn: String, args: List[String]): Overlays =
wenzelm@52977
   108
        new Overlays(rep.insert(cmd, (fn, args)))
wenzelm@52977
   109
      def remove(cmd: Command, fn: String, args: List[String]): Overlays =
wenzelm@52977
   110
        new Overlays(rep.remove(cmd, (fn, args)))
wenzelm@52887
   111
    }
wenzelm@52887
   112
wenzelm@52887
   113
wenzelm@52887
   114
    /* edits */
wenzelm@52887
   115
wenzelm@44384
   116
    sealed abstract class Edit[A, B]
wenzelm@44156
   117
    {
wenzelm@44383
   118
      def foreach(f: A => Unit)
wenzelm@44383
   119
      {
wenzelm@44156
   120
        this match {
wenzelm@44383
   121
          case Edits(es) => es.foreach(f)
wenzelm@44383
   122
          case _ =>
wenzelm@44156
   123
        }
wenzelm@44383
   124
      }
wenzelm@44156
   125
    }
wenzelm@44384
   126
    case class Clear[A, B]() extends Edit[A, B]
wenzelm@44384
   127
    case class Edits[A, B](edits: List[A]) extends Edit[A, B]
wenzelm@48707
   128
    case class Deps[A, B](header: Header) extends Edit[A, B]
wenzelm@52849
   129
    case class Perspective[A, B](required: Boolean, visible: B, overlays: Overlays) extends Edit[A, B]
wenzelm@54521
   130
    case class Blob[A, B]() extends Edit[A, B]
wenzelm@52808
   131
    type Perspective_Text = Perspective[Text.Edit, Text.Perspective]
wenzelm@52849
   132
    type Perspective_Command = Perspective[Command.Edit, Command.Perspective]
wenzelm@44156
   133
wenzelm@52887
   134
wenzelm@52887
   135
    /* commands */
wenzelm@52887
   136
wenzelm@52901
   137
    object Commands
wenzelm@52901
   138
    {
wenzelm@52901
   139
      def apply(commands: Linear_Set[Command]): Commands = new Commands(commands)
wenzelm@52901
   140
      val empty: Commands = apply(Linear_Set.empty)
wenzelm@52901
   141
wenzelm@52901
   142
      def starts(commands: Iterator[Command], offset: Text.Offset = 0)
wenzelm@52901
   143
        : Iterator[(Command, Text.Offset)] =
wenzelm@52901
   144
      {
wenzelm@52901
   145
        var i = offset
wenzelm@52901
   146
        for (command <- commands) yield {
wenzelm@52901
   147
          val start = i
wenzelm@52901
   148
          i += command.length
wenzelm@52901
   149
          (command, start)
wenzelm@52901
   150
        }
wenzelm@52901
   151
      }
wenzelm@52901
   152
wenzelm@52901
   153
      private val block_size = 1024
wenzelm@52901
   154
    }
wenzelm@52901
   155
wenzelm@52901
   156
    final class Commands private(val commands: Linear_Set[Command])
wenzelm@38227
   157
    {
wenzelm@54462
   158
      lazy val thy_load_commands: List[Command] =
wenzelm@54513
   159
        commands.iterator.filter(cmd => !cmd.blobs.isEmpty).toList
wenzelm@54462
   160
wenzelm@52901
   161
      private lazy val full_index: (Array[(Command, Text.Offset)], Text.Range) =
wenzelm@52901
   162
      {
wenzelm@52901
   163
        val blocks = new mutable.ListBuffer[(Command, Text.Offset)]
wenzelm@52901
   164
        var next_block = 0
wenzelm@52901
   165
        var last_stop = 0
wenzelm@52901
   166
        for ((command, start) <- Commands.starts(commands.iterator)) {
wenzelm@52901
   167
          last_stop = start + command.length
wenzelm@52901
   168
          while (last_stop + 1 > next_block) {
wenzelm@52901
   169
            blocks += (command -> start)
wenzelm@52901
   170
            next_block += Commands.block_size
wenzelm@52901
   171
          }
wenzelm@52901
   172
        }
wenzelm@52901
   173
        (blocks.toArray, Text.Range(0, last_stop))
wenzelm@52901
   174
      }
wenzelm@52901
   175
wenzelm@52901
   176
      private def full_range: Text.Range = full_index._2
wenzelm@52901
   177
wenzelm@52901
   178
      def range(i: Text.Offset = 0): Iterator[(Command, Text.Offset)] =
wenzelm@52901
   179
      {
wenzelm@52901
   180
        if (!commands.isEmpty && full_range.contains(i)) {
wenzelm@52901
   181
          val (cmd0, start0) = full_index._1(i / Commands.block_size)
wenzelm@52901
   182
          Node.Commands.starts(commands.iterator(cmd0), start0) dropWhile {
wenzelm@52901
   183
            case (cmd, start) => start + cmd.length <= i }
wenzelm@52901
   184
        }
wenzelm@52901
   185
        else Iterator.empty
wenzelm@38227
   186
      }
wenzelm@38227
   187
    }
wenzelm@38151
   188
  }
wenzelm@38151
   189
wenzelm@46712
   190
  final class Node private(
wenzelm@48707
   191
    val header: Node.Header = Node.bad_header("Bad theory header"),
wenzelm@52849
   192
    val perspective: Node.Perspective_Command =
wenzelm@52887
   193
      Node.Perspective(false, Command.Perspective.empty, Node.Overlays.empty),
wenzelm@52901
   194
    _commands: Node.Commands = Node.Commands.empty)
wenzelm@38151
   195
  {
wenzelm@46680
   196
    def clear: Node = new Node(header = header)
wenzelm@46680
   197
wenzelm@48707
   198
    def update_header(new_header: Node.Header): Node =
wenzelm@54513
   199
      new Node(new_header, perspective, _commands)
wenzelm@46680
   200
wenzelm@52849
   201
    def update_perspective(new_perspective: Node.Perspective_Command): Node =
wenzelm@54513
   202
      new Node(header, new_perspective, _commands)
wenzelm@46680
   203
wenzelm@52849
   204
    def same_perspective(other_perspective: Node.Perspective_Command): Boolean =
wenzelm@52849
   205
      perspective.required == other_perspective.required &&
wenzelm@52849
   206
      perspective.visible.same(other_perspective.visible) &&
wenzelm@52849
   207
      perspective.overlays == other_perspective.overlays
wenzelm@52808
   208
wenzelm@52901
   209
    def commands: Linear_Set[Command] = _commands.commands
wenzelm@54462
   210
    def thy_load_commands: List[Command] = _commands.thy_load_commands
wenzelm@43697
   211
wenzelm@52901
   212
    def update_commands(new_commands: Linear_Set[Command]): Node =
wenzelm@52918
   213
      if (new_commands eq _commands.commands) this
wenzelm@54513
   214
      else new Node(header, perspective, Node.Commands(new_commands))
wenzelm@38151
   215
wenzelm@38569
   216
    def command_range(i: Text.Offset = 0): Iterator[(Command, Text.Offset)] =
wenzelm@52901
   217
      _commands.range(i)
wenzelm@38151
   218
wenzelm@38569
   219
    def command_range(range: Text.Range): Iterator[(Command, Text.Offset)] =
wenzelm@38569
   220
      command_range(range.start) takeWhile { case (_, start) => start < range.stop }
wenzelm@38151
   221
wenzelm@38879
   222
    def command_start(cmd: Command): Option[Text.Offset] =
wenzelm@52901
   223
      Node.Commands.starts(commands.iterator).find(_._1 == cmd).map(_._2)
wenzelm@38151
   224
  }
wenzelm@38151
   225
wenzelm@38151
   226
wenzelm@46723
   227
  /* development graph */
wenzelm@46723
   228
wenzelm@46723
   229
  object Nodes
wenzelm@46723
   230
  {
wenzelm@46723
   231
    val empty: Nodes = new Nodes(Graph.empty(Node.Name.Ordering))
wenzelm@46723
   232
  }
wenzelm@46723
   233
wenzelm@46723
   234
  final class Nodes private(graph: Graph[Node.Name, Node])
wenzelm@46723
   235
  {
wenzelm@46723
   236
    def get_name(s: String): Option[Node.Name] =
wenzelm@46723
   237
      graph.keys.find(name => name.node == s)
wenzelm@46723
   238
wenzelm@46723
   239
    def apply(name: Node.Name): Node =
wenzelm@46723
   240
      graph.default_node(name, Node.empty).get_node(name)
wenzelm@46723
   241
wenzelm@46723
   242
    def + (entry: (Node.Name, Node)): Nodes =
wenzelm@46723
   243
    {
wenzelm@46723
   244
      val (name, node) = entry
wenzelm@48707
   245
      val imports = node.header.imports
wenzelm@46723
   246
      val graph1 =
wenzelm@46739
   247
        (graph.default_node(name, Node.empty) /: imports)((g, p) => g.default_node(p, Node.empty))
wenzelm@46723
   248
      val graph2 = (graph1 /: graph1.imm_preds(name))((g, dep) => g.del_edge(dep, name))
wenzelm@46739
   249
      val graph3 = (graph2 /: imports)((g, dep) => g.add_edge(dep, name))
wenzelm@46723
   250
      new Nodes(graph3.map_node(name, _ => node))
wenzelm@46723
   251
    }
wenzelm@46723
   252
wenzelm@46723
   253
    def entries: Iterator[(Node.Name, Node)] =
wenzelm@46723
   254
      graph.entries.map({ case (name, (node, _)) => (name, node) })
wenzelm@46723
   255
wenzelm@54528
   256
    def thy_load_commands(file_name: Node.Name): List[Command] =
wenzelm@54528
   257
      (for {
wenzelm@54528
   258
        (_, node) <- entries
wenzelm@54528
   259
        cmd <- node.thy_load_commands.iterator
wenzelm@54528
   260
        Exn.Res((name, _)) <- cmd.blobs.iterator
wenzelm@54528
   261
        if name == file_name
wenzelm@54528
   262
      } yield cmd).toList
wenzelm@54528
   263
wenzelm@46942
   264
    def descendants(names: List[Node.Name]): List[Node.Name] = graph.all_succs(names)
wenzelm@46723
   265
    def topological_order: List[Node.Name] = graph.topological_order
wenzelm@46723
   266
  }
wenzelm@46723
   267
wenzelm@46723
   268
wenzelm@38424
   269
wenzelm@38424
   270
  /** versioning **/
wenzelm@38424
   271
wenzelm@38424
   272
  /* particular document versions */
wenzelm@34485
   273
wenzelm@38417
   274
  object Version
wenzelm@38417
   275
  {
wenzelm@46681
   276
    val init: Version = new Version()
wenzelm@46681
   277
wenzelm@46941
   278
    def make(syntax: Outer_Syntax, nodes: Nodes): Version =
wenzelm@52530
   279
      new Version(Document_ID.make(), syntax, nodes)
wenzelm@38417
   280
  }
wenzelm@38417
   281
wenzelm@46712
   282
  final class Version private(
wenzelm@52530
   283
    val id: Document_ID.Version = Document_ID.none,
wenzelm@46941
   284
    val syntax: Outer_Syntax = Outer_Syntax.empty,
wenzelm@46723
   285
    val nodes: Nodes = Nodes.empty)
wenzelm@46941
   286
  {
wenzelm@52530
   287
    def is_init: Boolean = id == Document_ID.none
wenzelm@46941
   288
  }
immler@34660
   289
wenzelm@34859
   290
wenzelm@38424
   291
  /* changes of plain text, eventually resulting in document edits */
wenzelm@38227
   292
wenzelm@38227
   293
  object Change
wenzelm@38227
   294
  {
wenzelm@46678
   295
    val init: Change = new Change()
wenzelm@46678
   296
wenzelm@46678
   297
    def make(previous: Future[Version], edits: List[Edit_Text], version: Future[Version]): Change =
wenzelm@46678
   298
      new Change(Some(previous), edits, version)
wenzelm@38227
   299
  }
wenzelm@38227
   300
wenzelm@46712
   301
  final class Change private(
wenzelm@46677
   302
    val previous: Option[Future[Version]] = Some(Future.value(Version.init)),
wenzelm@46677
   303
    val edits: List[Edit_Text] = Nil,
wenzelm@46677
   304
    val version: Future[Version] = Future.value(Version.init))
wenzelm@38227
   305
  {
wenzelm@44672
   306
    def is_finished: Boolean =
wenzelm@44672
   307
      (previous match { case None => true case Some(future) => future.is_finished }) &&
wenzelm@44672
   308
      version.is_finished
wenzelm@44672
   309
wenzelm@46678
   310
    def truncate: Change = new Change(None, Nil, version)
wenzelm@38227
   311
  }
wenzelm@38227
   312
wenzelm@38227
   313
wenzelm@38841
   314
  /* history navigation */
wenzelm@38841
   315
wenzelm@38841
   316
  object History
wenzelm@38841
   317
  {
wenzelm@46679
   318
    val init: History = new History()
wenzelm@38841
   319
  }
wenzelm@38841
   320
wenzelm@46712
   321
  final class History private(
wenzelm@46679
   322
    val undo_list: List[Change] = List(Change.init))  // non-empty list
wenzelm@38841
   323
  {
wenzelm@46679
   324
    def tip: Change = undo_list.head
wenzelm@46679
   325
    def + (change: Change): History = new History(change :: undo_list)
wenzelm@38841
   326
wenzelm@46679
   327
    def prune(check: Change => Boolean, retain: Int): Option[(List[Change], History)] =
wenzelm@46679
   328
    {
wenzelm@46679
   329
      val n = undo_list.iterator.zipWithIndex.find(p => check(p._1)).get._2 + 1
wenzelm@46679
   330
      val (retained, dropped) = undo_list.splitAt(n max retain)
wenzelm@46679
   331
wenzelm@46679
   332
      retained.splitAt(retained.length - 1) match {
wenzelm@46679
   333
        case (prefix, List(last)) => Some(dropped, new History(prefix ::: List(last.truncate)))
wenzelm@46679
   334
        case _ => None
wenzelm@46679
   335
      }
wenzelm@46679
   336
    }
wenzelm@38841
   337
  }
wenzelm@38841
   338
wenzelm@38841
   339
wenzelm@38841
   340
wenzelm@38841
   341
  /** global state -- document structure, execution process, editing history **/
wenzelm@38424
   342
wenzelm@52972
   343
  object Snapshot
wenzelm@52972
   344
  {
wenzelm@52972
   345
    val init = State.init.snapshot()
wenzelm@52972
   346
  }
wenzelm@52972
   347
wenzelm@38424
   348
  abstract class Snapshot
wenzelm@38424
   349
  {
wenzelm@44582
   350
    val state: State
wenzelm@38424
   351
    val version: Version
wenzelm@38424
   352
    val is_outdated: Boolean
wenzelm@38427
   353
    def convert(i: Text.Offset): Text.Offset
wenzelm@52889
   354
    def revert(i: Text.Offset): Text.Offset
wenzelm@39177
   355
    def convert(range: Text.Range): Text.Range
wenzelm@39177
   356
    def revert(range: Text.Range): Text.Range
wenzelm@52972
   357
wenzelm@52972
   358
    val node_name: Node.Name
wenzelm@52972
   359
    val node: Node
wenzelm@51494
   360
    def eq_content(other: Snapshot): Boolean
wenzelm@52508
   361
    def cumulate_markup[A](
wenzelm@52508
   362
      range: Text.Range,
wenzelm@52508
   363
      info: A,
wenzelm@52508
   364
      elements: Option[Set[String]],
wenzelm@52900
   365
      result: Command.State => (A, Text.Markup) => Option[A]): List[Text.Info[A]]
wenzelm@52508
   366
    def select_markup[A](
wenzelm@52508
   367
      range: Text.Range,
wenzelm@52508
   368
      elements: Option[Set[String]],
wenzelm@52900
   369
      result: Command.State => Text.Markup => Option[A]): List[Text.Info[A]]
wenzelm@38424
   370
  }
wenzelm@38424
   371
wenzelm@52563
   372
  type Assign_Update =
wenzelm@52563
   373
    List[(Document_ID.Command, List[Document_ID.Exec])]  // update of exec state assignment
wenzelm@44476
   374
wenzelm@38370
   375
  object State
wenzelm@38370
   376
  {
wenzelm@38373
   377
    class Fail(state: State) extends Exception
wenzelm@38373
   378
wenzelm@44479
   379
    object Assignment
wenzelm@44479
   380
    {
wenzelm@46683
   381
      val init: Assignment = new Assignment()
wenzelm@44479
   382
    }
wenzelm@38370
   383
wenzelm@46712
   384
    final class Assignment private(
wenzelm@52530
   385
      val command_execs: Map[Document_ID.Command, List[Document_ID.Exec]] = Map.empty,
wenzelm@46677
   386
      val is_finished: Boolean = false)
wenzelm@38370
   387
    {
wenzelm@44477
   388
      def check_finished: Assignment = { require(is_finished); this }
wenzelm@47388
   389
      def unfinished: Assignment = new Assignment(command_execs, false)
wenzelm@44479
   390
wenzelm@52563
   391
      def assign(update: Assign_Update): Assignment =
wenzelm@38370
   392
      {
wenzelm@38976
   393
        require(!is_finished)
wenzelm@44479
   394
        val command_execs1 =
wenzelm@52563
   395
          (command_execs /: update) {
wenzelm@52563
   396
            case (res, (command_id, exec_ids)) =>
wenzelm@52563
   397
              if (exec_ids.isEmpty) res - command_id
wenzelm@52563
   398
              else res + (command_id -> exec_ids)
wenzelm@44479
   399
          }
wenzelm@47388
   400
        new Assignment(command_execs1, true)
wenzelm@38150
   401
      }
wenzelm@38370
   402
    }
wenzelm@46682
   403
wenzelm@46682
   404
    val init: State =
wenzelm@52563
   405
      State().define_version(Version.init, Assignment.init).assign(Version.init.id, Nil)._2
wenzelm@38370
   406
  }
wenzelm@38370
   407
wenzelm@46712
   408
  final case class State private(
wenzelm@52530
   409
    val versions: Map[Document_ID.Version, Version] = Map.empty,
wenzelm@54519
   410
    val blobs: Set[SHA1.Digest] = Set.empty,   // inlined files
wenzelm@52530
   411
    val commands: Map[Document_ID.Command, Command.State] = Map.empty,  // static markup from define_command
wenzelm@52530
   412
    val execs: Map[Document_ID.Exec, Command.State] = Map.empty,  // dynamic markup from execution
wenzelm@52530
   413
    val assignments: Map[Document_ID.Version, State.Assignment] = Map.empty,
wenzelm@38841
   414
    val history: History = History.init)
wenzelm@38370
   415
  {
wenzelm@38373
   416
    private def fail[A]: A = throw new State.Fail(this)
wenzelm@38370
   417
wenzelm@44479
   418
    def define_version(version: Version, assignment: State.Assignment): State =
wenzelm@38370
   419
    {
wenzelm@38417
   420
      val id = version.id
wenzelm@38417
   421
      copy(versions = versions + (id -> version),
wenzelm@44479
   422
        assignments = assignments + (id -> assignment.unfinished))
wenzelm@38370
   423
    }
wenzelm@38370
   424
wenzelm@54519
   425
    def define_blob(digest: SHA1.Digest): State = copy(blobs = blobs + digest)
wenzelm@54519
   426
    def defined_blob(digest: SHA1.Digest): Boolean = blobs.contains(digest)
wenzelm@54519
   427
wenzelm@38373
   428
    def define_command(command: Command): State =
wenzelm@38373
   429
    {
wenzelm@38373
   430
      val id = command.id
wenzelm@49414
   431
      copy(commands = commands + (id -> command.init_state))
wenzelm@38373
   432
    }
wenzelm@38373
   433
wenzelm@52530
   434
    def defined_command(id: Document_ID.Command): Boolean = commands.isDefinedAt(id)
wenzelm@44582
   435
wenzelm@52531
   436
    def find_command(version: Version, id: Document_ID.Generic): Option[(Node, Command)] =
wenzelm@44582
   437
      commands.get(id) orElse execs.get(id) match {
wenzelm@44582
   438
        case None => None
wenzelm@44582
   439
        case Some(st) =>
wenzelm@44582
   440
          val command = st.command
wenzelm@46681
   441
          val node = version.nodes(command.node_name)
wenzelm@54328
   442
          if (node.commands.contains(command)) Some((node, command)) else None
wenzelm@44582
   443
      }
wenzelm@38373
   444
wenzelm@52530
   445
    def the_version(id: Document_ID.Version): Version = versions.getOrElse(id, fail)
wenzelm@52564
   446
    def the_static_state(id: Document_ID.Command): Command.State = commands.getOrElse(id, fail)
wenzelm@52564
   447
    def the_dynamic_state(id: Document_ID.Exec): Command.State = execs.getOrElse(id, fail)
wenzelm@52563
   448
    def the_assignment(version: Version): State.Assignment = assignments.getOrElse(version.id, fail)
wenzelm@38370
   449
wenzelm@52531
   450
    def accumulate(id: Document_ID.Generic, message: XML.Elem): (Command.State, State) =
wenzelm@38370
   451
      execs.get(id) match {
wenzelm@44446
   452
        case Some(st) =>
wenzelm@49527
   453
          val new_st = st + (id, message)
wenzelm@44446
   454
          (new_st, copy(execs = execs + (id -> new_st)))
wenzelm@38370
   455
        case None =>
wenzelm@38370
   456
          commands.get(id) match {
wenzelm@38370
   457
            case Some(st) =>
wenzelm@49527
   458
              val new_st = st + (id, message)
wenzelm@38370
   459
              (new_st, copy(commands = commands + (id -> new_st)))
wenzelm@38370
   460
            case None => fail
wenzelm@38370
   461
          }
wenzelm@38370
   462
      }
wenzelm@38370
   463
wenzelm@52563
   464
    def assign(id: Document_ID.Version, update: Assign_Update): (List[Command], State) =
wenzelm@38370
   465
    {
wenzelm@38417
   466
      val version = the_version(id)
wenzelm@38370
   467
wenzelm@52566
   468
      def upd(exec_id: Document_ID.Exec, st: Command.State)
wenzelm@52566
   469
          : Option[(Document_ID.Exec, Command.State)] =
wenzelm@52566
   470
        if (execs.isDefinedAt(exec_id)) None else Some(exec_id -> st)
wenzelm@52566
   471
wenzelm@44543
   472
      val (changed_commands, new_execs) =
wenzelm@52563
   473
        ((Nil: List[Command], execs) /: update) {
wenzelm@52566
   474
          case ((commands1, execs1), (command_id, exec)) =>
wenzelm@52566
   475
            val st = the_static_state(command_id)
wenzelm@52566
   476
            val command = st.command
wenzelm@52527
   477
            val commands2 = command :: commands1
wenzelm@44543
   478
            val execs2 =
wenzelm@44543
   479
              exec match {
wenzelm@52527
   480
                case Nil => execs1
wenzelm@52527
   481
                case eval_id :: print_ids =>
wenzelm@52566
   482
                  execs1 ++ upd(eval_id, st) ++
wenzelm@52566
   483
                    (for (id <- print_ids; up <- upd(id, command.empty_state)) yield up)
wenzelm@44543
   484
              }
wenzelm@44543
   485
            (commands2, execs2)
wenzelm@38370
   486
        }
wenzelm@52563
   487
      val new_assignment = the_assignment(version).assign(update)
wenzelm@43722
   488
      val new_state = copy(assignments = assignments + (id -> new_assignment), execs = new_execs)
wenzelm@44476
   489
wenzelm@44543
   490
      (changed_commands, new_state)
wenzelm@38370
   491
    }
wenzelm@38370
   492
wenzelm@38417
   493
    def is_assigned(version: Version): Boolean =
wenzelm@43722
   494
      assignments.get(version.id) match {
wenzelm@38370
   495
        case Some(assgn) => assgn.is_finished
wenzelm@38370
   496
        case None => false
wenzelm@38370
   497
      }
wenzelm@38370
   498
wenzelm@44436
   499
    def is_stable(change: Change): Boolean =
wenzelm@44436
   500
      change.is_finished && is_assigned(change.version.get_finished)
wenzelm@44436
   501
wenzelm@46944
   502
    def recent_finished: Change = history.undo_list.find(_.is_finished) getOrElse fail
wenzelm@44672
   503
    def recent_stable: Change = history.undo_list.find(is_stable) getOrElse fail
wenzelm@44436
   504
    def tip_stable: Boolean = is_stable(history.tip)
wenzelm@44475
   505
    def tip_version: Version = history.tip.version.get_finished
wenzelm@44436
   506
wenzelm@44446
   507
    def continue_history(
wenzelm@44446
   508
        previous: Future[Version],
wenzelm@40479
   509
        edits: List[Edit_Text],
wenzelm@43722
   510
        version: Future[Version]): (Change, State) =
wenzelm@38841
   511
    {
wenzelm@46678
   512
      val change = Change.make(previous, edits, version)
wenzelm@38841
   513
      (change, copy(history = history + change))
wenzelm@38841
   514
    }
wenzelm@38841
   515
wenzelm@44672
   516
    def prune_history(retain: Int = 0): (List[Version], State) =
wenzelm@44672
   517
    {
wenzelm@46679
   518
      history.prune(is_stable, retain) match {
wenzelm@46679
   519
        case Some((dropped, history1)) =>
wenzelm@44672
   520
          val dropped_versions = dropped.map(change => change.version.get_finished)
wenzelm@46679
   521
          val state1 = copy(history = history1)
wenzelm@44672
   522
          (dropped_versions, state1)
wenzelm@46679
   523
        case None => fail
wenzelm@44672
   524
      }
wenzelm@44672
   525
    }
wenzelm@44672
   526
wenzelm@52530
   527
    def removed_versions(removed: List[Document_ID.Version]): State =
wenzelm@44676
   528
    {
wenzelm@44676
   529
      val versions1 = versions -- removed
wenzelm@44676
   530
      val assignments1 = assignments -- removed
wenzelm@54519
   531
      var blobs1 = Set.empty[SHA1.Digest]
wenzelm@52530
   532
      var commands1 = Map.empty[Document_ID.Command, Command.State]
wenzelm@52530
   533
      var execs1 = Map.empty[Document_ID.Exec, Command.State]
wenzelm@44676
   534
      for {
wenzelm@44676
   535
        (version_id, version) <- versions1.iterator
wenzelm@46997
   536
        command_execs = assignments1(version_id).command_execs
wenzelm@46723
   537
        (_, node) <- version.nodes.entries
wenzelm@44676
   538
        command <- node.commands.iterator
wenzelm@44676
   539
      } {
wenzelm@54519
   540
        for (digest <- command.blobs_digests; if !blobs1.contains(digest))
wenzelm@54519
   541
          blobs1 += digest
wenzelm@54519
   542
wenzelm@52568
   543
        if (!commands1.isDefinedAt(command.id))
wenzelm@52568
   544
          commands.get(command.id).foreach(st => commands1 += (command.id -> st))
wenzelm@54519
   545
wenzelm@52568
   546
        for (exec_id <- command_execs.getOrElse(command.id, Nil)) {
wenzelm@52527
   547
          if (!execs1.isDefinedAt(exec_id))
wenzelm@52527
   548
            execs.get(exec_id).foreach(st => execs1 += (exec_id -> st))
wenzelm@44676
   549
        }
wenzelm@44676
   550
      }
wenzelm@54519
   551
      copy(versions = versions1, blobs = blobs1, commands = commands1, execs = execs1,
wenzelm@54519
   552
        assignments = assignments1)
wenzelm@44676
   553
    }
wenzelm@44676
   554
wenzelm@44613
   555
    def command_state(version: Version, command: Command): Command.State =
wenzelm@44613
   556
    {
wenzelm@44613
   557
      require(is_assigned(version))
wenzelm@44613
   558
      try {
wenzelm@52527
   559
        the_assignment(version).check_finished.command_execs.getOrElse(command.id, Nil)
wenzelm@52564
   560
          .map(the_dynamic_state(_)) match {
wenzelm@52527
   561
            case eval_state :: print_states => (eval_state /: print_states)(_ ++ _)
wenzelm@52527
   562
            case Nil => fail
wenzelm@52527
   563
          }
wenzelm@44613
   564
      }
wenzelm@47395
   565
      catch {
wenzelm@47395
   566
        case _: State.Fail =>
wenzelm@52564
   567
          try { the_static_state(command.id) }
wenzelm@49414
   568
          catch { case _: State.Fail => command.init_state }
wenzelm@47395
   569
      }
wenzelm@44613
   570
    }
wenzelm@44613
   571
wenzelm@49645
   572
    def markup_to_XML(version: Version, node: Node, filter: XML.Elem => Boolean): XML.Body =
wenzelm@49645
   573
      node.commands.toList.map(cmd => command_state(version, cmd).markup_to_XML(filter)).flatten
wenzelm@38841
   574
wenzelm@38841
   575
    // persistent user-view
wenzelm@49346
   576
    def snapshot(name: Node.Name = Node.Name.empty, pending_edits: List[Text.Edit] = Nil)
wenzelm@49346
   577
      : Snapshot =
wenzelm@38370
   578
    {
wenzelm@44672
   579
      val stable = recent_stable
wenzelm@44436
   580
      val latest = history.tip
wenzelm@38841
   581
wenzelm@44156
   582
      // FIXME proper treatment of removed nodes
wenzelm@38841
   583
      val edits =
wenzelm@38841
   584
        (pending_edits /: history.undo_list.takeWhile(_ != stable))((edits, change) =>
wenzelm@44156
   585
            (for ((a, Node.Edits(es)) <- change.edits if a == name) yield es).flatten ::: edits)
wenzelm@38841
   586
      lazy val reverse_edits = edits.reverse
wenzelm@38841
   587
wenzelm@38841
   588
      new Snapshot
wenzelm@38841
   589
      {
wenzelm@52972
   590
        /* global information */
wenzelm@52972
   591
wenzelm@44582
   592
        val state = State.this
wenzelm@39698
   593
        val version = stable.version.get_finished
wenzelm@38841
   594
        val is_outdated = !(pending_edits.isEmpty && latest == stable)
wenzelm@38841
   595
wenzelm@38841
   596
        def convert(offset: Text.Offset) = (offset /: edits)((i, edit) => edit.convert(i))
wenzelm@38841
   597
        def revert(offset: Text.Offset) = (offset /: reverse_edits)((i, edit) => edit.revert(i))
wenzelm@43425
   598
        def convert(range: Text.Range) = (range /: edits)((r, edit) => edit.convert(r))
wenzelm@43425
   599
        def revert(range: Text.Range) = (range /: reverse_edits)((r, edit) => edit.revert(r))
wenzelm@39177
   600
wenzelm@52972
   601
wenzelm@52972
   602
        /* local node content */
wenzelm@52972
   603
wenzelm@52972
   604
        val node_name = name
wenzelm@52972
   605
        val node = version.nodes(name)
wenzelm@52972
   606
wenzelm@51494
   607
        def eq_content(other: Snapshot): Boolean =
wenzelm@49346
   608
          !is_outdated && !other.is_outdated &&
wenzelm@49346
   609
            node.commands.size == other.node.commands.size &&
wenzelm@49346
   610
            ((node.commands.iterator zip other.node.commands.iterator) forall {
wenzelm@49346
   611
              case (cmd1, cmd2) =>
wenzelm@51494
   612
                state.command_state(version, cmd1) eq_content
wenzelm@51494
   613
                  other.state.command_state(other.version, cmd2)
wenzelm@49346
   614
            })
wenzelm@49346
   615
wenzelm@46178
   616
        def cumulate_markup[A](range: Text.Range, info: A, elements: Option[Set[String]],
wenzelm@52900
   617
          result: Command.State => (A, Text.Markup) => Option[A]): List[Text.Info[A]] =
wenzelm@45459
   618
        {
wenzelm@45467
   619
          val former_range = revert(range)
wenzelm@52900
   620
          (for {
wenzelm@52900
   621
            (command, command_start) <- node.command_range(former_range)
wenzelm@50500
   622
            st = state.command_state(version, command)
wenzelm@50500
   623
            res = result(st)
wenzelm@52889
   624
            Text.Info(r0, a) <- st.markup.cumulate[A](
wenzelm@52889
   625
              (former_range - command_start).restrict(command.range), info, elements,
wenzelm@52900
   626
              { case (a, Text.Info(r0, b)) => res(a, Text.Info(convert(r0 + command_start), b)) }
wenzelm@52900
   627
            ).iterator
wenzelm@52900
   628
          } yield Text.Info(convert(r0 + command_start), a)).toList
wenzelm@45459
   629
        }
wenzelm@45459
   630
wenzelm@46178
   631
        def select_markup[A](range: Text.Range, elements: Option[Set[String]],
wenzelm@52900
   632
          result: Command.State => Text.Markup => Option[A]): List[Text.Info[A]] =
wenzelm@38845
   633
        {
wenzelm@52889
   634
          def result1(st: Command.State): (Option[A], Text.Markup) => Option[Option[A]] =
wenzelm@50500
   635
          {
wenzelm@50500
   636
            val res = result(st)
wenzelm@52889
   637
            (_: Option[A], x: Text.Markup) =>
wenzelm@52889
   638
              res(x) match {
wenzelm@52889
   639
                case None => None
wenzelm@52889
   640
                case some => Some(some)
wenzelm@52889
   641
              }
wenzelm@50500
   642
          }
wenzelm@46198
   643
          for (Text.Info(r, Some(x)) <- cumulate_markup(range, None, elements, result1))
wenzelm@46198
   644
            yield Text.Info(r, x)
wenzelm@38845
   645
        }
wenzelm@38841
   646
      }
wenzelm@38150
   647
    }
wenzelm@34485
   648
  }
wenzelm@34840
   649
}
wenzelm@34840
   650