include/svx/xmleohlp.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_SVX_XMLEOHLP_HXX
  21 #define INCLUDED_SVX_XMLEOHLP_HXX
  22
  23 #include <cppuhelper/compbase.hxx>
  24 #include <osl/mutex.hxx>
  25 #include <map>
  26 #include <com/sun/star/container/XNameContainer.hpp>
  27 #include <com/sun/star/document/XEmbeddedObjectResolver.hpp>
  28 #include <com/sun/star/container/XNameAccess.hpp>
  29 #include <com/sun/star/embed/XEmbeddedObject.hpp>
  30 #include <svx/svxdllapi.h>
  31
  32 enum class SvXMLEmbeddedObjectHelperMode
  33 {
  34     Read, Write
  35 };
  36
  37 namespace comphelper { class IEmbeddedHelper; }
  38
  39 class SvGlobalName;
  40 class OutputStorageWrapper_Impl;
  41
  42
  43 class SVX_DLLPUBLIC SvXMLEmbeddedObjectHelper :
  44     public cppu::WeakComponentImplHelper< css::document::XEmbeddedObjectResolver, css::container::XNameAccess >
  45 {
  46     typedef ::std::map< OUString, OutputStorageWrapper_Impl* > SvXMLEmbeddedObjectHelper_Impl;
  47 private:
  48
  49     ::osl::Mutex                maMutex;
  50
  51     const OUString       maReplacementGraphicsContainerStorageName;
  52     const OUString       maReplacementGraphicsContainerStorageName60;
  53     OUString             maCurContainerStorageName;
  54
  55
  56     css::uno::Reference < css::embed::XStorage > mxRootStorage;  // package
  57     ::comphelper::IEmbeddedHelper*             mpDocPersist;
  58     css::uno::Reference < css::embed::XStorage > mxContainerStorage; // container sub package for
  59     css::uno::Reference < css::embed::XStorage > mxTempStorage;  // package
  60                                                 // objects
  61     SvXMLEmbeddedObjectHelperMode       meCreateMode;
  62     SvXMLEmbeddedObjectHelper_Impl      *mpStreamMap;
  63
  64     SVX_DLLPRIVATE bool                 ImplGetStorageNames(
  65                                        const OUString& rURLStr,
  66                                        OUString& rContainerStorageName,
  67                                        OUString& rObjectStorageName,
  68                                        bool bInternalToExternal,
  69                                        bool *pGraphicRepl=nullptr,
  70                                        bool *pOasisFormat=nullptr ) const;
  71
  72     SVX_DLLPRIVATE css::uno::Reference < css::embed::XStorage > const & ImplGetContainerStorage(
  73                                     const OUString& rStorageName );
  74
  75     SVX_DLLPRIVATE void                 ImplReadObject(
  76                                     const OUString& rContainerStorageName,
  77                                     OUString& rObjName,
  78                                     const SvGlobalName *pClassId,
  79                                     SvStream* pTemp );
  80
  81     SVX_DLLPRIVATE OUString              ImplInsertEmbeddedObjectURL(
  82                                     const OUString& rURLStr );
  83
  84     SVX_DLLPRIVATE css::uno::Reference< css::io::XInputStream > ImplGetReplacementImage(
  85                                 const css::uno::Reference< css::embed::XEmbeddedObject >& xObj );
  86
  87 protected:
  88
  89                                 SvXMLEmbeddedObjectHelper();
  90                                 virtual ~SvXMLEmbeddedObjectHelper() override;
  91     void                        Init( const css::uno::Reference < css::embed::XStorage >&,
  92                                       ::comphelper::IEmbeddedHelper& rDocPersist,
  93                                       SvXMLEmbeddedObjectHelperMode eCreateMode );
  94
  95     virtual void SAL_CALL       disposing() override;
  96
  97 public:
  98                                 SvXMLEmbeddedObjectHelper(
  99                                     ::comphelper::IEmbeddedHelper& rDocPersist,
 100                                     SvXMLEmbeddedObjectHelperMode eCreateMode );
 101
 102     static SvXMLEmbeddedObjectHelper*   Create(
 103                                     const css::uno::Reference < css::embed::XStorage >&,
 104                                     ::comphelper::IEmbeddedHelper& rDocPersist,
 105                                     SvXMLEmbeddedObjectHelperMode eCreateMode,
 106                                     bool bDirect = true );
 107     static SvXMLEmbeddedObjectHelper*   Create(
 108                                     ::comphelper::IEmbeddedHelper& rDocPersist,
 109                                     SvXMLEmbeddedObjectHelperMode eCreateMode );
 110     static void                 Destroy( SvXMLEmbeddedObjectHelper* pSvXMLEmbeddedObjectHelper );
 111
 112     // XEmbeddedObjectResolver
 113     virtual OUString SAL_CALL resolveEmbeddedObjectURL( const OUString& aURL ) override;
 114
 115     // XNameAccess
 116     virtual css::uno::Any SAL_CALL getByName( const OUString& aName ) override;
 117     virtual css::uno::Sequence< OUString > SAL_CALL getElementNames(  ) override;
 118     virtual sal_Bool SAL_CALL hasByName( const OUString& aName ) override;
 119
 120     // XNameAccess
 121     virtual css::uno::Type SAL_CALL getElementType(  ) override;
 122     virtual sal_Bool SAL_CALL hasElements(  ) override;
 123
 124
 125     static void splitObjectURL(const OUString& aURLNoPar,
 126         OUString& rContainerStorageName,
 127         OUString& rObjectStorageName);
 128 };
 129
 130 #endif // INCLUDED_SVX_XMLEOHLP_HXX
 131
 132 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */