Towards Decoupling GuestView from Extensions

extensions/browser/guest_view/guest_view_base.h

 // Copyright 2014 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 EXTENSIONS_BROWSER_GUEST_VIEW_GUEST_VIEW_BASE_H_
 #define EXTENSIONS_BROWSER_GUEST_VIEW_GUEST_VIEW_BASE_H_
 
 #include <queue>
 
 #include "base/memory/weak_ptr.h"
 #include "base/values.h"
 #include "components/ui/zoom/zoom_observer.h"
 #include "content/public/browser/browser_plugin_guest_delegate.h"
 #include "content/public/browser/guest_host.h"
 #include "content/public/browser/render_process_host_observer.h"
 #include "content/public/browser/web_contents.h"
 #include "content/public/browser/web_contents_delegate.h"
 #include "content/public/browser/web_contents_observer.h"
 #include "extensions/common/guest_view/guest_view_constants.h"
 
 struct RendererContentSettingRules;
 
 namespace extensions {
 
+class GuestViewEvent;
+
 // A struct of parameters for SetSize(). The parameters are all declared as
 // scoped pointers since they are all optional. Null pointers indicate that the
 // parameter has not been provided, and the last used value should be used. Note
 // that when |enable_auto_size| is true, providing |normal_size| is not
 // meaningful. This is because the normal size of the guestview is overridden
 // whenever autosizing occurs.
 struct SetSizeParams {
   SetSizeParams();
   ~SetSizeParams();
 
   scoped_ptr<bool> enable_auto_size;
   scoped_ptr<gfx::Size> min_size;
   scoped_ptr<gfx::Size> max_size;
   scoped_ptr<gfx::Size> normal_size;
 };
 
 // A GuestViewBase is the base class browser-side API implementation for a
 // <*view> tag. GuestViewBase maintains an association between a guest
 // WebContents and an owner WebContents. It receives events issued from
 // the guest and relays them to the owner. GuestViewBase tracks the lifetime
 // of its owner. A GuestViewBase's owner is referred to as an embedder if
 // it is attached to a container within the owner's WebContents.
 class GuestViewBase : public content::BrowserPluginGuestDelegate,
                       public content::WebContentsDelegate,
                       public content::WebContentsObserver,
                       public ui_zoom::ZoomObserver {
  public:
-  class Event {
-   public:
-    Event(const std::string& name, scoped_ptr<base::DictionaryValue> args);
-    ~Event();
-
-    const std::string& name() const { return name_; }
-
-    scoped_ptr<base::DictionaryValue> GetArguments();
-
-   private:
-    const std::string name_;
-    scoped_ptr<base::DictionaryValue> args_;
-  };
-
   // Returns a *ViewGuest if this GuestView is of the given view type.
   template <typename T>
   T* As() {
     if (IsViewType(T::Type))
       return static_cast<T*>(this);
 
     return nullptr;
   }
 
   using GuestCreationCallback =
@@ skipping 223 matching lines @@
   void SetGuestHost(content::GuestHost* guest_host) final;
   void WillAttach(content::WebContents* embedder_web_contents,
                   int browser_plugin_instance_id,
                   bool is_full_page_plugin) final;
 
   // ui_zoom::ZoomObserver implementation.
   void OnZoomChanged(
       const ui_zoom::ZoomController::ZoomChangedEventData& data) final;
 
   // Dispatches an event to the guest proxy.
-  void DispatchEventToGuestProxy(Event* event);
+  void DispatchEventToGuestProxy(GuestViewEvent* event);
 
   // Dispatches an event to the view.
-  void DispatchEventToView(Event* event);
+  void DispatchEventToView(GuestViewEvent* event);
 
  protected:
   explicit GuestViewBase(content::WebContents* owner_web_contents);
 
   ~GuestViewBase() override;
 
   // Convert sizes in pixels from logical to physical numbers of pixels.
   // Note that a size can consist of a fractional number of logical pixels
   // (hence |logical_pixels| is represented as a double), but will always
   // consist of an integral number of physical pixels (hence the return value
@@ skipping 40 matching lines @@
                            const gfx::Size& pref_size) final;
   void UpdateTargetURL(content::WebContents* source, const GURL& url) override;
 
   void SetGuestZoomLevelToMatchEmbedder();
 
  private:
   class OwnerContentsObserver;
 
   class OpenerLifetimeObserver;
 
-  void DispatchEvent(Event* event, int instance_id);
-
   void SendQueuedEvents();
 
   void CompleteInit(scoped_ptr<base::DictionaryValue> create_params,
                     const WebContentsCreatedCallback& callback,
                     content::WebContents* guest_web_contents);
 
   // Dispatches the onResize event to the embedder.
   void DispatchOnResizeEvent(const gfx::Size& old_size,
                              const gfx::Size& new_size);
 
@@ skipping 31 matching lines @@
 
   // |initialized_| indicates whether GuestViewBase::Init has been called for
   // this object.
   bool initialized_;
 
   // Indicates that this guest is in the process of being destroyed.
   bool is_being_destroyed_;
 
   // This is a queue of Events that are destined to be sent to the embedder once
   // the guest is attached to a particular embedder.
-  std::deque<linked_ptr<Event> > pending_events_;
+  std::deque<linked_ptr<GuestViewEvent> > pending_events_;
 
   // The opener guest view.
   base::WeakPtr<GuestViewBase> opener_;
 
   // The parameters associated with the element hosting this GuestView that
   // are passed in from JavaScript. This will typically be the view instance ID,
   // and element-specific parameters. These parameters are passed along to new
   // guests that are created from this guest.
   scoped_ptr<base::DictionaryValue> attach_params_;
 
@@ skipping 33 matching lines @@
   // This is used to ensure pending tasks will not fire after this object is
   // destroyed.
   base::WeakPtrFactory<GuestViewBase> weak_ptr_factory_;
 
   DISALLOW_COPY_AND_ASSIGN(GuestViewBase);
 };
 
 }  // namespace extensions
 
 #endif  // EXTENSIONS_BROWSER_GUEST_VIEW_GUEST_VIEW_BASE_H_