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