src/Pure/PIDE/text.scala
author wenzelm
Sat Mar 01 22:46:31 2014 +0100 (2014-03-01)
changeset 55828 42ac3cfb89f6
parent 48677 bd4d132e32cf
child 56172 31289387fdf8
permissions -rw-r--r--
clarified language markup: added "delimited" property;
type Symbol_Pos.source preserves information about delimited outer tokens (e.g string, cartouche);
observe Completion.Language_Context only for delimited languages, which is important to complete keywords after undelimited inner tokens, e.g. "lemma A pro";
wenzelm@38425
     1
/*  Title:      Pure/PIDE/text.scala
wenzelm@45673
     2
    Module:     PIDE
wenzelm@34276
     3
    Author:     Fabian Immler, TU Munich
wenzelm@34276
     4
    Author:     Makarius
wenzelm@34276
     5
wenzelm@38425
     6
Basic operations on plain text.
wenzelm@34276
     7
*/
wenzelm@34276
     8
wenzelm@34276
     9
package isabelle
wenzelm@34276
    10
wenzelm@34276
    11
wenzelm@44379
    12
import scala.collection.mutable
wenzelm@44379
    13
import scala.util.Sorting
wenzelm@44379
    14
wenzelm@44379
    15
wenzelm@38425
    16
object Text
wenzelm@34276
    17
{
wenzelm@38477
    18
  /* offset */
wenzelm@38426
    19
wenzelm@38426
    20
  type Offset = Int
wenzelm@38426
    21
wenzelm@38477
    22
wenzelm@38565
    23
  /* range -- with total quasi-ordering */
wenzelm@38477
    24
wenzelm@38568
    25
  object Range
wenzelm@38568
    26
  {
wenzelm@38568
    27
    def apply(start: Offset): Range = Range(start, start)
wenzelm@44379
    28
wenzelm@44379
    29
    object Ordering extends scala.math.Ordering[Text.Range]
wenzelm@44379
    30
    {
wenzelm@44379
    31
      def compare(r1: Text.Range, r2: Text.Range): Int = r1 compare r2
wenzelm@44379
    32
    }
wenzelm@38568
    33
  }
wenzelm@38568
    34
wenzelm@38426
    35
  sealed case class Range(val start: Offset, val stop: Offset)
wenzelm@38427
    36
  {
wenzelm@38565
    37
    // denotation: {start} Un {i. start < i & i < stop}
wenzelm@43425
    38
    if (start > stop)
wenzelm@43425
    39
      error("Bad range: [" + start.toString + ":" + stop.toString + "]")
wenzelm@38477
    40
wenzelm@38563
    41
    override def toString = "[" + start.toString + ":" + stop.toString + "]"
wenzelm@38563
    42
wenzelm@47542
    43
    def length: Int = stop - start
wenzelm@47542
    44
wenzelm@38427
    45
    def map(f: Offset => Offset): Range = Range(f(start), f(stop))
wenzelm@38427
    46
    def +(i: Offset): Range = map(_ + i)
wenzelm@38570
    47
    def -(i: Offset): Range = map(_ - i)
wenzelm@38662
    48
wenzelm@38725
    49
    def is_singularity: Boolean = start == stop
wenzelm@38662
    50
wenzelm@38565
    51
    def contains(i: Offset): Boolean = start == i || start < i && i < stop
wenzelm@38565
    52
    def contains(that: Range): Boolean = this.contains(that.start) && that.stop <= this.stop
wenzelm@38565
    53
    def overlaps(that: Range): Boolean = this.contains(that.start) || that.contains(this.start)
wenzelm@38565
    54
    def compare(that: Range): Int = if (overlaps(that)) 0 else this.start compare that.start
wenzelm@38485
    55
wenzelm@45240
    56
    def apart(that: Range): Boolean =
wenzelm@45240
    57
      (this.start max that.start) > (this.stop min that.stop)
wenzelm@45240
    58
wenzelm@38564
    59
    def restrict(that: Range): Range =
wenzelm@38485
    60
      Range(this.start max that.start, this.stop min that.stop)
wenzelm@43428
    61
wenzelm@43428
    62
    def try_restrict(that: Range): Option[Range] =
wenzelm@45240
    63
      if (this apart that) None
wenzelm@45240
    64
      else Some(restrict(that))
wenzelm@45240
    65
wenzelm@45240
    66
    def try_join(that: Range): Option[Range] =
wenzelm@45240
    67
      if (this apart that) None
wenzelm@45240
    68
      else Some(Range(this.start min that.start, this.stop max that.stop))
wenzelm@38427
    69
  }
wenzelm@38426
    70
wenzelm@38426
    71
wenzelm@44379
    72
  /* perspective */
wenzelm@44379
    73
wenzelm@44473
    74
  object Perspective
wenzelm@44379
    75
  {
wenzelm@44474
    76
    val empty: Perspective = Perspective(Nil)
wenzelm@44379
    77
wenzelm@46576
    78
    def full: Perspective = Perspective(List(Range(0, Integer.MAX_VALUE / 2)))
wenzelm@46576
    79
wenzelm@44473
    80
    def apply(ranges: Seq[Range]): Perspective =
wenzelm@44379
    81
    {
wenzelm@44473
    82
      val result = new mutable.ListBuffer[Text.Range]
wenzelm@44473
    83
      var last: Option[Text.Range] = None
wenzelm@45240
    84
      def ship(next: Option[Range]) { result ++= last; last = next }
wenzelm@45240
    85
wenzelm@45240
    86
      for (range <- ranges.sortBy(_.start))
wenzelm@44473
    87
      {
wenzelm@44473
    88
        last match {
wenzelm@45240
    89
          case None => ship(Some(range))
wenzelm@45240
    90
          case Some(last_range) =>
wenzelm@45240
    91
            last_range.try_join(range) match {
wenzelm@45240
    92
              case None => ship(Some(range))
wenzelm@45240
    93
              case joined => last = joined
wenzelm@45240
    94
            }
wenzelm@44473
    95
        }
wenzelm@44379
    96
      }
wenzelm@45240
    97
      ship(None)
wenzelm@44473
    98
      new Perspective(result.toList)
wenzelm@44379
    99
    }
wenzelm@44473
   100
  }
wenzelm@44473
   101
wenzelm@46712
   102
  final class Perspective private(
wenzelm@46712
   103
    val ranges: List[Range]) // visible text partitioning in canonical order
wenzelm@44473
   104
  {
wenzelm@44473
   105
    def is_empty: Boolean = ranges.isEmpty
wenzelm@44473
   106
    def range: Range =
wenzelm@44473
   107
      if (is_empty) Range(0)
wenzelm@44473
   108
      else Range(ranges.head.start, ranges.last.stop)
wenzelm@45631
   109
wenzelm@45631
   110
    override def hashCode: Int = ranges.hashCode
wenzelm@45631
   111
    override def equals(that: Any): Boolean =
wenzelm@45631
   112
      that match {
wenzelm@45631
   113
        case other: Perspective => ranges == other.ranges
wenzelm@45631
   114
        case _ => false
wenzelm@45631
   115
      }
wenzelm@45240
   116
    override def toString = ranges.toString
wenzelm@44379
   117
  }
wenzelm@44379
   118
wenzelm@44379
   119
wenzelm@38577
   120
  /* information associated with text range */
wenzelm@38577
   121
wenzelm@43714
   122
  sealed case class Info[A](val range: Text.Range, val info: A)
wenzelm@38577
   123
  {
wenzelm@38577
   124
    def restrict(r: Text.Range): Info[A] = Info(range.restrict(r), info)
wenzelm@46207
   125
    def try_restrict(r: Text.Range): Option[Info[A]] = range.try_restrict(r).map(Info(_, info))
wenzelm@38577
   126
  }
wenzelm@38577
   127
wenzelm@45470
   128
  type Markup = Info[XML.Elem]
wenzelm@45455
   129
wenzelm@38577
   130
wenzelm@38426
   131
  /* editing */
wenzelm@34286
   132
wenzelm@38425
   133
  object Edit
wenzelm@38425
   134
  {
wenzelm@38426
   135
    def insert(start: Offset, text: String): Edit = new Edit(true, start, text)
wenzelm@38426
   136
    def remove(start: Offset, text: String): Edit = new Edit(false, start, text)
wenzelm@38425
   137
  }
wenzelm@34286
   138
wenzelm@46712
   139
  final class Edit private(val is_insert: Boolean, val start: Offset, val text: String)
wenzelm@38425
   140
  {
wenzelm@38425
   141
    override def toString =
wenzelm@38425
   142
      (if (is_insert) "Insert(" else "Remove(") + (start, text).toString + ")"
wenzelm@34286
   143
wenzelm@34286
   144
wenzelm@38425
   145
    /* transform offsets */
wenzelm@34286
   146
wenzelm@38426
   147
    private def transform(do_insert: Boolean, i: Offset): Offset =
wenzelm@38426
   148
      if (i < start) i
wenzelm@43425
   149
      else if (do_insert) i + text.length
wenzelm@38426
   150
      else (i - text.length) max start
wenzelm@34286
   151
wenzelm@43425
   152
    def convert(i: Offset): Offset = transform(is_insert, i)
wenzelm@43425
   153
    def revert(i: Offset): Offset = transform(!is_insert, i)
wenzelm@43425
   154
    def convert(range: Range): Range = range.map(convert)
wenzelm@43425
   155
    def revert(range: Range): Range = range.map(revert)
wenzelm@38425
   156
wenzelm@34286
   157
wenzelm@38425
   158
    /* edit strings */
wenzelm@38425
   159
wenzelm@38426
   160
    private def insert(i: Offset, string: String): String =
wenzelm@38426
   161
      string.substring(0, i) + text + string.substring(i)
wenzelm@34276
   162
wenzelm@38426
   163
    private def remove(i: Offset, count: Int, string: String): String =
wenzelm@38426
   164
      string.substring(0, i) + string.substring(i + count)
wenzelm@38425
   165
wenzelm@38425
   166
    def can_edit(string: String, shift: Int): Boolean =
wenzelm@38425
   167
      shift <= start && start < shift + string.length
wenzelm@38425
   168
wenzelm@38425
   169
    def edit(string: String, shift: Int): (Option[Edit], String) =
wenzelm@38425
   170
      if (!can_edit(string, shift)) (Some(this), string)
wenzelm@38425
   171
      else if (is_insert) (None, insert(start - shift, string))
wenzelm@38425
   172
      else {
wenzelm@38426
   173
        val i = start - shift
wenzelm@38426
   174
        val count = text.length min (string.length - i)
wenzelm@38425
   175
        val rest =
wenzelm@38425
   176
          if (count == text.length) None
wenzelm@38425
   177
          else Some(Edit.remove(start, text.substring(count)))
wenzelm@38426
   178
        (rest, remove(i, count, string))
wenzelm@38425
   179
      }
wenzelm@38425
   180
  }
wenzelm@34276
   181
}