1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166
|
// This file is generated
// Copyright (c) 2016 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_DEVTOOLS_DOMAINS_{{domain.domain | camelcase_to_hacker_style | upper}}_H_
#define HEADLESS_PUBLIC_DEVTOOLS_DOMAINS_{{domain.domain | camelcase_to_hacker_style | upper}}_H_
#include "base/callback.h"
#include "base/observer_list.h"
#include "base/values.h"
{% for domain_name in domain.dependencies %}
#include "headless/public/devtools/domains/types_{{domain_name | camelcase_to_hacker_style}}.h"
{% endfor %}
#include "headless/public/headless_export.h"
#include "headless/public/internal/message_dispatcher.h"
{# Macro for defining a member function for a given command. #}
{% macro command_decl(command) %}
{% set method_name = command.name | to_title_case %}
{% if command.description %}
// {{ command.description }}
{% endif %}
void {{method_name}}(std::unique_ptr<{{method_name}}Params> params, base::Callback<void(std::unique_ptr<{{method_name}}Result>)> callback = base::Callback<void(std::unique_ptr<{{method_name}}Result>)>());
{# Generate convenience methods that take the required parameters directly. #}
{# Don't generate these for experimental commands. #}
{% if "parameters" in command and not command.experimental %}
void {{method_name}}({##}
{% for parameter in command.parameters -%}
{% if parameter.get("optional", False) -%}
{% break %}
{% endif %}
{% if not loop.first %}, {% endif %}
{{resolve_type(parameter).pass_type}} {{parameter.name | camelcase_to_hacker_style -}}
{% endfor %}
{% if command.get("parameters", []) and not command.parameters[0].get("optional", False) %}, {% endif %}{# -#}
{% if command.get("returns", []) -%}
base::Callback<void(std::unique_ptr<{{method_name}}Result>)> callback = base::Callback<void(std::unique_ptr<{{method_name}}Result>)>(){##}
{% else -%}
base::Callback<void()> callback = base::Callback<void()>(){##}
{% endif %});
{# If the command has no return value, generate a convenience method that #}
{# accepts a base::Callback<void()> together with the parameters object. #}
{% if not command.get("returns", []) %}
void {{method_name}}(std::unique_ptr<{{method_name}}Params> params, base::Callback<void()> callback);
{% endif %}
{% endif %}
{% endmacro %}
namespace headless {
namespace {{domain.domain | camelcase_to_hacker_style}} {
class ExperimentalDomain;
class ExperimentalObserver;
{% if "events" in domain %}
class HEADLESS_EXPORT ExperimentalObserver {
public:
virtual ~ExperimentalObserver() {}
{% for event in domain.events %}
{% if event.description %}
// {{event.description}}
{% endif %}
virtual void On{{event.name | to_title_case}}(const {{event.name | to_title_case}}Params& params) {}
{% endfor %}
};
class HEADLESS_EXPORT Observer : public ExperimentalObserver {
public:
virtual ~Observer() {}
{% for event in domain.events %}
{% if event.description %}
// {% if event.experimental %}Experimental: {% endif %}{{event.description}}
{% endif %}
virtual void On{{event.name | to_title_case}}(const {{event.name | to_title_case}}Params& params) {% if event.experimental %}final {% endif %}{}
{% endfor %}
};
{% endif %}
{% if domain.description %}
// {{domain.description}}
{% endif %}
class HEADLESS_EXPORT Domain {
public:
{% if "events" in domain %}
// Add or remove an observer. |observer| must be removed before being
// destroyed.
void AddObserver(Observer* observer);
void RemoveObserver(Observer* observer);
{% endif %}
// Return the experimental interface for this domain. Note that experimental
// commands may be changed or removed at any time.
ExperimentalDomain* GetExperimental();
{# Generate methods for each command. #}
{% for command in domain.commands %}
{# Skip redirected commands. #}
{% if "redirect" in command %}{% continue %}{% endif %}
{# Skip experimental commands. #}
{% if command.experimental %}{% continue %}{% endif %}
{{ command_decl(command) }}
{% endfor %}
protected:
Domain(internal::MessageDispatcher* dispatcher);
~Domain();
{# Generate response handlers for commands that need them. #}
{% for command in domain.commands %}
{% if not "returns" in command %}{% continue %}{% endif %}
{% set method_name = command.name | to_title_case %}
static void Handle{{method_name}}Response(base::Callback<void(std::unique_ptr<{{method_name}}Result>)> callback, const base::Value& response);
{% endfor %}
{# Generate event dispatchers. #}
{% for event in domain.events %}
void Dispatch{{event.name | to_title_case}}Event(const base::Value& params);
{% endfor %}
internal::MessageDispatcher* dispatcher_; // Not owned.
{% if "events" in domain %}
base::ObserverList<ExperimentalObserver> observers_;
{% endif %}
{% if "events" in domain %}
protected:
void RegisterEventHandlersIfNeeded();
{% endif %}
private:
{% if "events" in domain %}
bool event_handlers_registered_ = false;
{% endif %}
DISALLOW_COPY_AND_ASSIGN(Domain);
};
class ExperimentalDomain : public Domain {
public:
ExperimentalDomain(internal::MessageDispatcher* dispatcher);
~ExperimentalDomain();
{% if "events" in domain %}
// Add or remove an observer. |observer| must be removed before being
// destroyed.
void AddObserver(ExperimentalObserver* observer);
void RemoveObserver(ExperimentalObserver* observer);
{% endif %}
{# Generate methods for each experimental command. #}
{% for command in domain.commands %}
{# Skip redirected commands. #}
{% if "redirect" in command %}{% continue %}{% endif %}
{# Skip non-experimental commands. #}
{% if not command.experimental %}{% continue %}{% endif %}
{{ command_decl(command) }}
{% endfor %}
private:
DISALLOW_COPY_AND_ASSIGN(ExperimentalDomain);
};
} // namespace {{domain.domain | camelcase_to_hacker_style}}
} // namespace headless
#endif // HEADLESS_PUBLIC_DEVTOOLS_DOMAINS_{{domain.domain | camelcase_to_hacker_style | upper}}_H_
|