Change the DidChangeView update to take a new ViewChanged resource.

webkit/plugins/ppapi/ppapi_plugin_instance.h

 // Copyright (c) 2011 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 WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_
 #define WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_
 
 #include <set>
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/compiler_specific.h"
 #include "base/memory/ref_counted.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/string16.h"
 #include "googleurl/src/gurl.h"
 #include "ppapi/c/dev/pp_cursor_type_dev.h"
 #include "ppapi/c/dev/ppp_printing_dev.h"
 #include "ppapi/c/pp_completion_callback.h"
 #include "ppapi/c/pp_instance.h"
 #include "ppapi/c/pp_resource.h"
 #include "ppapi/c/pp_var.h"
 #include "ppapi/c/ppb_input_event.h"
 #include "ppapi/shared_impl/function_group_base.h"
 #include "ppapi/shared_impl/ppb_instance_shared.h"
+#include "ppapi/shared_impl/ppb_view_shared.h"
 #include "ppapi/thunk/ppb_instance_api.h"
 #include "third_party/skia/include/core/SkRefCnt.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebCanvas.h"
 #include "third_party/WebKit/Source/WebKit/chromium/public/platform/WebString.h"
 #include "ui/base/ime/text_input_type.h"
 #include "ui/gfx/rect.h"
 #include "webkit/plugins/ppapi/plugin_delegate.h"
 #include "webkit/plugins/webkit_plugins_export.h"
 
 struct PP_Point;
@@ skipping 41 matching lines @@
 //
 // Note: to get from a PP_Instance to a PluginInstance*, use the
 // ResourceTracker.
 class WEBKIT_PLUGINS_EXPORT PluginInstance :
     public base::RefCounted<PluginInstance>,
     public ::ppapi::FunctionGroupBase,
     NON_EXPORTED_BASE(public ::ppapi::thunk::PPB_Instance_FunctionAPI),
     public ::ppapi::PPB_Instance_Shared {
  public:
   // Create and return a PluginInstance object which supports the
-  // PPP_Instance_1_0 interface.
+  // given version.
   static PluginInstance* Create1_0(PluginDelegate* delegate,
                                    PluginModule* module,
                                    const void* ppp_instance_if_1_0);
+  static PluginInstance* Create1_1(PluginDelegate* delegate,
+                                   PluginModule* module,
+                                   const void* ppp_instance_if_1_1);
 
   // Delete should be called by the WebPlugin before this destructor.
   virtual ~PluginInstance();
 
   PluginDelegate* delegate() const { return delegate_; }
   PluginModule* module() const { return module_.get(); }
   MessageChannel& message_channel() { return *message_channel_; }
 
   WebKit::WebPluginContainer* container() const { return container_; }
 
-  const gfx::Rect& position() const { return position_; }
-  const gfx::Rect& clip() const { return clip_; }
-
   void set_always_on_top(bool on_top) { always_on_top_ = on_top; }
 
   // Returns the PP_Instance uniquely identifying this instance. Guaranteed
   // nonzero.
   PP_Instance pp_instance() const { return pp_instance_; }
 
   // Does some pre-destructor cleanup on the instance. This is necessary
   // because some cleanup depends on the plugin instance still existing (like
   // calling the plugin's DidDestroy function). This function is called from
   // the WebPlugin implementation when WebKit is about to remove the plugin.
@@ skipping 22 matching lines @@
   // Commit the backing texture to the screen once the side effects some
   // rendering up to an offscreen SwapBuffers are visible.
   void CommitBackingTexture();
 
   // Called when the out-of-process plugin implementing this instance crashed.
   void InstanceCrashed();
 
   // PPB_Instance and PPB_Instance_Private implementation.
   const GURL& plugin_url() const { return plugin_url_; }
   bool full_frame() const { return full_frame_; }
+  const ::ppapi::ViewData& view_data() const { return view_data_; }
   // If |type| is not PP_CURSORTYPE_CUSTOM, |custom_image| and |hot_spot| are
   // ignored.
   bool SetCursor(PP_CursorType_Dev type,
                  PP_Resource custom_image,
                  const PP_Point* hot_spot);
 
   // PPP_Instance and PPP_Instance_Private pass-through.
   bool Initialize(WebKit::WebPluginContainer* container,
                   const std::vector<std::string>& arg_names,
                   const std::vector<std::string>& arg_values,
@@ skipping 142 matching lines @@
   void SimulateInputEvent(const ::ppapi::InputEventData& input_event);
 
   // FunctionGroupBase overrides.
   virtual ::ppapi::thunk::PPB_Instance_FunctionAPI*
       AsPPB_Instance_FunctionAPI() OVERRIDE;
 
   // PPB_Instance_FunctionAPI implementation.
   virtual PP_Bool BindGraphics(PP_Instance instance,
                                PP_Resource device) OVERRIDE;
   virtual PP_Bool IsFullFrame(PP_Instance instance) OVERRIDE;
+  virtual const ::ppapi::ViewData* GetViewData(PP_Instance instance) OVERRIDE;
   virtual PP_Var GetWindowObject(PP_Instance instance) OVERRIDE;
   virtual PP_Var GetOwnerElementObject(PP_Instance instance) OVERRIDE;
   virtual PP_Var ExecuteScript(PP_Instance instance,
                                PP_Var script,
                                PP_Var* exception) OVERRIDE;
   virtual PP_Var GetDefaultCharSet(PP_Instance instance) OVERRIDE;
   virtual void Log(PP_Instance instance,
                    int log_level,
                    PP_Var value) OVERRIDE;
   virtual void LogWithSource(PP_Instance instance,
                              int log_level,
                              PP_Var source,
                              PP_Var value) OVERRIDE;
   virtual void NumberOfFindResultsChanged(PP_Instance instance,
                                           int32_t total,
                                           PP_Bool final_result) OVERRIDE;
   virtual void SelectedFindResultChanged(PP_Instance instance,
                                          int32_t index) OVERRIDE;
   virtual PP_Bool FlashIsFullscreen(PP_Instance instance) OVERRIDE;
   virtual PP_Bool FlashSetFullscreen(PP_Instance instance,
                                      PP_Bool fullscreen) OVERRIDE;
   virtual PP_Bool FlashGetScreenSize(PP_Instance instance,
                                      PP_Size* size) OVERRIDE;
-  virtual PP_Bool IsFullscreen(PP_Instance instance) OVERRIDE;
   virtual PP_Bool SetFullscreen(PP_Instance instance,
                                      PP_Bool fullscreen) OVERRIDE;
   virtual PP_Bool GetScreenSize(PP_Instance instance, PP_Size* size)
       OVERRIDE;
   virtual int32_t RequestInputEvents(PP_Instance instance,
                                      uint32_t event_classes) OVERRIDE;
   virtual int32_t RequestFilteringInputEvents(PP_Instance instance,
                                               uint32_t event_classes) OVERRIDE;
   virtual void ClearInputEventRequest(PP_Instance instance,
                                       uint32_t event_classes) OVERRIDE;
@@ skipping 34 matching lines @@
   bool LoadPdfInterface();
   bool LoadPrintInterface();
   bool LoadPrivateInterface();
   bool LoadSelectionInterface();
   bool LoadZoomInterface();
 
   // Determines if we think the plugin has focus, both content area and webkit
   // (see has_webkit_focus_ below).
   bool PluginHasFocus() const;
 
+  void ScheduleAsyncDidChangeView(const ::ppapi::ViewData& previous_view);
+  void SendAsyncDidChangeView(const ::ppapi::ViewData& previous_view);
+  void SendDidChangeView(const ::ppapi::ViewData& previous_view);
+
   // Reports the current plugin geometry to the plugin by calling
   // DidChangeView.
   void ReportGeometry();
 
   // Queries the plugin for supported print formats and sets |format| to the
   // best format to use. Returns false if the plugin does not support any
   // print format that we can handle (we can handle raster and PDF).
   bool GetPreferredPrintOutputFormat(PP_PrintOutputFormat_Dev* format);
   bool PrintPDFOutput(PP_Resource print_output, WebKit::WebCanvas* canvas);
   bool PrintRasterOutput(PP_Resource print_output, WebKit::WebCanvas* canvas);
@@ skipping 40 matching lines @@
       int selection_end);
 
   // Checks if the security origin of the document containing this instance can
   // assess the security origin of the main frame document.
   bool CanAccessMainFrame() const;
 
   // Returns true if the WebView the plugin is in renders via the accelerated
   // compositing path.
   bool IsViewAccelerated();
 
-  // Remember view parameters that were sent to the plugin.
-  void SetSentDidChangeView(const gfx::Rect& position, const gfx::Rect& clip);
-
   // Track, set and reset size attributes to control the size of the plugin
   // in and out of fullscreen mode.
   void KeepSizeAttributesBeforeFullscreen();
   void SetSizeAttributesForFullscreen();
   void ResetSizeAttributesAfterFullscreen();
 
   PluginDelegate* delegate_;
   scoped_refptr<PluginModule> module_;
   scoped_ptr< ::ppapi::PPP_Instance_Combined> instance_interface_;
 
   PP_Instance pp_instance_;
 
   // NULL until we have been initialized.
   WebKit::WebPluginContainer* container_;
 
   // Plugin URL.
   GURL plugin_url_;
 
   // Indicates whether this is a full frame instance, which means it represents
   // an entire document rather than an embed tag.
   bool full_frame_;
 
+  // Stores the current state of the plugin view.
+  ::ppapi::ViewData view_data_;
+
   // Indicates if we've ever sent a didChangeView to the plugin. This ensure we
   // always send an initial notification, even if the position and clip are the
   // same as the default values.
-  bool sent_did_change_view_;
+  bool sent_initial_did_change_view_;
 
-  // Position in the viewport (which moves as the page is scrolled) of this
-  // plugin. This will be a 0-sized rectangle if the plugin has not yet been
-  // laid out.
-  gfx::Rect position_;
-
-  // Current clip rect. This will be empty if the plugin is not currently
-  // visible. This is in the plugin's coordinate system, so fully visible will
-  // be (0, 0, w, h) regardless of scroll position.
-  gfx::Rect clip_;
+  // Set to true when we've scheduled an asynchronous DidChangeView update for
+  // the purposes of consolidating updates. When this is set, code should
+  // update the view_data_ but not send updates. It will be cleared once the
+  // asynchronous update has been sent out.
+  bool suppress_did_change_view_;
 
   // The current device context for painting in 2D or 3D.
   scoped_refptr< ::ppapi::Resource> bound_graphics_;
 
   // We track two types of focus, one from WebKit, which is the focus among
   // all elements of the page, one one from the browser, which is whether the
   // tab/window has focus. We tell the plugin it has focus only when both of
   // these values are set to true.
   bool has_webkit_focus_;
   bool has_content_area_focus_;
@@ skipping 53 matching lines @@
   // to use a more optimized painting path in some cases.
   bool always_on_top_;
 
   // Implementation of PPB_FlashFullscreen.
 
   // Plugin container for fullscreen mode. NULL if not in fullscreen mode. Note:
   // there is a transition state where fullscreen_container_ is non-NULL but
   // flash_fullscreen_ is false (see above).
   FullscreenContainer* fullscreen_container_;
 
-  // True if we are in fullscreen mode. False if we are in normal mode or
-  // in transition to fullscreen.
+  // True if we are in "flash" fullscreen mode. False if we are in normal mode
+  // or in transition to fullscreen. Normal fullscreen mode is indicated in
+  // the ViewData.
   bool flash_fullscreen_;
 
   // Implementation of PPB_Fullscreen.
 
   // Since entering fullscreen mode is an asynchronous operation, we set this
   // variable to the desired state at the time we issue the fullscreen change
   // request. The plugin will receive a DidChangeView event when it goes
   // fullscreen.
   bool desired_fullscreen_state_;
 
-  // True if we are in fullscreen mode. False if we are in normal mode.
-  // It reflects the previous state when in transition.
-  bool fullscreen_;
-
   // WebKit does not resize the plugin when going into fullscreen mode, so we do
   // this here by modifying the various plugin attributes and then restoring
   // them on exit.
   WebKit::WebString width_before_fullscreen_;
   WebKit::WebString height_before_fullscreen_;
   WebKit::WebString border_before_fullscreen_;
   WebKit::WebString style_before_fullscreen_;
   gfx::Size screen_size_for_fullscreen_;
 
   // The MessageChannel used to implement bidirectional postMessage for the
@@ skipping 19 matching lines @@
 
   PP_CompletionCallback lock_mouse_callback_;
 
   DISALLOW_COPY_AND_ASSIGN(PluginInstance);
 };
 
 }  // namespace ppapi
 }  // namespace webkit
 
 #endif  // WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_