summaryrefslogtreecommitdiff
path: root/configmgr/source/inc/roottree.hxx
blob: d707208a2367cb2f38e882a7991b92fa821b1cfa (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
/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: roottree.hxx,v $
 *
 *  $Revision: 1.12 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 03:54:35 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/

#ifndef CONFIGMGR_ROOTTREE_HXX_
#define CONFIGMGR_ROOTTREE_HXX_

#ifndef CONFIGMGR_UTILITY_HXX_
#include "utility.hxx"
#endif

#ifndef INCLUDED_MEMORY
#include <memory>
#define INCLUDED_MEMORY
#endif

namespace configmgr
{
//-----------------------------------------------------------------------------

    class SubtreeChange;
    struct TreeChangeList;
//-----------------------------------------------------------------------------

    namespace memory
    {
        class Segment;
        class Accessor;
    }
//-----------------------------------------------------------------------------

    namespace data
    {
        class NodeAccess;
    }
//-----------------------------------------------------------------------------

    namespace configuration
    {
//-----------------------------------------------------------------------------
        class Tree; typedef Tree RootTree;
        class TreeRef;
        class TreeImpl;
        class NodeRef;
        class NodeChangesInformation;
        class AbsolutePath;
        class TemplateProvider;
        typedef unsigned int NodeOffset;
        typedef unsigned int TreeDepth;

//-----------------------------------------------------------------------------

        RootTree createReadOnlyTree(    AbsolutePath const& aRootPath,
                                        memory::Segment const* _pDataSegment,
                                        data::NodeAccess const& _aCacheNode,
                                        TreeDepth nDepth,
                                        TemplateProvider const& aTemplateProvider);

        RootTree createUpdatableTree(   AbsolutePath const& aRootPath,
                                        memory::Segment const* _pDataSegment,
                                        data::NodeAccess const& _aCacheNode,
                                        TreeDepth nDepth,
                                        TemplateProvider const& aTemplateProvider);

//-----------------------------------------------------------------------------
        class CommitHelper : Noncopyable
        {
            struct Data;

            std::auto_ptr<Data> m_pData;
            TreeImpl*           m_pTree;
        public:
            CommitHelper(TreeRef const& aTree);
            ~CommitHelper();

            // collect all changes into rChangeList
            bool prepareCommit(memory::Accessor const & _aAccessor, TreeChangeList& rChangeList);

            // finish and clean up the changes in rChangeList after they are integrated
            void finishCommit(memory::Accessor const & _aAccessor, TreeChangeList& rChangeList);
            // restore the changes in rChangeList as pending
            void revertCommit(memory::Accessor const & _aAccessor, TreeChangeList& rChangeList);
            // throw away and clean up the changes in rChangeList after a commit failed
            void failedCommit(memory::Accessor const & _aAccessor, TreeChangeList& rChangeList);

            // dispose of auxiliary data for a commit operation
            void reset();
        };

//-----------------------------------------------------------------------------
        /** adjusts <var>aTree</var> tree to the (externally produced) changes under <var>aExternalChanges</var>
            and collects the changes this induces locally.
            @param rLocalChanges
                a collection that will hold the changes induced by <var>aExternalChanges</var>.
            @param aExternalChanges
                a structured change that has already been applied to the master tree.
            @param aBaseTree
                the Tree that contains (directly) the affected node of <var>aExternalChanges</var>.
            @param aBaseNode
                a NodeRef referring to the (directly) affected node of <var>aExternalChanges</var>.
            @return
                <TRUE/> if any changes occur in this tree (so rLocalChanges is not empty), <FALSE/> otherwise.

        */
        bool adjustToChanges(   NodeChangesInformation& rLocalChanges,
                                Tree const& aBaseTree, NodeRef const& aBaseNode,
                                SubtreeChange const& aExternalChange) ;


//-----------------------------------------------------------------------------
    }
}

#endif // CONFIGMGR_ROOTTREE_HXX_