src/Pure/Isar/completion.scala
author traytel
Thu, 29 Aug 2013 23:21:48 +0200
changeset 53300 e414487da3f8
parent 53279 763d35697338
child 53295 45be26b98ca6
permissions -rw-r--r--
qualify internal and external constants in {l,g}fp properly
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
53279
763d35697338 clarified module location;
wenzelm
parents: 53275
diff changeset
     1
/*  Title:      Pure/Isar/completion.scala
31763
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.parsing.combinator.RegexParsers
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    10
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    11
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    12
object Completion
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    13
{
53275
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    14
  /* items */
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    15
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    16
  sealed case class Item(original: String, replacement: String, description: String)
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    17
  { override def toString: String = description }
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    18
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    19
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    20
  /* init */
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    21
46625
wenzelm
parents: 46624
diff changeset
    22
  val empty: Completion = new Completion()
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    23
  def init(): Completion = empty.add_symbols()
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    24
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    25
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    26
  /** word completion **/
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    27
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    28
  private val word_regex = "[a-zA-Z0-9_']+".r
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    29
  private def is_word(s: CharSequence): Boolean = word_regex.pattern.matcher(s).matches
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    30
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    31
  private object Parse extends RegexParsers
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    32
  {
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    33
    override val whiteSpace = "".r
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    34
43462
7f65a68f8b26 completion for control symbols;
wenzelm
parents: 40533
diff changeset
    35
    def reverse_symbol: Parser[String] = """>[A-Za-z0-9_']+\^?<\\""".r
7f65a68f8b26 completion for control symbols;
wenzelm
parents: 40533
diff changeset
    36
    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
    37
    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
    38
    def word: Parser[String] = """[a-zA-Z0-9_']{3,}""".r
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    39
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    40
    def read(in: CharSequence): Option[String] =
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    41
    {
37072
9105c8237c7a renamed "rev" to "reverse" following usual Scala conventions;
wenzelm
parents: 36012
diff changeset
    42
      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
    43
      parse((reverse_symbol | reverse_symb | escape | word) ^^ (_.reverse), reverse_in) match {
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    44
        case Success(result, _) => Some(result)
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    45
        case _ => None
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    46
      }
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    47
    }
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    48
  }
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    49
}
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    50
46712
8650d9a95736 prefer final ADTs -- prevent ooddities;
wenzelm
parents: 46625
diff changeset
    51
final class Completion private(
46625
wenzelm
parents: 46624
diff changeset
    52
  words_lex: Scan.Lexicon = Scan.Lexicon.empty,
wenzelm
parents: 46624
diff changeset
    53
  words_map: Map[String, String] = Map.empty,
wenzelm
parents: 46624
diff changeset
    54
  abbrevs_lex: Scan.Lexicon = Scan.Lexicon.empty,
wenzelm
parents: 46624
diff changeset
    55
  abbrevs_map: Map[String, (String, String)] = Map.empty)
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    56
{
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    57
  /* adding stuff */
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, replace: String): Completion =
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    60
    new Completion(
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    61
      words_lex + keyword,
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    62
      words_map + (keyword -> replace),
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    63
      abbrevs_lex,
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    64
      abbrevs_map)
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    65
40533
e38e80686ce5 somewhat adhoc replacement for 'thus' and 'hence';
wenzelm
parents: 37072
diff changeset
    66
  def + (keyword: String): Completion = this + (keyword, keyword)
e38e80686ce5 somewhat adhoc replacement for 'thus' and 'hence';
wenzelm
parents: 37072
diff changeset
    67
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    68
  private def add_symbols(): Completion =
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    69
  {
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    70
    val words =
43695
5130dfe1b7be simplified Symbol based on lazy Symbol.Interpretation -- reduced odd "functorial style";
wenzelm
parents: 43462
diff changeset
    71
      (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
    72
      (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
    73
      (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
    74
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    75
    val abbrs =
43695
5130dfe1b7be simplified Symbol based on lazy Symbol.Interpretation -- reduced odd "functorial style";
wenzelm
parents: 43462
diff changeset
    76
      (for ((x, y) <- Symbol.abbrevs if !Completion.is_word(y))
31765
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
    77
        yield (y.reverse.toString, (y, x))).toList
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    78
46624
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    79
    new Completion(
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    80
      words_lex ++ words.map(_._1),
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    81
      words_map ++ words,
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    82
      abbrevs_lex ++ abbrs.map(_._1),
dc4c72092088 streamlined abstract datatype;
wenzelm
parents: 45900
diff changeset
    83
      abbrevs_map ++ abbrs)
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    84
  }
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    85
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    86
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    87
  /* complete */
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    88
53275
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    89
  def complete(decode: Boolean, line: CharSequence): Option[(String, List[Completion.Item])] =
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
    90
  {
53275
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    91
    val raw_result =
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    92
      abbrevs_lex.parse(abbrevs_lex.keyword, new Library.Reverse(line)) match {
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    93
        case abbrevs_lex.Success(reverse_a, _) =>
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    94
          val (word, c) = abbrevs_map(reverse_a)
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    95
          Some(word, List(c))
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    96
        case _ =>
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    97
          Completion.Parse.read(line) match {
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    98
            case Some(word) =>
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
    99
              words_lex.completions(word).map(words_map(_)) match {
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   100
                case Nil => None
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   101
                case cs => Some(word, cs.sorted)
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   102
              }
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   103
            case None => None
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   104
          }
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   105
      }
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   106
    raw_result match {
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   107
      case Some((word, cs)) =>
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   108
        val ds = (if (decode) cs.map(Symbol.decode(_)).sorted else cs).filter(_ != word)
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   109
        if (ds.isEmpty) None
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   110
        else Some((word, ds.map(s => Completion.Item(word, s, s))))
b34aac6511ab tuned signature;
wenzelm
parents: 53251
diff changeset
   111
      case None => None
31765
a5fdf7a76f9d tuned input: require longer symbol prefix;
wenzelm
parents: 31763
diff changeset
   112
    }
31763
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
   113
  }
c2c2d380729d Completion of symbols and keywords.
wenzelm
parents:
diff changeset
   114
}