src/Pure/Isar/outer_syntax.scala
author wenzelm
Wed Jul 20 16:02:00 2016 +0200 (2016-07-20)
changeset 63528 0f39f59317c1
parent 63479 464ef556bd21
child 63579 73939a9b70a3
permissions -rw-r--r--
completion templates for commands involving "begin ... end" blocks;
wenzelm@34166
     1
/*  Title:      Pure/Isar/outer_syntax.scala
wenzelm@34166
     2
    Author:     Makarius
wenzelm@34166
     3
wenzelm@34166
     4
Isabelle/Isar outer syntax.
wenzelm@34166
     5
*/
wenzelm@34166
     6
wenzelm@34166
     7
package isabelle
wenzelm@34166
     8
wenzelm@34166
     9
wenzelm@43411
    10
import scala.collection.mutable
wenzelm@58706
    11
import scala.annotation.tailrec
wenzelm@34166
    12
wenzelm@34166
    13
wenzelm@43774
    14
object Outer_Syntax
wenzelm@43774
    15
{
wenzelm@58706
    16
  /* syntax */
wenzelm@58706
    17
wenzelm@58706
    18
  val empty: Outer_Syntax = new Outer_Syntax()
wenzelm@58706
    19
wenzelm@58706
    20
  def init(): Outer_Syntax = new Outer_Syntax(completion = Completion.init())
wenzelm@58706
    21
wenzelm@58706
    22
wenzelm@58706
    23
  /* string literals */
wenzelm@58706
    24
wenzelm@43774
    25
  def quote_string(str: String): String =
wenzelm@43774
    26
  {
wenzelm@43774
    27
    val result = new StringBuilder(str.length + 10)
wenzelm@43774
    28
    result += '"'
wenzelm@43774
    29
    for (s <- Symbol.iterator(str)) {
wenzelm@43774
    30
      if (s.length == 1) {
wenzelm@43774
    31
        val c = s(0)
wenzelm@43774
    32
        if (c < 32 && c != YXML.X && c != YXML.Y || c == '\\' || c == '"') {
wenzelm@43774
    33
          result += '\\'
wenzelm@43774
    34
          if (c < 10) result += '0'
wenzelm@43774
    35
          if (c < 100) result += '0'
wenzelm@60215
    36
          result ++= c.asInstanceOf[Int].toString
wenzelm@43774
    37
        }
wenzelm@43774
    38
        else result += c
wenzelm@43774
    39
      }
wenzelm@43774
    40
      else result ++= s
wenzelm@43774
    41
    }
wenzelm@43774
    42
    result += '"'
wenzelm@43774
    43
    result.toString
wenzelm@43774
    44
  }
wenzelm@46626
    45
wenzelm@58696
    46
wenzelm@58697
    47
  /* line-oriented structure */
wenzelm@58696
    48
wenzelm@58697
    49
  object Line_Structure
wenzelm@58696
    50
  {
wenzelm@58700
    51
    val init = Line_Structure()
wenzelm@58696
    52
  }
wenzelm@58696
    53
wenzelm@58700
    54
  sealed case class Line_Structure(
wenzelm@58700
    55
    improper: Boolean = true,
wenzelm@58700
    56
    command: Boolean = false,
wenzelm@58700
    57
    depth: Int = 0,
wenzelm@58700
    58
    span_depth: Int = 0,
wenzelm@58700
    59
    after_span_depth: Int = 0)
wenzelm@58706
    60
wenzelm@58706
    61
wenzelm@58706
    62
  /* overall document structure */
wenzelm@58706
    63
wenzelm@58706
    64
  sealed abstract class Document { def length: Int }
wenzelm@58747
    65
  case class Document_Block(name: String, text: String, body: List[Document]) extends Document
wenzelm@58706
    66
  {
wenzelm@58706
    67
    val length: Int = (0 /: body)(_ + _.length)
wenzelm@58706
    68
  }
wenzelm@58747
    69
  case class Document_Atom(command: Command) extends Document
wenzelm@58706
    70
  {
wenzelm@58706
    71
    def length: Int = command.length
wenzelm@58706
    72
  }
wenzelm@43774
    73
}
wenzelm@43774
    74
wenzelm@46712
    75
final class Outer_Syntax private(
wenzelm@58900
    76
  val keywords: Keyword.Keywords = Keyword.Keywords.empty,
wenzelm@53280
    77
  val completion: Completion = Completion.empty,
wenzelm@55749
    78
  val language_context: Completion.Language_Context = Completion.Language_Context.outer,
wenzelm@56393
    79
  val has_tokens: Boolean = true) extends Prover.Syntax
wenzelm@34166
    80
{
wenzelm@58706
    81
  /** syntax content **/
wenzelm@58706
    82
wenzelm@58900
    83
  override def toString: String = keywords.toString
wenzelm@56393
    84
wenzelm@58695
    85
wenzelm@58695
    86
  /* add keywords */
wenzelm@58695
    87
wenzelm@63429
    88
  def + (name: String, kind: String = "", tags: List[String] = Nil, replace: Option[String] = None)
wenzelm@58901
    89
    : Outer_Syntax =
wenzelm@53280
    90
  {
wenzelm@63429
    91
    val keywords1 = keywords + (name, kind, tags)
wenzelm@53280
    92
    val completion1 =
wenzelm@58853
    93
      if (replace == Some("")) completion
wenzelm@63528
    94
      else if (replace.isEmpty && Keyword.theory_block.contains(kind))
wenzelm@63528
    95
        completion + (name, name + "\nbegin\n\u0007\nend") + (name, name)
wenzelm@53280
    96
      else completion + (name, replace getOrElse name)
wenzelm@58900
    97
    new Outer_Syntax(keywords1, completion1, language_context, true)
wenzelm@53280
    98
  }
wenzelm@48706
    99
wenzelm@48873
   100
  def add_keywords(keywords: Thy_Header.Keywords): Outer_Syntax =
wenzelm@48873
   101
    (this /: keywords) {
wenzelm@63429
   102
      case (syntax, (name, ((kind, tags), _), replace)) =>
wenzelm@50128
   103
        syntax +
wenzelm@63429
   104
          (Symbol.decode(name), kind, tags, replace) +
wenzelm@63429
   105
          (Symbol.encode(name), kind, tags, replace)
wenzelm@46940
   106
    }
wenzelm@34166
   107
wenzelm@58695
   108
wenzelm@59073
   109
  /* merge */
wenzelm@59073
   110
wenzelm@59077
   111
  def ++ (other: Prover.Syntax): Prover.Syntax =
wenzelm@59073
   112
    if (this eq other) this
wenzelm@59073
   113
    else {
wenzelm@59077
   114
      val keywords1 = keywords ++ other.asInstanceOf[Outer_Syntax].keywords
wenzelm@59077
   115
      val completion1 = completion ++ other.asInstanceOf[Outer_Syntax].completion
wenzelm@59077
   116
      if ((keywords eq keywords1) && (completion eq completion1)) this
wenzelm@59077
   117
      else new Outer_Syntax(keywords1, completion1, language_context, has_tokens)
wenzelm@59073
   118
    }
wenzelm@59073
   119
wenzelm@59073
   120
wenzelm@59735
   121
  /* load commands */
wenzelm@58900
   122
wenzelm@63441
   123
  def load_command(name: String): Option[List[String]] = keywords.load_commands.get(name)
wenzelm@58900
   124
  def load_commands_in(text: String): Boolean = keywords.load_commands_in(text)
wenzelm@58900
   125
wenzelm@58900
   126
wenzelm@58706
   127
  /* language context */
wenzelm@34166
   128
wenzelm@58706
   129
  def set_language_context(context: Completion.Language_Context): Outer_Syntax =
wenzelm@58900
   130
    new Outer_Syntax(keywords, completion, context, has_tokens)
wenzelm@58706
   131
wenzelm@58706
   132
  def no_tokens: Outer_Syntax =
wenzelm@46969
   133
  {
wenzelm@58900
   134
    require(keywords.is_empty)
wenzelm@58706
   135
    new Outer_Syntax(
wenzelm@58706
   136
      completion = completion,
wenzelm@58706
   137
      language_context = language_context,
wenzelm@58706
   138
      has_tokens = false)
wenzelm@46969
   139
  }
wenzelm@40454
   140
wenzelm@58706
   141
wenzelm@40454
   142
wenzelm@58706
   143
  /** parsing **/
wenzelm@34166
   144
wenzelm@58697
   145
  /* line-oriented structure */
wenzelm@58696
   146
wenzelm@63460
   147
  private val close_structure =
wenzelm@63460
   148
    Set(Keyword.NEXT_BLOCK, Keyword.QED_BLOCK, Keyword.PRF_CLOSE)
wenzelm@63460
   149
wenzelm@59924
   150
  def line_structure(tokens: List[Token], structure: Outer_Syntax.Line_Structure)
wenzelm@58700
   151
    : Outer_Syntax.Line_Structure =
wenzelm@58696
   152
  {
wenzelm@58700
   153
    val improper1 = tokens.forall(_.is_improper)
wenzelm@58700
   154
    val command1 = tokens.exists(_.is_command)
wenzelm@58700
   155
wenzelm@63458
   156
    val command_depth =
wenzelm@63458
   157
      tokens.iterator.filter(_.is_proper).toStream.headOption match {
wenzelm@63458
   158
        case Some(tok) =>
wenzelm@63460
   159
          if (keywords.is_command(tok, close_structure))
wenzelm@63458
   160
            Some(structure.after_span_depth - 1)
wenzelm@63458
   161
          else None
wenzelm@63458
   162
        case None => None
wenzelm@63458
   163
      }
wenzelm@63458
   164
wenzelm@58696
   165
    val depth1 =
wenzelm@63459
   166
      if (tokens.exists(tok =>
wenzelm@63459
   167
            keywords.is_before_command(tok) || keywords.is_command(tok, Keyword.theory))) 0
wenzelm@63458
   168
      else if (command_depth.isDefined) command_depth.get
wenzelm@59924
   169
      else if (command1) structure.after_span_depth
wenzelm@59924
   170
      else structure.span_depth
wenzelm@58700
   171
wenzelm@58700
   172
    val (span_depth1, after_span_depth1) =
wenzelm@59924
   173
      ((structure.span_depth, structure.after_span_depth) /: tokens) {
wenzelm@58703
   174
        case ((x, y), tok) =>
wenzelm@58703
   175
          if (tok.is_command) {
wenzelm@63424
   176
            if (keywords.is_command(tok, Keyword.theory_goal)) (2, 1)
wenzelm@63424
   177
            else if (keywords.is_command(tok, Keyword.theory)) (1, 0)
wenzelm@63424
   178
            else if (keywords.is_command(tok, Keyword.proof_open)) (y + 2, y + 1)
wenzelm@63479
   179
            else if (keywords.is_command(tok, Set(Keyword.PRF_BLOCK))) (y + 2, y + 1)
wenzelm@63479
   180
            else if (keywords.is_command(tok, Set(Keyword.QED_BLOCK))) (y - 1, y - 2)
wenzelm@63479
   181
            else if (keywords.is_command(tok, Set(Keyword.PRF_CLOSE))) (y, y - 1)
wenzelm@63424
   182
            else if (keywords.is_command(tok, Keyword.proof_close)) (y + 1, y - 1)
wenzelm@63424
   183
            else if (keywords.is_command(tok, Keyword.qed_global)) (1, 0)
wenzelm@58703
   184
            else (x, y)
wenzelm@58703
   185
          }
wenzelm@58703
   186
          else (x, y)
wenzelm@58696
   187
      }
wenzelm@58700
   188
wenzelm@58700
   189
    Outer_Syntax.Line_Structure(improper1, command1, depth1, span_depth1, after_span_depth1)
wenzelm@58696
   190
  }
wenzelm@58696
   191
wenzelm@58696
   192
wenzelm@58706
   193
  /* command spans */
wenzelm@57905
   194
wenzelm@57905
   195
  def parse_spans(toks: List[Token]): List[Command_Span.Span] =
wenzelm@57905
   196
  {
wenzelm@57905
   197
    val result = new mutable.ListBuffer[Command_Span.Span]
wenzelm@57905
   198
    val content = new mutable.ListBuffer[Token]
wenzelm@57905
   199
    val improper = new mutable.ListBuffer[Token]
wenzelm@57905
   200
wenzelm@57905
   201
    def ship(span: List[Token])
wenzelm@57905
   202
    {
wenzelm@57905
   203
      val kind =
wenzelm@59924
   204
        if (span.forall(_.is_improper)) Command_Span.Ignored_Span
wenzelm@59924
   205
        else if (span.exists(_.is_error)) Command_Span.Malformed_Span
wenzelm@59924
   206
        else
wenzelm@59924
   207
          span.find(_.is_command) match {
wenzelm@59924
   208
            case None => Command_Span.Malformed_Span
wenzelm@59924
   209
            case Some(cmd) =>
wenzelm@59924
   210
              val name = cmd.source
wenzelm@59924
   211
              val offset =
wenzelm@59924
   212
                (0 /: span.takeWhile(_ != cmd)) {
wenzelm@59924
   213
                  case (i, tok) => i + Symbol.iterator(tok.source).length }
wenzelm@59924
   214
              val end_offset = offset + Symbol.iterator(name).length
wenzelm@59924
   215
              val pos = Position.Range(Text.Range(offset, end_offset) + 1)
wenzelm@59924
   216
              Command_Span.Command_Span(name, pos)
wenzelm@59924
   217
          }
wenzelm@57905
   218
      result += Command_Span.Span(kind, span)
wenzelm@57905
   219
    }
wenzelm@57905
   220
wenzelm@57905
   221
    def flush()
wenzelm@57905
   222
    {
wenzelm@59319
   223
      if (content.nonEmpty) { ship(content.toList); content.clear }
wenzelm@59319
   224
      if (improper.nonEmpty) { ship(improper.toList); improper.clear }
wenzelm@57905
   225
    }
wenzelm@57905
   226
wenzelm@57905
   227
    for (tok <- toks) {
wenzelm@59924
   228
      if (tok.is_improper) improper += tok
wenzelm@63441
   229
      else if (keywords.is_before_command(tok) ||
wenzelm@63441
   230
        tok.is_command &&
wenzelm@63441
   231
          (!content.exists(keywords.is_before_command(_)) || content.exists(_.is_command)))
wenzelm@59924
   232
      { flush(); content += tok }
wenzelm@57905
   233
      else { content ++= improper; improper.clear; content += tok }
wenzelm@57905
   234
    }
wenzelm@57905
   235
    flush()
wenzelm@57905
   236
wenzelm@57905
   237
    result.toList
wenzelm@57905
   238
  }
wenzelm@57905
   239
wenzelm@57906
   240
  def parse_spans(input: CharSequence): List[Command_Span.Span] =
wenzelm@59083
   241
    parse_spans(Token.explode(keywords, input))
wenzelm@57906
   242
wenzelm@57905
   243
wenzelm@58706
   244
  /* overall document structure */
wenzelm@55616
   245
wenzelm@58706
   246
  def heading_level(command: Command): Option[Int] =
wenzelm@58706
   247
  {
wenzelm@59735
   248
    val name = command.span.name
wenzelm@59735
   249
    name match {
wenzelm@59735
   250
      case Thy_Header.CHAPTER => Some(0)
wenzelm@62453
   251
      case Thy_Header.SECTION => Some(1)
wenzelm@59735
   252
      case Thy_Header.SUBSECTION => Some(2)
wenzelm@59735
   253
      case Thy_Header.SUBSUBSECTION => Some(3)
wenzelm@61463
   254
      case Thy_Header.PARAGRAPH => Some(4)
wenzelm@61463
   255
      case Thy_Header.SUBPARAGRAPH => Some(5)
wenzelm@58868
   256
      case _ =>
wenzelm@63441
   257
        keywords.kinds.get(name) match {
wenzelm@61463
   258
          case Some(kind) if Keyword.theory(kind) && !Keyword.theory_end(kind) => Some(6)
wenzelm@58868
   259
          case _ => None
wenzelm@58868
   260
        }
wenzelm@58706
   261
    }
wenzelm@58706
   262
  }
wenzelm@58706
   263
wenzelm@58743
   264
  def parse_document(node_name: Document.Node.Name, text: CharSequence):
wenzelm@58743
   265
    List[Outer_Syntax.Document] =
wenzelm@58706
   266
  {
wenzelm@58706
   267
    /* stack operations */
wenzelm@58706
   268
wenzelm@58706
   269
    def buffer(): mutable.ListBuffer[Outer_Syntax.Document] =
wenzelm@58706
   270
      new mutable.ListBuffer[Outer_Syntax.Document]
wenzelm@58706
   271
wenzelm@58747
   272
    var stack: List[(Int, Command, mutable.ListBuffer[Outer_Syntax.Document])] =
wenzelm@58747
   273
      List((0, Command.empty, buffer()))
wenzelm@55616
   274
wenzelm@58706
   275
    @tailrec def close(level: Int => Boolean)
wenzelm@58706
   276
    {
wenzelm@58706
   277
      stack match {
wenzelm@58747
   278
        case (lev, command, body) :: (_, _, body2) :: rest if level(lev) =>
wenzelm@59735
   279
          body2 += Outer_Syntax.Document_Block(command.span.name, command.source, body.toList)
wenzelm@58706
   280
          stack = stack.tail
wenzelm@58706
   281
          close(level)
wenzelm@58706
   282
        case _ =>
wenzelm@58706
   283
      }
wenzelm@58706
   284
    }
wenzelm@58706
   285
wenzelm@58743
   286
    def result(): List[Outer_Syntax.Document] =
wenzelm@58706
   287
    {
wenzelm@58706
   288
      close(_ => true)
wenzelm@58743
   289
      stack.head._3.toList
wenzelm@58706
   290
    }
wenzelm@58706
   291
wenzelm@58706
   292
    def add(command: Command)
wenzelm@58706
   293
    {
wenzelm@58706
   294
      heading_level(command) match {
wenzelm@58706
   295
        case Some(i) =>
wenzelm@58706
   296
          close(_ > i)
wenzelm@58747
   297
          stack = (i + 1, command, buffer()) :: stack
wenzelm@58706
   298
        case None =>
wenzelm@58706
   299
      }
wenzelm@58706
   300
      stack.head._3 += Outer_Syntax.Document_Atom(command)
wenzelm@58706
   301
    }
wenzelm@58706
   302
wenzelm@58706
   303
wenzelm@58706
   304
    /* result structure */
wenzelm@58706
   305
wenzelm@58706
   306
    val spans = parse_spans(text)
wenzelm@59702
   307
    spans.foreach(span => add(Command(Document_ID.none, node_name, Command.no_blobs, span)))
wenzelm@58706
   308
    result()
wenzelm@55616
   309
  }
wenzelm@34166
   310
}