Google Git
Sign in
chromium / chromium / src / 1d01cbaf3860d44dc1128dc0337258f63024c4d4 / . / third_party / blink / renderer / core / inspector / inspector_highlight.cc
blob: 01fdd3ee1828dabdb93d9acd6d53e7c7265a8ed8 [file] [log] [blame]
// Copyright 2015 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 "third_party/blink/renderer/core/inspector/inspector_highlight.h"
#include "base/macros.h"
#include "third_party/blink/renderer/core/css/css_color_value.h"
#include "third_party/blink/renderer/core/css/css_computed_style_declaration.h"
#include "third_party/blink/renderer/core/css/css_grid_auto_repeat_value.h"
#include "third_party/blink/renderer/core/css/css_grid_integer_repeat_value.h"
#include "third_party/blink/renderer/core/css/css_property_name.h"
#include "third_party/blink/renderer/core/css/css_property_names.h"
#include "third_party/blink/renderer/core/css/css_value.h"
#include "third_party/blink/renderer/core/display_lock/display_lock_utilities.h"
#include "third_party/blink/renderer/core/dom/pseudo_element.h"
#include "third_party/blink/renderer/core/frame/local_frame_view.h"
#include "third_party/blink/renderer/core/frame/visual_viewport.h"
#include "third_party/blink/renderer/core/geometry/dom_rect.h"
#include "third_party/blink/renderer/core/inspector/dom_traversal_utils.h"
#include "third_party/blink/renderer/core/inspector/inspector_dom_agent.h"
#include "third_party/blink/renderer/core/layout/adjust_for_absolute_zoom.h"
#include "third_party/blink/renderer/core/layout/geometry/physical_offset.h"
#include "third_party/blink/renderer/core/layout/layout_box.h"
#include "third_party/blink/renderer/core/layout/layout_grid.h"
#include "third_party/blink/renderer/core/layout/layout_inline.h"
#include "third_party/blink/renderer/core/layout/layout_object.h"
#include "third_party/blink/renderer/core/layout/layout_view.h"
#include "third_party/blink/renderer/core/layout/shapes/shape_outside_info.h"
#include "third_party/blink/renderer/core/page/chrome_client.h"
#include "third_party/blink/renderer/core/page/page.h"
#include "third_party/blink/renderer/core/style/computed_style_constants.h"
#include "third_party/blink/renderer/core/style/grid_positions_resolver.h"
#include "third_party/blink/renderer/platform/geometry/float_point.h"
#include "third_party/blink/renderer/platform/geometry/layout_unit.h"
#include "third_party/blink/renderer/platform/graphics/path.h"
#include "third_party/blink/renderer/platform/text/writing_mode.h"
#include "third_party/blink/renderer/platform/web_test_support.h"
namespace blink {
namespace {
class PathBuilder {
STACK_ALLOCATED();
public:
PathBuilder() : path_(protocol::ListValue::create()) {}
virtual ~PathBuilder() = default;
std::unique_ptr<protocol::ListValue> Release() { return std::move(path_); }
void AppendPath(const Path& path, float scale) {
Path transform_path(path);
transform_path.Transform(AffineTransform().Scale(scale));
transform_path.Apply(this, &PathBuilder::AppendPathElement);
}
protected:
virtual FloatPoint TranslatePoint(const FloatPoint& point) { return point; }
private:
static void AppendPathElement(void* path_builder,
const PathElement* path_element) {
static_cast<PathBuilder*>(path_builder)->AppendPathElement(path_element);
}
void AppendPathElement(const PathElement*);
void AppendPathCommandAndPoints(const char* command,
const FloatPoint points[],
size_t length);
std::unique_ptr<protocol::ListValue> path_;
DISALLOW_COPY_AND_ASSIGN(PathBuilder);
};
void PathBuilder::AppendPathCommandAndPoints(const char* command,
const FloatPoint points[],
size_t length) {
path_->pushValue(protocol::StringValue::create(command));
for (size_t i = 0; i < length; i++) {
FloatPoint point = TranslatePoint(points[i]);
path_->pushValue(protocol::FundamentalValue::create(point.X()));
path_->pushValue(protocol::FundamentalValue::create(point.Y()));
}
}
void PathBuilder::AppendPathElement(const PathElement* path_element) {
switch (path_element->type) {
// The points member will contain 1 value.
case kPathElementMoveToPoint:
AppendPathCommandAndPoints("M", path_element->points, 1);
break;
// The points member will contain 1 value.
case kPathElementAddLineToPoint:
AppendPathCommandAndPoints("L", path_element->points, 1);
break;
// The points member will contain 3 values.
case kPathElementAddCurveToPoint:
AppendPathCommandAndPoints("C", path_element->points, 3);
break;
// The points member will contain 2 values.
case kPathElementAddQuadCurveToPoint:
AppendPathCommandAndPoints("Q", path_element->points, 2);
break;
// The points member will contain no values.
case kPathElementCloseSubpath:
AppendPathCommandAndPoints("Z", nullptr, 0);
break;
}
}
class ShapePathBuilder : public PathBuilder {
public:
ShapePathBuilder(LocalFrameView& view,
LayoutObject& layout_object,
const ShapeOutsideInfo& shape_outside_info)
: view_(&view),
layout_object_(&layout_object),
shape_outside_info_(shape_outside_info) {}
static std::unique_ptr<protocol::ListValue> BuildPath(
LocalFrameView& view,
LayoutObject& layout_object,
const ShapeOutsideInfo& shape_outside_info,
const Path& path,
float scale) {
ShapePathBuilder builder(view, layout_object, shape_outside_info);
builder.AppendPath(path, scale);
return builder.Release();
}
protected:
FloatPoint TranslatePoint(const FloatPoint& point) override {
PhysicalOffset layout_object_point = PhysicalOffset::FromFloatPointRound(
shape_outside_info_.ShapeToLayoutObjectPoint(point));
// TODO(pfeldman): Is this kIgnoreTransforms correct?
return FloatPoint(view_->FrameToViewport(
RoundedIntPoint(layout_object_->LocalToAbsolutePoint(
layout_object_point, kIgnoreTransforms))));
}
private:
LocalFrameView* view_;
LayoutObject* const layout_object_;
const ShapeOutsideInfo& shape_outside_info_;
};
std::unique_ptr<protocol::Array<double>> BuildArrayForQuad(
const FloatQuad& quad) {
return std::make_unique<std::vector<double>, std::initializer_list<double>>(
{quad.P1().X(), quad.P1().Y(), quad.P2().X(), quad.P2().Y(),
quad.P3().X(), quad.P3().Y(), quad.P4().X(), quad.P4().Y()});
}
Path QuadToPath(const FloatQuad& quad) {
Path quad_path;
quad_path.MoveTo(quad.P1());
quad_path.AddLineTo(quad.P2());
quad_path.AddLineTo(quad.P3());
quad_path.AddLineTo(quad.P4());
quad_path.CloseSubpath();
return quad_path;
}
Path RowQuadToPath(const FloatQuad& quad, bool drawEndLine) {
Path quad_path;
quad_path.MoveTo(quad.P1());
quad_path.AddLineTo(quad.P2());
if (drawEndLine) {
quad_path.MoveTo(quad.P3());
quad_path.AddLineTo(quad.P4());
}
return quad_path;
}
Path ColumnQuadToPath(const FloatQuad& quad, bool drawEndLine) {
Path quad_path;
quad_path.MoveTo(quad.P1());
quad_path.AddLineTo(quad.P4());
if (drawEndLine) {
quad_path.MoveTo(quad.P3());
quad_path.AddLineTo(quad.P2());
}
return quad_path;
}
FloatPoint FramePointToViewport(const LocalFrameView* view,
FloatPoint point_in_frame) {
FloatPoint point_in_root_frame = view->ConvertToRootFrame(point_in_frame);
return view->GetPage()->GetVisualViewport().RootFrameToViewport(
point_in_root_frame);
}
void FrameQuadToViewport(const LocalFrameView* view, FloatQuad& quad) {
quad.SetP1(FramePointToViewport(view, quad.P1()));
quad.SetP2(FramePointToViewport(view, quad.P2()));
quad.SetP3(FramePointToViewport(view, quad.P3()));
quad.SetP4(FramePointToViewport(view, quad.P4()));
}
const ShapeOutsideInfo* ShapeOutsideInfoForNode(Node* node,
Shape::DisplayPaths* paths,
FloatQuad* bounds) {
LayoutObject* layout_object = node->GetLayoutObject();
if (!layout_object || !layout_object->IsBox() ||
!ToLayoutBox(layout_object)->GetShapeOutsideInfo())
return nullptr;
LocalFrameView* containing_view = node->GetDocument().View();
LayoutBox* layout_box = ToLayoutBox(layout_object);
const ShapeOutsideInfo* shape_outside_info =
layout_box->GetShapeOutsideInfo();
shape_outside_info->ComputedShape().BuildDisplayPaths(*paths);
PhysicalRect shape_bounds =
shape_outside_info->ComputedShapePhysicalBoundingBox();
*bounds = layout_box->LocalRectToAbsoluteQuad(shape_bounds);
FrameQuadToViewport(containing_view, *bounds);
return shape_outside_info;
}
String ToHEXA(const Color& color) {
return String::Format("#%02X%02X%02X%02X", color.Red(), color.Green(),
color.Blue(), color.Alpha());
}
void AppendStyleInfo(Node* node,
protocol::DictionaryValue* element_info,
const InspectorHighlightContrastInfo& node_contrast) {
std::unique_ptr<protocol::DictionaryValue> computed_style =
protocol::DictionaryValue::create();
CSSComputedStyleDeclaration* style =
MakeGarbageCollected<CSSComputedStyleDeclaration>(node, true);
Vector<CSSPropertyID> properties;
// For text nodes, we can show color & font properties.
bool has_text_children = false;
for (Node* child = node->firstChild(); !has_text_children && child;
child = child->nextSibling()) {
has_text_children = child->IsTextNode();
}
if (has_text_children) {
properties.push_back(CSSPropertyID::kColor);
properties.push_back(CSSPropertyID::kFontFamily);
properties.push_back(CSSPropertyID::kFontSize);
properties.push_back(CSSPropertyID::kLineHeight);
}
properties.push_back(CSSPropertyID::kPadding);
properties.push_back(CSSPropertyID::kMargin);
properties.push_back(CSSPropertyID::kBackgroundColor);
for (size_t i = 0; i < properties.size(); ++i) {
const CSSValue* value = style->GetPropertyCSSValue(properties[i]);
if (!value)
continue;
AtomicString name = CSSPropertyName(properties[i]).ToAtomicString();
if (value->IsColorValue()) {
Color color = static_cast<const cssvalue::CSSColorValue*>(value)->Value();
computed_style->setString(name, ToHEXA(color));
} else {
computed_style->setString(name, value->CssText());
}
}
element_info->setValue("style", std::move(computed_style));
if (!node_contrast.font_size.IsEmpty()) {
std::unique_ptr<protocol::DictionaryValue> contrast =
protocol::DictionaryValue::create();
contrast->setString("fontSize", node_contrast.font_size);
contrast->setString("fontWeight", node_contrast.font_weight);
contrast->setString("backgroundColor",
ToHEXA(node_contrast.background_color));
element_info->setValue("contrast", std::move(contrast));
}
}
std::unique_ptr<protocol::DictionaryValue> BuildElementInfo(Element* element) {
std::unique_ptr<protocol::DictionaryValue> element_info =
protocol::DictionaryValue::create();
Element* real_element = element;
auto* pseudo_element = DynamicTo<PseudoElement>(element);
if (pseudo_element) {
real_element = element->ParentOrShadowHostElement();
}
bool is_xhtml = real_element->GetDocument().IsXHTMLDocument();
element_info->setString(
"tagName", is_xhtml ? real_element->nodeName()
: real_element->nodeName().DeprecatedLower());
element_info->setString("idValue", real_element->GetIdAttribute());
StringBuilder class_names;
if (real_element->HasClass() && real_element->IsStyledElement()) {
HashSet<AtomicString> used_class_names;
const SpaceSplitString& class_names_string = real_element->ClassNames();
wtf_size_t class_name_count = class_names_string.size();
for (wtf_size_t i = 0; i < class_name_count; ++i) {
const AtomicString& class_name = class_names_string[i];
if (!used_class_names.insert(class_name).is_new_entry)
continue;
class_names.Append('.');
class_names.Append(class_name);
}
}
if (pseudo_element) {
if (pseudo_element->GetPseudoId() == kPseudoIdBefore)
class_names.Append("::before");
else if (pseudo_element->GetPseudoId() == kPseudoIdAfter)
class_names.Append("::after");
else if (pseudo_element->GetPseudoId() == kPseudoIdMarker)
class_names.Append("::marker");
}
if (!class_names.IsEmpty())
element_info->setString("className", class_names.ToString());
LayoutObject* layout_object = element->GetLayoutObject();
LocalFrameView* containing_view = element->GetDocument().View();
if (!layout_object || !containing_view)
return element_info;
// if (auto* context = element->GetDisplayLockContext()) {
// if (context->IsLocked()) {
// // If it's a locked element, use the values from the locked frame rect.
// // TODO(vmpstr): Verify that these values are correct here.
// element_info->setString(
// "nodeWidth",
// String::Number(context->GetLockedContentLogicalWidth().ToDouble()));
// element_info->setString(
// "nodeHeight",
// String::Number(context->GetLockedContentLogicalHeight().ToDouble()));
// }
// return element_info;
//}
// layoutObject the getBoundingClientRect() data in the tooltip
// to be consistent with the rulers (see http://crbug.com/262338).
DOMRect* bounding_box = element->getBoundingClientRect();
element_info->setString("nodeWidth", String::Number(bounding_box->width()));
element_info->setString("nodeHeight", String::Number(bounding_box->height()));
element_info->setBoolean("isKeyboardFocusable",
element->IsKeyboardFocusable());
element_info->setString("accessibleName", element->computedName());
element_info->setString("accessibleRole", element->computedRole());
element_info->setString("layoutObjectName", layout_object->GetName());
return element_info;
}
std::unique_ptr<protocol::DictionaryValue> BuildTextNodeInfo(Text* text_node) {
std::unique_ptr<protocol::DictionaryValue> text_info =
protocol::DictionaryValue::create();
LayoutObject* layout_object = text_node->GetLayoutObject();
if (!layout_object || !layout_object->IsText())
return text_info;
PhysicalRect bounding_box =
ToLayoutText(layout_object)->PhysicalVisualOverflowRect();
text_info->setString("nodeWidth", bounding_box.Width().ToString());
text_info->setString("nodeHeight", bounding_box.Height().ToString());
text_info->setString("tagName", "#text");
text_info->setBoolean("showAccessibilityInfo", false);
return text_info;
}
std::unique_ptr<protocol::DictionaryValue> BuildGridHighlightConfigInfo(
const InspectorGridHighlightConfig& grid_config) {
std::unique_ptr<protocol::DictionaryValue> grid_config_info =
protocol::DictionaryValue::create();
grid_config_info->setBoolean("gridBorderDash", grid_config.grid_border_dash);
grid_config_info->setBoolean("rowLineDash", grid_config.row_line_dash);
grid_config_info->setBoolean("columnLineDash", grid_config.column_line_dash);
grid_config_info->setBoolean("showGridExtensionLines",
grid_config.show_grid_extension_lines);
grid_config_info->setBoolean("showPositiveLineNumbers",
grid_config.show_positive_line_numbers);
grid_config_info->setBoolean("showNegativeLineNumbers",
grid_config.show_negative_line_numbers);
grid_config_info->setBoolean("showAreaNames", grid_config.show_area_names);
grid_config_info->setBoolean("showLineNames", grid_config.show_line_names);
if (grid_config.grid_color != Color::kTransparent) {
grid_config_info->setString("gridBorderColor",
grid_config.grid_color.Serialized());
}
if (grid_config.row_line_color != Color::kTransparent) {
grid_config_info->setString("rowLineColor",
grid_config.row_line_color.Serialized());
}
if (grid_config.column_line_color != Color::kTransparent) {
grid_config_info->setString("columnLineColor",
grid_config.column_line_color.Serialized());
}
if (grid_config.row_gap_color != Color::kTransparent) {
grid_config_info->setString("rowGapColor",
grid_config.row_gap_color.Serialized());
}
if (grid_config.column_gap_color != Color::kTransparent) {
grid_config_info->setString("columnGapColor",
grid_config.column_gap_color.Serialized());
}
if (grid_config.row_hatch_color != Color::kTransparent) {
grid_config_info->setString("rowHatchColor",
grid_config.row_hatch_color.Serialized());
}
if (grid_config.column_hatch_color != Color::kTransparent) {
grid_config_info->setString("columnHatchColor",
grid_config.column_hatch_color.Serialized());
}
if (grid_config.area_border_color != Color::kTransparent) {
grid_config_info->setString("areaBorderColor",
grid_config.area_border_color.Serialized());
}
return grid_config_info;
}
// Swaps |left| and |top| of an offset.
PhysicalOffset Transpose(PhysicalOffset& offset) {
return PhysicalOffset(offset.top, offset.left);
}
size_t GetTrackCount(const LayoutGrid* layout_grid,
GridTrackSizingDirection direction) {
return direction == kForRows ? layout_grid->RowPositions().size()
: layout_grid->ColumnPositions().size();
}
LayoutUnit GetPositionForTrackAt(const LayoutGrid* layout_grid,
size_t index,
GridTrackSizingDirection direction) {
if (direction == kForRows)
return layout_grid->RowPositions().at(index);
LayoutUnit position = layout_grid->ColumnPositions().at(index);
return layout_grid->StyleRef().IsLeftToRightDirection()
? position
: layout_grid->TranslateRTLCoordinate(position);
}
LayoutUnit GetPositionForFirstTrack(const LayoutGrid* layout_grid,
GridTrackSizingDirection direction) {
return GetPositionForTrackAt(layout_grid, 0, direction);
}
LayoutUnit GetPositionForLastTrack(const LayoutGrid* layout_grid,
GridTrackSizingDirection direction) {
size_t index = GetTrackCount(layout_grid, direction) - 1;
return GetPositionForTrackAt(layout_grid, index, direction);
}
PhysicalOffset LocalToAbsolutePoint(Node* node,
PhysicalOffset local,
float scale) {
LayoutObject* layout_object = node->GetLayoutObject();
LayoutGrid* layout_grid = ToLayoutGrid(layout_object);
FloatPoint local_in_frame = FramePointToViewport(
node->GetDocument().View(), FloatPoint(local.left, local.top));
PhysicalOffset abs_number_pos = layout_grid->LocalToAbsolutePoint(
PhysicalOffset::FromFloatPointRound(local_in_frame));
abs_number_pos.Scale(scale);
return abs_number_pos;
}
std::unique_ptr<protocol::DictionaryValue> BuildPosition(
PhysicalOffset position) {
std::unique_ptr<protocol::DictionaryValue> result =
protocol::DictionaryValue::create();
result->setDouble("x", position.left);
result->setDouble("y", position.top);
return result;
}
std::unique_ptr<protocol::ListValue> BuildGridTrackSizes(
Node* node,
GridTrackSizingDirection direction,
float scale,
LayoutUnit gap,
const Vector<String>* authored_values) {
LayoutObject* layout_object = node->GetLayoutObject();
LayoutGrid* layout_grid = ToLayoutGrid(layout_object);
bool is_rtl = direction == kForColumns &&
!layout_grid->StyleRef().IsLeftToRightDirection();
std::unique_ptr<protocol::ListValue> sizes = protocol::ListValue::create();
size_t track_count = GetTrackCount(layout_grid, direction);
LayoutUnit alt_axis_pos = GetPositionForFirstTrack(
layout_grid, direction == kForRows ? kForColumns : kForRows);
for (size_t i = 1; i < track_count; i++) {
LayoutUnit current_position =
GetPositionForTrackAt(layout_grid, i, direction);
LayoutUnit prev_position =
GetPositionForTrackAt(layout_grid, i - 1, direction);
LayoutUnit gap_offset = i < track_count - 1 ? gap : LayoutUnit();
LayoutUnit width = current_position - prev_position - gap_offset;
if (is_rtl)
width = prev_position - current_position - gap_offset;
LayoutUnit main_axis_pos = prev_position + width / 2;
if (is_rtl)
main_axis_pos = prev_position - width / 2;
auto adjusted_size = AdjustForAbsoluteZoom::AdjustFloat(
width * scale, layout_grid->StyleRef());
PhysicalOffset track_size_pos(main_axis_pos, alt_axis_pos);
if (direction == kForRows)
track_size_pos = Transpose(track_size_pos);
std::unique_ptr<protocol::DictionaryValue> size_info =
BuildPosition(LocalToAbsolutePoint(node, track_size_pos, scale));
size_info->setDouble("computedSize", adjusted_size);
if (i - 1 < authored_values->size()) {
size_info->setString("authoredSize", authored_values->at(i - 1));
}
sizes->pushValue(std::move(size_info));
}
return sizes;
}
std::unique_ptr<protocol::ListValue> BuildGridPositiveLineNumberPositions(
Node* node,
const LayoutUnit& grid_gap,
GridTrackSizingDirection direction,
float scale) {
LayoutObject* layout_object = node->GetLayoutObject();
LayoutGrid* layout_grid = ToLayoutGrid(layout_object);
bool is_rtl = direction == kForColumns &&
!layout_grid->StyleRef().IsLeftToRightDirection();
std::unique_ptr<protocol::ListValue> number_positions =
protocol::ListValue::create();
size_t track_count = GetTrackCount(layout_grid, direction);
LayoutUnit alt_axis_pos = GetPositionForFirstTrack(
layout_grid, direction == kForRows ? kForColumns : kForRows);
// Find index of the first explicit Grid Line.
size_t first_explicit_index =
layout_grid->ExplicitGridStartForDirection(direction);
// Go line by line, calculating the offset to fall in the middle of gaps
// if needed.
for (size_t i = first_explicit_index; i < track_count; ++i) {
LayoutUnit gapOffset = grid_gap / 2;
if (is_rtl)
gapOffset *= -1;
// No need for a gap offset if there is no gap, or the first line is
// explicit, or this is the last line.
if (grid_gap == 0 || i == 0 || i == track_count - 1) {
gapOffset = LayoutUnit();
}
LayoutUnit offset = GetPositionForTrackAt(layout_grid, i, direction);
PhysicalOffset number_position(offset - gapOffset, alt_axis_pos);
if (direction == kForRows)
number_position = Transpose(number_position);
number_positions->pushValue(
BuildPosition(LocalToAbsolutePoint(node, number_position, scale)));
}
return number_positions;
}
std::unique_ptr<protocol::ListValue> BuildGridNegativeLineNumberPositions(
Node* node,
const LayoutUnit& grid_gap,
GridTrackSizingDirection direction,
float scale) {
LayoutObject* layout_object = node->GetLayoutObject();
LayoutGrid* layout_grid = ToLayoutGrid(layout_object);
bool is_rtl = direction == kForColumns &&
!layout_grid->StyleRef().IsLeftToRightDirection();
std::unique_ptr<protocol::ListValue> number_positions =
protocol::ListValue::create();
size_t track_count = GetTrackCount(layout_grid, direction);
LayoutUnit alt_axis_pos = GetPositionForLastTrack(
layout_grid, direction == kForRows ? kForColumns : kForRows);
// This is the number of tracks from the start of the grid, to the end of the
// explicit grid (including any leading implicit tracks).
size_t explicit_grid_end_track_count =
layout_grid->ExplicitGridEndForDirection(direction);
LayoutUnit first_offset = GetPositionForFirstTrack(layout_grid, direction);
// Always start negative numbers at the first line.
std::unique_ptr<protocol::DictionaryValue> pos =
protocol::DictionaryValue::create();
PhysicalOffset number_position(first_offset, alt_axis_pos);
if (direction == kForRows)
number_position = Transpose(number_position);
number_positions->pushValue(
BuildPosition(LocalToAbsolutePoint(node, number_position, scale)));
// Then go line by line, calculating the offset to fall in the middle of gaps
// if needed.
for (size_t i = 1; i <= explicit_grid_end_track_count; i++) {
LayoutUnit gapOffset = grid_gap / 2;
if (is_rtl)
gapOffset *= -1;
if (grid_gap == 0 ||
(i == explicit_grid_end_track_count && i == track_count - 1)) {
gapOffset = LayoutUnit();
}
LayoutUnit offset = GetPositionForTrackAt(layout_grid, i, direction);
PhysicalOffset number_position(offset - gapOffset, alt_axis_pos);
if (direction == kForRows)
number_position = Transpose(number_position);
number_positions->pushValue(
BuildPosition(LocalToAbsolutePoint(node, number_position, scale)));
}
return number_positions;
}
std::unique_ptr<protocol::DictionaryValue> BuildAreaNamePaths(Node* node,
float scale) {
LayoutObject* layout_object = node->GetLayoutObject();
LayoutGrid* layout_grid = ToLayoutGrid(layout_object);
LocalFrameView* containing_view = node->GetDocument().View();
bool is_rtl = !layout_grid->StyleRef().IsLeftToRightDirection();
std::unique_ptr<protocol::DictionaryValue> area_paths =
protocol::DictionaryValue::create();
const Vector<LayoutUnit>& rows = layout_grid->RowPositions();
const Vector<LayoutUnit>& columns = layout_grid->ColumnPositions();
LayoutUnit row_gap = layout_grid->GridGap(kForRows);
LayoutUnit column_gap = layout_grid->GridGap(kForColumns);
NamedGridAreaMap grid_area_map = layout_grid->StyleRef().NamedGridArea();
for (const auto& item : grid_area_map) {
const GridArea& area = item.value;
const String& name = item.key;
LayoutUnit start_column = GetPositionForTrackAt(
layout_grid, area.columns.StartLine(), kForColumns);
LayoutUnit end_column =
GetPositionForTrackAt(layout_grid, area.columns.EndLine(), kForColumns);
LayoutUnit start_row =
GetPositionForTrackAt(layout_grid, area.rows.StartLine(), kForRows);
LayoutUnit end_row =
GetPositionForTrackAt(layout_grid, area.rows.EndLine(), kForRows);
// Only subtract the gap size if the end line isn't the last line in the
// container.
LayoutUnit row_gap_offset =
area.rows.EndLine() == rows.size() - 1 ? LayoutUnit() : row_gap;
LayoutUnit column_gap_offset = area.columns.EndLine() == columns.size() - 1
? LayoutUnit()
: column_gap;
if (is_rtl)
column_gap_offset *= -1;
PhysicalOffset position(start_column, start_row);
PhysicalSize size(end_column - start_column - column_gap_offset,
end_row - start_row - row_gap_offset);
PhysicalRect area_rect(position, size);
FloatQuad area_quad = layout_grid->LocalRectToAbsoluteQuad(area_rect);
FrameQuadToViewport(containing_view, area_quad);
PathBuilder area_builder;
area_builder.AppendPath(QuadToPath(area_quad), scale);
area_paths->setValue(name, area_builder.Release());
}
return area_paths;
}
std::unique_ptr<protocol::ListValue> BuildGridLineNames(
Node* node,
GridTrackSizingDirection direction,
float scale) {
LayoutObject* layout_object = node->GetLayoutObject();
LayoutGrid* layout_grid = ToLayoutGrid(layout_object);
bool is_rtl = direction == kForColumns &&
!layout_grid->StyleRef().IsLeftToRightDirection();
std::unique_ptr<protocol::ListValue> lines = protocol::ListValue::create();
const Vector<LayoutUnit>& tracks = direction == kForColumns
? layout_grid->ColumnPositions()
: layout_grid->RowPositions();
const NamedGridLinesMap& named_lines_map =
direction == kForColumns ? layout_grid->StyleRef().NamedGridColumnLines()
: layout_grid->StyleRef().NamedGridRowLines();
LayoutUnit gap = layout_grid->GridGap(direction);
LayoutUnit alt_axis_pos = GetPositionForFirstTrack(
layout_grid, direction == kForRows ? kForColumns : kForRows);
for (const auto& item : named_lines_map) {
const String& name = item.key;
for (const size_t index : item.value) {
LayoutUnit track = GetPositionForTrackAt(layout_grid, index, direction);
LayoutUnit gap_offset =
index > 0 && index < tracks.size() - 1 ? gap / 2 : LayoutUnit();
if (is_rtl)
gap_offset *= -1;
LayoutUnit main_axis_pos = track - gap_offset;
PhysicalOffset line_name_pos(main_axis_pos, alt_axis_pos);
if (direction == kForRows)
line_name_pos = Transpose(line_name_pos);
std::unique_ptr<protocol::DictionaryValue> line =
BuildPosition(LocalToAbsolutePoint(node, line_name_pos, scale));
line->setString("name", name);
lines->pushValue(std::move(line));
}
}
return lines;
}
// Gets the rotation angle of the grid layout (clock-wise).
int GetRotationAngle(LayoutGrid* layout_grid) {
// Local vector has 135deg bearing to the Y axis.
int local_vector_bearing = 135;
FloatPoint local_a(0, 0);
FloatPoint local_b(1, 1);
FloatPoint abs_a = layout_grid->LocalToAbsoluteFloatPoint(local_a);
FloatPoint abs_b = layout_grid->LocalToAbsoluteFloatPoint(local_b);
// Compute bearing of the absolute vector against the Y axis.
double theta = atan2(abs_b.X() - abs_a.X(), abs_a.Y() - abs_b.Y());
if (theta < 0.0)
theta += kTwoPiDouble;
int bearing = std::round(rad2deg(theta));
return bearing - local_vector_bearing;
}
String GetWritingMode(const LayoutGrid* layout_grid) {
// The grid overlay uses this to flip the grid lines and labels accordingly.
// lr, lr-tb, rl, rl-tb, tb, and tb-rl are deprecated and not handled here.
// sideways-lr and sideways-rl are not supported yet and not handled here.
WritingMode writing_mode = layout_grid->StyleRef().GetWritingMode();
if (writing_mode == WritingMode::kVerticalLr) {
return "vertical-lr";
}
if (writing_mode == WritingMode::kVerticalRl) {
return "vertical-rl";
}
return "horizontal-tb";
}
// Gets the list of authored track size values resolving repeat() functions
// and skipping line names.
Vector<String> GetAuthoredGridTrackSizes(const CSSValue* value,
size_t auto_repeat_count) {
Vector<String> result;
if (!value)
return result;
// TODO(alexrudenko): this would not handle track sizes defined using CSS
// variables.
const CSSValueList* value_list = DynamicTo<CSSValueList>(value);
if (!value_list)
return result;
for (auto list_value : *value_list) {
if (auto* grid_auto_repeat_value =
DynamicTo<cssvalue::CSSGridAutoRepeatValue>(list_value.Get())) {
Vector<String> repeated_track_sizes;
for (auto auto_repeat_value : To<CSSValueList>(*list_value)) {
if (!auto_repeat_value->IsGridLineNamesValue())
repeated_track_sizes.push_back(auto_repeat_value->CssText());
}
// There could be only one auto repeat value in a |value_list|, therefore,
// resetting auto_repeat_count to zero after inserting repeated values.
for (; auto_repeat_count; --auto_repeat_count)
result.AppendVector(repeated_track_sizes);
continue;
}
if (auto* repeated_values =
DynamicTo<cssvalue::CSSGridIntegerRepeatValue>(list_value.Get())) {
size_t repetitions = repeated_values->Repetitions();
for (size_t i = 0; i < repetitions; ++i) {
for (auto repeated_value : *repeated_values) {
if (repeated_value->IsGridLineNamesValue())
continue;
result.push_back(repeated_value->CssText());
}
}
continue;
}
if (list_value->IsGridLineNamesValue())
continue;
result.push_back(list_value->CssText());
}
return result;
}
std::unique_ptr<protocol::DictionaryValue> BuildGridInfo(
Node* node,
const InspectorGridHighlightConfig& grid_highlight_config,
float scale,
bool isPrimary) {
LocalFrameView* containing_view = node->GetDocument().View();
LayoutObject* layout_object = node->GetLayoutObject();
DCHECK(layout_object);
LayoutGrid* layout_grid = ToLayoutGrid(layout_object);
std::unique_ptr<protocol::DictionaryValue> grid_info =
protocol::DictionaryValue::create();
const auto& rows = layout_grid->RowPositions();
const auto& columns = layout_grid->ColumnPositions();
grid_info->setInteger("rotationAngle", GetRotationAngle(layout_grid));
// The grid track information collected in this method and sent to the overlay
// frontend assumes that the grid layout is in a horizontal-tb writing-mode.
// It is the responsibility of the frontend to flip the rendering of the grid
// overlay based on the following writingMode value.
grid_info->setString("writingMode", GetWritingMode(layout_grid));
auto row_gap =
layout_grid->GridGap(kForRows) + layout_grid->GridItemOffset(kForRows);
auto column_gap = layout_grid->GridGap(kForColumns) +
layout_grid->GridItemOffset(kForColumns);
if (grid_highlight_config.show_track_sizes) {
Element* element = DynamicTo<Element>(node);
DCHECK(element);
StyleResolver& style_resolver = element->GetDocument().GetStyleResolver();
HeapHashMap<CSSPropertyName, Member<const CSSValue>> cascaded_values =
style_resolver.CascadedValuesForElement(element, kPseudoIdNone);
Vector<String> column_authored_values = GetAuthoredGridTrackSizes(
cascaded_values.at(
CSSPropertyName(CSSPropertyID::kGridTemplateColumns)),
layout_grid->AutoRepeatCountForDirection(kForColumns));
Vector<String> row_authored_values = GetAuthoredGridTrackSizes(
cascaded_values.at(CSSPropertyName(CSSPropertyID::kGridTemplateRows)),
layout_grid->AutoRepeatCountForDirection(kForRows));
grid_info->setValue(
"columnTrackSizes",
BuildGridTrackSizes(node, kForColumns, scale, column_gap,
&column_authored_values));
grid_info->setValue("rowTrackSizes",
BuildGridTrackSizes(node, kForRows, scale, row_gap,
&row_authored_values));
}
PathBuilder row_builder;
PathBuilder row_gap_builder;
LayoutUnit row_left = columns.front();
LayoutUnit row_width = columns.back() - columns.front();
for (size_t i = 1; i < rows.size(); ++i) {
// Rows
PhysicalOffset position(row_left, rows.at(i - 1));
PhysicalSize size(row_width, rows.at(i) - rows.at(i - 1));
if (i != rows.size() - 1)
size.height -= row_gap;
PhysicalRect row(position, size);
FloatQuad row_quad = layout_grid->LocalRectToAbsoluteQuad(row);
FrameQuadToViewport(containing_view, row_quad);
row_builder.AppendPath(
RowQuadToPath(row_quad, i == rows.size() - 1 || row_gap > 0), scale);
// Row Gaps
if (i != rows.size() - 1) {
PhysicalOffset gap_position(row_left, rows.at(i) - row_gap);
PhysicalSize gap_size(row_width, row_gap);
PhysicalRect gap(gap_position, gap_size);
FloatQuad gap_quad = layout_grid->LocalRectToAbsoluteQuad(gap);
FrameQuadToViewport(containing_view, gap_quad);
row_gap_builder.AppendPath(QuadToPath(gap_quad), scale);
}
}
grid_info->setValue("rows", row_builder.Release());
grid_info->setValue("rowGaps", row_gap_builder.Release());
PathBuilder column_builder;
PathBuilder column_gap_builder;
LayoutUnit column_top = rows.front();
LayoutUnit column_height = rows.back() - rows.front();
bool is_ltr = layout_grid->StyleRef().IsLeftToRightDirection();
for (size_t i = 1; i < columns.size(); ++i) {
PhysicalSize size(columns.at(i) - columns.at(i - 1), column_height);
if (i != columns.size() - 1)
size.width -= column_gap;
LayoutUnit line_left =
GetPositionForTrackAt(layout_grid, i - 1, kForColumns);
if (!is_ltr)
line_left -= size.width;
PhysicalOffset position(line_left, column_top);
PhysicalRect column(position, size);
FloatQuad column_quad = layout_grid->LocalRectToAbsoluteQuad(column);
FrameQuadToViewport(containing_view, column_quad);
bool draw_end_line = is_ltr ? i == columns.size() - 1 : i == 1;
column_builder.AppendPath(
ColumnQuadToPath(column_quad, draw_end_line || column_gap > 0), scale);
// Column Gaps
if (i != columns.size() - 1) {
LayoutUnit gap_left = GetPositionForTrackAt(layout_grid, i, kForColumns);
if (is_ltr)
gap_left -= column_gap;
PhysicalOffset gap_position(gap_left, column_top);
PhysicalSize gap_size(column_gap, column_height);
PhysicalRect gap(gap_position, gap_size);
FloatQuad gap_quad = layout_grid->LocalRectToAbsoluteQuad(gap);
FrameQuadToViewport(containing_view, gap_quad);
column_gap_builder.AppendPath(QuadToPath(gap_quad), scale);
}
}
grid_info->setValue("columns", column_builder.Release());
grid_info->setValue("columnGaps", column_gap_builder.Release());
// Positive Row and column Line positions
if (grid_highlight_config.show_positive_line_numbers) {
grid_info->setValue(
"positiveRowLineNumberPositions",
BuildGridPositiveLineNumberPositions(node, row_gap, kForRows, scale));
grid_info->setValue("positiveColumnLineNumberPositions",
BuildGridPositiveLineNumberPositions(
node, column_gap, kForColumns, scale));
}
// Negative Row and column Line positions
if (grid_highlight_config.show_negative_line_numbers) {
grid_info->setValue(
"negativeRowLineNumberPositions",
BuildGridNegativeLineNumberPositions(node, row_gap, kForRows, scale));
grid_info->setValue("negativeColumnLineNumberPositions",
BuildGridNegativeLineNumberPositions(
node, column_gap, kForColumns, scale));
}
// Area names
if (grid_highlight_config.show_area_names) {
grid_info->setValue("areaNames", BuildAreaNamePaths(node, scale));
}
// line names
if (grid_highlight_config.show_line_names) {
grid_info->setValue("rowLineNameOffsets",
BuildGridLineNames(node, kForRows, scale));
grid_info->setValue("columnLineNameOffsets",
BuildGridLineNames(node, kForColumns, scale));
}
// Grid border
PathBuilder grid_border_builder;
PhysicalOffset grid_position(row_left, column_top);
PhysicalSize grid_size(row_width, column_height);
PhysicalRect grid_rect(grid_position, grid_size);
FloatQuad grid_quad = layout_grid->LocalRectToAbsoluteQuad(grid_rect);
FrameQuadToViewport(containing_view, grid_quad);
grid_border_builder.AppendPath(QuadToPath(grid_quad), scale);
grid_info->setValue("gridBorder", grid_border_builder.Release());
grid_info->setValue("gridHighlightConfig",
BuildGridHighlightConfigInfo(grid_highlight_config));
grid_info->setBoolean("isPrimaryGrid", isPrimary);
return grid_info;
}
std::unique_ptr<protocol::DictionaryValue> BuildGridInfo(
Node* node,
const InspectorHighlightConfig& highlight_config,
float scale,
bool isPrimary) {
// Legacy support for highlight_config.css_grid
if (highlight_config.css_grid != Color::kTransparent) {
std::unique_ptr<InspectorGridHighlightConfig> grid_config =
std::make_unique<InspectorGridHighlightConfig>();
grid_config->row_line_color = highlight_config.css_grid;
grid_config->column_line_color = highlight_config.css_grid;
grid_config->row_line_dash = true;
grid_config->column_line_dash = true;
return BuildGridInfo(node, *grid_config, scale, isPrimary);
}
return BuildGridInfo(node, *(highlight_config.grid_highlight_config), scale,
isPrimary);
}
void CollectQuadsRecursive(Node* node, Vector<FloatQuad>& out_quads) {
LayoutObject* layout_object = node->GetLayoutObject();
if (!layout_object)
return;
// For inline elements, absoluteQuads will return a line box based on the
// line-height and font metrics, which is technically incorrect as replaced
// elements like images should use their intristic height and expand the
// linebox as needed. To get an appropriate quads we descend
// into the children and have them add their boxes.
if (layout_object->IsLayoutInline() &&
LayoutTreeBuilderTraversal::FirstChild(*node)) {
for (Node* child = LayoutTreeBuilderTraversal::FirstChild(*node); child;
child = LayoutTreeBuilderTraversal::NextSibling(*child))
CollectQuadsRecursive(child, out_quads);
} else {
layout_object->AbsoluteQuads(out_quads);
}
}
void CollectQuads(Node* node, Vector<FloatQuad>& out_quads) {
CollectQuadsRecursive(node, out_quads);
LocalFrameView* containing_view =
node->GetLayoutObject() ? node->GetLayoutObject()->GetFrameView()
: nullptr;
if (containing_view) {
for (FloatQuad& quad : out_quads)
FrameQuadToViewport(containing_view, quad);
}
}
std::unique_ptr<protocol::Array<double>> RectForPhysicalRect(
const PhysicalRect& rect) {
return std::make_unique<std::vector<double>, std::initializer_list<double>>(
{rect.X(), rect.Y(), rect.Width(), rect.Height()});
}
// Returns |layout_object|'s bounding box in document coordinates.
PhysicalRect RectInRootFrame(const LayoutObject* layout_object) {
LocalFrameView* local_frame_view = layout_object->GetFrameView();
PhysicalRect rect_in_absolute = PhysicalRect::EnclosingRect(
layout_object->AbsoluteBoundingBoxFloatRect());
return local_frame_view
? local_frame_view->ConvertToRootFrame(rect_in_absolute)
: rect_in_absolute;
}
PhysicalRect TextFragmentRectInRootFrame(
const LayoutObject* layout_object,
const LayoutText::TextBoxInfo& text_box) {
PhysicalRect absolute_coords_text_box_rect =
layout_object->LocalToAbsoluteRect(
layout_object->FlipForWritingMode(text_box.local_rect));
LocalFrameView* local_frame_view = layout_object->GetFrameView();
return local_frame_view ? local_frame_view->ConvertToRootFrame(
absolute_coords_text_box_rect)
: absolute_coords_text_box_rect;
}
} // namespace
InspectorHighlightConfig::InspectorHighlightConfig()
: show_info(false),
show_styles(false),
show_rulers(false),
show_extension_lines(false),
show_accessibility_info(true),
color_format(ColorFormat::HEX) {}
InspectorHighlight::InspectorHighlight(float scale)
: InspectorHighlightBase(scale),
show_rulers_(false),
show_extension_lines_(false),
show_accessibility_info_(true),
color_format_(ColorFormat::HEX) {}
InspectorSourceOrderConfig::InspectorSourceOrderConfig() = default;
InspectorGridHighlightConfig::InspectorGridHighlightConfig()
: show_grid_extension_lines(false),
grid_border_dash(false),
row_line_dash(false),
column_line_dash(false),
show_positive_line_numbers(false),
show_negative_line_numbers(false),
show_area_names(false),
show_line_names(false),
show_track_sizes(false) {}
InspectorHighlightBase::InspectorHighlightBase(float scale)
: highlight_paths_(protocol::ListValue::create()), scale_(scale) {}
InspectorHighlightBase::InspectorHighlightBase(Node* node)
: highlight_paths_(protocol::ListValue::create()), scale_(1.f) {
DCHECK(!DisplayLockUtilities::NearestLockedExclusiveAncestor(*node));
LocalFrameView* frame_view = node->GetDocument().View();
if (frame_view) {
scale_ = 1.f / frame_view->GetChromeClient()->WindowToViewportScalar(
&frame_view->GetFrame(), 1.f);
}
}
bool InspectorHighlightBase::BuildNodeQuads(Node* node,
FloatQuad* content,
FloatQuad* padding,
FloatQuad* border,
FloatQuad* margin) {
LayoutObject* layout_object = node->GetLayoutObject();
if (!layout_object)
return false;
LocalFrameView* containing_view = layout_object->GetFrameView();
if (!containing_view)
return false;
if (!layout_object->IsBox() && !layout_object->IsLayoutInline() &&
!layout_object->IsText()) {
return false;
}
PhysicalRect content_box;
PhysicalRect padding_box;
PhysicalRect border_box;
PhysicalRect margin_box;
if (layout_object->IsText()) {
LayoutText* layout_text = ToLayoutText(layout_object);
PhysicalRect text_rect = layout_text->PhysicalVisualOverflowRect();
content_box = text_rect;
padding_box = text_rect;
border_box = text_rect;
margin_box = text_rect;
} else if (layout_object->IsBox()) {
LayoutBox* layout_box = ToLayoutBox(layout_object);
// LayoutBox returns the "pure" content area box, exclusive of the
// scrollbars (if present), which also count towards the content area in
// CSS.
const int vertical_scrollbar_width = layout_box->VerticalScrollbarWidth();
const int horizontal_scrollbar_height =
layout_box->HorizontalScrollbarHeight();
content_box = layout_box->PhysicalContentBoxRect();
content_box.SetWidth(content_box.Width() + vertical_scrollbar_width);
content_box.SetHeight(content_box.Height() + horizontal_scrollbar_height);
padding_box = layout_box->PhysicalPaddingBoxRect();
padding_box.SetWidth(padding_box.Width() + vertical_scrollbar_width);
padding_box.SetHeight(padding_box.Height() + horizontal_scrollbar_height);
border_box = layout_box->PhysicalBorderBoxRect();
margin_box = PhysicalRect(border_box.X() - layout_box->MarginLeft(),
border_box.Y() - layout_box->MarginTop(),
border_box.Width() + layout_box->MarginWidth(),
border_box.Height() + layout_box->MarginHeight());
} else {
LayoutInline* layout_inline = ToLayoutInline(layout_object);
// LayoutInline's bounding box includes paddings and borders, excludes
// margins.
border_box = layout_inline->PhysicalLinesBoundingBox();
padding_box =
PhysicalRect(border_box.X() + layout_inline->BorderLeft(),
border_box.Y() + layout_inline->BorderTop(),
border_box.Width() - layout_inline->BorderLeft() -
layout_inline->BorderRight(),
border_box.Height() - layout_inline->BorderTop() -
layout_inline->BorderBottom());
content_box =
PhysicalRect(padding_box.X() + layout_inline->PaddingLeft(),
padding_box.Y() + layout_inline->PaddingTop(),
padding_box.Width() - layout_inline->PaddingLeft() -
layout_inline->PaddingRight(),
padding_box.Height() - layout_inline->PaddingTop() -
layout_inline->PaddingBottom());
// Ignore marginTop and marginBottom for inlines.
margin_box = PhysicalRect(
border_box.X() - layout_inline->MarginLeft(), border_box.Y(),
border_box.Width() + layout_inline->MarginWidth(), border_box.Height());
}
*content = layout_object->LocalRectToAbsoluteQuad(content_box);
*padding = layout_object->LocalRectToAbsoluteQuad(padding_box);
*border = layout_object->LocalRectToAbsoluteQuad(border_box);
*margin = layout_object->LocalRectToAbsoluteQuad(margin_box);
FrameQuadToViewport(containing_view, *content);
FrameQuadToViewport(containing_view, *padding);
FrameQuadToViewport(containing_view, *border);
FrameQuadToViewport(containing_view, *margin);
return true;
}
void InspectorHighlightBase::AppendQuad(const FloatQuad& quad,
const Color& fill_color,
const Color& outline_color,
const String& name) {
Path path = QuadToPath(quad);
PathBuilder builder;
builder.AppendPath(path, scale_);
AppendPath(builder.Release(), fill_color, outline_color, name);
}
void InspectorHighlightBase::AppendPath(
std::unique_ptr<protocol::ListValue> path,
const Color& fill_color,
const Color& outline_color,
const String& name) {
std::unique_ptr<protocol::DictionaryValue> object =
protocol::DictionaryValue::create();
object->setValue("path", std::move(path));
object->setString("fillColor", fill_color.Serialized());
if (outline_color != Color::kTransparent)
object->setString("outlineColor", outline_color.Serialized());
if (!name.IsEmpty())
object->setString("name", name);
highlight_paths_->pushValue(std::move(object));
}
InspectorSourceOrderHighlight::InspectorSourceOrderHighlight(
Node* node,
Color outline_color,
int source_order_position)
: InspectorHighlightBase(node),
source_order_position_(source_order_position) {
FloatQuad content, padding, border, margin;
if (!BuildNodeQuads(node, &content, &padding, &border, &margin))
return;
AppendQuad(border, Color::kTransparent, outline_color, "border");
}
std::unique_ptr<protocol::DictionaryValue>
InspectorSourceOrderHighlight::AsProtocolValue() const {
std::unique_ptr<protocol::DictionaryValue> object =
protocol::DictionaryValue::create();
object->setValue("paths", highlight_paths_->clone());
object->setInteger("sourceOrder", source_order_position_);
return object;
}
// static
InspectorSourceOrderConfig InspectorSourceOrderHighlight::DefaultConfig() {
InspectorSourceOrderConfig config;
config.parent_outline_color = Color(224, 90, 183, 1);
config.child_outline_color = Color(0, 120, 212, 1);
return config;
}
InspectorHighlight::InspectorHighlight(
Node* node,
const InspectorHighlightConfig& highlight_config,
const InspectorHighlightContrastInfo& node_contrast,
bool append_element_info,
bool append_distance_info,
bool is_locked_ancestor)
: InspectorHighlightBase(node),
show_rulers_(highlight_config.show_rulers),
show_extension_lines_(highlight_config.show_extension_lines),
show_accessibility_info_(highlight_config.show_accessibility_info),
color_format_(highlight_config.color_format) {
AppendPathsForShapeOutside(node, highlight_config);
AppendNodeHighlight(node, highlight_config);
auto* text_node = DynamicTo<Text>(node);
auto* element = DynamicTo<Element>(node);
if (append_element_info && element)
element_info_ = BuildElementInfo(element);
else if (append_element_info && text_node)
element_info_ = BuildTextNodeInfo(text_node);
if (element_info_ && highlight_config.show_styles)
AppendStyleInfo(node, element_info_.get(), node_contrast);
if (element_info_ && is_locked_ancestor)
element_info_->setString("isLockedAncestor", "true");
if (element_info_) {
element_info_->setBoolean("showAccessibilityInfo",
show_accessibility_info_);
}
if (append_distance_info)
AppendDistanceInfo(node);
}
InspectorHighlight::~InspectorHighlight() = default;
void InspectorHighlight::AppendDistanceInfo(Node* node) {
if (!InspectorHighlight::GetBoxModel(node, &model_, false))
return;
boxes_ = std::make_unique<protocol::Array<protocol::Array<double>>>();
computed_style_ = protocol::DictionaryValue::create();
node->GetDocument().EnsurePaintLocationDataValidForNode(
node, DocumentUpdateReason::kInspector);
LayoutObject* layout_object = node->GetLayoutObject();
if (!layout_object)
return;
CSSComputedStyleDeclaration* style =
MakeGarbageCollected<CSSComputedStyleDeclaration>(node, true);
for (size_t i = 0; i < style->length(); ++i) {
AtomicString name(style->item(i));
const CSSValue* value = style->GetPropertyCSSValue(
cssPropertyID(node->GetExecutionContext(), name));
if (!value)
continue;
if (value->IsColorValue()) {
Color color = static_cast<const cssvalue::CSSColorValue*>(value)->Value();
computed_style_->setString(name, ToHEXA(color));
} else {
computed_style_->setString(name, value->CssText());
}
}
VisitAndCollectDistanceInfo(&(node->GetDocument()));
PhysicalRect document_rect(
node->GetDocument().GetLayoutView()->DocumentRect());
LocalFrameView* local_frame_view = node->GetDocument().View();
boxes_->emplace_back(
RectForPhysicalRect(local_frame_view->ConvertToRootFrame(document_rect)));
}
void InspectorHighlight::VisitAndCollectDistanceInfo(Node* node) {
LayoutObject* layout_object = node->GetLayoutObject();
if (layout_object)
AddLayoutBoxToDistanceInfo(layout_object);
if (auto* element = DynamicTo<Element>(node)) {
if (element->GetPseudoId()) {
if (layout_object)
VisitAndCollectDistanceInfo(element->GetPseudoId(), layout_object);
} else {
for (PseudoId pseudo_id :
{kPseudoIdFirstLetter, kPseudoIdBefore, kPseudoIdAfter}) {
if (Node* pseudo_node = element->GetPseudoElement(pseudo_id))
VisitAndCollectDistanceInfo(pseudo_node);
}
}
}
if (!node->IsContainerNode())
return;
for (Node* child = blink::dom_traversal_utils::FirstChild(*node, false);
child; child = blink::dom_traversal_utils::NextSibling(*child, false)) {
VisitAndCollectDistanceInfo(child);
}
}
void InspectorHighlight::VisitAndCollectDistanceInfo(
PseudoId pseudo_id,
LayoutObject* layout_object) {
protocol::DOM::PseudoType pseudo_type;
if (pseudo_id == kPseudoIdNone)
return;
for (LayoutObject* child = layout_object->SlowFirstChild(); child;
child = child->NextSibling()) {
if (child->IsAnonymous())
AddLayoutBoxToDistanceInfo(child);
}
}
void InspectorHighlight::AddLayoutBoxToDistanceInfo(
LayoutObject* layout_object) {
if (layout_object->IsText()) {
LayoutText* layout_text = ToLayoutText(layout_object);
for (const auto& text_box : layout_text->GetTextBoxInfo()) {
PhysicalRect text_rect(
TextFragmentRectInRootFrame(layout_object, text_box));
boxes_->emplace_back(RectForPhysicalRect(text_rect));
}
} else {
PhysicalRect rect(RectInRootFrame(layout_object));
boxes_->emplace_back(RectForPhysicalRect(rect));
}
}
void InspectorHighlight::AppendEventTargetQuads(
Node* event_target_node,
const InspectorHighlightConfig& highlight_config) {
if (event_target_node->GetLayoutObject()) {
FloatQuad border, unused;
if (BuildNodeQuads(event_target_node, &unused, &unused, &border, &unused))
AppendQuad(border, highlight_config.event_target);
}
}
void InspectorHighlight::AppendPathsForShapeOutside(
Node* node,
const InspectorHighlightConfig& config) {
Shape::DisplayPaths paths;
FloatQuad bounds_quad;
const ShapeOutsideInfo* shape_outside_info =
ShapeOutsideInfoForNode(node, &paths, &bounds_quad);
if (!shape_outside_info)
return;
if (!paths.shape.length()) {
AppendQuad(bounds_quad, config.shape);
return;
}
AppendPath(ShapePathBuilder::BuildPath(
*node->GetDocument().View(), *node->GetLayoutObject(),
*shape_outside_info, paths.shape, scale_),
config.shape, Color::kTransparent);
if (paths.margin_shape.length())
AppendPath(ShapePathBuilder::BuildPath(
*node->GetDocument().View(), *node->GetLayoutObject(),
*shape_outside_info, paths.margin_shape, scale_),
config.shape_margin, Color::kTransparent);
}
void InspectorHighlight::AppendNodeHighlight(
Node* node,
const InspectorHighlightConfig& highlight_config) {
LayoutObject* layout_object = node->GetLayoutObject();
if (!layout_object)
return;
Vector<FloatQuad> svg_quads;
if (BuildSVGQuads(node, svg_quads)) {
for (wtf_size_t i = 0; i < svg_quads.size(); ++i) {
AppendQuad(svg_quads[i], highlight_config.content,
highlight_config.content_outline);
}
return;
}
FloatQuad content, padding, border, margin;
if (!BuildNodeQuads(node, &content, &padding, &border, &margin))
return;
AppendQuad(content, highlight_config.content,
highlight_config.content_outline, "content");
AppendQuad(padding, highlight_config.padding, Color::kTransparent, "padding");
AppendQuad(border, highlight_config.border, Color::kTransparent, "border");
AppendQuad(margin, highlight_config.margin, Color::kTransparent, "margin");
if (highlight_config.css_grid == Color::kTransparent &&
!highlight_config.grid_highlight_config) {
return;
}
grid_info_ = protocol::ListValue::create();
if (layout_object->IsLayoutGrid()) {
grid_info_->pushValue(BuildGridInfo(node, highlight_config, scale_, true));
}
}
std::unique_ptr<protocol::DictionaryValue> InspectorHighlight::AsProtocolValue()
const {
std::unique_ptr<protocol::DictionaryValue> object =
protocol::DictionaryValue::create();
object->setValue("paths", highlight_paths_->clone());
object->setBoolean("showRulers", show_rulers_);
object->setBoolean("showExtensionLines", show_extension_lines_);
object->setBoolean("showAccessibilityInfo", show_accessibility_info_);
switch (color_format_) {
case ColorFormat::RGB:
object->setString("colorFormat", "rgb");
break;
case ColorFormat::HSL:
object->setString("colorFormat", "hsl");
break;
case ColorFormat::HEX:
object->setString("colorFormat", "hex");
break;
}
if (model_) {
std::unique_ptr<protocol::DictionaryValue> distance_info =
protocol::DictionaryValue::create();
distance_info->setArray(
"boxes",
protocol::ValueConversions<std::vector<
std::unique_ptr<std::vector<double>>>>::toValue(boxes_.get()));
distance_info->setArray(
"content", protocol::ValueConversions<std::vector<double>>::toValue(
model_->getContent()));
distance_info->setArray(
"padding", protocol::ValueConversions<std::vector<double>>::toValue(
model_->getPadding()));
distance_info->setArray(
"border", protocol::ValueConversions<std::vector<double>>::toValue(
model_->getBorder()));
distance_info->setValue("style", computed_style_->clone());
object->setValue("distanceInfo", std::move(distance_info));
}
if (element_info_)
object->setValue("elementInfo", element_info_->clone());
if (grid_info_ && grid_info_->size() > 0)
object->setValue("gridInfo", grid_info_->clone());
return object;
}
// static
bool InspectorHighlight::GetBoxModel(
Node* node,
std::unique_ptr<protocol::DOM::BoxModel>* model,
bool use_absolute_zoom) {
node->GetDocument().EnsurePaintLocationDataValidForNode(
node, DocumentUpdateReason::kInspector);
LayoutObject* layout_object = node->GetLayoutObject();
LocalFrameView* view = node->GetDocument().View();
if (!layout_object || !view)
return false;
FloatQuad content, padding, border, margin;
Vector<FloatQuad> svg_quads;
if (BuildSVGQuads(node, svg_quads)) {
if (!svg_quads.size())
return false;
content = svg_quads[0];
padding = svg_quads[0];
border = svg_quads[0];
margin = svg_quads[0];
} else if (!BuildNodeQuads(node, &content, &padding, &border, &margin)) {
return false;
}
if (use_absolute_zoom) {
AdjustForAbsoluteZoom::AdjustFloatQuad(content, *layout_object);
AdjustForAbsoluteZoom::AdjustFloatQuad(padding, *layout_object);
AdjustForAbsoluteZoom::AdjustFloatQuad(border, *layout_object);
AdjustForAbsoluteZoom::AdjustFloatQuad(margin, *layout_object);
}
float scale = 1 / view->GetPage()->GetVisualViewport().Scale();
content.Scale(scale, scale);
padding.Scale(scale, scale);
border.Scale(scale, scale);
margin.Scale(scale, scale);
IntRect bounding_box =
view->ConvertToRootFrame(layout_object->AbsoluteBoundingBoxRect());
LayoutBoxModelObject* model_object =
layout_object->IsBoxModelObject() ? ToLayoutBoxModelObject(layout_object)
: nullptr;
*model =
protocol::DOM::BoxModel::create()
.setContent(BuildArrayForQuad(content))
.setPadding(BuildArrayForQuad(padding))
.setBorder(BuildArrayForQuad(border))
.setMargin(BuildArrayForQuad(margin))
.setWidth(model_object ? AdjustForAbsoluteZoom::AdjustInt(
model_object->PixelSnappedOffsetWidth(
model_object->OffsetParent()),
model_object)
: bounding_box.Width())
.setHeight(model_object ? AdjustForAbsoluteZoom::AdjustInt(
model_object->PixelSnappedOffsetHeight(
model_object->OffsetParent()),
model_object)
: bounding_box.Height())
.build();
Shape::DisplayPaths paths;
FloatQuad bounds_quad;
protocol::ErrorSupport errors;
if (const ShapeOutsideInfo* shape_outside_info =
ShapeOutsideInfoForNode(node, &paths, &bounds_quad)) {
auto shape = ShapePathBuilder::BuildPath(
*view, *layout_object, *shape_outside_info, paths.shape, 1.f);
auto margin_shape = ShapePathBuilder::BuildPath(
*view, *layout_object, *shape_outside_info, paths.margin_shape, 1.f);
(*model)->setShapeOutside(
protocol::DOM::ShapeOutsideInfo::create()
.setBounds(BuildArrayForQuad(bounds_quad))
.setShape(protocol::ValueConversions<
protocol::Array<protocol::Value>>::fromValue(shape.get(),
&errors))
.setMarginShape(
protocol::ValueConversions<protocol::Array<protocol::Value>>::
fromValue(margin_shape.get(), &errors))
.build());
}
return true;
}
// static
bool InspectorHighlight::BuildSVGQuads(Node* node, Vector<FloatQuad>& quads) {
LayoutObject* layout_object = node->GetLayoutObject();
if (!layout_object)
return false;
if (!layout_object->GetNode() || !layout_object->GetNode()->IsSVGElement() ||
layout_object->IsSVGRoot())
return false;
CollectQuads(node, quads);
return true;
}
// static
bool InspectorHighlight::GetContentQuads(
Node* node,
std::unique_ptr<protocol::Array<protocol::Array<double>>>* result) {
LayoutObject* layout_object = node->GetLayoutObject();
LocalFrameView* view = node->GetDocument().View();
if (!layout_object || !view)
return false;
Vector<FloatQuad> quads;
CollectQuads(node, quads);
float scale = 1 / view->GetPage()->GetVisualViewport().Scale();
for (FloatQuad& quad : quads) {
AdjustForAbsoluteZoom::AdjustFloatQuad(quad, *layout_object);
quad.Scale(scale, scale);
}
result->reset(new protocol::Array<protocol::Array<double>>());
for (FloatQuad& quad : quads)
(*result)->emplace_back(BuildArrayForQuad(quad));
return true;
}
std::unique_ptr<protocol::DictionaryValue> InspectorGridHighlight(
Node* node,
const InspectorGridHighlightConfig& config) {
if (DisplayLockUtilities::NearestLockedExclusiveAncestor(*node)) {
// Skip if node is part of display locked tree.
return nullptr;
}
LocalFrameView* frame_view = node->GetDocument().View();
if (!frame_view)
return nullptr;
float scale = 1.f / frame_view->GetChromeClient()->WindowToViewportScalar(
&frame_view->GetFrame(), 1.f);
LayoutObject* layout_object = node->GetLayoutObject();
if (!layout_object || !layout_object->IsLayoutGrid())
return nullptr;
std::unique_ptr<protocol::DictionaryValue> grid_info =
BuildGridInfo(node, config, scale, true);
return grid_info;
}
// static
InspectorHighlightConfig InspectorHighlight::DefaultConfig() {
InspectorHighlightConfig config;
config.content = Color(255, 0, 0, 0);
config.content_outline = Color(128, 0, 0, 0);
config.padding = Color(0, 255, 0, 0);
config.border = Color(0, 0, 255, 0);
config.margin = Color(255, 255, 255, 0);
config.event_target = Color(128, 128, 128, 0);
config.shape = Color(0, 0, 0, 0);
config.shape_margin = Color(128, 128, 128, 0);
config.show_info = true;
config.show_styles = false;
config.show_rulers = true;
config.show_extension_lines = true;
config.css_grid = Color::kTransparent;
config.color_format = ColorFormat::HEX;
config.grid_highlight_config = std::make_unique<InspectorGridHighlightConfig>(
InspectorHighlight::DefaultGridConfig());
return config;
}
// static
InspectorGridHighlightConfig InspectorHighlight::DefaultGridConfig() {
InspectorGridHighlightConfig config;
config.grid_color = Color(255, 0, 0, 0);
config.row_line_color = Color(128, 0, 0, 0);
config.column_line_color = Color(128, 0, 0, 0);
config.row_gap_color = Color(0, 255, 0, 0);
config.column_gap_color = Color(0, 0, 255, 0);
config.row_hatch_color = Color(255, 255, 255, 0);
config.column_hatch_color = Color(128, 128, 128, 0);
config.area_border_color = Color(255, 0, 0, 0);
config.show_grid_extension_lines = true;
config.show_positive_line_numbers = true;
config.show_negative_line_numbers = true;
config.show_area_names = true;
config.show_line_names = true;
config.grid_border_dash = false;
config.row_line_dash = true;
config.column_line_dash = true;
config.show_track_sizes = true;
return config;
}
} // namespace blink