src/Pure/PIDE/text.scala
author wenzelm
Fri, 20 Aug 2010 11:00:15 +0200
changeset 38565 32b924a832c4
parent 38564 a6e2715fac5f
child 38568 f117ba49a59c
permissions -rw-r--r--
further clarification/unification of Position.Range and Text.Range concerning singularities: start offset is always included;
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
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    11
object Text
34276
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
    12
{
38477
f01f4ab2a0af refined notion of Text.Range;
wenzelm
parents: 38427
diff changeset
    13
  /* offset */
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    14
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    15
  type Offset = Int
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    16
38477
f01f4ab2a0af refined notion of Text.Range;
wenzelm
parents: 38427
diff changeset
    17
38565
32b924a832c4 further clarification/unification of Position.Range and Text.Range concerning singularities: start offset is always included;
wenzelm
parents: 38564
diff changeset
    18
  /* range -- with total quasi-ordering */
38477
f01f4ab2a0af refined notion of Text.Range;
wenzelm
parents: 38427
diff changeset
    19
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    20
  sealed case class Range(val start: Offset, val stop: Offset)
38427
7066fbd315ae some derived operations on Text.Range;
wenzelm
parents: 38426
diff changeset
    21
  {
38565
32b924a832c4 further clarification/unification of Position.Range and Text.Range concerning singularities: start offset is always included;
wenzelm
parents: 38564
diff changeset
    22
    // denotation: {start} Un {i. start < i & i < stop}
38477
f01f4ab2a0af refined notion of Text.Range;
wenzelm
parents: 38427
diff changeset
    23
    require(start <= stop)
f01f4ab2a0af refined notion of Text.Range;
wenzelm
parents: 38427
diff changeset
    24
38563
f6c9a4f9f66f added toString methods;
wenzelm
parents: 38562
diff changeset
    25
    override def toString = "[" + start.toString + ":" + stop.toString + "]"
f6c9a4f9f66f added toString methods;
wenzelm
parents: 38562
diff changeset
    26
38427
7066fbd315ae some derived operations on Text.Range;
wenzelm
parents: 38426
diff changeset
    27
    def map(f: Offset => Offset): Range = Range(f(start), f(stop))
7066fbd315ae some derived operations on Text.Range;
wenzelm
parents: 38426
diff changeset
    28
    def +(i: Offset): Range = map(_ + i)
38565
32b924a832c4 further clarification/unification of Position.Range and Text.Range concerning singularities: start offset is always included;
wenzelm
parents: 38564
diff changeset
    29
    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
    30
    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
    31
    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
    32
    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
    33
c5eae9fc1fa4 Text.Range: improved handling of singularities;
wenzelm
parents: 38477
diff changeset
    34
    def start_range: Range = Range(start, start)
c5eae9fc1fa4 Text.Range: improved handling of singularities;
wenzelm
parents: 38477
diff changeset
    35
    def stop_range: Range = Range(stop, stop)
c5eae9fc1fa4 Text.Range: improved handling of singularities;
wenzelm
parents: 38477
diff changeset
    36
38564
a6e2715fac5f parameterized type Markup_Tree.Node;
wenzelm
parents: 38563
diff changeset
    37
    def restrict(that: Range): Range =
38485
c5eae9fc1fa4 Text.Range: improved handling of singularities;
wenzelm
parents: 38477
diff changeset
    38
      Range(this.start max that.start, this.stop min that.stop)
38427
7066fbd315ae some derived operations on Text.Range;
wenzelm
parents: 38426
diff changeset
    39
  }
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    40
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    41
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    42
  /* editing */
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
    43
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    44
  object Edit
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    45
  {
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    46
    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
    47
    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
    48
  }
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
    49
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    50
  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
    51
  {
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    52
    override def toString =
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    53
      (if (is_insert) "Insert(" else "Remove(") + (start, text).toString + ")"
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
    54
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
    55
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    56
    /* transform offsets */
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
    57
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    58
    private def transform(do_insert: Boolean, i: Offset): Offset =
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    59
      if (i < start) i
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    60
      else if (is_insert == do_insert) i + text.length
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    61
      else (i - text.length) max start
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
    62
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    63
    def convert(i: Offset): Offset = transform(true, i)
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    64
    def revert(i: Offset): Offset = transform(false, i)
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    65
34286
951aa92d06bb more text edit operations;
wenzelm
parents: 34276
diff changeset
    66
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    67
    /* edit strings */
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    68
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    69
    private def insert(i: Offset, string: String): String =
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    70
      string.substring(0, i) + text + string.substring(i)
34276
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
    71
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    72
    private def remove(i: Offset, count: Int, string: String): String =
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    73
      string.substring(0, i) + string.substring(i + count)
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    74
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    75
    def can_edit(string: String, shift: Int): Boolean =
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    76
      shift <= start && start < shift + string.length
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    77
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    78
    def edit(string: String, shift: Int): (Option[Edit], String) =
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    79
      if (!can_edit(string, shift)) (Some(this), string)
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    80
      else if (is_insert) (None, insert(start - shift, string))
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    81
      else {
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    82
        val i = start - shift
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    83
        val count = text.length min (string.length - i)
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    84
        val rest =
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    85
          if (count == text.length) None
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    86
          else Some(Edit.remove(start, text.substring(count)))
38426
2858ec7b6dd8 specific types Text.Offset and Text.Range;
wenzelm
parents: 38425
diff changeset
    87
        (rest, remove(i, count, string))
38425
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    88
      }
e467db701d78 moved Text_Edit to Text.Edit;
wenzelm
parents: 38154
diff changeset
    89
  }
34276
12436485c244 Basic edits on plain text.
wenzelm
parents:
diff changeset
    90
}