components/guest_view/renderer/guest_view_container.h

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef COMPONENTS_GUEST_VIEW_RENDERER_GUEST_VIEW_CONTAINER_H_
   6 #define COMPONENTS_GUEST_VIEW_RENDERER_GUEST_VIEW_CONTAINER_H_
   7
   8 #include "base/memory/linked_ptr.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "content/public/renderer/browser_plugin_delegate.h"
  11 #include "ipc/ipc_message.h"
  12
  13 namespace guest_view {
  14
  15 class GuestViewRequest;
  16
  17 class GuestViewContainer : public content::BrowserPluginDelegate {
  18  public:
  19   explicit GuestViewContainer(content::RenderFrame* render_frame);
  20
  21   static GuestViewContainer* FromID(int element_instance_id);
  22
  23   // IssueRequest queues up a |request| until the container is ready and
  24   // the browser process has responded to the last request if it's still
  25   // pending.
  26   void IssueRequest(linked_ptr<GuestViewRequest> request);
  27
  28   int element_instance_id() const { return element_instance_id_; }
  29   content::RenderFrame* render_frame() const { return render_frame_; }
  30
  31   // Called by GuestViewContainerDispatcher to dispatch message to this
  32   // container.
  33   bool OnMessageReceived(const IPC::Message& message);
  34
  35   // Destroys this GuestViewContainer after performing necessary cleanup.
  36   // |embedder_frame_destroyed| is true if this destruction is due to the
  37   // embedding frame of the container being destroyed.
  38   void Destroy(bool embedder_frame_destroyed);
  39
  40   // Called when the embedding RenderFrame is destroyed.
  41   virtual void OnRenderFrameDestroyed() {}
  42
  43   // Called to respond to IPCs from the browser process that have not been
  44   // handled by GuestViewContainer.
  45   virtual bool OnMessage(const IPC::Message& message);
  46
  47   // Called to perform actions when a GuestViewContainer gets a geometry.
  48   virtual void OnReady() {}
  49
  50   // Called to perform actions when a GuestViewContainer is about to be
  51   // destroyed.
  52   // Note that this should be called exactly once.
  53   virtual void OnDestroy(bool embedder_frame_destroyed) {}
  54
  55  protected:
  56   ~GuestViewContainer() override;
  57
  58  private:
  59   class RenderFrameLifetimeObserver;
  60   friend class RenderFrameLifetimeObserver;
  61
  62   void RenderFrameDestroyed();
  63
  64   void EnqueueRequest(linked_ptr<GuestViewRequest> request);
  65   void PerformPendingRequest();
  66   void HandlePendingResponseCallback(const IPC::Message& message);
  67
  68   void OnHandleCallback(const IPC::Message& message);
  69
  70   // BrowserPluginDelegate implementation.
  71   void Ready() final;
  72   void SetElementInstanceID(int element_instance_id) final;
  73   void DidDestroyElement() final;
  74   base::WeakPtr<BrowserPluginDelegate> GetWeakPtr() final;
  75
  76   int element_instance_id_;
  77   content::RenderFrame* render_frame_;
  78   scoped_ptr<RenderFrameLifetimeObserver> render_frame_lifetime_observer_;
  79
  80   bool ready_;
  81   bool in_destruction_;
  82
  83   std::deque<linked_ptr<GuestViewRequest> > pending_requests_;
  84   linked_ptr<GuestViewRequest> pending_response_;
  85
  86   base::WeakPtrFactory<GuestViewContainer> weak_ptr_factory_;
  87
  88   DISALLOW_COPY_AND_ASSIGN(GuestViewContainer);
  89 };
  90
  91 }  // namespace guest_view
  92
  93 #endif  // COMPONENTS_GUEST_VIEW_RENDERER_GUEST_VIEW_CONTAINER_H_