src/Pure/Isar/outer_syntax.scala
author wenzelm
Thu Jan 08 20:56:39 2015 +0100 (2015-01-08)
changeset 59319 677615cba30d
parent 59122 c1dbcde94cd2
child 59684 86a76300137e
permissions -rw-r--r--
tuned;
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@43774
    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@58907
    88
  def + (name: String): Outer_Syntax = this + (name, None, None)
wenzelm@58907
    89
  def + (name: String, kind: String): Outer_Syntax = this + (name, Some((kind, Nil)), None)
wenzelm@58901
    90
  def + (name: String, opt_kind: Option[(String, List[String])], replace: Option[String])
wenzelm@58901
    91
    : Outer_Syntax =
wenzelm@53280
    92
  {
wenzelm@58901
    93
    val keywords1 =
wenzelm@58901
    94
      opt_kind match {
wenzelm@58901
    95
        case None => keywords + name
wenzelm@58901
    96
        case Some(kind) => keywords + (name, kind)
wenzelm@58901
    97
      }
wenzelm@53280
    98
    val completion1 =
wenzelm@58853
    99
      if (replace == Some("")) completion
wenzelm@53280
   100
      else completion + (name, replace getOrElse name)
wenzelm@58900
   101
    new Outer_Syntax(keywords1, completion1, language_context, true)
wenzelm@53280
   102
  }
wenzelm@48706
   103
wenzelm@48873
   104
  def add_keywords(keywords: Thy_Header.Keywords): Outer_Syntax =
wenzelm@48873
   105
    (this /: keywords) {
wenzelm@58901
   106
      case (syntax, (name, opt_spec, replace)) =>
wenzelm@58901
   107
        val opt_kind = opt_spec.map(_._1)
wenzelm@50128
   108
        syntax +
wenzelm@58901
   109
          (Symbol.decode(name), opt_kind, replace) +
wenzelm@58901
   110
          (Symbol.encode(name), opt_kind, replace)
wenzelm@46940
   111
    }
wenzelm@34166
   112
wenzelm@58695
   113
wenzelm@59073
   114
  /* merge */
wenzelm@59073
   115
wenzelm@59077
   116
  def ++ (other: Prover.Syntax): Prover.Syntax =
wenzelm@59073
   117
    if (this eq other) this
wenzelm@59073
   118
    else {
wenzelm@59077
   119
      val keywords1 = keywords ++ other.asInstanceOf[Outer_Syntax].keywords
wenzelm@59077
   120
      val completion1 = completion ++ other.asInstanceOf[Outer_Syntax].completion
wenzelm@59077
   121
      if ((keywords eq keywords1) && (completion eq completion1)) this
wenzelm@59077
   122
      else new Outer_Syntax(keywords1, completion1, language_context, has_tokens)
wenzelm@59073
   123
    }
wenzelm@59073
   124
wenzelm@59073
   125
wenzelm@58900
   126
  /* load commands */
wenzelm@58900
   127
wenzelm@58900
   128
  def load_command(name: String): Option[List[String]] = keywords.load_command(name)
wenzelm@58900
   129
  def load_commands_in(text: String): Boolean = keywords.load_commands_in(text)
wenzelm@58900
   130
wenzelm@58900
   131
wenzelm@58706
   132
  /* language context */
wenzelm@34166
   133
wenzelm@58706
   134
  def set_language_context(context: Completion.Language_Context): Outer_Syntax =
wenzelm@58900
   135
    new Outer_Syntax(keywords, completion, context, has_tokens)
wenzelm@58706
   136
wenzelm@58706
   137
  def no_tokens: Outer_Syntax =
wenzelm@46969
   138
  {
wenzelm@58900
   139
    require(keywords.is_empty)
wenzelm@58706
   140
    new Outer_Syntax(
wenzelm@58706
   141
      completion = completion,
wenzelm@58706
   142
      language_context = language_context,
wenzelm@58706
   143
      has_tokens = false)
wenzelm@46969
   144
  }
wenzelm@40454
   145
wenzelm@58706
   146
wenzelm@40454
   147
wenzelm@58706
   148
  /** parsing **/
wenzelm@34166
   149
wenzelm@58697
   150
  /* line-oriented structure */
wenzelm@58696
   151
wenzelm@58700
   152
  def line_structure(tokens: List[Token], struct: Outer_Syntax.Line_Structure)
wenzelm@58700
   153
    : Outer_Syntax.Line_Structure =
wenzelm@58696
   154
  {
wenzelm@58700
   155
    val improper1 = tokens.forall(_.is_improper)
wenzelm@58700
   156
    val command1 = tokens.exists(_.is_command)
wenzelm@58700
   157
wenzelm@58696
   158
    val depth1 =
wenzelm@59122
   159
      if (tokens.exists(tok => tok.is_command_kind(keywords, Keyword.theory))) 0
wenzelm@58700
   160
      else if (command1) struct.after_span_depth
wenzelm@58700
   161
      else struct.span_depth
wenzelm@58700
   162
wenzelm@58700
   163
    val (span_depth1, after_span_depth1) =
wenzelm@58700
   164
      ((struct.span_depth, struct.after_span_depth) /: tokens) {
wenzelm@58703
   165
        case ((x, y), tok) =>
wenzelm@58703
   166
          if (tok.is_command) {
wenzelm@59122
   167
            if (tok.is_command_kind(keywords, Keyword.theory_goal))
wenzelm@58900
   168
              (2, 1)
wenzelm@59122
   169
            else if (tok.is_command_kind(keywords, Keyword.theory))
wenzelm@58900
   170
              (1, 0)
wenzelm@59122
   171
            else if (tok.is_command_kind(keywords, Keyword.proof_goal) || tok.is_begin_block)
wenzelm@58900
   172
              (y + 2, y + 1)
wenzelm@59122
   173
            else if (tok.is_command_kind(keywords, Keyword.qed) || tok.is_end_block)
wenzelm@58900
   174
              (y + 1, y - 1)
wenzelm@59122
   175
            else if (tok.is_command_kind(keywords, Keyword.qed_global))
wenzelm@58900
   176
              (1, 0)
wenzelm@58703
   177
            else (x, y)
wenzelm@58703
   178
          }
wenzelm@58703
   179
          else (x, y)
wenzelm@58696
   180
      }
wenzelm@58700
   181
wenzelm@58700
   182
    Outer_Syntax.Line_Structure(improper1, command1, depth1, span_depth1, after_span_depth1)
wenzelm@58696
   183
  }
wenzelm@58696
   184
wenzelm@58696
   185
wenzelm@58706
   186
  /* command spans */
wenzelm@57905
   187
wenzelm@57905
   188
  def parse_spans(toks: List[Token]): List[Command_Span.Span] =
wenzelm@57905
   189
  {
wenzelm@57905
   190
    val result = new mutable.ListBuffer[Command_Span.Span]
wenzelm@57905
   191
    val content = new mutable.ListBuffer[Token]
wenzelm@57905
   192
    val improper = new mutable.ListBuffer[Token]
wenzelm@57905
   193
wenzelm@57905
   194
    def ship(span: List[Token])
wenzelm@57905
   195
    {
wenzelm@57905
   196
      val kind =
wenzelm@59319
   197
        if (span.nonEmpty && span.head.is_command && !span.exists(_.is_error)) {
wenzelm@57910
   198
          val name = span.head.source
wenzelm@57911
   199
          val pos = Position.Range(Text.Range(0, Symbol.iterator(name).length) + 1)
wenzelm@57910
   200
          Command_Span.Command_Span(name, pos)
wenzelm@57910
   201
        }
wenzelm@57905
   202
        else if (span.forall(_.is_improper)) Command_Span.Ignored_Span
wenzelm@57905
   203
        else Command_Span.Malformed_Span
wenzelm@57905
   204
      result += Command_Span.Span(kind, span)
wenzelm@57905
   205
    }
wenzelm@57905
   206
wenzelm@57905
   207
    def flush()
wenzelm@57905
   208
    {
wenzelm@59319
   209
      if (content.nonEmpty) { ship(content.toList); content.clear }
wenzelm@59319
   210
      if (improper.nonEmpty) { ship(improper.toList); improper.clear }
wenzelm@57905
   211
    }
wenzelm@57905
   212
wenzelm@57905
   213
    for (tok <- toks) {
wenzelm@57905
   214
      if (tok.is_command) { flush(); content += tok }
wenzelm@57905
   215
      else if (tok.is_improper) improper += tok
wenzelm@57905
   216
      else { content ++= improper; improper.clear; content += tok }
wenzelm@57905
   217
    }
wenzelm@57905
   218
    flush()
wenzelm@57905
   219
wenzelm@57905
   220
    result.toList
wenzelm@57905
   221
  }
wenzelm@57905
   222
wenzelm@57906
   223
  def parse_spans(input: CharSequence): List[Command_Span.Span] =
wenzelm@59083
   224
    parse_spans(Token.explode(keywords, input))
wenzelm@57906
   225
wenzelm@57905
   226
wenzelm@58706
   227
  /* overall document structure */
wenzelm@55616
   228
wenzelm@58706
   229
  def heading_level(command: Command): Option[Int] =
wenzelm@58706
   230
  {
wenzelm@58868
   231
    command.name match {
wenzelm@58868
   232
      case "chapter" => Some(0)
wenzelm@58868
   233
      case "section" | "header" => Some(1)
wenzelm@58868
   234
      case "subsection" => Some(2)
wenzelm@58868
   235
      case "subsubsection" => Some(3)
wenzelm@58868
   236
      case _ =>
wenzelm@58901
   237
        keywords.command_kind(command.name) match {
wenzelm@58938
   238
          case Some(kind) if Keyword.theory(kind) && kind != Keyword.THY_END => Some(4)
wenzelm@58868
   239
          case _ => None
wenzelm@58868
   240
        }
wenzelm@58706
   241
    }
wenzelm@58706
   242
  }
wenzelm@58706
   243
wenzelm@58743
   244
  def parse_document(node_name: Document.Node.Name, text: CharSequence):
wenzelm@58743
   245
    List[Outer_Syntax.Document] =
wenzelm@58706
   246
  {
wenzelm@58706
   247
    /* stack operations */
wenzelm@58706
   248
wenzelm@58706
   249
    def buffer(): mutable.ListBuffer[Outer_Syntax.Document] =
wenzelm@58706
   250
      new mutable.ListBuffer[Outer_Syntax.Document]
wenzelm@58706
   251
wenzelm@58747
   252
    var stack: List[(Int, Command, mutable.ListBuffer[Outer_Syntax.Document])] =
wenzelm@58747
   253
      List((0, Command.empty, buffer()))
wenzelm@55616
   254
wenzelm@58706
   255
    @tailrec def close(level: Int => Boolean)
wenzelm@58706
   256
    {
wenzelm@58706
   257
      stack match {
wenzelm@58747
   258
        case (lev, command, body) :: (_, _, body2) :: rest if level(lev) =>
wenzelm@58747
   259
          body2 += Outer_Syntax.Document_Block(command.name, command.source, body.toList)
wenzelm@58706
   260
          stack = stack.tail
wenzelm@58706
   261
          close(level)
wenzelm@58706
   262
        case _ =>
wenzelm@58706
   263
      }
wenzelm@58706
   264
    }
wenzelm@58706
   265
wenzelm@58743
   266
    def result(): List[Outer_Syntax.Document] =
wenzelm@58706
   267
    {
wenzelm@58706
   268
      close(_ => true)
wenzelm@58743
   269
      stack.head._3.toList
wenzelm@58706
   270
    }
wenzelm@58706
   271
wenzelm@58706
   272
    def add(command: Command)
wenzelm@58706
   273
    {
wenzelm@58706
   274
      heading_level(command) match {
wenzelm@58706
   275
        case Some(i) =>
wenzelm@58706
   276
          close(_ > i)
wenzelm@58747
   277
          stack = (i + 1, command, buffer()) :: stack
wenzelm@58706
   278
        case None =>
wenzelm@58706
   279
      }
wenzelm@58706
   280
      stack.head._3 += Outer_Syntax.Document_Atom(command)
wenzelm@58706
   281
    }
wenzelm@58706
   282
wenzelm@58706
   283
wenzelm@58706
   284
    /* result structure */
wenzelm@58706
   285
wenzelm@58706
   286
    val spans = parse_spans(text)
wenzelm@58706
   287
    spans.foreach(span => add(Command(Document_ID.none, node_name, Nil, span)))
wenzelm@58706
   288
    result()
wenzelm@55616
   289
  }
wenzelm@34166
   290
}