aboutsummaryrefslogtreecommitdiff
path: root/dottydoc/jvm/src/dotty/tools/dottydoc/html/EntityPage.scala
blob: cfac8333df067deafde538f235474efffcb701b6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
package dotty.tools.dottydoc
package html

import scalatags.Text.all._
import model.internal._
import model._

case class EntityPage(entity: Entity, packages: Map[String, Package]) {
  import CustomTags._
  import model.pickling._
  import prickle._
  import util.internal.setters._

  private def relPath(to: String, from: Entity) = {
    val len = from.path.length + (from match {
      case _: Package => 1
      case _ => 0
    })

    "../" * len + to
  }

  def render = "<!DOCTYPE html>" + html(
    head(
      meta(charset := "utf-8"),
      meta(name := "viewport",
           content := "width=device-width, initial-scale=1, shrink-to-fit=no"),
      meta("http-equiv".attr := "x-ua-compatible", content := "ie=edge"),

      script(`type` := "text/javascript", src := relPath("static/material.min.js", entity)),
      script(`type` := "text/javascript", src := relPath("static/highlight.pack.js", entity)),
      script(`type` := "text/javascript", src := relPath("index.js", entity)),
      script(`type` := "text/javascript", src := relPath("target/scala-2.11/dottydoc-fastopt.js", entity)),
      link(rel := "stylesheet", href := relPath("static/material-icons.css", entity)),
      link(rel := "stylesheet", href := relPath("static/material.min.css", entity)),
      link(rel := "stylesheet", href := relPath("static/github.css", entity)),
      link(rel := "stylesheet", href := relPath("static/index.css", entity))
    ),
    body(
      div(
        id := "main-container",
        div(
          cls := "mdl-layout mdl-js-layout mdl-layout--fixed-drawer",
          div(
            cls := "mdl-layout__drawer",
            span(
              cls := "mdl-layout-title subtitle",
              entity.path.dropRight(1).mkString(".")
            ),
            span(
              cls := "mdl-layout-title",
              entity match {
                case p: Package => p.name.split("\\.").last
                case e => e.name
              }
            ),
            nav(
              cls := "related mdl-navigation",
              companionAnchor,
              a(cls := "mdl-navigation__link", href := "#", "Source")
            ),
            span(
              cls := "mdl-layout-title",
              id := "docs-title",
              "Docs"
            ),
            searchView,
            packageView
          ),
          main(
            id := "entity-container",
            cls := "mdl-layout__content"
          )
        )
      )
    ),
    script(
      raw(s"""|UnparsedIndex.currentEntity = ${Pickle.intoString(entity.flat)};
              |dotty.tools.dottydoc.js.DottyDocJS()
              |     .main(document.getElementById("entity-container"));
           """.stripMargin)
    )
  )

  private def relativePath(to: Entity) = {
    val prefix = entity match {
      case _: Package => "../"
      case _ => ""
    }
    prefix + util.traversing.relativePath(entity, to)
  }

  def packageView = ul(
    cls := "mdl-list packages",
    {
      val keys: Seq[String] = packages.keys.toSeq.sorted
      val productReg = """^Product[0-9]+$""".r
      keys.flatMap { k =>
        val pack = packages(k)
        val children =
          pack.children
            .sortBy(_.name)
            .filterNot { ent =>
              // Filter out ProductX where X > 3
              productReg.findFirstIn(ent.name).map(_.slice(7, 99).toInt > 3).getOrElse(false) ||
              // Filter out packages
              ent.kind == "package" ||
              // Filter out objects that have companions
              (ent.kind == "object" && companion(ent).isDefined) ||
              ent.name == "AnyValCompanion"
            }
            .map { entity =>
              val comp = companion(entity)
              val entityUrl = relativePath(entity)
              val compUrl = comp.map(relativePath).getOrElse("#")
              li(
                cls := s"""mdl-list__item entity ${ if (comp.isDefined) "two" else "one" }""",
                comp.map { _ => a(cls := "entity-button object", href := compUrl, "O") }.getOrElse(()),
                a(
                  cls := s"""entity-button shadowed ${entity.kind.replaceAll(" ", "")}""",
                  href := entityUrl,
                  entity.kind(0).toUpper.toString
                ),
                a(
                  cls := "entity-name",
                  href := entityUrl,
                  entity.name
                )
              )
            }

        if (children.length > 0)
          li(cls := "mdl-list__item package", href := relativePath(pack), k) :: children
        else Nil
      }
    }
  )

  def companion(entity: Entity) = {
    val pack = entity.path.dropRight(1).mkString(".")
    (for {
      p     <- packages.get(pack)
      child <- p.children.find(e => e.name == entity.name && e.path.last != entity.path.last)
    } yield child)
  }

  def companionAnchor = {
    companion(entity).map { c =>
      a(
        cls := "mdl-navigation__link",
        href := c.path.last + ".html",
        "Companion " + c.kind
      )
    }.getOrElse(span())
  }

  def searchView = div(
    cls := "search-container",
    div(
      cls := "mdl-textfield mdl-js-textfield mdl-textfield--floating-label",
      input(cls := "mdl-textfield__input", `type` := "text", id := "search"),
      label(cls := "mdl-textfield__label", `for` := "search", "Search")
    )
  )
}