include/xmloff/shapeimport.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_XMLOFF_SHAPEIMPORT_HXX
  21 #define INCLUDED_XMLOFF_SHAPEIMPORT_HXX
  22
  23 #include <sal/config.h>
  24 #include <xmloff/dllapi.h>
  25 #include <com/sun/star/beans/XPropertySet.hpp>
  26 #include <com/sun/star/frame/XModel.hpp>
  27 #include <com/sun/star/xml/sax/XAttributeList.hpp>
  28 #include <com/sun/star/drawing/XShapes.hpp>
  29 #include <com/sun/star/drawing/HomogenMatrix.hpp>
  30 #include <com/sun/star/drawing/ProjectionMode.hpp>
  31 #include <com/sun/star/drawing/ShadeMode.hpp>
  32 #include <salhelper/simplereferenceobject.hxx>
  33 #include <xmloff/xmlictxt.hxx>
  34
  35 #include <xmloff/table/XMLTableImport.hxx>
  36 #include <basegfx/vector/b3dvector.hxx>
  37 #include <vector>
  38 #include <memory>
  39
  40 class SvXMLImport;
  41 class SvXMLImportContext;
  42 class SvXMLTokenMap;
  43 class SvXMLStylesContext;
  44 class XMLSdPropHdlFactory;
  45 class XMLPropertySetMapper;
  46 class SvXMLImportPropertyMapper;
  47
  48
  49 enum SdXMLGroupShapeElemTokenMap
  50 {
  51     XML_TOK_GROUP_GROUP,
  52     XML_TOK_GROUP_RECT,
  53     XML_TOK_GROUP_LINE,
  54     XML_TOK_GROUP_CIRCLE,
  55     XML_TOK_GROUP_ELLIPSE,
  56     XML_TOK_GROUP_POLYGON,
  57     XML_TOK_GROUP_POLYLINE,
  58     XML_TOK_GROUP_PATH,
  59
  60     XML_TOK_GROUP_CONTROL,
  61     XML_TOK_GROUP_CONNECTOR,
  62     XML_TOK_GROUP_MEASURE,
  63     XML_TOK_GROUP_PAGE,
  64     XML_TOK_GROUP_CAPTION,
  65
  66     XML_TOK_GROUP_CHART,
  67     XML_TOK_GROUP_3DSCENE,
  68
  69     XML_TOK_GROUP_FRAME,
  70
  71     XML_TOK_GROUP_CUSTOM_SHAPE,
  72
  73     XML_TOK_GROUP_ANNOTATION,
  74
  75     XML_TOK_GROUP_A,
  76
  77     XML_TOK_GROUP_LAST
  78 };
  79
  80 enum SdXMLFrameShapeElemTokenMap
  81 {
  82     XML_TOK_FRAME_TEXT_BOX,
  83     XML_TOK_FRAME_IMAGE,
  84     XML_TOK_FRAME_OBJECT,
  85     XML_TOK_FRAME_OBJECT_OLE,
  86     XML_TOK_FRAME_PLUGIN,
  87     XML_TOK_FRAME_FRAME,
  88     XML_TOK_FRAME_FLOATING_FRAME,
  89     XML_TOK_FRAME_APPLET,
  90     XML_TOK_FRAME_TABLE,
  91
  92     XML_TOK_FRAME_LAST
  93 };
  94
  95 enum SdXML3DSceneShapeElemTokenMap
  96 {
  97     XML_TOK_3DSCENE_3DSCENE,
  98     XML_TOK_3DSCENE_3DCUBE,
  99     XML_TOK_3DSCENE_3DSPHERE,
 100     XML_TOK_3DSCENE_3DLATHE,
 101     XML_TOK_3DSCENE_3DEXTRUDE,
 102
 103     XML_TOK_3DSCENE_LAST
 104 };
 105
 106 enum SdXMLShapeAttrTokenMap
 107 {
 108     XML_TOK_SHAPE_NAME,
 109     XML_TOK_SHAPE_DRAWSTYLE_NAME_GRAPHICS,
 110     XML_TOK_SHAPE_PRESENTATION_CLASS,
 111     XML_TOK_SHAPE_DRAWSTYLE_NAME_PRESENTATION,
 112     XML_TOK_SHAPE_TRANSFORM,
 113     XML_TOK_SHAPE_IS_PLACEHOLDER,
 114     XML_TOK_SHAPE_IS_USER_TRANSFORMED
 115 };
 116
 117 enum SdXML3DObjectAttrTokenMap
 118 {
 119     XML_TOK_3DOBJECT_DRAWSTYLE_NAME,
 120     XML_TOK_3DOBJECT_TRANSFORM
 121 };
 122
 123 enum SdXML3DPolygonBasedAttrTokenMap
 124 {
 125     XML_TOK_3DPOLYGONBASED_VIEWBOX,
 126     XML_TOK_3DPOLYGONBASED_D
 127 };
 128
 129 enum SdXML3DCubeObjectAttrTokenMap
 130 {
 131     XML_TOK_3DCUBEOBJ_MINEDGE,
 132     XML_TOK_3DCUBEOBJ_MAXEDGE
 133 };
 134
 135 enum SdXML3DSphereObjectAttrTokenMap
 136 {
 137     XML_TOK_3DSPHEREOBJ_CENTER,
 138     XML_TOK_3DSPHEREOBJ_SIZE
 139 };
 140
 141 enum SdXMLPolygonShapeAttrTokenMap
 142 {
 143     XML_TOK_POLYGONSHAPE_VIEWBOX,
 144     XML_TOK_POLYGONSHAPE_POINTS
 145 };
 146
 147 enum SdXMLPathShapeAttrTokenMap
 148 {
 149     XML_TOK_PATHSHAPE_VIEWBOX,
 150     XML_TOK_PATHSHAPE_D
 151 };
 152
 153 enum SdXML3DSceneShapeAttrTokenMap
 154 {
 155     XML_TOK_3DSCENESHAPE_TRANSFORM,
 156     XML_TOK_3DSCENESHAPE_VRP,
 157     XML_TOK_3DSCENESHAPE_VPN,
 158     XML_TOK_3DSCENESHAPE_VUP,
 159     XML_TOK_3DSCENESHAPE_PROJECTION,
 160     XML_TOK_3DSCENESHAPE_DISTANCE,
 161     XML_TOK_3DSCENESHAPE_FOCAL_LENGTH,
 162     XML_TOK_3DSCENESHAPE_SHADOW_SLANT,
 163     XML_TOK_3DSCENESHAPE_SHADE_MODE,
 164     XML_TOK_3DSCENESHAPE_AMBIENT_COLOR,
 165     XML_TOK_3DSCENESHAPE_LIGHTING_MODE
 166 };
 167
 168 enum SdXML3DLightAttrTokenMap
 169 {
 170     XML_TOK_3DLIGHT_DIFFUSE_COLOR,
 171     XML_TOK_3DLIGHT_DIRECTION,
 172     XML_TOK_3DLIGHT_ENABLED,
 173     XML_TOK_3DLIGHT_SPECULAR
 174 };
 175
 176
 177 // dr3d:3dlight context
 178
 179 class SdXML3DLightContext: public SvXMLImportContext
 180 {
 181     // local parameters which need to be read
 182     sal_Int32                   maDiffuseColor;
 183     ::basegfx::B3DVector        maDirection;
 184     bool                        mbEnabled;
 185     bool                        mbSpecular;
 186
 187 public:
 188     SdXML3DLightContext(
 189         SvXMLImport& rImport,
 190         sal_uInt16 nPrfx,
 191         const OUString& rLName,
 192         const css::uno::Reference< css::xml::sax::XAttributeList >& xAttrList);
 193     virtual ~SdXML3DLightContext() override;
 194
 195     sal_Int32 GetDiffuseColor() { return maDiffuseColor; }
 196     const ::basegfx::B3DVector& GetDirection() { return maDirection; }
 197     bool GetEnabled() { return mbEnabled; }
 198 };
 199
 200
 201 class SdXML3DSceneAttributesHelper
 202 {
 203 protected:
 204     SvXMLImport& mrImport;
 205
 206     // list for local light contexts
 207     ::std::vector< rtl::Reference< SdXML3DLightContext > >
 208                                 maList;
 209
 210     // local parameters which need to be read
 211     css::drawing::HomogenMatrix mxHomMat;
 212     bool                        mbSetTransform;
 213
 214     css::drawing::ProjectionMode mxPrjMode;
 215     sal_Int32                   mnDistance;
 216     sal_Int32                   mnFocalLength;
 217     sal_Int32                   mnShadowSlant;
 218     css::drawing::ShadeMode     mxShadeMode;
 219     sal_Int32                   maAmbientColor;
 220     bool                        mbLightingMode;
 221
 222     ::basegfx::B3DVector        maVRP;
 223     ::basegfx::B3DVector        maVPN;
 224     ::basegfx::B3DVector        maVUP;
 225     bool                        mbVRPUsed;
 226     bool                        mbVPNUsed;
 227     bool                        mbVUPUsed;
 228
 229 public:
 230     SdXML3DSceneAttributesHelper( SvXMLImport& rImporter );
 231
 232     /** creates a 3d light context and adds it to the internal list for later processing */
 233     SvXMLImportContext * create3DLightContext( sal_uInt16 nPrfx, const OUString& rLName, const css::uno::Reference< css::xml::sax::XAttributeList >& xAttrList);
 234
 235     /** this should be called for each scene attribute */
 236     void processSceneAttribute( sal_uInt16 nPrefix, const OUString& rLocalName, const OUString& rValue );
 237
 238     /** this sets the scene attributes at this propertyset */
 239     void setSceneAttributes( const css::uno::Reference< css::beans::XPropertySet >& xPropSet );
 240 };
 241
 242
 243 class SvXMLShapeContext : public SvXMLImportContext
 244 {
 245 protected:
 246     css::uno::Reference< css::drawing::XShape >   mxShape;
 247     bool                                          mbTemporaryShape;
 248     OUString                                      msHyperlink;
 249
 250 public:
 251     SvXMLShapeContext( SvXMLImport& rImp, sal_uInt16 nPrfx,
 252         const OUString& rLName, bool bTemporaryShape ) : SvXMLImportContext( rImp, nPrfx, rLName ), mbTemporaryShape(bTemporaryShape) {}
 253
 254
 255     const css::uno::Reference< css::drawing::XShape >& getShape() const { return mxShape; }
 256
 257     void setHyperlink( const OUString& rHyperlink );
 258 };
 259
 260
 261 class ShapeSortContext;
 262 struct XMLShapeImportHelperImpl;
 263 struct XMLShapeImportPageContextImpl;
 264
 265 class XMLOFF_DLLPUBLIC XMLShapeImportHelper : public salhelper::SimpleReferenceObject
 266 {
 267     std::unique_ptr<XMLShapeImportHelperImpl> mpImpl;
 268
 269     std::shared_ptr<XMLShapeImportPageContextImpl> mpPageContext;
 270
 271     // PropertySetMappers and factory
 272     rtl::Reference<XMLSdPropHdlFactory>       mpSdPropHdlFactory;
 273     rtl::Reference<SvXMLImportPropertyMapper> mpPropertySetMapper;
 274     rtl::Reference<SvXMLImportPropertyMapper> mpPresPagePropsMapper;
 275
 276     // contexts for Style and AutoStyle import
 277     rtl::Reference<SvXMLStylesContext> mxStylesContext;
 278     rtl::Reference<SvXMLStylesContext> mxAutoStylesContext;
 279
 280     // contexts for xShape contents TokenMaps
 281     std::unique_ptr<SvXMLTokenMap>              mpGroupShapeElemTokenMap;
 282     std::unique_ptr<SvXMLTokenMap>              mpFrameShapeElemTokenMap;
 283     std::unique_ptr<SvXMLTokenMap>              mp3DSceneShapeElemTokenMap;
 284     std::unique_ptr<SvXMLTokenMap>              mp3DObjectAttrTokenMap;
 285     std::unique_ptr<SvXMLTokenMap>              mp3DPolygonBasedAttrTokenMap;
 286     std::unique_ptr<SvXMLTokenMap>              mp3DCubeObjectAttrTokenMap;
 287     std::unique_ptr<SvXMLTokenMap>              mp3DSphereObjectAttrTokenMap;
 288     std::unique_ptr<SvXMLTokenMap>              mp3DLightAttrTokenMap;
 289
 290     const OUString       msStartShape;
 291     const OUString       msEndShape;
 292     const OUString       msStartGluePointIndex;
 293     const OUString       msEndGluePointIndex;
 294
 295     rtl::Reference< XMLTableImport > mxShapeTableImport;
 296
 297 protected:
 298     SvXMLImport& mrImporter;
 299
 300 public:
 301     XMLShapeImportHelper( SvXMLImport& rImporter,
 302         const css::uno::Reference< css::frame::XModel>& rModel,
 303     SvXMLImportPropertyMapper *pExtMapper=nullptr );
 304
 305     virtual ~XMLShapeImportHelper() override;
 306
 307     SvXMLShapeContext* CreateGroupChildContext(
 308         SvXMLImport& rImport, sal_uInt16 nPrefix, const OUString& rLocalName,
 309         const css::uno::Reference< css::xml::sax::XAttributeList >& xAttrList,
 310         css::uno::Reference< css::drawing::XShapes >& rShapes,
 311         bool bTemporaryShape = false);
 312
 313     SvXMLShapeContext* CreateFrameChildContext(
 314         SvXMLImport& rImport, sal_uInt16 nPrefix, const OUString& rLocalName,
 315         const css::uno::Reference< css::xml::sax::XAttributeList >& xAttrList,
 316         css::uno::Reference< css::drawing::XShapes >& rShapes,
 317         const css::uno::Reference< css::xml::sax::XAttributeList >& xFrameAttrList);
 318     static SvXMLImportContext* CreateFrameChildContext(
 319         SvXMLImportContext *pThisContext, sal_uInt16 nPrefix, const OUString& rLocalName,
 320         const css::uno::Reference< css::xml::sax::XAttributeList >& xAttrList );
 321
 322     SvXMLShapeContext* Create3DSceneChildContext(
 323         SvXMLImport& rImport, sal_uInt16 nPrefix, const OUString& rLocalName,
 324         const css::uno::Reference< css::xml::sax::XAttributeList >& xAttrList,
 325         css::uno::Reference< css::drawing::XShapes >& rShapes);
 326
 327     const SvXMLTokenMap& GetGroupShapeElemTokenMap();
 328     const SvXMLTokenMap& GetFrameShapeElemTokenMap();
 329     const SvXMLTokenMap& Get3DSceneShapeElemTokenMap();
 330     const SvXMLTokenMap& Get3DObjectAttrTokenMap();
 331     const SvXMLTokenMap& Get3DPolygonBasedAttrTokenMap();
 332     const SvXMLTokenMap& Get3DCubeObjectAttrTokenMap();
 333     const SvXMLTokenMap& Get3DSphereObjectAttrTokenMap();
 334     const SvXMLTokenMap& Get3DLightAttrTokenMap();
 335
 336     // Styles and AutoStyles contexts
 337     SvXMLStylesContext* GetStylesContext() const { return mxStylesContext.get(); }
 338     void SetStylesContext(SvXMLStylesContext* pNew);
 339     SvXMLStylesContext* GetAutoStylesContext() const { return mxAutoStylesContext.get(); }
 340     void SetAutoStylesContext(SvXMLStylesContext* pNew);
 341
 342     // get factories and mappers
 343     SvXMLImportPropertyMapper* GetPropertySetMapper() const { return mpPropertySetMapper.get(); }
 344     SvXMLImportPropertyMapper* GetPresPagePropsMapper() const { return mpPresPagePropsMapper.get(); }
 345
 346     // this function is called whenever the implementation classes like to add this new
 347     // shape to the given XShapes.
 348     virtual void addShape(
 349         css::uno::Reference< css::drawing::XShape >& rShape,
 350         const css::uno::Reference< css::xml::sax::XAttributeList >& xAttrList,
 351         css::uno::Reference< css::drawing::XShapes >& rShapes);
 352
 353     // this function is called whenever the implementation classes have finished importing
 354     // a shape to the given XShapes. The shape is already inserted into its XShapes and
 355     // all properties and styles are set.
 356     virtual void finishShape(
 357         css::uno::Reference< css::drawing::XShape >& rShape,
 358         const css::uno::Reference< css::xml::sax::XAttributeList >& xAttrList,
 359         css::uno::Reference< css::drawing::XShapes >& rShapes);
 360
 361     // helper functions for z-order sorting
 362     void pushGroupForSorting( css::uno::Reference< css::drawing::XShapes >& rShapes );
 363     void popGroupAndSort();
 364
 365     void shapeWithZIndexAdded( css::uno::Reference< css::drawing::XShape >& rShape,
 366                                sal_Int32 nZIndex );
 367     /// Updates the z-order of other shapes to be consistent again, needed due
 368     /// to the removal of rShape.
 369     void shapeRemoved(const css::uno::Reference<css::drawing::XShape>& rShape);
 370
 371     void addShapeConnection( css::uno::Reference< css::drawing::XShape >& rConnectorShape,
 372                              bool bStart,
 373                              const OUString& rDestShapeId,
 374                              sal_Int32 nDestGlueId );
 375
 376     /** adds a mapping for a glue point identifier from an xml file to the identifier created after inserting
 377         the new glue point into the core. The saved mappings can be retrieved by getGluePointId() */
 378     void addGluePointMapping( css::uno::Reference< css::drawing::XShape >& xShape,
 379                               sal_Int32 nSourceId, sal_Int32 nDestinnationId );
 380
 381     /** find mapping for given DestinationID. This allows to extract the original draw:id imported with a draw:glue-point */
 382     sal_Int32 findGluePointMapping(
 383         const css::uno::Reference< css::drawing::XShape >& xShape,
 384         sal_Int32 nDestinnationId ) const;
 385
 386     /** moves all current DestinationId's for rXShape by n */
 387     void moveGluePointMapping( const css::uno::Reference< css::drawing::XShape >& xShape, const sal_Int32 n );
 388
 389     /** retrieves a mapping for a glue point identifier from the current xml file to the identifier created after
 390         inserting the new glue point into the core. The mapping must be initialized first with addGluePointMapping() */
 391     sal_Int32 getGluePointId( const css::uno::Reference< css::drawing::XShape >& xShape, sal_Int32 nSourceId );
 392
 393     /** this method must be calling before the first shape is imported for the given page.
 394         Calls to this method can be nested */
 395     void startPage( css::uno::Reference< css::drawing::XShapes >& rShapes );
 396
 397     /** this method must be calling after the last shape is imported for the given page
 398         Calls to this method can be nested */
 399     void endPage( css::uno::Reference< css::drawing::XShapes >& rShapes );
 400
 401     void restoreConnections();
 402
 403     /** creates a property mapper for external chaining */
 404     static SvXMLImportPropertyMapper* CreateShapePropMapper(
 405         const css::uno::Reference< css::frame::XModel>& rModel, SvXMLImport& rImport );
 406
 407     /** defines if the import should increment the progress bar or not */
 408     void enableHandleProgressBar();
 409     bool IsHandleProgressBarEnabled() const;
 410
 411     /** queries the capability of the current model to create presentation shapes */
 412     bool IsPresentationShapesSupported();
 413
 414     XMLSdPropHdlFactory* GetSdPropHdlFactory() const { return mpSdPropHdlFactory.get(); }
 415
 416     const rtl::Reference< XMLTableImport >&     GetShapeTableImport();
 417 };
 418
 419 #endif // INCLUDED_XMLOFF_SHAPEIMPORT_HXX
 420
 421 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */