/* NSC -- new Scala compiler * Copyright 2007-2013 LAMP/EPFL * @author David Bernard, Manohar Jonnalagedda */ package scala.tools.nsc package doc package html import base._ import base.comment._ import model._ import scala.xml.NodeSeq import scala.xml.dtd.{DocType, PublicID} import scala.collection._ import java.io.Writer /** An html page that is part of a Scaladoc site. * @author David Bernard * @author Gilles Dubochet */ abstract class HtmlPage extends Page { thisPage => /** The title of this page. */ protected def title: String /** The page description */ protected def description: String = // unless overwritten, will display the title in a spaced format, keeping - and . title.replaceAll("[^a-zA-Z0-9\\.\\-]+", " ").replaceAll("\\-+", " - ").replaceAll(" +", " ") /** The page keywords */ protected def keywords: String = // unless overwritten, same as description, minus the " - " description.replaceAll(" - ", " ") /** Additional header elements (links, scripts, meta tags, etc.) required for this page. */ protected def headers: NodeSeq /** The body of this page. */ def body: NodeSeq def writeFor(site: HtmlFactory) { val doctype = DocType("html", PublicID("-//W3C//DTD XHTML 1.1//EN", "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"), Nil) val html = { title } \n") w.write(doctype.toString + "\n") w.write(xml.Xhtml.toXhtml(html)) } if (site.universe.settings.docRawOutput.value) writeFile(site, ".raw") { // we're only interested in the body, as this will go into the diff _.write(body.text) } //XML.save(pageFile.getPath, html, site.encoding, xmlDecl = false, doctype = doctype) } /** Transforms an optional comment into an styled HTML tree representing its body if it is defined, or into an empty * node sequence if it is not. */ def commentToHtml(comment: Option[Comment]): NodeSeq = (comment map (commentToHtml(_))) getOrElse NodeSeq.Empty /** Transforms a comment into an styled HTML tree representing its body. */ def commentToHtml(comment: Comment): NodeSeq = bodyToHtml(comment.body) def bodyToHtml(body: Body): NodeSeq = body.blocks flatMap (blockToHtml(_)) def blockToHtml(block: Block): NodeSeq = block match { case Title(in, 1) =>

{ inlineToHtml(in) }

case Title(in, 2) =>

{ inlineToHtml(in) }

case Title(in, 3) =>
{ inlineToHtml(in) }
case Title(in, _) =>
{ inlineToHtml(in) }
case Paragraph(in) =>

{ inlineToHtml(in) }

case Code(data) => 
{ SyntaxHigh(data) }
//
{ scala.xml.Text(data) }
case UnorderedList(items) => case OrderedList(items, listStyle) =>
    { listItemsToHtml(items) }
case DefinitionList(items) =>
{items map { case (t, d) =>
{ inlineToHtml(t) }
{ blockToHtml(d) }
} }
case HorizontalRule() =>
} def listItemsToHtml(items: Seq[Block]) = items.foldLeft(xml.NodeSeq.Empty){ (xmlList, item) => item match { case OrderedList(_, _) | UnorderedList(_) => // html requires sub ULs to be put into the last LI xmlList.init ++
  • { xmlList.last.child ++ blockToHtml(item) }
    • case Paragraph(inline) => xmlList :+
  • { inlineToHtml(inline) }
    • // LIs are blocks, no need to use Ps case block => xmlList :+
  • { blockToHtml(block) }
    • } } def inlineToHtml(inl: Inline): NodeSeq = inl match { case Chain(items) => items flatMap (inlineToHtml(_)) case Italic(in) => { inlineToHtml(in) } case Bold(in) => { inlineToHtml(in) } case Underline(in) => { inlineToHtml(in) } case Superscript(in) => { inlineToHtml(in) } case Subscript(in) => { inlineToHtml(in) } case Link(raw, title) => { inlineToHtml(title) } case Monospace(in) => { inlineToHtml(in) } case Text(text) => scala.xml.Text(text) case Summary(in) => inlineToHtml(in) case HtmlTag(tag) => scala.xml.Unparsed(tag) case EntityLink(target, link) => linkToHtml(target, link, true) } def linkToHtml(text: Inline, link: LinkTo, hasLinks: Boolean) = link match { case LinkToTpl(dtpl: TemplateEntity) => if (hasLinks) { inlineToHtml(text) } else { inlineToHtml(text) } case LinkToMember(mbr: MemberEntity, inTpl: TemplateEntity) => if (hasLinks) { inlineToHtml(text) } else { inlineToHtml(text) } case Tooltip(tooltip) => { inlineToHtml(text) } case LinkToExternal(name, url) => { inlineToHtml(text) } case _ => inlineToHtml(text) } def typeToHtml(tpes: List[model.TypeEntity], hasLinks: Boolean): NodeSeq = tpes match { case Nil => NodeSeq.Empty case List(tpe) => typeToHtml(tpe, hasLinks) case tpe :: rest => typeToHtml(tpe, hasLinks) ++ scala.xml.Text(" with ") ++ typeToHtml(rest, hasLinks) } def typeToHtml(tpe: model.TypeEntity, hasLinks: Boolean): NodeSeq = { val string = tpe.name def toLinksOut(inPos: Int, starts: List[Int]): NodeSeq = { if (starts.isEmpty && (inPos == string.length)) NodeSeq.Empty else if (starts.isEmpty) scala.xml.Text(string.slice(inPos, string.length)) else if (inPos == starts.head) toLinksIn(inPos, starts) else { scala.xml.Text(string.slice(inPos, starts.head)) ++ toLinksIn(starts.head, starts) } } def toLinksIn(inPos: Int, starts: List[Int]): NodeSeq = { val (link, width) = tpe.refEntity(inPos) val text = comment.Text(string.slice(inPos, inPos + width)) linkToHtml(text, link, hasLinks) ++ toLinksOut(inPos + width, starts.tail) } if (hasLinks) toLinksOut(0, tpe.refEntity.keySet.toList) else scala.xml.Text(string) } def typesToHtml(tpess: List[model.TypeEntity], hasLinks: Boolean, sep: NodeSeq): NodeSeq = tpess match { case Nil => NodeSeq.Empty case tpe :: Nil => typeToHtml(tpe, hasLinks) case tpe :: tpes => typeToHtml(tpe, hasLinks) ++ sep ++ typesToHtml(tpes, hasLinks, sep) } def hasPage(e: DocTemplateEntity) = { e.isPackage || e.isTrait || e.isClass || e.isObject || e.isCaseClass } /** Returns the HTML code that represents the template in `tpl` as a hyperlinked name. */ def templateToHtml(tpl: TemplateEntity, name: String = null) = tpl match { case dTpl: DocTemplateEntity => if (hasPage(dTpl)) { { if (name eq null) dTpl.name else name } } else { scala.xml.Text(if (name eq null) dTpl.name else name) } case ndTpl: NoDocTemplate => scala.xml.Text(if (name eq null) ndTpl.name else name) } /** Returns the HTML code that represents the templates in `tpls` as a list of hyperlinked names. */ def templatesToHtml(tplss: List[TemplateEntity], sep: NodeSeq): NodeSeq = tplss match { case Nil => NodeSeq.Empty case tpl :: Nil => templateToHtml(tpl) case tpl :: tpls => templateToHtml(tpl) ++ sep ++ templatesToHtml(tpls, sep) } /** Returns the _big image name corresponding to the DocTemplate Entity (upper left icon) */ def docEntityKindToBigImage(ety: DocTemplateEntity) = if (ety.isTrait && !ety.companion.isEmpty && ety.companion.get.visibility.isPublic && ety.companion.get.inSource != None) "trait_to_object_big.png" else if (ety.isTrait) "trait_big.png" else if (ety.isClass && !ety.companion.isEmpty && ety.companion.get.visibility.isPublic && ety.companion.get.inSource != None) "class_to_object_big.png" else if (ety.isClass) "class_big.png" else if ((ety.isAbstractType || ety.isAliasType) && !ety.companion.isEmpty && ety.companion.get.visibility.isPublic && ety.companion.get.inSource != None) "type_to_object_big.png" else if ((ety.isAbstractType || ety.isAliasType)) "type_big.png" else if (ety.isObject && !ety.companion.isEmpty && ety.companion.get.visibility.isPublic && ety.companion.get.inSource != None && ety.companion.get.isClass) "object_to_class_big.png" else if (ety.isObject && !ety.companion.isEmpty && ety.companion.get.visibility.isPublic && ety.companion.get.inSource != None && ety.companion.get.isTrait) "object_to_trait_big.png" else if (ety.isObject && !ety.companion.isEmpty && ety.companion.get.visibility.isPublic && ety.companion.get.inSource != None && (ety.companion.get.isAbstractType || ety.companion.get.isAliasType)) "object_to_trait_big.png" else if (ety.isObject) "object_big.png" else if (ety.isPackage) "package_big.png" else "class_big.png" // FIXME: an entity *should* fall into one of the above categories, but AnyRef is somehow not }