CSS shapes support in Web Inspector

Source/core/inspector/InspectorOverlay.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 465 matching lines @@
 }
 
 static PassRefPtr<JSONObject> buildObjectForSize(const IntSize& size)
 {
     RefPtr<JSONObject> result = JSONObject::create();
     result->setNumber("width", size.width());
     result->setNumber("height", size.height());
     return result.release();
 }
 
-static void setElementInfo(RefPtr<JSONObject>& highlightObject, Node* node)
+// CSS shapes
+struct PathApplyInfo {
+    FrameView* rootView;
+    FrameView* view;
+    JSONArray* array;
+    RenderObject* renderer;
+    const ShapeOutsideInfo* shapeOutsideInfo;
+};
+
+static void appendPathCommandAndPoints(PathApplyInfo* info, const String& command, const FloatPoint points[], unsigned length)
+{
+    FloatPoint point;
+    info->array->pushString(command);
+    for (unsigned i = 0; i < length; i++) {
+        point = info->shapeOutsideInfo->shapeToRendererPoint(points[i]);
+        point = info->view->contentsToRootView(roundedIntPoint(info->renderer->localToAbsolute(point))) + info->rootView->scrollOffset();
+        info->array->pushNumber(point.x());
+        info->array->pushNumber(point.y());
+    }
+}
+
+static void appendPathSegment(void* info, const PathElement* pathElement)
+{
+    PathApplyInfo* pathApplyInfo = static_cast<PathApplyInfo*>(info);
+    FloatPoint point;
+    switch (pathElement->type) {
+    // The points member will contain 1 value.
+    case PathElementMoveToPoint:
+        appendPathCommandAndPoints(pathApplyInfo, "M", pathElement->points, 1);
+        break;
+    // The points member will contain 1 value.
+    case PathElementAddLineToPoint:
+        appendPathCommandAndPoints(pathApplyInfo, "L", pathElement->points, 1);
+        break;
+    // The points member will contain 3 values.
+    case PathElementAddCurveToPoint:
+        appendPathCommandAndPoints(pathApplyInfo, "C", pathElement->points, 3);
+        break;
+    // The points member will contain 2 values.
+    case PathElementAddQuadCurveToPoint:
+        appendPathCommandAndPoints(pathApplyInfo, "Q", pathElement->points, 2);
+        break;
+    // The points member will contain no values.
+    case PathElementCloseSubpath:
+        appendPathCommandAndPoints(pathApplyInfo, "Z", 0, 0);
+        break;
+    }
+}
+
+static PassRefPtr<JSONObject> buildObjectForShapeOutside(Node *node)
+{
+    RenderObject* renderer = node->renderer();
+    if (renderer && renderer->isBox()) {
+        LocalFrame* containingFrame = node->document().frame();
+        RenderBox* renderBox = toRenderBox(renderer);
+
+        const ShapeOutsideInfo* shapeOutsideInfo = renderBox->shapeOutsideInfo();
+        if (!shapeOutsideInfo)
+            return nullptr;
+
+        RefPtr<JSONObject> shapeObject = JSONObject::create();
+        LayoutRect shapeBounds = shapeOutsideInfo->computedShapePhysicalBoundingBox();
+        FloatQuad shapeQuad = renderBox->localToAbsoluteQuad(FloatRect(shapeBounds));
+        FrameView* mainView = containingFrame->page()->mainFrame()->view();
+        FrameView* containingView = containingFrame->view();
+        contentsQuadToPage(mainView, containingView, shapeQuad);
+        shapeObject->setArray("bounds", buildArrayForQuad(shapeQuad));
+
+        Shape::DisplayPaths paths;
+        shapeOutsideInfo->computedShape().buildDisplayPaths(paths);
+
+        if (paths.shape.length()) {
+            RefPtr<JSONArray> shapePath = JSONArray::create();
+            PathApplyInfo info;
+            info.rootView = mainView;
+            info.view = containingView;
+            info.array = shapePath.get();
+            info.renderer = renderBox;
+            info.shapeOutsideInfo = shapeOutsideInfo;
+            paths.shape.apply(&info, &appendPathSegment);
+            shapeObject->setArray("shape", shapePath.release());
+            if (paths.marginShape.length()) {
+                shapePath = JSONArray::create();
+                info.array = shapePath.get();
+                paths.marginShape.apply(&info, &appendPathSegment);
+                shapeObject->setArray("marginShape", shapePath.release());
+            }
+        }
+        return shapeObject.release();
+    }
+    return nullptr;
+}
+
+static void setElementInfo(RefPtr<JSONObject>& highlightObject, RefPtr<JSONObject>& shapeObject, Node* node)
 {
     RefPtr<JSONObject> elementInfo = JSONObject::create();
     Element* element = toElement(node);
     Element* realElement = element;
     PseudoElement* pseudoElement = 0;
     if (element->isPseudoElement()) {
         pseudoElement = toPseudoElement(element);
         realElement = element->parentOrShadowHostElement();
     }
     bool isXHTML = realElement->document().isXHTMLDocument();
@@ skipping 21 matching lines @@
     if (!classNames.isEmpty())
         elementInfo->setString("className", classNames.toString());
 
     RenderObject* renderer = node->renderer();
     LocalFrame* containingFrame = node->document().frame();
     FrameView* containingView = containingFrame->view();
     IntRect boundingBox = pixelSnappedIntRect(containingView->contentsToRootView(renderer->absoluteBoundingBoxRect()));
     RenderBoxModelObject* modelObject = renderer->isBoxModelObject() ? toRenderBoxModelObject(renderer) : 0;
     elementInfo->setString("nodeWidth", String::number(modelObject ? adjustForAbsoluteZoom(modelObject->pixelSnappedOffsetWidth(), modelObject) : boundingBox.width()));
     elementInfo->setString("nodeHeight", String::number(modelObject ? adjustForAbsoluteZoom(modelObject->pixelSnappedOffsetHeight(), modelObject) : boundingBox.height()));
+    if (renderer->isBox() && shapeObject)
+        elementInfo->setObject("shapeOutsideInfo", shapeObject.release());
     highlightObject->setObject("elementInfo", elementInfo.release());
 }
 
 void InspectorOverlay::drawNodeHighlight()
 {
     if (!m_highlightNode)
         return;
 
     Highlight highlight;
     buildNodeHighlight(m_highlightNode.get(), m_nodeHighlightConfig, &highlight);
     if (m_eventTargetNode) {
         Highlight eventTargetHighlight;
         buildNodeHighlight(m_eventTargetNode.get(), m_nodeHighlightConfig, &eventTargetHighlight);
         highlight.quads.append(eventTargetHighlight.quads[1]); // Add border from eventTargetNode to highlight.
     }
     RefPtr<JSONObject> highlightObject = buildObjectForHighlight(highlight);
 
     Node* node = m_highlightNode.get();
+    RefPtr<JSONObject> shapeObject = buildObjectForShapeOutside(node);
     if (node->isElementNode() && !m_omitTooltip && m_nodeHighlightConfig.showInfo && node->renderer() && node->document().frame())
-        setElementInfo(highlightObject, node);
+        setElementInfo(highlightObject, shapeObject, node);
     evaluateInOverlay("drawNodeHighlight", highlightObject);
 }
 
 void InspectorOverlay::drawQuadHighlight()
 {
     if (!m_highlightQuad)
         return;
 
     Highlight highlight;
     buildQuadHighlight(m_page, *m_highlightQuad, m_quadHighlightConfig, &highlight);
@@ skipping 97 matching lines @@
     command->pushValue(argument);
     overlayPage()->mainFrame()->script().executeScriptInMainWorld("dispatch(" + command->toJSONString() + ")", ScriptController::ExecuteScriptWhenScriptsDisabled);
 }
 
 void InspectorOverlay::onTimer(Timer<InspectorOverlay>*)
 {
     m_drawViewSize = false;
     update();
 }
 
-bool InspectorOverlay::getBoxModel(Node* node, Vector<FloatQuad>* quads)
+bool InspectorOverlay::getBoxModel(Node* node, Vector<FloatQuad>* quads, String& shapeOutsideStr)
 {
+    RefPtr<JSONObject> shapeOutsideInfo = buildObjectForShapeOutside(node);
+    shapeOutsideStr = shapeOutsideInfo ? shapeOutsideInfo->toJSONString() : String();

[pfeldman, 2014/04/30 07:43:48]

You should not serialize shape into a string, declare a DOM.ShapeOutsideInfo
type in protocol.json so that it was an object with "bounds", "shape" and
"marginShape" (or what else could it have?); use array of "*" as a type of
"shape" and "marginShape" fields. It will generate a C++ class for you with
these properties. That's what your buildObjectForShapeOutside will return. You
can use this object both in overlay (via serialization) and return it over the
protocol.

[Habib Virji, 2014/05/01 09:52:07]

Done.

     return buildNodeQuads(node, *quads);
 }
 
 void InspectorOverlay::freePage()
 {
     if (m_overlayPage) {
         // FIXME: This logic is duplicated in SVGImage and WebViewImpl. Perhaps it can be combined
         // into Page's destructor.
         m_overlayPage->mainFrame()->loader().frameDetached();
         m_overlayPage->willBeDestroyed();
         m_overlayPage.clear();
     }
     m_overlayChromeClient.clear();
     m_timer.stop();
 
     // This will clear internal structures and issue update to the client. Safe to call last.
     hideHighlight();
 }
 
 void InspectorOverlay::startedRecordingProfile()
 {
     if (!m_activeProfilerCount++)
         freePage();
 }
 
 } // namespace WebCore