src/Pure/Thy/completion.scala
author wenzelm
Wed, 28 Aug 2013 22:25:14 +0200
changeset 53251 7facc08da806
parent 46712 8650d9a95736
child 53275 b34aac6511ab
permissions -rw-r--r--
complete symbols only in backslash forms -- less intrusive editing, greater chance of finding escape sequence in text; complete words >= 3 characters only; discontinued short word abbrev "Un" (see also fdd6e68e29d9 and e38e80686ce5);
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/Thy/completion.scala
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
     3
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
     4
Completion of symbols and keywords.
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
     5
*/
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
     6
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
     7
package isabelle
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
     8
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
     9
import scala.util.matching.Regex
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    10
import scala.util.parsing.combinator.RegexParsers
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    11
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    12
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    13
object Completion
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    14
{
46625
wenzelm
parents: 46624
diff changeset
    15
  val empty: Completion = new Completion()
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    16
  def init(): Completion = empty.add_symbols()
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    17
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    18
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    19
  /** word completion **/
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    20
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    21
  private val word_regex = "[a-zA-Z0-9_']+".r
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    22
  private def is_word(s: CharSequence): Boolean = word_regex.pattern.matcher(s).matches
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    23
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    24
  private object Parse extends RegexParsers
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    25
  {
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    26
    override val whiteSpace = "".r
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    27
43462
7f65a68f8b26 completion for control symbols;
wenzelm
parents: 40533
diff changeset
    28
    def reverse_symbol: Parser[String] = """>[A-Za-z0-9_']+\^?<\\""".r
7f65a68f8b26 completion for control symbols;
wenzelm
parents: 40533
diff changeset
    29
    def reverse_symb: Parser[String] = """[A-Za-z0-9_']{2,}\^?<\\""".r
53251
7facc08da806 complete symbols only in backslash forms -- less intrusive editing, greater chance of finding escape sequence in text;
wenzelm
parents: 46712
diff changeset
    30
    def escape: Parser[String] = """[a-zA-Z0-9_']+\\""".r
7facc08da806 complete symbols only in backslash forms -- less intrusive editing, greater chance of finding escape sequence in text;
wenzelm
parents: 46712
diff changeset
    31
    def word: Parser[String] = """[a-zA-Z0-9_']{3,}""".r
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    32
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    33
    def read(in: CharSequence): Option[String] =
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    34
    {
37072
9105c8237c7a renamed "rev" to "reverse" following usual Scala conventions;
wenzelm
parents: 36012
diff changeset
    35
      val reverse_in = new Library.Reverse(in)
53251
7facc08da806 complete symbols only in backslash forms -- less intrusive editing, greater chance of finding escape sequence in text;
wenzelm
parents: 46712
diff changeset
    36
      parse((reverse_symbol | reverse_symb | escape | word) ^^ (_.reverse), reverse_in) match {
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    37
        case Success(result, _) => Some(result)
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    38
        case _ => None
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    39
      }
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    40
    }
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    41
  }
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    42
}
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    43
46712
8650d9a95736 prefer final ADTs -- prevent ooddities;
wenzelm
parents: 46625
diff changeset
    44
final class Completion private(
46625
wenzelm
parents: 46624
diff changeset
    45
  words_lex: Scan.Lexicon = Scan.Lexicon.empty,
wenzelm
parents: 46624
diff changeset
    46
  words_map: Map[String, String] = Map.empty,
wenzelm
parents: 46624
diff changeset
    47
  abbrevs_lex: Scan.Lexicon = Scan.Lexicon.empty,
wenzelm
parents: 46624
diff changeset
    48
  abbrevs_map: Map[String, (String, String)] = Map.empty)
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    49
{
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    50
  /* adding stuff */
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    51
40533
e38e80686ce5 somewhat adhoc replacement for 'thus' and 'hence';
wenzelm
parents: 37072
diff changeset
    52
  def + (keyword: String, replace: String): Completion =
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    53
    new Completion(
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    54
      words_lex + keyword,
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    55
      words_map + (keyword -> replace),
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    56
      abbrevs_lex,
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    57
      abbrevs_map)
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    58
40533
e38e80686ce5 somewhat adhoc replacement for 'thus' and 'hence';
wenzelm
parents: 37072
diff changeset
    59
  def + (keyword: String): Completion = this + (keyword, keyword)
e38e80686ce5 somewhat adhoc replacement for 'thus' and 'hence';
wenzelm
parents: 37072
diff changeset
    60
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    61
  private def add_symbols(): Completion =
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    62
  {
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    63
    val words =
43695
5130dfe1b7be simplified Symbol based on lazy Symbol.Interpretation -- reduced odd "functorial style";
wenzelm
parents: 43462
diff changeset
    64
      (for ((x, _) <- Symbol.names) yield (x, x)).toList :::
53251
7facc08da806 complete symbols only in backslash forms -- less intrusive editing, greater chance of finding escape sequence in text;
wenzelm
parents: 46712
diff changeset
    65
      (for ((x, y) <- Symbol.names) yield ("\\" + y, x)).toList :::
43695
5130dfe1b7be simplified Symbol based on lazy Symbol.Interpretation -- reduced odd "functorial style";
wenzelm
parents: 43462
diff changeset
    66
      (for ((x, y) <- Symbol.abbrevs if Completion.is_word(y)) yield (y, x)).toList
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    67
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    68
    val abbrs =
43695
5130dfe1b7be simplified Symbol based on lazy Symbol.Interpretation -- reduced odd "functorial style";
wenzelm
parents: 43462
diff changeset
    69
      (for ((x, y) <- Symbol.abbrevs if !Completion.is_word(y))
31765
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
    70
        yield (y.reverse.toString, (y, x))).toList
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    71
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    72
    new Completion(
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    73
      words_lex ++ words.map(_._1),
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    74
      words_map ++ words,
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    75
      abbrevs_lex ++ abbrs.map(_._1),
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    76
      abbrevs_map ++ abbrs)
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    77
  }
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    78
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    79
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    80
  /* complete */
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    81
31765
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
    82
  def complete(line: CharSequence): Option[(String, List[String])] =
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    83
  {
34141
297b2149077d simiplified result of keyword parser (again);
wenzelm
parents: 34135
diff changeset
    84
    abbrevs_lex.parse(abbrevs_lex.keyword, new Library.Reverse(line)) match {
37072
9105c8237c7a renamed "rev" to "reverse" following usual Scala conventions;
wenzelm
parents: 36012
diff changeset
    85
      case abbrevs_lex.Success(reverse_a, _) =>
9105c8237c7a renamed "rev" to "reverse" following usual Scala conventions;
wenzelm
parents: 36012
diff changeset
    86
        val (word, c) = abbrevs_map(reverse_a)
35004
b89a31957950 filter out identical completions only after symbols.decode -- recover completion of literal symbols (e.g. \<AA>);
wenzelm
parents: 34141
diff changeset
    87
        Some(word, List(c))
31765
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
    88
      case _ =>
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
    89
        Completion.Parse.read(line) match {
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
    90
          case Some(word) =>
35004
b89a31957950 filter out identical completions only after symbols.decode -- recover completion of literal symbols (e.g. \<AA>);
wenzelm
parents: 34141
diff changeset
    91
            words_lex.completions(word).map(words_map(_)) match {
31765
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
    92
              case Nil => None
45900
793bf5fa5fbf prefer sorting from Scala library;
wenzelm
parents: 43695
diff changeset
    93
              case cs => Some(word, cs.sorted)
31765
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
    94
            }
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
    95
          case None => None
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
    96
        }
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
    97
    }
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    98
  }
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    99
}