include/vcl/vectorgraphicdata.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_VCL_VECTORGRAPHICDATA_HXX
  21 #define INCLUDED_VCL_VECTORGRAPHICDATA_HXX
  22
  23 #include <basegfx/range/b2drange.hxx>
  24 #include <com/sun/star/uno/Sequence.hxx>
  25 #include <vcl/bitmapex.hxx>
  26 #include <rtl/ustring.hxx>
  27 #include <deque>
  28 #include <memory>
  29 #include <algorithm>
  30
  31 namespace com { namespace sun { namespace star { namespace graphic { class XPrimitive2D; } } } }
  32 struct WmfExternal;
  33
  34 typedef css::uno::Sequence<sal_Int8> VectorGraphicDataArray;
  35
  36
  37 // helper to convert any Primitive2DSequence to a good quality BitmapEx,
  38 // using default parameters and graphic::XPrimitive2DRenderer
  39
  40 BitmapEx VCL_DLLPUBLIC convertPrimitive2DSequenceToBitmapEx(
  41     const std::deque< css::uno::Reference< css::graphic::XPrimitive2D > >& rSequence,
  42     const basegfx::B2DRange& rTargetRange,
  43     const sal_uInt32 nMaximumQuadraticPixels = 500000);
  44
  45
  46 enum class VectorGraphicDataType
  47 {
  48     Svg = 0,
  49     Emf = 1,
  50     Wmf = 2,
  51     Pdf = 3
  52 };
  53
  54 class VCL_DLLPUBLIC VectorGraphicData
  55 {
  56 private:
  57     // the file and length
  58     VectorGraphicDataArray      maVectorGraphicDataArray;
  59
  60     // The absolute Path if available
  61     OUString const              maPath;
  62
  63     // on demand created content
  64     bool                        mbSequenceCreated;
  65     basegfx::B2DRange           maRange;
  66     std::deque< css::uno::Reference< css::graphic::XPrimitive2D > > maSequence;
  67     BitmapEx                    maReplacement;
  68     size_t                      mNestedBitmapSize;
  69     VectorGraphicDataType const meVectorGraphicDataType;
  70
  71     // extra:
  72     std::unique_ptr<WmfExternal> mpExternalHeader;
  73
  74     // If the vector format has more pages this denotes which page to render
  75     sal_Int32 mnPageIndex;
  76
  77     /// Useful for PDF, which is vector-based, but still rendered to a bitmap.
  78     basegfx::B2DTuple maSizeHint;
  79
  80     // on demand creators
  81     void ensurePdfReplacement();
  82     void ensureReplacement();
  83     void ensureSequenceAndRange();
  84
  85     VectorGraphicData(const VectorGraphicData&) = delete;
  86     VectorGraphicData& operator=(const VectorGraphicData&) = delete;
  87
  88 public:
  89     VectorGraphicData(
  90         const VectorGraphicDataArray& rVectorGraphicDataArray,
  91         const OUString& rPath,
  92         VectorGraphicDataType eVectorDataType,
  93         sal_Int32 nPageIndex = -1);
  94     VectorGraphicData(const OUString& rPath, VectorGraphicDataType eVectorDataType);
  95     ~VectorGraphicData();
  96
  97     /// compare op
  98     bool operator==(const VectorGraphicData& rCandidate) const;
  99
 100     /// special: needed for emf/wmf, maybe replaced by scaling the result later (?)
 101     void setWmfExternalHeader(const WmfExternal& aExtHeader);
 102
 103     /// data read
 104     const VectorGraphicDataArray& getVectorGraphicDataArray() const { return maVectorGraphicDataArray; }
 105     sal_uInt32 getVectorGraphicDataArrayLength() const { return maVectorGraphicDataArray.getLength(); }
 106     enum class State { UNPARSED, PARSED };
 107     std::pair<State, size_t> getSizeBytes() const;
 108     const OUString& getPath() const { return maPath; }
 109     const VectorGraphicDataType& getVectorGraphicDataType() const { return meVectorGraphicDataType; }
 110
 111     /// data read and evtl. on demand creation
 112     const basegfx::B2DRange& getRange() const;
 113     const std::deque< css::uno::Reference< css::graphic::XPrimitive2D > >& getPrimitive2DSequence() const;
 114     const BitmapEx& getReplacement() const;
 115     BitmapChecksum GetChecksum() const;
 116
 117     sal_Int32 getPageIndex() const { return std::max(sal_Int32(0), mnPageIndex); }
 118
 119     void setPageIndex(sal_Int32 nPageIndex)
 120     {
 121         mnPageIndex = nPageIndex;
 122     }
 123
 124     void setSizeHint(const basegfx::B2DTuple& rSizeHint)
 125     {
 126         maSizeHint = rSizeHint;
 127     }
 128
 129     const basegfx::B2DTuple& getSizeHint() const { return maSizeHint; }
 130
 131     bool isPrimitiveSequenceCreated() const { return mbSequenceCreated; }
 132 };
 133
 134 typedef std::shared_ptr< VectorGraphicData > VectorGraphicDataPtr;
 135
 136 #endif // INCLUDED_VCL_VECTORGRAPHICDATA_HXX
 137
 138 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */