Add HandleInputEventAck message to allow out-of-process plugins to respond to user gestures.

webkit/plugins/ppapi/ppapi_plugin_instance.h

 // Copyright (c) 2012 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/dev/ppp_find_dev.h"
 #include "ppapi/c/dev/ppp_selection_dev.h"
 #include "ppapi/c/dev/ppp_zoom_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_time.h"
 #include "ppapi/c/pp_var.h"
 #include "ppapi/c/ppb_audio_config.h"
 #include "ppapi/c/ppb_input_event.h"
 #include "ppapi/c/ppb_gamepad.h"
 #include "ppapi/c/ppp_graphics_3d.h"
 #include "ppapi/c/ppp_input_event.h"
 #include "ppapi/c/ppp_messaging.h"
 #include "ppapi/c/ppp_mouse_lock.h"
 #include "ppapi/c/private/ppp_instance_private.h"
 #include "ppapi/shared_impl/function_group_base.h"
@@ skipping 229 matching lines @@
   void FlashSetFullscreen(bool fullscreen, bool delay_report);
 
   FullscreenContainer* fullscreen_container() const {
     return fullscreen_container_;
   }
 
   // Implementation of PPB_Fullscreen.
 
   // Because going to/from fullscreen is asynchronous, there are 4 states:
   // - normal            : desired_fullscreen_state_ == false
-  //                       fullscreen_ == false
+  //                       view_data_.is_fullscreen == false
   // - fullscreen pending: desired_fullscreen_state_ == true
-  //                       fullscreen_ == false
+  //                       view_data_.is_fullscreen == false
   // - fullscreen        : desired_fullscreen_state_ == true
-  //                       fullscreen_ == true
+  //                       view_data_.is_fullscreen == true
   // - normal pending    : desired_fullscreen_state_ = false
-  //                       fullscreen_ = true
+  //                       view_data_.is_fullscreen = true
   bool IsFullscreenOrPending();
 
   // Switches between fullscreen and normal mode. The transition is
   // asynchronous. WebKit will trigger corresponding VewChanged calls.
   // Returns true on success, false on failure (e.g. trying to enter fullscreen
   // when not processing a user gesture or trying to set fullscreen when
   // already in fullscreen mode).
   bool SetFullscreen(bool fullscreen);
 
   // Implementation of PPB_Flash.
@@ skipping 59 matching lines @@
   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;
+  virtual void ClosePendingUserGesture(PP_Instance instance,
+                                       PP_TimeTicks timestamp);
   virtual void ZoomChanged(PP_Instance instance, double factor) OVERRIDE;
   virtual void ZoomLimitsChanged(PP_Instance instance,
                                  double minimum_factor,
                                  double maximium_factor) OVERRIDE;
   virtual void PostMessage(PP_Instance instance, PP_Var message) OVERRIDE;
   virtual int32_t LockMouse(PP_Instance instance,
                             PP_CompletionCallback callback) OVERRIDE;
   virtual void UnlockMouse(PP_Instance instance) OVERRIDE;
   virtual PP_Var ResolveRelativeToDocument(
       PP_Instance instance,
@@ skipping 95 matching lines @@
   // Returns true if the WebView the plugin is in renders via the accelerated
   // compositing path.
   bool IsViewAccelerated();
 
   // 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();
 
+  // Helper function to determine if an action has a user gesture.
+  bool HasUserGesture();
+
   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.
@@ skipping 127 matching lines @@
   uint32_t filtered_input_event_mask_;
 
   // Text composition status.
   ui::TextInputType text_input_type_;
   gfx::Rect text_input_caret_;
   gfx::Rect text_input_caret_bounds_;
   bool text_input_caret_set_;
 
   PP_CompletionCallback lock_mouse_callback_;
 
+  // Track pending user gestures so out-of-process plugins can respond to
+  // a user gesture after it has been processed.
+  PP_TimeTicks pending_user_gesture_;
+
   DISALLOW_COPY_AND_ASSIGN(PluginInstance);
 };
 
 }  // namespace ppapi
 }  // namespace webkit
 
 #endif  // WEBKIT_PLUGINS_PPAPI_PPAPI_PLUGIN_INSTANCE_H_