Scaladoc: Add new search, featuring entity and member search

This commit adds a revamped search function for the scaladoc tool. It
also contains a number of small fixes for HTML-layout and JavaScript
issues.

The search is implemented by enhancing the scheduler and using
JavaScript promises. List of changes/additions:

* Revamped search functionality
    - Search members as well as entities
    - Preserve keyboard navigation
    - Scroll to selected entity if outside of viewport
    - Non-blocking, cancelable
* Display of library name (top left)
* Refactored scheduler
* Cleanup of HTML layout
    - Remove left pane
    - Better mobile layout, no need for dynamic offsets
    - Remove unused element classes
    - Remove iframe structure
    - Better layout for kinds

5 files changed, 29 insertions, 59 deletions

diff --git a/test/scaladoc/run/SI-6017.check b/test/scaladoc/run/SI-6017.check
deleted file mode 100644
index 619c56180b..0000000000
--- a/test/scaladoc/run/SI-6017.check
+++ /dev/null
@@ -1 +0,0 @@
-Done.
diff --git a/test/scaladoc/run/SI-6017.scala b/test/scaladoc/run/SI-6017.scala
deleted file mode 100644
index 9951534c6d..0000000000
--- a/test/scaladoc/run/SI-6017.scala
+++ /dev/null
@@ -1,28 +0,0 @@
-import scala.tools.nsc.doc
-import scala.tools.nsc.doc.model._
-import scala.tools.nsc.doc.html.page.{Index, ReferenceIndex}
-import scala.tools.partest.ScaladocModelTest
-
-object Test extends ScaladocModelTest {
-  override def scaladocSettings = ""
-  override def code = """
-    class STAR
-    class Star
-  """
-
-  def testModel(rootPackage: Package) {
-    model match {
-      case Some(universe) => {
-        val index = IndexModelFactory.makeIndex(universe)
-        // Because "STAR" and "Star" are different
-        assert(index.firstLetterIndex('s').keys.toSeq.length == 2)
-
-        val indexPage = new Index(universe, index)
-        val letters = indexPage.letters
-        assert(letters.length > 1)
-        assert(letters(0).toString == "<span>#</span>")
-      }
-      case _ => assert(false)
-    }
-  }
-}
diff --git a/test/scaladoc/scalacheck/DeprecatedIndexTest.scala b/test/scaladoc/scalacheck/DeprecatedIndexTest.scala
index 4a5a2001d4..2581b879da 100644
--- a/test/scaladoc/scalacheck/DeprecatedIndexTest.scala
+++ b/test/scaladoc/scalacheck/DeprecatedIndexTest.scala
@@ -1,6 +1,7 @@
 import org.scalacheck._
 import org.scalacheck.Prop._
 
+import scala.tools.nsc.ScalaDocReporter
 import scala.tools.nsc.doc
 import scala.tools.nsc.doc.html.page.DeprecatedIndex
 import java.net.{URLClassLoader, URLDecoder}
@@ -32,7 +33,8 @@ object Test extends Properties("IndexScript") {
   def createDeprecatedScript(path: String) =
     docFactory.makeUniverse(Left(List(path))) match {
       case Some(universe) => {
-        val index = new DeprecatedIndex(universe, indexModelFactory.makeIndex(universe))
+        val reporter = new ScalaDocReporter(universe.settings)
+        val index = new DeprecatedIndex(universe, indexModelFactory.makeIndex(universe), reporter)
         Some(index)
       }
       case _ =>
diff --git a/test/scaladoc/scalacheck/HtmlFactoryTest.scala b/test/scaladoc/scalacheck/HtmlFactoryTest.scala
index f0f106b293..daa7de8545 100644
--- a/test/scaladoc/scalacheck/HtmlFactoryTest.scala
+++ b/test/scaladoc/scalacheck/HtmlFactoryTest.scala
@@ -26,6 +26,8 @@ object Test extends Properties("HtmlFactory") {
 
   final val RESOURCES = "test/scaladoc/resources/"
 
+
+  import scala.tools.nsc.ScalaDocReporter
   import scala.tools.nsc.doc.{DocFactory, Settings}
   import scala.tools.nsc.doc.model.IndexModelFactory
   import scala.tools.nsc.doc.html.HtmlFactory
@@ -59,7 +61,7 @@ object Test extends Properties("HtmlFactory") {
     createFactory.makeUniverse(Left(List(RESOURCES+basename))) match {
       case Some(universe) => {
         val index = IndexModelFactory.makeIndex(universe)
-        (new HtmlFactory(universe, index)).writeTemplates((page) => {
+        (new HtmlFactory(universe, index, new ScalaDocReporter(universe.settings))).writeTemplates((page) => {
           result += (page.absoluteLinkTo(page.path) -> page.body)
         })
       }
@@ -75,7 +77,8 @@ object Test extends Properties("HtmlFactory") {
         val index = IndexModelFactory.makeIndex(universe)
         val pages = index.firstLetterIndex.map({
           case (key, value) => {
-            val page = new ReferenceIndex(key, index, universe)
+            val reporter = new ScalaDocReporter(universe.settings)
+            val page = new ReferenceIndex(key, index, universe, reporter)
             page.absoluteLinkTo(page.path) -> page.body
           }
         })
@@ -723,9 +726,9 @@ object Test extends Properties("HtmlFactory") {
       }
       case _ => false
     }
-    property("package") = files.get("com/example/p1/package.html") != None
+    property("package") = files.get("com/example/p1/index.html") != None
 
-    property("package object") = files("com/example/p1/package.html") match {
+    property("package object") = files("com/example/p1/index.html") match {
       case node: scala.xml.Node =>
         node.toString contains "com.example.p1#packageObjectMethod"
       case _ => false
@@ -743,13 +746,13 @@ object Test extends Properties("HtmlFactory") {
 
     property("SI-8514: No inconsistencies") =
       checkText("SI-8514.scala")(
-        (Some("a/package"),
+        (Some("a/index"),
          """class A extends AnyRef
             Some doc here
             Some doc here
             Annotations @DeveloperApi()
          """, true),
-        (Some("a/package"),
+        (Some("a/index"),
          """class B extends AnyRef
             Annotations @DeveloperApi()
          """, true)
@@ -794,28 +797,28 @@ object Test extends Properties("HtmlFactory") {
         case _ => false
       }
 
-    property("SI-8144: Members' permalink - package") = check("some/package.html") { node =>
-      ("type link" |: node.assertTypeLink("../index.html#some.package")) &&
-        ("member: some.pack" |: node.assertValuesLink("some.pack", "../index.html#some.package@pack"))
+    property("SI-8144: Members' permalink - package") = check("some/index.html") { node =>
+      ("type link" |: node.assertTypeLink("../some/index.html")) &&
+      ("member: some.pack" |: node.assertValuesLink("some.pack", "../some/index.html#pack"))
     }
 
-    property("SI-8144: Members' permalink - inner package") = check("some/pack/package.html") { node =>
-      ("type link" |: node.assertTypeLink("../../index.html#some.pack.package")) &&
-        ("member: SomeType (object)" |: node.assertValuesLink("some.pack.SomeType", "../../index.html#some.pack.package@SomeType")) &&
-        ("member: SomeType (class)" |: node.assertMemberLink("types")("some.pack.SomeType", "../../index.html#some.pack.package@SomeTypeextendsAnyRef"))
+    property("SI-8144: Members' permalink - inner package") = check("some/pack/index.html") { node =>
+      ("type link" |: node.assertTypeLink("../../some/pack/index.html")) &&
+        ("member: SomeType (object)" |: node.assertValuesLink("some.pack.SomeType", "../../some/pack/index.html#SomeType")) &&
+        ("member: SomeType (class)" |: node.assertMemberLink("types")("some.pack.SomeType", "../../some/pack/index.html#SomeTypeextendsAnyRef"))
     }
 
     property("SI-8144: Members' permalink - companion object") = check("some/pack/SomeType$.html") { node =>
-      ("type link" |: node.assertTypeLink("../../index.html#some.pack.SomeType$")) &&
-        ("member: someVal" |: node.assertMemberLink("allMembers")("some.pack.SomeType#someVal", "../../index.html#some.pack.SomeType$@someVal:String"))
+      ("type link" |: node.assertTypeLink("../../some/pack/SomeType$.html")) &&
+        ("member: someVal" |: node.assertMemberLink("allMembers")("some.pack.SomeType#someVal", "../../some/pack/SomeType$.html#someVal:String"))
     }
 
     property("SI-8144: Members' permalink - class") = check("some/pack/SomeType.html") { node =>
-      ("type link" |: node.assertTypeLink("../../index.html#some.pack.SomeType")) &&
-      ("constructor " |: node.assertMemberLink("constructors")("some.pack.SomeType#<init>", "../../index.html#some.pack.SomeType@<init>(arg:String):some.pack.SomeType")) &&
-        ( "member: type TypeAlias" |: node.assertMemberLink("types")("some.pack.SomeType.TypeAlias", "../../index.html#some.pack.SomeType@TypeAlias=String")) &&
-        ( "member: def >#<():Int " |: node.assertValuesLink("some.pack.SomeType#>#<", "../../index.html#some.pack.SomeType@>#<():Int")) &&
-        ( "member: def >@<():TypeAlias " |: node.assertValuesLink("some.pack.SomeType#>@<", "../../index.html#some.pack.SomeType@>@<():SomeType.this.TypeAlias"))
+      ("type link" |: node.assertTypeLink("../../some/pack/SomeType.html")) &&
+      ("constructor " |: node.assertMemberLink("constructors")("some.pack.SomeType#<init>", "../../some/pack/SomeType.html#<init>(arg:String):some.pack.SomeType")) &&
+        ( "member: type TypeAlias" |: node.assertMemberLink("types")("some.pack.SomeType.TypeAlias", "../../some/pack/SomeType.html#TypeAlias=String")) &&
+        ( "member: def >#<():Int " |: node.assertValuesLink("some.pack.SomeType#>#<", "../../some/pack/SomeType.html#>#<():Int")) &&
+        ( "member: def >@<():TypeAlias " |: node.assertValuesLink("some.pack.SomeType#>@<", "../../some/pack/SomeType.html#>@<():SomeType.this.TypeAlias"))
     }
 
   }
diff --git a/test/scaladoc/scalacheck/IndexTest.scala b/test/scaladoc/scalacheck/IndexTest.scala
index 7dbd2103a6..036586c21d 100644
--- a/test/scaladoc/scalacheck/IndexTest.scala
+++ b/test/scaladoc/scalacheck/IndexTest.scala
@@ -1,6 +1,7 @@
 import org.scalacheck._
 import org.scalacheck.Prop._
 
+import scala.tools.nsc.ScalaDocReporter
 import scala.tools.nsc.doc
 import scala.tools.nsc.doc.html.page.Index
 import java.net.{URLClassLoader, URLDecoder}
@@ -47,7 +48,8 @@ object Test extends Properties("Index") {
 
     maybeUniverse match {
       case Some(universe) => {
-        val index = new Index(universe, indexModelFactory.makeIndex(universe))
+        val reporter = new ScalaDocReporter(universe.settings)
+        val index = new Index(universe, indexModelFactory.makeIndex(universe), reporter)
         return Some(index)
       }
       case _ => return None
@@ -71,14 +73,6 @@ object Test extends Properties("Index") {
       case None => false
     }
   }
-  property("browser contains a script element") = {
-    createIndex("src/scaladoc/scala/tools/nsc/doc/html/page/Index.scala") match {
-      case Some(index) =>
-        (index.browser \ "script").size == 1
-
-      case None => false
-    }
-  }
   property("package objects in index") = {
     createIndex("test/scaladoc/resources/SI-5558.scala") match {
       case Some(index) =>