configmgr/source/backend/basicupdatemerger.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: basicupdatemerger.cxx,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 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_configmgr.hxx"
  33
  34 #include "basicupdatemerger.hxx"
  35 #include "layerdefaultremover.hxx"
  36
  37 #ifndef INCLUDED_ALGORITHM
  38 #include <algorithm>
  39 #define INCLUDED_ALGORITHM
  40 #endif
  41 #ifndef INCLUDED_ITERATOR
  42 #include <iterator>
  43 #define INCLUDED_ITERATOR
  44 #endif
  45
  46 // -----------------------------------------------------------------------------
  47
  48 namespace configmgr
  49 {
  50 // -----------------------------------------------------------------------------
  51     namespace backend
  52     {
  53 // -----------------------------------------------------------------------------
  54
  55 BasicUpdateMerger::BasicUpdateMerger( uno::Reference< backenduno::XLayer > const & _xSourceLayer )
  56 : m_xSourceLayer(_xSourceLayer)
  57 , m_xResultHandler()
  58 , m_nNesting(0)
  59 , m_bSkipping(false)
  60 {
  61 }
  62 // -----------------------------------------------------------------------------
  63
  64 BasicUpdateMerger::~BasicUpdateMerger()
  65 {
  66 }
  67 // -----------------------------------------------------------------------------
  68
  69 void SAL_CALL BasicUpdateMerger::readData( uno::Reference< backenduno::XLayerHandler > const & _xResultHandler )
  70     throw ( backenduno::MalformedDataException, lang::NullPointerException,
  71             lang::WrappedTargetException, uno::RuntimeException)
  72 {
  73     if (!_xResultHandler.is())
  74     {
  75         rtl::OUString sMsg( RTL_CONSTASCII_USTRINGPARAM("UpdateMerger: Error - NULL output handler unexpected") );
  76         throw lang::NullPointerException(sMsg,*this);
  77     }
  78     if (!m_xSourceLayer.is())
  79     {
  80         rtl::OUString sMsg( RTL_CONSTASCII_USTRINGPARAM("UpdateMerger: Error - No source layer set") );
  81         throw lang::NullPointerException(sMsg,*this);
  82     }
  83
  84     try
  85     {
  86         m_xResultHandler = new LayerDefaultRemover(_xResultHandler);
  87         m_xSourceLayer->readData( this );
  88     }
  89     catch (uno::Exception & )
  90     {
  91         m_xResultHandler.clear();
  92         throw;
  93     }
  94
  95     m_xResultHandler.clear();
  96 }
  97 // -----------------------------------------------------------------------------
  98
  99 void SAL_CALL BasicUpdateMerger::startLayer(  )
 100     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 101 {
 102     if (m_nNesting)
 103         raiseMalformedDataException("UpdateMerger: Cannot start layer - layer already in progress");
 104
 105     m_bSkipping = false;
 106
 107     m_xResultHandler->startLayer();
 108 }
 109 // -----------------------------------------------------------------------------
 110
 111 void SAL_CALL BasicUpdateMerger::endLayer(  )
 112     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 113 {
 114     if (m_nNesting > 0)
 115         raiseMalformedDataException("UpdateMerger: Cannot end layer - data handling still in progress");
 116
 117     this->flushContext();
 118
 119     m_xResultHandler->endLayer();
 120 }
 121 // -----------------------------------------------------------------------------
 122
 123 void SAL_CALL BasicUpdateMerger::overrideNode( const rtl::OUString& aName, sal_Int16 aAttributes, sal_Bool bClear )
 124     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 125 {
 126     if (!isSkipping())
 127         m_xResultHandler->overrideNode(aName, aAttributes, bClear);
 128
 129     pushLevel(aName);
 130 }
 131 // -----------------------------------------------------------------------------
 132
 133 void SAL_CALL BasicUpdateMerger::addOrReplaceNode( const rtl::OUString& aName, sal_Int16 aAttributes )
 134     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 135 {
 136     if (!isSkipping())
 137         m_xResultHandler->addOrReplaceNode(aName, aAttributes);
 138
 139     pushLevel(aName);
 140 }
 141 // -----------------------------------------------------------------------------
 142
 143 void SAL_CALL BasicUpdateMerger::addOrReplaceNodeFromTemplate( const rtl::OUString& aName, const backenduno::TemplateIdentifier& aTemplate, sal_Int16 aAttributes )
 144     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 145 {
 146     if (!isSkipping())
 147         m_xResultHandler->addOrReplaceNodeFromTemplate(aName, aTemplate, aAttributes);
 148
 149     pushLevel(aName);
 150 }
 151 // -----------------------------------------------------------------------------
 152
 153 void SAL_CALL BasicUpdateMerger::endNode(  )
 154     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 155 {
 156     if (!isSkipping())
 157         m_xResultHandler->endNode();
 158
 159     popLevel();
 160 }
 161 // -----------------------------------------------------------------------------
 162
 163 void SAL_CALL BasicUpdateMerger::dropNode( const rtl::OUString& aName )
 164     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 165 {
 166     if (!isSkipping())
 167         m_xResultHandler->dropNode(aName);
 168 }
 169 // -----------------------------------------------------------------------------
 170
 171 void SAL_CALL BasicUpdateMerger::overrideProperty( const rtl::OUString& aName, sal_Int16 aAttributes, const uno::Type& aType, sal_Bool bClear )
 172     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 173 {
 174     if (!isSkipping())
 175         m_xResultHandler->overrideProperty(aName, aAttributes, aType, bClear);
 176
 177     pushLevel( rtl::OUString() ); // do not match context path to property names
 178 }
 179 // -----------------------------------------------------------------------------
 180
 181 void SAL_CALL BasicUpdateMerger::endProperty(  )
 182     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 183 {
 184     if (!isSkipping())
 185         m_xResultHandler->endProperty();
 186
 187     popLevel();
 188 }
 189 // -----------------------------------------------------------------------------
 190
 191 void SAL_CALL BasicUpdateMerger::setPropertyValue( const uno::Any& aValue )
 192     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 193 {
 194     if (!isSkipping())
 195         m_xResultHandler->setPropertyValue(aValue);
 196 }
 197 // -----------------------------------------------------------------------------
 198
 199 void SAL_CALL BasicUpdateMerger::setPropertyValueForLocale( const uno::Any& aValue, const rtl::OUString & aLocale )
 200     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 201 {
 202     if (!isSkipping())
 203         m_xResultHandler->setPropertyValueForLocale(aValue,aLocale);
 204 }
 205 // -----------------------------------------------------------------------------
 206
 207 void SAL_CALL BasicUpdateMerger::addProperty( const rtl::OUString& aName, sal_Int16 aAttributes, const uno::Type& aType )
 208     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 209 {
 210     if (!isSkipping())
 211         m_xResultHandler->addProperty(aName, aAttributes, aType);
 212 }
 213 // -----------------------------------------------------------------------------
 214
 215 void SAL_CALL BasicUpdateMerger::addPropertyWithValue( const rtl::OUString& aName, sal_Int16 aAttributes, const uno::Any& aValue )
 216     throw (backenduno::MalformedDataException, lang::WrappedTargetException, uno::RuntimeException)
 217 {
 218     if (!isSkipping())
 219         m_xResultHandler->addPropertyWithValue(aName, aAttributes, aValue);
 220 }
 221 // -----------------------------------------------------------------------------
 222
 223 void BasicUpdateMerger::raiseMalformedDataException(sal_Char const * pMsg)
 224 {
 225     rtl::OUString sMsg = rtl::OUString::createFromAscii(pMsg);
 226
 227     throw backenduno::MalformedDataException(sMsg, *this, uno::Any());
 228 }
 229 // -----------------------------------------------------------------------------
 230
 231 void BasicUpdateMerger::startSkipping()
 232 {
 233     OSL_PRECOND( m_nNesting == 0, "BasicUpdateMerger: starting to skip, while already forwarding data");
 234     m_nNesting = 1;
 235     m_bSkipping = true;
 236     OSL_POSTCOND( isHandling(), "BasicUpdateMerger: isHandling() is broken");
 237     OSL_POSTCOND( isSkipping(), "BasicUpdateMerger: isSkipping() is broken");
 238 }
 239 // -----------------------------------------------------------------------------
 240
 241
 242 void BasicUpdateMerger::pushLevel(rtl::OUString const & _aContext)
 243 {
 244     if (m_nNesting > 0)
 245     {
 246         ++m_nNesting;
 247         OSL_POSTCOND( isHandling(), "BasicUpdateMerger: level counting is broken" );
 248     }
 249     else if (m_nNesting < 0)
 250     {
 251         OSL_POSTCOND( isHandling(), "BasicUpdateMerger: level counting is broken" );
 252     }
 253     else if (m_aSearchPath.empty())
 254     {
 255         ++m_nNesting;
 256         OSL_POSTCOND( isHandling(), "BasicUpdateMerger: level counting is broken" );
 257     }
 258     else if ( m_aSearchPath.back().equals(_aContext) ) // search path is reverse - see findContext()
 259     {
 260         OSL_ENSURE( m_nNesting == 0, "BasicUpdateMerger: level count while searching must be zero");
 261
 262         m_aSearchPath.pop_back();
 263     }
 264     else // start forwarding
 265     {
 266         m_nNesting = 1;
 267         OSL_POSTCOND( isHandling(), "BasicUpdateMerger: level counting is broken" );
 268         OSL_POSTCOND(!isSkipping(), "BasicUpdateMerger: skip flag set while searching " );
 269     }
 270 }
 271 // -----------------------------------------------------------------------------
 272
 273 void BasicUpdateMerger::popLevel()
 274 {
 275     OSL_PRECOND( isHandling(), "BasicUpdateMerger: ending a node that wasn't handled here");
 276     if (m_nNesting > 0)
 277     {
 278         if (--m_nNesting == 0)
 279             m_bSkipping = false;
 280     }
 281     else if (m_nNesting == 0) // ending a context level, but the context is not yet gone
 282     {
 283         OSL_ENSURE( !m_aSearchPath.empty(), "BasicUpdateMerger: flushing a context that was already found");
 284         flushContext();
 285         leaveContext();
 286     }
 287     else
 288     {
 289         OSL_ENSURE( m_aSearchPath.empty(), "BasicUpdateMerger: Left an unfinished context" );
 290     }
 291 }
 292 // -----------------------------------------------------------------------------
 293
 294 void BasicUpdateMerger::findContext(std::vector<rtl::OUString> const & _aContext)
 295 {
 296     // make the context a *reverse* copy of the context path
 297     OSL_PRECOND( ! isHandling(), "BasicUpdateMerger: starting context search while still handling data");
 298     m_aSearchPath.clear();
 299     m_aSearchPath.reserve(_aContext.size());
 300     std::copy( _aContext.rbegin(), _aContext.rend(), std::back_inserter(m_aSearchPath) );
 301 }
 302 // -----------------------------------------------------------------------------
 303
 304 void BasicUpdateMerger::leaveContext()
 305 {
 306     OSL_PRECOND( !isHandling(), "BasicUpdateMerger: ending the context while still handling data or seaching the context");
 307
 308     // force
 309     m_nNesting = -1;
 310
 311     OSL_POSTCOND( ! isSkipping(), "BasicUpdateMerger: ending the context node while still skipping data");
 312     OSL_POSTCOND( isHandling(), "BasicUpdateMerger: cannot mark context as being handled to the end.");
 313 }
 314 // -----------------------------------------------------------------------------
 315
 316 void BasicUpdateMerger::flushContext()
 317 {
 318     std::vector<rtl::OUString>::size_type nNesting = m_aSearchPath.size();
 319
 320     while (!m_aSearchPath.empty())
 321     {
 322         m_xResultHandler->overrideNode(m_aSearchPath.back(), 0, false);
 323         m_aSearchPath.pop_back();
 324     }
 325     this->flushUpdate();
 326
 327     while (nNesting > 0)
 328     {
 329         m_xResultHandler->endNode();
 330         --nNesting;
 331     }
 332 }
 333 // -----------------------------------------------------------------------------
 334
 335 // -----------------------------------------------------------------------------
 336 // -----------------------------------------------------------------------------
 337     } // namespace
 338
 339 // -----------------------------------------------------------------------------
 340 } // namespace
 341