configmgr/source/backend/layerupdatebuilder.cxx

   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: layerupdatebuilder.cxx,v $
  10  * $Revision: 1.12 $
  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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_configmgr.hxx"
  33
  34 #include "layerupdatebuilder.hxx"
  35 #include "updatedata.hxx"
  36 #include "layerupdate.hxx"
  37 #include <com/sun/star/configuration/backend/TemplateIdentifier.hpp>
  38
  39 namespace configmgr
  40 {
  41 // -----------------------------------------------------------------------------
  42     namespace backend
  43     {
  44 // -----------------------------------------------------------------------------
  45
  46 LayerUpdateBuilder::LayerUpdateBuilder()
  47 : m_aUpdate()
  48 , m_pCurrentNode(NULL)
  49 , m_pCurrentProp(NULL)
  50 {
  51 }
  52 // -----------------------------------------------------------------------------
  53
  54 void LayerUpdateBuilder::clear()
  55 {
  56     m_pCurrentProp = NULL;
  57     m_pCurrentNode = NULL;
  58     m_aUpdate = LayerUpdate();
  59
  60     OSL_POSTCOND( this->isEmpty(), "LayerUpdateBuilder: Could not reset the stored update.");
  61 }
  62 // -----------------------------------------------------------------------------
  63
  64 LayerUpdate const & LayerUpdateBuilder::result() const
  65 {
  66     OSL_ENSURE(this->isComplete(),
  67                 "LayerUpdateBuilder: There is no result to retrieve"
  68                 " - building the data is still in progress.");
  69
  70     return m_aUpdate;
  71 }
  72 // -----------------------------------------------------------------------------
  73
  74 inline
  75 LayerUpdate & LayerUpdateBuilder::data()
  76 {
  77     return m_aUpdate;
  78 }
  79 // -----------------------------------------------------------------------------
  80
  81 bool LayerUpdateBuilder::init()
  82 {
  83     if (m_pCurrentNode) return false;
  84
  85     LayerUpdate & update = data();
  86     m_pCurrentNode = new NodeModification(NULL, rtl::OUString(), 0, 0, false);
  87     update.setContextNode(m_pCurrentNode);
  88
  89     OSL_ENSURE(m_pCurrentProp == NULL, "LayerUpdateBuilder: Internal error: got a current property for a new context");
  90
  91     return true;
  92 }
  93 // -----------------------------------------------------------------------------
  94
  95 bool LayerUpdateBuilder::modifyNode(rtl::OUString const & _aName, sal_Int16 _nFlags, sal_Int16 _nFlagsMask, sal_Bool _bReset)
  96 {
  97     OSL_PRECOND(m_pCurrentNode && !m_pCurrentProp, "LayerUpdateBuilder: Illegal state for this operation");
  98
  99     NodeUpdate * pNewNode = new NodeModification(m_pCurrentNode,_aName,_nFlags,_nFlagsMask,_bReset);
 100     rtl::Reference<ElementUpdate> xNewNode(pNewNode);
 101
 102     if (!m_pCurrentNode->addNodeUpdate(xNewNode))
 103         return false;
 104
 105     m_pCurrentNode = pNewNode;
 106     return true;
 107 }
 108 // -----------------------------------------------------------------------------
 109
 110 bool LayerUpdateBuilder::replaceNode(rtl::OUString const & _aName, sal_Int16 _nFlags, backenduno::TemplateIdentifier const * _pTemplate)
 111 {
 112     OSL_PRECOND(m_pCurrentNode && !m_pCurrentProp, "LayerUpdateBuilder: Illegal state for this operation");
 113
 114     NodeUpdate * pNewNode = _pTemplate ?
 115         new NodeReplace(m_pCurrentNode,_aName,_nFlags,_pTemplate->Name,_pTemplate->Component) :
 116         new NodeReplace(m_pCurrentNode,_aName,_nFlags);
 117
 118     rtl::Reference<ElementUpdate> xNewNode(pNewNode);
 119
 120     if (!m_pCurrentNode->addNodeUpdate(xNewNode))
 121         return false;
 122
 123     m_pCurrentNode = pNewNode;
 124     return true;
 125 }
 126 // -----------------------------------------------------------------------------
 127
 128 bool LayerUpdateBuilder::finishNode()
 129 {
 130     OSL_PRECOND(m_pCurrentNode && !m_pCurrentProp, "LayerUpdateBuilder: Illegal state for this operation");
 131
 132     if (m_pCurrentProp || !m_pCurrentNode) return false;
 133
 134     m_pCurrentNode = m_pCurrentNode->getParent();
 135     return true;
 136 }
 137 // -----------------------------------------------------------------------------
 138
 139 bool LayerUpdateBuilder::removeNode(rtl::OUString const & _aName)
 140 {
 141     OSL_PRECOND(m_pCurrentNode && !m_pCurrentProp, "LayerUpdateBuilder: Illegal state for this operation");
 142
 143     NodeDrop * pNewNode = new NodeDrop(m_pCurrentNode,_aName);
 144
 145     rtl::Reference<ElementUpdate> xNewNode(pNewNode);
 146
 147     if (!m_pCurrentNode->addNodeUpdate(xNewNode))
 148         return false;
 149
 150     return true;
 151 }
 152 // -----------------------------------------------------------------------------
 153
 154 bool LayerUpdateBuilder::modifyProperty(rtl::OUString const & _aName, sal_Int16 _nFlags, sal_Int16 _nFlagsMask, uno::Type const & _aType)
 155 {
 156     OSL_PRECOND(m_pCurrentNode && !m_pCurrentProp, "LayerUpdateBuilder: Illegal state for this operation");
 157
 158     PropertyUpdate * pNewProp = new PropertyUpdate(m_pCurrentNode,_aName,_nFlags,_nFlagsMask,_aType);
 159     rtl::Reference<ElementUpdate> xNewProp(pNewProp);
 160
 161     if (!m_pCurrentNode->addPropertyUpdate(xNewProp))
 162         return false;
 163
 164     m_pCurrentProp = pNewProp;
 165     return true;
 166 }
 167 // -----------------------------------------------------------------------------
 168
 169 bool LayerUpdateBuilder::setPropertyValue(uno::Any const & _aValue)
 170 {
 171     OSL_PRECOND(m_pCurrentProp, "LayerUpdateBuilder: Illegal state for property operation");
 172
 173     return m_pCurrentProp->setValue(_aValue);
 174 }
 175 // -----------------------------------------------------------------------------
 176
 177 bool LayerUpdateBuilder::setPropertyValueForLocale(uno::Any const & _aValue, rtl::OUString const & _aLocale)
 178 {
 179     OSL_PRECOND(m_pCurrentProp, "LayerUpdateBuilder: Illegal state for property operation");
 180
 181     return m_pCurrentProp->setValueFor(_aLocale, _aValue);
 182 }
 183 // -----------------------------------------------------------------------------
 184
 185 bool LayerUpdateBuilder::resetPropertyValue()
 186 {
 187     OSL_PRECOND(m_pCurrentProp, "LayerUpdateBuilder: Illegal state for property operation");
 188
 189     return m_pCurrentProp->resetValue();
 190 }
 191 // -----------------------------------------------------------------------------
 192
 193 bool LayerUpdateBuilder::resetPropertyValueForLocale(rtl::OUString const & _aLocale)
 194 {
 195     OSL_PRECOND(m_pCurrentProp, "LayerUpdateBuilder: Illegal state for property operation");
 196
 197     return m_pCurrentProp->resetValueFor(_aLocale);
 198 }
 199 // -----------------------------------------------------------------------------
 200
 201 bool LayerUpdateBuilder::finishProperty()
 202 {
 203     OSL_PRECOND(m_pCurrentProp, "LayerUpdateBuilder: Illegal state for property operation");
 204     if (!m_pCurrentProp) return false;
 205     m_pCurrentProp->finishValue();
 206
 207     OSL_ASSERT(m_pCurrentNode == m_pCurrentProp->getParent());
 208
 209     m_pCurrentProp = NULL;
 210     return true;
 211 }
 212 // -----------------------------------------------------------------------------
 213
 214 bool LayerUpdateBuilder::addNullProperty(rtl::OUString const & _aName, sal_Int16 _nFlags, uno::Type const & _aType)
 215 {
 216     OSL_PRECOND(m_pCurrentNode && !m_pCurrentProp, "LayerUpdateBuilder: Illegal state for this operation");
 217
 218     PropertyAdd * pNewProp = new PropertyAdd(m_pCurrentNode,_aName,_nFlags,_aType);
 219
 220     rtl::Reference<ElementUpdate> xNewProp(pNewProp);
 221
 222     if (!m_pCurrentNode->addPropertyUpdate(xNewProp))
 223         return false;
 224
 225     return true;
 226 }
 227 // -----------------------------------------------------------------------------
 228
 229 bool LayerUpdateBuilder::addProperty(rtl::OUString const & _aName, sal_Int16 _nFlags, uno::Any const & _aValue)
 230 {
 231     OSL_PRECOND(m_pCurrentNode && !m_pCurrentProp, "LayerUpdateBuilder: Illegal state for this operation");
 232
 233     PropertyAdd * pNewProp = new PropertyAdd(m_pCurrentNode,_aName,_nFlags,_aValue);
 234
 235     rtl::Reference<ElementUpdate> xNewProp(pNewProp);
 236
 237     if (!m_pCurrentNode->addPropertyUpdate(xNewProp))
 238         return false;
 239
 240     return true;
 241 }
 242 // -----------------------------------------------------------------------------
 243
 244 bool LayerUpdateBuilder::resetProperty(rtl::OUString const & _aName)
 245 {
 246     OSL_PRECOND(m_pCurrentNode && !m_pCurrentProp, "LayerUpdateBuilder: Illegal state for this operation");
 247
 248     PropertyReset * pNewProp = new PropertyReset(m_pCurrentNode,_aName);
 249
 250     rtl::Reference<ElementUpdate> xNewProp(pNewProp);
 251
 252     if (!m_pCurrentNode->addPropertyUpdate(xNewProp))
 253         return false;
 254
 255     return true;
 256 }
 257 // -----------------------------------------------------------------------------
 258
 259 bool LayerUpdateBuilder::finish()
 260 {
 261     if (!this->finishNode()) return false;
 262
 263     return m_pCurrentNode == NULL;
 264 }
 265 // -----------------------------------------------------------------------------
 266
 267 bool LayerUpdateBuilder::isEmpty() const
 268 {
 269     OSL_ENSURE( !m_pCurrentNode || !m_aUpdate.isEmpty(), "LayerUpdateBuilder: Invariant violation: got a current node without a layer");
 270     return m_aUpdate.isEmpty();
 271 }
 272 // -----------------------------------------------------------------------------
 273
 274 bool LayerUpdateBuilder::isActive() const
 275 {
 276     OSL_ENSURE( !m_pCurrentNode || !m_aUpdate.isEmpty(), "LayerUpdateBuilder: Invariant violation: got a current node without a layer");
 277     return m_pCurrentNode != 0;
 278 }
 279 // -----------------------------------------------------------------------------
 280 #if OSL_DEBUG_LEVEL > 0
 281 bool LayerUpdateBuilder::isComplete() const
 282 {
 283     OSL_ENSURE( !m_pCurrentNode || !m_aUpdate.isEmpty(), "LayerUpdateBuilder: Invariant violation: got a current node without a layer");
 284     return !m_aUpdate.isEmpty() && m_pCurrentNode == NULL;
 285 }
 286 #endif
 287 // -----------------------------------------------------------------------------
 288
 289 bool LayerUpdateBuilder::isPropertyActive() const
 290 {
 291     OSL_ENSURE( !m_pCurrentNode || !m_aUpdate.isEmpty(), "LayerUpdateBuilder: Invariant violation: got a current node without a layer");
 292     OSL_ENSURE(m_pCurrentNode || !m_pCurrentProp, "LayerUpdateBuilder: Invariant violation: got a current property without a node");
 293     return m_pCurrentProp != 0;
 294 }
 295 // -----------------------------------------------------------------------------
 296
 297 // -----------------------------------------------------------------------------
 298 // -----------------------------------------------------------------------------
 299     } // namespace backend
 300
 301 // -------------------------------------------------------------------------
 302 } // namespace configmgr