xmloff/source/forms/propertyimport.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_XMLOFF_SOURCE_FORMS_PROPERTYIMPORT_HXX
  21 #define INCLUDED_XMLOFF_SOURCE_FORMS_PROPERTYIMPORT_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <set>
  26
  27 #include <xmloff/xmlictxt.hxx>
  28 #include "formattributes.hxx"
  29 #include <rtl/ref.hxx>
  30 #include <com/sun/star/beans/PropertyValue.hpp>
  31 #include "layerimport.hxx"
  32
  33 namespace com { namespace sun { namespace star { namespace util {
  34     struct Time;
  35     struct Date;
  36 } } } }
  37
  38 namespace xmloff
  39 {
  40
  41     //= PropertyConversion
  42     class PropertyConversion
  43     {
  44     public:
  45         static css::uno::Any convertString(
  46             const css::uno::Type& _rExpectedType,
  47             const OUString& _rReadCharacters,
  48             const SvXMLEnumMapEntry* _pEnumMap = nullptr,
  49             const bool _bInvertBoolean = false
  50         );
  51
  52         static css::uno::Type xmlTypeToUnoType( const OUString& _rType );
  53     };
  54
  55     class OFormLayerXMLImport_Impl;
  56     //= OPropertyImport
  57     /** Helper class for importing property values
  58
  59         <p>This class imports properties which are stored as attributes as well as properties which
  60         are stored in </em>&lt;form:properties&gt;</em> elements.</p>
  61     */
  62     class OPropertyImport : public SvXMLImportContext
  63     {
  64         friend class OSinglePropertyContext;
  65         friend class OListPropertyContext;
  66
  67     protected:
  68         typedef ::std::vector< css::beans::PropertyValue > PropertyValueArray;
  69         PropertyValueArray          m_aValues;
  70         PropertyValueArray          m_aGenericValues;
  71             // the values which the instance collects between StartElement and EndElement
  72
  73         typedef std::set<OUString> StringSet;
  74         StringSet                   m_aEncounteredAttributes;
  75
  76         OFormLayerXMLImport_Impl&       m_rContext;
  77
  78         bool                    m_bTrackAttributes;
  79
  80         // TODO: think about the restriction that the class does not know anything about the object it is importing.
  81         // Perhaps this object should be known to the class, so setting the properties ('normal' ones as well as
  82         // style properties) can be done in our own EndElement instead of letting derived classes do this.
  83
  84     public:
  85         OPropertyImport(OFormLayerXMLImport_Impl& _rImport, sal_uInt16 _nPrefix, const OUString& _rName);
  86
  87         virtual SvXMLImportContext* CreateChildContext(
  88             sal_uInt16 _nPrefix, const OUString& _rLocalName,
  89             const css::uno::Reference< css::xml::sax::XAttributeList >& _rxAttrList) override;
  90
  91         virtual void StartElement(
  92             const css::uno::Reference< css::xml::sax::XAttributeList >& _rxAttrList) override;
  93         virtual void Characters(const OUString& _rChars) override;
  94
  95     protected:
  96         /** handle one single attribute.
  97
  98             <p>This is called for every attribute of the element. This class' implementation checks if the attribute
  99             describes a property, if so, it is added to <member>m_aValues</member>.</p>
 100
 101             <p>All non-property attributes should be handled in derived classes.</p>
 102
 103             @param _nNamespaceKey
 104                 key of the namespace used in the attribute
 105             @param _rLocalName
 106                 local (relative to the namespace) attribute name
 107             @param _rValue
 108                 attribute value
 109         */
 110         virtual bool handleAttribute(sal_uInt16 _nNamespaceKey,
 111             const OUString& _rLocalName,
 112             const OUString& _rValue);
 113
 114         /** determine if the element imported by the object had an given attribute.
 115             <p>Please be aware of the fact that the name given must be a local name, i.e. not contain a namespace.
 116             All form relevant attributes are in the same namespace, so this would be an redundant information.</p>
 117         */
 118         bool    encounteredAttribute(const OUString& _rAttributeName) const;
 119
 120         /** enables the tracking of the encountered attributes
 121             <p>The tracking will raise the import costs a little bit, but it's cheaper than
 122             derived classes tracking this themself.</p>
 123         */
 124         void        enableTrackAttributes() { m_bTrackAttributes = true; }
 125
 126         inline void implPushBackPropertyValue(const css::beans::PropertyValue& _rProp)
 127         {
 128             m_aValues.push_back(_rProp);
 129         }
 130
 131         inline void implPushBackPropertyValue( const OUString& _rName, const css::uno::Any& _rValue )
 132         {
 133             m_aValues.push_back( css::beans::PropertyValue(
 134                 _rName, -1, _rValue, css::beans::PropertyState_DIRECT_VALUE ) );
 135         }
 136
 137         inline void implPushBackGenericPropertyValue(const css::beans::PropertyValue& _rProp)
 138         {
 139             m_aGenericValues.push_back(_rProp);
 140         }
 141     };
 142     typedef tools::SvRef<OPropertyImport> OPropertyImportRef;
 143
 144     //= OPropertyElementsContext
 145     /** helper class for importing the &lt;form:properties&gt; element
 146     */
 147     class OPropertyElementsContext : public SvXMLImportContext
 148     {
 149     protected:
 150         OPropertyImportRef  m_xPropertyImporter;    // to add the properties
 151
 152     public:
 153         OPropertyElementsContext(SvXMLImport& _rImport, sal_uInt16 _nPrefix, const OUString& _rName,
 154                 const OPropertyImportRef& _rPropertyImporter);
 155
 156         virtual SvXMLImportContext* CreateChildContext(
 157             sal_uInt16 _nPrefix, const OUString& _rLocalName,
 158             const css::uno::Reference< css::xml::sax::XAttributeList >& _rxAttrList) override;
 159
 160 #if OSL_DEBUG_LEVEL > 0
 161         virtual void StartElement(
 162             const css::uno::Reference< css::xml::sax::XAttributeList >& _rxAttrList) override;
 163         virtual void Characters(const OUString& _rChars) override;
 164 #endif
 165     };
 166
 167     //= OSinglePropertyContext
 168     /** helper class for importing a single &lt;form:property&gt; element
 169     */
 170     class OSinglePropertyContext : public SvXMLImportContext
 171     {
 172         OPropertyImportRef          m_xPropertyImporter;    // to add the properties
 173
 174     public:
 175         OSinglePropertyContext(SvXMLImport& _rImport, sal_uInt16 _nPrefix, const OUString& _rName,
 176                 const OPropertyImportRef& _rPropertyImporter);
 177
 178         virtual SvXMLImportContext* CreateChildContext(
 179             sal_uInt16 _nPrefix, const OUString& _rLocalName,
 180             const css::uno::Reference< css::xml::sax::XAttributeList >& _rxAttrList) override;
 181
 182         virtual void StartElement(
 183             const css::uno::Reference< css::xml::sax::XAttributeList >& _rxAttrList) override;
 184     };
 185
 186     //= OListPropertyContext
 187     class OListPropertyContext : public SvXMLImportContext
 188     {
 189         OPropertyImportRef                  m_xPropertyImporter;
 190         OUString                     m_sPropertyName;
 191         OUString                     m_sPropertyType;
 192         ::std::vector< OUString >    m_aListValues;
 193
 194     public:
 195         OListPropertyContext( SvXMLImport& _rImport, sal_uInt16 _nPrefix, const OUString& _rName,
 196                 const OPropertyImportRef& _rPropertyImporter );
 197
 198         virtual void StartElement(
 199             const css::uno::Reference< css::xml::sax::XAttributeList >& _rxAttrList ) override;
 200
 201         virtual void EndElement() override;
 202
 203         virtual SvXMLImportContext* CreateChildContext(
 204             sal_uInt16 _nPrefix, const OUString& _rLocalName,
 205             const css::uno::Reference< css::xml::sax::XAttributeList >& _rxAttrList) override;
 206     };
 207
 208     //= OListValueContext
 209     class OListValueContext : public SvXMLImportContext
 210     {
 211         OUString& m_rListValueHolder;
 212
 213     public:
 214         OListValueContext( SvXMLImport& _rImport, sal_uInt16 _nPrefix, const OUString& _rName,
 215             OUString& _rListValueHolder );
 216
 217         virtual void StartElement(
 218             const css::uno::Reference< css::xml::sax::XAttributeList >& _rxAttrList ) override;
 219     };
 220
 221 }   // namespace xmloff
 222
 223 #endif // INCLUDED_XMLOFF_SOURCE_FORMS_PROPERTYIMPORT_HXX
 224
 225 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */