headless: Initial headless embedder API implementation

headless/public/headless_web_frame.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_WEB_FRAME_H_
-#define HEADLESS_PUBLIC_WEB_FRAME_H_
+#ifndef HEADLESS_PUBLIC_HEADLESS_WEB_FRAME_H_
+#define HEADLESS_PUBLIC_HEADLESS_WEB_FRAME_H_
 
 #include "base/callback.h"
 #include "base/macros.h"
 #include "base/values.h"
 #include "headless/public/headless_export.h"
+#include "ui/gfx/geometry/size.h"
 
 namespace headless {
 
-class WebDocument;
-
 // Class representing a frame in a web page (e.g. main frame or an iframe).
 // Should be accessed from renderer main thread.
-class HEADLESS_EXPORT WebFrame {
+class HEADLESS_EXPORT HeadlessWebFrame {
  public:
-  virtual ~WebFrame() {}
+  virtual ~HeadlessWebFrame() {}
 
   using ScriptExecutionCallback =
       base::Callback<void(const std::vector<scoped_ptr<base::Value>>&)>;
 
   // Schedule given script for execution.
   virtual void ExecuteScript(const std::string& source_code) = 0;

[pfeldman, 2016/02/09 19:49:51]

I think we should be reusing the remote debugging API framework for this. I'm
currently writing a doc on how it could be applied. For example, this method in
the remote debugging API already exists and supports execution contexts, return
values, exceptions, etc:
http://chromedevtools.github.io/debugger-protocol-viewer/Runtime/#method-eval...

[Sami, 2016/02/09 21:40:51]

Done.

 
   // Execute given script and return its result.
   // Returned value will be converted to json (base::Value).
   // Special effects to bear in mind:
   // - Boolean will be converted to base::FundamentalValue (no surprises here).
   // - Number will be converted to base::FundamentalValue.
   // - Array will be converted to base::ListValue.
   //   Note: All non-numerical properties will be omitted
   //   (e.g. "array = [1, 2, 3]; array['property'] = 'value'; return array"
   //    will return [1, 2, 3]).
   // - Object will be converted to base::DictionaryValue
   //   Note: Only string can be key in base::DictionaryValue, so all non-string
   //   properties will be omitted
   //   (e.g. "obj = Object(); obj['key'] = 'value'; obj[0] = 42;" will return
   //    {"key":"value"}).
   virtual void ExecuteScriptAndReturnValue(

[pfeldman, 2016/02/09 19:49:51]

Here you go, we don't need to reinvent the wheel here.

[Sami, 2016/02/09 21:40:51]

Done.

       const std::string& source_code,
       const ScriptExecutionCallback& callback) = 0;
 
   virtual std::string ContentAsText(size_t max_chars) const = 0;
   virtual std::string ContentAsMarkup() const = 0;
-  virtual proto::Document ContentAsProtobuf() const = 0;
 
   virtual gfx::Size GetScrollOffset() const = 0;

[pfeldman, 2016/02/09 19:49:51]

Are these provisional or are there clients for these?

[Sami, 2016/02/09 21:40:51]

PhantomJS at least exposes these, not sure if anyone uses them.

   virtual void SetScrollOffset(const gfx::Size& offset) = 0;
 
   virtual float GetPageScaleFactor() const = 0;

[pfeldman, 2016/02/09 19:49:51]

ditto

[Sami, 2016/02/09 21:40:51]

Same for these. Perhaps the emulation path could handle these?

   virtual void SetPageScaleFactor(float page_scale_factor) = 0;
 
+ protected:
+  HeadlessWebFrame() {}
+
  private:
-  DISALLOW_COPY_AND_ASSIGN(WebFrame);
+  DISALLOW_COPY_AND_ASSIGN(HeadlessWebFrame);
 };
 
 }  // namespace headless
 
-#endif  // HEADLESS_PUBLIC_WEB_FRAME_H_
+#endif  // HEADLESS_PUBLIC_HEADLESS_WEB_FRAME_H_