2009-10-02 Adam Barth <abarth@webkit.org>
[WebKit-https.git] / WebCore / loader / RedirectScheduler.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 RedirectScheduler_h
32 #define RedirectScheduler_h
33
34 #include "Event.h"
35 #include "Timer.h"
36 #include <wtf/OwnPtr.h>
37 #include <wtf/PassOwnPtr.h>
38 #include <wtf/PassRefPtr.h>
39
40 namespace WebCore {
41
42     class FormState;
43     class Frame;
44     class FrameLoadRequest;
45     class String;
46
47     struct ScheduledRedirection;
48
49     class RedirectScheduler : public Noncopyable {
50     public:
51         RedirectScheduler(Frame*);
52         ~RedirectScheduler();
53
54         bool redirectScheduledDuringLoad();
55         bool locationChangePending();
56
57         void scheduleRedirect(double delay, const String& url);
58         void scheduleLocationChange(const String& url, const String& referrer, bool lockHistory = true, bool lockBackForwardList = true, bool userGesture = false);
59         void scheduleFormSubmission(const FrameLoadRequest&, bool lockHistory, PassRefPtr<Event>, PassRefPtr<FormState>);
60         void scheduleRefresh(bool userGesture = false);
61         void scheduleHistoryNavigation(int steps);
62
63         void startTimer();
64
65         void cancel(bool newLoadInProgress = false);
66         void clear();
67
68     private:
69         void timerFired(Timer<RedirectScheduler>*);
70         void schedule(PassOwnPtr<ScheduledRedirection>);
71
72         static bool mustLockBackForwardList(Frame* targetFrame);
73
74         Frame* m_frame;
75         Timer<RedirectScheduler> m_timer;
76         OwnPtr<ScheduledRedirection> m_scheduledRedirection;
77     };
78
79 } // namespace WebCore
80
81 #endif // FrameLoader_h