src/Pure/PIDE/document.scala
author wenzelm
Wed Aug 24 16:49:48 2011 +0200 (2011-08-24)
changeset 44443 35d67b2056cc
parent 44442 cb18e4f09053
child 44446 f9334afb6945
permissions -rw-r--r--
clarified Document.Node.clear -- retain header (cf. ML version);
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@43662
    26
  val new_id = new Counter
wenzelm@38355
    27
wenzelm@38150
    28
wenzelm@34818
    29
wenzelm@38424
    30
  /** document structure **/
wenzelm@38424
    31
wenzelm@38424
    32
  /* named nodes -- development graph */
wenzelm@38424
    33
wenzelm@44384
    34
  type Edit[A, B] = (String, 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@44182
    38
  type Node_Header = Exn.Result[Thy_Header]
wenzelm@44182
    39
wenzelm@38151
    40
  object Node
wenzelm@38151
    41
  {
wenzelm@44384
    42
    sealed abstract class Edit[A, B]
wenzelm@44156
    43
    {
wenzelm@44383
    44
      def foreach(f: A => Unit)
wenzelm@44383
    45
      {
wenzelm@44156
    46
        this match {
wenzelm@44383
    47
          case Edits(es) => es.foreach(f)
wenzelm@44383
    48
          case _ =>
wenzelm@44156
    49
        }
wenzelm@44383
    50
      }
wenzelm@44156
    51
    }
wenzelm@44384
    52
    case class Clear[A, B]() extends Edit[A, B]
wenzelm@44384
    53
    case class Edits[A, B](edits: List[A]) extends Edit[A, B]
wenzelm@44384
    54
    case class Header[A, B](header: Node_Header) extends Edit[A, B]
wenzelm@44384
    55
    case class Perspective[A, B](perspective: B) extends Edit[A, B]
wenzelm@44156
    56
wenzelm@44442
    57
    def norm_header(f: String => String, g: String => String, header: Node_Header): Node_Header =
wenzelm@44182
    58
      header match {
wenzelm@44442
    59
        case Exn.Res(h) => Exn.capture { h.norm_deps(f, g) }
wenzelm@44442
    60
        case exn => exn
wenzelm@44182
    61
      }
wenzelm@43697
    62
wenzelm@44385
    63
    val empty: Node = Node(Exn.Exn(ERROR("Bad theory header")), Nil, Map(), Linear_Set())
wenzelm@38227
    64
wenzelm@38426
    65
    def command_starts(commands: Iterator[Command], offset: Text.Offset = 0)
wenzelm@38426
    66
      : Iterator[(Command, Text.Offset)] =
wenzelm@38227
    67
    {
wenzelm@38227
    68
      var i = offset
wenzelm@38227
    69
      for (command <- commands) yield {
wenzelm@38227
    70
        val start = i
wenzelm@38227
    71
        i += command.length
wenzelm@38227
    72
        (command, start)
wenzelm@38227
    73
      }
wenzelm@38227
    74
    }
wenzelm@38151
    75
  }
wenzelm@38151
    76
wenzelm@38880
    77
  private val block_size = 1024
wenzelm@38879
    78
wenzelm@43715
    79
  sealed case class Node(
wenzelm@44182
    80
    val header: Node_Header,
wenzelm@44385
    81
    val perspective: Command.Perspective,
wenzelm@43715
    82
    val blobs: Map[String, Blob],
wenzelm@43715
    83
    val commands: Linear_Set[Command])
wenzelm@38151
    84
  {
wenzelm@44443
    85
    def clear: Node = Node.empty.copy(header = header)
wenzelm@44443
    86
wenzelm@44443
    87
wenzelm@43697
    88
    /* commands */
wenzelm@43697
    89
wenzelm@38879
    90
    private lazy val full_index: (Array[(Command, Text.Offset)], Text.Range) =
wenzelm@38879
    91
    {
wenzelm@38879
    92
      val blocks = new mutable.ListBuffer[(Command, Text.Offset)]
wenzelm@38879
    93
      var next_block = 0
wenzelm@38879
    94
      var last_stop = 0
wenzelm@38879
    95
      for ((command, start) <- Node.command_starts(commands.iterator)) {
wenzelm@38879
    96
        last_stop = start + command.length
wenzelm@38885
    97
        while (last_stop + 1 > next_block) {
wenzelm@38879
    98
          blocks += (command -> start)
wenzelm@38879
    99
          next_block += block_size
wenzelm@38879
   100
        }
wenzelm@38879
   101
      }
wenzelm@38879
   102
      (blocks.toArray, Text.Range(0, last_stop))
wenzelm@38879
   103
    }
wenzelm@38151
   104
wenzelm@38879
   105
    def full_range: Text.Range = full_index._2
wenzelm@38151
   106
wenzelm@38569
   107
    def command_range(i: Text.Offset = 0): Iterator[(Command, Text.Offset)] =
wenzelm@38879
   108
    {
wenzelm@38879
   109
      if (!commands.isEmpty && full_range.contains(i)) {
wenzelm@38879
   110
        val (cmd0, start0) = full_index._1(i / block_size)
wenzelm@38879
   111
        Node.command_starts(commands.iterator(cmd0), start0) dropWhile {
wenzelm@38879
   112
          case (cmd, start) => start + cmd.length <= i }
wenzelm@38879
   113
      }
wenzelm@38879
   114
      else Iterator.empty
wenzelm@38879
   115
    }
wenzelm@38151
   116
wenzelm@38569
   117
    def command_range(range: Text.Range): Iterator[(Command, Text.Offset)] =
wenzelm@38569
   118
      command_range(range.start) takeWhile { case (_, start) => start < range.stop }
wenzelm@38151
   119
wenzelm@38426
   120
    def command_at(i: Text.Offset): Option[(Command, Text.Offset)] =
wenzelm@38151
   121
    {
wenzelm@38151
   122
      val range = command_range(i)
wenzelm@38151
   123
      if (range.hasNext) Some(range.next) else None
wenzelm@38151
   124
    }
wenzelm@38151
   125
wenzelm@38426
   126
    def proper_command_at(i: Text.Offset): Option[Command] =
wenzelm@38151
   127
      command_at(i) match {
wenzelm@38151
   128
        case Some((command, _)) =>
wenzelm@38151
   129
          commands.reverse_iterator(command).find(cmd => !cmd.is_ignored)
wenzelm@38151
   130
        case None => None
wenzelm@38151
   131
      }
wenzelm@38879
   132
wenzelm@38879
   133
    def command_start(cmd: Command): Option[Text.Offset] =
wenzelm@38879
   134
      command_starts.find(_._1 == cmd).map(_._2)
wenzelm@38879
   135
wenzelm@38879
   136
    def command_starts: Iterator[(Command, Text.Offset)] =
wenzelm@38879
   137
      Node.command_starts(commands.iterator)
wenzelm@38151
   138
  }
wenzelm@38151
   139
wenzelm@38151
   140
wenzelm@38424
   141
wenzelm@38424
   142
  /** versioning **/
wenzelm@38424
   143
wenzelm@38424
   144
  /* particular document versions */
wenzelm@34485
   145
wenzelm@38417
   146
  object Version
wenzelm@38417
   147
  {
wenzelm@43722
   148
    val init: Version = Version(no_id, Map().withDefaultValue(Node.empty))
wenzelm@38417
   149
  }
wenzelm@38417
   150
wenzelm@44436
   151
  type Nodes = Map[String, Node]
wenzelm@44436
   152
  sealed case class Version(val id: Version_ID, val nodes: Nodes)
immler@34660
   153
wenzelm@34859
   154
wenzelm@38424
   155
  /* changes of plain text, eventually resulting in document edits */
wenzelm@38227
   156
wenzelm@38227
   157
  object Change
wenzelm@38227
   158
  {
wenzelm@43722
   159
    val init = Change(Future.value(Version.init), Nil, Future.value(Version.init))
wenzelm@38227
   160
  }
wenzelm@38227
   161
wenzelm@43722
   162
  sealed case class Change(
wenzelm@38417
   163
    val previous: Future[Version],
wenzelm@40479
   164
    val edits: List[Edit_Text],
wenzelm@43722
   165
    val version: Future[Version])
wenzelm@38227
   166
  {
wenzelm@39698
   167
    def is_finished: Boolean = previous.is_finished && version.is_finished
wenzelm@38227
   168
  }
wenzelm@38227
   169
wenzelm@38227
   170
wenzelm@38841
   171
  /* history navigation */
wenzelm@38841
   172
wenzelm@38841
   173
  object History
wenzelm@38841
   174
  {
wenzelm@38841
   175
    val init = new History(List(Change.init))
wenzelm@38841
   176
  }
wenzelm@38841
   177
wenzelm@38841
   178
  // FIXME pruning, purging of state
wenzelm@38841
   179
  class History(val undo_list: List[Change])
wenzelm@38841
   180
  {
wenzelm@38841
   181
    require(!undo_list.isEmpty)
wenzelm@38841
   182
wenzelm@38841
   183
    def tip: Change = undo_list.head
wenzelm@38841
   184
    def +(change: Change): History = new History(change :: undo_list)
wenzelm@38841
   185
  }
wenzelm@38841
   186
wenzelm@38841
   187
wenzelm@38841
   188
wenzelm@38841
   189
  /** global state -- document structure, execution process, editing history **/
wenzelm@38424
   190
wenzelm@38424
   191
  abstract class Snapshot
wenzelm@38424
   192
  {
wenzelm@38424
   193
    val version: Version
wenzelm@38424
   194
    val node: Node
wenzelm@38424
   195
    val is_outdated: Boolean
wenzelm@38424
   196
    def lookup_command(id: Command_ID): Option[Command]
wenzelm@38424
   197
    def state(command: Command): Command.State
wenzelm@38427
   198
    def convert(i: Text.Offset): Text.Offset
wenzelm@39177
   199
    def convert(range: Text.Range): Text.Range
wenzelm@38427
   200
    def revert(i: Text.Offset): Text.Offset
wenzelm@39177
   201
    def revert(range: Text.Range): Text.Range
wenzelm@39178
   202
    def select_markup[A](range: Text.Range)(result: Markup_Tree.Select[A])
wenzelm@39177
   203
      : Stream[Text.Info[Option[A]]]
wenzelm@38424
   204
  }
wenzelm@38424
   205
wenzelm@38370
   206
  object State
wenzelm@38370
   207
  {
wenzelm@38373
   208
    class Fail(state: State) extends Exception
wenzelm@38373
   209
wenzelm@38882
   210
    val init = State().define_version(Version.init, Map()).assign(Version.init.id, Nil)._2
wenzelm@38370
   211
wenzelm@38976
   212
    case class Assignment(
wenzelm@38976
   213
      val assignment: Map[Command, Exec_ID],
wenzelm@38976
   214
      val is_finished: Boolean = false)
wenzelm@38370
   215
    {
wenzelm@38976
   216
      def get_finished: Map[Command, Exec_ID] = { require(is_finished); assignment }
wenzelm@38976
   217
      def assign(command_execs: List[(Command, Exec_ID)]): Assignment =
wenzelm@38370
   218
      {
wenzelm@38976
   219
        require(!is_finished)
wenzelm@38976
   220
        Assignment(assignment ++ command_execs, true)
wenzelm@38150
   221
      }
wenzelm@38370
   222
    }
wenzelm@38370
   223
  }
wenzelm@38370
   224
wenzelm@43715
   225
  sealed case class State(
wenzelm@38417
   226
    val versions: Map[Version_ID, Version] = Map(),
wenzelm@38370
   227
    val commands: Map[Command_ID, Command.State] = Map(),
wenzelm@38417
   228
    val execs: Map[Exec_ID, (Command.State, Set[Version])] = Map(),
wenzelm@43722
   229
    val assignments: Map[Version_ID, State.Assignment] = Map(),
wenzelm@38841
   230
    val disposed: Set[ID] = Set(),  // FIXME unused!?
wenzelm@38841
   231
    val history: History = History.init)
wenzelm@38370
   232
  {
wenzelm@38373
   233
    private def fail[A]: A = throw new State.Fail(this)
wenzelm@38370
   234
wenzelm@38417
   235
    def define_version(version: Version, former_assignment: Map[Command, Exec_ID]): State =
wenzelm@38370
   236
    {
wenzelm@38417
   237
      val id = version.id
wenzelm@38417
   238
      if (versions.isDefinedAt(id) || disposed(id)) fail
wenzelm@38417
   239
      copy(versions = versions + (id -> version),
wenzelm@43722
   240
        assignments = assignments + (id -> State.Assignment(former_assignment)))
wenzelm@38370
   241
    }
wenzelm@38370
   242
wenzelm@38373
   243
    def define_command(command: Command): State =
wenzelm@38373
   244
    {
wenzelm@38373
   245
      val id = command.id
wenzelm@38373
   246
      if (commands.isDefinedAt(id) || disposed(id)) fail
wenzelm@38373
   247
      copy(commands = commands + (id -> command.empty_state))
wenzelm@38373
   248
    }
wenzelm@38373
   249
wenzelm@38370
   250
    def lookup_command(id: Command_ID): Option[Command] = commands.get(id).map(_.command)
wenzelm@38373
   251
wenzelm@38417
   252
    def the_version(id: Version_ID): Version = versions.getOrElse(id, fail)
wenzelm@38370
   253
    def the_command(id: Command_ID): Command.State = commands.getOrElse(id, fail)
wenzelm@38370
   254
    def the_exec_state(id: Exec_ID): Command.State = execs.getOrElse(id, fail)._1
wenzelm@43722
   255
    def the_assignment(version: Version): State.Assignment =
wenzelm@43722
   256
      assignments.getOrElse(version.id, fail)
wenzelm@38370
   257
wenzelm@38872
   258
    def accumulate(id: ID, message: XML.Elem): (Command.State, State) =
wenzelm@38370
   259
      execs.get(id) match {
wenzelm@38417
   260
        case Some((st, occs)) =>
wenzelm@38370
   261
          val new_st = st.accumulate(message)
wenzelm@38417
   262
          (new_st, copy(execs = execs + (id -> (new_st, occs))))
wenzelm@38370
   263
        case None =>
wenzelm@38370
   264
          commands.get(id) match {
wenzelm@38370
   265
            case Some(st) =>
wenzelm@38370
   266
              val new_st = st.accumulate(message)
wenzelm@38370
   267
              (new_st, copy(commands = commands + (id -> new_st)))
wenzelm@38370
   268
            case None => fail
wenzelm@38370
   269
          }
wenzelm@38370
   270
      }
wenzelm@38370
   271
wenzelm@38882
   272
    def assign(id: Version_ID, edits: List[(Command_ID, Exec_ID)]): (List[Command], State) =
wenzelm@38370
   273
    {
wenzelm@38417
   274
      val version = the_version(id)
wenzelm@38417
   275
      val occs = Set(version)  // FIXME unused (!?)
wenzelm@38370
   276
wenzelm@38370
   277
      var new_execs = execs
wenzelm@38370
   278
      val assigned_execs =
wenzelm@38370
   279
        for ((cmd_id, exec_id) <- edits) yield {
wenzelm@38370
   280
          val st = the_command(cmd_id)
wenzelm@38370
   281
          if (new_execs.isDefinedAt(exec_id) || disposed(exec_id)) fail
wenzelm@38417
   282
          new_execs += (exec_id -> (st, occs))
wenzelm@38370
   283
          (st.command, exec_id)
wenzelm@38370
   284
        }
wenzelm@38976
   285
      val new_assignment = the_assignment(version).assign(assigned_execs)
wenzelm@43722
   286
      val new_state = copy(assignments = assignments + (id -> new_assignment), execs = new_execs)
wenzelm@38976
   287
      (assigned_execs.map(_._1), new_state)
wenzelm@38370
   288
    }
wenzelm@38370
   289
wenzelm@38417
   290
    def is_assigned(version: Version): Boolean =
wenzelm@43722
   291
      assignments.get(version.id) match {
wenzelm@38370
   292
        case Some(assgn) => assgn.is_finished
wenzelm@38370
   293
        case None => false
wenzelm@38370
   294
      }
wenzelm@38370
   295
wenzelm@44436
   296
    def is_stable(change: Change): Boolean =
wenzelm@44436
   297
      change.is_finished && is_assigned(change.version.get_finished)
wenzelm@44436
   298
wenzelm@44436
   299
    def tip_stable: Boolean = is_stable(history.tip)
wenzelm@44436
   300
    def recent_stable: Option[Change] = history.undo_list.find(is_stable)
wenzelm@44436
   301
wenzelm@38841
   302
    def extend_history(previous: Future[Version],
wenzelm@40479
   303
        edits: List[Edit_Text],
wenzelm@43722
   304
        version: Future[Version]): (Change, State) =
wenzelm@38841
   305
    {
wenzelm@43722
   306
      val change = Change(previous, edits, version)
wenzelm@38841
   307
      (change, copy(history = history + change))
wenzelm@38841
   308
    }
wenzelm@38841
   309
wenzelm@38841
   310
wenzelm@38841
   311
    // persistent user-view
wenzelm@38841
   312
    def snapshot(name: String, pending_edits: List[Text.Edit]): Snapshot =
wenzelm@38370
   313
    {
wenzelm@44436
   314
      val stable = recent_stable.get
wenzelm@44436
   315
      val latest = history.tip
wenzelm@38841
   316
wenzelm@44156
   317
      // FIXME proper treatment of removed nodes
wenzelm@38841
   318
      val edits =
wenzelm@38841
   319
        (pending_edits /: history.undo_list.takeWhile(_ != stable))((edits, change) =>
wenzelm@44156
   320
            (for ((a, Node.Edits(es)) <- change.edits if a == name) yield es).flatten ::: edits)
wenzelm@38841
   321
      lazy val reverse_edits = edits.reverse
wenzelm@38841
   322
wenzelm@38841
   323
      new Snapshot
wenzelm@38841
   324
      {
wenzelm@39698
   325
        val version = stable.version.get_finished
wenzelm@38841
   326
        val node = version.nodes(name)
wenzelm@38841
   327
        val is_outdated = !(pending_edits.isEmpty && latest == stable)
wenzelm@38841
   328
wenzelm@38841
   329
        def lookup_command(id: Command_ID): Option[Command] = State.this.lookup_command(id)
wenzelm@38841
   330
wenzelm@38841
   331
        def state(command: Command): Command.State =
wenzelm@38848
   332
          try { the_exec_state(the_assignment(version).get_finished.getOrElse(command, fail)) }
wenzelm@38841
   333
          catch { case _: State.Fail => command.empty_state }
wenzelm@38841
   334
wenzelm@38841
   335
        def convert(offset: Text.Offset) = (offset /: edits)((i, edit) => edit.convert(i))
wenzelm@38841
   336
        def revert(offset: Text.Offset) = (offset /: reverse_edits)((i, edit) => edit.revert(i))
wenzelm@43425
   337
        def convert(range: Text.Range) = (range /: edits)((r, edit) => edit.convert(r))
wenzelm@43425
   338
        def revert(range: Text.Range) = (range /: reverse_edits)((r, edit) => edit.revert(r))
wenzelm@39177
   339
wenzelm@39178
   340
        def select_markup[A](range: Text.Range)(result: Markup_Tree.Select[A])
wenzelm@39177
   341
          : Stream[Text.Info[Option[A]]] =
wenzelm@38845
   342
        {
wenzelm@38845
   343
          val former_range = revert(range)
wenzelm@38845
   344
          for {
wenzelm@39177
   345
            (command, command_start) <- node.command_range(former_range).toStream
wenzelm@38845
   346
            Text.Info(r0, x) <- state(command).markup.
wenzelm@38845
   347
              select((former_range - command_start).restrict(command.range)) {
wenzelm@38845
   348
                case Text.Info(r0, info)
wenzelm@38845
   349
                if result.isDefinedAt(Text.Info(convert(r0 + command_start), info)) =>
wenzelm@38845
   350
                  result(Text.Info(convert(r0 + command_start), info))
wenzelm@39177
   351
              }
wenzelm@43427
   352
          } yield Text.Info(convert(r0 + command_start), x)
wenzelm@38845
   353
        }
wenzelm@38841
   354
      }
wenzelm@38150
   355
    }
wenzelm@34485
   356
  }
wenzelm@34840
   357
}
wenzelm@34840
   358