summaryrefslogtreecommitdiff
path: root/configmgr/source/inc/treechangelist.hxx
blob: e1bae47ddf3dab611768100e30c38db1991c719f (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
/*************************************************************************
 *
 *  $RCSfile: treechangelist.hxx,v $
 *
 *  $Revision: 1.2 $
 *
 *  last change: $Author: jb $ $Date: 2001-09-28 12:44:15 $
 *
 *  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): _______________________________________
 *
 *
 ************************************************************************/

/* PLEASE DON'T DELETE ANY COMMENT LINES, ALSO IT'S UNNECESSARY. */


#ifndef CONFIGMGR_TREECHANGELIST_HXX
#define CONFIGMGR_TREECHANGELIST_HXX

#ifndef CONFIGMGR_CHANGE_HXX
#include "change.hxx"
#endif
#ifndef CONFIGMGR_CONFIGURATION_ATTRIBUTES_HXX_
#include "attributes.hxx"
#endif
#ifndef CONFIGMGR_CONFIGPATH_HXX_
#include "configpath.hxx"
#endif
#ifndef CONFIGMGR_MISC_OPTIONS_HXX_
#include <options.hxx>
#endif
#ifndef _VOS_REF_HXX_
#include <vos/ref.hxx>
#endif

namespace configmgr
{

////////////////////////////////////////////////////////////////////////////////
    
    //==========================================================================
    //= TreeChangeList
    //==========================================================================
    struct TreeChangeList
    {
        typedef configuration::AbsolutePath   AbsolutePath;
        typedef configuration::Name           Name;
        typedef configuration::Attributes     NodeAttributes;

        TreeChangeList(const vos::ORef < OOptions >& _xOptions, 
                        const AbsolutePath& _rRootPath,
                        const SubtreeChange& _aSubtree,
                        SubtreeChange::DeepChildCopy _doDeepCopy)
                : m_xOptions(_xOptions),
                  m_aLocation(_rRootPath),
                  root(_aSubtree,_doDeepCopy)   
            {}

        /** ctor
        @param		_rRootPath		path to the root of the whole to-be-updated subtree
        */
        TreeChangeList( const vos::ORef < OOptions >& _xOptions,
                        const AbsolutePath& _rRootPath, 
                        const NodeAttributes& _rAttr = NodeAttributes())
                : m_xOptions(_xOptions)
                , m_aLocation(_rRootPath)
                , root(_rRootPath.getLocalName().getName().toString(), _rAttr)
        {}
        
        /** ctor
        @param		_rLocalName			relative path within the to-be-updated subtree
        */
        TreeChangeList( const vos::ORef < OOptions >& _xOptions,
                        const AbsolutePath& _rRootPath,
                        const Name& _rChildTemplateName, 
                        const Name& _rChildTemplateModule, 
                        const NodeAttributes& _rAttr = NodeAttributes())
                : m_xOptions(_xOptions)
                , m_aLocation(_rRootPath)
                , root(_rRootPath.getLocalName().getName().toString(), _rChildTemplateName.toString(), _rChildTemplateModule.toString(), _rAttr)
        {}

        /** ctor
        @param		_rPathToRoot		path to the root of the whole to-be-updated subtree
        @param		_rLocalName			relative path within the to-be-updated subtree
        TreeChangeList( const vos::ORef < OOptions >& _xOptions,
                        const AbsolutePath& _rRootPath,
                        const ISubtree& _rTree)
                : m_xOptions(_xOptions)
                , m_aLocation(_rRootPath)
                , root(_rTree)
        {
            OSL_ENSURE(false, "Test only, because deep copy of subtreechange is very expensive.");
        }
        */

        /** ctor
        @param		_rTreeList			list to initialize the path, no childs are copied			
        */
        TreeChangeList( const TreeChangeList& _rTree, SubtreeChange::NoChildCopy _rNoCopy)
            : m_xOptions(_rTree.m_xOptions)
            , m_aLocation(_rTree.m_aLocation)
            , root(_rTree.root, _rNoCopy)
        {}	

        /// is root a change for the module root
        bool isModuleRootChange() const { return m_aLocation.getDepth() <= 1; }

        /// get the module these changes belong to
        Name getModuleName() const { return m_aLocation.getModuleName(); }
        
        /// get the full path to the root (location + root-name)
        void setRootPath(const AbsolutePath& _rRootPath) 
        { m_aLocation = _rRootPath; }

        /// get the full path to the root (location + root-name)
        AbsolutePath const& getRootNodePath() const { return m_aLocation; }

        /// get the full path to the root (location)
        AbsolutePath getRootContextPath() const { return m_aLocation.getParentPath(); }

        vos::ORef < OOptions > getOptions() const { return m_xOptions; }

    public:
        SubtreeChange root;						 // the root of the whole tree of updates
    private:
        AbsolutePath            m_aLocation;	 // absolute path to the parent of the node corresponding to this->root
        vos::ORef < OOptions >  m_xOptions;		 // options for the tree that is concerned by these changes
    };
//----------------------------------------------------------------------------
    
} // namespace configmgr

#endif