SVGRenderTreeAsText.cpp [plain text]
#include "config.h"
#include "SVGRenderTreeAsText.h"
#include "GraphicsTypes.h"
#include "HTMLNames.h"
#include "NodeRenderStyle.h"
#include "RenderImage.h"
#include "RenderIterator.h"
#include "RenderSVGGradientStop.h"
#include "RenderSVGImage.h"
#include "RenderSVGPath.h"
#include "RenderSVGResourceClipper.h"
#include "RenderSVGResourceFilter.h"
#include "RenderSVGResourceLinearGradient.h"
#include "RenderSVGResourceMarker.h"
#include "RenderSVGResourceMasker.h"
#include "RenderSVGResourcePattern.h"
#include "RenderSVGResourceRadialGradient.h"
#include "RenderSVGResourceSolidColor.h"
#include "RenderSVGRoot.h"
#include "RenderSVGText.h"
#include "RenderTreeAsText.h"
#include "SVGCircleElement.h"
#include "SVGEllipseElement.h"
#include "SVGInlineTextBox.h"
#include "SVGLineElement.h"
#include "SVGNames.h"
#include "SVGPathElement.h"
#include "SVGPathUtilities.h"
#include "SVGPointList.h"
#include "SVGPolyElement.h"
#include "SVGRectElement.h"
#include "SVGRootInlineBox.h"
#include "SVGStopElement.h"
#include <math.h>
namespace WebCore {
class TextStreamSeparator {
public:
TextStreamSeparator(const String& s)
: m_separator(s)
, m_needToSeparate(false)
{
}
private:
friend TextStream& operator<<(TextStream&, TextStreamSeparator&);
String m_separator;
bool m_needToSeparate;
};
TextStream& operator<<(TextStream& ts, TextStreamSeparator& sep)
{
if (sep.m_needToSeparate)
ts << sep.m_separator;
else
sep.m_needToSeparate = true;
return ts;
}
template<typename ValueType>
static void writeNameValuePair(TextStream& ts, const char* name, ValueType value)
{
ts << " [" << name << "=" << value << "]";
}
template<typename ValueType>
static void writeNameAndQuotedValue(TextStream& ts, const char* name, ValueType value)
{
ts << " [" << name << "=\"" << value << "\"]";
}
static void writeIfNotEmpty(TextStream& ts, const char* name, const String& value)
{
if (!value.isEmpty())
writeNameValuePair(ts, name, value);
}
template<typename ValueType>
static void writeIfNotDefault(TextStream& ts, const char* name, ValueType value, ValueType defaultValue)
{
if (value != defaultValue)
writeNameValuePair(ts, name, value);
}
TextStream& operator<<(TextStream& ts, const FloatRect& r)
{
ts << "at (" << TextStream::FormatNumberRespectingIntegers(r.x());
ts << "," << TextStream::FormatNumberRespectingIntegers(r.y());
ts << ") size " << TextStream::FormatNumberRespectingIntegers(r.width());
ts << "x" << TextStream::FormatNumberRespectingIntegers(r.height());
return ts;
}
TextStream& operator<<(TextStream& ts, const AffineTransform& transform)
{
if (transform.isIdentity())
ts << "identity";
else
ts << "{m=(("
<< transform.a() << "," << transform.b()
<< ")("
<< transform.c() << "," << transform.d()
<< ")) t=("
<< transform.e() << "," << transform.f()
<< ")}";
return ts;
}
static TextStream& operator<<(TextStream& ts, const WindRule rule)
{
switch (rule) {
case RULE_NONZERO:
ts << "NON-ZERO";
break;
case RULE_EVENODD:
ts << "EVEN-ODD";
break;
}
return ts;
}
static TextStream& operator<<(TextStream& ts, const SVGUnitTypes::SVGUnitType& unitType)
{
ts << SVGPropertyTraits<SVGUnitTypes::SVGUnitType>::toString(unitType);
return ts;
}
static TextStream& operator<<(TextStream& ts, const SVGMarkerUnitsType& markerUnit)
{
ts << SVGPropertyTraits<SVGMarkerUnitsType>::toString(markerUnit);
return ts;
}
TextStream& operator<<(TextStream& ts, const Color& c)
{
return ts << c.nameForRenderTreeAsText();
}
static TextStream& operator<<(TextStream& ts, const DashArray& a)
{
ts << "{";
DashArray::const_iterator end = a.end();
for (DashArray::const_iterator it = a.begin(); it != end; ++it) {
if (it != a.begin())
ts << ", ";
ts << *it;
}
ts << "}";
return ts;
}
static TextStream& operator<<(TextStream& ts, LineCap style)
{
switch (style) {
case ButtCap:
ts << "BUTT";
break;
case RoundCap:
ts << "ROUND";
break;
case SquareCap:
ts << "SQUARE";
break;
}
return ts;
}
static TextStream& operator<<(TextStream& ts, LineJoin style)
{
switch (style) {
case MiterJoin:
ts << "MITER";
break;
case RoundJoin:
ts << "ROUND";
break;
case BevelJoin:
ts << "BEVEL";
break;
}
return ts;
}
static TextStream& operator<<(TextStream& ts, const SVGSpreadMethodType& type)
{
ts << SVGPropertyTraits<SVGSpreadMethodType>::toString(type).upper();
return ts;
}
static void writeSVGPaintingResource(TextStream& ts, RenderSVGResource* resource)
{
if (resource->resourceType() == SolidColorResourceType) {
ts << "[type=SOLID] [color=" << static_cast<RenderSVGResourceSolidColor*>(resource)->color() << "]";
return;
}
RenderSVGResourceContainer* container = static_cast<RenderSVGResourceContainer*>(resource);
SVGElement& element = container->element();
if (resource->resourceType() == PatternResourceType)
ts << "[type=PATTERN]";
else if (resource->resourceType() == LinearGradientResourceType)
ts << "[type=LINEAR-GRADIENT]";
else if (resource->resourceType() == RadialGradientResourceType)
ts << "[type=RADIAL-GRADIENT]";
ts << " [id=\"" << element.getIdAttribute() << "\"]";
}
static void writeStyle(TextStream& ts, const RenderElement& renderer)
{
const RenderStyle& style = renderer.style();
const SVGRenderStyle& svgStyle = style.svgStyle();
if (!renderer.localTransform().isIdentity())
writeNameValuePair(ts, "transform", renderer.localTransform());
writeIfNotDefault(ts, "image rendering", style.imageRendering(), RenderStyle::initialImageRendering());
writeIfNotDefault(ts, "opacity", style.opacity(), RenderStyle::initialOpacity());
if (renderer.isSVGShape()) {
const auto& shape = toRenderSVGShape(renderer);
Color fallbackColor;
if (RenderSVGResource* strokePaintingResource = RenderSVGResource::strokePaintingResource(const_cast<RenderSVGShape&>(shape), shape.style(), fallbackColor)) {
TextStreamSeparator s(" ");
ts << " [stroke={" << s;
writeSVGPaintingResource(ts, strokePaintingResource);
SVGLengthContext lengthContext(&shape.graphicsElement());
double dashOffset = svgStyle.strokeDashOffset().value(lengthContext);
double strokeWidth = svgStyle.strokeWidth().value(lengthContext);
const Vector<SVGLength>& dashes = svgStyle.strokeDashArray();
DashArray dashArray;
const Vector<SVGLength>::const_iterator end = dashes.end();
for (Vector<SVGLength>::const_iterator it = dashes.begin(); it != end; ++it)
dashArray.append((*it).value(lengthContext));
writeIfNotDefault(ts, "opacity", svgStyle.strokeOpacity(), 1.0f);
writeIfNotDefault(ts, "stroke width", strokeWidth, 1.0);
writeIfNotDefault(ts, "miter limit", svgStyle.strokeMiterLimit(), 4.0f);
writeIfNotDefault(ts, "line cap", svgStyle.capStyle(), ButtCap);
writeIfNotDefault(ts, "line join", svgStyle.joinStyle(), MiterJoin);
writeIfNotDefault(ts, "dash offset", dashOffset, 0.0);
if (!dashArray.isEmpty())
writeNameValuePair(ts, "dash array", dashArray);
ts << "}]";
}
if (RenderSVGResource* fillPaintingResource = RenderSVGResource::fillPaintingResource(const_cast<RenderSVGShape&>(shape), shape.style(), fallbackColor)) {
TextStreamSeparator s(" ");
ts << " [fill={" << s;
writeSVGPaintingResource(ts, fillPaintingResource);
writeIfNotDefault(ts, "opacity", svgStyle.fillOpacity(), 1.0f);
writeIfNotDefault(ts, "fill rule", svgStyle.fillRule(), RULE_NONZERO);
ts << "}]";
}
writeIfNotDefault(ts, "clip rule", svgStyle.clipRule(), RULE_NONZERO);
}
writeIfNotEmpty(ts, "start marker", svgStyle.markerStartResource());
writeIfNotEmpty(ts, "middle marker", svgStyle.markerMidResource());
writeIfNotEmpty(ts, "end marker", svgStyle.markerEndResource());
}
static TextStream& writePositionAndStyle(TextStream& ts, const RenderElement& renderer)
{
ts << " " << enclosingIntRect(renderer.absoluteClippedOverflowRect());
writeStyle(ts, renderer);
return ts;
}
static TextStream& operator<<(TextStream& ts, const RenderSVGShape& shape)
{
writePositionAndStyle(ts, shape);
SVGGraphicsElement& svgElement = shape.graphicsElement();
SVGLengthContext lengthContext(&svgElement);
if (isSVGRectElement(svgElement)) {
const SVGRectElement& element = toSVGRectElement(svgElement);
writeNameValuePair(ts, "x", element.x().value(lengthContext));
writeNameValuePair(ts, "y", element.y().value(lengthContext));
writeNameValuePair(ts, "width", element.width().value(lengthContext));
writeNameValuePair(ts, "height", element.height().value(lengthContext));
} else if (isSVGLineElement(svgElement)) {
const SVGLineElement& element = toSVGLineElement(svgElement);
writeNameValuePair(ts, "x1", element.x1().value(lengthContext));
writeNameValuePair(ts, "y1", element.y1().value(lengthContext));
writeNameValuePair(ts, "x2", element.x2().value(lengthContext));
writeNameValuePair(ts, "y2", element.y2().value(lengthContext));
} else if (isSVGEllipseElement(svgElement)) {
const SVGEllipseElement& element = toSVGEllipseElement(svgElement);
writeNameValuePair(ts, "cx", element.cx().value(lengthContext));
writeNameValuePair(ts, "cy", element.cy().value(lengthContext));
writeNameValuePair(ts, "rx", element.rx().value(lengthContext));
writeNameValuePair(ts, "ry", element.ry().value(lengthContext));
} else if (isSVGCircleElement(svgElement)) {
const SVGCircleElement& element = toSVGCircleElement(svgElement);
writeNameValuePair(ts, "cx", element.cx().value(lengthContext));
writeNameValuePair(ts, "cy", element.cy().value(lengthContext));
writeNameValuePair(ts, "r", element.r().value(lengthContext));
} else if (svgElement.hasTagName(SVGNames::polygonTag) || svgElement.hasTagName(SVGNames::polylineTag)) {
const SVGPolyElement& element = toSVGPolyElement(svgElement);
writeNameAndQuotedValue(ts, "points", element.pointList().valueAsString());
} else if (isSVGPathElement(svgElement)) {
const SVGPathElement& element = toSVGPathElement(svgElement);
String pathString;
buildStringFromByteStream(element.pathByteStream(), pathString, NormalizedParsing);
writeNameAndQuotedValue(ts, "data", pathString);
} else
ASSERT_NOT_REACHED();
return ts;
}
static TextStream& operator<<(TextStream& ts, const RenderSVGRoot& root)
{
return writePositionAndStyle(ts, root);
}
static void writeRenderSVGTextBox(TextStream& ts, const RenderSVGText& text)
{
SVGRootInlineBox* box = toSVGRootInlineBox(text.firstRootBox());
if (!box)
return;
ts << " " << enclosingIntRect(FloatRect(text.location(), FloatSize(box->logicalWidth(), box->logicalHeight())));
ts << " contains 1 chunk(s)";
if (text.parent() && (text.parent()->style().visitedDependentColor(CSSPropertyColor) != text.style().visitedDependentColor(CSSPropertyColor)))
writeNameValuePair(ts, "color", text.style().visitedDependentColor(CSSPropertyColor).nameForRenderTreeAsText());
}
static inline void writeSVGInlineTextBox(TextStream& ts, SVGInlineTextBox* textBox, int indent)
{
Vector<SVGTextFragment>& fragments = textBox->textFragments();
if (fragments.isEmpty())
return;
const SVGRenderStyle& svgStyle = textBox->renderer().style().svgStyle();
String text = textBox->renderer().text();
unsigned fragmentsSize = fragments.size();
for (unsigned i = 0; i < fragmentsSize; ++i) {
SVGTextFragment& fragment = fragments.at(i);
writeIndent(ts, indent + 1);
unsigned startOffset = fragment.characterOffset;
unsigned endOffset = fragment.characterOffset + fragment.length;
ts << "chunk 1 ";
ETextAnchor anchor = svgStyle.textAnchor();
bool isVerticalText = svgStyle.isVerticalWritingMode();
if (anchor == TA_MIDDLE) {
ts << "(middle anchor";
if (isVerticalText)
ts << ", vertical";
ts << ") ";
} else if (anchor == TA_END) {
ts << "(end anchor";
if (isVerticalText)
ts << ", vertical";
ts << ") ";
} else if (isVerticalText)
ts << "(vertical) ";
startOffset -= textBox->start();
endOffset -= textBox->start();
ts << "text run " << i + 1 << " at (" << fragment.x << "," << fragment.y << ")";
ts << " startOffset " << startOffset << " endOffset " << endOffset;
if (isVerticalText)
ts << " height " << fragment.height;
else
ts << " width " << fragment.width;
if (!textBox->isLeftToRightDirection() || textBox->dirOverride()) {
ts << (textBox->isLeftToRightDirection() ? " LTR" : " RTL");
if (textBox->dirOverride())
ts << " override";
}
ts << ": " << quoteAndEscapeNonPrintables(text.substring(fragment.characterOffset, fragment.length)) << "\n";
}
}
static inline void writeSVGInlineTextBoxes(TextStream& ts, const RenderText& text, int indent)
{
for (InlineTextBox* box = text.firstTextBox(); box; box = box->nextTextBox()) {
if (!box->isSVGInlineTextBox())
continue;
writeSVGInlineTextBox(ts, toSVGInlineTextBox(box), indent);
}
}
static void writeStandardPrefix(TextStream& ts, const RenderObject& object, int indent)
{
writeIndent(ts, indent);
ts << object.renderName();
if (object.node())
ts << " {" << object.node()->nodeName() << "}";
}
static void writeChildren(TextStream& ts, const RenderElement& parent, int indent)
{
for (const auto& child : childrenOfType<RenderObject>(parent))
write(ts, child, indent + 1);
}
static inline void writeCommonGradientProperties(TextStream& ts, SVGSpreadMethodType spreadMethod, const AffineTransform& gradientTransform, SVGUnitTypes::SVGUnitType gradientUnits)
{
writeNameValuePair(ts, "gradientUnits", gradientUnits);
if (spreadMethod != SVGSpreadMethodPad)
ts << " [spreadMethod=" << spreadMethod << "]";
if (!gradientTransform.isIdentity())
ts << " [gradientTransform=" << gradientTransform << "]";
}
void writeSVGResourceContainer(TextStream& ts, const RenderSVGResourceContainer& resource, int indent)
{
writeStandardPrefix(ts, resource, indent);
const AtomicString& id = resource.element().getIdAttribute();
writeNameAndQuotedValue(ts, "id", id);
if (resource.resourceType() == MaskerResourceType) {
const auto& masker = static_cast<const RenderSVGResourceMasker&>(resource);
writeNameValuePair(ts, "maskUnits", masker.maskUnits());
writeNameValuePair(ts, "maskContentUnits", masker.maskContentUnits());
ts << "\n";
#if ENABLE(FILTERS)
} else if (resource.resourceType() == FilterResourceType) {
const auto& filter = static_cast<const RenderSVGResourceFilter&>(resource);
writeNameValuePair(ts, "filterUnits", filter.filterUnits());
writeNameValuePair(ts, "primitiveUnits", filter.primitiveUnits());
ts << "\n";
FloatRect dummyRect;
RefPtr<SVGFilter> dummyFilter = SVGFilter::create(AffineTransform(), dummyRect, dummyRect, dummyRect, true);
if (auto builder = filter.buildPrimitives(dummyFilter.get())) {
if (FilterEffect* lastEffect = builder->lastEffect())
lastEffect->externalRepresentation(ts, indent + 1);
}
#endif
} else if (resource.resourceType() == ClipperResourceType) {
const auto& clipper = static_cast<const RenderSVGResourceClipper&>(resource);
writeNameValuePair(ts, "clipPathUnits", clipper.clipPathUnits());
ts << "\n";
} else if (resource.resourceType() == MarkerResourceType) {
const auto& marker = static_cast<const RenderSVGResourceMarker&>(resource);
writeNameValuePair(ts, "markerUnits", marker.markerUnits());
ts << " [ref at " << marker.referencePoint() << "]";
ts << " [angle=";
if (marker.angle() == -1)
ts << "auto" << "]\n";
else
ts << marker.angle() << "]\n";
} else if (resource.resourceType() == PatternResourceType) {
const auto& pattern = static_cast<const RenderSVGResourcePattern&>(resource);
PatternAttributes attributes;
pattern.patternElement().collectPatternAttributes(attributes);
writeNameValuePair(ts, "patternUnits", attributes.patternUnits());
writeNameValuePair(ts, "patternContentUnits", attributes.patternContentUnits());
AffineTransform transform = attributes.patternTransform();
if (!transform.isIdentity())
ts << " [patternTransform=" << transform << "]";
ts << "\n";
} else if (resource.resourceType() == LinearGradientResourceType) {
const auto& gradient = static_cast<const RenderSVGResourceLinearGradient&>(resource);
LinearGradientAttributes attributes;
gradient.linearGradientElement().collectGradientAttributes(attributes);
writeCommonGradientProperties(ts, attributes.spreadMethod(), attributes.gradientTransform(), attributes.gradientUnits());
ts << " [start=" << gradient.startPoint(attributes) << "] [end=" << gradient.endPoint(attributes) << "]\n";
} else if (resource.resourceType() == RadialGradientResourceType) {
const auto& gradient = static_cast<const RenderSVGResourceRadialGradient&>(resource);
RadialGradientAttributes attributes;
gradient.radialGradientElement().collectGradientAttributes(attributes);
writeCommonGradientProperties(ts, attributes.spreadMethod(), attributes.gradientTransform(), attributes.gradientUnits());
FloatPoint focalPoint = gradient.focalPoint(attributes);
FloatPoint centerPoint = gradient.centerPoint(attributes);
float radius = gradient.radius(attributes);
float focalRadius = gradient.focalRadius(attributes);
ts << " [center=" << centerPoint << "] [focal=" << focalPoint << "] [radius=" << radius << "] [focalRadius=" << focalRadius << "]\n";
} else
ts << "\n";
writeChildren(ts, resource, indent);
}
void writeSVGContainer(TextStream& ts, const RenderSVGContainer& container, int indent)
{
if (container.isSVGResourceFilterPrimitive())
return;
writeStandardPrefix(ts, container, indent);
writePositionAndStyle(ts, container);
ts << "\n";
writeResources(ts, container, indent);
writeChildren(ts, container, indent);
}
void write(TextStream& ts, const RenderSVGRoot& root, int indent)
{
writeStandardPrefix(ts, root, indent);
ts << root << "\n";
writeChildren(ts, root, indent);
}
void writeSVGText(TextStream& ts, const RenderSVGText& text, int indent)
{
writeStandardPrefix(ts, text, indent);
writeRenderSVGTextBox(ts, text);
ts << "\n";
writeResources(ts, text, indent);
writeChildren(ts, text, indent);
}
void writeSVGInlineText(TextStream& ts, const RenderSVGInlineText& text, int indent)
{
writeStandardPrefix(ts, text, indent);
ts << " " << enclosingIntRect(FloatRect(text.firstRunLocation(), text.floatLinesBoundingBox().size())) << "\n";
writeResources(ts, text, indent);
writeSVGInlineTextBoxes(ts, text, indent);
}
void writeSVGImage(TextStream& ts, const RenderSVGImage& image, int indent)
{
writeStandardPrefix(ts, image, indent);
writePositionAndStyle(ts, image);
ts << "\n";
writeResources(ts, image, indent);
}
void write(TextStream& ts, const RenderSVGShape& shape, int indent)
{
writeStandardPrefix(ts, shape, indent);
ts << shape << "\n";
writeResources(ts, shape, indent);
}
void writeSVGGradientStop(TextStream& ts, const RenderSVGGradientStop& stop, int indent)
{
writeStandardPrefix(ts, stop, indent);
ts << " [offset=" << stop.element().offset() << "] [color=" << stop.element().stopColorIncludingOpacity() << "]\n";
}
void writeResources(TextStream& ts, const RenderObject& renderer, int indent)
{
const RenderStyle& style = renderer.style();
const SVGRenderStyle& svgStyle = style.svgStyle();
if (!svgStyle.maskerResource().isEmpty()) {
if (RenderSVGResourceMasker* masker = getRenderSVGResourceById<RenderSVGResourceMasker>(renderer.document(), svgStyle.maskerResource())) {
writeIndent(ts, indent);
ts << " ";
writeNameAndQuotedValue(ts, "masker", svgStyle.maskerResource());
ts << " ";
writeStandardPrefix(ts, *masker, 0);
ts << " " << masker->resourceBoundingBox(renderer) << "\n";
}
}
if (!svgStyle.clipperResource().isEmpty()) {
if (RenderSVGResourceClipper* clipper = getRenderSVGResourceById<RenderSVGResourceClipper>(renderer.document(), svgStyle.clipperResource())) {
writeIndent(ts, indent);
ts << " ";
writeNameAndQuotedValue(ts, "clipPath", svgStyle.clipperResource());
ts << " ";
writeStandardPrefix(ts, *clipper, 0);
ts << " " << clipper->resourceBoundingBox(renderer) << "\n";
}
}
#if ENABLE(FILTERS)
if (!svgStyle.filterResource().isEmpty()) {
if (RenderSVGResourceFilter* filter = getRenderSVGResourceById<RenderSVGResourceFilter>(renderer.document(), svgStyle.filterResource())) {
writeIndent(ts, indent);
ts << " ";
writeNameAndQuotedValue(ts, "filter", svgStyle.filterResource());
ts << " ";
writeStandardPrefix(ts, *filter, 0);
ts << " " << filter->resourceBoundingBox(renderer) << "\n";
}
}
#endif
}
}