content/browser/browser_plugin/browser_plugin_embedder.h

   1 // Copyright (c) 2012 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 // A BrowserPluginEmbedder handles messages coming from a BrowserPlugin's
   6 // embedder that are not directed at any particular existing guest process.
   7 // In the beginning, when a BrowserPlugin instance in the embedder renderer
   8 // process requests an initial navigation, the WebContents for that renderer
   9 // renderer creates a BrowserPluginEmbedder for itself. The
  10 // BrowserPluginEmbedder, in turn, forwards the requests to a
  11 // BrowserPluginGuestManager, which creates and manages the lifetime of the new
  12 // guest.
  13
  14 #ifndef CONTENT_BROWSER_BROWSER_PLUGIN_BROWSER_PLUGIN_EMBEDDER_H_
  15 #define CONTENT_BROWSER_BROWSER_PLUGIN_BROWSER_PLUGIN_EMBEDDER_H_
  16
  17 #include <map>
  18
  19 #include "base/memory/weak_ptr.h"
  20 #include "base/values.h"
  21 #include "content/public/browser/web_contents.h"
  22 #include "content/public/browser/web_contents_observer.h"
  23 #include "third_party/WebKit/public/web/WebDragOperation.h"
  24
  25 struct BrowserPluginHostMsg_Attach_Params;
  26 struct BrowserPluginHostMsg_ResizeGuest_Params;
  27
  28 namespace gfx {
  29 class Point;
  30 }
  31
  32 namespace content {
  33
  34 class BrowserPluginGuest;
  35 class BrowserPluginGuestManager;
  36 class RenderWidgetHostImpl;
  37 class WebContentsImpl;
  38 struct NativeWebKeyboardEvent;
  39
  40 class CONTENT_EXPORT BrowserPluginEmbedder : public WebContentsObserver {
  41  public:
  42   ~BrowserPluginEmbedder() override;
  43
  44   static BrowserPluginEmbedder* Create(WebContentsImpl* web_contents);
  45
  46   // Returns this embedder's WebContentsImpl.
  47   WebContentsImpl* GetWebContents() const;
  48
  49   // Called when embedder's |rwh| has sent screen rects to renderer.
  50   void DidSendScreenRects();
  51
  52   // WebContentsObserver implementation.
  53   bool OnMessageReceived(const IPC::Message& message) override;
  54
  55   void DragSourceEndedAt(int client_x, int client_y, int screen_x,
  56       int screen_y, blink::WebDragOperation operation);
  57
  58   void OnUpdateDragCursor(bool* handled);
  59
  60   void DragEnteredGuest(BrowserPluginGuest* guest);
  61
  62   void DragLeftGuest(BrowserPluginGuest* guest);
  63
  64   void StartDrag(BrowserPluginGuest* guest);
  65
  66   // Sends EndSystemDrag message to the guest that initiated the last drag/drop
  67   // operation, if there's any.
  68   void SystemDragEnded();
  69
  70   // Used to handle special keyboard events.
  71   bool HandleKeyboardEvent(const NativeWebKeyboardEvent& event);
  72
  73   // Find the given |search_text| in the page. Returns true if the find request
  74   // is handled by this browser plugin embedder.
  75   bool Find(int request_id,
  76             const base::string16& search_text,
  77             const blink::WebFindOptions& options);
  78
  79  private:
  80   explicit BrowserPluginEmbedder(WebContentsImpl* web_contents);
  81
  82   BrowserPluginGuestManager* GetBrowserPluginGuestManager() const;
  83
  84   void ClearGuestDragStateIfApplicable();
  85
  86   bool DidSendScreenRectsCallback(WebContents* guest_web_contents);
  87
  88   bool UnlockMouseIfNecessaryCallback(bool* mouse_unlocked, WebContents* guest);
  89
  90   bool FindInGuest(int request_id,
  91                    const base::string16& search_text,
  92                    const blink::WebFindOptions& options,
  93                    WebContents* guest);
  94
  95   // Message handlers.
  96   void OnAttach(int instance_id,
  97                 const BrowserPluginHostMsg_Attach_Params& params);
  98   void OnPluginAtPositionResponse(int instance_id,
  99                                   int request_id,
 100                                   const gfx::Point& position);
 101
 102   // Used to correctly update the cursor when dragging over a guest, and to
 103   // handle a race condition when dropping onto the guest that started the drag
 104   // (the race is that the dragend message arrives before the drop message so
 105   // the drop never takes place).
 106   // crbug.com/233571
 107   base::WeakPtr<BrowserPluginGuest> guest_dragging_over_;
 108
 109   // Pointer to the guest that started the drag, used to forward necessary drag
 110   // status messages to the correct guest.
 111   base::WeakPtr<BrowserPluginGuest> guest_started_drag_;
 112
 113   // Keeps track of "dragend" state.
 114   bool guest_drag_ending_;
 115
 116   base::WeakPtrFactory<BrowserPluginEmbedder> weak_ptr_factory_;
 117
 118   DISALLOW_COPY_AND_ASSIGN(BrowserPluginEmbedder);
 119 };
 120
 121 }  // namespace content
 122
 123 #endif  // CONTENT_BROWSER_BROWSER_PLUGIN_BROWSER_PLUGIN_EMBEDDER_H_