Scala example source code file (DiagramGenerator.scala)

This example Scala source code file (DiagramGenerator.scala) is included in my "Source Code Warehouse" project. The intent of this project is to help you more easily find Scala source code examples by using tags.

All credit for the original source code belongs to scala-lang.org; I'm just trying to make examples easier to find. (For my Scala work, see my Scala examples and tutorials.)

Scala tags/keywords

compiler, diagram, diagramgenerator, doctemplateentity, dotrunner, htmlpage, nsc, xml

The DiagramGenerator.scala Scala example source code

/**
 * @author Damien Obrist
 * @author Vlad Ureche
 */
package scala.tools.nsc
package doc
package html
package page
package diagram

import scala.xml.NodeSeq
import scala.tools.nsc.doc.html.HtmlPage
import scala.tools.nsc.doc.model.diagram.Diagram
import scala.tools.nsc.doc.model.DocTemplateEntity

trait DiagramGenerator {

  /**
   * Generates a visualization of the internal representation
   * of a diagram.
   *
   * @param d   The model of the diagram
   * @param p   The page the diagram will be embedded in (needed for link generation)
   * @return    The HTML to be embedded in the Scaladoc page
   */
  def generate(d: Diagram, t: DocTemplateEntity, p: HtmlPage):NodeSeq
}

object DiagramGenerator {

  // TODO: This is tailored towards the dot generator, since it's the only generator. In the future it should be more
  // general.

  private[this] var dotRunner: DotRunner = null
  private[this] var settings: doc.Settings = null

  def initialize(s: doc.Settings) =
    settings = s

  def getDotRunner() = {
    if (dotRunner == null)
      dotRunner = new DotRunner(settings)
    dotRunner
  }

  def cleanup() = {
    DiagramStats.printStats(settings)
    if (dotRunner != null) {
      dotRunner.cleanup()
      dotRunner = null
    }
  }
}