| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| |
| #ifndef _XMLOFF_PROPERTYSETMAPPER_HXX |
| #define _XMLOFF_PROPERTYSETMAPPER_HXX |
| |
| #include "sal/config.h" |
| #include "xmloff/dllapi.h" |
| #include <com/sun/star/uno/Sequence.hxx> |
| #include <com/sun/star/uno/Any.hxx> |
| #include <com/sun/star/beans/XPropertySet.hpp> |
| |
| #ifndef __SGI_STL_VECTOR |
| #include <vector> |
| #endif |
| #include <xmloff/uniref.hxx> |
| #include <xmloff/maptype.hxx> |
| #include <xmloff/xmltypes.hxx> |
| #include <xmloff/prhdlfac.hxx> |
| |
| #include <tools/debug.hxx> |
| |
| class SvXMLUnitConverter; |
| class XMLPropertyHandler; |
| |
| /////////////////////////////////////////////////////////////////////////// |
| // |
| /** Helper-class for XML-im/export: |
| - Holds a pointer to a given array of XMLPropertyMapEntry |
| - Provides several methods to access data from this array |
| - Holds a Sequence of XML-names (for properties) |
| - The filter takes all properties of the XPropertySet which are also |
| in the XMLPropertyMapEntry and which are have not a default value |
| and put them into a vector of XMLPropertyStae |
| - this class knows how to compare, im/export properties |
| |
| Attention: At all methods, which get an index as parameter, there is no |
| range validation to save runtime !! |
| */ |
| struct XMLPropertySetMapperEntry_Impl |
| { |
| ::rtl::OUString sXMLAttributeName; |
| ::rtl::OUString sAPIPropertyName; |
| sal_uInt16 nXMLNameSpace; |
| sal_Int32 nType; |
| sal_Int16 nContextId; |
| SvtSaveOptions::ODFDefaultVersion nEarliestODFVersionForExport; |
| const XMLPropertyHandler *pHdl; |
| |
| XMLPropertySetMapperEntry_Impl( |
| const XMLPropertyMapEntry& rMapEntry, |
| const UniReference< XMLPropertyHandlerFactory >& rFactory ); |
| |
| XMLPropertySetMapperEntry_Impl( |
| const XMLPropertySetMapperEntry_Impl& rEntry ); |
| |
| sal_uInt32 GetPropType() const { return nType & XML_TYPE_PROP_MASK; } |
| }; |
| |
| class XMLOFF_DLLPUBLIC XMLPropertySetMapper : public UniRefBase |
| { |
| ::std::vector< XMLPropertySetMapperEntry_Impl > aMapEntries; |
| ::std::vector< UniReference < XMLPropertyHandlerFactory > > aHdlFactories; |
| |
| public: |
| /** The last element of the XMLPropertyMapEntry-array must contain NULL-values */ |
| XMLPropertySetMapper( |
| const XMLPropertyMapEntry* pEntries, |
| const UniReference< XMLPropertyHandlerFactory >& rFactory ); |
| virtual ~XMLPropertySetMapper(); |
| |
| void AddMapperEntry( const UniReference < XMLPropertySetMapper >& rMapper ); |
| |
| /** Return number of entries in input-array */ |
| sal_Int32 GetEntryCount() const { return aMapEntries.size(); } |
| |
| /** Returns the flags of an entry */ |
| sal_uInt32 GetEntryFlags( sal_Int32 nIndex ) const |
| { |
| DBG_ASSERT( (nIndex >= 0) && (nIndex < (sal_Int32)aMapEntries.size() ), "illegal access to invalid entry!" ); |
| return aMapEntries[nIndex].nType & ~MID_FLAG_MASK; |
| } |
| |
| /** Returns the type of an entry */ |
| sal_uInt32 GetEntryType( sal_Int32 nIndex, |
| sal_Bool bWithFlags = sal_True ) const |
| { |
| DBG_ASSERT( (nIndex >= 0) && (nIndex < (sal_Int32)aMapEntries.size() ), "illegal access to invalid entry!" ); |
| sal_uInt32 nType = aMapEntries[nIndex].nType; |
| if( !bWithFlags ) |
| nType = nType & MID_FLAG_MASK; |
| return nType; |
| } |
| |
| /** Returns the namespace-key of an entry */ |
| sal_uInt16 GetEntryNameSpace( sal_Int32 nIndex ) const |
| { |
| DBG_ASSERT( (nIndex >= 0) && (nIndex < (sal_Int32)aMapEntries.size() ), "illegal access to invalid entry!" ); |
| return aMapEntries[nIndex].nXMLNameSpace; |
| } |
| |
| /** Returns the 'local' XML-name of the entry */ |
| const ::rtl::OUString& GetEntryXMLName( sal_Int32 nIndex ) const |
| { |
| DBG_ASSERT( (nIndex >= 0) && (nIndex < (sal_Int32)aMapEntries.size() ), "illegal access to invalid entry!" ); |
| return aMapEntries[nIndex].sXMLAttributeName; |
| } |
| |
| /** Returns the entry API name */ |
| const ::rtl::OUString& GetEntryAPIName( sal_Int32 nIndex ) const |
| { |
| DBG_ASSERT( (nIndex >= 0) && (nIndex < (sal_Int32)aMapEntries.size() ), "illegal access to invalid entry!" ); |
| return aMapEntries[nIndex].sAPIPropertyName; |
| } |
| |
| /** returns the entry context id. -1 is a valid index here. */ |
| sal_Int16 GetEntryContextId( sal_Int32 nIndex ) const |
| { |
| DBG_ASSERT( (nIndex >= -1) && (nIndex < (sal_Int32)aMapEntries.size() ), "illegal access to invalid entry!" ); |
| return nIndex == -1 ? 0 : aMapEntries[nIndex].nContextId; |
| } |
| |
| /** returns the earliest odf version for which this property should be exported. */ |
| SvtSaveOptions::ODFDefaultVersion GetEarliestODFVersionForExport( sal_Int32 nIndex ) const |
| { |
| DBG_ASSERT( (nIndex >= -1) && (nIndex < (sal_Int32)aMapEntries.size() ), "illegal access to invalid entry!" ); |
| return nIndex == -1 ? SvtSaveOptions::ODFVER_UNKNOWN : aMapEntries[nIndex].nEarliestODFVersionForExport; |
| } |
| |
| /** Returns the index of an entry with the given XML-name and namespace |
| If there is no matching entry the method returns -1 */ |
| sal_Int32 GetEntryIndex( sal_uInt16 nNamespace, |
| const ::rtl::OUString& rStrName, |
| sal_uInt32 nPropType, |
| sal_Int32 nStartAt = -1 ) const; |
| |
| /** Retrieves a PropertyHandler for that property wich placed at nIndex in the XMLPropertyMapEntry-array */ |
| const XMLPropertyHandler* GetPropertyHandler( sal_Int32 nIndex ) const |
| { |
| DBG_ASSERT( (nIndex >= 0) && (nIndex < (sal_Int32)aMapEntries.size() ), "illegal access to invalid entry!" ); |
| return aMapEntries[nIndex].pHdl; |
| } |
| |
| /** import/export |
| This methods calls the respective im/export-method of the respective PropertyHandler. */ |
| virtual sal_Bool exportXML( ::rtl::OUString& rStrExpValue, |
| const XMLPropertyState& rProperty, |
| const SvXMLUnitConverter& rUnitConverter ) const; |
| virtual sal_Bool importXML( const ::rtl::OUString& rStrImpValue, |
| XMLPropertyState& rProperty, |
| const SvXMLUnitConverter& rUnitConverter ) const; |
| |
| /** searches for an entry that matches the given api name, namespace and local name or -1 if nothing found */ |
| sal_Int32 FindEntryIndex( const sal_Char* sApiName, |
| sal_uInt16 nNameSpace, |
| const ::rtl::OUString& sXMLName ) const; |
| |
| /** searches for an entry that matches the given ContextId or gives -1 if nothing found */ |
| sal_Int32 FindEntryIndex( const sal_Int16 nContextId ) const; |
| |
| /** Remove an entry */ |
| void RemoveEntry( sal_Int32 nIndex ); |
| }; |
| |
| #endif // _XMLOFF_PROPERTYSETMAPPER_HXX |
