Home | History | Annotate | Download | only in loader 
      1 /*
      2  * Copyright (C) 2010 Google Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions
      6  * are met:
      7  *
      8  * 1.  Redistributions of source code must retain the above copyright
      9  *     notice, this list of conditions and the following disclaimer.
     10  * 2.  Redistributions in binary form must reproduce the above copyright
     11  *     notice, this list of conditions and the following disclaimer in the
     12  *     documentation and/or other materials provided with the distribution.
     13  * 3.  Neither the name of Google, Inc. nor the names of
     14  *     its contributors may be used to endorse or promote products derived
     15  *     from this software without specific prior written permission.
     16  *
     17  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
     18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
     21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
     24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27  */
     28 
     29 #ifndef FrameLoaderStateMachine_h
     30 #define FrameLoaderStateMachine_h
     31 
     32 #include <wtf/Noncopyable.h>
     33 
     34 namespace WebCore {
     35 
     36 // Encapsulates a state machine for FrameLoader. Note that this is different from FrameState,
     37 // which stores the state of the current load that FrameLoader is executing.
     38 class FrameLoaderStateMachine {
     39     WTF_MAKE_NONCOPYABLE(FrameLoaderStateMachine);
     40 public:
     41     FrameLoaderStateMachine();
     42 
     43     // Once a load has been committed, the state may
     44     // alternate between CommittedFirstRealLoad and FirstLayoutDone.
     45     // Otherwise, the states only go down the list.
     46     enum State {
     47         Uninitialized,
     48         CreatingInitialEmptyDocument,
     49         DisplayingInitialEmptyDocument,
     50         DisplayingInitialEmptyDocumentPostCommit,
     51         CommittedFirstRealLoad,
     52         FirstLayoutDone
     53     };
     54 
     55     bool committingFirstRealLoad() const;
     56     bool committedFirstRealDocumentLoad() const;
     57     bool creatingInitialEmptyDocument() const;
     58     bool isDisplayingInitialEmptyDocument() const;
     59     bool firstLayoutDone() const;
     60     void advanceTo(State);
     61 
     62 private:
     63     State m_state;
     64 };
     65 
     66 } // namespace WebCore
     67 
     68 #endif // FrameLoaderStateMachine_h
     69