src/Pure/General/xml.scala

pass raw messages through xml_cache actor, which is important to retain ordering of results (e.g. read_command reports before assign, cf. 383c9d758a56);

/*  Title:      Pure/General/xml.scala
    Author:     Makarius

Untyped XML trees.
*/

package isabelle

import java.lang.System
import java.util.WeakHashMap
import java.lang.ref.WeakReference
import javax.xml.parsers.DocumentBuilderFactory

import scala.actors.Actor._
import scala.collection.mutable


object XML
{
  /** XML trees **/

  /* datatype representation */

  type Attributes = Properties.T

  sealed abstract class Tree { override def toString = string_of_tree(this) }
  case class Elem(markup: Markup, body: List[Tree]) extends Tree
  case class Text(content: String) extends Tree

  def elem(name: String, body: List[Tree]) = Elem(Markup(name, Nil), body)
  def elem(name: String) = Elem(Markup(name, Nil), Nil)

  type Body = List[Tree]


  /* string representation */

  def string_of_body(body: Body): String =
  {
    val s = new StringBuilder

    def text(txt: String) {
      if (txt == null) s ++= txt
      else {
        for (c <- txt.iterator) c match {
          case '<' => s ++= "&lt;"
          case '>' => s ++= "&gt;"
          case '&' => s ++= "&amp;"
          case '"' => s ++= "&quot;"
          case '\'' => s ++= "&apos;"
          case _ => s += c
        }
      }
    }
    def attrib(p: (String, String)) { s ++= " "; s ++= p._1; s ++= "=\""; text(p._2); s ++= "\"" }
    def elem(markup: Markup) { s ++= markup.name; markup.properties.foreach(attrib) }
    def tree(t: Tree): Unit =
      t match {
        case Elem(markup, Nil) =>
          s ++= "<"; elem(markup); s ++= "/>"
        case Elem(markup, ts) =>
          s ++= "<"; elem(markup); s ++= ">"
          ts.foreach(tree)
          s ++= "</"; s ++= markup.name; s ++= ">"
        case Text(txt) => text(txt)
      }
    body.foreach(tree)
    s.toString
  }

  def string_of_tree(tree: XML.Tree): String = string_of_body(List(tree))


  /* text content */

  def content_stream(tree: Tree): Stream[String] =
    tree match {
      case Elem(_, body) => content_stream(body)
      case Text(content) => Stream(content)
    }
  def content_stream(body: Body): Stream[String] =
    body.toStream.flatten(content_stream(_))

  def content(tree: Tree): Iterator[String] = content_stream(tree).iterator
  def content(body: Body): Iterator[String] = content_stream(body).iterator


  /* pipe-lined cache for partial sharing */

  class Cache(initial_size: Int = 131071, max_string: Int = 100)
  {
    private val cache_actor = actor
    {
      val table = new WeakHashMap[Any, WeakReference[Any]](initial_size)

      def lookup[A](x: A): Option[A] =
      {
        val ref = table.get(x)
        if (ref == null) None
        else {
          val y = ref.asInstanceOf[WeakReference[A]].get
          if (y == null) None
          else Some(y)
        }
      }
      def store[A](x: A): A =
      {
        table.put(x, new WeakReference[Any](x))
        x
      }

      def trim_bytes(s: String): String = new String(s.toCharArray)

      def cache_string(x: String): String =
        lookup(x) match {
          case Some(y) => y
          case None =>
            val z = trim_bytes(x)
            if (z.length > max_string) z else store(z)
        }
      def cache_props(x: Properties.T): Properties.T =
        if (x.isEmpty) x
        else
          lookup(x) match {
            case Some(y) => y
            case None => store(x.map(p => (trim_bytes(p._1).intern, cache_string(p._2))))
          }
      def cache_markup(x: Markup): Markup =
        lookup(x) match {
          case Some(y) => y
          case None =>
            x match {
              case Markup(name, props) =>
                store(Markup(cache_string(name), cache_props(props)))
            }
        }
      def cache_tree(x: XML.Tree): XML.Tree =
        lookup(x) match {
          case Some(y) => y
          case None =>
            x match {
              case XML.Elem(markup, body) =>
                store(XML.Elem(cache_markup(markup), cache_body(body)))
              case XML.Text(text) => store(XML.Text(cache_string(text)))
            }
        }
      def cache_body(x: XML.Body): XML.Body =
        if (x.isEmpty) x
        else
          lookup(x) match {
            case Some(y) => y
            case None => x.map(cache_tree(_))
          }

      // main loop
      loop {
        react {
          case Cache_String(x, f) => f(cache_string(x))
          case Cache_Markup(x, f) => f(cache_markup(x))
          case Cache_Tree(x, f) => f(cache_tree(x))
          case Cache_Body(x, f) => f(cache_body(x))
          case Cache_Ignore(x, f) => f(x)
          case bad => System.err.println("XML.cache_actor: ignoring bad input " + bad)
        }
      }
    }

    private case class Cache_String(x: String, f: String => Unit)
    private case class Cache_Markup(x: Markup, f: Markup => Unit)
    private case class Cache_Tree(x: XML.Tree, f: XML.Tree => Unit)
    private case class Cache_Body(x: XML.Body, f: XML.Body => Unit)
    private case class Cache_Ignore[A](x: A, f: A => Unit)

    // main methods
    def cache_string(x: String)(f: String => Unit) { cache_actor ! Cache_String(x, f) }
    def cache_markup(x: Markup)(f: Markup => Unit) { cache_actor ! Cache_Markup(x, f) }
    def cache_tree(x: XML.Tree)(f: XML.Tree => Unit) { cache_actor ! Cache_Tree(x, f) }
    def cache_body(x: XML.Body)(f: XML.Body => Unit) { cache_actor ! Cache_Body(x, f) }
    def cache_ignore[A](x: A)(f: A => Unit) { cache_actor ! Cache_Ignore(x, f) }
  }



  /** document object model (W3C DOM) **/

  def get_data(node: org.w3c.dom.Node): Option[XML.Tree] =
    node.getUserData(Markup.Data.name) match {
      case tree: XML.Tree => Some(tree)
      case _ => None
    }

  def document_node(doc: org.w3c.dom.Document, tree: Tree): org.w3c.dom.Node =
  {
    def DOM(tr: Tree): org.w3c.dom.Node = tr match {
      case Elem(Markup.Data, List(data, t)) =>
        val node = DOM(t)
        node.setUserData(Markup.Data.name, data, null)
        node
      case Elem(Markup(name, atts), ts) =>
        if (name == Markup.Data.name)
          error("Malformed data element: " + tr.toString)
        val node = doc.createElement(name)
        for ((name, value) <- atts) node.setAttribute(name, value)
        for (t <- ts) node.appendChild(DOM(t))
        node
      case Text(txt) => doc.createTextNode(txt)
    }
    DOM(tree)
  }



  /** XML as data representation language **/

  class XML_Atom(s: String) extends Exception(s)
  class XML_Body(body: XML.Body) extends Exception

  object Encode
  {
    type T[A] = A => XML.Body


    /* atomic values */

    def long_atom(i: Long): String = i.toString

    def int_atom(i: Int): String = i.toString

    def bool_atom(b: Boolean): String = if (b) "1" else "0"

    def unit_atom(u: Unit) = ""


    /* structural nodes */

    private def node(ts: XML.Body): XML.Tree = XML.Elem(Markup(":", Nil), ts)

    private def vector(xs: List[String]): XML.Attributes =
      xs.zipWithIndex.map(p => (int_atom(p._2), p._1))

    private def tagged(tag: Int, data: (List[String], XML.Body)): XML.Tree =
      XML.Elem(Markup(int_atom(tag), vector(data._1)), data._2)


    /* representation of standard types */

    val properties: T[Properties.T] =
      (props => List(XML.Elem(Markup(":", props), Nil)))

    val string: T[String] = (s => if (s.isEmpty) Nil else List(XML.Text(s)))

    val long: T[Long] = (x => string(long_atom(x)))

    val int: T[Int] = (x => string(int_atom(x)))

    val bool: T[Boolean] = (x => string(bool_atom(x)))

    val unit: T[Unit] = (x => string(unit_atom(x)))

    def pair[A, B](f: T[A], g: T[B]): T[(A, B)] =
      (x => List(node(f(x._1)), node(g(x._2))))

    def triple[A, B, C](f: T[A], g: T[B], h: T[C]): T[(A, B, C)] =
      (x => List(node(f(x._1)), node(g(x._2)), node(h(x._3))))

    def list[A](f: T[A]): T[List[A]] =
      (xs => xs.map((x: A) => node(f(x))))

    def option[A](f: T[A]): T[Option[A]] =
    {
      case None => Nil
      case Some(x) => List(node(f(x)))
    }

    def variant[A](fs: List[PartialFunction[A, (List[String], XML.Body)]]): T[A] =
    {
      case x =>
        val (f, tag) = fs.iterator.zipWithIndex.find(p => p._1.isDefinedAt(x)).get
        List(tagged(tag, f(x)))
    }
  }

  object Decode
  {
    type T[A] = XML.Body => A
    type V[A] = (List[String], XML.Body) => A


    /* atomic values */

    def long_atom(s: String): Long =
      try { java.lang.Long.parseLong(s) }
      catch { case e: NumberFormatException => throw new XML_Atom(s) }

    def int_atom(s: String): Int =
      try { Integer.parseInt(s) }
      catch { case e: NumberFormatException => throw new XML_Atom(s) }

    def bool_atom(s: String): Boolean =
      if (s == "1") true
      else if (s == "0") false
      else throw new XML_Atom(s)

    def unit_atom(s: String): Unit =
      if (s == "") () else throw new XML_Atom(s)


    /* structural nodes */

    private def node(t: XML.Tree): XML.Body =
      t match {
        case XML.Elem(Markup(":", Nil), ts) => ts
        case _ => throw new XML_Body(List(t))
      }

    private def vector(atts: XML.Attributes): List[String] =
    {
      val xs = new mutable.ListBuffer[String]
      var i = 0
      for ((a, x) <- atts) {
        if (int_atom(a) == i) { xs += x; i = i + 1 }
        else throw new XML_Atom(a)
      }
      xs.toList
    }

    private def tagged(t: XML.Tree): (Int, (List[String], XML.Body)) =
      t match {
        case XML.Elem(Markup(name, atts), ts) => (int_atom(name), (vector(atts), ts))
        case _ => throw new XML_Body(List(t))
      }


    /* representation of standard types */

    val properties: T[Properties.T] =
    {
      case List(XML.Elem(Markup(":", props), Nil)) => props
      case ts => throw new XML_Body(ts)
    }

    val string: T[String] =
    {
      case Nil => ""
      case List(XML.Text(s)) => s
      case ts => throw new XML_Body(ts)
    }

    val long: T[Long] = (x => long_atom(string(x)))

    val int: T[Int] = (x => int_atom(string(x)))

    val bool: T[Boolean] = (x => bool_atom(string(x)))

    val unit: T[Unit] = (x => unit_atom(string(x)))

    def pair[A, B](f: T[A], g: T[B]): T[(A, B)] =
    {
      case List(t1, t2) => (f(node(t1)), g(node(t2)))
      case ts => throw new XML_Body(ts)
    }

    def triple[A, B, C](f: T[A], g: T[B], h: T[C]): T[(A, B, C)] =
    {
      case List(t1, t2, t3) => (f(node(t1)), g(node(t2)), h(node(t3)))
      case ts => throw new XML_Body(ts)
    }

    def list[A](f: T[A]): T[List[A]] =
      (ts => ts.map(t => f(node(t))))

    def option[A](f: T[A]): T[Option[A]] =
    {
      case Nil => None
      case List(t) => Some(f(node(t)))
      case ts => throw new XML_Body(ts)
    }

    def variant[A](fs: List[V[A]]): T[A] =
    {
      case List(t) =>
        val (tag, (xs, ts)) = tagged(t)
        val f =
          try { fs(tag) }
          catch { case _: IndexOutOfBoundsException => throw new XML_Body(List(t)) }
        f(xs, ts)
      case ts => throw new XML_Body(ts)
    }
  }
}