framework/source/inc/accelerators/storageholder.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: storageholder.hxx,v $
  10  * $Revision: 1.5.82.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __FRAMEWORK_ACCELERATORS_STORAGEHOLDER_HXX_
  32 #define __FRAMEWORK_ACCELERATORS_STORAGEHOLDER_HXX_
  33
  34 //===============================================
  35 // own includes
  36
  37 #include <accelerators/istoragelistener.hxx>
  38 #include <threadhelp/threadhelpbase.hxx>
  39 #include <general.h>
  40 #include <stdtypes.h>
  41
  42 //===============================================
  43 // interface includes
  44
  45 #ifndef __COM_SUN_STAR_EMBED_XSTORAGE_HPP_
  46 #include <com/sun/star/embed/XStorage.hpp>
  47 #endif
  48
  49 #ifndef __COM_SUN_STAR_LANG_XMULTISERVICEFACTORY_HPP_
  50 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  51 #endif
  52
  53 //===============================================
  54 // other includes
  55
  56
  57 //===============================================
  58 // namespace
  59
  60 namespace framework
  61 {
  62
  63 #ifdef css
  64     #error "Who defines css? I will use it as namespace alias inside header."
  65 #else
  66     #define css ::com::sun::star
  67 #endif
  68
  69 //===============================================
  70 // definitions
  71
  72 //-----------------------------------------------
  73 /**
  74     TODO document me
  75  */
  76 class StorageHolder : private ThreadHelpBase // attention! Must be the first base class to guarentee right initialize lock ...
  77 {
  78     //-------------------------------------------
  79     // types
  80     public:
  81
  82         /** @short  TODO */
  83         typedef ::std::vector< css::uno::Reference< css::embed::XStorage > > TStorageList;
  84
  85         typedef ::std::vector< IStorageListener* > TStorageListenerList;
  86
  87         struct TStorageInfo
  88         {
  89             public:
  90                 css::uno::Reference< css::embed::XStorage > Storage;
  91                 sal_Int32 UseCount;
  92                 TStorageListenerList Listener;
  93
  94                 TStorageInfo()
  95                     : UseCount(0)
  96                 {}
  97         };
  98
  99         /** @short  TODO */
 100         typedef ::std::hash_map< ::rtl::OUString                    ,
 101                                  TStorageInfo                       ,
 102                                  ::rtl::OUStringHash                ,
 103                                  ::std::equal_to< ::rtl::OUString > > TPath2StorageInfo;
 104
 105     //-------------------------------------------
 106     // member
 107     private:
 108
 109         /** @short  TODO */
 110         css::uno::Reference< css::lang::XMultiServiceFactory > m_xSMGR;
 111
 112         /** @short  TODO */
 113         css::uno::Reference< css::embed::XStorage > m_xRoot;
 114
 115         /** @short  TODO */
 116         TPath2StorageInfo m_lStorages;
 117
 118     //-------------------------------------------
 119     // interface
 120     public:
 121
 122         //---------------------------------------
 123         /** @short  TODO
 124          */
 125         StorageHolder();
 126
 127         //---------------------------------------
 128         /** @short  TODO
 129          */
 130         StorageHolder(const css::uno::Reference< css::lang::XMultiServiceFactory >& xSMGR);
 131
 132         //---------------------------------------
 133         /** @short  TODO
 134          */
 135         virtual ~StorageHolder();
 136
 137         //---------------------------------------
 138         /** @short  TODO
 139          */
 140         virtual void forgetCachedStorages();
 141
 142         //---------------------------------------
 143         /** @short  TODO
 144          */
 145         virtual void setRootStorage(const css::uno::Reference< css::embed::XStorage >& xRoot);
 146
 147         //---------------------------------------
 148         /** @short  TODO
 149          */
 150         virtual css::uno::Reference< css::embed::XStorage > getRootStorage() const;
 151
 152         //---------------------------------------
 153         /** @short  TODO
 154                     open or get!
 155          */
 156         virtual css::uno::Reference< css::embed::XStorage > openPath(const ::rtl::OUString& sPath    ,
 157                                                                            sal_Int32        nOpenMode);
 158
 159         //---------------------------------------
 160         /** @short  TODO
 161          */
 162         virtual StorageHolder::TStorageList getAllPathStorages(const ::rtl::OUString& sPath);
 163
 164         //---------------------------------------
 165         /** @short  TODO
 166          */
 167         virtual void commitPath(const ::rtl::OUString& sPath);
 168
 169         //---------------------------------------
 170         /** @short  TODO
 171          */
 172         virtual void closePath(const ::rtl::OUString& sPath);
 173
 174         //---------------------------------------
 175         /** @short  TODO
 176          */
 177         virtual void notifyPath(const ::rtl::OUString& sPath);
 178
 179         //---------------------------------------
 180         /** @short  TODO
 181          */
 182         virtual void addStorageListener(      IStorageListener* pListener,
 183                                         const ::rtl::OUString&  sPath    );
 184
 185         //---------------------------------------
 186         /** @short  TODO
 187          */
 188         virtual void removeStorageListener(      IStorageListener* pListener,
 189                                            const ::rtl::OUString&  sPath    );
 190
 191         //---------------------------------------
 192         /** @short  TODO
 193          */
 194         virtual ::rtl::OUString getPathOfStorage(const css::uno::Reference< css::embed::XStorage >& xStorage);
 195
 196         //---------------------------------------
 197         /** @short  TODO
 198          */
 199         virtual css::uno::Reference< css::embed::XStorage > getParentStorage(const css::uno::Reference< css::embed::XStorage >& xChild);
 200
 201         //---------------------------------------
 202         /** @short  TODO
 203          */
 204         virtual css::uno::Reference< css::embed::XStorage > getParentStorage(const ::rtl::OUString& sChildPath);
 205
 206         //---------------------------------------
 207         /** @short  TODO
 208          */
 209         virtual void operator=(const StorageHolder& rCopy);
 210
 211         //---------------------------------------
 212         /** @short  opens a sub element of the specified base storage.
 213
 214             @descr  First this method try to open the requested sub element
 215                     using the given open mode. If it failed there is second step,
 216                     which tries to do the same again ... but removing a might existing
 217                     WRITE flag from the open mode. The user can supress this fallback
 218                     handling by setting the parameter bAllowFallback to FALSE.
 219
 220             @param  xBaseStorage
 221                     the storage, where the sub element should be searched.
 222
 223             @param  sSubElement
 224                     the full name of the sub element.
 225                     e.g. "default.xml"
 226
 227             @param  eOpenMode
 228                     a flag field, which set the open mode for this operation.
 229
 230             @param  bAllowFallback
 231                     if eOpenMode contains an ELEMENT_WRITE flag this parameter
 232                     allow to remove it and try it with the rest of eOpenMode flags
 233                     again.
 234          */
 235         static css::uno::Reference< css::embed::XStorage > openSubStorageWithFallback(const css::uno::Reference< css::embed::XStorage >& xBaseStorage  ,
 236                                                                                       const ::rtl::OUString&                             sSubStorage   ,
 237                                                                                             sal_Int32                                    eOpenMode     ,
 238                                                                                             sal_Bool                                     bAllowFallback);
 239
 240         static css::uno::Reference< css::io::XStream > openSubStreamWithFallback(const css::uno::Reference< css::embed::XStorage >& xBaseStorage  ,
 241                                                                                  const ::rtl::OUString&                             sSubStream    ,
 242                                                                                        sal_Int32                                    eOpenMode     ,
 243                                                                                        sal_Bool                                     bAllowFallback);
 244
 245         //---------------------------------------
 246         // helper
 247         private:
 248
 249             //-----------------------------------
 250             /** @short  TODO
 251              */
 252             static ::rtl::OUString impl_st_normPath(const ::rtl::OUString& sPath);
 253
 254             //-----------------------------------
 255             /** @short  TODO
 256              */
 257             static OUStringList impl_st_parsePath(const ::rtl::OUString& sPath);
 258 };
 259
 260 #undef css // dont let it out!
 261
 262 } // namespace framework
 263
 264 #endif // __FRAMEWORK_ACCELERATORS_STORAGEHOLDER_HXX_