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