Stop using PLATFORM(MAC) in WTF except where it means “OS X but not iOS”
[WebKit-https.git] / Source / WTF / wtf / RunLoopTimerCF.cpp
1 /*
2  * Copyright (C) 2009, 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30
31 #if PLATFORM(COCOA) && HAVE(RUNLOOP_TIMER)
32
33 #include "RunLoopTimer.h"
34
35 #include "AutodrainedPool.h"
36
37 namespace WTF {
38
39 RunLoopTimerBase::~RunLoopTimerBase()
40 {
41     stop();
42 }
43
44 static void timerFired(CFRunLoopTimerRef, void* context)
45 {
46     // CFRunLoopTimer does not create an NSAutoreleasePool, like NSTimer does. This can lead to
47     // autoreleased objects being pushed into NSAutoreleasePools underneath the run loop, which
48     // are very infrequently drained. Create a new autorelease pool here to give autoreleased objects
49     // a place to collect.
50     AutodrainedPool pool;
51     RunLoopTimerBase* timer = static_cast<RunLoopTimerBase*>(context);
52     timer->fired();
53 }
54
55 void RunLoopTimerBase::start(double nextFireInterval, double repeatInterval)
56 {
57     if (m_timer)
58         CFRunLoopTimerInvalidate(m_timer.get());
59     CFRunLoopTimerContext context = { 0, this, 0, 0, 0 };
60     m_timer = adoptCF(CFRunLoopTimerCreate(0, CFAbsoluteTimeGetCurrent() + nextFireInterval, repeatInterval, 0, 0, timerFired, &context));
61 }
62
63 void RunLoopTimerBase::schedule(const SchedulePair* schedulePair)
64 {
65     ASSERT_ARG(schedulePair, schedulePair);
66     ASSERT_WITH_MESSAGE(m_timer, "Timer must have one of the start functions called before calling schedule().");
67     CFRunLoopAddTimer(schedulePair->runLoop(), m_timer.get(), schedulePair->mode());
68 }
69
70 void RunLoopTimerBase::schedule(const SchedulePairHashSet& schedulePairs)
71 {
72     SchedulePairHashSet::const_iterator end = schedulePairs.end();
73     for (SchedulePairHashSet::const_iterator it = schedulePairs.begin(); it != end; ++it)
74         schedule((*it).get());
75 }
76
77 void RunLoopTimerBase::stop()
78 {
79     if (!m_timer)
80         return;
81     CFRunLoopTimerInvalidate(m_timer.get());
82     m_timer = 0;
83 }
84
85 bool RunLoopTimerBase::isActive() const
86 {
87     return m_timer && CFRunLoopTimerIsValid(m_timer.get());
88 }
89
90 } // namespace WTF
91
92 #endif // PLATFORM(COCOA) && HAVE(RUNLOOP_TIMER)