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