src/Pure/PIDE/document.scala
author wenzelm
Tue Sep 18 13:18:45 2012 +0200 (2012-09-18 ago)
changeset 49414 d7b5fb2e9ca2
parent 49346 977cf0788b30
child 49527 b96e4a39cc3e
permissions -rw-r--r--
some support for inital command markup;
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@38227
    16
  /* formal identifiers */
wenzelm@38150
    17
wenzelm@38363
    18
  type ID = Long
wenzelm@43780
    19
  val ID = Properties.Value.Long
wenzelm@38414
    20
wenzelm@38373
    21
  type Version_ID = ID
wenzelm@38363
    22
  type Command_ID = ID
wenzelm@38373
    23
  type Exec_ID = ID
wenzelm@38150
    24
wenzelm@43662
    25
  val no_id: ID = 0
wenzelm@45243
    26
  val new_id = Counter()
wenzelm@38355
    27
wenzelm@38150
    28
wenzelm@34818
    29
wenzelm@38424
    30
  /** document structure **/
wenzelm@38424
    31
wenzelm@46723
    32
  /* individual nodes */
wenzelm@38424
    33
wenzelm@44615
    34
  type Edit[A, B] = (Node.Name, Node.Edit[A, B])
wenzelm@44384
    35
  type Edit_Text = Edit[Text.Edit, Text.Perspective]
wenzelm@44384
    36
  type Edit_Command = Edit[(Option[Command], Option[Command]), Command.Perspective]
wenzelm@38151
    37
wenzelm@38151
    38
  object Node
wenzelm@38151
    39
  {
wenzelm@48707
    40
    sealed case class Header(
wenzelm@46938
    41
      imports: List[Name],
wenzelm@48706
    42
      keywords: Thy_Header.Keywords,
wenzelm@48707
    43
      uses: List[(String, Boolean)],
wenzelm@48707
    44
      errors: List[String] = Nil)
wenzelm@48707
    45
    {
wenzelm@48707
    46
      def error(msg: String): Header = copy(errors = errors ::: List(msg))
wenzelm@48707
    47
    }
wenzelm@48707
    48
wenzelm@48707
    49
    def bad_header(msg: String): Header = Header(Nil, Nil, Nil, List(msg))
wenzelm@46737
    50
wenzelm@44957
    51
    object Name
wenzelm@44957
    52
    {
wenzelm@44957
    53
      val empty = Name("", "", "")
wenzelm@48793
    54
      def apply(raw_path: Path): Name =
wenzelm@44959
    55
      {
wenzelm@48793
    56
        val path = raw_path.expand
wenzelm@44959
    57
        val node = path.implode
wenzelm@44959
    58
        val dir = path.dir.implode
wenzelm@44959
    59
        val theory = Thy_Header.thy_name(node) getOrElse error("Bad theory file name: " + path)
wenzelm@44959
    60
        Name(node, dir, theory)
wenzelm@44959
    61
      }
wenzelm@46723
    62
wenzelm@46723
    63
      object Ordering extends scala.math.Ordering[Name]
wenzelm@46723
    64
      {
wenzelm@46723
    65
        def compare(name1: Name, name2: Name): Int = name1.node compare name2.node
wenzelm@46723
    66
      }
wenzelm@44957
    67
    }
wenzelm@44616
    68
    sealed case class Name(node: String, dir: String, theory: String)
wenzelm@44615
    69
    {
wenzelm@44615
    70
      override def hashCode: Int = node.hashCode
wenzelm@44615
    71
      override def equals(that: Any): Boolean =
wenzelm@44615
    72
        that match {
wenzelm@44615
    73
          case other: Name => node == other.node
wenzelm@44615
    74
          case _ => false
wenzelm@44615
    75
        }
wenzelm@44642
    76
      override def toString: String = theory
wenzelm@44615
    77
    }
wenzelm@44615
    78
wenzelm@44384
    79
    sealed abstract class Edit[A, B]
wenzelm@44156
    80
    {
wenzelm@44383
    81
      def foreach(f: A => Unit)
wenzelm@44383
    82
      {
wenzelm@44156
    83
        this match {
wenzelm@44383
    84
          case Edits(es) => es.foreach(f)
wenzelm@44383
    85
          case _ =>
wenzelm@44156
    86
        }
wenzelm@44383
    87
      }
wenzelm@44156
    88
    }
wenzelm@44384
    89
    case class Clear[A, B]() extends Edit[A, B]
wenzelm@44384
    90
    case class Edits[A, B](edits: List[A]) extends Edit[A, B]
wenzelm@48707
    91
    case class Deps[A, B](header: Header) extends Edit[A, B]
wenzelm@44384
    92
    case class Perspective[A, B](perspective: B) extends Edit[A, B]
wenzelm@44156
    93
wenzelm@38426
    94
    def command_starts(commands: Iterator[Command], offset: Text.Offset = 0)
wenzelm@38426
    95
      : Iterator[(Command, Text.Offset)] =
wenzelm@38227
    96
    {
wenzelm@38227
    97
      var i = offset
wenzelm@38227
    98
      for (command <- commands) yield {
wenzelm@38227
    99
        val start = i
wenzelm@38227
   100
        i += command.length
wenzelm@38227
   101
        (command, start)
wenzelm@38227
   102
      }
wenzelm@38227
   103
    }
wenzelm@46680
   104
wenzelm@46680
   105
    private val block_size = 1024
wenzelm@46680
   106
wenzelm@46680
   107
    val empty: Node = new Node()
wenzelm@38151
   108
  }
wenzelm@38151
   109
wenzelm@46712
   110
  final class Node private(
wenzelm@48707
   111
    val header: Node.Header = Node.bad_header("Bad theory header"),
wenzelm@46677
   112
    val perspective: Command.Perspective = Command.Perspective.empty,
wenzelm@46677
   113
    val blobs: Map[String, Blob] = Map.empty,
wenzelm@46677
   114
    val commands: Linear_Set[Command] = Linear_Set.empty)
wenzelm@38151
   115
  {
wenzelm@46680
   116
    def clear: Node = new Node(header = header)
wenzelm@46680
   117
wenzelm@48707
   118
    def update_header(new_header: Node.Header): Node =
wenzelm@46680
   119
      new Node(new_header, perspective, blobs, commands)
wenzelm@46680
   120
wenzelm@46680
   121
    def update_perspective(new_perspective: Command.Perspective): Node =
wenzelm@46680
   122
      new Node(header, new_perspective, blobs, commands)
wenzelm@46680
   123
wenzelm@46680
   124
    def update_blobs(new_blobs: Map[String, Blob]): Node =
wenzelm@46680
   125
      new Node(header, perspective, new_blobs, commands)
wenzelm@46680
   126
wenzelm@46680
   127
    def update_commands(new_commands: Linear_Set[Command]): Node =
wenzelm@46680
   128
      new Node(header, perspective, blobs, new_commands)
wenzelm@44443
   129
wenzelm@44443
   130
wenzelm@43697
   131
    /* commands */
wenzelm@43697
   132
wenzelm@38879
   133
    private lazy val full_index: (Array[(Command, Text.Offset)], Text.Range) =
wenzelm@38879
   134
    {
wenzelm@38879
   135
      val blocks = new mutable.ListBuffer[(Command, Text.Offset)]
wenzelm@38879
   136
      var next_block = 0
wenzelm@38879
   137
      var last_stop = 0
wenzelm@38879
   138
      for ((command, start) <- Node.command_starts(commands.iterator)) {
wenzelm@38879
   139
        last_stop = start + command.length
wenzelm@38885
   140
        while (last_stop + 1 > next_block) {
wenzelm@38879
   141
          blocks += (command -> start)
wenzelm@46680
   142
          next_block += Node.block_size
wenzelm@38879
   143
        }
wenzelm@38879
   144
      }
wenzelm@38879
   145
      (blocks.toArray, Text.Range(0, last_stop))
wenzelm@38879
   146
    }
wenzelm@38151
   147
wenzelm@38879
   148
    def full_range: Text.Range = full_index._2
wenzelm@38151
   149
wenzelm@38569
   150
    def command_range(i: Text.Offset = 0): Iterator[(Command, Text.Offset)] =
wenzelm@38879
   151
    {
wenzelm@38879
   152
      if (!commands.isEmpty && full_range.contains(i)) {
wenzelm@46680
   153
        val (cmd0, start0) = full_index._1(i / Node.block_size)
wenzelm@38879
   154
        Node.command_starts(commands.iterator(cmd0), start0) dropWhile {
wenzelm@38879
   155
          case (cmd, start) => start + cmd.length <= i }
wenzelm@38879
   156
      }
wenzelm@38879
   157
      else Iterator.empty
wenzelm@38879
   158
    }
wenzelm@38151
   159
wenzelm@38569
   160
    def command_range(range: Text.Range): Iterator[(Command, Text.Offset)] =
wenzelm@38569
   161
      command_range(range.start) takeWhile { case (_, start) => start < range.stop }
wenzelm@38151
   162
wenzelm@38426
   163
    def command_at(i: Text.Offset): Option[(Command, Text.Offset)] =
wenzelm@38151
   164
    {
wenzelm@38151
   165
      val range = command_range(i)
wenzelm@38151
   166
      if (range.hasNext) Some(range.next) else None
wenzelm@38151
   167
    }
wenzelm@38151
   168
wenzelm@38879
   169
    def command_start(cmd: Command): Option[Text.Offset] =
wenzelm@46677
   170
      Node.command_starts(commands.iterator).find(_._1 == cmd).map(_._2)
wenzelm@38151
   171
  }
wenzelm@38151
   172
wenzelm@38151
   173
wenzelm@46723
   174
  /* development graph */
wenzelm@46723
   175
wenzelm@46723
   176
  object Nodes
wenzelm@46723
   177
  {
wenzelm@46723
   178
    val empty: Nodes = new Nodes(Graph.empty(Node.Name.Ordering))
wenzelm@46723
   179
  }
wenzelm@46723
   180
wenzelm@46723
   181
  final class Nodes private(graph: Graph[Node.Name, Node])
wenzelm@46723
   182
  {
wenzelm@46723
   183
    def get_name(s: String): Option[Node.Name] =
wenzelm@46723
   184
      graph.keys.find(name => name.node == s)
wenzelm@46723
   185
wenzelm@46723
   186
    def apply(name: Node.Name): Node =
wenzelm@46723
   187
      graph.default_node(name, Node.empty).get_node(name)
wenzelm@46723
   188
wenzelm@46723
   189
    def + (entry: (Node.Name, Node)): Nodes =
wenzelm@46723
   190
    {
wenzelm@46723
   191
      val (name, node) = entry
wenzelm@48707
   192
      val imports = node.header.imports
wenzelm@46723
   193
      val graph1 =
wenzelm@46739
   194
        (graph.default_node(name, Node.empty) /: imports)((g, p) => g.default_node(p, Node.empty))
wenzelm@46723
   195
      val graph2 = (graph1 /: graph1.imm_preds(name))((g, dep) => g.del_edge(dep, name))
wenzelm@46739
   196
      val graph3 = (graph2 /: imports)((g, dep) => g.add_edge(dep, name))
wenzelm@46723
   197
      new Nodes(graph3.map_node(name, _ => node))
wenzelm@46723
   198
    }
wenzelm@46723
   199
wenzelm@46723
   200
    def entries: Iterator[(Node.Name, Node)] =
wenzelm@46723
   201
      graph.entries.map({ case (name, (node, _)) => (name, node) })
wenzelm@46723
   202
wenzelm@46942
   203
    def descendants(names: List[Node.Name]): List[Node.Name] = graph.all_succs(names)
wenzelm@46723
   204
    def topological_order: List[Node.Name] = graph.topological_order
wenzelm@46723
   205
  }
wenzelm@46723
   206
wenzelm@46723
   207
wenzelm@38424
   208
wenzelm@38424
   209
  /** versioning **/
wenzelm@38424
   210
wenzelm@38424
   211
  /* particular document versions */
wenzelm@34485
   212
wenzelm@38417
   213
  object Version
wenzelm@38417
   214
  {
wenzelm@46681
   215
    val init: Version = new Version()
wenzelm@46681
   216
wenzelm@46941
   217
    def make(syntax: Outer_Syntax, nodes: Nodes): Version =
wenzelm@46941
   218
      new Version(new_id(), syntax, nodes)
wenzelm@38417
   219
  }
wenzelm@38417
   220
wenzelm@46712
   221
  final class Version private(
wenzelm@46677
   222
    val id: Version_ID = no_id,
wenzelm@46941
   223
    val syntax: Outer_Syntax = Outer_Syntax.empty,
wenzelm@46723
   224
    val nodes: Nodes = Nodes.empty)
wenzelm@46941
   225
  {
wenzelm@46941
   226
    def is_init: Boolean = id == no_id
wenzelm@46941
   227
  }
immler@34660
   228
wenzelm@34859
   229
wenzelm@38424
   230
  /* changes of plain text, eventually resulting in document edits */
wenzelm@38227
   231
wenzelm@38227
   232
  object Change
wenzelm@38227
   233
  {
wenzelm@46678
   234
    val init: Change = new Change()
wenzelm@46678
   235
wenzelm@46678
   236
    def make(previous: Future[Version], edits: List[Edit_Text], version: Future[Version]): Change =
wenzelm@46678
   237
      new Change(Some(previous), edits, version)
wenzelm@38227
   238
  }
wenzelm@38227
   239
wenzelm@46712
   240
  final class Change private(
wenzelm@46677
   241
    val previous: Option[Future[Version]] = Some(Future.value(Version.init)),
wenzelm@46677
   242
    val edits: List[Edit_Text] = Nil,
wenzelm@46677
   243
    val version: Future[Version] = Future.value(Version.init))
wenzelm@38227
   244
  {
wenzelm@44672
   245
    def is_finished: Boolean =
wenzelm@44672
   246
      (previous match { case None => true case Some(future) => future.is_finished }) &&
wenzelm@44672
   247
      version.is_finished
wenzelm@44672
   248
wenzelm@46678
   249
    def truncate: Change = new Change(None, Nil, version)
wenzelm@38227
   250
  }
wenzelm@38227
   251
wenzelm@38227
   252
wenzelm@38841
   253
  /* history navigation */
wenzelm@38841
   254
wenzelm@38841
   255
  object History
wenzelm@38841
   256
  {
wenzelm@46679
   257
    val init: History = new History()
wenzelm@38841
   258
  }
wenzelm@38841
   259
wenzelm@46712
   260
  final class History private(
wenzelm@46679
   261
    val undo_list: List[Change] = List(Change.init))  // non-empty list
wenzelm@38841
   262
  {
wenzelm@46679
   263
    def tip: Change = undo_list.head
wenzelm@46679
   264
    def + (change: Change): History = new History(change :: undo_list)
wenzelm@38841
   265
wenzelm@46679
   266
    def prune(check: Change => Boolean, retain: Int): Option[(List[Change], History)] =
wenzelm@46679
   267
    {
wenzelm@46679
   268
      val n = undo_list.iterator.zipWithIndex.find(p => check(p._1)).get._2 + 1
wenzelm@46679
   269
      val (retained, dropped) = undo_list.splitAt(n max retain)
wenzelm@46679
   270
wenzelm@46679
   271
      retained.splitAt(retained.length - 1) match {
wenzelm@46679
   272
        case (prefix, List(last)) => Some(dropped, new History(prefix ::: List(last.truncate)))
wenzelm@46679
   273
        case _ => None
wenzelm@46679
   274
      }
wenzelm@46679
   275
    }
wenzelm@38841
   276
  }
wenzelm@38841
   277
wenzelm@38841
   278
wenzelm@38841
   279
wenzelm@38841
   280
  /** global state -- document structure, execution process, editing history **/
wenzelm@38424
   281
wenzelm@38424
   282
  abstract class Snapshot
wenzelm@38424
   283
  {
wenzelm@44582
   284
    val state: State
wenzelm@38424
   285
    val version: Version
wenzelm@48923
   286
    val node_name: Node.Name
wenzelm@38424
   287
    val node: Node
wenzelm@38424
   288
    val is_outdated: Boolean
wenzelm@38427
   289
    def convert(i: Text.Offset): Text.Offset
wenzelm@39177
   290
    def convert(range: Text.Range): Text.Range
wenzelm@38427
   291
    def revert(i: Text.Offset): Text.Offset
wenzelm@39177
   292
    def revert(range: Text.Range): Text.Range
wenzelm@49346
   293
    def eq_markup(other: Snapshot): Boolean
wenzelm@46178
   294
    def cumulate_markup[A](range: Text.Range, info: A, elements: Option[Set[String]],
wenzelm@46178
   295
      result: PartialFunction[(A, Text.Markup), A]): Stream[Text.Info[A]]
wenzelm@46178
   296
    def select_markup[A](range: Text.Range, elements: Option[Set[String]],
wenzelm@46198
   297
      result: PartialFunction[Text.Markup, A]): Stream[Text.Info[A]]
wenzelm@38424
   298
  }
wenzelm@38424
   299
wenzelm@47388
   300
  type Assign = List[(Document.Command_ID, Option[Document.Exec_ID])]  // exec state assignment
wenzelm@44476
   301
wenzelm@38370
   302
  object State
wenzelm@38370
   303
  {
wenzelm@38373
   304
    class Fail(state: State) extends Exception
wenzelm@38373
   305
wenzelm@44479
   306
    object Assignment
wenzelm@44479
   307
    {
wenzelm@46683
   308
      val init: Assignment = new Assignment()
wenzelm@44479
   309
    }
wenzelm@38370
   310
wenzelm@46712
   311
    final class Assignment private(
wenzelm@46677
   312
      val command_execs: Map[Command_ID, Exec_ID] = Map.empty,
wenzelm@46677
   313
      val is_finished: Boolean = false)
wenzelm@38370
   314
    {
wenzelm@44477
   315
      def check_finished: Assignment = { require(is_finished); this }
wenzelm@47388
   316
      def unfinished: Assignment = new Assignment(command_execs, false)
wenzelm@44479
   317
wenzelm@47388
   318
      def assign(add_command_execs: List[(Command_ID, Option[Exec_ID])]): Assignment =
wenzelm@38370
   319
      {
wenzelm@38976
   320
        require(!is_finished)
wenzelm@44479
   321
        val command_execs1 =
wenzelm@44479
   322
          (command_execs /: add_command_execs) {
wenzelm@44479
   323
            case (res, (command_id, None)) => res - command_id
wenzelm@44479
   324
            case (res, (command_id, Some(exec_id))) => res + (command_id -> exec_id)
wenzelm@44479
   325
          }
wenzelm@47388
   326
        new Assignment(command_execs1, true)
wenzelm@38150
   327
      }
wenzelm@38370
   328
    }
wenzelm@46682
   329
wenzelm@46682
   330
    val init: State =
wenzelm@46682
   331
      State().define_version(Version.init, Assignment.init).assign(Version.init.id)._2
wenzelm@38370
   332
  }
wenzelm@38370
   333
wenzelm@46712
   334
  final case class State private(
wenzelm@46677
   335
    val versions: Map[Version_ID, Version] = Map.empty,
wenzelm@46677
   336
    val commands: Map[Command_ID, Command.State] = Map.empty,  // static markup from define_command
wenzelm@46677
   337
    val execs: Map[Exec_ID, Command.State] = Map.empty,  // dynamic markup from execution
wenzelm@46677
   338
    val assignments: Map[Version_ID, State.Assignment] = Map.empty,
wenzelm@38841
   339
    val history: History = History.init)
wenzelm@38370
   340
  {
wenzelm@38373
   341
    private def fail[A]: A = throw new State.Fail(this)
wenzelm@38370
   342
wenzelm@44479
   343
    def define_version(version: Version, assignment: State.Assignment): State =
wenzelm@38370
   344
    {
wenzelm@38417
   345
      val id = version.id
wenzelm@38417
   346
      copy(versions = versions + (id -> version),
wenzelm@44479
   347
        assignments = assignments + (id -> assignment.unfinished))
wenzelm@38370
   348
    }
wenzelm@38370
   349
wenzelm@38373
   350
    def define_command(command: Command): State =
wenzelm@38373
   351
    {
wenzelm@38373
   352
      val id = command.id
wenzelm@49414
   353
      copy(commands = commands + (id -> command.init_state))
wenzelm@38373
   354
    }
wenzelm@38373
   355
wenzelm@44582
   356
    def defined_command(id: Command_ID): Boolean = commands.isDefinedAt(id)
wenzelm@44582
   357
wenzelm@44607
   358
    def find_command(version: Version, id: ID): Option[(Node, Command)] =
wenzelm@44582
   359
      commands.get(id) orElse execs.get(id) match {
wenzelm@44582
   360
        case None => None
wenzelm@44582
   361
        case Some(st) =>
wenzelm@44582
   362
          val command = st.command
wenzelm@46681
   363
          val node = version.nodes(command.node_name)
wenzelm@46681
   364
          Some((node, command))
wenzelm@44582
   365
      }
wenzelm@38373
   366
wenzelm@38417
   367
    def the_version(id: Version_ID): Version = versions.getOrElse(id, fail)
wenzelm@47395
   368
    def the_command_state(id: Command_ID): Command.State = commands.getOrElse(id, fail)
wenzelm@44446
   369
    def the_exec(id: Exec_ID): Command.State = execs.getOrElse(id, fail)
wenzelm@43722
   370
    def the_assignment(version: Version): State.Assignment =
wenzelm@43722
   371
      assignments.getOrElse(version.id, fail)
wenzelm@38370
   372
wenzelm@38872
   373
    def accumulate(id: ID, message: XML.Elem): (Command.State, State) =
wenzelm@38370
   374
      execs.get(id) match {
wenzelm@44446
   375
        case Some(st) =>
wenzelm@46152
   376
          val new_st = st + message
wenzelm@44446
   377
          (new_st, copy(execs = execs + (id -> new_st)))
wenzelm@38370
   378
        case None =>
wenzelm@38370
   379
          commands.get(id) match {
wenzelm@38370
   380
            case Some(st) =>
wenzelm@46152
   381
              val new_st = st + message
wenzelm@38370
   382
              (new_st, copy(commands = commands + (id -> new_st)))
wenzelm@38370
   383
            case None => fail
wenzelm@38370
   384
          }
wenzelm@38370
   385
      }
wenzelm@38370
   386
wenzelm@47388
   387
    def assign(id: Version_ID, command_execs: Assign = Nil): (List[Command], State) =
wenzelm@38370
   388
    {
wenzelm@38417
   389
      val version = the_version(id)
wenzelm@38370
   390
wenzelm@44543
   391
      val (changed_commands, new_execs) =
wenzelm@44479
   392
        ((Nil: List[Command], execs) /: command_execs) {
wenzelm@44543
   393
          case ((commands1, execs1), (cmd_id, exec)) =>
wenzelm@47395
   394
            val st = the_command_state(cmd_id)
wenzelm@44543
   395
            val commands2 = st.command :: commands1
wenzelm@44543
   396
            val execs2 =
wenzelm@44543
   397
              exec match {
wenzelm@44543
   398
                case None => execs1
wenzelm@44543
   399
                case Some(exec_id) => execs1 + (exec_id -> st)
wenzelm@44543
   400
              }
wenzelm@44543
   401
            (commands2, execs2)
wenzelm@38370
   402
        }
wenzelm@47388
   403
      val new_assignment = the_assignment(version).assign(command_execs)
wenzelm@43722
   404
      val new_state = copy(assignments = assignments + (id -> new_assignment), execs = new_execs)
wenzelm@44476
   405
wenzelm@44543
   406
      (changed_commands, new_state)
wenzelm@38370
   407
    }
wenzelm@38370
   408
wenzelm@38417
   409
    def is_assigned(version: Version): Boolean =
wenzelm@43722
   410
      assignments.get(version.id) match {
wenzelm@38370
   411
        case Some(assgn) => assgn.is_finished
wenzelm@38370
   412
        case None => false
wenzelm@38370
   413
      }
wenzelm@38370
   414
wenzelm@44436
   415
    def is_stable(change: Change): Boolean =
wenzelm@44436
   416
      change.is_finished && is_assigned(change.version.get_finished)
wenzelm@44436
   417
wenzelm@46944
   418
    def recent_finished: Change = history.undo_list.find(_.is_finished) getOrElse fail
wenzelm@44672
   419
    def recent_stable: Change = history.undo_list.find(is_stable) getOrElse fail
wenzelm@44436
   420
    def tip_stable: Boolean = is_stable(history.tip)
wenzelm@44475
   421
    def tip_version: Version = history.tip.version.get_finished
wenzelm@44436
   422
wenzelm@44446
   423
    def continue_history(
wenzelm@44446
   424
        previous: Future[Version],
wenzelm@40479
   425
        edits: List[Edit_Text],
wenzelm@43722
   426
        version: Future[Version]): (Change, State) =
wenzelm@38841
   427
    {
wenzelm@46678
   428
      val change = Change.make(previous, edits, version)
wenzelm@38841
   429
      (change, copy(history = history + change))
wenzelm@38841
   430
    }
wenzelm@38841
   431
wenzelm@44672
   432
    def prune_history(retain: Int = 0): (List[Version], State) =
wenzelm@44672
   433
    {
wenzelm@46679
   434
      history.prune(is_stable, retain) match {
wenzelm@46679
   435
        case Some((dropped, history1)) =>
wenzelm@44672
   436
          val dropped_versions = dropped.map(change => change.version.get_finished)
wenzelm@46679
   437
          val state1 = copy(history = history1)
wenzelm@44672
   438
          (dropped_versions, state1)
wenzelm@46679
   439
        case None => fail
wenzelm@44672
   440
      }
wenzelm@44672
   441
    }
wenzelm@44672
   442
wenzelm@44676
   443
    def removed_versions(removed: List[Version_ID]): State =
wenzelm@44676
   444
    {
wenzelm@44676
   445
      val versions1 = versions -- removed
wenzelm@44676
   446
      val assignments1 = assignments -- removed
wenzelm@44676
   447
      var commands1 = Map.empty[Command_ID, Command.State]
wenzelm@44676
   448
      var execs1 = Map.empty[Exec_ID, Command.State]
wenzelm@44676
   449
      for {
wenzelm@44676
   450
        (version_id, version) <- versions1.iterator
wenzelm@46997
   451
        command_execs = assignments1(version_id).command_execs
wenzelm@46723
   452
        (_, node) <- version.nodes.entries
wenzelm@44676
   453
        command <- node.commands.iterator
wenzelm@44676
   454
      } {
wenzelm@44676
   455
        val id = command.id
wenzelm@44676
   456
        if (!commands1.isDefinedAt(id) && commands.isDefinedAt(id))
wenzelm@44676
   457
          commands1 += (id -> commands(id))
wenzelm@44676
   458
        if (command_execs.isDefinedAt(id)) {
wenzelm@44676
   459
          val exec_id = command_execs(id)
wenzelm@44676
   460
          if (!execs1.isDefinedAt(exec_id) && execs.isDefinedAt(exec_id))
wenzelm@44676
   461
            execs1 += (exec_id -> execs(exec_id))
wenzelm@44676
   462
        }
wenzelm@44676
   463
      }
wenzelm@44676
   464
      copy(versions = versions1, commands = commands1, execs = execs1, assignments = assignments1)
wenzelm@44676
   465
    }
wenzelm@44676
   466
wenzelm@44613
   467
    def command_state(version: Version, command: Command): Command.State =
wenzelm@44613
   468
    {
wenzelm@44613
   469
      require(is_assigned(version))
wenzelm@44613
   470
      try {
wenzelm@44613
   471
        the_exec(the_assignment(version).check_finished.command_execs
wenzelm@44613
   472
          .getOrElse(command.id, fail))
wenzelm@44613
   473
      }
wenzelm@47395
   474
      catch {
wenzelm@47395
   475
        case _: State.Fail =>
wenzelm@47395
   476
          try { the_command_state(command.id) }
wenzelm@49414
   477
          catch { case _: State.Fail => command.init_state }
wenzelm@47395
   478
      }
wenzelm@44613
   479
    }
wenzelm@44613
   480
wenzelm@38841
   481
wenzelm@38841
   482
    // persistent user-view
wenzelm@49346
   483
    def snapshot(name: Node.Name = Node.Name.empty, pending_edits: List[Text.Edit] = Nil)
wenzelm@49346
   484
      : Snapshot =
wenzelm@38370
   485
    {
wenzelm@44672
   486
      val stable = recent_stable
wenzelm@44436
   487
      val latest = history.tip
wenzelm@38841
   488
wenzelm@44156
   489
      // FIXME proper treatment of removed nodes
wenzelm@38841
   490
      val edits =
wenzelm@38841
   491
        (pending_edits /: history.undo_list.takeWhile(_ != stable))((edits, change) =>
wenzelm@44156
   492
            (for ((a, Node.Edits(es)) <- change.edits if a == name) yield es).flatten ::: edits)
wenzelm@38841
   493
      lazy val reverse_edits = edits.reverse
wenzelm@38841
   494
wenzelm@38841
   495
      new Snapshot
wenzelm@38841
   496
      {
wenzelm@44582
   497
        val state = State.this
wenzelm@39698
   498
        val version = stable.version.get_finished
wenzelm@48923
   499
        val node_name = name
wenzelm@38841
   500
        val node = version.nodes(name)
wenzelm@38841
   501
        val is_outdated = !(pending_edits.isEmpty && latest == stable)
wenzelm@38841
   502
wenzelm@38841
   503
        def convert(offset: Text.Offset) = (offset /: edits)((i, edit) => edit.convert(i))
wenzelm@38841
   504
        def revert(offset: Text.Offset) = (offset /: reverse_edits)((i, edit) => edit.revert(i))
wenzelm@43425
   505
        def convert(range: Text.Range) = (range /: edits)((r, edit) => edit.convert(r))
wenzelm@43425
   506
        def revert(range: Text.Range) = (range /: reverse_edits)((r, edit) => edit.revert(r))
wenzelm@39177
   507
wenzelm@49346
   508
        def eq_markup(other: Snapshot): Boolean =
wenzelm@49346
   509
          !is_outdated && !other.is_outdated &&
wenzelm@49346
   510
            node.commands.size == other.node.commands.size &&
wenzelm@49346
   511
            ((node.commands.iterator zip other.node.commands.iterator) forall {
wenzelm@49346
   512
              case (cmd1, cmd2) =>
wenzelm@49346
   513
                cmd1.source == cmd2.source &&
wenzelm@49346
   514
                (state.command_state(version, cmd1).markup eq
wenzelm@49346
   515
                 other.state.command_state(other.version, cmd2).markup)
wenzelm@49346
   516
            })
wenzelm@49346
   517
wenzelm@46178
   518
        def cumulate_markup[A](range: Text.Range, info: A, elements: Option[Set[String]],
wenzelm@46178
   519
          result: PartialFunction[(A, Text.Markup), A]): Stream[Text.Info[A]] =
wenzelm@45459
   520
        {
wenzelm@45467
   521
          val former_range = revert(range)
wenzelm@45459
   522
          for {
wenzelm@45459
   523
            (command, command_start) <- node.command_range(former_range).toStream
wenzelm@46208
   524
            Text.Info(r0, a) <- state.command_state(version, command).markup.
wenzelm@46178
   525
              cumulate[A]((former_range - command_start).restrict(command.range), info, elements,
wenzelm@46178
   526
                {
wenzelm@46178
   527
                  case (a, Text.Info(r0, b))
wenzelm@46178
   528
                  if result.isDefinedAt((a, Text.Info(convert(r0 + command_start), b))) =>
wenzelm@46178
   529
                    result((a, Text.Info(convert(r0 + command_start), b)))
wenzelm@46178
   530
                })
wenzelm@45459
   531
          } yield Text.Info(convert(r0 + command_start), a)
wenzelm@45459
   532
        }
wenzelm@45459
   533
wenzelm@46178
   534
        def select_markup[A](range: Text.Range, elements: Option[Set[String]],
wenzelm@46198
   535
          result: PartialFunction[Text.Markup, A]): Stream[Text.Info[A]] =
wenzelm@38845
   536
        {
wenzelm@45468
   537
          val result1 =
wenzelm@45468
   538
            new PartialFunction[(Option[A], Text.Markup), Option[A]] {
wenzelm@45468
   539
              def isDefinedAt(arg: (Option[A], Text.Markup)): Boolean = result.isDefinedAt(arg._2)
wenzelm@45468
   540
              def apply(arg: (Option[A], Text.Markup)): Option[A] = Some(result(arg._2))
wenzelm@45468
   541
            }
wenzelm@46198
   542
          for (Text.Info(r, Some(x)) <- cumulate_markup(range, None, elements, result1))
wenzelm@46198
   543
            yield Text.Info(r, x)
wenzelm@38845
   544
        }
wenzelm@38841
   545
      }
wenzelm@38150
   546
    }
wenzelm@34485
   547
  }
wenzelm@34840
   548
}
wenzelm@34840
   549