author | wenzelm |
Thu, 27 Jun 2024 23:32:24 +0200 | |
changeset 80433 | 48776d779d94 |
parent 80427 | c92356464bb3 |
child 80437 | 2c07b9b2f9f4 |
permissions | -rw-r--r-- |
44698 | 1 |
/* Title: Pure/PIDE/yxml.scala |
27930 | 2 |
Author: Makarius |
3 |
||
44698 | 4 |
Efficient text representation of XML trees. Suitable for direct |
5 |
inlining into plain text. |
|
27930 | 6 |
*/ |
7 |
||
8 |
package isabelle |
|
9 |
||
10 |
||
40453 | 11 |
import scala.collection.mutable |
36684 | 12 |
|
13 |
||
75393 | 14 |
object YXML { |
27943
f34ff5e7728f
replaced Pattern.split by chunks iterator (more efficient, resembles ML version more closely);
wenzelm
parents:
27930
diff
changeset
|
15 |
/* chunk markers */ |
27930 | 16 |
|
80425 | 17 |
val X_byte: Byte = 5 |
18 |
val Y_byte: Byte = 6 |
|
19 |
||
20 |
val X = X_byte.toChar |
|
21 |
val Y = Y_byte.toChar |
|
56600 | 22 |
|
73029 | 23 |
val is_X: Char => Boolean = _ == X |
24 |
val is_Y: Char => Boolean = _ == Y |
|
56600 | 25 |
|
71601 | 26 |
val X_string: String = X.toString |
27 |
val Y_string: String = Y.toString |
|
28 |
val XY_string: String = X_string + Y_string |
|
29 |
val XYX_string: String = XY_string + X_string |
|
27930 | 30 |
|
43782 | 31 |
def detect(s: String): Boolean = s.exists(c => c == X || c == Y) |
67820
e30d6368c7c8
clarified argument formats: explicit Unit, allow XML.Elem as well;
wenzelm
parents:
64370
diff
changeset
|
32 |
def detect_elem(s: String): Boolean = s.startsWith(XY_string) |
43782 | 33 |
|
27930 | 34 |
|
73029 | 35 |
/* string representation */ |
38268
beb86b805590
more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents:
38267
diff
changeset
|
36 |
|
80433
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
37 |
trait Output extends XML.Traversal { |
80425 | 38 |
def byte(b: Byte): Unit |
39 |
def string(s: String): Unit |
|
80433
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
40 |
|
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
41 |
// XML.Traversal |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
42 |
override def text(s: String): Unit = string(s) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
43 |
override def elem(markup: Markup, end: Boolean = false): Unit = { |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
44 |
byte(X_byte) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
45 |
byte(Y_byte) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
46 |
string(markup.name) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
47 |
for ((a, b) <- markup.properties) { |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
48 |
byte(Y_byte) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
49 |
string(a) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
50 |
byte('='.toByte) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
51 |
string(b) |
38268
beb86b805590
more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents:
38267
diff
changeset
|
52 |
} |
80433
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
53 |
byte(X_byte) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
54 |
if (end) end_elem(markup.name) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
55 |
} |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
56 |
override def end_elem(name: String): Unit = { |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
57 |
byte(X_byte) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
58 |
byte(Y_byte) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
59 |
byte(X_byte) |
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
60 |
} |
71534 | 61 |
} |
62 |
||
80425 | 63 |
class Output_String(builder: StringBuilder) extends Output { |
64 |
override def byte(b: Byte): Unit = { builder += b.toChar } |
|
65 |
override def string(s: String): Unit = { builder ++= s } |
|
80433
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
66 |
def result(ts: List[XML.Tree]): String = { traverse(ts); builder.toString } |
38268
beb86b805590
more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents:
38267
diff
changeset
|
67 |
} |
beb86b805590
more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents:
38267
diff
changeset
|
68 |
|
80427 | 69 |
class Output_Bytes(builder: Bytes.Builder) extends Output { |
70 |
override def byte(b: Byte): Unit = { builder += b } |
|
71 |
override def string(s: String): Unit = { builder += s } |
|
72 |
} |
|
73 |
||
80425 | 74 |
def string_of_body(body: XML.Body): String = |
75 |
new Output_String(new StringBuilder).result(body) |
|
76 |
||
80433
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
77 |
def string_of_tree(tree: XML.Tree): String = string_of_body(List(tree)) |
38268
beb86b805590
more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents:
38267
diff
changeset
|
78 |
|
80427 | 79 |
def bytes_of_body(body: XML.Body): Bytes = |
80433
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
80 |
Bytes.Builder.use()(builder => new Output_Bytes(builder).traverse(body)) |
80427 | 81 |
|
80433
48776d779d94
more robust: prefer tail-recursive XML.Traversal;
wenzelm
parents:
80427
diff
changeset
|
82 |
def bytes_of_tree(tree: XML.Tree): Bytes = bytes_of_body(List(tree)) |
80427 | 83 |
|
38268
beb86b805590
more uniform XML/YXML string_of_body/string_of_tree;
wenzelm
parents:
38267
diff
changeset
|
84 |
|
27930 | 85 |
/* parsing */ |
86 |
||
27993
6dd90ef9f927
simplified exceptions: use plain error function / RuntimeException;
wenzelm
parents:
27971
diff
changeset
|
87 |
private def err(msg: String) = error("Malformed YXML: " + msg) |
27930 | 88 |
private def err_attribute() = err("bad attribute") |
89 |
private def err_element() = err("bad element") |
|
90 |
private def err_unbalanced(name: String) = |
|
91 |
if (name == "") err("unbalanced element") |
|
44181 | 92 |
else err("unbalanced element " + quote(name)) |
27930 | 93 |
|
73029 | 94 |
private def parse_attrib(source: CharSequence): (String, String) = |
73712 | 95 |
Properties.Eq.unapply(source.toString) getOrElse err_attribute() |
27930 | 96 |
|
97 |
||
75393 | 98 |
def parse_body(source: CharSequence, cache: XML.Cache = XML.Cache.none): XML.Body = { |
27930 | 99 |
/* stack operations */ |
100 |
||
40453 | 101 |
def buffer(): mutable.ListBuffer[XML.Tree] = new mutable.ListBuffer[XML.Tree] |
102 |
var stack: List[(Markup, mutable.ListBuffer[XML.Tree])] = List((Markup.Empty, buffer())) |
|
27930 | 103 |
|
73340 | 104 |
def add(x: XML.Tree): Unit = |
73029 | 105 |
(stack: @unchecked) match { case (_, body) :: _ => body += x } |
27930 | 106 |
|
73340 | 107 |
def push(name: String, atts: XML.Attributes): Unit = |
27930 | 108 |
if (name == "") err_element() |
73030 | 109 |
else stack = (cache.markup(Markup(name, atts)), buffer()) :: stack |
27930 | 110 |
|
73340 | 111 |
def pop(): Unit = |
36684 | 112 |
(stack: @unchecked) match { |
73029 | 113 |
case (Markup.Empty, _) :: _ => err_unbalanced("") |
114 |
case (markup, body) :: pending => |
|
38230
ed147003de4b
simplified type XML.Tree: embed Markup directly, avoid slightly odd triple;
wenzelm
parents:
36685
diff
changeset
|
115 |
stack = pending |
73030 | 116 |
add(cache.tree0(XML.Elem(markup, body.toList))) |
36684 | 117 |
} |
27930 | 118 |
|
119 |
||
120 |
/* parse chunks */ |
|
121 |
||
56600 | 122 |
for (chunk <- Library.separated_chunks(is_X, source) 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
|
123 |
if (chunk.length == 1 && chunk.charAt(0) == Y) pop() |
27945
d2dc5a1903e8
tuned parse performance: avoid splitting terminal Y chunk;
wenzelm
parents:
27944
diff
changeset
|
124 |
else { |
56600 | 125 |
Library.separated_chunks(is_Y, chunk).toList match { |
34099
2541de190d92
added decode_chars, with raw character view on byte buffer and adhoc decoding via toString;
wenzelm
parents:
32450
diff
changeset
|
126 |
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
|
127 |
push(name.toString, atts.map(parse_attrib)) |
73030 | 128 |
case txts => for (txt <- txts) add(cache.tree0(XML.Text(cache.string(txt.toString)))) |
27945
d2dc5a1903e8
tuned parse performance: avoid splitting terminal Y chunk;
wenzelm
parents:
27944
diff
changeset
|
129 |
} |
27930 | 130 |
} |
131 |
} |
|
42719 | 132 |
(stack: @unchecked) match { |
38475 | 133 |
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
|
134 |
case (Markup(name, _), _) :: _ => err_unbalanced(name) |
27930 | 135 |
} |
136 |
} |
|
137 |
||
73030 | 138 |
def parse(source: CharSequence, cache: XML.Cache = XML.Cache.none): XML.Tree = |
139 |
parse_body(source, cache = cache) match { |
|
27930 | 140 |
case List(result) => result |
73028 | 141 |
case Nil => XML.no_text |
67820
e30d6368c7c8
clarified argument formats: explicit Unit, allow XML.Elem as well;
wenzelm
parents:
64370
diff
changeset
|
142 |
case _ => err("multiple XML trees") |
e30d6368c7c8
clarified argument formats: explicit Unit, allow XML.Elem as well;
wenzelm
parents:
64370
diff
changeset
|
143 |
} |
e30d6368c7c8
clarified argument formats: explicit Unit, allow XML.Elem as well;
wenzelm
parents:
64370
diff
changeset
|
144 |
|
73030 | 145 |
def parse_elem(source: CharSequence, cache: XML.Cache = XML.Cache.none): XML.Tree = |
146 |
parse_body(source, cache = cache) match { |
|
67820
e30d6368c7c8
clarified argument formats: explicit Unit, allow XML.Elem as well;
wenzelm
parents:
64370
diff
changeset
|
147 |
case List(elem: XML.Elem) => elem |
e30d6368c7c8
clarified argument formats: explicit Unit, allow XML.Elem as well;
wenzelm
parents:
64370
diff
changeset
|
148 |
case _ => err("single XML element expected") |
27930 | 149 |
} |
27960 | 150 |
|
29521 | 151 |
|
152 |
/* failsafe parsing */ |
|
153 |
||
45666 | 154 |
private def markup_broken(source: CharSequence) = |
55551 | 155 |
XML.Elem(Markup.Broken, List(XML.Text(source.toString))) |
29521 | 156 |
|
75393 | 157 |
def parse_body_failsafe(source: CharSequence, cache: XML.Cache = XML.Cache.none): XML.Body = { |
73030 | 158 |
try { parse_body(source, cache = cache) } |
45666 | 159 |
catch { case ERROR(_) => List(markup_broken(source)) } |
29521 | 160 |
} |
161 |
||
75393 | 162 |
def parse_failsafe(source: CharSequence, cache: XML.Cache = XML.Cache.none): XML.Tree = { |
73030 | 163 |
try { parse(source, cache = cache) } |
45666 | 164 |
catch { case ERROR(_) => markup_broken(source) } |
27960 | 165 |
} |
27930 | 166 |
} |