Source code
Revision control
Copy as Markdown
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
// Qt-Security score:significant reason:default
#include "qsvggenerator.h"
#ifndef QT_NO_SVGGENERATOR
#include "qpainterpath.h"
#include "private/qdrawhelper_p.h"
#include "private/qpaintengine_p.h"
#include "private/qpainter_p.h"
#include "private/qtextengine_p.h"
#include "qcompilerdetection.h"
#include "qfile.h"
#include "qtextstream.h"
#include "qbuffer.h"
#include "qmath.h"
#include "qbitmap.h"
#include "qtransform.h"
#include "qdebug.h"
#include <optional>
QT_BEGIN_NAMESPACE
static void translate_color(const QColor &color, QString *color_string,
QString *opacity_string)
{
Q_ASSERT(color_string);
Q_ASSERT(opacity_string);
*color_string =
QString::fromLatin1("#%1%2%3")
.arg(color.red(), 2, 16, QLatin1Char('0'))
.arg(color.green(), 2, 16, QLatin1Char('0'))
.arg(color.blue(), 2, 16, QLatin1Char('0'));
*opacity_string = QString::number(color.alphaF());
}
static void translate_dashPattern(const QList<qreal> &pattern, qreal width, QString *pattern_string)
{
Q_ASSERT(pattern_string);
// Note that SVG operates in absolute lengths, whereas Qt uses a length/width ratio.
for (qreal entry : pattern)
*pattern_string += QString::fromLatin1("%1,").arg(entry * width);
pattern_string->chop(1);
}
class QSvgPaintEnginePrivate : public QPaintEnginePrivate
{
public:
explicit QSvgPaintEnginePrivate(QSvgGenerator::SvgVersion version)
: svgVersion(version)
{
attributes.document_title = QLatin1String("Qt SVG Document");
attributes.document_description = QLatin1String("Generated with Qt");
attributes.font_families << QLatin1String("serif");
attributes.font_size = QLatin1String("10pt");
attributes.font_style = QLatin1String("normal");
attributes.font_weight = QLatin1String("normal");
}
QSvgGenerator::SvgVersion svgVersion;
QSize size;
QRectF viewBox;
QIODevice *outputDevice{nullptr};
QTextStream *stream{nullptr};
int resolution{72};
QString header;
QString defs;
QString body;
bool afterFirstUpdate{false};
QBrush brush;
QPen pen;
QTransform matrix;
QFont font;
QString generateGradientName() {
++numGradients;
currentGradientName = QString::fromLatin1("gradient%1").arg(numGradients);
return currentGradientName;
}
QString currentGradientName;
int numGradients{0};
QStringList savedPatternBrushes;
QStringList savedPatternMasks;
struct _attributes {
QString document_title;
QString document_description;
QString font_weight;
QString font_size;
QStringList font_families;
QString font_style;
QString stroke, strokeOpacity;
QString dashPattern, dashOffset;
QString fill, fillOpacity;
} attributes;
QString generateClipPathName() {
++numClipPaths;
currentClipPathName = QStringLiteral("clipPath%1").arg(numClipPaths);
return currentClipPathName;
}
std::optional<QPainterPath> clipPath;
bool clipEnabled{false};
bool isClippingEffective() const {
return clipEnabled && clipPath.has_value();
}
QString currentClipPathName;
int numClipPaths{0};
bool hasEmittedClipGroup{false};
};
static inline QPaintEngine::PaintEngineFeatures svgEngineFeatures()
{
return QPaintEngine::PaintEngineFeatures(
QPaintEngine::AllFeatures
& ~QPaintEngine::PerspectiveTransform
& ~QPaintEngine::ConicalGradientFill
& ~QPaintEngine::PorterDuff);
}
Q_GUI_EXPORT QImage qt_imageForBrush(int brushStyle, bool invert);
Q_GUI_EXPORT bool qHasPixmapTexture(const QBrush& brush);
class QSvgPaintEngine : public QPaintEngine
{
Q_DECLARE_PRIVATE(QSvgPaintEngine)
public:
explicit QSvgPaintEngine(QSvgGenerator::SvgVersion version)
: QPaintEngine(*new QSvgPaintEnginePrivate(version),
svgEngineFeatures())
{
}
bool begin(QPaintDevice *device) override;
bool end() override;
void updateState(const QPaintEngineState &state) override;
void updateClipState(const QPaintEngineState &state);
void popGroup();
void drawEllipse(const QRectF &r) override;
void drawPath(const QPainterPath &path) override;
void drawPixmap(const QRectF &r, const QPixmap &pm, const QRectF &sr) override;
void drawPolygon(const QPointF *points, int pointCount, PolygonDrawMode mode) override;
void drawRects(const QRectF *rects, int rectCount) override;
void drawTextItem(const QPointF &pt, const QTextItem &item) override;
void generateImage(QTextStream &stream, const QRectF &r, const QImage &pm);
void drawImage(const QRectF &r, const QImage &pm, const QRectF &sr,
Qt::ImageConversionFlags flags = Qt::AutoColor) override;
QPaintEngine::Type type() const override { return QPaintEngine::SVG; }
QSize size() const { return d_func()->size; }
void setSize(const QSize &size) {
Q_ASSERT(!isActive());
d_func()->size = size;
}
QRectF viewBox() const { return d_func()->viewBox; }
void setViewBox(const QRectF &viewBox) {
Q_ASSERT(!isActive());
d_func()->viewBox = viewBox;
}
QString documentTitle() const { return d_func()->attributes.document_title; }
void setDocumentTitle(const QString &title) {
d_func()->attributes.document_title = title;
}
QString documentDescription() const { return d_func()->attributes.document_description; }
void setDocumentDescription(const QString &description) {
d_func()->attributes.document_description = description;
}
QIODevice *outputDevice() const { return d_func()->outputDevice; }
void setOutputDevice(QIODevice *device) {
Q_ASSERT(!isActive());
d_func()->outputDevice = device;
}
int resolution() const { return d_func()->resolution; }
void setResolution(int resolution) {
Q_ASSERT(!isActive());
d_func()->resolution = resolution;
}
QSvgGenerator::SvgVersion svgVersion() const { return d_func()->svgVersion; }
QString savePatternMask(Qt::BrushStyle style)
{
QString maskId = QStringLiteral("patternmask%1").arg(style);
if (!d_func()->savedPatternMasks.contains(maskId)) {
QImage img = qt_imageForBrush(style, true);
QRegion reg(QBitmap::fromData(img.size(), img.constBits()));
QString rct(QStringLiteral("<rect x=\"%1\" y=\"%2\" width=\"%3\" height=\"%4\" />"));
QTextStream str(&d_func()->defs, QIODevice::Append);
str << "<mask id=\"" << maskId << "\" x=\"0\" y=\"0\" width=\"8\" height=\"8\" "
<< "stroke=\"none\" fill=\"#ffffff\" patternUnits=\"userSpaceOnUse\" >" << '\n';
for (QRect r : reg)
str << rct.arg(r.x()).arg(r.y()).arg(r.width()).arg(r.height()) << '\n';
str << QStringLiteral("</mask>") << '\n' << '\n';
d_func()->savedPatternMasks.append(maskId);
}
return maskId;
}
QString savePatternBrush(const QString &color, const QBrush &brush)
{
QString patternId = QStringLiteral("fillpattern%1_").arg(brush.style()) + QStringView{color}.mid(1);
if (!d_func()->savedPatternBrushes.contains(patternId)) {
QString maskId = savePatternMask(brush.style());
QString geo(QStringLiteral("x=\"0\" y=\"0\" width=\"8\" height=\"8\""));
QTextStream str(&d_func()->defs, QIODevice::Append);
str << QStringLiteral("<pattern id=\"%1\" %2 patternUnits=\"userSpaceOnUse\" >").arg(patternId, geo) << '\n';
str << QStringLiteral("<rect %1 stroke=\"none\" fill=\"%2\" mask=\"url(#%3)\" />").arg(geo, color, maskId) << '\n';
str << QStringLiteral("</pattern>") << '\n' << '\n';
d_func()->savedPatternBrushes.append(patternId);
}
return patternId;
}
QString saveTextureBrush(const QString &color, const QBrush &brush)
{
QImage tex = brush.textureImage();
QString patternId = QStringLiteral("texpattern_%1").arg(QString::number(tex.cacheKey(), 16));
if (qHasPixmapTexture(brush) && brush.texture().isQBitmap()) {
Q_ASSERT(tex.format() == QImage::Format_MonoLSB);
tex.setColorCount(2);
tex.setColor(0, qRgba(0, 0, 0, 0));
tex.setColor(1, brush.color().rgba());
patternId += QLatin1Char('_') + QStringView{color}.mid(1);
}
if (!d_func()->savedPatternBrushes.contains(patternId)) {
QString geo = QStringLiteral("x=\"0\" y=\"0\" width=\"%1\" height=\"%2\"").arg(tex.width()).arg(tex.height());
QTextStream str(&d_func()->defs, QIODevice::Append);
str << QStringLiteral("<pattern id=\"%1\" %2 patternUnits=\"userSpaceOnUse\" >").arg(patternId, geo) << '\n';
generateImage(str, tex.rect(), tex);
str << QStringLiteral("</pattern>") << '\n' << '\n';
d_func()->savedPatternBrushes.append(patternId);
}
return patternId;
}
void saveLinearGradientBrush(const QGradient *g)
{
QTextStream str(&d_func()->defs, QIODevice::Append);
const QLinearGradient *grad = static_cast<const QLinearGradient*>(g);
str << QLatin1String("<linearGradient ");
saveGradientUnits(str, g);
if (grad) {
str << QLatin1String("x1=\"") <<grad->start().x()<< QLatin1String("\" ")
<< QLatin1String("y1=\"") <<grad->start().y()<< QLatin1String("\" ")
<< QLatin1String("x2=\"") <<grad->finalStop().x() << QLatin1String("\" ")
<< QLatin1String("y2=\"") <<grad->finalStop().y() << QLatin1String("\" ");
}
str << QLatin1String("id=\"") << d_func()->generateGradientName() << QLatin1String("\">\n");
saveGradientStops(str, g);
str << QLatin1String("</linearGradient>") <<'\n';
}
void saveRadialGradientBrush(const QGradient *g)
{
QTextStream str(&d_func()->defs, QIODevice::Append);
const QRadialGradient *grad = static_cast<const QRadialGradient*>(g);
str << QLatin1String("<radialGradient ");
saveGradientUnits(str, g);
if (grad) {
str << QLatin1String("cx=\"") <<grad->center().x()<< QLatin1String("\" ")
<< QLatin1String("cy=\"") <<grad->center().y()<< QLatin1String("\" ")
<< QLatin1String("r=\"") <<grad->radius() << QLatin1String("\" ")
<< QLatin1String("fx=\"") <<grad->focalPoint().x() << QLatin1String("\" ")
<< QLatin1String("fy=\"") <<grad->focalPoint().y() << QLatin1String("\" ");
}
str << QLatin1String("id=\"") <<d_func()->generateGradientName()<< QLatin1String("\">\n");
saveGradientStops(str, g);
str << QLatin1String("</radialGradient>") << '\n';
}
void saveConicalGradientBrush(const QGradient *)
{
qWarning("svg's don't support conical gradients!");
}
void saveGradientStops(QTextStream &str, const QGradient *g) {
QGradientStops stops = g->stops();
if (g->interpolationMode() == QGradient::ColorInterpolation) {
bool constantAlpha = true;
int alpha = stops.at(0).second.alpha();
for (int i = 1; i < stops.size(); ++i)
constantAlpha &= (stops.at(i).second.alpha() == alpha);
if (!constantAlpha) {
const qreal spacing = qreal(0.02);
QGradientStops newStops;
QRgb fromColor = qPremultiply(stops.at(0).second.rgba());
QRgb toColor;
for (int i = 0; i + 1 < stops.size(); ++i) {
int parts = qCeil((stops.at(i + 1).first - stops.at(i).first) / spacing);
newStops.append(stops.at(i));
toColor = qPremultiply(stops.at(i + 1).second.rgba());
if (parts > 1) {
qreal step = (stops.at(i + 1).first - stops.at(i).first) / parts;
for (int j = 1; j < parts; ++j) {
QRgb color = qUnpremultiply(INTERPOLATE_PIXEL_256(fromColor, 256 - 256 * j / parts, toColor, 256 * j / parts));
newStops.append(QGradientStop(stops.at(i).first + j * step, QColor::fromRgba(color)));
}
}
fromColor = toColor;
}
newStops.append(stops.back());
stops = newStops;
}
}
for (const QGradientStop &stop : std::as_const(stops)) {
const QString color = stop.second.name(QColor::HexRgb);
str << QLatin1String(" <stop offset=\"")<< stop.first << QLatin1String("\" ")
<< QLatin1String("stop-color=\"") << color << QLatin1String("\" ")
<< QLatin1String("stop-opacity=\"") << stop.second.alphaF() <<QLatin1String("\" />\n");
}
}
void saveGradientUnits(QTextStream &str, const QGradient *gradient)
{
str << QLatin1String("gradientUnits=\"");
if (gradient && (gradient->coordinateMode() == QGradient::ObjectBoundingMode || gradient->coordinateMode() == QGradient::ObjectMode))
str << QLatin1String("objectBoundingBox");
else
str << QLatin1String("userSpaceOnUse");
str << QLatin1String("\" ");
}
void generateQtDefaults()
{
*d_func()->stream << QLatin1String("fill=\"none\" ");
*d_func()->stream << QLatin1String("stroke=\"black\" ");
*d_func()->stream << QLatin1String("stroke-width=\"1\" ");
*d_func()->stream << QLatin1String("fill-rule=\"evenodd\" ");
*d_func()->stream << QLatin1String("stroke-linecap=\"square\" ");
*d_func()->stream << QLatin1String("stroke-linejoin=\"bevel\" ");
*d_func()->stream << QLatin1String(">\n");
}
inline QTextStream &stream()
{
return *d_func()->stream;
}
void qpenToSvg(const QPen &spen)
{
d_func()->pen = spen;
switch (spen.style()) {
case Qt::NoPen:
stream() << QLatin1String("stroke=\"none\" ");
d_func()->attributes.stroke = QLatin1String("none");
d_func()->attributes.strokeOpacity = QString();
return;
break;
case Qt::SolidLine: {
QString color, colorOpacity;
translate_color(spen.color(), &color,
&colorOpacity);
d_func()->attributes.stroke = color;
d_func()->attributes.strokeOpacity = colorOpacity;
stream() << QLatin1String("stroke=\"")<<color<< QLatin1String("\" ");
stream() << QLatin1String("stroke-opacity=\"")<<colorOpacity<< QLatin1String("\" ");
}
break;
case Qt::DashLine:
case Qt::DotLine:
case Qt::DashDotLine:
case Qt::DashDotDotLine:
case Qt::CustomDashLine: {
QString color, colorOpacity, dashPattern, dashOffset;
qreal penWidth = spen.width() == 0 ? qreal(1) : spen.widthF();
translate_color(spen.color(), &color, &colorOpacity);
translate_dashPattern(spen.dashPattern(), penWidth, &dashPattern);
// SVG uses absolute offset
dashOffset = QString::number(spen.dashOffset() * penWidth);
d_func()->attributes.stroke = color;
d_func()->attributes.strokeOpacity = colorOpacity;
d_func()->attributes.dashPattern = dashPattern;
d_func()->attributes.dashOffset = dashOffset;
stream() << QLatin1String("stroke=\"")<<color<< QLatin1String("\" ");
stream() << QLatin1String("stroke-opacity=\"")<<colorOpacity<< QLatin1String("\" ");
stream() << QLatin1String("stroke-dasharray=\"")<<dashPattern<< QLatin1String("\" ");
stream() << QLatin1String("stroke-dashoffset=\"")<<dashOffset<< QLatin1String("\" ");
break;
}
default:
qWarning("Unsupported pen style");
break;
}
if (spen.widthF() == 0)
stream() <<"stroke-width=\"1\" ";
else
stream() <<"stroke-width=\"" << spen.widthF() << "\" ";
switch (spen.capStyle()) {
case Qt::FlatCap:
stream() << "stroke-linecap=\"butt\" ";
break;
case Qt::SquareCap:
stream() << "stroke-linecap=\"square\" ";
break;
case Qt::RoundCap:
stream() << "stroke-linecap=\"round\" ";
break;
default:
qWarning("Unhandled cap style");
}
switch (spen.joinStyle()) {
case Qt::SvgMiterJoin:
case Qt::MiterJoin:
stream() << "stroke-linejoin=\"miter\" "
"stroke-miterlimit=\""<<spen.miterLimit()<<"\" ";
break;
case Qt::BevelJoin:
stream() << "stroke-linejoin=\"bevel\" ";
break;
case Qt::RoundJoin:
stream() << "stroke-linejoin=\"round\" ";
break;
default:
qWarning("Unhandled join style");
}
}
void qbrushToSvg(const QBrush &sbrush)
{
d_func()->brush = sbrush;
switch (sbrush.style()) {
case Qt::SolidPattern: {
QString color, colorOpacity;
translate_color(sbrush.color(), &color, &colorOpacity);
stream() << "fill=\"" << color << "\" "
"fill-opacity=\""
<< colorOpacity << "\" ";
d_func()->attributes.fill = std::move(color);
d_func()->attributes.fillOpacity = std::move(colorOpacity);
}
break;
case Qt::Dense1Pattern:
case Qt::Dense2Pattern:
case Qt::Dense3Pattern:
case Qt::Dense4Pattern:
case Qt::Dense5Pattern:
case Qt::Dense6Pattern:
case Qt::Dense7Pattern:
case Qt::HorPattern:
case Qt::VerPattern:
case Qt::CrossPattern:
case Qt::BDiagPattern:
case Qt::FDiagPattern:
case Qt::DiagCrossPattern:
case Qt::TexturePattern: {
QString color, colorOpacity;
translate_color(sbrush.color(), &color, &colorOpacity);
QString patternId = (sbrush.style() == Qt::TexturePattern) ? saveTextureBrush(color, sbrush)
: savePatternBrush(color, sbrush);
QString patternRef = QString(QStringLiteral("url(#%1)")).arg(patternId);
stream() << "fill=\"" << patternRef << "\" fill-opacity=\"" << colorOpacity << "\" ";
d_func()->attributes.fill = std::move(patternRef);
d_func()->attributes.fillOpacity = std::move(colorOpacity);
break;
}
case Qt::LinearGradientPattern:
saveLinearGradientBrush(sbrush.gradient());
d_func()->attributes.fill = QString::fromLatin1("url(#%1)").arg(d_func()->currentGradientName);
d_func()->attributes.fillOpacity = QString();
stream() << QLatin1String("fill=\"url(#") << d_func()->currentGradientName << QLatin1String(")\" ");
break;
case Qt::RadialGradientPattern:
saveRadialGradientBrush(sbrush.gradient());
d_func()->attributes.fill = QString::fromLatin1("url(#%1)").arg(d_func()->currentGradientName);
d_func()->attributes.fillOpacity = QString();
stream() << QLatin1String("fill=\"url(#") << d_func()->currentGradientName << QLatin1String(")\" ");
break;
case Qt::ConicalGradientPattern:
saveConicalGradientBrush(sbrush.gradient());
d_func()->attributes.fill = QString::fromLatin1("url(#%1)").arg(d_func()->currentGradientName);
d_func()->attributes.fillOpacity = QString();
stream() << QLatin1String("fill=\"url(#") << d_func()->currentGradientName << QLatin1String(")\" ");
break;
case Qt::NoBrush:
stream() << QLatin1String("fill=\"none\" ");
d_func()->attributes.fill = QLatin1String("none");
d_func()->attributes.fillOpacity = QString();
return;
break;
default:
break;
}
}
void qfontToSvg(const QFont &sfont)
{
Q_D(QSvgPaintEngine);
d->font = sfont;
if (d->font.pixelSize() == -1)
d->attributes.font_size = QString::number(d->font.pointSizeF() * d->resolution / 72);
else
d->attributes.font_size = QString::number(d->font.pixelSize());
d->attributes.font_weight = QString::number(d->font.weight());
d->attributes.font_families = d->font.families();
d->attributes.font_style = d->font.italic() ? QLatin1String("italic") : QLatin1String("normal");
*d->stream << "font-family=\"" << d->attributes.font_families.join(QStringLiteral(",")) << "\" "
"font-size=\"" << d->attributes.font_size << "\" "
"font-weight=\"" << d->attributes.font_weight << "\" "
"font-style=\"" << d->attributes.font_style << "\" "
<< '\n';
}
};
class QSvgGeneratorPrivate
{
public:
QSvgPaintEngine *engine{nullptr};
uint owns_iodevice : 1;
QString fileName;
};
/*!
\class QSvgGenerator
\ingroup painting
\inmodule QtSvg
\since 4.3
\brief The QSvgGenerator class provides a paint device that is used to create SVG drawings.
\reentrant
This paint device represents a Scalable Vector Graphics (SVG) drawing. Like QPrinter, it is
designed as a write-only device that generates output in a specific format.
To write an SVG file, you first need to configure the output by setting the \l fileName
or \l outputDevice properties. It is usually necessary to specify the size of the drawing
by setting the \l size property, and in some cases where the drawing will be included in
another, the \l viewBox property also needs to be set.
\code
QSvgGenerator generator;
generator.setFileName(path);
generator.setSize(QSize(200, 200));
generator.setViewBox(QRect(0, 0, 200, 200));
generator.setTitle(tr("SVG Generator Drawing"));
generator.setDescription(tr("An SVG drawing created by the SVG Generator"));
\endcode
Other meta-data can be specified by setting the \a title, \a description and \a resolution
properties.
As with other QPaintDevice subclasses, a QPainter object is used to paint onto an instance
of this class:
\code
QPainter painter;
painter.begin(&generator);
...
painter.end();
\endcode
Painting is performed in the same way as for any other paint device. However,
it is necessary to use the QPainter::begin() and \l{QPainter::}{end()} to
explicitly begin and end painting on the device.
\sa QSvgRenderer, QSvgWidget, {Qt SVG C++ Classes}
*/
/*!
\enum QSvgGenerator::SvgVersion
\since 6.5
This enumeration describes the version of the SVG output of the
generator.
\value SvgTiny12 The generated document follows the SVG Tiny 1.2 specification.
\value Svg11 The generated document follows the SVG 1.1 specification.
*/
/*!
Constructs a new generator using the SVG Tiny 1.2 profile.
*/
QSvgGenerator::QSvgGenerator() // ### Qt 7: inline
: QSvgGenerator(SvgVersion::SvgTiny12)
{
}
/*!
\since 6.5
Constructs a new generator that uses the SVG version \a version.
*/
QSvgGenerator::QSvgGenerator(SvgVersion version)
: d_ptr(new QSvgGeneratorPrivate)
{
Q_D(QSvgGenerator);
d->engine = new QSvgPaintEngine(version);
d->owns_iodevice = false;
}
/*!
Destroys the generator.
*/
QSvgGenerator::~QSvgGenerator()
{
Q_D(QSvgGenerator);
if (d->owns_iodevice)
delete d->engine->outputDevice();
delete d->engine;
}
/*!
\property QSvgGenerator::title
\brief the title of the generated SVG drawing
\since 4.5
\sa description
*/
QString QSvgGenerator::title() const
{
Q_D(const QSvgGenerator);
return d->engine->documentTitle();
}
void QSvgGenerator::setTitle(const QString &title)
{
Q_D(QSvgGenerator);
d->engine->setDocumentTitle(title);
}
/*!
\property QSvgGenerator::description
\brief the description of the generated SVG drawing
\since 4.5
\sa title
*/
QString QSvgGenerator::description() const
{
Q_D(const QSvgGenerator);
return d->engine->documentDescription();
}
void QSvgGenerator::setDescription(const QString &description)
{
Q_D(QSvgGenerator);
d->engine->setDocumentDescription(description);
}
/*!
\property QSvgGenerator::size
\brief the size of the generated SVG drawing
\since 4.5
By default this property is set to \c{QSize(-1, -1)}, which
indicates that the generator should not output the width and
height attributes of the \c<svg> element.
\note It is not possible to change this property while a
QPainter is active on the generator.
\sa viewBox, resolution
*/
QSize QSvgGenerator::size() const
{
Q_D(const QSvgGenerator);
return d->engine->size();
}
void QSvgGenerator::setSize(const QSize &size)
{
Q_D(QSvgGenerator);
if (d->engine->isActive()) {
qWarning("QSvgGenerator::setSize(), cannot set size while SVG is being generated");
return;
}
d->engine->setSize(size);
}
/*!
\property QSvgGenerator::viewBox
\brief the viewBox of the generated SVG drawing
\since 4.5
By default this property is set to \c{QRect(0, 0, -1, -1)}, which
indicates that the generator should not output the viewBox attribute
of the \c<svg> element.
\note It is not possible to change this property while a
QPainter is active on the generator.
\sa viewBox(), size, resolution
*/
QRectF QSvgGenerator::viewBoxF() const
{
Q_D(const QSvgGenerator);
return d->engine->viewBox();
}
/*!
\since 4.5
Returns viewBoxF().toRect().
\sa viewBoxF()
*/
QRect QSvgGenerator::viewBox() const
{
Q_D(const QSvgGenerator);
return d->engine->viewBox().toRect();
}
void QSvgGenerator::setViewBox(const QRectF &viewBox)
{
Q_D(QSvgGenerator);
if (d->engine->isActive()) {
qWarning("QSvgGenerator::setViewBox(), cannot set viewBox while SVG is being generated");
return;
}
d->engine->setViewBox(viewBox);
}
void QSvgGenerator::setViewBox(const QRect &viewBox)
{
setViewBox(QRectF(viewBox));
}
/*!
\property QSvgGenerator::fileName
\brief the target filename for the generated SVG drawing
\since 4.5
\sa outputDevice
*/
QString QSvgGenerator::fileName() const
{
Q_D(const QSvgGenerator);
return d->fileName;
}
void QSvgGenerator::setFileName(const QString &fileName)
{
Q_D(QSvgGenerator);
if (d->engine->isActive()) {
qWarning("QSvgGenerator::setFileName(), cannot set file name while SVG is being generated");
return;
}
if (d->owns_iodevice)
delete d->engine->outputDevice();
d->owns_iodevice = true;
d->fileName = fileName;
QFile *file = new QFile(fileName);
d->engine->setOutputDevice(file);
}
/*!
\property QSvgGenerator::outputDevice
\brief the output device for the generated SVG drawing
\since 4.5
If both output device and file name are specified, the output device
will have precedence.
\sa fileName
*/
QIODevice *QSvgGenerator::outputDevice() const
{
Q_D(const QSvgGenerator);
return d->engine->outputDevice();
}
void QSvgGenerator::setOutputDevice(QIODevice *outputDevice)
{
Q_D(QSvgGenerator);
if (d->engine->isActive()) {
qWarning("QSvgGenerator::setOutputDevice(), cannot set output device while SVG is being generated");
return;
}
d->owns_iodevice = false;
d->engine->setOutputDevice(outputDevice);
d->fileName = QString();
}
/*!
\property QSvgGenerator::resolution
\brief the resolution of the generated output
\since 4.5
The resolution is specified in dots per inch, and is used to
calculate the physical size of an SVG drawing.
\sa size, viewBox
*/
int QSvgGenerator::resolution() const
{
Q_D(const QSvgGenerator);
return d->engine->resolution();
}
void QSvgGenerator::setResolution(int dpi)
{
Q_D(QSvgGenerator);
d->engine->setResolution(dpi);
}
/*!
\since 6.5
Returns the version of the SVG document that this generator is
producing.
*/
QSvgGenerator::SvgVersion QSvgGenerator::svgVersion() const
{
Q_D(const QSvgGenerator);
return d->engine->svgVersion();
}
/*!
Returns the paint engine used to render graphics to be converted to SVG
format information.
*/
QPaintEngine *QSvgGenerator::paintEngine() const
{
Q_D(const QSvgGenerator);
return d->engine;
}
/*!
\reimp
*/
int QSvgGenerator::metric(QPaintDevice::PaintDeviceMetric metric) const
{
Q_D(const QSvgGenerator);
switch (metric) {
case QPaintDevice::PdmDepth:
return 32;
case QPaintDevice::PdmWidth:
return d->engine->size().width();
case QPaintDevice::PdmHeight:
return d->engine->size().height();
case QPaintDevice::PdmDpiX:
return d->engine->resolution();
case QPaintDevice::PdmDpiY:
return d->engine->resolution();
case QPaintDevice::PdmHeightMM:
return qRound(d->engine->size().height() * 25.4 / d->engine->resolution());
case QPaintDevice::PdmWidthMM:
return qRound(d->engine->size().width() * 25.4 / d->engine->resolution());
case QPaintDevice::PdmNumColors:
return 0xffffffff;
case QPaintDevice::PdmPhysicalDpiX:
return d->engine->resolution();
case QPaintDevice::PdmPhysicalDpiY:
return d->engine->resolution();
case QPaintDevice::PdmDevicePixelRatio:
return 1;
case QPaintDevice::PdmDevicePixelRatioScaled:
return 1 * QPaintDevice::devicePixelRatioFScale();
default:
qWarning("QSvgGenerator::metric(), unhandled metric %d\n", metric);
break;
}
return 0;
}
/*!
\since 6.11
\reimp
*/
void QSvgGenerator::initPainter(QPainter *painter) const
{
QPainterPrivate *painterPrivate = QPainterPrivate::get(painter);
for (QFont *font : { &painterPrivate->state->deviceFont, &painterPrivate->state->font }) {
if (font->hintingPreference() == QFont::PreferDefaultHinting)
font->setHintingPreference(QFont::PreferNoHinting);
}
painterPrivate->setEngineDirtyFlags({ QPaintEngine::DirtyFont });
}
/*****************************************************************************
* class QSvgPaintEngine
*/
bool QSvgPaintEngine::begin(QPaintDevice *)
{
Q_D(QSvgPaintEngine);
if (!d->outputDevice) {
qWarning("QSvgPaintEngine::begin(), no output device");
return false;
}
if (!d->outputDevice->isOpen()) {
if (!d->outputDevice->open(QIODevice::WriteOnly | QIODevice::Text)) {
qWarning("QSvgPaintEngine::begin(), could not open output device: '%s'",
qPrintable(d->outputDevice->errorString()));
return false;
}
} else if (!d->outputDevice->isWritable()) {
qWarning("QSvgPaintEngine::begin(), could not write to read-only output device: '%s'",
qPrintable(d->outputDevice->errorString()));
return false;
}
d->stream = new QTextStream(&d->header);
// stream out the header...
*d->stream << "<?xml version=\"1.0\" encoding=\"UTF-8\" standalone=\"no\"?>" << '\n' << "<svg";
if (d->size.isValid()) {
qreal wmm = d->size.width() * 25.4 / d->resolution;
qreal hmm = d->size.height() * 25.4 / d->resolution;
*d->stream << " width=\"" << wmm << "mm\" height=\"" << hmm << "mm\"" << '\n';
}
if (d->viewBox.isValid()) {
*d->stream << " viewBox=\"" << d->viewBox.left() << ' ' << d->viewBox.top();
*d->stream << ' ' << d->viewBox.width() << ' ' << d->viewBox.height() << '\"' << '\n';
}
switch (d->svgVersion) {
case QSvgGenerator::SvgVersion::SvgTiny12:
*d->stream << " version=\"1.2\" baseProfile=\"tiny\">";
break;
case QSvgGenerator::SvgVersion::Svg11:
*d->stream << " version=\"1.1\">";
break;
}
*d->stream << '\n';
if (!d->attributes.document_title.isEmpty()) {
*d->stream << "<title>" << d->attributes.document_title.toHtmlEscaped() << "</title>" << '\n';
}
if (!d->attributes.document_description.isEmpty()) {
*d->stream << "<desc>" << d->attributes.document_description.toHtmlEscaped() << "</desc>" << '\n';
}
d->stream->setString(&d->defs);
*d->stream << "<defs>\n";
d->stream->setString(&d->body);
// Start the initial graphics state...
*d->stream << "<g ";
generateQtDefaults();
*d->stream << '\n';
return true;
}
bool QSvgPaintEngine::end()
{
Q_D(QSvgPaintEngine);
d->stream->setString(&d->defs);
*d->stream << "</defs>\n";
d->stream->setDevice(d->outputDevice);
*d->stream << d->header;
*d->stream << d->defs;
*d->stream << d->body;
if (d->hasEmittedClipGroup)
*d->stream << "</g>";
if (d->afterFirstUpdate)
*d->stream << "</g>" << '\n'; // close the updateState
*d->stream << "</g>" << '\n' // close the Qt defaults
<< "</svg>" << '\n';
delete d->stream;
return true;
}
void QSvgPaintEngine::drawPixmap(const QRectF &r, const QPixmap &pm,
const QRectF &sr)
{
drawImage(r, pm.toImage(), sr);
}
void QSvgPaintEngine::generateImage(QTextStream &stream, const QRectF &r, const QImage &image)
{
QString quality;
if (state->renderHints() & QPainter::SmoothPixmapTransform) {
quality = QLatin1String("optimizeQuality");
} else {
quality = QLatin1String("optimizeSpeed");
}
stream << "<image ";
stream << "x=\""<<r.x()<<"\" "
"y=\""<<r.y()<<"\" "
"width=\""<<r.width()<<"\" "
"height=\""<<r.height()<<"\" "
"preserveAspectRatio=\"none\" "
"image-rendering=\""<<quality<<"\" ";
QByteArray data;
QBuffer buffer(&data);
buffer.open(QBuffer::ReadWrite);
image.save(&buffer, "PNG");
buffer.close();
stream << "xlink:href=\"data:image/png;base64,"
<< data.toBase64()
<<"\" />\n";
}
void QSvgPaintEngine::drawImage(const QRectF &r, const QImage &image,
const QRectF &sr,
Qt::ImageConversionFlags flags)
{
Q_UNUSED(sr);
Q_UNUSED(flags);
generateImage(stream(), r, image);
}
void QSvgPaintEngine::updateState(const QPaintEngineState &state)
{
Q_D(QSvgPaintEngine);
// always stream full gstate, which is not required, but...
// close old state and start a new one...
if (d->hasEmittedClipGroup)
*d->stream << "</g>\n";
if (d->afterFirstUpdate)
*d->stream << "</g>\n\n";
updateClipState(state);
if (d->isClippingEffective()) {
*d->stream << QStringLiteral("<g clip-path=\"url(#%1)\">").arg(d->currentClipPathName);
d->hasEmittedClipGroup = true;
} else {
d->hasEmittedClipGroup = false;
}
*d->stream << "<g ";
qbrushToSvg(state.brush());
qpenToSvg(state.pen());
d->matrix = state.transform();
*d->stream << "transform=\"matrix(" << d->matrix.m11() << ','
<< d->matrix.m12() << ','
<< d->matrix.m21() << ',' << d->matrix.m22() << ','
<< d->matrix.dx() << ',' << d->matrix.dy()
<< ")\""
<< '\n';
qfontToSvg(state.font());
if (!qFuzzyIsNull(state.opacity() - 1))
stream() << "opacity=\""<<state.opacity()<<"\" ";
*d->stream << '>' << '\n';
d->afterFirstUpdate = true;
}
void QSvgPaintEngine::updateClipState(const QPaintEngineState &state)
{
Q_D(QSvgPaintEngine);
switch (d->svgVersion) {
case QSvgGenerator::SvgVersion::SvgTiny12:
// no clip handling in Tiny 1.2
return;
case QSvgGenerator::SvgVersion::Svg11:
break;
}
const QPaintEngine::DirtyFlags flags = state.state();
const bool clippingChanged = flags.testAnyFlags(DirtyClipPath | DirtyClipRegion);
if (clippingChanged) {
switch (state.clipOperation()) {
case Qt::NoClip:
d->clipEnabled = false;
d->clipPath.reset();
break;
case Qt::ReplaceClip:
case Qt::IntersectClip:
d->clipPath = painter()->transform().map(painter()->clipPath());
break;
}
}
if (flags & DirtyClipEnabled)
d->clipEnabled = state.isClipEnabled();
if (d->isClippingEffective() && clippingChanged) {
d->stream->setString(&d->defs);
*d->stream << QLatin1String("<clipPath id=\"%1\">\n").arg(d->generateClipPathName());
drawPath(*d->clipPath);
*d->stream << "</clipPath>\n";
d->stream->setString(&d->body);
}
}
void QSvgPaintEngine::drawEllipse(const QRectF &r)
{
Q_D(QSvgPaintEngine);
const bool isCircle = r.width() == r.height();
*d->stream << '<' << (isCircle ? "circle" : "ellipse");
if (state->pen().isCosmetic())
*d->stream << " vector-effect=\"non-scaling-stroke\"";
const QPointF c = r.center();
*d->stream << " cx=\"" << c.x() << "\" cy=\"" << c.y();
if (isCircle)
*d->stream << "\" r=\"" << r.width() / qreal(2.0);
else
*d->stream << "\" rx=\"" << r.width() / qreal(2.0) << "\" ry=\"" << r.height() / qreal(2.0);
*d->stream << "\"/>" << '\n';
}
void QSvgPaintEngine::drawPath(const QPainterPath &p)
{
Q_D(QSvgPaintEngine);
*d->stream << "<path vector-effect=\""
<< (state->pen().isCosmetic() ? "non-scaling-stroke" : "none")
<< "\" fill-rule=\""
<< (p.fillRule() == Qt::OddEvenFill ? "evenodd" : "nonzero")
<< "\" d=\"";
int i = 0;
QPointF subPathStart;
auto endSubPath = [&]() {
if (i > 0) {
const QPointF subPathEnd = p.elementAt(i - 1);
if (subPathEnd == subPathStart)
*d->stream << "Z ";
}
};
bool inCurveToElement = false;
for (i = 0; i < p.elementCount(); ++i) {
const QPainterPath::Element &e = p.elementAt(i);
switch (e.type) {
case QPainterPath::MoveToElement:
endSubPath();
subPathStart = e;
*d->stream << 'M' << e.x << ',' << e.y;
break;
case QPainterPath::LineToElement:
*d->stream << 'L' << e.x << ',' << e.y;
break;
case QPainterPath::CurveToElement:
*d->stream << 'C' << e.x << ',' << e.y;
break;
case QPainterPath::CurveToDataElement:
if (Q_LIKELY(inCurveToElement))
*d->stream << e.x << ',' << e.y;
break;
default:
break;
}
*d->stream << ' ';
if (e.type != QPainterPath::CurveToDataElement)
inCurveToElement = (e.type == QPainterPath::CurveToElement);
}
endSubPath();
*d->stream << "\"/>" << '\n';
}
void QSvgPaintEngine::drawPolygon(const QPointF *points, int pointCount,
PolygonDrawMode mode)
{
Q_ASSERT(pointCount >= 2);
//Q_D(QSvgPaintEngine);
if (mode == PolylineMode)
stream() << "<polyline fill=\"none\"";
else if (mode == OddEvenMode)
stream() << "<polygon fill-rule=\"evenodd\"";
else if (mode == WindingMode || mode == ConvexMode)
stream() << "<polygon fill-rule=\"nonzero\"";
stream() << " vector-effect=\""
<< (state->pen().isCosmetic() ? "non-scaling-stroke" : "none")
<< "\" points=\"";
for (int i = 0; i < pointCount; ++i) {
const QPointF &pt = points[i];
stream() << pt.x() << ',' << pt.y() << ' ';
}
stream() << "\" />" <<'\n';
}
void QSvgPaintEngine::drawRects(const QRectF *rects, int rectCount)
{
Q_D(QSvgPaintEngine);
for (int i=0; i < rectCount; ++i) {
const QRectF &rect = rects[i].normalized();
*d->stream << "<rect";
if (state->pen().isCosmetic())
*d->stream << " vector-effect=\"non-scaling-stroke\"";
*d->stream << " x=\"" << rect.x() << "\" y=\"" << rect.y()
<< "\" width=\"" << rect.width() << "\" height=\"" << rect.height()
<< "\"/>" << '\n';
}
}
void QSvgPaintEngine::drawTextItem(const QPointF &pt, const QTextItem &textItem)
{
Q_D(QSvgPaintEngine);
if (d->pen.style() == Qt::NoPen)
return;
const QTextItemInt &ti = static_cast<const QTextItemInt &>(textItem);
if (ti.chars == 0)
QPaintEngine::drawTextItem(pt, ti); // Draw as path
QString s = QString::fromRawData(ti.chars, ti.num_chars);
*d->stream << "<text "
"fill=\"" << d->attributes.stroke << "\" "
"fill-opacity=\"" << d->attributes.strokeOpacity << "\" "
"stroke=\"none\" "
"xml:space=\"preserve\" "
"x=\"" << pt.x() << "\" y=\"" << pt.y() << "\" ";
qfontToSvg(textItem.font());
*d->stream << " >"
<< s.toHtmlEscaped()
<< "</text>"
<< '\n';
}
QT_END_NAMESPACE
#endif // QT_NO_SVGGENERATOR