1/* 2 * Copyright (C) 2008 Apple Inc. All Rights Reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 13 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY 14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 16 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR 17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 24 * 25 */ 26 27#ifndef DOMTimer_h 28#define DOMTimer_h 29 30#include "SuspendableTimer.h" 31#include "UserGestureIndicator.h" 32#include <wtf/OwnPtr.h> 33#include <wtf/PassOwnPtr.h> 34 35namespace WebCore { 36 37 class ScheduledAction; 38 39 class DOMTimer : public SuspendableTimer { 40 public: 41 virtual ~DOMTimer(); 42 // Creates a new timer owned by specified ScriptExecutionContext, starts it 43 // and returns its Id. 44 static int install(ScriptExecutionContext*, PassOwnPtr<ScheduledAction>, int timeout, bool singleShot); 45 static void removeById(ScriptExecutionContext*, int timeoutId); 46 47 // ActiveDOMObject 48 virtual void contextDestroyed(); 49 virtual void stop(); 50 51 // Adjust to a change in the ScriptExecutionContext's minimum timer interval. 52 // This allows the minimum allowable interval time to be changed in response 53 // to events like moving a tab to the background. 54 void adjustMinimumTimerInterval(double oldMinimumTimerInterval); 55 56 private: 57 DOMTimer(ScriptExecutionContext*, PassOwnPtr<ScheduledAction>, int interval, bool singleShot); 58 virtual void fired(); 59 60 double intervalClampedToMinimum(int timeout, double minimumTimerInterval) const; 61 62 // Retuns timer fire time rounded to the next multiple of timer alignment interval. 63 virtual double alignedFireTime(double) const; 64 65 int m_timeoutId; 66 int m_nestingLevel; 67 OwnPtr<ScheduledAction> m_action; 68 int m_originalInterval; 69 RefPtr<UserGestureToken> m_userGestureToken; 70 }; 71 72} // namespace WebCore 73 74#endif // DOMTimer_h 75 76