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