/* -*- 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 .

 */

#ifndef INCLUDED_VCL_VECTORGRAPHICDATA_HXX

#define INCLUDED_VCL_VECTORGRAPHICDATA_HXX

#include <basegfx/range/b2drange.hxx>

#include <vcl/bitmap.hxx>

#include <vcl/BinaryDataContainer.hxx>

#include <rtl/ustring.hxx>

#include <deque>

#include <algorithm>

#include <optional>

namespace com::sun::star::graphic { class XPrimitive2D; }

// helper to convert any Primitive2DSequence to a good quality Bitmap,

// using default parameters and graphic::XPrimitive2DRenderer

Bitmap VCL_DLLPUBLIC convertPrimitive2DSequenceToBitmap(

    const std::deque< css::uno::Reference< css::graphic::XPrimitive2D > >& rSequence,

    const basegfx::B2DRange& rTargetRange,

    const sal_uInt32 nMaximumQuadraticPixels = 500000,

    const o3tl::Length eTargetUnit = o3tl::Length::mm100,

    const std::optional<Size>& rTargetDPI = std::nullopt);

enum class VectorGraphicDataType

{

    Svg = 0,

    Emf = 1,

    Wmf = 2,

    Pdf = 3

};

class VCL_DLLPUBLIC VectorGraphicData

{

private:

    // the file and length

    BinaryDataContainer maDataContainer;

    // on demand created content

    bool                        mbSequenceCreated;

    basegfx::B2DRange           maRange;

    std::deque< css::uno::Reference< css::graphic::XPrimitive2D > > maSequence;

    Bitmap                      maReplacement;

    size_t                      mNestedBitmapSize;

    VectorGraphicDataType meType;

    /// If the vector format has more pages this denotes which page to render

    sal_Int32 mnPageIndex;

    /// Useful for PDF, which is vector-based, but still rendered to a bitmap.

    basegfx::B2DTuple maSizeHint;

    bool mbEnableEMFPlus = true;

    // on demand creators

    void ensurePdfReplacement();

    void ensureReplacement();

    void ensureSequenceAndRange();

    VectorGraphicData(const VectorGraphicData&) = delete;

    VectorGraphicData& operator=(const VectorGraphicData&) = delete;

public:

    VectorGraphicData(

        BinaryDataContainer aDataContainer,

        VectorGraphicDataType eVectorDataType,

        sal_Int32 nPageIndex = -1);

    ~VectorGraphicData();

    /// compare op

    bool operator==(const VectorGraphicData& rCandidate) const;

    /// data read

    const BinaryDataContainer& getBinaryDataContainer() const

    {

        return maDataContainer;

    }

    enum class State { UNPARSED, PARSED };

    std::pair<State, size_t> getSizeBytes() const;

    const VectorGraphicDataType& getType() const { return meType; }

    /// data read and evtl. on demand creation

    const basegfx::B2DRange& getRange() const;

    const std::deque<css::uno::Reference<css::graphic::XPrimitive2D>>& getPrimitive2DSequence() const;

    Bitmap getBitmap(const Size& pixelSize) const;

    const Bitmap& getReplacement() const;

    BitmapChecksum GetChecksum() const;

    sal_Int32 getPageIndex() const

    {

        return std::max(sal_Int32(0), mnPageIndex);

    }

    void setPageIndex(sal_Int32 nPageIndex)

    {

        mnPageIndex = nPageIndex;

    }

    void setSizeHint(const basegfx::B2DTuple& rSizeHint)

    {

        maSizeHint = rSizeHint;

    }

    const basegfx::B2DTuple& getSizeHint() const { return maSizeHint; }

    void setEnableEMFPlus(bool bEnableEMFPlus) { mbEnableEMFPlus = bEnableEMFPlus; }

    bool isPrimitiveSequenceCreated() const { return mbSequenceCreated; }

};

#endif // INCLUDED_VCL_VECTORGRAPHICDATA_HXX

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