Vibration API: use runtime flag, change from client to platform.

Source/modules/vibration/NavigatorVibration.cpp

 /*
  *  Copyright (C) 2012 Samsung Electronics
  *
  *  This library is free software; you can redistribute it and/or
  *  modify it under the terms of the GNU Library General Public
  *  License as published by the Free Software Foundation; either
  *  version 2 of the License, or (at your option) any later version.
  *
  *  This library is distributed in the hope that it will be useful,
  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  *  Library General Public License for more details.
  *
  *  You should have received a copy of the GNU Library General Public License
  *  along with this library; see the file COPYING.LIB.  If not, write to
  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  *  Boston, MA 02110-1301, USA.
  */
 
 #include "config.h"
 #include "modules/vibration/NavigatorVibration.h"
 
-#if ENABLE(VIBRATION)
-
-#include "core/dom/ExceptionCode.h"
 #include "core/page/Frame.h"
-#include "core/page/Navigator.h"
 #include "core/page/Page.h"
-#include "modules/vibration/Vibration.h"
-#include "wtf/Uint32Array.h"
+#include "public/platform/Platform.h"
 
 namespace WebCore {
 
+// Maximum duration of a vibration is 10 seconds.
+const unsigned kVibrationDurationMax = 10000;
+
+// Maximum number of entries in a vibration pattern.
+const unsigned kVibrationPatternLengthMax = 99;
+
 NavigatorVibration::NavigatorVibration()
+    : m_timerStart(this, &NavigatorVibration::timerStartFired)
+    , m_timerStop(this, &NavigatorVibration::timerStopFired)
+    , m_isVibrating(false)
 {
 }
 
 NavigatorVibration::~NavigatorVibration()
 {
+    if (m_isVibrating)
+        cancelVibration();
 }
 
-void NavigatorVibration::vibrate(Navigator* navigator, unsigned time, ExceptionCode& ec)
+bool NavigatorVibration::vibrate(const VibrationPattern& pattern)
+{
+    size_t length = pattern.size();
+
+    // If the pattern is too long then abort.
+    if (length > kVibrationPatternLengthMax)
+        return false;
+
+    // If any pattern entry is too long then abort.
+    for (size_t i = 0; i < length; ++i) {
+        if (pattern[i] > kVibrationDurationMax)
+            return false;
+    }
+
+    m_pattern = pattern;
+
+    // If the last item in the pattern is a pause then discard it.
+    if (length && !(length % 2))
+        m_pattern.removeLast();
+
+    if (m_isVibrating)
+        cancelVibration();
+
+    if (m_timerStart.isActive())
+        m_timerStart.stop();
+
+    if (!m_pattern.size())
+        return true;
+
+    if (m_pattern.size() == 1 && !m_pattern[0]) {
+        m_pattern.clear();
+        return true;
+    }
+
+    m_timerStart.startOneShot(0);
+}
+
+void NavigatorVibration::cancelVibration()
+{
+    m_pattern.clear();
+    if (m_isVibrating) {
+        WebKit::Platform::current()->cancelVibration();
+        m_isVibrating = false;
+        m_timerStop.stop();
+    }
+}
+
+void NavigatorVibration::suspendVibration()
+{
+    if (!m_isVibrating)
+        return;
+
+    m_pattern.insert(0, m_timerStop.nextFireInterval());
+    m_timerStop.stop();
+    cancelVibration();
+}
+
+void NavigatorVibration::resumeVibration()
+{
+    m_timerStart.startOneShot(0);

[abarth-chromium, 2013/06/12 20:41:27]

Should we ASSERT that m_timerStart isn't active?

[Michael van Ouwerkerk, 2013/06/13 18:23:17]

Done.

+}
+
+void NavigatorVibration::timerStartFired(Timer<NavigatorVibration>* timer)
+{
+    ASSERT_UNUSED(timer, timer == &m_timerStart);
+
+    m_timerStart.stop();

[abarth-chromium, 2013/06/12 20:41:27]

Is this necessary if we only use one-shot timers?

[Michael van Ouwerkerk, 2013/06/13 18:23:17]

It doesn't seem to be. I've removed it here and in timerStopFired.

+
+    if (m_pattern.size()) {
+        m_isVibrating = true;
+        WebKit::Platform::current()->vibrate(m_pattern[0]);
+        m_timerStop.startOneShot(m_pattern[0] / 1000.0);
+        m_pattern.remove(0);
+    }
+}
+
+void NavigatorVibration::timerStopFired(Timer<NavigatorVibration>* timer)
+{
+    ASSERT_UNUSED(timer, timer == &m_timerStop);
+
+    m_timerStop.stop();
+    m_isVibrating = false;
+
+    if (m_pattern.size()) {
+        m_timerStart.startOneShot(m_pattern[0] / 1000.0);
+        m_pattern.remove(0);
+    }
+}
+
+bool NavigatorVibration::vibrate(Navigator* navigator, unsigned time)
+{
+    VibrationPattern pattern;
+    pattern.append(time);
+    return NavigatorVibration::vibrate(navigator, pattern);
+}
+
+bool NavigatorVibration::vibrate(Navigator* navigator, const VibrationPattern& pattern)
 {
     if (!navigator->frame()->page())
-        return;
+        return false;
 
-    if (navigator->frame()->page()->visibilityState() == PageVisibilityStateHidden)
-        return;
+    if (navigator->frame()->page()->visibilityState() != PageVisibilityStateVisible)
+        return false;
 
-    if (!Vibration::isActive(navigator->frame()->page())) {
-        ec = NOT_SUPPORTED_ERR;
-        return;
-    }
-
-    Vibration::from(navigator->frame()->page())->vibrate(time);
+    return NavigatorVibration::from(navigator)->vibrate(pattern);
 }
 
-void NavigatorVibration::vibrate(Navigator* navigator, const VibrationPattern& pattern, ExceptionCode& ec)
+NavigatorVibration* NavigatorVibration::from(Navigator* navigator)
 {
-    if (!navigator->frame()->page())
-        return;
+    if (!Supplement<Navigator>::from(navigator, supplementName()))
+        Supplement<Navigator>::provideTo(navigator, supplementName(), adoptPtr(new NavigatorVibration()));
+    return static_cast<NavigatorVibration*>(Supplement<Navigator>::from(navigator, supplementName()));

[abarth-chromium, 2013/06/12 20:41:27]

Please use the normal pattern for these "from" functions.  It's a couple lines
longer, but it avoids doing two hash lookups.

[Michael van Ouwerkerk, 2013/06/13 18:23:17]

Done.

+}
 
-    if (navigator->frame()->page()->visibilityState() == PageVisibilityStateHidden)
-        return;
-
-    if (!Vibration::isActive(navigator->frame()->page())) {
-        ec = NOT_SUPPORTED_ERR;
-        return;
-    }
-
-    Vibration::from(navigator->frame()->page())->vibrate(pattern);
+const char* NavigatorVibration::supplementName()
+{
+    return "NavigatorVibration";
 }
 
 } // namespace WebCore
-
-#endif // ENABLE(VIBRATION)
-