src/Pure/PIDE/yxml.scala
author wenzelm
Wed, 04 Apr 2012 14:19:47 +0200
changeset 47336 bed4b2738d8a
parent 45673 cd41e3903fbf
child 48996 a8bad1369ada
permissions -rw-r--r--
separate module for prover command execution;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
44698
0385292321a0 moved XML/YXML to src/Pure/PIDE;
wenzelm
parents: 44181
diff changeset
     1
/*  Title:      Pure/PIDE/yxml.scala
45673
cd41e3903fbf separate compilation of PIDE vs. Pure sources, which enables independent Scala library;
wenzelm
parents: 45667
diff changeset
     2
    Module:     PIDE
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
     3
    Author:     Makarius
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
     4
44698
0385292321a0 moved XML/YXML to src/Pure/PIDE;
wenzelm
parents: 44181
diff changeset
     5
Efficient text representation of XML trees.  Suitable for direct
0385292321a0 moved XML/YXML to src/Pure/PIDE;
wenzelm
parents: 44181
diff changeset
     6
inlining into plain text.
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
     7
*/
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
     8
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
     9
package isabelle
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    10
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    11
40453
wenzelm
parents: 38475
diff changeset
    12
import scala.collection.mutable
36684
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    13
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    14
32450
375db037f4d2 misc tuning;
wenzelm
parents: 31521
diff changeset
    15
object YXML
375db037f4d2 misc tuning;
wenzelm
parents: 31521
diff changeset
    16
{
27943
f34ff5e7728f replaced Pattern.split by chunks iterator (more efficient, resembles ML version more closely);
wenzelm
parents: 27930
diff changeset
    17
  /* chunk markers */
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    18
43774
6dfdb70496fe added Outer_Syntax.quote_string, which is conceptually a bit different from Token.unparse;
wenzelm
parents: 43746
diff changeset
    19
  val X = '\5'
6dfdb70496fe added Outer_Syntax.quote_string, which is conceptually a bit different from Token.unparse;
wenzelm
parents: 43746
diff changeset
    20
  val Y = '\6'
6dfdb70496fe added Outer_Syntax.quote_string, which is conceptually a bit different from Token.unparse;
wenzelm
parents: 43746
diff changeset
    21
  val X_string = X.toString
6dfdb70496fe added Outer_Syntax.quote_string, which is conceptually a bit different from Token.unparse;
wenzelm
parents: 43746
diff changeset
    22
  val Y_string = Y.toString
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    23
43782
834de29572d5 clarified YXML.detect;
wenzelm
parents: 43774
diff changeset
    24
  def detect(s: String): Boolean = s.exists(c => c == X || c == Y)
834de29572d5 clarified YXML.detect;
wenzelm
parents: 43774
diff changeset
    25
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    26
38268
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    27
  /* string representation */  // FIXME byte array version with pseudo-utf-8 (!?)
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    28
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    29
  def string_of_body(body: XML.Body): String =
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    30
  {
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    31
    val s = new StringBuilder
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    32
    def attrib(p: (String, String)) { s += Y; s ++= p._1; s += '='; s ++= p._2 }
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    33
    def tree(t: XML.Tree): Unit =
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    34
      t match {
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    35
        case XML.Elem(Markup(name, atts), ts) =>
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    36
          s += X; s += Y; s++= name; atts.foreach(attrib); s += X
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    37
          ts.foreach(tree)
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    38
          s += X; s += Y; s += X
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    39
        case XML.Text(text) => s ++= text
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    40
      }
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    41
    body.foreach(tree)
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    42
    s.toString
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    43
  }
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    44
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    45
  def string_of_tree(tree: XML.Tree): String = string_of_body(List(tree))
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    46
beb86b805590 more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents: 38267
diff changeset
    47
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    48
  /* parsing */
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    49
27993
6dd90ef9f927 simplified exceptions: use plain error function / RuntimeException;
wenzelm
parents: 27971
diff changeset
    50
  private def err(msg: String) = error("Malformed YXML: " + msg)
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    51
  private def err_attribute() = err("bad attribute")
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    52
  private def err_element() = err("bad element")
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    53
  private def err_unbalanced(name: String) =
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    54
    if (name == "") err("unbalanced element")
44181
wenzelm
parents: 43841
diff changeset
    55
    else err("unbalanced element " + quote(name))
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    56
27944
2bf3f30558ed parse_attrib: more efficient due to indexOf('=');
wenzelm
parents: 27943
diff changeset
    57
  private def parse_attrib(source: CharSequence) = {
2bf3f30558ed parse_attrib: more efficient due to indexOf('=');
wenzelm
parents: 27943
diff changeset
    58
    val s = source.toString
2bf3f30558ed parse_attrib: more efficient due to indexOf('=');
wenzelm
parents: 27943
diff changeset
    59
    val i = s.indexOf('=')
2bf3f30558ed parse_attrib: more efficient due to indexOf('=');
wenzelm
parents: 27943
diff changeset
    60
    if (i <= 0) err_attribute()
38234
4b610fbb2d83 YXML.parse: refrain from interning, let XML.Cache do it (partially);
wenzelm
parents: 38231
diff changeset
    61
    (s.substring(0, i), s.substring(i + 1))
27944
2bf3f30558ed parse_attrib: more efficient due to indexOf('=');
wenzelm
parents: 27943
diff changeset
    62
  }
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    63
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    64
38267
e50c283dd125 type XML.Body as basic data representation language (Scala version);
wenzelm
parents: 38234
diff changeset
    65
  def parse_body(source: CharSequence): XML.Body =
32450
375db037f4d2 misc tuning;
wenzelm
parents: 31521
diff changeset
    66
  {
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    67
    /* stack operations */
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    68
40453
wenzelm
parents: 38475
diff changeset
    69
    def buffer(): mutable.ListBuffer[XML.Tree] = new mutable.ListBuffer[XML.Tree]
wenzelm
parents: 38475
diff changeset
    70
    var stack: List[(Markup, mutable.ListBuffer[XML.Tree])] = List((Markup.Empty, buffer()))
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    71
36684
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    72
    def add(x: XML.Tree)
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    73
    {
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    74
      (stack: @unchecked) match { case ((_, body) :: _) => body += x }
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    75
    }
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    76
36684
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    77
    def push(name: String, atts: XML.Attributes)
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    78
    {
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    79
      if (name == "") err_element()
38230
ed147003de4b simplified type XML.Tree: embed Markup directly, avoid slightly odd triple;
wenzelm
parents: 36685
diff changeset
    80
      else stack = (Markup(name, atts), buffer()) :: stack
36684
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    81
    }
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    82
36684
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    83
    def pop()
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    84
    {
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    85
      (stack: @unchecked) match {
38475
wenzelm
parents: 38268
diff changeset
    86
        case ((Markup.Empty, _) :: _) => err_unbalanced("")
38230
ed147003de4b simplified type XML.Tree: embed Markup directly, avoid slightly odd triple;
wenzelm
parents: 36685
diff changeset
    87
        case ((markup, body) :: pending) =>
ed147003de4b simplified type XML.Tree: embed Markup directly, avoid slightly odd triple;
wenzelm
parents: 36685
diff changeset
    88
          stack = pending
ed147003de4b simplified type XML.Tree: embed Markup directly, avoid slightly odd triple;
wenzelm
parents: 36685
diff changeset
    89
          add(XML.Elem(markup, body.toList))
36684
943f1ca7b375 misc tuning -- accumulate body via ListBuffer;
wenzelm
parents: 34201
diff changeset
    90
      }
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    91
    }
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    92
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    93
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    94
    /* parse chunks */
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
    95
36685
2b3076cfd6dd slightly more general Library.chunks;
wenzelm
parents: 36684
diff changeset
    96
    for (chunk <- Library.chunks(source, X) if chunk.length != 0) {
34099
2541de190d92 added decode_chars, with raw character view on byte buffer and adhoc decoding via toString;
wenzelm
parents: 32450
diff changeset
    97
      if (chunk.length == 1 && chunk.charAt(0) == Y) pop()
27945
d2dc5a1903e8 tuned parse performance: avoid splitting terminal Y chunk;
wenzelm
parents: 27944
diff changeset
    98
      else {
36685
2b3076cfd6dd slightly more general Library.chunks;
wenzelm
parents: 36684
diff changeset
    99
        Library.chunks(chunk, Y).toList match {
34099
2541de190d92 added decode_chars, with raw character view on byte buffer and adhoc decoding via toString;
wenzelm
parents: 32450
diff changeset
   100
          case ch :: name :: atts if ch.length == 0 =>
38234
4b610fbb2d83 YXML.parse: refrain from interning, let XML.Cache do it (partially);
wenzelm
parents: 38231
diff changeset
   101
            push(name.toString, atts.map(parse_attrib))
27945
d2dc5a1903e8 tuned parse performance: avoid splitting terminal Y chunk;
wenzelm
parents: 27944
diff changeset
   102
          case txts => for (txt <- txts) add(XML.Text(txt.toString))
d2dc5a1903e8 tuned parse performance: avoid splitting terminal Y chunk;
wenzelm
parents: 27944
diff changeset
   103
        }
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
   104
      }
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
   105
    }
42719
wenzelm
parents: 40453
diff changeset
   106
    (stack: @unchecked) match {
38475
wenzelm
parents: 38268
diff changeset
   107
      case List((Markup.Empty, body)) => body.toList
38230
ed147003de4b simplified type XML.Tree: embed Markup directly, avoid slightly odd triple;
wenzelm
parents: 36685
diff changeset
   108
      case (Markup(name, _), _) :: _ => err_unbalanced(name)
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
   109
    }
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
   110
  }
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
   111
32450
375db037f4d2 misc tuning;
wenzelm
parents: 31521
diff changeset
   112
  def parse(source: CharSequence): XML.Tree =
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
   113
    parse_body(source) match {
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
   114
      case List(result) => result
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
   115
      case Nil => XML.Text("")
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
   116
      case _ => err("multiple results")
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
   117
    }
27960
65b10d8ef0c6 added parse_failsafe;
wenzelm
parents: 27946
diff changeset
   118
29521
736bf7117153 added parse_body_failsafe;
wenzelm
parents: 29180
diff changeset
   119
736bf7117153 added parse_body_failsafe;
wenzelm
parents: 29180
diff changeset
   120
  /* failsafe parsing */
736bf7117153 added parse_body_failsafe;
wenzelm
parents: 29180
diff changeset
   121
45666
d83797ef0d2d separate module for concrete Isabelle markup;
wenzelm
parents: 44698
diff changeset
   122
  private def markup_broken(source: CharSequence) =
d83797ef0d2d separate module for concrete Isabelle markup;
wenzelm
parents: 44698
diff changeset
   123
    XML.elem(Markup.Broken.name, List(XML.Text(source.toString)))
29521
736bf7117153 added parse_body_failsafe;
wenzelm
parents: 29180
diff changeset
   124
38267
e50c283dd125 type XML.Body as basic data representation language (Scala version);
wenzelm
parents: 38234
diff changeset
   125
  def parse_body_failsafe(source: CharSequence): XML.Body =
32450
375db037f4d2 misc tuning;
wenzelm
parents: 31521
diff changeset
   126
  {
29521
736bf7117153 added parse_body_failsafe;
wenzelm
parents: 29180
diff changeset
   127
    try { parse_body(source) }
45666
d83797ef0d2d separate module for concrete Isabelle markup;
wenzelm
parents: 44698
diff changeset
   128
    catch { case ERROR(_) => List(markup_broken(source)) }
29521
736bf7117153 added parse_body_failsafe;
wenzelm
parents: 29180
diff changeset
   129
  }
736bf7117153 added parse_body_failsafe;
wenzelm
parents: 29180
diff changeset
   130
32450
375db037f4d2 misc tuning;
wenzelm
parents: 31521
diff changeset
   131
  def parse_failsafe(source: CharSequence): XML.Tree =
375db037f4d2 misc tuning;
wenzelm
parents: 31521
diff changeset
   132
  {
27960
65b10d8ef0c6 added parse_failsafe;
wenzelm
parents: 27946
diff changeset
   133
    try { parse(source) }
45666
d83797ef0d2d separate module for concrete Isabelle markup;
wenzelm
parents: 44698
diff changeset
   134
    catch { case ERROR(_) => markup_broken(source) }
27960
65b10d8ef0c6 added parse_failsafe;
wenzelm
parents: 27946
diff changeset
   135
  }
27930
2b44df907cc2 Efficient text representation of XML trees.
wenzelm
parents:
diff changeset
   136
}