summaryrefslogtreecommitdiff
path: root/svgio/source/svgreader/svgsvgnode.cxx
blob: a8daee667ebee3e0bd33fbe5951247b189d27727 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */

#include <svgio/svgreader/svgsvgnode.hxx>
#include <drawinglayer/geometry/viewinformation2d.hxx>
#include <drawinglayer/primitive2d/transformprimitive2d.hxx>
#include <drawinglayer/primitive2d/maskprimitive2d.hxx>
#include <basegfx/polygon/b2dpolygontools.hxx>
#include <basegfx/polygon/b2dpolygon.hxx>
#include <basegfx/matrix/b2dhommatrixtools.hxx>
#include <drawinglayer/primitive2d/polygonprimitive2d.hxx>
#include <drawinglayer/primitive2d/hiddengeometryprimitive2d.hxx>

//////////////////////////////////////////////////////////////////////////////

namespace svgio
{
    namespace svgreader
    {
        SvgSvgNode::SvgSvgNode(
            SvgDocument& rDocument,
            SvgNode* pParent)
        :   SvgNode(SVGTokenSvg, rDocument, pParent),
            maSvgStyleAttributes(*this),
            mpViewBox(0),
            maSvgAspectRatio(SvgAspectRatio(Align_xMidYMid, false, true)),
            maX(),
            maY(),
            maWidth(),
            maHeight(),
            maVersion()
        {
            if(!getParent())
            {
                // initial fill is black
                maSvgStyleAttributes.setFill(SvgPaint(basegfx::BColor(0.0, 0.0, 0.0), true, true));
            }
        }

        SvgSvgNode::~SvgSvgNode()
        {
            if(mpViewBox) delete mpViewBox;
        }

        const SvgStyleAttributes* SvgSvgNode::getSvgStyleAttributes() const
        {
            return &maSvgStyleAttributes;
        }

        void SvgSvgNode::parseAttribute(const OUString& rTokenName, SVGToken aSVGToken, const OUString& aContent)
        {
            // call parent
            SvgNode::parseAttribute(rTokenName, aSVGToken, aContent);

            // read style attributes
            maSvgStyleAttributes.parseStyleAttribute(rTokenName, aSVGToken, aContent);

            // parse own
            switch(aSVGToken)
            {
                case SVGTokenStyle:
                {
                    maSvgStyleAttributes.readStyle(aContent);
                    break;
                }
                case SVGTokenViewBox:
                {
                    const basegfx::B2DRange aRange(readViewBox(aContent, *this));

                    if(!aRange.isEmpty())
                    {
                        setViewBox(&aRange);
                    }
                    break;
                }
                case SVGTokenPreserveAspectRatio:
                {
                    setSvgAspectRatio(readSvgAspectRatio(aContent));
                    break;
                }
                case SVGTokenX:
                {
                    SvgNumber aNum;

                    if(readSingleNumber(aContent, aNum))
                    {
                        setX(aNum);
                    }
                    break;
                }
                case SVGTokenY:
                {
                    SvgNumber aNum;

                    if(readSingleNumber(aContent, aNum))
                    {
                        setY(aNum);
                    }
                    break;
                }
                case SVGTokenWidth:
                {
                    SvgNumber aNum;

                    if(readSingleNumber(aContent, aNum))
                    {
                        if(aNum.isPositive())
                        {
                            setWidth(aNum);
                        }
                    }
                    break;
                }
                case SVGTokenHeight:
                {
                    SvgNumber aNum;

                    if(readSingleNumber(aContent, aNum))
                    {
                        if(aNum.isPositive())
                        {
                            setHeight(aNum);
                        }
                    }
                    break;
                }
                case SVGTokenVersion:
                {
                    SvgNumber aNum;

                    if(readSingleNumber(aContent, aNum))
                    {
                        setVersion(aNum);
                    }
                    break;
                }
                default:
                {
                    break;
                }
            }
        }

        void SvgSvgNode::decomposeSvgNode(drawinglayer::primitive2d::Primitive2DSequence& rTarget, bool bReferenced) const
        {
            drawinglayer::primitive2d::Primitive2DSequence aSequence;

            // decompose childs
            SvgNode::decomposeSvgNode(aSequence, bReferenced);

            if(aSequence.hasElements())
            {
                if(getParent())
                {
                    const bool bWidthIsRelative(!getWidth().isSet() || Unit_percent == getWidth().getUnit());
                    const bool bHeightIsRelative(!getWidth().isSet() || Unit_percent == getWidth().getUnit());
                    const SvgSvgNode* pParentSvgSvgNode = 0;
                    double fW(0.0);
                    double fH(0.0);

                    // #i122594# if width/height is not given, it's 100% (see 5.1.2 The ‘svg’ element in SVG1.1 spec).
                    // If it is relative, the question is to what. The previous implementatin assumed relative to the
                    // local ViewBox which is implied by (4.2 Basic data types):
                    //
                    // "Note that the non-property <length> definition also allows a percentage unit identifier.
                    // The meaning of a percentage length value depends on the attribute for which the percentage
                    // length value has been specified. Two common cases are: (a) when a percentage length value
                    // represents a percentage of the viewport width or height (refer to the section that discusses
                    // units in general), and (b) when a percentage length value represents a percentage of the
                    // bounding box width or height on a given object (refer to the section that describes object
                    // bounding box units)."
                    //
                    // This is not closer specified for the SVG element itself as non-outmost element, but comparisons
                    // with common browsers shows that it's mostly interpreted relative to the viewBox of the parent.
                    // Adding code to search the parent SVG element and calculating width/height relative to it's
                    // viewBox width/height (and no longer to the local viewBox).
                    if(bWidthIsRelative || bHeightIsRelative)
                    {
                        for(const SvgNode* pParent = getParent(); pParent && !pParentSvgSvgNode; pParent = pParent->getParent())
                        {
                            pParentSvgSvgNode = dynamic_cast< const SvgSvgNode* >(pParent);
                        }
                    }

                    if(bWidthIsRelative)
                    {
                        fW = getWidth().isSet() ? getWidth().getNumber() * 0.01 : 1.0;

                        if(pParentSvgSvgNode)
                        {
                            fW *= pParentSvgSvgNode->getViewBox()->getWidth();
                        }
                    }
                    else
                    {
                        fW = getWidth().solve(*this, xcoordinate);
                    }

                    if(bHeightIsRelative)
                    {
                        fH = getHeight().isSet() ? getHeight().getNumber() * 0.01 : 1.0;

                        if(pParentSvgSvgNode)
                        {
                            fH *= pParentSvgSvgNode->getViewBox()->getHeight();
                        }
                    }
                    else
                    {
                        fH = getHeight().solve(*this, ycoordinate);
                    }

                    if(getViewBox())
                    {
                        // Svg defines that with no width or no height the viewBox content is empty,
                        // so both need to exist
                        if(!basegfx::fTools::equalZero(getViewBox()->getWidth()) && !basegfx::fTools::equalZero(getViewBox()->getHeight()))
                        {
                            // create target range homing x,y, width and height as given
                            const double fX(getX().isSet() ? getX().solve(*this, xcoordinate) : 0.0);
                            const double fY(getY().isSet() ? getY().solve(*this, ycoordinate) : 0.0);
                            const basegfx::B2DRange aTarget(fX, fY, fX + fW, fY + fH);

                            if(aTarget.equal(*getViewBox()))
                            {
                                // no mapping needed, append
                                drawinglayer::primitive2d::appendPrimitive2DSequenceToPrimitive2DSequence(rTarget, aSequence);
                            }
                            else
                            {
                                // create mapping
                                const SvgAspectRatio& rRatio = getSvgAspectRatio();

                                if(rRatio.isSet())
                                {
                                    // let mapping be created from SvgAspectRatio
                                    const basegfx::B2DHomMatrix aEmbeddingTransform(
                                        rRatio.createMapping(aTarget, *getViewBox()));

                                    // prepare embedding in transformation
                                    const drawinglayer::primitive2d::Primitive2DReference xRef(
                                        new drawinglayer::primitive2d::TransformPrimitive2D(
                                            aEmbeddingTransform,
                                            aSequence));

                                    if(rRatio.isMeetOrSlice())
                                    {
                                        // embed in transformation
                                        drawinglayer::primitive2d::appendPrimitive2DReferenceToPrimitive2DSequence(rTarget, xRef);
                                    }
                                    else
                                    {
                                        // need to embed in MaskPrimitive2D, too
                                        const drawinglayer::primitive2d::Primitive2DReference xMask(
                                            new drawinglayer::primitive2d::MaskPrimitive2D(
                                                basegfx::B2DPolyPolygon(basegfx::tools::createPolygonFromRect(aTarget)),
                                                drawinglayer::primitive2d::Primitive2DSequence(&xRef, 1)));

                                        drawinglayer::primitive2d::appendPrimitive2DReferenceToPrimitive2DSequence(rTarget, xMask);
                                    }
                                }
                                else
                                {
                                    // choose default mapping
                                    const basegfx::B2DHomMatrix aEmbeddingTransform(
                                        rRatio.createLinearMapping(
                                            aTarget, *getViewBox()));

                                    // embed in transformation
                                    const drawinglayer::primitive2d::Primitive2DReference xTransform(
                                        new drawinglayer::primitive2d::TransformPrimitive2D(
                                            aEmbeddingTransform,
                                            aSequence));

                                    drawinglayer::primitive2d::appendPrimitive2DReferenceToPrimitive2DSequence(rTarget, xTransform);
                                }
                            }
                        }
                    }
                    else
                    {
                        // Svg defines that a negative value is an error and that 0.0 disables rendering
                        if(basegfx::fTools::more(fW, 0.0) && basegfx::fTools::more(fH, 0.0))
                        {
                            // check if we have a x,y position
                            const double fX(getX().isSet() ? getX().solve(*this, xcoordinate) : 0.0);
                            const double fY(getY().isSet() ? getY().solve(*this, ycoordinate) : 0.0);

                            if(!basegfx::fTools::equalZero(fX) || !basegfx::fTools::equalZero(fY))
                            {
                                // embed in transform
                                const drawinglayer::primitive2d::Primitive2DReference xRef(
                                    new drawinglayer::primitive2d::TransformPrimitive2D(
                                        basegfx::tools::createTranslateB2DHomMatrix(fX, fY),
                                        aSequence));

                                aSequence = drawinglayer::primitive2d::Primitive2DSequence(&xRef, 1);
                            }

                            // embed in MaskPrimitive2D to clip
                            const drawinglayer::primitive2d::Primitive2DReference xMask(
                                new drawinglayer::primitive2d::MaskPrimitive2D(
                                    basegfx::B2DPolyPolygon(
                                        basegfx::tools::createPolygonFromRect(
                                            basegfx::B2DRange(fX, fY, fX + fW, fY + fH))),
                                    aSequence));

                            // append
                            drawinglayer::primitive2d::appendPrimitive2DReferenceToPrimitive2DSequence(rTarget, xMask);
                        }
                    }
                }
                else
                {
                    // Outermost SVG element; create target range homing width and height as given.
                    // SVG defines that x,y has no meaning for the outermost SVG element. Use a fallback
                    // width and height of DIN A 4 (21 x 29,7 cm)
                    double fViewPortW(getWidth().isSet() ? getWidth().solve(*this, xcoordinate) : (210.0 * 3.543307));
                    double fViewPortH(getHeight().isSet() ? getHeight().solve(*this, ycoordinate) : (297.0 * 3.543307));
                    basegfx::B2DRange aSvgCanvasRange(0.0, 0.0, 0.0, 0.0);

                    // Svg defines that a negative value is an error and that 0.0 disables rendering
                    if(basegfx::fTools::more(fViewPortW, 0.0) && basegfx::fTools::more(fViewPortH, 0.0))
                    {
                        basegfx::B2DRange aContentRange; // ViewBox or bounding box
                        if(getViewBox())
                        {
                            aContentRange = *getViewBox();
                        }
                        else    // no ViewBox given -> get bounding box  TODO: ignore preserveAspectRatio i.e. set to default?
                        {
                            aContentRange = drawinglayer::primitive2d::getB2DRangeFromPrimitive2DSequence(aSequence, drawinglayer::geometry::ViewInformation2D());
                        }
                        double fW(aContentRange.getWidth());
                        double fH(aContentRange.getHeight());

                        if(!basegfx::fTools::equalZero(fW) && !basegfx::fTools::equalZero(fH))
                        {
                            const SvgAspectRatio& rRatio = getSvgAspectRatio();
                            double fScale = std::min(fViewPortW/fW, fViewPortH/fH);
                            fW *= fScale;
                            fH *= fScale;
                            aSvgCanvasRange = basegfx::B2DRange(0.0, 0.0, fW, fH);

                            // let mapping be created from SvgAspectRatio
                            basegfx::B2DHomMatrix aViewBoxMapping;
                            aViewBoxMapping = rRatio.createMapping(aSvgCanvasRange, aContentRange);

                            // no need to check ratio here for slice, the outermost Svg will
                            // be clipped anyways (see below)

                            // scale content to viewBox definitions
                            const drawinglayer::primitive2d::Primitive2DReference xTransform(
                                     new drawinglayer::primitive2d::TransformPrimitive2D(
                                     aViewBoxMapping,
                                     aSequence));

                            aSequence = drawinglayer::primitive2d::Primitive2DSequence(&xTransform, 1);
                        }
                    }
                    // to be completely correct in Svg sense it is necessary to clip
                    // the whole content to the given canvas. I choose here to do this
                    // initially despite I found various examples of Svg files out there
                    // which have no correct values for this clipping. It's correct
                    // due to the Svg spec.
                    bool bDoCorrectCanvasClipping(true);

                    if(bDoCorrectCanvasClipping)
                    {
                        // different from Svg we have the possibility with primitives to get
                        // a correct bounding box for the geometry. Get it for evtl. taking action
                        const basegfx::B2DRange aContentRange(
                            drawinglayer::primitive2d::getB2DRangeFromPrimitive2DSequence(
                                aSequence,
                                drawinglayer::geometry::ViewInformation2D()));

                        if(aSvgCanvasRange.isInside(aContentRange))
                        {
                            // no clip needed, but an invisible HiddenGeometryPrimitive2D
                            // to allow getting the full Svg range using the primitive mechanisms.
                            // This is needed since e.g. an SdrObject using this as graphic will
                            // create a mapping transformation to exactly map the content to it's
                            // real life size
                            const drawinglayer::primitive2d::Primitive2DReference xLine(
                                new drawinglayer::primitive2d::PolygonHairlinePrimitive2D(
                                    basegfx::tools::createPolygonFromRect( aSvgCanvasRange),
                                    basegfx::BColor(0.0, 0.0, 0.0)));
                            const drawinglayer::primitive2d::Primitive2DReference xHidden(
                                new drawinglayer::primitive2d::HiddenGeometryPrimitive2D(
                                    drawinglayer::primitive2d::Primitive2DSequence(&xLine, 1)));

                            drawinglayer::primitive2d::appendPrimitive2DReferenceToPrimitive2DSequence(aSequence, xHidden);
                        }
                        else if(aSvgCanvasRange.overlaps(aContentRange))
                        {
                            // Clip is necessary. This will make Svg images evtl. smaller
                            // than wanted from Svg (the free space which may be around it is
                            // conform to the Svg spec), but avoids an expensive and unneccessary
                            // clip. Keep the full Svg range here to get the correct mappings
                            // to objects using this. Optimizations can be done in the processors
                            const drawinglayer::primitive2d::Primitive2DReference xMask(
                                new drawinglayer::primitive2d::MaskPrimitive2D(
                                    basegfx::B2DPolyPolygon(basegfx::tools::createPolygonFromRect(aSvgCanvasRange)),
                                    aSequence));

                            aSequence = drawinglayer::primitive2d::Primitive2DSequence(&xMask, 1);
                        }
                        else
                        {
                            // not inside, no overlap. Empty Svg
                            aSequence.realloc(0);
                        }
                    }

                    if(aSequence.hasElements())
                    {
                        // embed in transform primitive to scale to 1/100th mm
                        // where 1 mm == 3.543307 px to get from Svg coordinates to
                        // drawinglayer ones
                        const double fScaleTo100thmm(100.0 / 3.543307);
                        const basegfx::B2DHomMatrix aTransform(
                            basegfx::tools::createScaleB2DHomMatrix(
                                fScaleTo100thmm,
                                fScaleTo100thmm));

                        const drawinglayer::primitive2d::Primitive2DReference xTransform(
                            new drawinglayer::primitive2d::TransformPrimitive2D( aTransform, aSequence));

                        aSequence = drawinglayer::primitive2d::Primitive2DSequence(&xTransform, 1);

                        // append to result
                        drawinglayer::primitive2d::appendPrimitive2DSequenceToPrimitive2DSequence(rTarget, aSequence);
                    }
                }
            }
        }

        const basegfx::B2DRange* SvgSvgNode::getCurrentViewPort() const
        {
            if(getViewBox())
            {
                return getViewBox();
            }
            else
            {
                return SvgNode::getCurrentViewPort();
            }
        }

    } // end of namespace svgreader
} // end of namespace svgio

//////////////////////////////////////////////////////////////////////////////
// eof

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */