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 "ActiveDOMObject.h"
31#include "Timer.h"
32#include <wtf/OwnPtr.h>
33
34namespace WebCore {
35
36    class InspectorTimelineAgent;
37    class ScheduledAction;
38
39    class DOMTimer : public TimerBase, public ActiveDOMObject {
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*, ScheduledAction*, int timeout, bool singleShot);
45        static void removeById(ScriptExecutionContext*, int timeoutId);
46
47        // ActiveDOMObject
48        virtual bool hasPendingActivity() const;
49        virtual void contextDestroyed();
50        virtual void stop();
51        virtual bool canSuspend() const;
52        virtual void suspend();
53        virtual void resume();
54
55        // The lowest allowable timer setting (in seconds, 0.001 == 1 ms).
56        // Default is 10ms.
57        // Chromium uses a non-default timeout.
58        static double minTimerInterval() { return s_minTimerInterval; }
59        static void setMinTimerInterval(double value) { s_minTimerInterval = value; }
60
61    private:
62        DOMTimer(ScriptExecutionContext*, ScheduledAction*, int timeout, bool singleShot);
63        virtual void fired();
64
65        int m_timeoutId;
66        int m_nestingLevel;
67        OwnPtr<ScheduledAction> m_action;
68        double m_nextFireInterval;
69        double m_repeatInterval;
70#if !ASSERT_DISABLED
71        bool m_suspended;
72#endif
73        static double s_minTimerInterval;
74    };
75
76} // namespace WebCore
77
78#endif // DOMTimer_h
79
80