content/shell/test_runner/web_frame_test_client.h

// Copyright 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 CONTENT_SHELL_TEST_RUNNER_WEB_FRAME_TEST_CLIENT_H_
#define CONTENT_SHELL_TEST_RUNNER_WEB_FRAME_TEST_CLIENT_H_

#include <string>

#include "base/macros.h"
#include "third_party/blink/public/web/web_local_frame_client.h"

namespace content {
class BlinkTestRunner;
class SpellCheckClient;
class TestRunner;
class WebFrameTestProxy;
class WebViewTestProxy;

// WebFrameTestClient implements WebLocalFrameClient interface, providing
// behavior expected by tests.  WebFrameTestClient ends up used by
// WebFrameTestProxy which coordinates forwarding WebLocalFrameClient calls
// either to WebFrameTestClient or to the product code (i.e. to
// RenderFrameImpl).
class WebFrameTestClient : public blink::WebLocalFrameClient {
 public:
  // Caller has to ensure that all arguments (|web_view_test_proxy| and so
  // forth) live longer than |this|.
  WebFrameTestClient(WebViewTestProxy* web_view_test_proxy,
                     WebFrameTestProxy* web_frame_test_proxy);

  ~WebFrameTestClient() override;

  // Called when the WebLocalFrame backing the RenderFrame exists and knows its
  // position in the frame tree.
  void Initialize();

  // Reset state between tests.
  void Reset();

  static std::string GetFrameDescription(blink::WebLocalFrame* frame);

  bool ShouldContinueNavigation(blink::WebNavigationInfo* info);

  // WebLocalFrameClient overrides needed by WebFrameTestProxy.
  void PostAccessibilityEvent(const ui::AXEvent& event) override;
  void MarkWebAXObjectDirty(const blink::WebAXObject& obj,
                            bool subtree) override;
  void DidChangeSelection(bool is_selection_empty) override;
  void DidChangeContents() override;
  blink::WebPlugin* CreatePlugin(const blink::WebPluginParams& params) override;
  void ShowContextMenu(
      const blink::WebContextMenuData& context_menu_data) override;
  void DidAddMessageToConsole(const blink::WebConsoleMessage& message,
                              const blink::WebString& source_name,
                              unsigned source_line,
                              const blink::WebString& stack_trace) override;
  void DidStartLoading() override;
  void DidStopLoading() override;
  void DidDispatchPingLoader(const blink::WebURL& url) override;
  void WillSendRequest(blink::WebURLRequest& request) override;
  void CheckIfAudioSinkExistsAndIsAuthorized(
      const blink::WebString& sink_id,
      blink::WebSetSinkIdCompleteCallback completion_callback) override;
  void DidClearWindowObject() override;
  blink::WebEffectiveConnectionType GetEffectiveConnectionType() override;

 private:
  TestRunner* test_runner();
  BlinkTestRunner* blink_test_runner();

  void HandleWebAccessibilityEvent(const blink::WebAXObject& obj,
                                   const char* event_name);

  // Borrowed pointers to other parts of web tests state.
  WebViewTestProxy* web_view_test_proxy_;
  WebFrameTestProxy* web_frame_test_proxy_;

  std::unique_ptr<SpellCheckClient> spell_check_;

  DISALLOW_COPY_AND_ASSIGN(WebFrameTestClient);
};

}  // namespace content

#endif  // CONTENT_SHELL_TEST_RUNNER_WEB_FRAME_TEST_CLIENT_H_