sd/source/filter/eppt/epptbase.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_SD_SOURCE_FILTER_EPPT_EPPTBASE_HXX
  21 #define INCLUDED_SD_SOURCE_FILTER_EPPT_EPPTBASE_HXX
  22
  23 #include <memory>
  24 #include <vector>
  25
  26 #include <vcl/mapmod.hxx>
  27 #include <tools/stream.hxx>
  28 #include <tools/fract.hxx>
  29 #include <tools/gen.hxx>
  30 #include <com/sun/star/awt/Size.hpp>
  31 #include <com/sun/star/awt/Point.hpp>
  32 #include <com/sun/star/presentation/FadeEffect.hpp>
  33 #include <com/sun/star/beans/PropertyState.hpp>
  34 #include <vcl/vclptr.hxx>
  35 #include <vcl/graph.hxx>
  36
  37 #include "grouptable.hxx"
  38
  39 namespace com { namespace sun { namespace star { namespace task { class XStatusIndicator; } } } }
  40 namespace com { namespace sun { namespace star { namespace frame { class XModel; } } } }
  41 namespace com { namespace sun { namespace star { namespace awt { struct Rectangle; } } } }
  42 namespace com { namespace sun { namespace star { namespace drawing { class XMasterPagesSupplier; } } } }
  43 namespace com { namespace sun { namespace star { namespace drawing { class XDrawPage; } } } }
  44 namespace com { namespace sun { namespace star { namespace drawing { class XDrawPages; } } } }
  45 namespace com { namespace sun { namespace star { namespace drawing { class XDrawPagesSupplier; } } } }
  46 namespace com { namespace sun { namespace star { namespace beans { struct PropertyValue; } } } }
  47 namespace com { namespace sun { namespace star { namespace beans { class XPropertySet; } } } }
  48 namespace com { namespace sun { namespace star { namespace drawing { class XShape; } } } }
  49 namespace com { namespace sun { namespace star { namespace drawing { class XShapes; } } } }
  50
  51 class VirtualDevice;
  52
  53 // PLACEMENT_ID
  54 enum class EppLayout
  55 {
  56     TITLESLIDE            =  0, /* The slide is a title slide                                                             */
  57     TITLEANDBODYSLIDE     =  1, /* Title and body slide                                                                   */
  58     TITLEMASTERSLIDE      =  2, /* Title master slide                                                                     */
  59     MASTERSLIDE           =  3, /* Master slide layout                                                                    */
  60     MASTERNOTES           =  4, /* Master notes layout                                                                    */
  61     NOTESTITLEBODY        =  5, /* Notes title/body layout                                                                */
  62     HANDOUTLAYOUT         =  6, /* Handout layout, therefore it doesn't have placeholders except header, footer, and date */
  63     ONLYTITLE             =  7, /* Only title placeholder                                                                 */
  64     TWOCOLUMNSANDTITLE    =  8, /* Body of the slide has 2 columns and a title                                            */
  65     TWOROWSANDTITLE       =  9, /* Slide's body has 2 rows and a title                                                    */
  66     RIGHTCOLUMN2ROWS      = 10, /* Body contains 2 columns, right column has 2 rows                                       */
  67     LEFTCOLUMN2ROWS       = 11, /* Body contains 2 columns, left column has 2 rows                                        */
  68     BOTTOMROW2COLUMNS     = 12, /* Body contains 2 rows, bottom row has 2 columns                                         */
  69     TOPROW2COLUMN         = 13, /* Body contains 2 rows, top row has 2 columns                                            */
  70     FOUROBJECTS           = 14, /* 4 objects                                                                              */
  71     BIGOBJECT             = 15, /* Big object                                                                             */
  72     BLANKSLIDE            = 16, /* Blank slide                                                                            */
  73     TITLERIGHTBODYLEFT    = 17, /* Vertical title on the right, body on the left                                          */
  74     TITLERIGHT2BODIESLEFT = 18  /* Vertical title on the right, body on the left split into 2 rows                        */
  75 };
  76
  77 #define EPP_LAYOUT_SIZE 25
  78
  79 struct PHLayout
  80 {
  81     EppLayout   nLayout;
  82     sal_uInt8 nPlaceHolder[ 8 ];
  83
  84     sal_uInt8   nUsedObjectPlaceHolder;
  85     sal_uInt8   nTypeOfTitle;
  86     sal_uInt8   nTypeOfOutliner;
  87
  88     bool    bTitlePossible;
  89     bool    bOutlinerPossible;
  90     bool    bSecOutlinerPossible;
  91 };
  92
  93 enum PageType { NORMAL = 0, MASTER = 1, NOTICE = 2, UNDEFINED = 3, LAYOUT = 4 };
  94
  95 class PropValue
  96 {
  97     protected:
  98
  99         css::uno::Any                                    mAny;
 100         css::uno::Reference< css::beans::XPropertySet >  mXPropSet;
 101
 102         bool    ImplGetPropertyValue( const OUString& rString );
 103         bool    ImplGetPropertyValue( const css::uno::Reference
 104                         < css::beans::XPropertySet > &, const OUString& );
 105
 106     public:
 107
 108         PropValue() {}
 109
 110         static bool GetPropertyValue(
 111             css::uno::Any& rAny,
 112             const css::uno::Reference< css::beans::XPropertySet > &,
 113             const OUString& rPropertyName,
 114             bool bTestPropertyAvailability = false );
 115
 116         static css::beans::PropertyState GetPropertyState(
 117             const css::uno::Reference < css::beans::XPropertySet > &,
 118             const OUString& rPropertyName );
 119 };
 120
 121 class EscherGraphicProvider;
 122 class PPTExBulletProvider
 123 {
 124     friend struct PPTExParaSheet;
 125
 126     protected:
 127
 128         SvMemoryStream          aBuExPictureStream;
 129         SvMemoryStream          aBuExOutlineStream;
 130         SvMemoryStream          aBuExMasterStream;
 131
 132         std::unique_ptr<EscherGraphicProvider>
 133                                 pGraphicProv;
 134
 135     public:
 136
 137         sal_uInt16 GetId(Graphic const & rGraphic, Size& rGraphicSize);
 138
 139         PPTExBulletProvider();
 140         ~PPTExBulletProvider();
 141 };
 142
 143 struct FontCollectionEntry
 144 {
 145         OUString                Name;
 146         double                  Scaling;
 147         sal_Int16               Family;
 148         sal_Int16               Pitch;
 149         sal_Int16               CharSet;
 150
 151         OUString const          Original;
 152
 153         FontCollectionEntry( const OUString& rName, sal_Int16 nFamily, sal_Int16 nPitch, sal_Int16 nCharSet ) :
 154                             Scaling ( 1.0 ),
 155                             Family  ( nFamily ),
 156                             Pitch   ( nPitch ),
 157                             CharSet ( nCharSet ),
 158                             Original( rName )
 159                             {
 160                                 ImplInit( rName );
 161                             };
 162
 163         explicit FontCollectionEntry( const OUString& rName ) :
 164                             Scaling ( 1.0 ),
 165                             Family  ( 0 ),
 166                             Pitch   ( 0 ),
 167                             CharSet ( 0 ),
 168                             Original( rName )
 169                             {
 170                                 ImplInit( rName );
 171                             };
 172         ~FontCollectionEntry();
 173
 174     private:
 175
 176         void ImplInit( const OUString& rName );
 177 };
 178
 179 class FontCollection
 180 {
 181 public:
 182
 183     FontCollection();
 184
 185     ~FontCollection();
 186
 187     static short GetScriptDirection( const OUString& rText );
 188
 189     sal_uInt32  GetId( FontCollectionEntry& rFontDescriptor );
 190
 191     sal_uInt32  GetCount() const { return maFonts.size(); };
 192
 193     const FontCollectionEntry* GetById( sal_uInt32 nId );
 194
 195     FontCollectionEntry& GetLast() { return *(maFonts.rbegin()); };
 196
 197 private:
 198
 199     VclPtr<VirtualDevice> pVDev;
 200     std::vector<FontCollectionEntry> maFonts;
 201 };
 202
 203 #define PPTEX_STYLESHEETENTRIES  9
 204
 205 enum PPTExTextAttr
 206 {
 207     ParaAttr_BulletOn,
 208     ParaAttr_BuHardFont,
 209     ParaAttr_BuHardColor,
 210     ParaAttr_BuHardHeight,
 211     ParaAttr_BulletChar,
 212     ParaAttr_BulletFont,
 213     ParaAttr_BulletHeight,
 214     ParaAttr_BulletColor,
 215     ParaAttr_Adjust,
 216     ParaAttr_LineFeed,
 217     ParaAttr_UpperDist,
 218     ParaAttr_LowerDist,
 219     ParaAttr_TextOfs,
 220     ParaAttr_BulletOfs,
 221     ParaAttr_DefaultTab,
 222     ParaAttr_BiDi,
 223     CharAttr_Bold,
 224     CharAttr_Italic,
 225     CharAttr_Underline,
 226     CharAttr_Shadow,
 227     CharAttr_Strikeout,
 228     CharAttr_Embossed,
 229     CharAttr_Font,
 230     CharAttr_AsianOrComplexFont,
 231     CharAttr_Symbol,
 232     CharAttr_FontHeight,
 233     CharAttr_FontColor,
 234     CharAttr_Escapement
 235 };
 236
 237 struct PPTExCharLevel
 238 {
 239     sal_uInt16      mnFlags;
 240     sal_uInt16      mnFont;
 241     sal_uInt16      mnAsianOrComplexFont;
 242     sal_uInt16      mnFontHeight;
 243     sal_uInt16      mnEscapement;
 244     Color           mnFontColor;
 245 };
 246
 247 struct PPTExCharSheet
 248 {
 249                 PPTExCharLevel  maCharLevel[ 5 ];
 250
 251                 explicit PPTExCharSheet( int nInstance );
 252
 253                 void    SetStyleSheet( const css::uno::Reference< css::beans::XPropertySet > &,
 254                                         FontCollection& rFontCollection, int nLevel );
 255                 void    Write( SvStream& rSt, sal_uInt16 nLev, bool bSimpleText,
 256                             const css::uno::Reference< css::beans::XPropertySet > & rPagePropSet );
 257
 258 };
 259
 260 struct PPTExParaLevel
 261 {
 262     bool            mbIsBullet;
 263     sal_uInt16      mnBulletChar;
 264     sal_uInt16      mnBulletFont;
 265     sal_uInt16      mnBulletHeight;
 266     sal_uInt32      mnBulletColor;
 267
 268     sal_uInt16      mnAdjust;
 269     sal_uInt16      mnLineFeed;
 270     sal_uInt16      mnUpperDist;
 271     sal_uInt16      mnLowerDist;
 272     sal_uInt16      mnTextOfs;
 273     sal_uInt16      mnBulletOfs;
 274     sal_uInt16      mnDefaultTab;
 275
 276     bool            mbExtendedBulletsUsed;
 277     sal_uInt16      mnBulletId;
 278     sal_uInt16      mnBulletStart;
 279     sal_uInt32      mnMappedNumType;
 280     sal_uInt32      mnNumberingType;
 281     sal_uInt16      mnAsianSettings;
 282     sal_uInt16      mnBiDi;
 283 };
 284
 285 struct PPTExParaSheet
 286 {
 287                 PPTExBulletProvider* pBuProv;
 288
 289                 sal_uInt32  mnInstance;
 290
 291                 PPTExParaLevel  maParaLevel[ 5 ];
 292                 PPTExParaSheet( int nInstance, sal_uInt16 nDefaultTab, PPTExBulletProvider* pProv );
 293
 294                 void    SetStyleSheet( const css::uno::Reference< css::beans::XPropertySet > &,
 295                                         FontCollection& rFontCollection, int nLevel, const PPTExCharLevel& rCharLevel );
 296                 void    Write( SvStream& rSt, sal_uInt16 nLev, bool bSimpleText,
 297                     const css::uno::Reference< css::beans::XPropertySet > & rPagePropSet );
 298 };
 299
 300 class PPTExStyleSheet
 301 {
 302
 303     public:
 304
 305                 std::unique_ptr<PPTExCharSheet>  mpCharSheet[ PPTEX_STYLESHEETENTRIES ];
 306                 std::unique_ptr<PPTExParaSheet>  mpParaSheet[ PPTEX_STYLESHEETENTRIES ];
 307
 308                 PPTExStyleSheet( sal_uInt16 nDefaultTab, PPTExBulletProvider* pBuProv );
 309                 ~PPTExStyleSheet();
 310
 311                 PPTExParaSheet& GetParaSheet( int nInstance ) { return *mpParaSheet[ nInstance ]; };
 312
 313                 void            SetStyleSheet( const css::uno::Reference< css::beans::XPropertySet > &,
 314                                                 FontCollection& rFontCollection, int nInstance, int nLevel );
 315                 bool        IsHardAttribute( sal_uInt32 nInstance, sal_uInt32 nLevel, PPTExTextAttr eAttr, sal_uInt32 nValue );
 316
 317                 static sal_uInt32 SizeOfTxCFStyleAtom() { return 24; }
 318                 void            WriteTxCFStyleAtom( SvStream& rSt );
 319 };
 320
 321 class PPTWriterBase : public PropValue, public GroupTable
 322 {
 323 protected:
 324     css::uno::Reference< css::frame::XModel >                 mXModel;
 325     css::uno::Reference< css::task::XStatusIndicator >        mXStatusIndicator;
 326
 327     bool            mbStatusIndicator;
 328
 329     css::uno::Reference< css::drawing::XDrawPagesSupplier >   mXDrawPagesSupplier;
 330     css::uno::Reference< css::drawing::XMasterPagesSupplier > mXMasterPagesSupplier;
 331     css::uno::Reference< css::drawing::XDrawPages >           mXDrawPages;
 332     css::uno::Reference< css::drawing::XDrawPage >            mXDrawPage;
 333     css::uno::Reference< css::beans::XPropertySet >           mXPagePropSet;
 334     css::uno::Reference< css::beans::XPropertySet >           mXBackgroundPropSet;
 335     css::uno::Reference< css::drawing::XShapes >              mXShapes;
 336     css::uno::Reference< css::drawing::XShape >               mXShape;
 337     css::awt::Size         maSize;
 338     css::awt::Point        maPosition;
 339     ::tools::Rectangle           maRect;
 340     OString        mType;
 341     bool            mbPresObj;
 342     bool            mbEmptyPresObj;
 343     bool            mbIsBackgroundDark;
 344     sal_Int32           mnAngle;
 345
 346     sal_uInt32          mnPages;            ///< number of Slides ( w/o master pages & notes & handout )
 347     sal_uInt32          mnMasterPages;
 348
 349     Fraction const     maFraction;
 350     MapMode const      maMapModeSrc;
 351     MapMode const      maMapModeDest;
 352     css::awt::Size     maDestPageSize;
 353     css::awt::Size     maPageSize; // #i121183# Keep size in logic coordinates (100th mm)
 354     css::awt::Size     maNotesPageSize;
 355
 356     PageType                        meLatestPageType;
 357     std::vector< std::unique_ptr<PPTExStyleSheet> > maStyleSheetList;
 358     PPTExStyleSheet*                mpStyleSheet;
 359
 360     FontCollection      maFontCollection;
 361
 362     virtual void ImplWriteSlide( sal_uInt32 /* nPageNum */, sal_uInt32 /* nMasterNum */, sal_uInt16 /* nMode */,
 363                                  bool /* bHasBackground */, css::uno::Reference< css::beans::XPropertySet > const & /* aXBackgroundPropSet */ ) {}
 364     virtual void ImplWriteNotes( sal_uInt32 nPageNum ) = 0;
 365     virtual void ImplWriteSlideMaster( sal_uInt32 /* nPageNum */, css::uno::Reference< css::beans::XPropertySet > const & /* aXBackgroundPropSet */ ) {}
 366
 367     virtual void exportPPTPre( const std::vector< css::beans::PropertyValue >& ) {}
 368     virtual void exportPPTPost() {}
 369
 370     virtual bool ImplCreateDocument()=0;
 371     virtual bool ImplCreateMainNotes()=0;
 372
 373     bool GetStyleSheets();
 374     bool GetShapeByIndex( sal_uInt32 nIndex, bool bGroup );
 375
 376     bool CreateMainNotes();
 377
 378     css::awt::Size   MapSize( const css::awt::Size& );
 379     css::awt::Point  MapPoint( const css::awt::Point& );
 380     ::tools::Rectangle        MapRectangle( const css::awt::Rectangle& );
 381
 382     bool ContainsOtherShapeThanPlaceholders();
 383
 384 public:
 385     PPTWriterBase();
 386     PPTWriterBase( const css::uno::Reference< css::frame::XModel > & rModel,
 387                    const css::uno::Reference< css::task::XStatusIndicator > & rStatInd );
 388
 389     virtual ~PPTWriterBase();
 390
 391     void exportPPT(const std::vector< css::beans::PropertyValue >&);
 392
 393     bool InitSOIface();
 394     bool GetPageByIndex( sal_uInt32 nIndex, PageType );
 395     sal_uInt32 GetMasterIndex( PageType ePageType );
 396     void SetCurrentStyleSheet( sal_uInt32 nPageNum );
 397
 398     bool GetPresObj() { return mbPresObj; }
 399
 400     static PHLayout const & GetLayout( const css::uno::Reference< css::beans::XPropertySet >& rXPropSet );
 401     static PHLayout const & GetLayout( sal_Int32 nOffset );
 402     static sal_Int32 GetLayoutOffset( const css::uno::Reference< css::beans::XPropertySet >& rXPropSet );
 403     static sal_Int32 GetLayoutOffsetFixed( const css::uno::Reference< css::beans::XPropertySet >& rXPropSet );
 404
 405     bool CreateSlide( sal_uInt32 nPageNum );
 406     bool CreateSlideMaster( sal_uInt32 nPageNum );
 407     bool CreateNotes( sal_uInt32 nPageNum );
 408
 409     static sal_Int8 GetTransition( sal_Int16 nTransitionType, sal_Int16 nTransitionSubtype, css::presentation::FadeEffect eEffect, sal_uInt8& nDirection );
 410     static sal_Int8 GetTransition( css::presentation::FadeEffect eEffect, sal_uInt8& nDirection );
 411 };
 412
 413 #endif
 414
 415 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */