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