15c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/* 293ac45cfc74041c8ae536ce58a9534d46db2024eTorne (Richard Coles) * Copyright (C) 2013 Google Inc. All rights reserved. 35c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 45c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Redistribution and use in source and binary forms, with or without 55c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * modification, are permitted provided that the following conditions are 65c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * met: 75c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 85c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Redistributions of source code must retain the above copyright 95c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * notice, this list of conditions and the following disclaimer. 105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Redistributions in binary form must reproduce the above 115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * copyright notice, this list of conditions and the following disclaimer 125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * in the documentation and/or other materials provided with the 135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * distribution. 145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * * Neither the name of Google Inc. nor the names of its 155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * contributors may be used to endorse or promote products derived from 165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * this software without specific prior written permission. 175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 275c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 305c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 311e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)#include "config.h" 321e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)#include "core/dom/DocumentLifecycle.h" 335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 341e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)#include "wtf/Assertions.h" 355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 36c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles)namespace blink { 375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3809380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)static DocumentLifecycle::DeprecatedTransition* s_deprecatedTransitionStack = 0; 3909380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) 4009380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)DocumentLifecycle::Scope::Scope(DocumentLifecycle& lifecycle, State finalState) 4109380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) : m_lifecycle(lifecycle) 4209380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) , m_finalState(finalState) 4309380295ba73501a205346becac22c6978e4671dTorne (Richard Coles){ 4409380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)} 4509380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) 4609380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)DocumentLifecycle::Scope::~Scope() 4709380295ba73501a205346becac22c6978e4671dTorne (Richard Coles){ 4809380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) m_lifecycle.advanceTo(m_finalState); 4909380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)} 5009380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) 5109380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)DocumentLifecycle::DeprecatedTransition::DeprecatedTransition(State from, State to) 5209380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) : m_previous(s_deprecatedTransitionStack) 5309380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) , m_from(from) 5409380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) , m_to(to) 5509380295ba73501a205346becac22c6978e4671dTorne (Richard Coles){ 5609380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) s_deprecatedTransitionStack = this; 5709380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)} 5809380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) 5909380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)DocumentLifecycle::DeprecatedTransition::~DeprecatedTransition() 6009380295ba73501a205346becac22c6978e4671dTorne (Richard Coles){ 6109380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) s_deprecatedTransitionStack = m_previous; 6209380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)} 6309380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) 641e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)DocumentLifecycle::DocumentLifecycle() 651e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) : m_state(Uninitialized) 66d6cdb82654e8f3343a693ca752d5c4cee0324e17Torne (Richard Coles) , m_detachCount(0) 671e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles){ 681e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)} 6993ac45cfc74041c8ae536ce58a9534d46db2024eTorne (Richard Coles) 701e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)DocumentLifecycle::~DocumentLifecycle() 711e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles){ 721e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)} 7393ac45cfc74041c8ae536ce58a9534d46db2024eTorne (Richard Coles) 74197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch#if ENABLE(ASSERT) 7509380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) 7609380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)bool DocumentLifecycle::canAdvanceTo(State state) const 7709380295ba73501a205346becac22c6978e4671dTorne (Richard Coles){ 7809380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state > m_state) 7909380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 8009380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (m_state == Disposed) { 8109380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) // FIXME: We can dispose a document multiple times. This seems wrong. 8209380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) // See https://code.google.com/p/chromium/issues/detail?id=301668. 8309380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return state == Disposed; 8409380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) } 8509380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (m_state == StyleClean) { 8609380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) // We can synchronously recalc style. 8709380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == InStyleRecalc) 8809380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 8909380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) // We can synchronously perform layout. 9009380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == InPreLayout) 9109380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 9209380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == InPerformLayout) 9309380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 9409380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) // We can redundant arrive in the style clean state. 9509380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == StyleClean) 9609380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 9709380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return false; 9809380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) } 9909380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (m_state == InPreLayout) { 10009380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == InStyleRecalc) 10109380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 10209380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == StyleClean) 10309380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 10409380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == InPreLayout) 10509380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 10609380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return false; 10709380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) } 10809380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (m_state == AfterPerformLayout) { 10910f88d5669dbd969c059d61ba09fa37dd72ac559Ben Murdoch // We can synchronously recompute layout in AfterPerformLayout. 11010f88d5669dbd969c059d61ba09fa37dd72ac559Ben Murdoch // FIXME: Ideally, we would unnest this recursion into a loop. 111f91f5fa1608c2cdd9af1842fb5dadbe78275be2aBo Liu return state == InPreLayout; 11209380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) } 11309380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (m_state == LayoutClean) { 11409380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) // We can synchronously recalc style. 11509380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == InStyleRecalc) 11609380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 11709380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) // We can synchronously perform layout. 11809380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == InPreLayout) 11909380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 12009380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == InPerformLayout) 12109380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 12209380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) // We can redundant arrive in the layout clean state. This situation 12309380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) // can happen when we call layout recursively and we unwind the stack. 12409380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == LayoutClean) 12509380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 12609380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == StyleClean) 12709380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 12809380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return false; 12909380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) } 13009380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (m_state == CompositingClean) { 13109380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == InStyleRecalc) 13209380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 133c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) if (state == InCompositingUpdate) 134c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) return true; 135c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) if (state == InPaintInvalidation) 136c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) return true; 137c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) return false; 138c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) } 139c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) if (m_state == InPaintInvalidation) { 140c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) if (state == PaintInvalidationClean) 141c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) return true; 142c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) return false; 143c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) } 144c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) if (m_state == PaintInvalidationClean) { 145c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) if (state == InStyleRecalc) 146c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) return true; 14709380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == InPreLayout) 14809380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 14909380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) if (state == InCompositingUpdate) 15009380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return true; 15109380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return false; 15209380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) } 15309380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) return false; 15409380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)} 15509380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) 1566f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdochbool DocumentLifecycle::canRewindTo(State state) const 1576f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch{ 1586f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch // This transition is bogus, but we've whitelisted it anyway. 1596f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch if (s_deprecatedTransitionStack && m_state == s_deprecatedTransitionStack->from() && state == s_deprecatedTransitionStack->to()) 1606f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch return true; 161c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) return m_state == StyleClean || m_state == AfterPerformLayout || m_state == LayoutClean || m_state == CompositingClean || m_state == PaintInvalidationClean; 1626f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch} 1636f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch 16409380295ba73501a205346becac22c6978e4671dTorne (Richard Coles)#endif 16509380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) 1661e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)void DocumentLifecycle::advanceTo(State state) 1671e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles){ 16809380295ba73501a205346becac22c6978e4671dTorne (Richard Coles) ASSERT(canAdvanceTo(state)); 1691e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) m_state = state; 1701e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)} 1715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1726f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdochvoid DocumentLifecycle::ensureStateAtMost(State state) 1736f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch{ 1746f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch ASSERT(state == VisualUpdatePending || state == StyleClean || state == LayoutClean); 1756f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch if (m_state <= state) 1766f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch return; 1776f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch ASSERT(canRewindTo(state)); 1786f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch m_state = state; 1796f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch} 1806f543c786fc42989f552b4daa774ca5ff32fa697Ben Murdoch 1811e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)} 182