OLD | NEW |
---|---|
1 // Copyright 2015 The Chromium Authors. All rights reserved. | 1 // Copyright 2015 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ | 5 #ifndef HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ |
6 #define HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ | 6 #define HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ |
7 | 7 |
8 #include <string> | |
9 | |
8 #include "base/callback.h" | 10 #include "base/callback.h" |
9 #include "base/macros.h" | 11 #include "base/macros.h" |
10 #include "base/memory/ref_counted.h" | 12 #include "base/memory/ref_counted.h" |
11 #include "base/memory/scoped_ptr.h" | 13 #include "base/memory/scoped_ptr.h" |
12 #include "headless/public/headless_export.h" | 14 #include "headless/public/headless_export.h" |
15 #include "net/url_request/url_request_context_getter.h" | |
13 | 16 |
14 namespace base { | 17 namespace base { |
18 class MessagePump; | |
15 class SingleThreadTaskRunner; | 19 class SingleThreadTaskRunner; |
16 | |
17 namespace trace_event { | |
18 class TraceConfig; | |
19 } | |
20 } | 20 } |
21 | 21 |
22 namespace gfx { | 22 namespace gfx { |
23 class Size; | 23 class Size; |
24 } | 24 } |
25 | 25 |
26 namespace net { | 26 namespace net { |
27 class URLRequestContextGetter; | 27 class URLRequestContextGetter; |
28 } | 28 } |
29 | 29 |
30 namespace headless { | 30 namespace headless { |
31 class WebContents; | 31 class HeadlessWebContents; |
32 | 32 |
33 class HEADLESS_EXPORT HeadlessBrowser { | 33 class HEADLESS_EXPORT HeadlessBrowser { |
34 public: | 34 public: |
35 static HeadlessBrowser* Get(); | |
36 | |
37 struct Options; | 35 struct Options; |
38 | 36 |
39 // Main routine for running browser. | 37 // Main routine for running browser. |
40 // Takes command line args and callback to run as soon as browser starts. | 38 // Takes command line args and callback to run as soon as browser starts. |
41 static int Run( | 39 using StartCallback = base::Callback<void(HeadlessBrowser*)>; |
42 const Options& options, | 40 static int Run(const Options& options, |
43 const base::Callback<void(HeadlessBrowser*)>& on_browser_start_callback); | 41 const StartCallback& on_browser_start_callback); |
Ryan Sleevi
2016/02/22 22:01:22
DESIGN: It's worth highlighting that this is a wei
Sami
2016/02/23 20:19:08
I've now refactored this to split out the main ent
| |
44 | 42 |
45 // Create a new browser tab. | 43 // Create a new browser tab. |size| is in physical pixels. |
46 virtual scoped_ptr<WebContents> CreateWebContents(const gfx::Size& size) = 0; | 44 virtual scoped_ptr<HeadlessWebContents> CreateWebContents( |
45 const gfx::Size& size) = 0; | |
47 | 46 |
48 virtual scoped_refptr<base::SingleThreadTaskRunner> BrowserMainThread() = 0; | 47 virtual scoped_refptr<base::SingleThreadTaskRunner> BrowserMainThread() |
49 virtual scoped_refptr<base::SingleThreadTaskRunner> RendererMainThread() = 0; | 48 const = 0; |
50 | 49 |
51 // Requests browser to stop as soon as possible. | 50 // Requests browser to stop as soon as possible. |
52 // |Run| will return as soon as browser stops. | 51 // |Run| will return as soon as browser stops. |
53 virtual void Stop() = 0; | 52 virtual void Stop() = 0; |
54 | 53 |
55 virtual void StartTracing(const base::trace_event::TraceConfig& trace_config, | |
56 const base::Closure& on_tracing_started) = 0; | |
57 virtual void StopTracing(const std::string& log_file_name, | |
58 const base::Closure& on_tracing_stopped) = 0; | |
59 | |
60 protected: | 54 protected: |
55 HeadlessBrowser() {} | |
61 virtual ~HeadlessBrowser() {} | 56 virtual ~HeadlessBrowser() {} |
62 | 57 |
63 private: | 58 private: |
64 DISALLOW_COPY_AND_ASSIGN(HeadlessBrowser); | 59 DISALLOW_COPY_AND_ASSIGN(HeadlessBrowser); |
65 }; | 60 }; |
66 | 61 |
62 // Embedding API overrides for the headless browser. | |
67 struct HeadlessBrowser::Options { | 63 struct HeadlessBrowser::Options { |
68 ~Options(); | 64 ~Options(); |
69 | 65 |
70 class Builder; | 66 class Builder; |
71 | 67 |
72 // Command line options to be passed to browser. | 68 // Command line options to be passed to browser. |
73 int argc; | 69 int argc; |
74 const char** argv; | 70 const char** argv; |
75 | 71 |
76 std::string user_agent; | 72 std::string user_agent; |
77 std::string navigator_platform; | 73 std::string navigator_platform; |
78 | 74 |
79 static const int kInvalidPort = -1; | 75 static const int kInvalidPort = -1; |
80 // If not null, create start devtools for remote debugging | |
81 // on specified port. | |
82 int devtools_http_port; | 76 int devtools_http_port; |
83 | 77 |
84 // Optional URLRequestContextGetter for customizing network stack. | 78 // Optional URLRequestContextGetter for customizing network stack. Allows |
85 // Allows overriding: | 79 // overriding, e.g.: |
86 // - Cookie storage | 80 // - Cookie storage |
87 // - HTTP cache | 81 // - HTTP cache |
88 // - SSL config | 82 // - SSL config |
89 // - Proxy service | 83 // - Proxy service |
84 // | |
85 // See HeadlessNetwork for more details. | |
Ryan Sleevi
2016/02/22 22:01:21
DESIGN/LAYER: This seems to document your implemen
Sami
2016/02/23 20:19:08
Agreed, I think we'll need to do some more design
| |
90 scoped_refptr<net::URLRequestContextGetter> url_request_context_getter; | 86 scoped_refptr<net::URLRequestContextGetter> url_request_context_getter; |
91 | 87 |
92 scoped_ptr<base::MessagePump> message_pump; | 88 // Optional message pump that overrides the default. Must outlive the browser. |
89 base::MessagePump* message_pump; | |
93 | 90 |
94 private: | 91 private: |
95 Options(int argc, const char** argv); | 92 Options(int argc, const char** argv); |
96 }; | 93 }; |
97 | 94 |
98 class HeadlessBrowser::Options::Builder { | 95 class HeadlessBrowser::Options::Builder { |
99 public: | 96 public: |
100 Builder(int argc, const char** argv); | 97 Builder(int argc, const char** argv); |
101 ~Builder(); | 98 ~Builder(); |
102 | 99 |
103 Builder& SetUserAgent(const std::string& user_agent); | 100 Builder& SetUserAgent(const std::string& user_agent); |
104 Builder& EnableDevToolsServer(int port); | 101 Builder& EnableDevToolsServer(int port); |
105 Builder& SetURLRequestContextGetter( | 102 Builder& SetURLRequestContextGetter( |
106 scoped_refptr<net::URLRequestContextGetter> url_request_context_getter); | 103 scoped_refptr<net::URLRequestContextGetter> url_request_context_getter); |
104 Builder& SetMessagePump(base::MessagePump* message_pump); | |
107 | 105 |
108 Options Build(); | 106 Options Build(); |
109 | 107 |
110 private: | 108 private: |
111 Options options_; | 109 Options options_; |
112 | 110 |
113 DISALLOW_COPY_AND_ASSIGN(Builder); | 111 DISALLOW_COPY_AND_ASSIGN(Builder); |
114 }; | 112 }; |
115 | 113 |
116 } // namespace headless | 114 } // namespace headless |
117 | 115 |
118 #endif // HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ | 116 #endif // HEADLESS_PUBLIC_HEADLESS_BROWSER_H_ |
OLD | NEW |