CTTE Timer and DeferrableOneShotTimer
[WebKit-https.git] / Source / WebCore / loader / NavigationScheduler.h
1 /*
2  * Copyright (C) 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
3  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
4  * Copyright (C) 2009 Adam Barth. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  *
10  * 1.  Redistributions of source code must retain the above copyright
11  *     notice, this list of conditions and the following disclaimer. 
12  * 2.  Redistributions in binary form must reproduce the above copyright
13  *     notice, this list of conditions and the following disclaimer in the
14  *     documentation and/or other materials provided with the distribution. 
15  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
16  *     its contributors may be used to endorse or promote products derived
17  *     from this software without specific prior written permission. 
18  *
19  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
20  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
21  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
22  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
23  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
24  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef NavigationScheduler_h
32 #define NavigationScheduler_h
33
34 #include "Timer.h"
35 #include <wtf/Forward.h>
36 #include <wtf/Noncopyable.h>
37 #include <wtf/PassRefPtr.h>
38
39 namespace WebCore {
40
41 class FormSubmission;
42 class Frame;
43 class ScheduledNavigation;
44 class SecurityOrigin;
45
46 class NavigationDisablerForBeforeUnload {
47     WTF_MAKE_NONCOPYABLE(NavigationDisablerForBeforeUnload);
48
49 public:
50     NavigationDisablerForBeforeUnload()
51     {
52         s_navigationDisableCount++;
53     }
54     ~NavigationDisablerForBeforeUnload()
55     {
56         ASSERT(s_navigationDisableCount);
57         s_navigationDisableCount--;
58     }
59     static bool isNavigationAllowed() { return !s_navigationDisableCount; }
60
61 private:
62     static unsigned s_navigationDisableCount;
63 };
64
65 class NavigationScheduler {
66     WTF_MAKE_NONCOPYABLE(NavigationScheduler);
67
68 public:
69     explicit NavigationScheduler(Frame&);
70     ~NavigationScheduler();
71
72     bool redirectScheduledDuringLoad();
73     bool locationChangePending();
74
75     void scheduleRedirect(double delay, const String& url);
76     void scheduleLocationChange(SecurityOrigin*, const String& url, const String& referrer, bool lockHistory = true, bool lockBackForwardList = true);
77     void scheduleFormSubmission(PassRefPtr<FormSubmission>);
78     void scheduleRefresh();
79     void scheduleHistoryNavigation(int steps);
80
81     void startTimer();
82
83     void cancel(bool newLoadInProgress = false);
84     void clear();
85
86 private:
87     bool shouldScheduleNavigation() const;
88     bool shouldScheduleNavigation(const String& url) const;
89
90     void timerFired(Timer<NavigationScheduler>&);
91     void schedule(std::unique_ptr<ScheduledNavigation>);
92
93     static bool mustLockBackForwardList(Frame& targetFrame);
94
95     Frame& m_frame;
96     Timer<NavigationScheduler> m_timer;
97     std::unique_ptr<ScheduledNavigation> m_redirect;
98 };
99
100 } // namespace WebCore
101
102 #endif // NavigationScheduler_h