mandoline/tab/frame_devtools_agent.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 MANDOLINE_TAB_FRAME_DEVTOOLS_AGENT_H_
#define MANDOLINE_TAB_FRAME_DEVTOOLS_AGENT_H_

#include <map>
#include <string>

#include "base/macros.h"
#include "base/memory/scoped_ptr.h"
#include "components/devtools_service/public/interfaces/devtools_service.mojom.h"
#include "mandoline/tab/frame.h"
#include "third_party/mojo/src/mojo/public/cpp/bindings/binding.h"

namespace base {
class DictionaryValue;
}

namespace mojo {
class ApplicationImpl;
}

namespace web_view {

class FrameDevToolsAgentDelegate;

// FrameDevToolsAgent relays messages between the DevTools service and the
// DevTools agent of the frame that it attaches to.
// It persists state across frame navigations and also intercepts
// "Page.navigate" requests.
class FrameDevToolsAgent : public devtools_service::DevToolsAgent {
 public:
  FrameDevToolsAgent(mojo::ApplicationImpl* app,
                     FrameDevToolsAgentDelegate* delegate);
  ~FrameDevToolsAgent() override;

  // Attaches this agent to a new frame. |forward_agent| is the DevToolsAgent
  // interface provided by the frame. DevTools-related properties are added to
  // |devtools_properties|, which should be passed to the frame to initialize
  // its DevTools agent.
  void AttachFrame(devtools_service::DevToolsAgentPtr forward_agent,
                   mandoline::Frame::ClientPropertyMap* devtools_properties);

 private:
  class FrameDevToolsAgentClient;

  void RegisterAgentIfNecessary();

  void HandlePageNavigateRequest(const base::DictionaryValue* request);

  // devtools_service::DevToolsAgent implementation.
  void SetClient(devtools_service::DevToolsAgentClientPtr client) override;
  void DispatchProtocolMessage(const mojo::String& message) override;

  // The following methods are called by |client_impl_|.
  void OnReceivedClientMessage(int32_t call_id,
                               const mojo::String& message,
                               const mojo::String& state);
  void OnForwardClientClosed();

  mojo::ApplicationImpl* const app_;
  FrameDevToolsAgentDelegate* const delegate_;

  const std::string id_;

  scoped_ptr<FrameDevToolsAgentClient> client_impl_;

  mojo::Binding<DevToolsAgent> binding_;
  // The DevToolsAgent interface provided by the frame. This class will forward
  // DevToolsAgent method calls it receives to |forward_agent_|.
  devtools_service::DevToolsAgentPtr forward_agent_;

  std::string state_;
  std::map<int, std::string> pending_messages_;

  DISALLOW_COPY_AND_ASSIGN(FrameDevToolsAgent);
};

}  // namespace web_view

#endif  // MANDOLINE_TAB_FRAME_DEVTOOLS_AGENT_H_