cc: handling debug settings in new LayerTreeDebugState structure

cc/layer_tree_host.cc

 // Copyright 2011 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "cc/layer_tree_host.h"
 
 #include "base/command_line.h"
 #include "base/debug/trace_event.h"
 #include "base/message_loop.h"
 #include "cc/font_atlas.h"
@@ skipping 11 matching lines @@
 #include "cc/overdraw_metrics.h"
 #include "cc/single_thread_proxy.h"
 #include "cc/switches.h"
 #include "cc/thread.h"
 #include "cc/thread_proxy.h"
 #include "cc/tree_synchronizer.h"
 
 using namespace std;
 
 namespace {
+
 static int numLayerTreeInstances;
+
+// merge blocks of memory - ORs num bytes from source into destination
+void* memmrg(void* destination, const void* source, size_t num)
+{
+    char* dstPtr = (char*)destination;
+    char* srcPtr = (char*)source;
+
+    for (size_t i = 0; i < num; i++)
+        dstPtr[i] |= srcPtr[i];
+
+    return destination;
+}
+
 }
 
 namespace cc {
 
 bool LayerTreeHost::s_needsFilterContext = false;
 
-LayerTreeSettings::LayerTreeSettings()
-    : acceleratePainting(false)
+LayerTreeDebugState::LayerTreeDebugState()
+    : showFPSCounter(false)
+    , showPlatformLayerTree(false)
     , showDebugBorders(false)
-    , showPlatformLayerTree(false)
     , showPaintRects(false)
     , showPropertyChangedRects(false)
     , showSurfaceDamageRects(false)
     , showScreenSpaceRects(false)
     , showReplicaScreenSpaceRects(false)
     , showOccludingRects(false)
     , showNonOccludingRects(false)
+{
+}
+
+LayerTreeDebugState::~LayerTreeDebugState()
+{
+}
+
+bool LayerTreeDebugState::showHudInfo() const
+{
+    return showFPSCounter || showPlatformLayerTree || showHudRects();
+}
+
+bool LayerTreeDebugState::showHudRects() const
+{
+    return showPaintRects || showPropertyChangedRects || showSurfaceDamageRects || showScreenSpaceRects || showReplicaScreenSpaceRects || showOccludingRects || showNonOccludingRects;
+}
+
+bool LayerTreeDebugState::equal(const LayerTreeDebugState& a, const LayerTreeDebugState& b)
+{
+    return memcmp(&a, &b, sizeof(LayerTreeDebugState)) == 0;

[danakj, 2012/11/27 20:23:15]

this is fine.

+}
+
+LayerTreeDebugState LayerTreeDebugState::merge(const LayerTreeDebugState& a, const LayerTreeDebugState& b)

[danakj, 2012/11/27 20:23:15]

better names than "a" and "b" please. initialState and requestedEnabledState?

[egraether, 2012/11/27 22:10:47]

this method just ORs the states and returns a new one, so there is no real
meaning to the parameters. I think putting something could be misleading. same
applies for the equal method.

+{
+    LayerTreeDebugState r(a);
+    memmrg(&r, &b, sizeof(LayerTreeDebugState));

[danakj, 2012/11/27 20:23:15]

i liked just doing the | for each flag before better.

[egraether, 2012/11/27 22:10:47]

that was just a little experiment, because I don't really like that big block of
| statements. I then realized that this wouldn't work to well as soon as you add
members that are numbers or anything.

[danakj, 2012/11/27 22:15:00]

merge(a, b) is super not clear what is happening though.

We should use names for the variables that show their intended use.

equals(a,b) doesn't make me wonder about what the inside of the function is
doing and what the purpose of the two variables is.

+    return r;
+}
+
+LayerTreeSettings::LayerTreeSettings()
+    : acceleratePainting(false)
     , renderVSyncEnabled(true)
     , perTilePaintingEnabled(false)
     , partialSwapEnabled(false)
     , acceleratedAnimationEnabled(true)
     , pageScalePinchZoomEnabled(false)
     , backgroundColorInsteadOfCheckerboard(false)
     , showOverdrawInTracing(false)
     , refreshRate(0)
     , maxPartialTextureUpdates(std::numeric_limits<size_t>::max())
     , defaultTileSize(gfx::Size(256, 256))
     , maxUntiledLayerSize(gfx::Size(512, 512))
     , minimumOcclusionTrackingSize(gfx::Size(160, 160))
 {
     // TODO(danakj): Move this to chromium when we don't go through the WebKit API anymore.
-    showPropertyChangedRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowPropertyChangedRects);
-    showSurfaceDamageRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowSurfaceDamageRects);
-    showScreenSpaceRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowScreenSpaceRects);
-    showReplicaScreenSpaceRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowReplicaScreenSpaceRects);
-    showOccludingRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowOccludingRects);
-    showNonOccludingRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowNonOccludingRects);
     partialSwapEnabled = CommandLine::ForCurrentProcess()->HasSwitch(switches::kEnablePartialSwap);
     backgroundColorInsteadOfCheckerboard = CommandLine::ForCurrentProcess()->HasSwitch(switches::kBackgroundColorInsteadOfCheckerboard);
     showOverdrawInTracing = CommandLine::ForCurrentProcess()->HasSwitch(switches::kTraceOverdraw);
+
+    initialDebugState.showPropertyChangedRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowPropertyChangedRects);
+    initialDebugState.showSurfaceDamageRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowSurfaceDamageRects);
+    initialDebugState.showScreenSpaceRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowScreenSpaceRects);
+    initialDebugState.showReplicaScreenSpaceRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowReplicaScreenSpaceRects);
+    initialDebugState.showOccludingRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowOccludingRects);
+    initialDebugState.showNonOccludingRects = CommandLine::ForCurrentProcess()->HasSwitch(cc::switches::kShowNonOccludingRects);
 }
 
 LayerTreeSettings::~LayerTreeSettings()
 {
 }
 
 RendererCapabilities::RendererCapabilities()
     : bestTextureFormat(0)
     , contextHasCachedFrontBuffer(false)
     , usingPartialSwap(false)
@@ skipping 28 matching lines @@
     : m_animating(false)
     , m_needsAnimateLayers(false)
     , m_client(client)
     , m_commitNumber(0)
     , m_renderingStats()
     , m_rendererInitialized(false)
     , m_contextLost(false)
     , m_numTimesRecreateShouldFail(0)
     , m_numFailedRecreateAttempts(0)
     , m_settings(settings)
+    , m_debugState(settings.initialDebugState)
     , m_deviceScaleFactor(1)
     , m_visible(true)
     , m_pageScaleFactor(1)
     , m_minPageScaleFactor(1)
     , m_maxPageScaleFactor(1)
     , m_triggerIdleUpdates(true)
     , m_backgroundColor(SK_ColorWHITE)
     , m_hasTransparentBackground(false)
     , m_partialTextureUpdateRequests(0)
 {
@@ skipping 150 matching lines @@
     // to visit their controllers.
     if (rootLayer() && m_needsAnimateLayers)
         hostImpl->setNeedsAnimateLayers();
 
     hostImpl->setSourceFrameNumber(commitNumber());
     hostImpl->setViewportSize(layoutViewportSize(), deviceViewportSize());
     hostImpl->setDeviceScaleFactor(deviceScaleFactor());
     hostImpl->setPageScaleFactorAndLimits(m_pageScaleFactor, m_minPageScaleFactor, m_maxPageScaleFactor);
     hostImpl->setBackgroundColor(m_backgroundColor);
     hostImpl->setHasTransparentBackground(m_hasTransparentBackground);
+    hostImpl->setDebugState(m_debugState);
 
     m_commitNumber++;
 }
 
 void LayerTreeHost::createHUDLayerIfNeeded()
 {
     if (!m_hudLayer)
         m_hudLayer = HeadsUpDisplayLayer::create();
 }
 
-void LayerTreeHost::setShowFPSCounter(bool show)
-{
-    createHUDLayerIfNeeded();
-    m_hudLayer->setShowFPSCounter(show);
-}
-
 void LayerTreeHost::setFontAtlas(scoped_ptr<FontAtlas> fontAtlas)
 {
     createHUDLayerIfNeeded();
     m_hudLayer->setFontAtlas(fontAtlas.Pass());
 }
 
 void LayerTreeHost::willCommit()
 {
     m_client->willCommit();
 
-    if (m_settings.showDebugInfo())
+    if (m_debugState.showHudInfo())
         createHUDLayerIfNeeded();
 
     if (m_rootLayer && m_hudLayer && !m_hudLayer->parent())
         m_rootLayer->addChild(m_hudLayer);
 }
 
 void LayerTreeHost::commitComplete()
 {
     m_client->didCommit();
 }
@@ skipping 106 matching lines @@
     m_rootLayer = rootLayer;
     if (m_rootLayer)
         m_rootLayer->setLayerTreeHost(this);
 
     if (m_hudLayer)
         m_hudLayer->removeFromParent();
 
     setNeedsCommit();
 }
 
+void LayerTreeHost::setDebugState(const LayerTreeDebugState& debugState)
+{
+    if (!LayerTreeDebugState::equal(m_debugState, debugState)) {

[danakj, 2012/11/27 20:23:15]

I think you want to merge, then compare to m_debugState. Then
assign/setNeedsCommit if anything changed.

[egraether, 2012/11/27 22:10:47]

Yeah, that sounds more stable. I just tried to be efficient.

+        m_debugState = LayerTreeDebugState::merge(m_settings.initialDebugState, debugState);
+        setNeedsCommit();
+    }
+}
+
 void LayerTreeHost::setViewportSize(const gfx::Size& layoutViewportSize, const gfx::Size& deviceViewportSize)
 {
     if (layoutViewportSize == m_layoutViewportSize && deviceViewportSize == m_deviceViewportSize)
         return;
 
     m_layoutViewportSize = layoutViewportSize;
     m_deviceViewportSize = deviceViewportSize;
 
     setNeedsCommit();
 }
@@ skipping 402 matching lines @@
             else
                 layer->notifyAnimationFinished(wallClockTime.ToDoubleT());
         }
     }
 
     for (size_t childIndex = 0; childIndex < layer->children().size(); ++childIndex)
         setAnimationEventsRecursive(events, layer->children()[childIndex].get(), wallClockTime);
 }
 
 }  // namespace cc