src/Pure/Thy/presentation.scala

clarified signature;

/*  Title:      Pure/Thy/presentation.scala
    Author:     Makarius

HTML presentation of PIDE document content.
*/

package isabelle


import scala.annotation.tailrec
import scala.collection.immutable.SortedMap
import scala.collection.mutable


object Presentation {
  /** HTML documents **/

  /* HTML context */

  def html_context(
    sessions_structure: Sessions.Structure,
    elements: Elements,
    root_dir: Path = Path.current,
    nodes: Nodes = Nodes.empty
  ): HTML_Context = new HTML_Context(sessions_structure, elements, root_dir, nodes)

  class HTML_Context private[Presentation](
    sessions_structure: Sessions.Structure,
    val elements: Elements,
    val root_dir: Path,
    val nodes: Nodes
  ) {
    /* directory structure and resources */

    def theory_session(name: Document.Node.Name): String =
      sessions_structure.theory_qualifier(name)

    def theory_elements(name: Document.Node.Name): Elements =
      elements.copy(entity = nodes(name.theory).others.foldLeft(elements.entity)(_ + _))

    def session_dir(session: String): Path =
      root_dir + Path.explode(sessions_structure(session).chapter_session)

    def html_name_theory(name: Document.Node.Name): String =
      Path.explode(name.theory_base_name).html.implode

    def html_name_file(src_path: Path): String =
      (Path.explode("files") + src_path.squash.html).implode

    def html_name(name: Document.Node.Name): String =
      if (name.node.endsWith(".thy")) html_name_theory(name)
      else html_name_file(name.path)

    def files_path(session: String, path: Path): Path =
      session_dir(session) + Path.explode("files") + path.squash.html

    private def session_relative(session0: String, session1: String): Option[String] = {
      for {
        info0 <- sessions_structure.get(session0)
        info1 <- sessions_structure.get(session1)
      } yield {
        if (info0.name == info1.name) ""
        else if (info0.chapter == info1.chapter) "../" + info1.name + "/"
        else "../../" + info1.chapter_session + "/"
      }
    }

    def node_relative(session0: String, node_name: Document.Node.Name): Option[String] =
      session_relative(session0, sessions_structure.theory_qualifier(node_name))


    /* HTML content */

    def head(title: String, rest: XML.Body = Nil): XML.Tree =
      HTML.div("head", HTML.chapter(title) :: rest)

    def source(body: XML.Body): XML.Tree = HTML.pre("source", body)

    def contents(
      heading: String,
      items: List[XML.Body],
      css_class: String = "contents"
    ) : List[XML.Elem] = {
      if (items.isEmpty) Nil
      else List(HTML.div(css_class, List(HTML.section(heading), HTML.itemize(items))))
    }

    val isabelle_css: String = File.read(HTML.isabelle_css)

    def html_document(title: String, body: XML.Body, fonts_css: String): HTML_Document = {
      val content =
        HTML.output_document(
          List(
            HTML.style(fonts_css + "\n\n" + isabelle_css),
            HTML.title(title)),
          List(HTML.source(body)), css = "", structural = false)
      HTML_Document(title, content)
    }
  }

  sealed case class HTML_Document(title: String, content: String)


  /* presentation elements */

  sealed case class Elements(
    html: Markup.Elements = Markup.Elements.empty,
    entity: Markup.Elements = Markup.Elements.empty,
    language: Markup.Elements = Markup.Elements.empty)

  val elements1: Elements =
    Elements(
      html = Rendering.foreground_elements ++ Rendering.text_color_elements +
        Markup.NUMERAL + Markup.COMMENT + Markup.ENTITY + Markup.LANGUAGE,
      entity = Markup.Elements(Markup.THEORY, Markup.TYPE_NAME, Markup.CONSTANT, Markup.FACT,
        Markup.CLASS, Markup.LOCALE, Markup.FREE))

  val elements2: Elements =
    Elements(
      html = elements1.html ++ Rendering.markdown_elements,
      language = Markup.Elements(Markup.Language.DOCUMENT))


  /* per-session node info */

  sealed case class File_Info(theory: String, is_theory: Boolean = false)

  object Node_Info {
    val empty: Node_Info = new Node_Info(Map.empty, Map.empty, Nil)
    def make(theory: Export_Theory.Theory): Node_Info = {
      val by_range = theory.entity_iterator.toList.groupBy(_.range)
      val by_kname = theory.entity_iterator.map(entity => entity.kname -> entity).toMap
      val others = theory.others.keySet.toList
      new Node_Info(by_range, by_kname, others)
    }
  }

  class Node_Info private(
    by_range: Map[Symbol.Range, List[Export_Theory.Entity0]],
    by_kname: Map[String, Export_Theory.Entity0],
    val others: List[String]
  ) {
    def get_defs(range: Symbol.Range): List[Export_Theory.Entity0] =
      by_range.getOrElse(range, Nil)
    def get_def(kind: String, name: String): Option[Export_Theory.Entity0] = {
      by_kname.get(Export_Theory.export_kind_name(kind, name))
    }
  }

  object Nodes {
    val empty: Nodes = new Nodes(Map.empty, Map.empty)

    def read(
      database_context: Export.Database_Context,
      deps: Sessions.Deps,
      presentation_sessions: List[String]
    ): Nodes = {

      def open_session(session: String): Export.Session_Context =
        database_context.open_session(deps.base_info(session))

      type Batch = (String, List[String])
      val batches =
        presentation_sessions.foldLeft((Set.empty[String], List.empty[Batch]))(
          { case ((seen, batches), session) =>
              val thys = deps(session).loaded_theories.keys_iterator.filterNot(seen).toList
              (seen ++ thys, (session, thys) :: batches)
          })._2

      val theory_node_info =
        Par_List.map[Batch, List[(String, Node_Info)]](
          { case (session, thys) =>
              using(open_session(session)) { session_context =>
                for (thy_name <- thys) yield {
                  val theory_context = session_context.theory(thy_name)
                  val theory = Export_Theory.read_theory(theory_context, permissive = true)
                  thy_name -> Node_Info.make(theory)
                }
              }
          }, batches).flatten.toMap

      val files_info =
        deps.sessions_structure.build_requirements(presentation_sessions).flatMap(session =>
          using(open_session(session)) { session_context =>
            session_context.theory_names().flatMap { theory =>
              session_context.theory(theory).files0(permissive = true) match {
                case Nil => Nil
                case thy :: blobs =>
                  val thy_file_info = File_Info(theory, is_theory = true)
                  (thy -> thy_file_info) :: blobs.map(_ -> File_Info(theory))
              }
            }
          }).toMap

      new Nodes(theory_node_info, files_info)
    }
  }

  class Nodes private(
    theory_node_info: Map[String, Node_Info],
    val files_info: Map[String, File_Info]
  ) {
    def apply(name: String): Node_Info = theory_node_info.getOrElse(name, Node_Info.empty)
    def get(name: String): Option[Node_Info] = theory_node_info.get(name)
  }


  /* formal entities */

  object Theory_Ref {
    def unapply(props: Properties.T): Option[Document.Node.Name] =
      (props, props, props) match {
        case (Markup.Kind(Markup.THEORY), Markup.Name(theory), Position.Def_File(thy_file)) =>
          Some(Resources.file_node(Path.explode(thy_file), theory = theory))
        case _ => None
      }
  }

  object Entity_Ref {
    def unapply(props: Properties.T): Option[(Path, Option[String], String, String)] =
      (props, props, props, props) match {
        case (Markup.Entity.Ref.Prop(_), Position.Def_File(def_file),
        Markup.Kind(kind), Markup.Name(name)) =>
          val def_theory = Position.Def_Theory.unapply(props)
          Some((Path.explode(def_file), def_theory, kind, name))
        case _ => None
      }
  }

  object Entity_Context {
    val empty: Entity_Context = new Entity_Context

    def make(
        session: String,
        node: Document.Node.Name,
        html_context: HTML_Context): Entity_Context =
      new Entity_Context {
        private val seen_ranges: mutable.Set[Symbol.Range] = mutable.Set.empty

        override def make_def(range: Symbol.Range, body: XML.Body): Option[XML.Elem] = {
          body match {
            case List(XML.Elem(Markup("span", List("id" -> _)), _)) => None
            case _ =>
              Some {
                val body1 =
                  if (seen_ranges.contains(range)) {
                    HTML.entity_def(HTML.span(HTML.id(offset_id(range)), body))
                  }
                  else HTML.span(body)
                html_context.nodes(node.theory).get_defs(range).foldLeft(body1) {
                  case (elem, entity) =>
                    HTML.entity_def(HTML.span(HTML.id(entity.kname), List(elem)))
                }
              }
          }
        }

        private def offset_id(range: Text.Range): String =
          "offset_" + range.start + ".." + range.stop

        private def physical_ref(thy_name: String, props: Properties.T): Option[String] = {
          for {
            range <- Position.Def_Range.unapply(props)
            if thy_name == node.theory
          } yield {
            seen_ranges += range
            offset_id(range)
          }
        }

        private def logical_ref(thy_name: String, kind: String, name: String): Option[String] =
          for {
            node_info <- html_context.nodes.get(thy_name)
            entity <- node_info.get_def(kind, name)
          } yield entity.kname

        override def make_ref(props: Properties.T, body: XML.Body): Option[XML.Elem] = {
          props match {
            case Theory_Ref(node_name) =>
              html_context.node_relative(session, node_name).map(html_dir =>
                HTML.link(html_dir + html_context.html_name_theory(node_name), body))
            case Entity_Ref(file_path, def_theory, kind, name) if file_path.get_ext == "thy" =>
              for {
                thy_name <-
                  def_theory orElse (if (File.eq(node.path, file_path)) Some(node.theory) else None)
                node_name = Resources.file_node(file_path, theory = thy_name)
                html_dir <- html_context.node_relative(session, node_name)
                html_file = html_context.html_name(node_name)
                html_ref <-
                  logical_ref(thy_name, kind, name) orElse physical_ref(thy_name, props)
              } yield {
                HTML.entity_ref(HTML.link(html_dir + html_file + "#" + html_ref, body))
              }
            case _ => None
          }
        }
      }
  }

  class Entity_Context {
    def make_def(range: Symbol.Range, body: XML.Body): Option[XML.Elem] = None
    def make_ref(props: Properties.T, body: XML.Body): Option[XML.Elem] = None
  }


  /* HTML output */

  private val div_elements =
    Set(HTML.div.name, HTML.pre.name, HTML.par.name, HTML.list.name, HTML.`enum`.name,
      HTML.descr.name)

  def make_html(
    entity_context: Entity_Context,
    elements: Elements,
    xml: XML.Body
  ): XML.Body = {
    def html_div(html: XML.Body): Boolean =
      html exists {
        case XML.Elem(markup, body) => div_elements.contains(markup.name) || html_div(body)
        case XML.Text(_) => false
      }

    def html_class(c: String, html: XML.Body): XML.Body =
      if (c == "") html
      else if (html_div(html)) List(HTML.div(c, html))
      else List(HTML.span(c, html))

    def html_body(xml_body: XML.Body, end_offset: Symbol.Offset): (XML.Body, Symbol.Offset) =
      xml_body.foldRight((List.empty[XML.Tree], end_offset)) { case (tree, (res, end_offset1)) =>
        val (res1, offset) = html_body_single(tree, end_offset1)
        (res1 ++ res, offset)
      }

    @tailrec
    def html_body_single(xml_tree: XML.Tree, end_offset: Symbol.Offset): (XML.Body, Symbol.Offset) =
      xml_tree match {
        case XML.Wrapped_Elem(markup, _, body) => html_body_single(XML.Elem(markup, body), end_offset)
        case XML.Elem(Markup(Markup.ENTITY, props @ Markup.Kind(kind)), body) =>
          val (body1, offset) = html_body(body, end_offset)
          if (elements.entity(kind)) {
            entity_context.make_ref(props, body1) match {
              case Some(link) => (List(link), offset)
              case None => (body1, offset)
            }
          }
          else (body1, offset)
        case XML.Elem(Markup(Markup.LANGUAGE, Markup.Name(name)), body) =>
          val (body1, offset) = html_body(body, end_offset)
          (html_class(if (elements.language(name)) name else "", body1), offset)
        case XML.Elem(Markup(Markup.MARKDOWN_PARAGRAPH, _), body) =>
          val (body1, offset) = html_body(body, end_offset)
          (List(HTML.par(body1)), offset)
        case XML.Elem(Markup(Markup.MARKDOWN_ITEM, _), body) =>
          val (body1, offset) = html_body(body, end_offset)
          (List(HTML.item(body1)), offset)
        case XML.Elem(Markup(Markup.Markdown_Bullet.name, _), text) =>
          (Nil, end_offset - XML.symbol_length(text))
        case XML.Elem(Markup.Markdown_List(kind), body) =>
          val (body1, offset) = html_body(body, end_offset)
          if (kind == Markup.ENUMERATE) (List(HTML.`enum`(body1)), offset)
          else (List(HTML.list(body1)), offset)
        case XML.Elem(markup, body) =>
          val name = markup.name
          val (body1, offset) = html_body(body, end_offset)
          val html =
            markup.properties match {
              case Markup.Kind(kind) if kind == Markup.COMMAND || kind == Markup.KEYWORD =>
                html_class(kind, body1)
              case _ =>
                body1
            }
          Rendering.foreground.get(name) orElse Rendering.text_color.get(name) match {
            case Some(c) => (html_class(c.toString, html), offset)
            case None => (html_class(name, html), offset)
          }
        case XML.Text(text) =>
          val offset = end_offset - Symbol.length(text)
          val body = HTML.text(Symbol.decode(text))
          entity_context.make_def(Text.Range(offset, end_offset), body) match {
            case Some(body1) => (List(body1), offset)
            case None => (body, offset)
          }
      }

    html_body(xml, XML.symbol_length(xml) + 1)._1
  }


  /* PIDE HTML document */

  def html_document(
    snapshot: Document.Snapshot,
    html_context: HTML_Context,
    plain_text: Boolean = false,
    fonts_css: String = HTML.fonts_css()
  ): HTML_Document = {
    require(!snapshot.is_outdated, "document snapshot outdated")

    val name = snapshot.node_name
    if (plain_text) {
      val title = "File " + Symbol.cartouche_decoded(name.path.file_name)
      val body = HTML.text(snapshot.node.source)
      html_context.html_document(title, body, fonts_css)
    }
    else {
      Resources.html_document(snapshot) getOrElse {
        val title =
          if (name.is_theory) "Theory " + quote(name.theory_base_name)
          else "File " + Symbol.cartouche_decoded(name.path.file_name)
        val xml = snapshot.xml_markup(elements = html_context.elements.html)
        val body = make_html(Entity_Context.empty, html_context.elements, xml)
        html_context.html_document(title, body, fonts_css)
      }
    }
  }



  /** HTML presentation **/

  /* presentation context */

  object Context {
    val none: Context = new Context { def enabled: Boolean = false }
    val standard: Context = new Context { def enabled: Boolean = true }

    def dir(path: Path): Context =
      new Context {
        def enabled: Boolean = true
        override def dir(store: Sessions.Store): Path = path
      }

    def make(s: String): Context =
      if (s == ":") standard else dir(Path.explode(s))
  }

  abstract class Context private {
    def enabled: Boolean
    def enabled(info: Sessions.Info): Boolean = enabled || info.browser_info
    def dir(store: Sessions.Store): Path = store.presentation_dir
  }


  /* maintain chapter index */

  private val sessions_path = Path.basic(".sessions")

  private def read_sessions(dir: Path): List[(String, String)] = {
    val path = dir + sessions_path
    if (path.is_file) {
      import XML.Decode._
      list(pair(string, string))(Symbol.decode_yxml(File.read(path)))
    }
    else Nil
  }

  def update_chapter(
    presentation_dir: Path,
    chapter: String,
    new_sessions: List[(String, String)]
  ): Unit = {
    val dir = Isabelle_System.make_directory(presentation_dir + Path.basic(chapter))

    val sessions0 =
      try { read_sessions(dir) }
      catch { case _: XML.Error => Nil }

    val sessions = (SortedMap.empty[String, String] ++ sessions0 ++ new_sessions).toList
    File.write(dir + sessions_path,
      {
        import XML.Encode._
        YXML.string_of_body(list(pair(string, string))(sessions))
      })

    val title = "Isabelle/" + chapter + " sessions"
    HTML.write_document(dir, "index.html",
      List(HTML.title(title + Isabelle_System.isabelle_heading())),
      HTML.chapter(title) ::
       (if (sessions.isEmpty) Nil
        else
          List(HTML.div("sessions",
            List(HTML.description(
              sessions.map({ case (name, description) =>
                val descr = Symbol.trim_blank_lines(description)
                (List(HTML.link(name + "/index.html", HTML.text(name))),
                  if (descr == "") Nil
                  else HTML.break ::: List(HTML.pre(HTML.text(descr)))) })))))),
      base = Some(presentation_dir))
  }

  def update_root(presentation_dir: Path): Unit = {
    Isabelle_System.make_directory(presentation_dir)
    HTML.init_fonts(presentation_dir)
    Isabelle_System.copy_file(Path.explode("~~/lib/logo/isabelle.gif"),
      presentation_dir + Path.explode("isabelle.gif"))
    val title = "The " + XML.text(Isabelle_System.isabelle_name()) + " Library"
    File.write(presentation_dir + Path.explode("index.html"),
      HTML.header +
"""
<head>
  """ + HTML.head_meta + """
  <title>""" + title + """</title>
</head>

<body text="#000000" bgcolor="#FFFFFF" link="#0000FF" vlink="#000099" alink="#404040">
  <center>
    <table width="100%" border="0" cellspacing="10" cellpadding="0">
      <tr>
        <td width="20%" valign="middle" align="center"><a href="https://isabelle.in.tum.de/"><img align="bottom" src="isabelle.gif" width="100" height="86" alt="[Isabelle]" border="0" /></a></td>

        <td width="80%" valign="middle" align="center">
          <table width="90%" border="0" cellspacing="0" cellpadding="20">
            <tr>
              <td valign="middle" align="center" bgcolor="#AACCCC"><font face="Helvetica,Arial" size="+2">""" + title + """</font></td>
            </tr>
          </table>
        </td>
      </tr>
    </table>
  </center>
  <hr />
""" + File.read(Path.explode("~~/lib/html/library_index_content.template")) +
"""
</body>
""" + HTML.footer)
  }


  /* present session */

  val session_graph_path: Path = Path.explode("session_graph.pdf")
  val readme_path: Path = Path.explode("README.html")

  def session_html(
    html_context: HTML_Context,
    session_context: Export.Session_Context,
    progress: Progress = new Progress,
    verbose: Boolean = false,
  ): Unit = {
    val session = session_context.session_name
    val info = session_context.sessions_structure(session)
    val options = info.options
    val base = session_context.session_base

    val session_dir =
      Isabelle_System.make_directory(html_context.session_dir(session)).expand

    progress.echo("Presenting " + session + " in " + session_dir + " ...")

    Bytes.write(session_dir + session_graph_path,
      graphview.Graph_File.make_pdf(options, base.session_graph_display))

    val documents =
      for {
        doc <- info.document_variants
        db <- session_context.session_db()
        document <- Document_Build.read_document(db, session, doc.name)
      }
      yield {
        val doc_path = session_dir + doc.path.pdf
        if (verbose) progress.echo("Presenting document " + session + "/" + doc.name)
        if (options.bool("document_echo")) progress.echo("Document at " + doc_path)
        Bytes.write(doc_path, document.pdf)
        doc
      }

    val view_links = {
      val deps_link =
        HTML.link(session_graph_path, HTML.text("theory dependencies"))

      val readme_links =
        if ((info.dir + readme_path).is_file) {
          Isabelle_System.copy_file(info.dir + readme_path, session_dir + readme_path)
          List(HTML.link(readme_path, HTML.text("README")))
        }
        else Nil

      val document_links =
        documents.map(doc => HTML.link(doc.path.pdf, HTML.text(doc.name)))

      Library.separate(HTML.break ::: HTML.nl,
        (deps_link :: readme_links ::: document_links).
          map(link => HTML.text("View ") ::: List(link))).flatten
    }

    def present_theory(name: Document.Node.Name): Option[XML.Body] = {
      progress.expose_interrupt()

      Build_Job.read_theory(session_context.theory(name.theory)).map { command =>
        if (verbose) progress.echo("Presenting theory " + name)
        val snapshot = Document.State.init.snippet(command)

        val thy_elements = html_context.theory_elements(name)

        val thy_html =
          html_context.source(
            make_html(Entity_Context.make(session, name, html_context),
              thy_elements, snapshot.xml_markup(elements = thy_elements.html)))

        val files_html =
          for {
            (src_path, xml) <- snapshot.xml_markup_blobs(elements = thy_elements.html)
            if xml.nonEmpty
          }
          yield {
            progress.expose_interrupt()
            if (verbose) progress.echo("Presenting file " + src_path)
            (src_path, html_context.source(make_html(Entity_Context.empty, thy_elements, xml)))
          }

        val files =
          for {
            (src_path, file_html) <- files_html
            file_path = html_context.files_path(session, src_path)
            rel_path <- File.relative_path(session_dir, file_path)
          }
          yield {
            val file_title = "File " + Symbol.cartouche_decoded(src_path.implode_short)
            HTML.write_document(file_path.dir, file_path.file_name,
              List(HTML.title(file_title)), List(html_context.head(file_title), file_html),
              base = Some(html_context.root_dir))
            List(HTML.link(rel_path.implode, HTML.text(file_title)))
          }

        val thy_title = "Theory " + name.theory_base_name

        HTML.write_document(session_dir, html_context.html_name_theory(name),
          List(HTML.title(thy_title)), List(html_context.head(thy_title), thy_html),
          base = Some(html_context.root_dir))

        List(HTML.link(html_context.html_name_theory(name),
          HTML.text(name.theory_base_name) :::
            (if (files.isEmpty) Nil else List(HTML.itemize(files)))))
      }
    }

    val theories = base.proper_session_theories.flatMap(present_theory)

    val title = "Session " + session
      HTML.write_document(session_dir, "index.html",
        List(HTML.title(title + Isabelle_System.isabelle_heading())),
        html_context.head(title, List(HTML.par(view_links))) ::
          html_context.contents("Theories", theories),
        base = Some(html_context.root_dir))
  }
}