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