Refactor code listening to platform events in content/renderer/.

content/renderer/renderer_webkitplatformsupport_impl.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 CONTENT_RENDERER_RENDERER_WEBKITPLATFORMSUPPORT_IMPL_H_
 #define CONTENT_RENDERER_RENDERER_WEBKITPLATFORMSUPPORT_IMPL_H_
 
 #include "base/compiler_specific.h"
+#include "base/id_map.h"
 #include "base/memory/scoped_ptr.h"
 #include "content/child/blink_platform_impl.h"
 #include "content/common/content_export.h"
 #include "content/renderer/compositor_bindings/web_compositor_support_impl.h"
 #include "content/renderer/webpublicsuffixlist_impl.h"
 #include "third_party/WebKit/public/platform/WebGraphicsContext3D.h"
 #include "third_party/WebKit/public/platform/WebIDBFactory.h"
 #include "third_party/WebKit/public/platform/WebScreenOrientationType.h"
 
 namespace base {
@@ skipping 13 matching lines @@
 class WebDeviceMotionData;
 class WebDeviceOrientationData;
 class WebGraphicsContext3DProvider;
 }
 
 namespace content {
 class BatteryStatusDispatcher;
 class DeviceLightEventPump;
 class DeviceMotionEventPump;
 class DeviceOrientationEventPump;
+class PlatformEventObserverBase;
 class QuotaMessageFilter;
 class RendererClipboardClient;
 class RenderView;
-class RendererGamepadProvider;
 class ThreadSafeSender;
 class WebClipboardImpl;
 class WebDatabaseObserverImpl;
 class WebFileSystemImpl;
 
 class CONTENT_EXPORT RendererWebKitPlatformSupportImpl
     : public BlinkPlatformImpl {
  public:
   RendererWebKitPlatformSupportImpl();
   virtual ~RendererWebKitPlatformSupportImpl();
@@ skipping 83 matching lines @@
   virtual void startListening(blink::WebPlatformEventType,
                               blink::WebPlatformEventListener*);
   virtual void stopListening(blink::WebPlatformEventType);
   virtual void queryStorageUsageAndQuota(
       const blink::WebURL& storage_partition,
       blink::WebStorageQuotaType,
       blink::WebStorageQuotaCallbacks);
   virtual void vibrate(unsigned int milliseconds);
   virtual void cancelVibration();
 
-  void set_gamepad_provider(RendererGamepadProvider* provider) {
-    gamepad_provider_ = provider;
-  }
+  // Set the PlatformEventObserverBase in |platform_event_observers_| associated
+  // with |type| to |observer|. If there was already an observer associated to
+  // the given |type|, it will be overridden.

[Avi (use Gerrit), 2014/08/07 19:56:11]

What does "overridden" mean here? Use "replaced" if that is what you mean.

[mlamouri (slow - plz ping), 2014/08/08 18:08:36]

Done.

+  // Note that |observer| will be owned by this object after the call.

[Avi (use Gerrit), 2014/08/07 19:56:11]

If you are taking ownership, indicate that in the code by making the parameter a
scoped_ptr. Don't annotate it with only comments.

[mlamouri (slow - plz ping), 2014/08/08 18:08:36]

Done.

+  void SetPlatformEventObserverForTesting(blink::WebPlatformEventType type,
+                                          PlatformEventObserverBase* observer);
 
   // Disables the WebSandboxSupport implementation for testing.
   // Tests that do not set up a full sandbox environment should call
   // SetSandboxEnabledForTesting(false) _before_ creating any instances
   // of this class, to ensure that we don't attempt to use sandbox-related
   // file descriptors or other resources.
   //
   // Returns the previous |enable| value.
   static bool SetSandboxEnabledForTesting(bool enable);
 
   //  Set a double to return when setDeviceLightListener is invoked.
   static void SetMockDeviceLightDataForTesting(double data);
   // Set WebDeviceMotionData to return when setDeviceMotionListener is invoked.
   static void SetMockDeviceMotionDataForTesting(
       const blink::WebDeviceMotionData& data);
   // Set WebDeviceOrientationData to return when setDeviceOrientationListener
   // is invoked.
   static void SetMockDeviceOrientationDataForTesting(
       const blink::WebDeviceOrientationData& data);
 
   // Notifies blink::WebBatteryStatusListener that battery status has changed.
-  static void MockBatteryStatusChangedForTesting(
+  void MockBatteryStatusChangedForTesting(
       const blink::WebBatteryStatus& status);
 
   WebDatabaseObserverImpl* web_database_observer_impl() {
     return web_database_observer_impl_.get();
   }
 
  private:
   bool CheckPreparsedJsCachingEnabled() const;
 
-  // Implement those methods internally so startListening() and stopListening()
-  // are being used and Blink can change its interface.
-  void SetDeviceMotionListener(blink::WebDeviceMotionListener*);
-  void SetDeviceOrientationListener(blink::WebDeviceOrientationListener*);
-  void SetDeviceLightListener(blink::WebDeviceLightListener*);
-  void SetBatteryStatusListener(blink::WebBatteryStatusListener*);
-  void SetGamepadListener(blink::WebGamepadListener*);
+  // Factory that takes a type and return PlatformEventObserverBase that matches
+  // it.
+  static PlatformEventObserverBase* CreatePlatformEventObserverFromType(
+      blink::WebPlatformEventType type);
 
+  // Use the data previously set via SetMockDevice...DataForTesting() and send
+  // them to the registered listener.
+  void SendFakeDeviceEventDataForTesting(blink::WebPlatformEventType type);
 
   scoped_ptr<RendererClipboardClient> clipboard_client_;
   scoped_ptr<WebClipboardImpl> clipboard_;
 
   class FileUtilities;
   scoped_ptr<FileUtilities> file_utilities_;
 
   class MimeRegistry;
   scoped_ptr<MimeRegistry> mime_registry_;
 
@@ skipping 25 matching lines @@
   scoped_refptr<QuotaMessageFilter> quota_message_filter_;
 
   scoped_ptr<WebDatabaseObserverImpl> web_database_observer_impl_;
 
   WebCompositorSupportImpl compositor_support_;
 
   scoped_ptr<blink::WebScrollbarBehavior> web_scrollbar_behavior_;
 
   scoped_ptr<BatteryStatusDispatcher> battery_status_dispatcher_;
 
-  RendererGamepadProvider* gamepad_provider_;
+  IDMap<PlatformEventObserverBase, IDMapOwnPointer> platform_event_observers_;
 
   DISALLOW_COPY_AND_ASSIGN(RendererWebKitPlatformSupportImpl);
 };
 
 }  // namespace content
 
 #endif  // CONTENT_RENDERER_RENDERER_WEBKITPLATFORMSUPPORT_IMPL_H_