aboutsummaryrefslogtreecommitdiff
path: root/dottydoc/jvm/src/dotty/tools/dottydoc/core/TypeLinkerPhases.scala
blob: 5339844ba8432e2ff64c734cd8395b2bf543c937 (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
package dotty.tools
package dottydoc
package core

import dotc.core.Contexts.Context
import dotc.util.Positions.NoPosition

import transform.DocMiniPhase
import model._
import comment._
import BodyParsers._
import model.internal._
import util.MemberLookup
import util.traversing._
import util.internal.setters._

class ReturnTypeLinker extends DocMiniPhase with TypeLinker {
  override def transformDef(implicit ctx: Context) = { case df: DefImpl =>
    val returnValue = linkReference(df, df.returnValue, ctx.base.packages[Package].toMap)
    df.copy(returnValue = returnValue)
  }

  override def transformVal(implicit ctx: Context) = { case vl: ValImpl =>
    val returnValue = linkReference(vl, vl.returnValue, ctx.base.packages[Package].toMap)
    vl.copy(returnValue = returnValue)
  }
}

class ParamListTypeLinker extends DocMiniPhase with TypeLinker {
  override def transformDef(implicit ctx: Context) = { case df: DefImpl =>
    val newParamLists = for {
      list <- df.paramLists
      newList = list.map(linkReference(df, _, ctx.base.packages[Package].toMap))
    } yield newList.asInstanceOf[List[NamedReference]]

    df.copy(paramLists = newParamLists)
  }
}

trait TypeLinker extends MemberLookup {
  def linkReference(ent: Entity, rv: Reference, packs: Map[String, Package]): Reference =
    rv match {
      case rv @ TypeReference(_, UnsetLink(t, query), tps) =>
        val inlineToHtml = InlineToHtml(ent)
        val title = inlineToHtml(t)

        def handleEntityLink(title: String, lt: LinkTo): MaterializableLink = lt match {
          case Tooltip(str)           => NoLink(title, str)
          case LinkToExternal(_, url) => MaterializedLink(title, url)
          case LinkToEntity(target)   => MaterializedLink(title, util.traversing.relativePath(ent, target))
        }

        val target = handleEntityLink(title, makeEntityLink(ent, packs, t, NoPosition, query).link)

        val tpTargets = tps.map {
          case UnsetLink(t, query) =>
            handleEntityLink(inlineToHtml(t), makeEntityLink(ent, packs, t, NoPosition, query).link)
          case x => x
        }

        rv.copy(tpeLink = target, paramLinks = tpTargets)
      case rv @ OrTypeReference(left, right) =>
        rv.copy(left = linkReference(ent, left, packs), right = linkReference(ent, right, packs))
      case rv @ AndTypeReference(left, right) =>
        rv.copy(left = linkReference(ent, left, packs), right = linkReference(ent, right, packs))
      case rv @ NamedReference(_, ref) => rv.copy(ref = linkReference(ent, ref, packs))
      case _ => rv
    }
}