356f188fb203b50838e1017a011844856c9eb62b
[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 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 "FrameLoaderTypes.h"
35 #include "Timer.h"
36 #include <wtf/Forward.h>
37
38 namespace WebCore {
39
40 class FormSubmission;
41 class Frame;
42 class ScheduledNavigation;
43 class SecurityOrigin;
44 class URL;
45
46 class NavigationDisablerForBeforeUnload {
47 public:
48     NavigationDisablerForBeforeUnload()
49     {
50         s_navigationDisableCount++;
51     }
52     ~NavigationDisablerForBeforeUnload()
53     {
54         ASSERT(s_navigationDisableCount);
55         s_navigationDisableCount--;
56     }
57     static bool isNavigationAllowed() { return !s_navigationDisableCount; }
58
59 private:
60     static unsigned s_navigationDisableCount;
61 };
62
63 class NavigationScheduler {
64 public:
65     explicit NavigationScheduler(Frame&);
66     ~NavigationScheduler();
67
68     bool redirectScheduledDuringLoad();
69     bool locationChangePending();
70
71     void scheduleRedirect(double delay, const URL&);
72     void scheduleLocationChange(SecurityOrigin*, const URL&, const String& referrer, LockHistory = LockHistory::Yes, LockBackForwardList = LockBackForwardList::Yes);
73     void scheduleFormSubmission(PassRefPtr<FormSubmission>);
74     void scheduleRefresh();
75     void scheduleHistoryNavigation(int steps);
76
77     void startTimer();
78
79     void cancel(bool newLoadInProgress = false);
80     void clear();
81
82 private:
83     bool shouldScheduleNavigation() const;
84     bool shouldScheduleNavigation(const URL&) const;
85
86     void timerFired(Timer&);
87     void schedule(std::unique_ptr<ScheduledNavigation>);
88
89     static LockBackForwardList mustLockBackForwardList(Frame& targetFrame);
90
91     Frame& m_frame;
92     Timer m_timer;
93     std::unique_ptr<ScheduledNavigation> m_redirect;
94 };
95
96 } // namespace WebCore
97
98 #endif // NavigationScheduler_h