Devtools[LayoutEditor]: Rework layout-editor workflow

Source/web/InspectorOverlayImpl.cpp

 /*
  * Copyright (C) 2011 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:
  *
  * 1.  Redistributions of source code must retain the above copyright
  *     notice, this list of conditions and the following disclaimer.
  * 2.  Redistributions in binary form must reproduce the above copyright
@@ skipping 164 matching lines @@
     , m_overlayHost(InspectorOverlayHost::create())
     , m_drawViewSize(false)
     , m_drawViewSizeWithGrid(false)
     , m_resizeTimerActive(false)
     , m_omitTooltip(false)
     , m_timer(this, &InspectorOverlayImpl::onTimer)
     , m_suspendCount(0)
     , m_inLayout(false)
     , m_needsUpdate(false)
     , m_inspectMode(InspectorDOMAgent::NotSearching)
+    , m_layoutEditorEnabled(false)
 {
 }
 
 InspectorOverlayImpl::~InspectorOverlayImpl()
 {
     ASSERT(!m_overlayPage);
 }
 
 DEFINE_TRACE(InspectorOverlayImpl)
 {
     visitor->trace(m_highlightNode);
     visitor->trace(m_eventTargetNode);
     visitor->trace(m_overlayPage);
     visitor->trace(m_overlayChromeClient);
     visitor->trace(m_overlayHost);
     visitor->trace(m_debuggerAgent);
     visitor->trace(m_domAgent);
     visitor->trace(m_layoutEditor);
     visitor->trace(m_hoveredNodeForInspectMode);
 }
 
 void InspectorOverlayImpl::init(InspectorCSSAgent* cssAgent, InspectorDebuggerAgent* debuggerAgent, InspectorDOMAgent* domAgent)
 {
-    m_layoutEditor = LayoutEditor::create(cssAgent);
+    m_layoutEditor = LayoutEditor::create(cssAgent, domAgent);
     m_debuggerAgent = debuggerAgent;
     m_domAgent = domAgent;
     m_overlayHost->setListener(this);
 }
 
 void InspectorOverlayImpl::invalidate()
 {
     if (!m_pageOverlay)
         m_pageOverlay = PageOverlay::create(m_webViewImpl, new InspectorPageOverlayDelegate(*this));
 
@@ skipping 65 matching lines @@
 }
 
 void InspectorOverlayImpl::setPausedInDebuggerMessage(const String* message)
 {
     m_pausedInDebuggerMessage = message ? *message : String();
     update();
 }
 
 void InspectorOverlayImpl::hideHighlight()
 {
-    if (m_layoutEditor)
-        m_layoutEditor->setNode(nullptr);
     m_highlightNode.clear();
     m_eventTargetNode.clear();
     m_highlightQuad.clear();
-    update();
+
+    if (m_inspectMode == InspectorDOMAgent::ShowLayoutEditor && m_layoutEditorEnabled && m_layoutEditor->node() && m_inspectModeHighlightConfig)
+        highlightNode(m_layoutEditor->node(), *m_inspectModeHighlightConfig, false);
+    else
+        update();
 }
 
 void InspectorOverlayImpl::highlightNode(Node* node, const InspectorHighlightConfig& highlightConfig, bool omitTooltip)
 {
     highlightNode(node, nullptr, highlightConfig, omitTooltip);
 }
 
 void InspectorOverlayImpl::highlightNode(Node* node, Node* eventTarget, const InspectorHighlightConfig& highlightConfig, bool omitTooltip)
 {
     m_nodeHighlightConfig = highlightConfig;
     m_highlightNode = node;
-    if (m_layoutEditor && highlightConfig.showLayoutEditor)
-        m_layoutEditor->setNode(node);
     m_eventTargetNode = eventTarget;
     m_omitTooltip = omitTooltip;
     update();
 }
 
 void InspectorOverlayImpl::setInspectMode(InspectorDOMAgent::SearchMode searchMode, PassOwnPtr<InspectorHighlightConfig> highlightConfig)
 {
     m_inspectMode = searchMode;
     update();
 
     if (searchMode != InspectorDOMAgent::NotSearching) {
         m_inspectModeHighlightConfig = highlightConfig;
     } else {
+        m_layoutEditorEnabled = false;
         m_hoveredNodeForInspectMode.clear();
         hideHighlight();
     }
 }
 
 void InspectorOverlayImpl::highlightQuad(PassOwnPtr<FloatQuad> quad, const InspectorHighlightConfig& highlightConfig)
 {
     m_quadHighlightConfig = highlightConfig;
     m_highlightQuad = quad;
     m_omitTooltip = false;
@@ skipping 49 matching lines @@
     if (!m_highlightNode)
         return;
 
     bool appendElementInfo = m_highlightNode->isElementNode() && !m_omitTooltip && m_nodeHighlightConfig.showInfo && m_highlightNode->layoutObject() && m_highlightNode->document().frame();
     InspectorHighlight highlight(m_highlightNode.get(), m_nodeHighlightConfig, appendElementInfo);
     if (m_eventTargetNode)
         highlight.appendEventTargetQuads(m_eventTargetNode.get(), m_nodeHighlightConfig);
 
     RefPtr<JSONObject> highlightJSON = highlight.asJSONObject();
     evaluateInOverlay("drawHighlight", highlightJSON.release());
-    if (m_layoutEditor && m_nodeHighlightConfig.showLayoutEditor) {
+    if (m_highlightNode == m_layoutEditor->node() && m_inspectMode == InspectorDOMAgent::ShowLayoutEditor && m_layoutEditorEnabled) {

[dgozman, 2015/09/02 01:17:22]

Let's instead ASSERT(m_layoutEditorEnabled).

[sergeyv, 2015/09/02 01:49:16]

Done.

         RefPtr<JSONObject> layoutEditorInfo = m_layoutEditor->buildJSONInfo();
         if (layoutEditorInfo)
             evaluateInOverlay("showLayoutEditor", layoutEditorInfo.release());
     }
 }
 
 void InspectorOverlayImpl::drawQuadHighlight()
 {
     if (!m_highlightQuad)
         return;
@@ skipping 157 matching lines @@
 void InspectorOverlayImpl::overlayPropertyChanged(float value)
 {
     m_layoutEditor->overlayPropertyChanged(value);
 }
 
 void InspectorOverlayImpl::overlayEndedPropertyChange()
 {
     m_layoutEditor->overlayEndedPropertyChange();
 }
 
+void InspectorOverlayImpl::clearSelection(bool commitChanges)
+{
+    if (m_inspectMode != InspectorDOMAgent::ShowLayoutEditor)
+        return;
+
+    m_layoutEditorEnabled = false;
+    if (m_layoutEditor->node() && m_inspectModeHighlightConfig) {
+        m_hoveredNodeForInspectMode = m_layoutEditor->node();
+        highlightNode(m_layoutEditor->node(), *m_inspectModeHighlightConfig, false);
+    }
+
+    m_layoutEditor->clearSelection(commitChanges);

[dgozman, 2015/09/02 01:17:22]

Let's rename setNode to selectNode.

[sergeyv, 2015/09/02 01:49:16]

Done.

+}
+
 void InspectorOverlayImpl::profilingStarted()
 {
     if (!m_suspendCount++)
         clear();
 }
 
 void InspectorOverlayImpl::profilingStopped()
 {
     --m_suspendCount;
 }
 
 void InspectorOverlayImpl::pageLayoutInvalidated(bool resized)
 {
     if (resized && m_drawViewSize) {
         m_resizeTimerActive = true;
         m_timer.startOneShot(1, FROM_HERE);
     }
     update();
 }
 
 void InspectorOverlayImpl::setShowViewportSizeOnResize(bool show, bool showGrid)
 {
     m_drawViewSize = show;
     m_drawViewSizeWithGrid = showGrid;
 }
 
 bool InspectorOverlayImpl::handleMouseMove(const PlatformMouseEvent& event)
 {
-    if (m_inspectMode == InspectorDOMAgent::NotSearching)
+    if (!shouldSearchForNode())
         return false;
 
     LocalFrame* frame = m_webViewImpl->mainFrameImpl()->frame();
     if (!frame->view() || !frame->contentLayoutObject())
         return false;
     Node* node = hoveredNodeForEvent(frame, event, event.shiftKey());
 
     // Do not highlight within user agent shadow root unless requested.
     if (m_inspectMode != InspectorDOMAgent::SearchingForUAShadow) {
         ShadowRoot* shadowRoot = InspectorDOMAgent::userAgentShadowRoot(node);
@@ skipping 14 matching lines @@
 
     if (node && m_inspectModeHighlightConfig) {
         m_hoveredNodeForInspectMode = node;
         highlightNode(node, eventTarget, *m_inspectModeHighlightConfig, event.ctrlKey() || event.metaKey());
     }
     return true;
 }
 
 bool InspectorOverlayImpl::handleMousePress()
 {
-    if (m_inspectMode == InspectorDOMAgent::NotSearching)
+    if (!shouldSearchForNode())
         return false;
 
     if (m_hoveredNodeForInspectMode) {
-        if (m_domAgent)
-            m_domAgent->inspect(m_hoveredNodeForInspectMode.get());
+        inspect(m_hoveredNodeForInspectMode.get());
         m_hoveredNodeForInspectMode.clear();
         return true;
     }
     return false;
 }
 
 bool InspectorOverlayImpl::handleGestureEvent(const PlatformGestureEvent& event)
 {
-    if (m_inspectMode == InspectorDOMAgent::NotSearching || event.type() != PlatformEvent::GestureTap)
+    if (!shouldSearchForNode() || event.type() != PlatformEvent::GestureTap)
         return false;
     Node* node = hoveredNodeForEvent(m_webViewImpl->mainFrameImpl()->frame(), event, false);
     if (node && m_inspectModeHighlightConfig) {
         highlightNode(node, *m_inspectModeHighlightConfig, false);
-        if (m_domAgent)
-            m_domAgent->inspect(node);
+        inspect(node);
         return true;
     }
     return false;
 }
 
 bool InspectorOverlayImpl::handleTouchEvent(const PlatformTouchEvent& event)
 {
-    if (m_inspectMode == InspectorDOMAgent::NotSearching)
+    if (!shouldSearchForNode())
         return false;
     Node* node = hoveredNodeForEvent(m_webViewImpl->mainFrameImpl()->frame(), event, false);
     if (node && m_inspectModeHighlightConfig) {
         highlightNode(node, *m_inspectModeHighlightConfig, false);
-        if (m_domAgent)
-            m_domAgent->inspect(node);
+        inspect(node);
         return true;
     }
     return false;
 }
 
+
+bool InspectorOverlayImpl::shouldSearchForNode()
+{
+    return !(m_inspectMode == InspectorDOMAgent::NotSearching || (m_inspectMode == InspectorDOMAgent::ShowLayoutEditor && m_layoutEditorEnabled));
+}
+
+void InspectorOverlayImpl::inspect(Node* node)
+{
+    if (m_domAgent)
+        m_domAgent->inspect(node);
+
+    if (m_layoutEditor && m_inspectMode == InspectorDOMAgent::ShowLayoutEditor && !m_layoutEditorEnabled) {
+        m_layoutEditorEnabled = true;
+        m_layoutEditor->setNode(node);
+        highlightNode(node, *m_inspectModeHighlightConfig, false);
+    }
+}
+
 } // namespace blink