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

#define INCLUDED_XMLOFF_SHAPEEXPORT_HXX

#include <sal/config.h>

#include <xmloff/dllapi.h>

#include <sal/types.h>

#include <rtl/ref.hxx>

#include <rtl/ustring.hxx>

#include <rtl/ustrbuf.hxx>

#include <salhelper/simplereferenceobject.hxx>

#include <functional>

#include <map>

#include <xmloff/animexp.hxx>

#include <xmloff/families.hxx>

#include <xmloff/txtparae.hxx>

#include <o3tl/typed_flags_set.hxx>

namespace com::sun::star::awt { struct Point; }

namespace com::sun::star::beans { class XPropertySet; }

namespace com::sun::star::drawing { class XShape; }

namespace com::sun::star::drawing { class XShapes; }

namespace com::sun::star::lang { class XComponent; }

class XMLTableExport;

namespace comphelper { class AttributeList; }

// shape export features are bits used for the nFeature

// parameter of XMLShapeExport::exportShape

enum class XMLShapeExportFlags {

     NONE     = 0,

     X        = 0x0001,

     Y        = 0x0002,

     POSITION = 0x0003,

     WIDTH    = 0x0004,

     HEIGHT   = 0x0008,

     SIZE     = WIDTH | HEIGHT,

// When setting the flag below no ignorableWhiteSpace will be called around

// the drawing object elements

     NO_WS    = 0x0020,

// When setting the flag below a callout shape is exported as office:annotation

     ANNOTATION = 0x0040,

};

namespace o3tl

{

    template<> struct typed_flags<XMLShapeExportFlags> : is_typed_flags<XMLShapeExportFlags, 0x6f> {};

}

#define SEF_DEFAULT         XMLShapeExportFlags::POSITION|XMLShapeExportFlags::SIZE

enum class XmlShapeType

{

    Unknown,                            // not known

    DrawRectangleShape,                 // "com.sun.star.drawing.RectangleShape"

    DrawEllipseShape,                   // "com.sun.star.drawing.EllipseShape"

    DrawControlShape,                   // "com.sun.star.drawing.ControlShape"

    DrawConnectorShape,                 // "com.sun.star.drawing.ConnectorShape"

    DrawMeasureShape,                   // "com.sun.star.drawing.MeasureShape"

    DrawLineShape,                      // "com.sun.star.drawing.LineShape"

    DrawPolyPolygonShape,               // "com.sun.star.drawing.PolyPolygonShape"

    DrawPolyLineShape,                  // "com.sun.star.drawing.PolyLineShape"

    DrawOpenBezierShape,                // "com.sun.star.drawing.OpenBezierShape"

    DrawClosedBezierShape,              // "com.sun.star.drawing.ClosedBezierShape"

    DrawGraphicObjectShape,             // "com.sun.star.drawing.GraphicObjectShape"

    DrawGroupShape,                     // "com.sun.star.drawing.GroupShape"

    DrawTextShape,                      // "com.sun.star.drawing.TextShape"

    DrawOLE2Shape,                      // "com.sun.star.drawing.OLE2Shape"

    DrawChartShape,                     // embedded com.sun.star.chart

    DrawSheetShape,                     // embedded com.sun.star.sheet

    DrawPageShape,                      // "com.sun.star.drawing.PageShape"

    DrawFrameShape,                     // "com.sun.star.drawing.FrameShape"

    DrawCaptionShape,                   // "com.sun.star.drawing.CaptionShape"

    DrawAppletShape,                    // "com.sun.star.drawing.AppletShape"

    DrawPluginShape,                    // "com.sun.star.drawing.PlugginShape"

    Draw3DSceneObject,                  // "com.sun.star.drawing.Shape3DSceneObject"

    Draw3DCubeObject,                   // "com.sun.star.drawing.Shape3DCubeObject"

    Draw3DSphereObject,                 // "com.sun.star.drawing.Shape3DSphereObject"

    Draw3DLatheObject,                  // "com.sun.star.drawing.Shape3DLatheObject"

    Draw3DExtrudeObject,                // "com.sun.star.drawing.Shape3DExtrudeObject"

    PresTitleTextShape,                 // "com.sun.star.presentation.TitleTextShape"

    PresOutlinerShape,                  // "com.sun.star.presentation.OutlinerShape"

    PresSubtitleShape,                  // "com.sun.star.presentation.SubtitleShape"

    PresGraphicObjectShape,             // "com.sun.star.presentation.GraphicObjectShape"

    PresPageShape,                      // "com.sun.star.presentation.PageShape"

    PresOLE2Shape,                      // "com.sun.star.presentation.OLE2Shape"

    PresChartShape,                     // "com.sun.star.presentation.ChartShape"

    PresSheetShape,                     // "com.sun.star.presentation.CalcShape"

    PresTableShape,                     // "com.sun.star.presentation.TableShape"

    PresOrgChartShape,                  // "com.sun.star.presentation.OrgChartShape"

    PresNotesShape,                     // "com.sun.star.presentation.NotesShape"

    HandoutShape,                       // "com.sun.star.presentation.HandoutShape"

    PresHeaderShape,                    // "com.sun.star.presentation.HeaderShape"

    PresFooterShape,                    // "com.sun.star.presentation.FooterShape"

    PresSlideNumberShape,               // "com.sun.star.presentation.SlideNumberShape"

    PresDateTimeShape,                  // "com.sun.star.presentation.DateTimeShape"

    DrawCustomShape,                    // "com.sun.star.drawing.CustomShape"

    DrawMediaShape,                     // "com.sun.star.drawing.MediaShape"

    PresMediaShape,                     // "com.sun.star.presentation.MediaShape"

    DrawTableShape,                     // "com.sun.star.drawing.TableShape"

    NotYetSet

};

/** caches style and type info after a collectShapeAutostyle for later use in exportShape */

struct ImplXMLShapeExportInfo

{

    OUString   msStyleName;

    OUString   msTextStyleName;

    XmlStyleFamily  mnFamily;

    XmlShapeType    meShapeType;

    css::uno::Reference< css::drawing::XShape > xCustomShapeReplacement;

    css::uno::Reference<css::lang::XComponent> xPDFModelReplacement;

    ImplXMLShapeExportInfo() : mnFamily( XmlStyleFamily::SD_GRAPHICS_ID ), meShapeType( XmlShapeType::NotYetSet ) {}

};

/** a vector for shape style and type cache information */

typedef std::map< css::uno::Reference< css::drawing::XShape >, ImplXMLShapeExportInfo > ShapeExportInfoMap;

/** a map to store all cache data for already collected XShapes */

typedef std::map< css::uno::Reference < css::drawing::XShapes >, ShapeExportInfoMap > ShapesInfos;

class SvXMLExport;

class SvXMLExportPropertyMapper;

namespace basegfx

{

    class B2DTuple;

    class B2DHomMatrix;

}

class XMLOFF_DLLPUBLIC XMLShapeExport : public salhelper::SimpleReferenceObject

{

private:

    SvXMLExport&                                mrExport;

    rtl::Reference< SvXMLExportPropertyMapper >   mxPropertySetMapper;

    rtl::Reference< XMLAnimationsExporter >       mxAnimationsExporter;

    ShapesInfos                                 maShapesInfos;

    ShapesInfos::iterator                       maCurrentShapesIter;

    bool                                        mbExportLayer;

    OUString                                    msPresentationStylePrefix;

    // #88546# possibility to switch progress bar handling on/off

    bool                                        mbHandleProgressBar;

    rtl::Reference< XMLTableExport >            mxShapeTableExport;

protected:

    SvXMLExport& GetExport() { return mrExport; }

    const SvXMLExport& GetExport() const  { return mrExport; }

private:

    SAL_DLLPRIVATE const rtl::Reference< SvXMLExportPropertyMapper >& GetPropertySetMapper() const { return mxPropertySetMapper; }

    OUStringBuffer msBuffer;

    SAL_DLLPRIVATE void ImpCalcShapeType(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType& eShapeType);

    SAL_DLLPRIVATE void ImpExportNewTrans(const css::uno::Reference< css::beans::XPropertySet >& xPropSet, XMLShapeExportFlags nFeatures, css::awt::Point* pRefPoint);

    SAL_DLLPRIVATE void ImpExportNewTrans_GetB2DHomMatrix(::basegfx::B2DHomMatrix& rMatrix, const css::uno::Reference< css::beans::XPropertySet >& xPropSet);

    SAL_DLLPRIVATE static void ImpExportNewTrans_DecomposeAndRefPoint(const ::basegfx::B2DHomMatrix& rMat, ::basegfx::B2DTuple& rTRScale, double& fTRShear, double& fTRRotate, ::basegfx::B2DTuple& rTRTranslate, css::awt::Point* pRefPoint);

    SAL_DLLPRIVATE void ImpExportNewTrans_FeaturesAndWrite(::basegfx::B2DTuple const & rTRScale, double fTRShear, double fTRRotate, ::basegfx::B2DTuple const & rTRTranslate, const XMLShapeExportFlags nFeatures);

    SAL_DLLPRIVATE bool ImpExportPresentationAttributes( const css::uno::Reference< css::beans::XPropertySet >& xPropSet, const OUString& rClass );

    SAL_DLLPRIVATE void ImpExportText( const css::uno::Reference< css::drawing::XShape >& xShape, TextPNS eExtensionNS = TextPNS::ODF );

    SAL_DLLPRIVATE void ImpExportEvents( const css::uno::Reference< css::drawing::XShape >& xShape );

    SAL_DLLPRIVATE void ImpExportDescription( const css::uno::Reference< css::drawing::XShape >& xShape ); // #i68101#

    SAL_DLLPRIVATE void ImpExportGluePoints( const css::uno::Reference< css::drawing::XShape >& xShape );

    SAL_DLLPRIVATE void ImpExportSignatureLine(const css::uno::Reference<css::drawing::XShape>& xShape);

    SAL_DLLPRIVATE void ImpExportQRCode(const css::uno::Reference<css::drawing::XShape>& xShape);

    // single shape exporters

    SAL_DLLPRIVATE void ImpExportGroupShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExport3DSceneShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportRectangleShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportLineShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportEllipseShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportPolygonShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportTextBoxShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportGraphicObjectShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportChartShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr, comphelper::AttributeList* pAttrList = nullptr );

    SAL_DLLPRIVATE void ImpExportControlShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT,  css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportConnectorShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportMeasureShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT,  css::awt::Point const * pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportOLE2Shape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr, comphelper::AttributeList* pAttrList = nullptr );

    SAL_DLLPRIVATE void ImpExportPageShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportCaptionShape(const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExport3DShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType );

    SAL_DLLPRIVATE void ImpExportFrameShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportPluginShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportAppletShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportCustomShape( const css::uno::Reference< css::drawing::XShape >& xShape, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportMediaShape( const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT, css::awt::Point* pRefPoint = nullptr );

    SAL_DLLPRIVATE void ImpExportTableShape(const css::uno::Reference< css::drawing::XShape >& xShape, XmlShapeType eShapeType, XMLShapeExportFlags nFeatures = SEF_DEFAULT,    css::awt::Point* pRefPoint = nullptr );

public:

    XMLShapeExport(SvXMLExport& rExp, SvXMLExportPropertyMapper *pExtMapper=nullptr );

    virtual ~XMLShapeExport() override;

    // This method collects all automatic styles for the given XShape

    void collectShapeAutoStyles(

        const css::uno::Reference < css::drawing::XShape >& xShape);

    // This method exports the given XShape

    void exportShape(

        const css::uno::Reference < css::drawing::XShape >& xShape,

        XMLShapeExportFlags nFeatures = SEF_DEFAULT,

        css::awt::Point* pRefPoint = nullptr,

        comphelper::AttributeList* pAttrList = nullptr

        );

    // This method collects all automatic styles for the shapes inside the given XShapes collection

    void collectShapesAutoStyles(

        const css::uno::Reference < css::drawing::XShapes >& xShapes);

    // This method exports all XShape inside the given XShapes collection

    void exportShapes(

        const css::uno::Reference < css::drawing::XShapes >& xShapes,

        XMLShapeExportFlags nFeatures = SEF_DEFAULT,

        css::awt::Point* pRefPoint = nullptr

        );

    /** initializes some internal structures for fast access to the given XShapes collection

        <p>This method has to be called before you use exportShape or collectShapeAutoStyles.

        It is automatically called if you use collectShapesAutoStyles and exportShapes.

        @see collectShapeAutoStyles

        @see exportShape

        @see collectShapesAutoStyles

        @see exportShapes

    */

    void seekShapes(

        const css::uno::Reference< css::drawing::XShapes >& xShapes ) noexcept;

    void exportAutoStyles();

    /** sets a new reference to an XMLAnimationExporter.

        If this is a non NULL reference, the animation information from all shapes given to exportShape()

        from now on are collected.

    */

    void setAnimationsExporter( rtl::Reference< XMLAnimationsExporter > const & xAnimExport ) { mxAnimationsExporter = xAnimExport; }

    /** returns the last set XMLAnimationExport */

    const rtl::Reference< XMLAnimationsExporter >& getAnimationsExporter() const { return mxAnimationsExporter; }

    /// returns the export property mapper for external chaining

    static SvXMLExportPropertyMapper* CreateShapePropMapper( SvXMLExport& rExport );

    void enableLayerExport() { mbExportLayer = true; }

    /** defines if the export should increment the progress bar or not */

    void enableHandleProgressBar() { mbHandleProgressBar = true; }

    bool IsHandleProgressBarEnabled() const { return mbHandleProgressBar; }

    void setPresentationStylePrefix( const OUString& rPrefix ) { msPresentationStylePrefix = rPrefix; }

    /** helper for chart that adds all attributes of a 3d scene element to the export */

    void export3DSceneAttributes( const css::uno::Reference< css::beans::XPropertySet >& xPropSet );

    /** helper for chart that exports all lamps from the propertyset */

    void export3DLamps( const css::uno::Reference< css::beans::XPropertySet >& xPropSet );

    /** sj: replacing CustomShapes with standard objects that are also supported in OpenOffice.org format */

    css::uno::Reference < css::drawing::XShape > checkForCustomShapeReplacement(

        const css::uno::Reference < css::drawing::XShape >& );

    /** replacing PDF with drawing objects */

    css::uno::Reference<css::lang::XComponent> checkForPDFShapeReplacement(

        const css::uno::Reference<css::drawing::XShape>& xShape);

    /** helper to export the style for graphic defaults */

    void ExportGraphicDefaults();

    /** is called before a shape element for the given XShape is exported */

    virtual void onExport( const css::uno::Reference < css::drawing::XShape >& xShape );

    const rtl::Reference< XMLTableExport >&     GetShapeTableExport();

};

namespace xmloff {

XMLOFF_DLLPUBLIC void FixZOrder(

    css::uno::Reference<css::drawing::XShapes> const& xShapes,

    std::function<unsigned int (css::uno::Reference<css::beans::XPropertySet> const&)> const& rGetLayer);

} // namespace xmloff

#endif

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