Add *explicit* keyword to constructor which has a parameter in bridge, history, loade...
[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/OwnPtr.h>
38 #include <wtf/PassOwnPtr.h>
39 #include <wtf/PassRefPtr.h>
40
41 namespace WebCore {
42
43 class FormSubmission;
44 class Frame;
45 class ScheduledNavigation;
46 class SecurityOrigin;
47
48 class NavigationDisablerForBeforeUnload {
49     WTF_MAKE_NONCOPYABLE(NavigationDisablerForBeforeUnload);
50
51 public:
52     NavigationDisablerForBeforeUnload()
53     {
54         s_navigationDisableCount++;
55     }
56     ~NavigationDisablerForBeforeUnload()
57     {
58         ASSERT(s_navigationDisableCount);
59         s_navigationDisableCount--;
60     }
61     static bool isNavigationAllowed() { return !s_navigationDisableCount; }
62
63 private:
64     static unsigned s_navigationDisableCount;
65 };
66
67 class NavigationScheduler {
68     WTF_MAKE_NONCOPYABLE(NavigationScheduler);
69
70 public:
71     explicit NavigationScheduler(Frame*);
72     ~NavigationScheduler();
73
74     bool redirectScheduledDuringLoad();
75     bool locationChangePending();
76
77     void scheduleRedirect(double delay, const String& url);
78     void scheduleLocationChange(SecurityOrigin*, const String& url, const String& referrer, bool lockHistory = true, bool lockBackForwardList = true);
79     void scheduleFormSubmission(PassRefPtr<FormSubmission>);
80     void scheduleRefresh();
81     void scheduleHistoryNavigation(int steps);
82
83     void startTimer();
84
85     void cancel(bool newLoadInProgress = false);
86     void clear();
87
88 private:
89     bool shouldScheduleNavigation() const;
90     bool shouldScheduleNavigation(const String& url) const;
91
92     void timerFired(Timer<NavigationScheduler>*);
93     void schedule(PassOwnPtr<ScheduledNavigation>);
94
95     static bool mustLockBackForwardList(Frame* targetFrame);
96
97     Frame* m_frame;
98     Timer<NavigationScheduler> m_timer;
99     OwnPtr<ScheduledNavigation> m_redirect;
100 };
101
102 } // namespace WebCore
103
104 #endif // NavigationScheduler_h