| /* |
| * Copyright (C) 2013 Google Inc. All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are |
| * met: |
| * |
| * * Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * * Redistributions in binary form must reproduce the above |
| * copyright notice, this list of conditions and the following disclaimer |
| * in the documentation and/or other materials provided with the |
| * distribution. |
| * * Neither the name of Google Inc. nor the names of its |
| * contributors may be used to endorse or promote products derived from |
| * this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| #include "config.h" |
| #include "core/dom/DocumentLifecycle.h" |
| |
| #include "platform/RuntimeEnabledFeatures.h" |
| #include "wtf/Assertions.h" |
| |
| namespace blink { |
| |
| static DocumentLifecycle::DeprecatedTransition* s_deprecatedTransitionStack = 0; |
| |
| // TODO(skyostil): Come up with a better way to store cross-frame lifecycle |
| // related data to avoid this being a global setting. |
| static unsigned s_preventThrottlingCount = 0; |
| |
| DocumentLifecycle::Scope::Scope(DocumentLifecycle& lifecycle, State finalState) |
| : m_lifecycle(lifecycle) |
| , m_finalState(finalState) |
| { |
| } |
| |
| DocumentLifecycle::Scope::~Scope() |
| { |
| m_lifecycle.advanceTo(m_finalState); |
| } |
| |
| DocumentLifecycle::DeprecatedTransition::DeprecatedTransition(State from, State to) |
| : m_previous(s_deprecatedTransitionStack) |
| , m_from(from) |
| , m_to(to) |
| { |
| s_deprecatedTransitionStack = this; |
| } |
| |
| DocumentLifecycle::DeprecatedTransition::~DeprecatedTransition() |
| { |
| s_deprecatedTransitionStack = m_previous; |
| } |
| |
| DocumentLifecycle::PreventThrottlingScope::PreventThrottlingScope(DocumentLifecycle& lifecycle) |
| { |
| s_preventThrottlingCount++; |
| } |
| |
| DocumentLifecycle::PreventThrottlingScope::~PreventThrottlingScope() |
| { |
| ASSERT(s_preventThrottlingCount > 0); |
| s_preventThrottlingCount--; |
| } |
| |
| DocumentLifecycle::DocumentLifecycle() |
| : m_state(Uninitialized) |
| , m_detachCount(0) |
| { |
| } |
| |
| DocumentLifecycle::~DocumentLifecycle() |
| { |
| } |
| |
| #if ENABLE(ASSERT) |
| |
| bool DocumentLifecycle::canAdvanceTo(State nextState) const |
| { |
| // We can stop from anywhere. |
| if (nextState == Stopping) |
| return true; |
| |
| switch (m_state) { |
| case Uninitialized: |
| return nextState == Inactive; |
| case Inactive: |
| if (nextState == StyleClean) |
| return true; |
| if (nextState == Disposed) |
| return true; |
| break; |
| case VisualUpdatePending: |
| if (nextState == InPreLayout) |
| return true; |
| if (nextState == InStyleRecalc) |
| return true; |
| if (nextState == InPerformLayout) |
| return true; |
| break; |
| case InStyleRecalc: |
| return nextState == StyleClean; |
| case StyleClean: |
| // We can synchronously recalc style. |
| if (nextState == InStyleRecalc) |
| return true; |
| // We can notify layout objects that subtrees changed. |
| if (nextState == InLayoutSubtreeChange) |
| return true; |
| // We can synchronously perform layout. |
| if (nextState == InPreLayout) |
| return true; |
| if (nextState == InPerformLayout) |
| return true; |
| // We can redundant arrive in the style clean state. |
| if (nextState == StyleClean) |
| return true; |
| if (nextState == LayoutClean) |
| return true; |
| if (nextState == InCompositingUpdate) |
| return true; |
| break; |
| case InLayoutSubtreeChange: |
| return nextState == LayoutSubtreeChangeClean; |
| case LayoutSubtreeChangeClean: |
| // We can synchronously recalc style. |
| if (nextState == InStyleRecalc) |
| return true; |
| // We can synchronously perform layout. |
| if (nextState == InPreLayout) |
| return true; |
| if (nextState == InPerformLayout) |
| return true; |
| // Can move back to style clean. |
| if (nextState == StyleClean) |
| return true; |
| if (nextState == LayoutClean) |
| return true; |
| if (nextState == InCompositingUpdate) |
| return true; |
| break; |
| case InPreLayout: |
| if (nextState == InStyleRecalc) |
| return true; |
| if (nextState == StyleClean) |
| return true; |
| if (nextState == InPreLayout) |
| return true; |
| break; |
| case InPerformLayout: |
| return nextState == AfterPerformLayout; |
| case AfterPerformLayout: |
| // We can synchronously recompute layout in AfterPerformLayout. |
| // FIXME: Ideally, we would unnest this recursion into a loop. |
| if (nextState == InPreLayout) |
| return true; |
| if (nextState == LayoutClean) |
| return true; |
| break; |
| case LayoutClean: |
| // We can synchronously recalc style. |
| if (nextState == InStyleRecalc) |
| return true; |
| // We can synchronously perform layout. |
| if (nextState == InPreLayout) |
| return true; |
| if (nextState == InPerformLayout) |
| return true; |
| // We can redundantly arrive in the layout clean state. This situation |
| // can happen when we call layout recursively and we unwind the stack. |
| if (nextState == LayoutClean) |
| return true; |
| if (nextState == StyleClean) |
| return true; |
| if (nextState == InCompositingUpdate) |
| return true; |
| break; |
| case InCompositingUpdate: |
| return nextState == CompositingClean; |
| case CompositingClean: |
| if (nextState == InStyleRecalc) |
| return true; |
| if (nextState == InPreLayout) |
| return true; |
| if (nextState == InCompositingUpdate) |
| return true; |
| if (nextState == InPaintInvalidation) |
| return true; |
| break; |
| case InPaintInvalidation: |
| return nextState == PaintInvalidationClean; |
| case PaintInvalidationClean: |
| if (nextState == InStyleRecalc) |
| return true; |
| if (nextState == InPreLayout) |
| return true; |
| if (nextState == InCompositingUpdate) |
| return true; |
| if (RuntimeEnabledFeatures::slimmingPaintV2Enabled()) { |
| if (nextState == InUpdatePaintProperties) |
| return true; |
| } else { |
| if (nextState == InPaint && RuntimeEnabledFeatures::slimmingPaintSynchronizedPaintingEnabled()) |
| return true; |
| } |
| break; |
| case InUpdatePaintProperties: |
| if (nextState == UpdatePaintPropertiesClean && RuntimeEnabledFeatures::slimmingPaintV2Enabled()) |
| return true; |
| break; |
| case UpdatePaintPropertiesClean: |
| if (nextState == InPaint && RuntimeEnabledFeatures::slimmingPaintV2Enabled()) |
| return true; |
| break; |
| case InPaint: |
| if (nextState == PaintClean && RuntimeEnabledFeatures::slimmingPaintSynchronizedPaintingEnabled()) |
| return true; |
| break; |
| case PaintClean: |
| if (!RuntimeEnabledFeatures::slimmingPaintSynchronizedPaintingEnabled()) |
| break; |
| if (nextState == InStyleRecalc) |
| return true; |
| if (nextState == InPreLayout) |
| return true; |
| if (nextState == InCompositingUpdate) |
| return true; |
| break; |
| case Stopping: |
| return nextState == Stopped; |
| case Stopped: |
| return nextState == Disposed; |
| case Disposed: |
| // FIXME: We can dispose a document multiple times. This seems wrong. |
| // See https://code.google.com/p/chromium/issues/detail?id=301668. |
| return nextState == Disposed; |
| } |
| return false; |
| } |
| |
| bool DocumentLifecycle::canRewindTo(State nextState) const |
| { |
| // This transition is bogus, but we've whitelisted it anyway. |
| if (s_deprecatedTransitionStack && m_state == s_deprecatedTransitionStack->from() && nextState == s_deprecatedTransitionStack->to()) |
| return true; |
| return m_state == StyleClean |
| || m_state == LayoutSubtreeChangeClean |
| || m_state == AfterPerformLayout |
| || m_state == LayoutClean |
| || m_state == CompositingClean |
| || m_state == PaintInvalidationClean |
| || (m_state == PaintClean && RuntimeEnabledFeatures::slimmingPaintSynchronizedPaintingEnabled()); |
| } |
| |
| #endif |
| |
| void DocumentLifecycle::advanceTo(State nextState) |
| { |
| ASSERT_WITH_MESSAGE(canAdvanceTo(nextState), |
| "Cannot advance document lifecycle from %s to %s.", stateAsDebugString(m_state), stateAsDebugString(nextState)); |
| m_state = nextState; |
| } |
| |
| void DocumentLifecycle::ensureStateAtMost(State state) |
| { |
| ASSERT(state == VisualUpdatePending || state == StyleClean || state == LayoutClean); |
| if (m_state <= state) |
| return; |
| ASSERT_WITH_MESSAGE(canRewindTo(state), |
| "Cannot rewind document lifecycle from %s to %s.", stateAsDebugString(m_state), stateAsDebugString(state)); |
| m_state = state; |
| } |
| |
| bool DocumentLifecycle::throttlingAllowed() const |
| { |
| return !s_preventThrottlingCount; |
| } |
| |
| #if ENABLE(ASSERT) |
| #define DEBUG_STRING_CASE(StateName) \ |
| case StateName: return #StateName |
| |
| const char* DocumentLifecycle::stateAsDebugString(const State state) |
| { |
| switch (state) { |
| DEBUG_STRING_CASE(Uninitialized); |
| DEBUG_STRING_CASE(Inactive); |
| DEBUG_STRING_CASE(VisualUpdatePending); |
| DEBUG_STRING_CASE(InStyleRecalc); |
| DEBUG_STRING_CASE(StyleClean); |
| DEBUG_STRING_CASE(InLayoutSubtreeChange); |
| DEBUG_STRING_CASE(LayoutSubtreeChangeClean); |
| DEBUG_STRING_CASE(InPreLayout); |
| DEBUG_STRING_CASE(InPerformLayout); |
| DEBUG_STRING_CASE(AfterPerformLayout); |
| DEBUG_STRING_CASE(LayoutClean); |
| DEBUG_STRING_CASE(InCompositingUpdate); |
| DEBUG_STRING_CASE(CompositingClean); |
| DEBUG_STRING_CASE(InPaintInvalidation); |
| DEBUG_STRING_CASE(PaintInvalidationClean); |
| DEBUG_STRING_CASE(InUpdatePaintProperties); |
| DEBUG_STRING_CASE(UpdatePaintPropertiesClean); |
| DEBUG_STRING_CASE(InPaint); |
| DEBUG_STRING_CASE(PaintClean); |
| DEBUG_STRING_CASE(Stopping); |
| DEBUG_STRING_CASE(Stopped); |
| DEBUG_STRING_CASE(Disposed); |
| } |
| |
| ASSERT_NOT_REACHED(); |
| return "Unknown"; |
| } |
| #endif |
| |
| } |
