Add phase to deal with constructors

8 files changed, 76 insertions, 23 deletions

diff --git a/dottydoc/src/dotty/tools/dottydoc/DottyDoc.scala b/dottydoc/src/dotty/tools/dottydoc/DottyDoc.scala
index 61de1cfd8..2d4c7abcf 100644
--- a/dottydoc/src/dotty/tools/dottydoc/DottyDoc.scala
+++ b/dottydoc/src/dotty/tools/dottydoc/DottyDoc.scala
@@ -35,6 +35,7 @@ class DocCompiler extends Compiler {
                                 new LinkParamListTypes,
                                 new LinkImplicitlyAddedTypes,
                                 new LinkSuperTypes,
+                                new AlternateConstructors,
                                 new SortMembers))
   )
 }
diff --git a/dottydoc/src/dotty/tools/dottydoc/core/AlternateConstructorsPhase.scala b/dottydoc/src/dotty/tools/dottydoc/core/AlternateConstructorsPhase.scala
new file mode 100644
index 000000000..53c96fc87
--- /dev/null
+++ b/dottydoc/src/dotty/tools/dottydoc/core/AlternateConstructorsPhase.scala
@@ -0,0 +1,34 @@
+package dotty.tools
+package dottydoc
+package core
+
+import dotc.core.Contexts.Context
+
+import transform.DocMiniPhase
+import model._
+import model.internal._
+
+/** This DocMiniPhase adds the alternate constructors, currently defined as
+ *  methods with the name `<init>`, to the Entity#constructors list
+ */
+class AlternateConstructors extends DocMiniPhase {
+  def partitionMembers(ent: Entity with Constructors with Members): (List[List[ParamList]], List[Entity]) = {
+    val (constructors, members) = ent.members.partition(x => x.name == "<init>")
+
+    val paramLists: List[List[ParamList]] = constructors.collect {
+      case df: Def => df.paramLists
+    }
+
+    (ent.constructors ++ paramLists, members)
+  }
+
+  override def transformClass(implicit ctx: Context) = { case cls: ClassImpl =>
+    val (constructors, members) = partitionMembers(cls)
+    cls.copy(members = members, constructors = constructors)
+  }
+
+  override def transformCaseClass(implicit ctx: Context) = { case cc: CaseClassImpl =>
+    val (constructors, members) = partitionMembers(cc)
+    cc.copy(members = members, constructors = constructors)
+  }
+}
diff --git a/dottydoc/src/dotty/tools/dottydoc/core/DocASTPhase.scala b/dottydoc/src/dotty/tools/dottydoc/core/DocASTPhase.scala
index 013010971..7744752ce 100644
--- a/dottydoc/src/dotty/tools/dottydoc/core/DocASTPhase.scala
+++ b/dottydoc/src/dotty/tools/dottydoc/core/DocASTPhase.scala
@@ -97,7 +97,7 @@ class DocASTPhase extends Phase {
         val name = n.decode.toString
         val newPath = prev :+ name
         //TODO: should not `collectMember` from `rhs` - instead: get from symbol, will get inherited members as well
-        TraitImpl(name, collectMembers(rhs), flags(t), newPath, typeParams(t.symbol), superTypes(t))
+        TraitImpl(name, collectMembers(rhs), flags(t), newPath, typeParams(t.symbol), traitParameters(t.symbol), superTypes(t))
 
       /** objects, on the format "Object$" so drop the last letter */
       case o @ TypeDef(n, rhs) if o.symbol.is(Flags.Module) =>
@@ -110,7 +110,7 @@ class DocASTPhase extends Phase {
         val name = n.decode.toString
         val newPath = prev :+ name
         //TODO: should not `collectMember` from `rhs` - instead: get from symbol, will get inherited members as well
-        (name, collectMembers(rhs), flags(c), newPath, typeParams(c.symbol), superTypes(c), None) match {
+        (name, collectMembers(rhs), flags(c), newPath, typeParams(c.symbol), constructors(c.symbol), superTypes(c), None) match {
           case x if c.symbol.is(Flags.CaseClass) => CaseClassImpl.tupled(x)
           case x => ClassImpl.tupled(x)
         }
diff --git a/dottydoc/src/dotty/tools/dottydoc/core/MiniPhaseTransform.scala b/dottydoc/src/dotty/tools/dottydoc/core/MiniPhaseTransform.scala
index 7bdb2bf4e..2690ac7b7 100644
--- a/dottydoc/src/dotty/tools/dottydoc/core/MiniPhaseTransform.scala
+++ b/dottydoc/src/dotty/tools/dottydoc/core/MiniPhaseTransform.scala
@@ -88,15 +88,16 @@ object transform {
 
           newPackage
         }
-        case c: Class => transformEntity(c, _.classTransformation) { newClass =>
+        case c: Class => transformEntity(c, _.classTransformation) { cls =>
           ClassImpl(
-            newClass.name,
-            newClass.members.map(traverse),
-            newClass.modifiers,
-            newClass.path,
-            newClass.typeParams,
-            newClass.superTypes,
-            newClass.comment
+            cls.name,
+            cls.members.map(traverse),
+            cls.modifiers,
+            cls.path,
+            cls.typeParams,
+            cls.constructors,
+            cls.superTypes,
+            cls.comment
           )
         }
         case cc: CaseClass => transformEntity(cc, _.caseClassTransformation) { cc =>
@@ -106,6 +107,7 @@ object transform {
             cc.modifiers,
             cc.path,
             cc.typeParams,
+            cc.constructors,
             cc.superTypes,
             cc.comment
           )
@@ -117,6 +119,7 @@ object transform {
             trt.modifiers,
             trt.path,
             trt.typeParams,
+            trt.traitParams,
             trt.superTypes,
             trt.comment
           )
diff --git a/dottydoc/src/dotty/tools/dottydoc/model/entities.scala b/dottydoc/src/dotty/tools/dottydoc/model/entities.scala
index 4d3a33b33..76792070c 100644
--- a/dottydoc/src/dotty/tools/dottydoc/model/entities.scala
+++ b/dottydoc/src/dotty/tools/dottydoc/model/entities.scala
@@ -57,6 +57,10 @@ trait ParamList {
   def isImplicit: Boolean
 }
 
+trait Constructors {
+  def constructors: List[List[ParamList]]
+}
+
 trait ImplicitlyAddedEntity extends Entity {
   def implicitlyAddedFrom: Option[Reference]
 }
@@ -67,15 +71,16 @@ trait Package extends Entity with Members {
   def children: List[Entity with Members]
 }
 
-trait Class extends Entity with Modifiers with TypeParams with SuperTypes with Members {
+trait Class extends Entity with Modifiers with TypeParams with Constructors with SuperTypes with Members {
   val kind = "class"
 }
 
-trait CaseClass extends Entity with Modifiers with TypeParams with SuperTypes with Members {
+trait CaseClass extends Entity with Modifiers with TypeParams with Constructors with SuperTypes with Members {
   override val kind = "case class"
 }
 
 trait Trait extends Entity with Modifiers with TypeParams with SuperTypes with Members {
+  def traitParams: List[ParamList]
   override val kind = "trait"
 }
 
diff --git a/dottydoc/src/dotty/tools/dottydoc/model/factories.scala b/dottydoc/src/dotty/tools/dottydoc/model/factories.scala
index b5cf15148..b19b836ee 100644
--- a/dottydoc/src/dotty/tools/dottydoc/model/factories.scala
+++ b/dottydoc/src/dotty/tools/dottydoc/model/factories.scala
@@ -6,19 +6,17 @@ import references._
 import dotty.tools.dotc
 import dotc.core.Types._
 import dotc.core.TypeApplications._
-import dotc.core.Flags
 import dotc.core.Contexts.Context
-import dotc.core.Symbols.Symbol
+import dotc.core.Symbols.{ Symbol, ClassSymbol }
 import dotty.tools.dotc.core.SymDenotations._
 import dotty.tools.dotc.core.Names.TypeName
-import dotc.core.{ Flags => DottyFlags }
 import dotc.ast.Trees._
 
 
 object factories {
   import dotty.tools.dotc.ast.tpd._
   import dotty.tools.dottydoc.model.internal.ParamListImpl
-  import DottyFlags._
+  import dotc.core.Flags._
 
   type TypeTree = dotty.tools.dotc.ast.Trees.Tree[Type]
 
@@ -118,11 +116,11 @@ object factories {
         pt.paramNames.map(_.show.split("\\$").last)
       case ClassInfo(_, _, _, decls, _) =>
         decls.iterator
-          .filter(_.flags is Flags.TypeParam)
+          .filter(_.flags is TypeParam)
           .map { tp =>
             val prefix =
-              if (tp.flags is Flags.Covariant) "+"
-              else if (tp.flags is Flags.Contravariant) "-"
+              if (tp.flags is Covariant) "+"
+              else if (tp.flags is Contravariant) "-"
               else ""
             prefix + tp.name.show.split("\\$").last
           }
@@ -131,6 +129,15 @@ object factories {
         Nil
     }
 
+  def constructors(sym: Symbol)(implicit ctx: Context): List[List[ParamList]] = sym match {
+    case sym: ClassSymbol =>
+      paramLists(sym.primaryConstructor.info) :: Nil
+    case _ => Nil
+  }
+
+  def traitParameters(sym: Symbol)(implicit ctx: Context): List[ParamList] =
+    constructors(sym).head
+
   def paramLists(tpe: Type)(implicit ctx: Context): List[ParamList] = tpe match {
     case pt: PolyType =>
       paramLists(pt.resultType)
diff --git a/dottydoc/src/dotty/tools/dottydoc/model/internal.scala b/dottydoc/src/dotty/tools/dottydoc/model/internal.scala
index 63e97743d..6afb1ec9b 100644
--- a/dottydoc/src/dotty/tools/dottydoc/model/internal.scala
+++ b/dottydoc/src/dotty/tools/dottydoc/model/internal.scala
@@ -26,6 +26,7 @@ object internal {
     modifiers: List[String],
     path: List[String],
     typeParams: List[String] = Nil,
+    constructors: List[List[ParamList]] = Nil,
     superTypes: List[MaterializableLink] = Nil,
     var comment: Option[Comment] = None
   ) extends Class with Impl
@@ -36,6 +37,7 @@ object internal {
     modifiers: List[String],
     path: List[String],
     typeParams: List[String] = Nil,
+    constructors: List[List[ParamList]] = Nil,
     superTypes: List[MaterializableLink] = Nil,
     var comment: Option[Comment] = None
   ) extends CaseClass with Impl
@@ -46,6 +48,7 @@ object internal {
     modifiers: List[String],
     path: List[String],
     typeParams: List[String] = Nil,
+    traitParams: List[ParamList] = Nil,
     superTypes: List[MaterializableLink] = Nil,
     var comment: Option[Comment] = None
   ) extends Trait with Impl
diff --git a/dottydoc/src/dotty/tools/dottydoc/model/json.scala b/dottydoc/src/dotty/tools/dottydoc/model/json.scala
index 9bf37295c..145728f8a 100644
--- a/dottydoc/src/dotty/tools/dottydoc/model/json.scala
+++ b/dottydoc/src/dotty/tools/dottydoc/model/json.scala
@@ -34,7 +34,7 @@ object json {
     def json: String = {
       val (secondTitle, secondValue, kind) = link match {
         case ul: UnsetLink => ("query".json, ul.query.json, "UnsetLink".json)
-        case ml: MaterializedLink => ("target", ml.target.json, "MaterializedLink".json)
+        case ml: MaterializedLink => ("target".json, ml.target.json, "MaterializedLink".json)
         case nl: NoLink => ("target".json, nl.target.json, "NoLink".json)
       }
       s"""{"title":${link.title.json},$secondTitle:${secondValue},"kind":$kind}"""
@@ -70,11 +70,11 @@ object json {
     case ent: Package =>
       s"""{"name":${ent.name.json},"members":${ent.members.map(_.json).mkString("[",",","]")},"path":${ent.path.map(_.json).mkString("[",",","]")},${ent.comment.map(_.json).fold("")(cmt => s""""comment":$cmt,""")}"kind":"package"}"""
     case ent: Class =>
-      s"""{"name":${ent.name.json},"members":${ent.members.map(_.json).mkString("[",",","]")},"modifiers":${ent.modifiers.map(_.json).mkString("[",",","]")},"path":${ent.path.map(_.json).mkString("[",",","]")},"typeParams":${ent.typeParams.map(_.json).mkString("[",",","]")},"superTypes":${ent.superTypes.map(_.json).mkString("[",",","]")},${ent.comment.map(_.json).fold("")(cmt => s""""comment":$cmt,""")}"kind":"class"}"""
+      s"""{"name":${ent.name.json},"members":${ent.members.map(_.json).mkString("[",",","]")},"modifiers":${ent.modifiers.map(_.json).mkString("[",",","]")},"path":${ent.path.map(_.json).mkString("[",",","]")},"typeParams":${ent.typeParams.map(_.json).mkString("[",",","]")},"constructors":${ent.constructors.map(xs => xs.map(_.json).mkString("[",",","]")).mkString("[",",","]")},"superTypes":${ent.superTypes.map(_.json).mkString("[",",","]")},${ent.comment.map(_.json).fold("")(cmt => s""""comment":$cmt,""")}"kind":"class"}"""
     case ent: CaseClass =>
-      s"""{"name":${ent.name.json},"members":${ent.members.map(_.json).mkString("[",",","]")},"modifiers":${ent.modifiers.map(_.json).mkString("[",",","]")},"path":${ent.path.map(_.json).mkString("[",",","]")},"typeParams":${ent.typeParams.map(_.json).mkString("[",",","]")},"superTypes":${ent.superTypes.map(_.json).mkString("[",",","]")},${ent.comment.map(_.json).fold("")(cmt => s""""comment":$cmt,""")}"kind":"case class"}"""
+      s"""{"name":${ent.name.json},"members":${ent.members.map(_.json).mkString("[",",","]")},"modifiers":${ent.modifiers.map(_.json).mkString("[",",","]")},"path":${ent.path.map(_.json).mkString("[",",","]")},"typeParams":${ent.typeParams.map(_.json).mkString("[",",","]")},"constructors":${ent.constructors.map(xs => xs.map(_.json).mkString("[",",","]")).mkString("[",",","]")},"superTypes":${ent.superTypes.map(_.json).mkString("[",",","]")},${ent.comment.map(_.json).fold("")(cmt => s""""comment":$cmt,""")}"kind":"case class"}"""
     case ent: Trait =>
-      s"""{"name":${ent.name.json},"members":${ent.members.map(_.json).mkString("[",",","]")},"modifiers":${ent.modifiers.map(_.json).mkString("[",",","]")},"path":${ent.path.map(_.json).mkString("[",",","]")},"typeParams":${ent.typeParams.map(_.json).mkString("[",",","]")},"superTypes":${ent.superTypes.map(_.json).mkString("[",",","]")},${ent.comment.map(_.json).fold("")(cmt => s""""comment":$cmt,""")}"kind":"trait"}"""
+      s"""{"name":${ent.name.json},"members":${ent.members.map(_.json).mkString("[",",","]")},"modifiers":${ent.modifiers.map(_.json).mkString("[",",","]")},"path":${ent.path.map(_.json).mkString("[",",","]")},"typeParams":${ent.typeParams.map(_.json).mkString("[",",","]")},"traitParams":${ent.traitParams.map(_.json).mkString("[",",","]")},"superTypes":${ent.superTypes.map(_.json).mkString("[",",","]")},${ent.comment.map(_.json).fold("")(cmt => s""""comment":$cmt,""")}"kind":"trait"}"""
     case ent: Object =>
       s"""{"name":${ent.name.json},"members":${ent.members.map(_.json).mkString("[",",","]")},"modifiers":${ent.modifiers.map(_.json).mkString("[",",","]")},"path":${ent.path.map(_.json).mkString("[",",","]")},"superTypes":${ent.superTypes.map(_.json).mkString("[",",","]")},${ent.comment.map(_.json).fold("")(cmt => s""""comment":$cmt,""")}"kind":"object"}"""
     case ent: Def =>