Debian Codegraph @

src/util/dsvgrenderer.cpp

raw
1 // SPDX-FileCopyrightText: 2022 - 2023 UnionTech Software Technology Co., Ltd.
2 //
3 // SPDX-License-Identifier: LGPL-3.0-or-later
4
5 #ifndef DTK_DISABLE_LIBRSVG
6 #include <librsvg/rsvg.h>
7 #else
8 #include <QSvgRenderer>
9 #endif
10
11 #include "dsvgrenderer.h"
12 #include "dobject_p.h"
13
14 #include <QPainter>
15 #include <QFile>
16 #include <QDebug>
17 #include <QGuiApplication>
18 #include <QLibrary>
19 #include <QXmlStreamReader>
20
21 DCORE_USE_NAMESPACE
22
23 DGUI_BEGIN_NAMESPACE
24
25 #ifndef DTK_DISABLE_LIBRSVG
26 class RSvg
27 {
28 public:
29 RSvg()
30 {
31 // fix found lib was librsvg2-dev without version number
32 rsvg = new QLibrary("rsvg-2", "2");
33
34 if (!rsvg->load()) {
35 delete rsvg;
36 rsvg = nullptr;
37 return;
38 }
39
40 #define INIT_FUNCTION(Name) Name = reinterpret_cast<decltype (Name)>(rsvg->resolve(#Name)); Q_ASSERT(Name)
41
42 INIT_FUNCTION(cairo_image_surface_create_for_data);
43 INIT_FUNCTION(cairo_create);
44 INIT_FUNCTION(cairo_scale);
45 INIT_FUNCTION(cairo_translate);
46 INIT_FUNCTION(cairo_destroy);
47 INIT_FUNCTION(cairo_surface_destroy);
48 INIT_FUNCTION(g_object_unref);
49 INIT_FUNCTION(rsvg_handle_render_cairo);
50 INIT_FUNCTION(rsvg_handle_render_cairo_sub);
51 INIT_FUNCTION(rsvg_handle_get_dimensions_sub);
52 INIT_FUNCTION(rsvg_handle_get_position_sub);
53 INIT_FUNCTION(rsvg_handle_has_sub);
54 INIT_FUNCTION(rsvg_handle_new_from_data);
55 INIT_FUNCTION(rsvg_handle_get_dimensions);
56 }
57
58 static RSvg *instance() {
59 static RSvg *global = new RSvg();
60 return global;
61 }
62
63 bool isValid() const
64 {
65 return rsvg;
66 }
67
68 ~RSvg()
69 {
70 if (rsvg)
71 delete rsvg;
72 }
73
74 cairo_surface_t *(*cairo_image_surface_create_for_data)(unsigned char *data, cairo_format_t format, int width, int height, int stride);
75 cairo_t *(*cairo_create)(cairo_surface_t *target);
76 void (*cairo_scale)(cairo_t *cr, double sx, double sy);
77 void (*cairo_translate)(cairo_t *cr, double tx, double ty);
78 void (*cairo_destroy)(cairo_t *cr);
79 void (*cairo_surface_destroy)(cairo_surface_t *surface);
80 void (*g_object_unref)(gpointer object);
81
82 gboolean (*rsvg_handle_render_cairo)(RsvgHandle *handle, cairo_t *cr);
83 gboolean (*rsvg_handle_render_cairo_sub)(RsvgHandle *handle, cairo_t *cr, const char *id);
84 gboolean (*rsvg_handle_get_dimensions_sub)(RsvgHandle *handle, RsvgDimensionData *dimension_data, const char *id);
85 gboolean (*rsvg_handle_get_position_sub)(RsvgHandle *handle, RsvgPositionData *position_data, const char *id);
86 gboolean (*rsvg_handle_has_sub)(RsvgHandle *handle, const char *id);
87 RsvgHandle *(*rsvg_handle_new_from_data)(const guint8 *data, gsize data_len, GError **error);
88 void (*rsvg_handle_get_dimensions)(RsvgHandle *handle, RsvgDimensionData *dimension_data);
89
90 private:
91 QLibrary *rsvg = nullptr;
92 };
93 #endif
94
95 class DSvgRendererPrivate : public DObjectPrivate
96 {
97 public:
98 explicit DSvgRendererPrivate(DSvgRenderer *qq);
99
100 QImage getImage(const QSize &size, const QString &elementId) const;
101
102 #ifndef DTK_DISABLE_LIBRSVG
103 RsvgHandle *handle = nullptr;
104 QSize defaultSize;
105 mutable QRectF viewBox;
106 #else
107 QSvgRenderer *qRenderer = nullptr;
108 #endif
109 };
110
111 DSvgRendererPrivate::DSvgRendererPrivate(DSvgRenderer *qq)
112 : DObjectPrivate(qq) // qq ==> DObject
113 #ifdef DTK_DISABLE_LIBRSVG
114 , qRenderer(new QSvgRenderer(qq)) // qq ==> QObject
115 #endif
116 {
117
118 }
119
120 QImage DSvgRendererPrivate::getImage(const QSize &size, const QString &elementId) const
121 {
122 #ifndef DTK_DISABLE_LIBRSVG
123 if (!RSvg::instance()->isValid())
124 return QImage();
125
126 QImage image(size, QImage::Format_ARGB32_Premultiplied);
127
128 image.fill(Qt::transparent);
129
130 cairo_surface_t *surface = RSvg::instance()->cairo_image_surface_create_for_data(image.bits(), CAIRO_FORMAT_ARGB32, image.width(), image.height(), image.bytesPerLine());
131 cairo_t *cairo = RSvg::instance()->cairo_create(surface);
132 RSvg::instance()->cairo_scale(cairo, image.width() / viewBox.width(), image.height() / viewBox.height());
133 RSvg::instance()->cairo_translate(cairo, -viewBox.x(), -viewBox.y());
134
135 if (elementId.isEmpty())
136 RSvg::instance()->rsvg_handle_render_cairo(handle, cairo);
137 else
138 RSvg::instance()->rsvg_handle_render_cairo_sub(handle, cairo, elementId.toUtf8().constData());
139
140 RSvg::instance()->cairo_destroy(cairo);
141 RSvg::instance()->cairo_surface_destroy(surface);
142
143 return image;
144 #else
145 QImage image(size, QImage::Format_ARGB32_Premultiplied);
146 image.fill(Qt::transparent);
147 QPainter pa(&image);
148 if (elementId.isEmpty())
149 qRenderer->render(&pa);
150 else
151 qRenderer->render(&pa, elementId);
152 return image;
153 #endif
154 }
155
156 /*!
157 \class Dtk::Gui::DSvgRenderer
158 \inmodule dtkgui
159 \brief 提供了将SVG文件的内容绘制到绘制设备上的方法.
160
161 SVG图形可以在构造 DSvgRenderer 时加载,也可以稍后使用load()函数加载。
162 因为渲染是使用 QPainter 执行的,所以可以在 QPaintDevice 的任何子类上渲染SVG图形。
163 如果加载了有效文件,则无论是在构造时还是以后某个时间,isValid()都将返回true;否则将返回false。
164 DSvgRenderer提供render()插槽,用于使用给定的 QPainter 渲染当前文档或动画文档的当前帧
165 \note 使用 DSvgRenderer 需要 librsvg库
166 */
167
168 DSvgRenderer::DSvgRenderer(QObject *parent)
169 : QObject(parent)
170 , DObject(*new DSvgRendererPrivate(this))
171 {
172
173 }
174
175 DSvgRenderer::DSvgRenderer(const QString &filename, QObject *parent)
176 : DSvgRenderer(parent)
177 {
178 load(filename);
179 }
180
181 DSvgRenderer::DSvgRenderer(const QByteArray &contents, QObject *parent)
182 : DSvgRenderer(parent)
183 {
184 load(contents);
185 }
186
187 DSvgRenderer::~DSvgRenderer()
188 {
189 #ifndef DTK_DISABLE_LIBRSVG
190 D_D(DSvgRenderer);
191
192 if (d->handle) {
193 Q_ASSERT(RSvg::instance()->isValid());
194 RSvg::instance()->g_object_unref(d->handle);
195 }
196 #endif
197 }
198
199 bool DSvgRenderer::isValid() const
200 {
201 D_DC(DSvgRenderer);
202 #ifndef DTK_DISABLE_LIBRSVG
203 return d->handle;
204 #else
205 return d->qRenderer->isValid();
206 #endif
207 }
208
209 QSize DSvgRenderer::defaultSize() const
210 {
211 D_DC(DSvgRenderer);
212 #ifndef DTK_DISABLE_LIBRSVG
213 return d->defaultSize;
214 #else
215 return d->qRenderer->defaultSize();
216 #endif
217 }
218
219 QRect DSvgRenderer::viewBox() const
220 {
221 D_DC(DSvgRenderer);
222 #ifndef DTK_DISABLE_LIBRSVG
223 return d->handle ? d->viewBox.toRect() : QRect();
224 #else
225 return d->qRenderer->viewBox();
226 #endif
227 }
228
229 QRectF DSvgRenderer::viewBoxF() const
230 {
231 D_DC(DSvgRenderer);
232 #ifndef DTK_DISABLE_LIBRSVG
233 return d->handle ? d->viewBox : QRectF();
234 #else
235 return d->qRenderer->viewBoxF();
236 #endif
237 }
238
239 void DSvgRenderer::setViewBox(const QRect &viewbox)
240 {
241 setViewBox(QRectF(viewbox));
242 }
243
244 void DSvgRenderer::setViewBox(const QRectF &viewbox)
245 {
246 D_D(DSvgRenderer);
247 #ifndef DTK_DISABLE_LIBRSVG
248 if (d->handle)
249 d->viewBox = viewbox;
250 #else
251 return d->qRenderer->setViewBox(viewbox);
252 #endif
253 }
254
255 QRectF DSvgRenderer::boundsOnElement(const QString &id) const
256 {
257 D_DC(DSvgRenderer);
258 #ifndef DTK_DISABLE_LIBRSVG
259 if (!d->handle)
260 return QRectF();
261
262 const QByteArray &id_data = id.toUtf8();
263
264 RsvgDimensionData dimension_data;
265
266 if (!RSvg::instance()->rsvg_handle_get_dimensions_sub(d->handle, &dimension_data, id_data.constData()))
267 return QRectF();
268
269 RsvgPositionData pos_data;
270
271 if (!RSvg::instance()->rsvg_handle_get_position_sub(d->handle, &pos_data, id_data.constData()))
272 return QRectF();
273
274 return QRectF(pos_data.x, pos_data.y, dimension_data.width, dimension_data.height);
275 #else
276 return d->qRenderer->boundsOnElement(id);
277 #endif
278 }
279
280 bool DSvgRenderer::elementExists(const QString &id) const
281 {
282 D_DC(DSvgRenderer);
283 #ifndef DTK_DISABLE_LIBRSVG
284 if (!d->handle)
285 return false;
286
287 return RSvg::instance()->rsvg_handle_has_sub(d->handle, id.toUtf8().constData());
288 #else
289 return d->qRenderer->elementExists(id);
290 #endif
291 }
292
293 QImage DSvgRenderer::toImage(const QSize sz, const QString &elementId) const
294 {
295 Q_D(const DSvgRenderer);
296
297 return d->getImage(sz, elementId);
298 }
299
300 #ifndef DTK_DISABLE_LIBRSVG
301 static QByteArray updateXmlAttribute(const QString &contents)
302 {
303 QByteArray data;
304 QXmlStreamWriter writer(&data);
305 QXmlStreamReader reader(contents);
306 while(reader.readNext() != QXmlStreamReader::Invalid && !reader.atEnd()) {
307 if (reader.tokenType() != QXmlStreamReader::StartElement ||
308 !reader.attributes().hasAttribute("href")) {
309 writer.writeCurrentToken(reader);
310 continue;
311 }
312
313 for (const auto &nd : reader.namespaceDeclarations())
314 writer.writeNamespace(nd.namespaceUri().toString(), nd.prefix().toString());
315
316 writer.writeStartElement(reader.namespaceUri().toString(), reader.name().toString());
317
318 for (const auto &attr : reader.attributes()) {
319 if (attr.name() == QStringLiteral("href")) {
320 writer.writeAttribute("xlink:href", attr.value().toString());
321 continue;
322 }
323 writer.writeAttribute(attr);
324 }
325 }
326
327 return data;
328 }
329
330 static QByteArray format(const QByteArray &contents)
331 {
332 QXmlStreamReader reader(contents);
333 while (reader.readNextStartElement()) {
334 if (reader.attributes().hasAttribute("href"))
335 return updateXmlAttribute(contents);
336 }
337
338 return contents;
339 }
340 #endif
341
342 bool DSvgRenderer::load(const QString &filename)
343 {
344 #ifndef DTK_DISABLE_LIBRSVG
345 QFile file(filename);
346
347 if (file.open(QIODevice::ReadOnly)) {
348 // TODO: if `href` attribute is adapted after librsvg upgrade revert me
349 return load(format(file.readAll()));
350 }
351
352 return false;
353 #else
354 D_D(DSvgRenderer);
355 return d->qRenderer->load(filename);
356 #endif
357 }
358
359 bool DSvgRenderer::load(const QByteArray &contents)
360 {
361 D_D(DSvgRenderer);
362 #ifndef DTK_DISABLE_LIBRSVG
363 if (!RSvg::instance()->isValid())
364 return false;
365
366 if (d->handle) {
367 RSvg::instance()->g_object_unref(d->handle);
368 d->handle = nullptr;
369 }
370
371 GError *error = nullptr;
372 d->handle = RSvg::instance()->rsvg_handle_new_from_data((const guint8*)contents.constData(), contents.length(), &error);
373
374 if (error) {
375 qWarning("DSvgRenderer::load: %s", error->message);
376 g_error_free(error);
377
378 return false;
379 }
380
381 RsvgDimensionData rsvg_data;
382
383 RSvg::instance()->rsvg_handle_get_dimensions(d->handle, &rsvg_data);
384
385 d->defaultSize.setWidth(rsvg_data.width);
386 d->defaultSize.setHeight(rsvg_data.height);
387 d->viewBox = QRectF(QPointF(0, 0), d->defaultSize);
388
389 return true;
390 #else
391 return d->qRenderer->load(contents);
392 #endif
393 }
394
395 void DSvgRenderer::render(QPainter *p)
396 {
397 #ifndef DTK_DISABLE_LIBRSVG
398 render(p, QString(), QRectF());
399 #else
400 D_D(DSvgRenderer);
401 d->qRenderer->render(p);
402 #endif
403 }
404
405 void DSvgRenderer::render(QPainter *p, const QRectF &bounds)
406 {
407 #ifndef DTK_DISABLE_LIBRSVG
408 render(p, QString(), bounds);
409 #else
410 D_D(DSvgRenderer);
411 d->qRenderer->render(p, bounds);
412 #endif
413 }
414
415 void DSvgRenderer::render(QPainter *p, const QString &elementId, const QRectF &bounds)
416 {
417 D_D(DSvgRenderer);
418 #ifndef DTK_DISABLE_LIBRSVG
419 if (!d->handle)
420 return;
421
422 p->save();
423
424 const QImage image = d->getImage(QSize(p->device()->width(), p->device()->height()), elementId);
425
426 if (bounds.isEmpty())
427 p->drawImage(0, 0, image);
428 else
429 p->drawImage(bounds, image);
430
431 p->restore();
432 #else
433 d->qRenderer->render(p, elementId, bounds);
434 #endif
435 }
436
437 DGUI_END_NAMESPACE