components/plugins/renderer/plugin_placeholder.h

// Copyright 2013 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef COMPONENTS_PLUGINS_RENDERER_PLUGIN_PLACEHOLDER_H_
#define COMPONENTS_PLUGINS_RENDERER_PLUGIN_PLACEHOLDER_H_

#include "base/memory/raw_ptr.h"
#include "components/plugins/renderer/webview_plugin.h"
#include "content/public/renderer/render_frame_observer.h"
#include "gin/public/wrappable_pointer_tags.h"
#include "gin/wrappable.h"
#include "third_party/blink/public/web/blink.h"
#include "third_party/blink/public/web/web_plugin_params.h"
#include "v8/include/cppgc/persistent.h"

namespace plugins {

// This abstract class is the base class of all plugin placeholders.
class PluginPlaceholderBase : public content::RenderFrameObserver,
                              public WebViewPlugin::Delegate {
 public:
  // |render_frame| is a weak pointer. If it is going away, our |plugin_| will
  // be destroyed as well and will notify us. `Init` must be called after
  // this object is constructed.
  PluginPlaceholderBase(content::RenderFrame* render_frame,
                        const blink::WebPluginParams& params);
  virtual void Init(const std::string& html_data);

  PluginPlaceholderBase(const PluginPlaceholderBase&) = delete;
  PluginPlaceholderBase& operator=(const PluginPlaceholderBase&) = delete;

  ~PluginPlaceholderBase() override;

  WebViewPlugin* plugin() { return plugin_; }

 protected:
  const blink::WebPluginParams& GetPluginParams() const;

  // WebViewPlugin::Delegate methods:
  void ShowContextMenu(const blink::WebMouseEvent&) override;
  void PluginDestroyed() override;
  v8::Local<v8::Object> GetV8ScriptableObject(
      v8::Isolate* isolate) const override;
  bool IsErrorPlaceholder() override;

  // Hide this placeholder.
  void HidePlugin();
  bool hidden() const { return hidden_; }

 protected:
  // JavaScript callbacks:
  void HideCallback();
  void NotifyPlaceholderReadyForTestingCallback();

  // RenderFrameObserver methods:
  void OnDestruct() override;

 private:
  blink::WebPluginParams plugin_params_;
  raw_ptr<WebViewPlugin> plugin_;

  bool hidden_ = false;
};

// A basic placeholder that supports only hiding.
class PluginPlaceholder final : public gin::Wrappable<PluginPlaceholder>,
                                public PluginPlaceholderBase {
 public:
  static constexpr gin::WrapperInfo kWrapperInfo = {{gin::kEmbedderNativeGin},
                                                    gin::kPluginPlaceholder};

  PluginPlaceholder(content::RenderFrame* render_frame,
                    const blink::WebPluginParams& params);
  ~PluginPlaceholder() override;

  static PluginPlaceholder* Create(content::RenderFrame* render_frame,
                                   const blink::WebPluginParams& params,
                                   const std::string& html_data);

  // gin::WrappableBase overrides:
  const gin::WrapperInfo* wrapper_info() const override;

 private:
  // WebViewPlugin::Delegate methods:
  v8::Local<v8::Value> GetV8Handle(v8::Isolate* isolate) final;

  // gin::Wrappable method:
  gin::ObjectTemplateBuilder GetObjectTemplateBuilder(
      v8::Isolate* isolate) override;

  // RenderFrameObserver override.
  void OnDestruct() override;

  // Keeps `this` alive until `OnDestruct()` is called.
  cppgc::Persistent<PluginPlaceholder> self_;
};

}  // namespace plugins

#endif  // COMPONENTS_PLUGINS_RENDERER_PLUGIN_PLACEHOLDER_H_