Implement JSON filter and start web-worker implementation

Author: felixmulder

doc-tool/resources/_includes/sidebar.html

@@ -17,8 +17,11 @@
           var input = document.getElementById("search-api-input");
           input.onkeydown = function(evt) {
               evt = evt || window.event;
-              if (evt.keyCode == 13)
-                  window.location = "{{ site.baseurl }}/api/search.html?searchTerm=" + input.value;
+              if (evt.keyCode == 13) window.location = (
+                  "{{ site.baseurl }}/api/search.html?" +
+                  "searchTerm=" + input.value +
+                  "&previousUrl=" + encodeURI(window.location)
+              );
           };
       </script>
     </li>

doc-tool/resources/_layouts/search.html

@@ -7,9 +7,41 @@
 
 {% include "toolbar" %}
 
+<a id="back-anchor" href="">&lt; Back</a>
 <h1 id="searching-for"></h1>
 
 <script>
-    document.getElementById("searching-for").innerHTML =
-        location.search;
+    // Parse parameters from URL:
+    var parameters = [];
+    var apiSearch = undefined;
+    (function() {
+        var pairs = location.search.substring(1).split('&');
+        for (var i = 0; i < pairs.length; i++) {
+            var keyVal = pairs[i].split('=');
+            parameters[keyVal[0]] = keyVal.length == 2 ? keyVal[1] : undefined;
+        }
+    })();
+
+    // Set search term and back button:
+    var searchTerm = parameters["searchTerm"];
+    document.getElementById("searching-for").innerHTML = 'Seaching for "' + searchTerm + '"...';
+    document.getElementById("back-anchor").href = parameters["previousUrl"];
+
+    if (!window.Worker) {
+        document.getElementById("searching-for").innerHTML =
+            "Couldn't search for \"" + searchTerm + "\", " +
+            "web workers not supported. Please update your browser.";
+    }
+    else {
+      apiSearch = new Worker("{{ site.baseurl }}/js/api-search.js");
+      apiSearch.postMessage({
+        "type":   "setup",
+        "search": searchTerm,
+        "docs":   {{ docs | json }},
+      });
+
+      apiSearch.onmessage = function(res) {
+        console.log("got res: " + res.data);
+      };
+    }
 </script>

doc-tool/resources/js/api-search.js

@@ -0,0 +1,7 @@
+onmessage = function(e) {
+  var docs = e.data.docs;
+  var searchTerm = e.data.search;
+  postMessage(
+    "Search not implemented, couldn't find: " + searchTerm
+  );
+}

doc-tool/src/dotty/tools/dottydoc/staticsite/Site.scala

@@ -141,6 +141,7 @@ case class Site(
         "css/color-brewer.css" -> "/css/color-brewer.css",
         "css/font-awesome.min.css" -> "/css/font-awesome.min.css",
         "css/bootstrap.min.css" -> "/css/bootstrap.min.css",
+        "js/api-search.js" -> "/js/api-search.js",
         "js/bootstrap.min.js" -> "/js/bootstrap.min.js",
         "js/jquery.min.js" -> "/js/jquery.min.js",
         "js/tether.min.js" -> "/js/tether.min.js",

doc-tool/src/dotty/tools/dottydoc/staticsite/Template.scala

@@ -35,6 +35,7 @@ case class LiquidTemplate(path: String, content: SourceFile) extends Template wi
   /** Register filters to static container */
   Filter.registerFilter(new Reverse)
   Filter.registerFilter(new First)
+  Filter.registerFilter(new Json)
 
   // For some reason, liqp rejects a straight conversion using `.asJava`
   private def toJavaMap(map: Map[String, AnyRef]): HashMap[String, Object] =

doc-tool/src/dotty/tools/dottydoc/staticsite/filters.scala

@@ -2,8 +2,9 @@ package dotty.tools
 package dottydoc
 package staticsite
 
-import java.util.{ Map => JMap }
+import java.util.{ Map => JMap, List => JList }
 
+import com.fasterxml.jackson.databind.ObjectMapper
 import liqp.filters.Filter
 
 /** Custom liquid template filters */
@@ -39,4 +40,20 @@ object filters {
       case _ => null
     }
   }
+
+  /** Used to transform java representation to valid JSON
+   *
+   *  This can be used on things like the docs (`java.util.List[Map[String,_]]`)
+   *  which are available globally:
+   *
+   *  ```html
+   *  {{ docs | json }}
+   *  ```
+   */
+  final class Json extends Filter("json") {
+    override def apply(value: Any, params: AnyRef*): AnyRef = value match {
+      case map: JList[_] => new ObjectMapper().writeValueAsString(map)
+      case _ => null
+    }
+  }
 }

doc-tool/test/dotty/tools/dottydoc/staticsite/SiteTests.scala

@@ -90,6 +90,7 @@ class SiteTests extends DottyDocTest with SourceFileOps {
       "css/color-brewer.css",
       "css/bootstrap.min.css",
       "css/font-awesome.min.css",
+      "js/api-search.js",
       "js/highlight.pack.js",
       "js/bootstrap.min.js",
       "js/tether.min.js",