configmgr/source/treecache/cachedata.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: cachedata.hxx,v $
  10  * $Revision: 1.10 $
  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 CONFIGMGR_CACHEDATA_HXX
  32 #define CONFIGMGR_CACHEDATA_HXX
  33
  34 #include "cacheline.hxx"
  35
  36 #ifndef INCLUDED_MAP
  37 #include <map>
  38 #define INCLUDED_MAP
  39 #endif
  40
  41 #ifndef INCLUDED_VECTOR
  42 #include <vector>
  43 #define INCLUDED_VECTOR
  44 #endif
  45
  46 namespace configmgr
  47 {
  48 ////////////////////////////////////////////////////////////////////////////////
  49     namespace backend
  50     {
  51         struct NodeInstance;
  52         struct TemplateInstance;
  53         struct UpdateInstance;
  54         struct ConstUpdateInstance;
  55     }
  56
  57 ////////////////////////////////////////////////////////////////////////////////
  58     /** A collection of CacheLines
  59     */
  60
  61     class CacheData
  62     {
  63     public:
  64         CacheData();
  65         virtual ~CacheData();
  66
  67         // attach a module with a given name
  68         void attachModule(sharable::TreeFragment * _aLocation, rtl::OUString const & _aModule);
  69         /// check if the given module exists already (and is not empty)
  70         bool hasModule(rtl::OUString const & _aModule) const;
  71         /// checks if the given module exists and has defaults available
  72         bool hasModuleDefaults(rtl::OUString const & _aModule) const;
  73
  74         /// gets a tree address for the given module if it exists
  75         sharable::TreeFragment * getTreeAddress(rtl::OUString const & _aModule) const;
  76
  77         /// checks whether a certain node exists in the tree
  78         bool  hasNode(configuration::AbsolutePath const & _aLocation) const;
  79
  80         /// retrieve the given node without changing its ref count
  81         sharable::Node *   getNode(configuration::AbsolutePath const & _rPath);
  82         /// retrieve the given template tree without changing its ref count
  83         sharable::TreeFragment *        getTemplateTree( configuration::AbsolutePath const & aTemplateName ) const;
  84
  85         /// retrieve the subtree at _aPath and clientAcquire() it
  86         sharable::Node * acquireNode(configuration::AbsolutePath const & _aPath );
  87         /// retrieve the subtree at _aPath and clientAcquire() it, return true on success
  88         bool acquireModule( rtl::OUString const & _aModule );
  89         /// clientRelease() the tree at aComponentName, and return the resulting reference count
  90         oslInterlockedCount releaseModule( rtl::OUString const & _aModule, bool _bKeepDeadModule = false );
  91
  92         bool insertDefaults( backend::NodeInstance const & _aDefaultInstance
  93                            ) SAL_THROW((com::sun::star::uno::RuntimeException));
  94
  95         /// merge the given changes into this tree - reflects old values to _anUpdate
  96         void applyUpdate( backend::UpdateInstance & _anUpdate) SAL_THROW((com::sun::star::uno::RuntimeException));
  97
  98         // low-level interface for cache management
  99         typedef std::map<rtl::OUString, rtl::Reference<CacheLine> > ModuleList;
 100         ModuleList& accessModuleList() { return m_aModules; }
 101
 102     protected:
 103         virtual rtl::Reference<CacheLine> doCreateAttachedModule(sharable::TreeFragment * _aLocation, rtl::OUString const & _aName) SAL_THROW((com::sun::star::uno::RuntimeException));
 104
 105         sharable::TreeFragment * internalGetPartialTree(configuration::AbsolutePath const & _aPath ) const;
 106         sharable::Node * internalGetNode(const configuration::AbsolutePath& _rPath) const;
 107
 108         rtl::Reference<CacheLine> internalAttachModule(sharable::TreeFragment * _aLocation, rtl::OUString const & _aName) SAL_THROW((com::sun::star::uno::RuntimeException));
 109         void internalAddModule(rtl::OUString const & _aName, rtl::Reference<CacheLine> const & _aModule);
 110
 111         rtl::Reference<CacheLine> internalGetModule(rtl::OUString const & _aName) const;
 112         rtl::Reference<CacheLine> internalGetModule(const configuration::AbsolutePath& _aLocation) const;
 113
 114     private:
 115         ModuleList m_aModules;
 116     };
 117 ////////////////////////////////////////////////////////////////////////////////
 118     /** A collection of CacheLines for templates
 119     */
 120
 121     class TemplateCacheData : public CacheData
 122     {
 123     public:
 124         TemplateCacheData() : CacheData()
 125         {
 126         }
 127
 128         /** add the given template tree at the given location,
 129             return the tree that is now pertinent and clientAcquire() it once
 130         */
 131         sharable::TreeFragment * addTemplates( backend::ComponentDataStruct const & _aComponentInstance
 132                                        ) SAL_THROW((com::sun::star::uno::RuntimeException));
 133
 134         // create a new module with the given name
 135         void createModule(rtl::OUString const & _aModule) SAL_THROW((com::sun::star::uno::RuntimeException));
 136     private:
 137         virtual rtl::Reference<CacheLine> doCreateAttachedModule(sharable::TreeFragment * _aLocation, rtl::OUString const & _aName) SAL_THROW((com::sun::star::uno::RuntimeException));
 138     };
 139 //-----------------------------------------------------------------------------
 140     /** A collection of CacheLines
 141     */
 142
 143     class ExtendedCacheData : public CacheData
 144     {
 145     public:
 146         ExtendedCacheData() : CacheData()
 147         {
 148         }
 149
 150         /** add the given subtree at the given location,
 151             return the tree that is now pertinent and clientAcquire() it once
 152         */
 153         sharable::TreeFragment * addComponentData( backend::ComponentInstance const & _aComponentInstance,
 154                                             bool _bWithDefaults
 155                                            ) SAL_THROW((com::sun::star::uno::RuntimeException));
 156
 157         /// find the modules having pending changes
 158         bool hasPending(rtl::OUString const & _aModule);
 159         /// find the modules having pending changes
 160         void findPendingModules( std::vector< rtl::OUString > & _rPendingList );
 161
 162         /// add or merge the given subtreechange at the given location
 163         void addPending(backend::ConstUpdateInstance const & _anUpdate) SAL_THROW((com::sun::star::uno::RuntimeException));
 164         /// remove and return pending changes for the given component
 165         std::auto_ptr<SubtreeChange> releasePending(rtl::OUString const & _aModule) SAL_THROW((com::sun::star::uno::RuntimeException));
 166
 167         // create a new module with the given name
 168         void createModule(rtl::OUString const & _aModule) SAL_THROW((com::sun::star::uno::RuntimeException));
 169     private:
 170         virtual rtl::Reference<CacheLine> doCreateAttachedModule(sharable::TreeFragment * _aLocation, rtl::OUString const & _aName) SAL_THROW((com::sun::star::uno::RuntimeException));
 171
 172         rtl::Reference<ExtendedCacheLine> implExtended(rtl::Reference<CacheLine> const & _aSimpleRef) const;
 173     };
 174 //-----------------------------------------------------------------------------
 175
 176 } // namespace configmgr
 177
 178 #endif
 179