1 /************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27 28 #ifndef _COMPHELPER_OFOPXMLHELPER_HXX 29 #define _COMPHELPER_OFOPXMLHELPER_HXX 30 31 #ifndef _COM_SUN_STAR_XML_SAX_XDUCUMENTHANDLER_HPP_ 32 #include <com/sun/star/xml/sax/XDocumentHandler.hpp> 33 #endif 34 #include <com/sun/star/beans/StringPair.hpp> 35 #include <com/sun/star/io/XInputStream.hpp> 36 #include <com/sun/star/io/XOutputStream.hpp> 37 #include <cppuhelper/implbase1.hxx> 38 #include <comphelper/comphelperdllapi.h> 39 40 41 namespace comphelper 42 { 43 44 // this helper class is designed to allow to parse ContentType- and Relationship-related information from OfficeOpenXML format 45 class COMPHELPER_DLLPUBLIC OFOPXMLHelper : public cppu::WeakImplHelper1 < com::sun::star::xml::sax::XDocumentHandler > 46 { 47 sal_uInt16 m_nFormat; // which format to parse 48 49 // Relations info related strings 50 ::rtl::OUString m_aRelListElement; 51 ::rtl::OUString m_aRelElement; 52 ::rtl::OUString m_aIDAttr; 53 ::rtl::OUString m_aTypeAttr; 54 ::rtl::OUString m_aTargetModeAttr; 55 ::rtl::OUString m_aTargetAttr; 56 57 // ContentType related strings 58 ::rtl::OUString m_aTypesElement; 59 ::rtl::OUString m_aDefaultElement; 60 ::rtl::OUString m_aOverrideElement; 61 ::rtl::OUString m_aExtensionAttr; 62 ::rtl::OUString m_aPartNameAttr; 63 ::rtl::OUString m_aContentTypeAttr; 64 65 ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::StringPair > > m_aResultSeq; 66 ::com::sun::star::uno::Sequence< ::rtl::OUString > m_aElementsSeq; // stack of elements being parsed 67 68 OFOPXMLHelper( sal_uInt16 nFormat ); // must not be created directly 69 ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::StringPair > > GetParsingResult(); 70 71 static COMPHELPER_DLLPRIVATE ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::StringPair > > SAL_CALL ReadSequence_Impl( const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& xInStream, const ::rtl::OUString& aStringID, sal_uInt16 nFormat, const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > xFactory ) 72 throw( ::com::sun::star::uno::Exception ); 73 74 public: 75 ~OFOPXMLHelper(); 76 77 // returns sequence of elements, where each element is described by sequence of tags, 78 // where each tag is described by StringPair ( First - name, Second - value ) 79 // the first tag of each element sequence must be "Id" 80 static 81 ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::StringPair > > 82 SAL_CALL 83 ReadRelationsInfoSequence( 84 const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& xInStream, 85 const ::rtl::OUString aStreamName, 86 const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > xFactory ) 87 throw( ::com::sun::star::uno::Exception ); 88 89 // returns sequence containing two entries of type sequence<StringPair> 90 // the first sequence describes "Default" elements, where each element is described 91 // by StringPair object ( First - Extension, Second - ContentType ) 92 // the second sequence describes "Override" elements, where each element is described 93 // by StringPair object ( First - PartName, Second - ContentType ) 94 static 95 ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::StringPair > > 96 SAL_CALL 97 ReadContentTypeSequence( 98 const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& xInStream, 99 const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > xFactory ) 100 throw( ::com::sun::star::uno::Exception ); 101 102 // writes sequence of elements, where each element is described by sequence of tags, 103 // where each tag is described by StringPair ( First - name, Second - value ) 104 // the first tag of each element sequence must be "Id" 105 static 106 void SAL_CALL WriteRelationsInfoSequence( 107 const ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream >& xOutStream, 108 const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::StringPair > >& aSequence, 109 const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > xFactory ) 110 throw( ::com::sun::star::uno::Exception ); 111 112 // writes two entries of type sequence<StringPair> 113 // the first sequence describes "Default" elements, where each element is described 114 // by StringPair object ( First - Extension, Second - ContentType ) 115 // the second sequence describes "Override" elements, where each element is described 116 // by StringPair object ( First - PartName, Second - ContentType ) 117 static 118 void SAL_CALL WriteContentSequence( 119 const ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream >& xOutStream, 120 const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::StringPair >& aDefaultsSequence, 121 const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::StringPair >& aOverridesSequence, 122 const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory > xFactory ) 123 throw( ::com::sun::star::uno::Exception ); 124 125 // XDocumentHandler 126 virtual void SAL_CALL startDocument() throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException); 127 virtual void SAL_CALL endDocument() throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException); 128 virtual void SAL_CALL startElement( const ::rtl::OUString& aName, const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& xAttribs ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException); 129 virtual void SAL_CALL endElement( const ::rtl::OUString& aName ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException); 130 virtual void SAL_CALL characters( const ::rtl::OUString& aChars ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException); 131 virtual void SAL_CALL ignorableWhitespace( const ::rtl::OUString& aWhitespaces ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException); 132 virtual void SAL_CALL processingInstruction( const ::rtl::OUString& aTarget, const ::rtl::OUString& aData ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException); 133 virtual void SAL_CALL setDocumentLocator( const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XLocator >& xLocator ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException); 134 }; 135 136 } // namespace comphelper 137 138 #endif 139 140