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