Bug 852944 - Gamepad API IPC; r=ted, r=baku

--HG--
extra : rebase_source : 34ca0c1e1b7fcc312b5d7c97d5bd2086af2bc7ce

Author: qdot

dom/base/nsGlobalWindow.cpp

@@ -187,6 +187,7 @@
 #include "mozilla/dom/StructuredCloneTags.h"
 
 #ifdef MOZ_GAMEPAD
+#include "mozilla/dom/Gamepad.h"
 #include "mozilla/dom/GamepadService.h"
 #endif
 
@@ -13367,13 +13368,28 @@ void
 nsGlobalWindow::AddGamepad(uint32_t aIndex, Gamepad* aGamepad)
 {
   MOZ_ASSERT(IsInnerWindow());
+  // Create the index we will present to content based on which indices are
+  // already taken, as required by the spec.
+  // https://w3c.github.io/gamepad/gamepad.html#widl-Gamepad-index
+  int index = 0;
+  while(mGamepadIndexSet.Contains(index)) {
+    ++index;
+  }
+  mGamepadIndexSet.Put(index);
+  aGamepad->SetIndex(index);
   mGamepads.Put(aIndex, aGamepad);
 }
 
 void
 nsGlobalWindow::RemoveGamepad(uint32_t aIndex)
 {
   MOZ_ASSERT(IsInnerWindow());
+  nsRefPtr<Gamepad> gamepad;
+  if (!mGamepads.Get(aIndex, getter_AddRefs(gamepad))) {
+    return;
+  }
+  // Free up the index we were using so it can be reused
+  mGamepadIndexSet.Remove(gamepad->Index());
   mGamepads.Remove(aIndex);
 }
 
@@ -13384,8 +13400,8 @@ nsGlobalWindow::EnumGamepadsForGet(const uint32_t& aKey, Gamepad* aData,
 {
   nsTArray<nsRefPtr<Gamepad> >* array =
     static_cast<nsTArray<nsRefPtr<Gamepad> >*>(aUserArg);
-  array->EnsureLengthAtLeast(aKey + 1);
-  (*array)[aKey] = aData;
+  array->EnsureLengthAtLeast(aData->Index() + 1);
+  (*array)[aData->Index()] = aData;
   return PL_DHASH_NEXT;
 }
 
@@ -13404,6 +13420,7 @@ nsGlobalWindow::GetGamepad(uint32_t aIndex)
 {
   MOZ_ASSERT(IsInnerWindow());
   nsRefPtr<Gamepad> gamepad;
+
   if (mGamepads.Get(aIndex, getter_AddRefs(gamepad))) {
     return gamepad.forget();
   }

dom/base/nsGlobalWindow.h

@@ -52,6 +52,7 @@
 #include "Units.h"
 #include "nsComponentManagerUtils.h"
 #include "nsSize.h"
+#include "nsCheapSets.h"
 
 #define DEFAULT_HOME_PAGE "www.mozilla.org"
 #define PREF_BROWSER_STARTUP_HOMEPAGE "browser.startup.homepage"
@@ -1590,6 +1591,7 @@ class nsGlobalWindow : public mozilla::dom::EventTarget,
   // Indicates whether this window wants gamepad input events
   bool                   mHasGamepad : 1;
 #ifdef MOZ_GAMEPAD
+  nsCheapSet<nsUint32HashKey> mGamepadIndexSet;
   nsRefPtrHashtable<nsUint32HashKey, mozilla::dom::Gamepad> mGamepads;
   bool mHasSeenGamepadInput;
 #endif

dom/gamepad/GamepadFunctions.cpp

@@ -0,0 +1,105 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "mozilla/dom/GamepadFunctions.h"
+#include "mozilla/dom/GamepadService.h"
+#include "nsHashKeys.h"
+#include "mozilla/dom/ContentParent.h"
+#include "mozilla/unused.h"
+
+namespace mozilla {
+namespace dom {
+namespace GamepadFunctions {
+
+namespace {
+// Increments as gamepads are added
+uint32_t gGamepadIndex = 0;
+}
+
+template<class T>
+void
+NotifyGamepadChange(const T& aInfo)
+{
+  MOZ_ASSERT(NS_IsMainThread());
+  MOZ_ASSERT(XRE_GetProcessType() == GeckoProcessType_Default);
+  GamepadChangeEvent e(aInfo);
+  nsTArray<ContentParent*> t;
+  ContentParent::GetAll(t);
+  for(uint32_t i = 0; i < t.Length(); ++i) {
+    unused << t[i]->SendGamepadUpdate(e);
+  }
+  // If we have a GamepadService in the main process, send directly to it.
+  if (GamepadService::IsServiceRunning()) {
+    nsRefPtr<GamepadService> svc = GamepadService::GetService();
+    svc->Update(e);
+  }
+}
+
+uint32_t
+AddGamepad(const char* aID,
+           GamepadMappingType aMapping,
+           uint32_t aNumButtons, uint32_t aNumAxes)
+{
+  MOZ_ASSERT(NS_IsMainThread());
+  MOZ_ASSERT(XRE_GetProcessType() == GeckoProcessType_Default);
+
+  int index = gGamepadIndex;
+  gGamepadIndex++;
+  GamepadAdded a(NS_ConvertUTF8toUTF16(nsDependentCString(aID)), index,
+                 (uint32_t)aMapping, aNumButtons, aNumAxes);
+  gGamepadIndex++;
+  NotifyGamepadChange<GamepadAdded>(a);
+  return index;
+}
+
+void
+RemoveGamepad(uint32_t aIndex)
+{
+  MOZ_ASSERT(NS_IsMainThread());
+  MOZ_ASSERT(XRE_GetProcessType() == GeckoProcessType_Default);
+  GamepadRemoved a(aIndex);
+  NotifyGamepadChange<GamepadRemoved>(a);
+}
+
+void
+NewButtonEvent(uint32_t aIndex, uint32_t aButton,
+               bool aPressed, double aValue)
+{
+  MOZ_ASSERT(NS_IsMainThread());
+  MOZ_ASSERT(XRE_GetProcessType() == GeckoProcessType_Default);
+  GamepadButtonInformation a(aIndex, aButton, aPressed, aValue);
+  NotifyGamepadChange<GamepadButtonInformation>(a);
+}
+
+void
+NewButtonEvent(uint32_t aIndex, uint32_t aButton,
+               bool aPressed)
+{
+  MOZ_ASSERT(NS_IsMainThread());
+  MOZ_ASSERT(XRE_GetProcessType() == GeckoProcessType_Default);
+  // When only a digital button is available the value will be synthesized.
+  NewButtonEvent(aIndex, aButton, aPressed, aPressed ? 1.0L : 0.0L);
+}
+
+void
+NewAxisMoveEvent(uint32_t aIndex, uint32_t aAxis,
+                 double aValue)
+{
+  MOZ_ASSERT(NS_IsMainThread());
+  MOZ_ASSERT(XRE_GetProcessType() == GeckoProcessType_Default);
+  GamepadAxisInformation a(aIndex, aAxis, aValue);
+  NotifyGamepadChange<GamepadAxisInformation>(a);
+}
+
+void
+ResetGamepadIndexes()
+{
+  MOZ_ASSERT(NS_IsMainThread());
+  MOZ_ASSERT(XRE_GetProcessType() == GeckoProcessType_Default);
+  gGamepadIndex = 0;
+}
+
+} // namespace GamepadFunctions
+} // namespace dom
+} // namespace mozilla

dom/gamepad/GamepadFunctions.h

@@ -0,0 +1,45 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef mozilla_dom_GamepadFunctions_h_
+#define mozilla_dom_GamepadFunctions_h_
+
+#include "mozilla/dom/GamepadBinding.h"
+
+namespace mozilla {
+namespace dom {
+namespace GamepadFunctions {
+
+// Functions for building and transmitting IPDL messages through the HAL
+// sandbox. Used by platform specific Gamepad implementations
+
+// Add a gamepad to the list of known gamepads, and return its index.
+uint32_t AddGamepad(const char* aID, GamepadMappingType aMapping,
+                    uint32_t aNumButtons, uint32_t aNumAxes);
+// Remove the gamepad at |aIndex| from the list of known gamepads.
+void RemoveGamepad(uint32_t aIndex);
+
+// Update the state of |aButton| for the gamepad at |aIndex| for all
+// windows that are listening and visible, and fire one of
+// a gamepadbutton{up,down} event at them as well.
+// aPressed is used for digital buttons, aValue is for analog buttons.
+void NewButtonEvent(uint32_t aIndex, uint32_t aButton, bool aPressed,
+                    double aValue);
+// When only a digital button is available the value will be synthesized.
+void NewButtonEvent(uint32_t aIndex, uint32_t aButton, bool aPressed);
+
+// Update the state of |aAxis| for the gamepad at |aIndex| for all
+// windows that are listening and visible, and fire a gamepadaxismove
+// event at them as well.
+void NewAxisMoveEvent(uint32_t aIndex, uint32_t aAxis, double aValue);
+
+// When shutting down the platform communications for gamepad, also reset the
+// indexes.
+void ResetGamepadIndexes();
+
+} // namespace GamepadFunctions
+} // namespace dom
+} // namespace mozilla
+
+#endif

dom/gamepad/GamepadMonitoring.cpp

@@ -0,0 +1,31 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#include "mozilla/dom/GamepadMonitoring.h"
+#include "mozilla/dom/GamepadFunctions.h"
+#include "mozilla/dom/PContentParent.h"
+
+namespace mozilla {
+namespace dom {
+
+using namespace GamepadFunctions;
+
+void
+MaybeStopGamepadMonitoring()
+{
+  MOZ_ASSERT(NS_IsMainThread());
+  MOZ_ASSERT(XRE_GetProcessType() == GeckoProcessType_Default);
+  nsTArray<ContentParent*> t;
+  ContentParent::GetAll(t);
+  for(uint32_t i = 0; i < t.Length(); ++i) {
+    if (t[i]->HasGamepadListener()) {
+      return;
+    }
+  }
+  StopGamepadMonitoring();
+  ResetGamepadIndexes();
+}
+
+} // namespace dom
+} // namespace mozilla

dom/gamepad/GamepadMonitoring.h

@@ -0,0 +1,22 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+#ifndef mozilla_dom_GamepadMonitoring_h_
+#define mozilla_dom_GamepadMonitoring_h_
+
+namespace mozilla {
+namespace dom {
+// Functions for platform specific gamepad monitoring.
+
+void MaybeStopGamepadMonitoring();
+
+// These two functions are implemented in the platform specific service files
+// (linux/LinuxGamepad.cpp, cocoa/CocoaGamepad.cpp, etc)
+void StartGamepadMonitoring();
+void StopGamepadMonitoring();
+
+} // namespace dom
+} // namespace mozilla
+
+#endif