src/Tools/jEdit/src/structure_matching.scala
author wenzelm
Mon, 01 Dec 2014 17:43:23 +0100
changeset 59074 7836d927ffca
parent 58901 47809a811eba
child 59122 c1dbcde94cd2
permissions -rw-r--r--
tuned signature;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
58748
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
     1
/*  Title:      Tools/jEdit/src/structure_matching.scala
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
     3
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
     4
Structure matcher for Isabelle/Isar outer syntax.
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
     5
*/
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
     6
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
     7
package isabelle.jedit
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
     8
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
     9
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    10
import isabelle._
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    11
58803
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
    12
import org.gjt.sp.jedit.textarea.{TextArea, StructureMatcher, Selection}
58748
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    13
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    14
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    15
object Structure_Matching
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    16
{
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    17
  object Isabelle_Matcher extends StructureMatcher
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    18
  {
58803
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
    19
    private def find_block(
58752
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    20
      open: Token => Boolean,
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    21
      close: Token => Boolean,
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    22
      reset: Token => Boolean,
58762
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
    23
      restrict: Token => Boolean,
58754
wenzelm
parents: 58752
diff changeset
    24
      it: Iterator[Text.Info[Token]]): Option[(Text.Range, Text.Range)] =
58752
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    25
    {
58754
wenzelm
parents: 58752
diff changeset
    26
      val range1 = it.next.range
58762
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
    27
      it.takeWhile(info => !info.info.is_command || restrict(info.info)).
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
    28
        scanLeft((range1, 1))(
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
    29
          { case ((r, d), Text.Info(range, tok)) =>
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
    30
              if (open(tok)) (range, d + 1)
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
    31
              else if (close(tok)) (range, d - 1)
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
    32
              else if (reset(tok)) (range, 0)
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
    33
              else (r, d) }
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
    34
        ).collectFirst({ case (range2, 0) => (range1, range2) })
58752
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    35
    }
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    36
58803
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
    37
    private def find_pair(text_area: TextArea): Option[(Text.Range, Text.Range)] =
58748
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    38
    {
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    39
      val buffer = text_area.getBuffer
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    40
      val caret_line = text_area.getCaretLine
58749
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
    41
      val caret = text_area.getCaretPosition
58748
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
    42
59074
7836d927ffca tuned signature;
wenzelm
parents: 58901
diff changeset
    43
      Isabelle.buffer_syntax(text_area.getBuffer) match {
58803
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
    44
        case Some(syntax) =>
58750
1b4b005d73c1 added option jedit_structure_limit;
wenzelm
parents: 58749
diff changeset
    45
          val limit = PIDE.options.value.int("jedit_structure_limit") max 0
1b4b005d73c1 added option jedit_structure_limit;
wenzelm
parents: 58749
diff changeset
    46
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    47
          def is_command_kind(token: Token, pred: String => Boolean): Boolean =
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    48
            syntax.keywords.is_command_kind(token, pred)
58900
1435cc20b022 explicit type Keyword.Keywords;
wenzelm
parents: 58804
diff changeset
    49
58750
1b4b005d73c1 added option jedit_structure_limit;
wenzelm
parents: 58749
diff changeset
    50
          def iterator(line: Int, lim: Int = limit): Iterator[Text.Info[Token]] =
58756
eb5d0c58564d ignore improper tokens to avoid ambiguity of Range.touches (assuming that relevant tokens are separated properly);
wenzelm
parents: 58755
diff changeset
    51
            Token_Markup.line_token_iterator(syntax, buffer, line, line + lim).
eb5d0c58564d ignore improper tokens to avoid ambiguity of Range.touches (assuming that relevant tokens are separated properly);
wenzelm
parents: 58755
diff changeset
    52
              filter(_.info.is_proper)
58750
1b4b005d73c1 added option jedit_structure_limit;
wenzelm
parents: 58749
diff changeset
    53
1b4b005d73c1 added option jedit_structure_limit;
wenzelm
parents: 58749
diff changeset
    54
          def rev_iterator(line: Int, lim: Int = limit): Iterator[Text.Info[Token]] =
58756
eb5d0c58564d ignore improper tokens to avoid ambiguity of Range.touches (assuming that relevant tokens are separated properly);
wenzelm
parents: 58755
diff changeset
    55
            Token_Markup.line_token_reverse_iterator(syntax, buffer, line, line - lim).
eb5d0c58564d ignore improper tokens to avoid ambiguity of Range.touches (assuming that relevant tokens are separated properly);
wenzelm
parents: 58755
diff changeset
    56
              filter(_.info.is_proper)
58750
1b4b005d73c1 added option jedit_structure_limit;
wenzelm
parents: 58749
diff changeset
    57
58752
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    58
          def caret_iterator(): Iterator[Text.Info[Token]] =
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    59
            iterator(caret_line).dropWhile(info => !info.range.touches(caret))
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    60
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    61
          def rev_caret_iterator(): Iterator[Text.Info[Token]] =
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    62
            rev_iterator(caret_line).dropWhile(info => !info.range.touches(caret))
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    63
58756
eb5d0c58564d ignore improper tokens to avoid ambiguity of Range.touches (assuming that relevant tokens are separated properly);
wenzelm
parents: 58755
diff changeset
    64
          iterator(caret_line, 1).find(info => info.range.touches(caret))
eb5d0c58564d ignore improper tokens to avoid ambiguity of Range.touches (assuming that relevant tokens are separated properly);
wenzelm
parents: 58755
diff changeset
    65
          match {
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    66
            case Some(Text.Info(range1, tok)) if is_command_kind(tok, Keyword.theory_goal) =>
58755
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
    67
              find_block(
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    68
                is_command_kind(_, Keyword.proof_goal),
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    69
                is_command_kind(_, Keyword.qed),
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    70
                is_command_kind(_, Keyword.qed_global),
58762
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
    71
                t =>
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    72
                  is_command_kind(t, Keyword.diag) ||
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    73
                  is_command_kind(t, Keyword.proof),
58755
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
    74
                caret_iterator())
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
    75
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    76
            case Some(Text.Info(range1, tok)) if is_command_kind(tok, Keyword.proof_goal) =>
58755
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
    77
              find_block(
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    78
                is_command_kind(_, Keyword.proof_goal),
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    79
                is_command_kind(_, Keyword.qed),
58755
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
    80
                _ => false,
58762
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
    81
                t =>
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    82
                  is_command_kind(t, Keyword.diag) ||
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    83
                  is_command_kind(t, Keyword.proof),
58755
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
    84
                caret_iterator())
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
    85
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    86
            case Some(Text.Info(range1, tok)) if is_command_kind(tok, Keyword.qed_global) =>
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    87
              rev_caret_iterator().find(info => is_command_kind(info.info, Keyword.theory))
58749
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
    88
              match {
58750
1b4b005d73c1 added option jedit_structure_limit;
wenzelm
parents: 58749
diff changeset
    89
                case Some(Text.Info(range2, tok))
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    90
                if is_command_kind(tok, Keyword.theory_goal) => Some((range1, range2))
58749
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
    91
                case _ => None
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
    92
              }
58752
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
    93
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    94
            case Some(Text.Info(range1, tok)) if is_command_kind(tok, Keyword.qed) =>
58755
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
    95
              find_block(
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    96
                is_command_kind(_, Keyword.qed),
58755
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
    97
                t =>
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    98
                  is_command_kind(t, Keyword.proof_goal) ||
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
    99
                  is_command_kind(t, Keyword.theory_goal),
58755
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
   100
                _ => false,
58762
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
   101
                t =>
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
   102
                  is_command_kind(t, Keyword.diag) ||
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
   103
                  is_command_kind(t, Keyword.proof) ||
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
   104
                  is_command_kind(t, Keyword.theory_goal),
58755
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
   105
                rev_caret_iterator())
fc822ca2428a support for proof structure matching;
wenzelm
parents: 58754
diff changeset
   106
58752
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
   107
            case Some(Text.Info(range1, tok)) if tok.is_begin =>
58762
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
   108
              find_block(_.is_begin, _.is_end, _ => false, _ => true, caret_iterator())
58752
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
   109
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
   110
            case Some(Text.Info(range1, tok)) if tok.is_end =>
58762
4fedc5d4b2fe restricted scanning;
wenzelm
parents: 58756
diff changeset
   111
              find_block(_.is_end, _.is_begin, _ => false, _ => true, rev_caret_iterator())
58763
1b943a82d5ed find main command keyword of 'begin';
wenzelm
parents: 58762
diff changeset
   112
              match {
1b943a82d5ed find main command keyword of 'begin';
wenzelm
parents: 58762
diff changeset
   113
                case Some((_, range2)) =>
58800
bfed1c26caed explicit keyword category for commands that may start a block;
wenzelm
parents: 58763
diff changeset
   114
                  rev_caret_iterator().
bfed1c26caed explicit keyword category for commands that may start a block;
wenzelm
parents: 58763
diff changeset
   115
                    dropWhile(info => info.range != range2).
bfed1c26caed explicit keyword category for commands that may start a block;
wenzelm
parents: 58763
diff changeset
   116
                    dropWhile(info => info.range == range2).
bfed1c26caed explicit keyword category for commands that may start a block;
wenzelm
parents: 58763
diff changeset
   117
                    find(info => info.info.is_command || info.info.is_begin)
58763
1b943a82d5ed find main command keyword of 'begin';
wenzelm
parents: 58762
diff changeset
   118
                  match {
58800
bfed1c26caed explicit keyword category for commands that may start a block;
wenzelm
parents: 58763
diff changeset
   119
                    case Some(Text.Info(range3, tok)) =>
58901
47809a811eba clarified representation of type Keywords;
wenzelm
parents: 58900
diff changeset
   120
                      if (is_command_kind(tok, Keyword.theory_block)) Some((range1, range3))
58800
bfed1c26caed explicit keyword category for commands that may start a block;
wenzelm
parents: 58763
diff changeset
   121
                      else Some((range1, range2))
58763
1b943a82d5ed find main command keyword of 'begin';
wenzelm
parents: 58762
diff changeset
   122
                    case None => None
1b943a82d5ed find main command keyword of 'begin';
wenzelm
parents: 58762
diff changeset
   123
                  }
1b943a82d5ed find main command keyword of 'begin';
wenzelm
parents: 58762
diff changeset
   124
                case None => None
1b943a82d5ed find main command keyword of 'begin';
wenzelm
parents: 58762
diff changeset
   125
              }
58752
2077bc9558cf support for begin/end matching;
wenzelm
parents: 58750
diff changeset
   126
58749
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
   127
            case _ => None
58748
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
   128
          }
58803
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   129
        case None => None
58748
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
   130
      }
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
   131
    }
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
   132
58749
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
   133
    def getMatch(text_area: TextArea): StructureMatcher.Match =
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
   134
      find_pair(text_area) match {
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
   135
        case Some((_, range)) =>
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
   136
          val line = text_area.getBuffer.getLineOfOffset(range.start)
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
   137
          new StructureMatcher.Match(Structure_Matching.Isabelle_Matcher,
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
   138
            line, range.start, line, range.stop)
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
   139
        case None => null
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
   140
      }
83b0f633190e some structure matching, based on line token iterators;
wenzelm
parents: 58748
diff changeset
   141
58748
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
   142
    def selectMatch(text_area: TextArea)
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
   143
    {
58803
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   144
      def get_span(offset: Text.Offset): Option[Text.Range] =
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   145
        for {
59074
7836d927ffca tuned signature;
wenzelm
parents: 58901
diff changeset
   146
          syntax <- Isabelle.buffer_syntax(text_area.getBuffer)
58803
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   147
          span <- Token_Markup.command_span(syntax, text_area.getBuffer, offset)
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   148
        } yield span.range
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   149
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   150
      find_pair(text_area) match {
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   151
        case Some((r1, r2)) =>
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   152
          (get_span(r1.start), get_span(r2.start)) match {
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   153
            case (Some(range1), Some(range2)) =>
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   154
              val start = range1.start min range2.start
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   155
              val stop = range1.stop max range2.stop
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   156
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   157
              text_area.moveCaretPosition(stop, false)
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   158
              if (!text_area.isMultipleSelectionEnabled) text_area.selectNone
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   159
              text_area.addToSelection(new Selection.Range(start, stop))
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   160
            case _ =>
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   161
          }
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   162
        case None =>
7a0f675eb671 proper selectMatch, e.g. relevant for S-click on gutter;
wenzelm
parents: 58800
diff changeset
   163
      }
58748
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
   164
    }
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
   165
  }
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
   166
}
8f92f17d8781 support for structure matching;
wenzelm
parents:
diff changeset
   167