Adds support for headless chrome embedder mojo services

headless/public/headless_web_contents.h

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef HEADLESS_PUBLIC_HEADLESS_WEB_CONTENTS_H_
 #define HEADLESS_PUBLIC_HEADLESS_WEB_CONTENTS_H_
 
-#include "base/callback.h"
+#include <list>
+
+#include "base/bind.h"
 #include "base/macros.h"
 #include "headless/public/headless_export.h"
+#include "mojo/public/cpp/bindings/interface_request.h"
 #include "ui/gfx/geometry/size.h"
 #include "url/gurl.h"
 
 namespace headless {
 class HeadlessBrowserContext;
 class HeadlessBrowserImpl;
 class HeadlessDevToolsTarget;
 
 // Class representing contents of a browser tab. Should be accessed from browser
 // main thread.
@@ skipping 54 matching lines @@
 
   // Specify the initial window size (default is 800x600).
   Builder& SetWindowSize(const gfx::Size& size);
 
   // Set a browser context for storing session data (e.g., cookies, cache, local
   // storage) for the tab. Several tabs can share the same browser context. If
   // unset, the default browser context will be used. The browser context must
   // outlive this HeadlessWebContents.
   Builder& SetBrowserContext(HeadlessBrowserContext* browser_context);
 
+  // Specify an embedder provided Mojo service to be installed.  The
+  // |service_factory| callback is called on demand by Mojo to instantiate the
+  // service if any client asks for it.  Note if JS bindings are used they are
+  // assumed to be in their default location gen/path_to/filenme.mojom.js

[Sami, 2016/06/20 16:58:17]

This comment about the JS bindings file is no longer accurate, right?

[alex clarke (OOO till 29th), 2016/06/20 23:19:13]

Done.

+  template <typename Interface>
+  Builder& AddMojoService(
+      const base::Callback<void(mojo::InterfaceRequest<Interface>)>&
+          service_factory) {
+    return AddMojoService(
+        Interface::Name_,
+        base::Bind(&Builder::ForwardToServiceFactory<Interface>,
+                   service_factory));
+  }
+  Builder& AddMojoService(const std::string& service_name,
+                          const base::Callback<void(
+                              mojo::ScopedMessagePipeHandle)>& service_factory);
+
+  // Specify JS mojo module bindings to be installed, one per mojom file.
+  // Note a single mojom file could potentially define many interfaces.
+  Builder& AddJsMojoBindings(const std::string& mojom_name,

[Sami, 2016/06/20 16:58:16]

Is |mojom_file| a file that is read off disk somewhere? It's a little hard to
tell. If so, could we make it a base::FilePath to make it obvious?

[alex clarke (OOO till 29th), 2016/06/20 23:19:14]

No it's not.

+                             const std::string& js_bindings);

[Sami, 2016/06/20 16:58:16]

Could you document |js_bindings| and where to get it from?

[alex clarke (OOO till 29th), 2016/06/20 23:19:14]

Done.

+
   // The returned object is owned by HeadlessBrowser. Call
   // HeadlessWebContents::Close() to dispose it.
   HeadlessWebContents* Build();
 
  private:
   friend class HeadlessBrowserImpl;
   friend class HeadlessWebContentsImpl;
 
+  template <typename Interface>
+  static void ForwardToServiceFactory(
+      const base::Callback<void(mojo::InterfaceRequest<Interface>)>&
+          service_factory,
+      mojo::ScopedMessagePipeHandle handle) {
+    service_factory.Run(mojo::MakeRequest<Interface>(std::move(handle)));
+  }
+
+  struct MojoService {
+    MojoService();
+    MojoService(const std::string& service_name,
+                const base::Callback<void(mojo::ScopedMessagePipeHandle)>&
+                    service_factory);
+    ~MojoService();
+
+    std::string service_name;
+    base::Callback<void(mojo::ScopedMessagePipeHandle)> service_factory;
+
+   private:
+    DISALLOW_COPY_AND_ASSIGN(MojoService);
+  };
+
+  struct MojoBindings {
+    MojoBindings();
+    MojoBindings(const std::string& mojom_name, const std::string& js_bindings);
+    ~MojoBindings();
+
+    std::string mojom_name;
+    std::string js_bindings;
+
+   private:
+    DISALLOW_COPY_AND_ASSIGN(MojoBindings);
+  };
+
   explicit Builder(HeadlessBrowserImpl* browser);
 
   HeadlessBrowserImpl* browser_;
   GURL initial_url_ = GURL("about:blank");
   gfx::Size window_size_ = gfx::Size(800, 600);
   HeadlessBrowserContext* browser_context_;
+  std::list<MojoService> mojo_services_;
+  std::list<MojoBindings> mojo_bindings_;
 
   DISALLOW_COPY_AND_ASSIGN(Builder);
 };
 
 }  // namespace headless
 
 #endif  // HEADLESS_PUBLIC_HEADLESS_WEB_CONTENTS_H_