configmgr/source/xml/elementparser.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: elementparser.hxx,v $
  10  * $Revision: 1.7 $
  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 #ifndef CONFIGMGR_XML_ELEMENTPARSER_HXX
  32 #define CONFIGMGR_XML_ELEMENTPARSER_HXX
  33
  34 #include "elementinfo.hxx"
  35 #include "logger.hxx"
  36 #include <com/sun/star/xml/sax/XAttributeList.hpp>
  37
  38 namespace configmgr
  39 {
  40 // -----------------------------------------------------------------------------
  41     namespace xml
  42     {
  43 // -----------------------------------------------------------------------------
  44         namespace uno           = ::com::sun::star::uno;
  45         namespace sax           = ::com::sun::star::xml::sax;
  46
  47 // -----------------------------------------------------------------------------
  48         class ElementParser
  49         {
  50             Logger mLogger;
  51         public:
  52             class BadValueType
  53             {
  54                 rtl::OUString mMessage;
  55             public:
  56                 BadValueType(rtl::OUString const & aMessage) : mMessage(aMessage) {}
  57
  58                 rtl::OUString message() const { return mMessage.getStr(); }
  59             };
  60         public:
  61             explicit
  62             ElementParser(Logger const & xLogger)
  63             : mLogger(xLogger)
  64             {}
  65
  66             Logger const & logger() const { return mLogger; }
  67
  68             /// reset the parser for a new document
  69             void reset()
  70             {}
  71
  72             /// retrieve the (almost) complete information for an element
  73             ElementInfo parseElementInfo(rtl::OUString const& _sTag, uno::Reference< sax::XAttributeList > const& _xAttribs) const;
  74
  75             /// retrieve the node name for an element
  76             ElementType::Enum getNodeType(rtl::OUString const& _sTag, uno::Reference< sax::XAttributeList > const& xAttribs) const;
  77
  78             /// retrieve the node name for an element
  79             rtl::OUString getName(rtl::OUString const& _sTag, uno::Reference< sax::XAttributeList > const& xAttribs, ElementType::Enum eType = ElementType::unknown) const;
  80
  81             /// query whether the node has an operation
  82             Operation::Enum getOperation(uno::Reference< sax::XAttributeList > const& xAttribs, ElementType::Enum _eType) const;
  83
  84             /// retrieve the language (if any) stored in the attribute list
  85             bool getLanguage(uno::Reference< sax::XAttributeList > const& xAttribs, rtl::OUString & _rsLanguage) const;
  86
  87             /// reads attributes for nodes from the attribute list
  88             sal_Int16 getNodeFlags(uno::Reference< sax::XAttributeList > const& xAttribs, ElementType::Enum _eType) const;
  89
  90             /// retrieve element type and associated module name of a set,
  91             bool getSetElementType(uno::Reference< sax::XAttributeList > const& _xAttribs, rtl::OUString& _rsElementType, rtl::OUString& _rsElementTypeModule) const;
  92
  93             /// retrieve the instance type and associated module name of a instance,
  94             bool getInstanceType(uno::Reference< sax::XAttributeList > const& _xAttribs, rtl::OUString& _rsElementType, rtl::OUString& _rsElementTypeModule) const;
  95
  96             /// retrieve the component for an import or uses element,
  97             bool getImportComponent(uno::Reference< sax::XAttributeList > const& _xAttribs, rtl::OUString& _rsComponent) const;
  98
  99             /// retrieve element type and associated module name of a set,
 100             uno::Type getPropertyValueType(uno::Reference< sax::XAttributeList > const& _xAttribs) const;
 101                 // throw( BadValueType )
 102
 103             /// reads a value attribute from the attribute list
 104             bool isNull(uno::Reference< sax::XAttributeList > const& _xAttribs) const;
 105
 106             /// reads a value attribute from the attribute list
 107             rtl::OUString getSeparator(uno::Reference< sax::XAttributeList > const& _xAttribs) const;
 108
 109         // low-level internal methods
 110
 111             /// checks for presence of a boolean attribute and assigns its value if it exists (and is a bool)
 112             bool maybeGetAttribute(uno::Reference< sax::XAttributeList > const& _xAttribs, rtl::OUString const& _aAttributeName, bool& _rbAttributeValue) const;
 113
 114             /// checks for presence of an attribute and assigns its value if it exists
 115             bool maybeGetAttribute(uno::Reference< sax::XAttributeList > const& _xAttribs, rtl::OUString const& _aAttributeName, rtl::OUString& _rsAttributeValue) const;
 116         };
 117 // -----------------------------------------------------------------------------
 118
 119 // -----------------------------------------------------------------------------
 120     } // namespace xml
 121 // -----------------------------------------------------------------------------
 122 } // namespace configmgr
 123
 124 #endif
 125