configmgr/source/backend/binaryreadhandler.hxx

   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: binaryreadhandler.hxx,v $
  10  * $Revision: 1.11 $
  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 #ifndef CONFIGMGR_BINARYREADHANDLER_HXX
  31 #define CONFIGMGR_BINARYREADHANDLER_HXX
  32
  33 #include "binaryreader.hxx"
  34 #include "componentdatahelper.hxx"
  35 #include "valuenode.hxx"
  36 #include "binarytype.hxx"
  37 #include "attributes.hxx"
  38 #include "matchlocale.hxx"
  39 #include <com/sun/star/configuration/backend/XLayer.hpp>
  40 #include <com/sun/star/io/IOException.hpp>
  41
  42 #ifndef INCLUDED_MEMORY
  43 #include <memory>
  44 #define INCLUDED_MEMORY
  45 #endif // INCLUDED_MEMORY
  46
  47 #ifndef INCLUDED_VECTOR
  48 #include <vector>
  49 #define INCLUDED_VECTOR
  50 #endif // INCLUDED_VECTOR
  51
  52
  53 namespace configmgr
  54 {
  55     // -----------------------------------------------------------------------------
  56     namespace backend
  57     {
  58         namespace css = com::sun::star;
  59
  60         namespace io   = css::io;
  61         namespace uno  = css::uno;
  62         namespace backenduno = css::configuration::backend  ;
  63
  64         // -----------------------------------------------------------------------------
  65
  66         class BinaryReadHandler
  67         {
  68             BinaryReader         m_BinaryReader;
  69             ComponentDataFactory m_aNodeFactory;
  70             rtl::OUString        m_aComponentName;
  71
  72         public:
  73             BinaryReadHandler(rtl::OUString const & _aFileURL, rtl::OUString const & _aComponentName, uno::Reference<lang::XMultiServiceFactory> const & _aFactory);
  74             ~BinaryReadHandler();
  75
  76             bool validateHeader(    const uno::Reference<backenduno::XLayer> * pLayers,
  77                                     sal_Int32 nNumLayers,
  78                                     const rtl::OUString& _aSchemaVersion,
  79                                     com::sun::star::lang::Locale const & aRequestedLocale,
  80                                     std::vector< com::sun::star::lang::Locale > & outKnownLocales)
  81                 SAL_THROW( (io::IOException, uno::RuntimeException) );
  82
  83             std::auto_ptr<ISubtree> readComponentTree()
  84                 SAL_THROW( (io::IOException, uno::RuntimeException) );
  85
  86             std::auto_ptr<ISubtree> readTemplatesTree()
  87                 SAL_THROW( (io::IOException, uno::RuntimeException) );
  88
  89         private:
  90             std::auto_ptr<ISubtree> readToplevelTree()
  91                 SAL_THROW( (io::IOException, uno::RuntimeException) );
  92
  93             void readChildren(ISubtree & rTree)
  94                 SAL_THROW( (io::IOException, uno::RuntimeException) );
  95
  96         private:
  97             bool verifyFileHeader(  const uno::Reference<backenduno::XLayer> * pLayers,
  98                                     sal_Int32 nNumLayers,
  99                                     const rtl::OUString& _aSchemaVersion,
 100                                     com::sun::star::lang::Locale const & aRequestedLocale,
 101                                     std::vector< com::sun::star::lang::Locale > & outKnownLocales);
 102
 103             bool isUptodate(const std::vector<rtl::OUString> & _timeStamps)
 104                 SAL_THROW( (io::IOException, uno::RuntimeException) );
 105
 106             void readChildNodes(ISubtree & rSubTree)
 107                 SAL_THROW( (io::IOException, uno::RuntimeException) );
 108
 109             binary::NodeType::Type readNodeType()
 110                 SAL_THROW( (io::IOException, uno::RuntimeException) );
 111
 112             binary::ValueFlags::Type readValueFlags(bool& bSeq, bool& hasValue, bool& hasDefault )
 113                 SAL_THROW( (io::IOException, uno::RuntimeException) );
 114
 115             void readAttributes(node::Attributes  &_aAttributes)
 116                 SAL_THROW( (io::IOException, uno::RuntimeException) );
 117
 118             void readGroup(rtl::OUString &_aName, node::Attributes &_aAttributes)
 119                 SAL_THROW( (io::IOException, uno::RuntimeException) );
 120
 121             void readSet(rtl::OUString &_aName, node::Attributes &_aAttributes,
 122                                             rtl::OUString &_sInstanceName, rtl::OUString &_sInstanceModule)
 123                 SAL_THROW( (io::IOException, uno::RuntimeException) );
 124
 125             void readValue(rtl::OUString &_aName, node::Attributes &_aAttributes,
 126                                               uno::Any& _aValue, uno::Any& _aDefaultValue,uno::Type& _aType)
 127                 SAL_THROW( (io::IOException, uno::RuntimeException) );
 128
 129             void readName(rtl::OUString &_aString)
 130                 SAL_THROW( (io::IOException, uno::RuntimeException) );
 131         };
 132     // ---------------------------------------------------------------------------
 133     }
 134  // -----------------------------------------------------------------------------
 135 }// namespace configmgr
 136 #endif