SI-3314 SI-4888 Scaladoc: Relative type prefixes

And adds support for linking to class members, only usable from the
model factory now, so no links to members from the doc comment yet,
sorry. But it fixes the Enumeration problem once and for all!

Also corrected the inTpl for members obtained by implicit conversions,
so they're in the correct template and the comment variable expansion
is done from the correct (but different) template.

Review by @kzys.

8 files changed, 182 insertions, 14 deletions

diff --git a/test/scaladoc/run/SI-3314.check b/test/scaladoc/run/SI-3314.check
new file mode 100644
index 0000000000..619c56180b
--- /dev/null
+++ b/test/scaladoc/run/SI-3314.check
@@ -0,0 +1 @@
+Done.
diff --git a/test/scaladoc/run/SI-3314.scala b/test/scaladoc/run/SI-3314.scala
new file mode 100644
index 0000000000..665223098a
--- /dev/null
+++ b/test/scaladoc/run/SI-3314.scala
@@ -0,0 +1,74 @@
+import scala.tools.nsc.doc.model._
+import scala.tools.partest.ScaladocModelTest
+
+object Test extends ScaladocModelTest {
+
+  override def resourceFile = "SI-3314.scala"
+
+  // no need for special settings
+  def scaladocSettings = ""
+
+  def testModel(rootPackage: Package) = {
+    // get the quick access implicit defs in scope (_package(s), _class(es), _trait(s), object(s) _method(s), _value(s))
+    import access._
+
+    // just need to check the member exists, access methods will throw an error if there's a problem
+    val base = rootPackage._package("scala")._package("test")._package("scaladoc")
+
+    val test1 = base._package("test1")
+    val test1Value = test1._class("Enum")._method("Value").resultType
+    assert(test1Value.name == "Value",       test1Value.name + " == Value")
+    assert(test1Value.refEntity.size == 1, test1Value.refEntity.size + " == 1")
+
+    val test1Constants = test1._object("Constants")._method("a").resultType
+    assert(test1Constants.name == "Value", test1Constants.name + " == Value")
+    assert(test1Constants.refEntity.size == 1, test1Constants.refEntity.size + " == 1")
+    assert(test1Constants.refEntity(0)._1 == LinkToMember(test1._object("Constants")._class("Value"), test1._object("Constants")),
+           test1Constants.refEntity(0)._1 + " == LinkToMember(test1.Enum.Value)")
+
+    val test2 = base._package("test2")
+    def testDefinition(doc: DocTemplateEntity) = {
+      for (day <- List("Mon", "Tue", "Wed", "Thu", "Fri", "Sat", "Sun")) {
+        assert(doc._value(day).resultType.name == "Value",
+               doc._value(day).resultType.name + " == Value")
+        assert(doc._value(day).resultType.refEntity.size == 1,
+               doc._value(day).resultType.refEntity.size + " == 1")
+        assert(doc._value(day).resultType.refEntity(0)._1 == LinkToMember(doc._classMbr("Value"), doc),
+               doc._value(day).resultType.refEntity(0)._1 + " == LinkToMember(" + doc.qualifiedName + ".Value)")
+      }
+    }
+    testDefinition(test2._trait("WeekDayTrait"))
+    testDefinition(test2._class("WeekDayClass"))
+    testDefinition(test2._object("WeekDayObject"))
+
+    def testUsage(doc: DocTemplateEntity) = {
+      val ValueInClass = test2._class("WeekDayClass")._classMbr("Value")
+      val ValueInTrait = test2._trait("WeekDayTrait")._classMbr("Value")
+      val ValueInObject = test2._object("WeekDayObject")._classMbr("Value")
+      val WeekDayInObject = test2._object("WeekDayObject")._member("WeekDay")
+
+      val expected = List(
+        ("isWorkingDay1", "Value",   ValueInClass),
+        ("isWorkingDay2", "Value",   ValueInClass),
+        ("isWorkingDay3", "Value",   ValueInTrait),
+        ("isWorkingDay4", "Value",   ValueInTrait),
+        ("isWorkingDay5", "Value",   ValueInObject),
+        ("isWorkingDay6", "WeekDay", WeekDayInObject),
+        ("isWorkingDay7", "Value",   ValueInObject),
+        ("isWorkingDay8", "WeekDay", WeekDayInObject),
+        ("isWorkingDay9", "Value",   ValueInObject))
+
+      for ((method, name, ref) <- expected) {
+        assert(doc._method(method).valueParams(0)(0).resultType.name == name,
+               doc._method(method).valueParams(0)(0).resultType.name + " == " + name + " (in " + doc + "." + method + ")")
+        assert(doc._method(method).valueParams(0)(0).resultType.refEntity.size == 1,
+               doc._method(method).valueParams(0)(0).resultType.refEntity.size + " == " + 1 + " (in " + doc + "." + method + ")")
+        assert(doc._method(method).valueParams(0)(0).resultType.refEntity(0)._1 == LinkToMember(ref, ref.inTemplate),
+               doc._method(method).valueParams(0)(0).resultType.refEntity(0)._1 + " == LinkToMember(" + ref.qualifiedName + ") (in " + doc + "." + method + ")")
+      }
+    }
+    testUsage(test2._object("UserObject"))
+    testUsage(test2._class("UserClass"))
+    testUsage(test2._trait("UserTrait"))
+  }
+}
\ No newline at end of file
diff --git a/test/scaladoc/run/SI-3484.check b/test/scaladoc/run/SI-3484.check
new file mode 100644
index 0000000000..619c56180b
--- /dev/null
+++ b/test/scaladoc/run/SI-3484.check
@@ -0,0 +1 @@
+Done.
diff --git a/test/scaladoc/run/SI-3484.scala b/test/scaladoc/run/SI-3484.scala
new file mode 100644
index 0000000000..297aebee8f
--- /dev/null
+++ b/test/scaladoc/run/SI-3484.scala
@@ -0,0 +1,52 @@
+import scala.tools.nsc.doc.model._
+import scala.tools.nsc.doc.model.diagram._
+import scala.tools.partest.ScaladocModelTest
+
+object Test extends ScaladocModelTest {
+
+  override def code = """
+        class cbf[A, B, C]
+
+        /**
+         *  @define Coll Collection
+         *  @define bfreturn $Coll
+         */
+        class Collection[A] {
+          /** What map does...
+           *
+           *  $bfreturn
+           *  @usecase def map[B](f: A => B): $bfreturn[B]
+           *
+           */
+          def map[B, That](f: A => B)(implicit fact: cbf[Collection[A], B, That]) =
+            null
+        }
+
+        /**
+         *  @define b John
+         *  @define a Mister $b
+         */
+        class SR704 {
+          /**
+           *  Hello $a.
+           */
+          def foo = 123
+        }
+    """
+
+  // diagrams must be started. In case there's an error with dot, it should not report anything
+  def scaladocSettings = ""
+
+  def testModel(rootPackage: Package) = {
+    // get the quick access implicit defs in scope (_package(s), _class(es), _trait(s), object(s) _method(s), _value(s))
+    import access._
+
+    // check correct expansion of the use case signature
+    val map = rootPackage._class("Collection")._method("map")
+    assert(map.resultType.name == "Collection[B]", map.resultType.name + " == Traversable[B]")
+
+    val foo = rootPackage._class("SR704")._method("foo")
+    assert(extractCommentText(foo.comment.get).contains("Hello Mister John."),
+           extractCommentText(foo.comment.get) + ".contains(Hello Mister John.)")
+  }
+}
\ No newline at end of file
diff --git a/test/scaladoc/run/SI-4676.check b/test/scaladoc/run/SI-4676.check
new file mode 100644
index 0000000000..619c56180b
--- /dev/null
+++ b/test/scaladoc/run/SI-4676.check
@@ -0,0 +1 @@
+Done.
diff --git a/test/scaladoc/run/SI-4676.scala b/test/scaladoc/run/SI-4676.scala
new file mode 100644
index 0000000000..b83a59a472
--- /dev/null
+++ b/test/scaladoc/run/SI-4676.scala
@@ -0,0 +1,26 @@
+import scala.tools.nsc.doc.model._
+import scala.tools.nsc.doc.model.diagram._
+import scala.tools.partest.ScaladocModelTest
+
+object Test extends ScaladocModelTest {
+
+  override def code = """
+        class SI_4676 {
+          type SS = (String,String)
+          def x(ss: SS): Int = 3
+        }
+        class cbf[A, B, C]
+    """
+
+  // diagrams must be started. In case there's an error with dot, it should not report anything
+  def scaladocSettings = ""
+
+  def testModel(rootPackage: Package) = {
+    // get the quick access implicit defs in scope (_package(s), _class(es), _trait(s), object(s) _method(s), _value(s))
+    import access._
+
+    // check correct expansion of the use case signature
+    val x = rootPackage._class("SI_4676")._method("x")
+    assert(x.valueParams(0)(0).resultType.name == "(String, String)", "parameter ss of method x has type (String, String")
+  }
+}
\ No newline at end of file
diff --git a/test/scaladoc/run/SI-5235.scala b/test/scaladoc/run/SI-5235.scala
index cae70fd0a5..f0c6e1cf17 100644
--- a/test/scaladoc/run/SI-5235.scala
+++ b/test/scaladoc/run/SI-5235.scala
@@ -77,11 +77,11 @@ object Test extends ScaladocModelTest {
     assert(gcReverseType.name == "GenericColl", gcReverseType.name + " == GenericColl")
     assert(scReverseType.name == "BullSh",      scReverseType.name + " == BullSh")
     assert(mcReverseType.name == "MyCollection",mcReverseType.name + " == MyCollection")
-    assert(gcReverseType.refEntity(0)._1 == GenericColl,
+    assert(gcReverseType.refEntity(0)._1 == LinkToTpl(GenericColl),
            gcReverse.qualifiedName + "'s return type has a link to " + GenericColl.qualifiedName)
-    assert(scReverseType.refEntity.isEmpty,
+    assert(!scReverseType.refEntity(0)._1.asInstanceOf[LinkToTpl].tpl.isDocTemplate,
            scReverse.qualifiedName + "'s return type does not have links")
-    assert(mcReverseType.refEntity(0)._1 == MyCollection,
+    assert(mcReverseType.refEntity(0)._1 == LinkToTpl(MyCollection),
            mcReverse.qualifiedName + "'s return type has a link to " + MyCollection.qualifiedName)
   }
 }
\ No newline at end of file
diff --git a/test/scaladoc/run/implicits-var-exp.scala b/test/scaladoc/run/implicits-var-exp.scala
index 16569fe3c2..94d2990d29 100644
--- a/test/scaladoc/run/implicits-var-exp.scala
+++ b/test/scaladoc/run/implicits-var-exp.scala
@@ -6,25 +6,36 @@ object Test extends ScaladocModelTest {
 
   override def code = """
         package scala.test.scaladoc.variable.expansion {
-          /**
-           * Blah blah blah
-           */
+          /** @define coll WROOOONG-A */
           class A
 
           object A {
             import language.implicitConversions
-            implicit def aToB(a: A) = new B
+            implicit def aToC(a: A) = new C
+            implicit def aToE(a: A) = new E with F
           }
 
-          /**
-           * @define coll collection
-           */
+          /** @define coll WROOOONG-B */
           class B {
-            /**
-             * foo returns a $coll
-             */
+            /** foo returns a $coll */
             def foo: Nothing = ???
           }
+
+          /** @define coll collection */
+          class C extends B
+
+          /** @define coll WROOOONG-D */
+          trait D {
+            /** bar returns a $coll */
+            def bar: Nothing = ???
+          }
+
+          /** @define coll result */
+          //trait E { self: D => override def bar: Nothing = ??? }
+          trait E extends D { override def bar: Nothing = ??? }
+
+          /** @define coll WROOOONG-F */
+          trait F
         }
     """
 
@@ -37,7 +48,9 @@ object Test extends ScaladocModelTest {
 
     val base = rootPackage._package("scala")._package("test")._package("scaladoc")._package("variable")._package("expansion")
     val foo = base._class("A")._method("foo")
-
     assert(foo.comment.get.body.toString.contains("foo returns a collection"), "\"" + foo.comment.get.body.toString + "\".contains(\"foo returns a collection\")")
+
+    val bar = base._class("A")._method("bar")
+    assert(bar.comment.get.body.toString.contains("bar returns a result"), "\"" + bar.comment.get.body.toString + "\".contains(\"bar returns a result\")")
   }
 }
\ No newline at end of file