src/Pure/PIDE/text.scala
author wenzelm
Thu, 25 Aug 2011 11:27:37 +0200
changeset 44473 4f264fdf8d0e
parent 44384 8f6054a63f96
child 44474 681447a9ffe5
permissions -rw-r--r--
slightly more abstract Text.Perspective;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
     1
/*  Title:      Pure/PIDE/text.scala
34276
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
     2
    Author:     Fabian Immler, TU Munich
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
     3
    Author:     Makarius
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
     4
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
     5
Basic operations on plain text.
34276
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
     6
*/
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
     7
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
     8
package isabelle
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
     9
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
    10
44379
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    11
import scala.collection.mutable
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    12
import scala.math.Ordering
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    13
import scala.util.Sorting
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    14
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    15
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    16
object Text
34276
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
    17
{
38477
f01f4ab2a0af refined notion of Text.Range;
wenzelm
parents: 38427
diff changeset
    18
  /* offset */
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    19
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    20
  type Offset = Int
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    21
38477
f01f4ab2a0af refined notion of Text.Range;
wenzelm
parents: 38427
diff changeset
    22
38565
32b924a832c4 further clarification/unification of Position.Range and Text.Range concerning singularities: start offset is always included;
wenzelm
parents: 38564
diff changeset
    23
  /* range -- with total quasi-ordering */
38477
f01f4ab2a0af refined notion of Text.Range;
wenzelm
parents: 38427
diff changeset
    24
38568
f117ba49a59c alternative constructor for Range singularities;
wenzelm
parents: 38565
diff changeset
    25
  object Range
f117ba49a59c alternative constructor for Range singularities;
wenzelm
parents: 38565
diff changeset
    26
  {
f117ba49a59c alternative constructor for Range singularities;
wenzelm
parents: 38565
diff changeset
    27
    def apply(start: Offset): Range = Range(start, start)
44379
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    28
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    29
    object Ordering extends scala.math.Ordering[Text.Range]
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    30
    {
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    31
      def compare(r1: Text.Range, r2: Text.Range): Int = r1 compare r2
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    32
    }
38568
f117ba49a59c alternative constructor for Range singularities;
wenzelm
parents: 38565
diff changeset
    33
  }
f117ba49a59c alternative constructor for Range singularities;
wenzelm
parents: 38565
diff changeset
    34
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    35
  sealed case class Range(val start: Offset, val stop: Offset)
38427
7066fbd315ae some derived operations on Text.Range;
wenzelm
parents: 38426
diff changeset
    36
  {
38565
32b924a832c4 further clarification/unification of Position.Range and Text.Range concerning singularities: start offset is always included;
wenzelm
parents: 38564
diff changeset
    37
    // denotation: {start} Un {i. start < i & i < stop}
43425
0a5612040a8b more explicit error message;
wenzelm
parents: 38725
diff changeset
    38
    if (start > stop)
0a5612040a8b more explicit error message;
wenzelm
parents: 38725
diff changeset
    39
      error("Bad range: [" + start.toString + ":" + stop.toString + "]")
38477
f01f4ab2a0af refined notion of Text.Range;
wenzelm
parents: 38427
diff changeset
    40
38563
f6c9a4f9f66f added toString methods;
wenzelm
parents: 38562
diff changeset
    41
    override def toString = "[" + start.toString + ":" + stop.toString + "]"
f6c9a4f9f66f added toString methods;
wenzelm
parents: 38562
diff changeset
    42
38427
7066fbd315ae some derived operations on Text.Range;
wenzelm
parents: 38426
diff changeset
    43
    def map(f: Offset => Offset): Range = Range(f(start), f(stop))
7066fbd315ae some derived operations on Text.Range;
wenzelm
parents: 38426
diff changeset
    44
    def +(i: Offset): Range = map(_ + i)
38570
3fa11fb01f86 added Text.Range.- convenience;
wenzelm
parents: 38568
diff changeset
    45
    def -(i: Offset): Range = map(_ - i)
38662
4d4553e09337 Text.Range.is_singleton;
wenzelm
parents: 38578
diff changeset
    46
38725
3d9d5ff80f6f tuned signature;
wenzelm
parents: 38662
diff changeset
    47
    def is_singularity: Boolean = start == stop
38662
4d4553e09337 Text.Range.is_singleton;
wenzelm
parents: 38578
diff changeset
    48
38565
32b924a832c4 further clarification/unification of Position.Range and Text.Range concerning singularities: start offset is always included;
wenzelm
parents: 38564
diff changeset
    49
    def contains(i: Offset): Boolean = start == i || start < i && i < stop
32b924a832c4 further clarification/unification of Position.Range and Text.Range concerning singularities: start offset is always included;
wenzelm
parents: 38564
diff changeset
    50
    def contains(that: Range): Boolean = this.contains(that.start) && that.stop <= this.stop
32b924a832c4 further clarification/unification of Position.Range and Text.Range concerning singularities: start offset is always included;
wenzelm
parents: 38564
diff changeset
    51
    def overlaps(that: Range): Boolean = this.contains(that.start) || that.contains(this.start)
32b924a832c4 further clarification/unification of Position.Range and Text.Range concerning singularities: start offset is always included;
wenzelm
parents: 38564
diff changeset
    52
    def compare(that: Range): Int = if (overlaps(that)) 0 else this.start compare that.start
38485
c5eae9fc1fa4 Text.Range: improved handling of singularities;
wenzelm
parents: 38477
diff changeset
    53
38564
a6e2715fac5f parameterized type Markup_Tree.Node;
wenzelm
parents: 38563
diff changeset
    54
    def restrict(that: Range): Range =
38485
c5eae9fc1fa4 Text.Range: improved handling of singularities;
wenzelm
parents: 38477
diff changeset
    55
      Range(this.start max that.start, this.stop min that.stop)
43428
b41dea5772c6 more robust treatment of partial range restriction;
wenzelm
parents: 43425
diff changeset
    56
b41dea5772c6 more robust treatment of partial range restriction;
wenzelm
parents: 43425
diff changeset
    57
    def try_restrict(that: Range): Option[Range] =
b41dea5772c6 more robust treatment of partial range restriction;
wenzelm
parents: 43425
diff changeset
    58
      try { Some (restrict(that)) }
43650
f00da558b78e imitate exception ERROR of Isabelle/ML;
wenzelm
parents: 43428
diff changeset
    59
      catch { case ERROR(_) => None }
38427
7066fbd315ae some derived operations on Text.Range;
wenzelm
parents: 38426
diff changeset
    60
  }
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    61
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    62
44379
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    63
  /* perspective */
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    64
44473
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    65
  object Perspective
44379
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    66
  {
44473
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    67
    val empty = Perspective(Nil)
44379
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    68
44473
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    69
    def apply(ranges: Seq[Range]): Perspective =
44379
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    70
    {
44473
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    71
      val sorted_ranges = ranges.toArray
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    72
      Sorting.quickSort(sorted_ranges)(Range.Ordering)
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    73
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    74
      val result = new mutable.ListBuffer[Text.Range]
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    75
      var last: Option[Text.Range] = None
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    76
      for (range <- sorted_ranges)
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    77
      {
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    78
        last match {
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    79
          case Some(last_range)
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    80
          if ((last_range overlaps range) || last_range.stop == range.start) =>
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    81
            last = Some(Text.Range(last_range.start, range.stop))
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    82
          case _ =>
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    83
            result ++= last
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    84
            last = Some(range)
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    85
        }
44379
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    86
      }
44473
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    87
      result ++= last
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    88
      new Perspective(result.toList)
44379
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    89
    }
44473
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    90
  }
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    91
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    92
  sealed case class Perspective(ranges: List[Range]) // visible text partitioning in canonical order
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    93
  {
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    94
    def is_empty: Boolean = ranges.isEmpty
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    95
    def range: Range =
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    96
      if (is_empty) Range(0)
4f264fdf8d0e slightly more abstract Text.Perspective;
wenzelm
parents: 44384
diff changeset
    97
      else Range(ranges.head.start, ranges.last.stop)
44379
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    98
  }
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
    99
1079ab6b342b added official Text.Range.Ordering;
wenzelm
parents: 43714
diff changeset
   100
38577
4e4d3ea3725a renamed Markup_Tree.Node to Text.Info;
wenzelm
parents: 38570
diff changeset
   101
  /* information associated with text range */
4e4d3ea3725a renamed Markup_Tree.Node to Text.Info;
wenzelm
parents: 38570
diff changeset
   102
43714
3749d1e6dde9 tuned signature;
wenzelm
parents: 43650
diff changeset
   103
  sealed case class Info[A](val range: Text.Range, val info: A)
38577
4e4d3ea3725a renamed Markup_Tree.Node to Text.Info;
wenzelm
parents: 38570
diff changeset
   104
  {
4e4d3ea3725a renamed Markup_Tree.Node to Text.Info;
wenzelm
parents: 38570
diff changeset
   105
    def restrict(r: Text.Range): Info[A] = Info(range.restrict(r), info)
43428
b41dea5772c6 more robust treatment of partial range restriction;
wenzelm
parents: 43425
diff changeset
   106
    def try_restrict(r: Text.Range): Option[Info[A]] =
b41dea5772c6 more robust treatment of partial range restriction;
wenzelm
parents: 43425
diff changeset
   107
      try { Some(Info(range.restrict(r), info)) }
43650
f00da558b78e imitate exception ERROR of Isabelle/ML;
wenzelm
parents: 43428
diff changeset
   108
      catch { case ERROR(_) => None }
38577
4e4d3ea3725a renamed Markup_Tree.Node to Text.Info;
wenzelm
parents: 38570
diff changeset
   109
  }
4e4d3ea3725a renamed Markup_Tree.Node to Text.Info;
wenzelm
parents: 38570
diff changeset
   110
4e4d3ea3725a renamed Markup_Tree.Node to Text.Info;
wenzelm
parents: 38570
diff changeset
   111
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   112
  /* editing */
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
   113
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   114
  object Edit
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   115
  {
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   116
    def insert(start: Offset, text: String): Edit = new Edit(true, start, text)
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   117
    def remove(start: Offset, text: String): Edit = new Edit(false, start, text)
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   118
  }
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
   119
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   120
  class Edit(val is_insert: Boolean, val start: Offset, val text: String)
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   121
  {
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   122
    override def toString =
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   123
      (if (is_insert) "Insert(" else "Remove(") + (start, text).toString + ")"
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
   124
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
   125
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   126
    /* transform offsets */
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
   127
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   128
    private def transform(do_insert: Boolean, i: Offset): Offset =
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   129
      if (i < start) i
43425
0a5612040a8b more explicit error message;
wenzelm
parents: 38725
diff changeset
   130
      else if (do_insert) i + text.length
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   131
      else (i - text.length) max start
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
   132
43425
0a5612040a8b more explicit error message;
wenzelm
parents: 38725
diff changeset
   133
    def convert(i: Offset): Offset = transform(is_insert, i)
0a5612040a8b more explicit error message;
wenzelm
parents: 38725
diff changeset
   134
    def revert(i: Offset): Offset = transform(!is_insert, i)
0a5612040a8b more explicit error message;
wenzelm
parents: 38725
diff changeset
   135
    def convert(range: Range): Range = range.map(convert)
0a5612040a8b more explicit error message;
wenzelm
parents: 38725
diff changeset
   136
    def revert(range: Range): Range = range.map(revert)
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   137
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
   138
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   139
    /* edit strings */
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   140
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   141
    private def insert(i: Offset, string: String): String =
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   142
      string.substring(0, i) + text + string.substring(i)
34276
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
   143
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   144
    private def remove(i: Offset, count: Int, string: String): String =
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   145
      string.substring(0, i) + string.substring(i + count)
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   146
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   147
    def can_edit(string: String, shift: Int): Boolean =
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   148
      shift <= start && start < shift + string.length
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   149
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   150
    def edit(string: String, shift: Int): (Option[Edit], String) =
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   151
      if (!can_edit(string, shift)) (Some(this), string)
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   152
      else if (is_insert) (None, insert(start - shift, string))
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   153
      else {
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   154
        val i = start - shift
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   155
        val count = text.length min (string.length - i)
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   156
        val rest =
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   157
          if (count == text.length) None
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   158
          else Some(Edit.remove(start, text.substring(count)))
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
   159
        (rest, remove(i, count, string))
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   160
      }
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
   161
  }
34276
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
   162
}