1/*
2 * Copyright (C) 2008, 2013 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 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 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 SuspendableTimer_h
28#define SuspendableTimer_h
29
30#include "ActiveDOMObject.h"
31#include "Timer.h"
32
33namespace WebCore {
34
35class SuspendableTimer : private TimerBase, public ActiveDOMObject {
36public:
37    explicit SuspendableTimer(ScriptExecutionContext*);
38    virtual ~SuspendableTimer();
39
40    // A hook for derived classes to perform cleanup.
41    virtual void didStop();
42
43    // Part of TimerBase interface used by SuspendableTimer clients, modified to work when suspended.
44    bool isActive() const { return TimerBase::isActive() || (m_suspended && m_savedIsActive); }
45    bool isSuspended() const { return m_suspended; }
46    void startRepeating(double repeatInterval);
47    void startOneShot(double interval);
48    double repeatInterval() const;
49    void augmentFireInterval(double delta);
50    void augmentRepeatInterval(double delta);
51    using TimerBase::didChangeAlignmentInterval;
52    using TimerBase::operator new;
53    using TimerBase::operator delete;
54
55    void cancel(); // Equivalent to TimerBase::stop(), whose name conflicts with ActiveDOMObject::stop().
56
57private:
58    virtual void fired() = 0;
59
60    // ActiveDOMObject
61    virtual bool hasPendingActivity() const final override;
62    virtual void stop() final override;
63    virtual bool canSuspend() const final override;
64    virtual void suspend(ReasonForSuspension) final override;
65    virtual void resume() final override;
66
67    bool m_suspended;
68
69    double m_savedNextFireInterval;
70    double m_savedRepeatInterval;
71    bool m_savedIsActive;
72};
73
74} // namespace WebCore
75
76#endif // SuspendableTimer_h
77
78