summaryrefslogtreecommitdiff
path: root/configmgr/source/treecache/cacheline.hxx
blob: 894a7d3063ac32d5311c9ebc47dd096d25cea8d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
/*************************************************************************
 *
 *  $RCSfile: cacheline.hxx,v $
 *
 *  $Revision: 1.3 $
 *
 *  last change: $Author: ssmith $ $Date: 2002-12-13 10:30:44 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/

#ifndef CONFIGMGR_CACHELINE_HXX
#define CONFIGMGR_CACHELINE_HXX

#ifndef CONFIGMGR_TREEADDRESS_HXX
#include "treeaddress.hxx"
#endif
#ifndef CONFIGMGR_SEGMENT_HXX
#include "segment.hxx"
#endif
#ifndef CONFIGMGR_CONFIGPATH_HXX_
#include "configpath.hxx"
#endif
#ifndef CONFIGMGR_BACKEND_REQUESTTYPES_HXX_
#include "requesttypes.hxx"
#endif

#ifndef _OSL_INTERLOCK_H_
#include <osl/interlck.h>
#endif
#ifndef _SALHELPER_SIMPLEREFERENCEOBJECT_HXX_
#include <salhelper/simplereferenceobject.hxx>
#endif
#ifndef _RTL_REF_HXX_
#include <rtl/ref.hxx>
#endif

namespace configmgr
{
////////////////////////////////////////////////////////////////////////////////
    using ::rtl::OUString;

    namespace data { class NodeAddress; class TreeAddress; class NodeAccess; }
////////////////////////////////////////////////////////////////////////////////
    /** This object represents a cache line for a single configuration tree
    */
    class CacheLine : public salhelper::SimpleReferenceObject, NotCopyable
    {
    public:
        typedef oslInterlockedCount RefCount;

        typedef configuration::Name         Name;
        typedef configuration::AbsolutePath Path;

        // create a new CacheLine for the given component name
        static rtl::Reference<CacheLine> 
            createNew( Name const & _aModuleName, memory::HeapManager & _rHeapImpl ); 
       
        // create a new CacheLine attached to the given memory location
        static rtl::Reference<CacheLine> 
            createAttached( Name const & _aModuleName, memory::HeapManager & _rHeapImpl, 
                            memory::SegmentAddress const & _aLocation ); 
       
        memory::Segment * getDataSegment();

        memory::SegmentAddress getDataSegmentAddress() const;

        bool isEmpty() const { return m_base.isNull(); }

        bool hasDefaults(memory::Accessor const & _aAccessor) const;

        data::TreeAddress getModuleRootAddress( ) const { return m_base; }

        data::TreeAddress	getPartialTree(memory::Accessor const & _aAccessor, Path const & _aTemplatePath ) const;
        data::NodeAddress	getNode(memory::Accessor const & _aAccessor, Path const & _aPath) const;

        data::TreeAddress   setComponentData( memory::UpdateAccessor& _aAccessToken,
                                              backend::ComponentData const & _aComponentInstance, 
                                              bool _bWithDefaults
                                           ) CFG_UNO_THROW_RTE();

        data::TreeAddress   insertDefaults(   memory::UpdateAccessor& _aAccessToken, 
                                              backend::NodeInstance const & _aDefaultInstance
                                           ) CFG_UNO_THROW_RTE();

        // get the module name for this component
        Name getModuleName() const;

        /// add a client for this module's data
        RefCount clientReferences() const { return m_nDataRefs; }
        /// add a client for this modules data
        RefCount clientAcquire() { return osl_incrementInterlockedCount(&m_nDataRefs); }			
        /// subtract a client for this modules data
        RefCount clientRelease() { return osl_decrementInterlockedCount(&m_nDataRefs); }		

    protected:
        // create a new CacheLine attached to the given memory location
        explicit 
        CacheLine( Name const & _aModuleName, memory::HeapManager & _rHeapImpl, 
                    memory::SegmentAddress const & _aLocation ); 
       
        // create a new empty CacheLine for the given component name
        explicit 
        CacheLine( Name const & _aModuleName, memory::HeapManager & _rHeapImpl ); 

        data::NodeAccess internalGetNode(memory::Accessor const & _anAccessor, Path const & _rPath) const;

        data::TreeAddress base() const { return m_base; }
        void setBase(data::TreeAddress _base); 

    private:
        memory::Segment     m_storage;
        data::TreeAddress   m_base;
        Name                m_name;

        oslInterlockedCount m_nDataRefs;			/// the number of clients on this modules data
    };
    typedef rtl::Reference<CacheLine> CacheLineRef;

////////////////////////////////////////////////////////////////////////////////
    /** This object represents a cache line and associated data for a single configuration tree
    */
    class ExtendedCacheLine : public CacheLine
    {
    public:
        // create a new CacheLine for the given component name
        static rtl::Reference<ExtendedCacheLine> 
            createNew( Name const & _aModuleName, memory::HeapManager & _rHeapImpl ); 
       
        // create a new CacheLine attached to the given memory location
        static rtl::Reference<ExtendedCacheLine> 
            createAttached( Name const & _aModuleName, memory::HeapManager & _rHeapImpl, 
                            memory::SegmentAddress const & _aLocation ); 
       
    // management of pending changes
        bool hasPending() const {return m_pPending.get() != NULL;}
        
        void addPending(backend::ConstUpdateInstance const & _anUpdate) CFG_UNO_THROW_RTE();
        std::auto_ptr<SubtreeChange> releasePending() {return m_pPending;}
        
    private:
        // create a new empty CacheLine for the given component name
        explicit 
        ExtendedCacheLine( Name const & _aModuleName, memory::HeapManager & _rHeapImpl );
        
        // create a new CacheLine attached to the given memory location
        explicit 
        ExtendedCacheLine( Name const & _aModuleName, memory::HeapManager & _rHeapImpl, 
                            memory::SegmentAddress const & _aLocation ); 

    private:
        std::auto_ptr<SubtreeChange> m_pPending;
    };
    typedef rtl::Reference<ExtendedCacheLine> ExtendedCacheLineRef;
////////////////////////////////////////////////////////////////////////////////

    inline
    memory::Segment * CacheLine::getDataSegment() 
    { return &m_storage; }

////////////////////////////////////////////////////////////////////////////////
    
} // namespace configmgr

#endif