| /************************************************************** |
| * |
| * 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 OOX_CORE_FILTERBASE_HXX |
| #define OOX_CORE_FILTERBASE_HXX |
| |
| #include <memory> |
| #include <com/sun/star/beans/NamedValue.hpp> |
| #include <com/sun/star/document/XExporter.hpp> |
| #include <com/sun/star/document/XFilter.hpp> |
| #include <com/sun/star/document/XImporter.hpp> |
| #include <com/sun/star/io/XInputStream.hpp> |
| #include <com/sun/star/io/XOutputStream.hpp> |
| #include <com/sun/star/io/XStream.hpp> |
| #include <com/sun/star/lang/XInitialization.hpp> |
| #include <com/sun/star/lang/XServiceInfo.hpp> |
| #include <cppuhelper/basemutex.hxx> |
| #include <cppuhelper/implbase5.hxx> |
| #include "oox/helper/binarystreambase.hxx" |
| #include "oox/helper/storagebase.hxx" |
| #include "oox/dllapi.h" |
| |
| namespace com { namespace sun { namespace star { |
| namespace awt { struct DeviceInfo; } |
| namespace frame { class XFrame; } |
| namespace frame { class XModel; } |
| namespace graphic { class XGraphic; } |
| namespace io { class XInputStream; } |
| namespace io { class XOutputStream; } |
| namespace io { class XStream; } |
| namespace lang { class XMultiComponentFactory; } |
| namespace lang { class XMultiServiceFactory; } |
| namespace task { class XInteractionHandler; } |
| namespace task { class XStatusIndicator; } |
| namespace uno { class XComponentContext; } |
| } } } |
| |
| namespace comphelper { |
| class IDocPasswordVerifier; |
| class MediaDescriptor; |
| } |
| |
| namespace oox { |
| class GraphicHelper; |
| class ModelObjectHelper; |
| } |
| |
| namespace oox { namespace ole { |
| class OleObjectHelper; |
| class VbaProject; |
| } } |
| |
| namespace oox { |
| namespace core { |
| |
| // ============================================================================ |
| |
| struct FilterBaseImpl; |
| |
| typedef ::cppu::WeakImplHelper5< |
| ::com::sun::star::lang::XServiceInfo, |
| ::com::sun::star::lang::XInitialization, |
| ::com::sun::star::document::XImporter, |
| ::com::sun::star::document::XExporter, |
| ::com::sun::star::document::XFilter > |
| FilterBase_BASE; |
| |
| class OOX_DLLPUBLIC FilterBase : public FilterBase_BASE, public ::cppu::BaseMutex |
| { |
| public: |
| explicit FilterBase( |
| const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& rxContext ) |
| throw( ::com::sun::star::uno::RuntimeException ); |
| |
| virtual ~FilterBase(); |
| |
| /** Returns true, if filter is an import filter. */ |
| bool isImportFilter() const; |
| /** Returns true, if filter is an export filter. */ |
| bool isExportFilter() const; |
| |
| /** Derived classes implement import of the entire document. */ |
| virtual bool importDocument() = 0; |
| |
| /** Derived classes implement export of the entire document. */ |
| virtual bool exportDocument() = 0; |
| |
| // ------------------------------------------------------------------------ |
| |
| /** Returns the specified argument passed through the XInitialization interface. */ |
| ::com::sun::star::uno::Any getArgument( const ::rtl::OUString& rArgName ) const; |
| |
| /** Returns the component context passed in the filter constructor (always existing). */ |
| const ::com::sun::star::uno::Reference< ::com::sun::star::uno::XComponentContext >& |
| getComponentContext() const; |
| |
| /** Returns the component service factory (always existing). */ |
| const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiComponentFactory >& |
| getComponentFactory() const; |
| |
| /** Returns the multi service factory of the component (always existing). */ |
| const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& |
| getServiceFactory() const; |
| |
| /** Returns the document model (always existing). */ |
| const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& |
| getModel() const; |
| |
| /** Returns the service factory provided by the document model (always existing). */ |
| const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XMultiServiceFactory >& |
| getModelFactory() const; |
| |
| /** Returns the frame that will contain the document model (may be null). */ |
| const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XFrame >& |
| getTargetFrame() const; |
| |
| /** Returns the status indicator (may be null). */ |
| const ::com::sun::star::uno::Reference< ::com::sun::star::task::XStatusIndicator >& |
| getStatusIndicator() const; |
| |
| /** Returns the status interaction handler (may be null). */ |
| const ::com::sun::star::uno::Reference< ::com::sun::star::task::XInteractionHandler >& |
| getInteractionHandler() const; |
| |
| /** Returns the media descriptor. */ |
| ::comphelper::MediaDescriptor& getMediaDescriptor() const; |
| |
| /** Returns the URL of the imported or exported file. */ |
| const ::rtl::OUString& getFileUrl() const; |
| |
| /** Returns an absolute URL for the passed relative or absolute URL. */ |
| ::rtl::OUString getAbsoluteUrl( const ::rtl::OUString& rUrl ) const; |
| |
| /** Returns the base storage of the imported/exported file. */ |
| StorageRef getStorage() const; |
| |
| /** Opens and returns the specified sub storage from the base storage. |
| |
| @param rStorageName |
| The name of the embedded storage. The name may contain slashes to |
| open storages from embedded substorages. |
| @param bCreateMissing |
| True = create missing sub storages (for export filters). |
| */ |
| StorageRef openSubStorage( |
| const ::rtl::OUString& rStorageName, |
| bool bCreateMissing ) const; |
| |
| /** Opens and returns the specified input stream from the base storage. |
| |
| @param rStreamName |
| The name of the embedded storage stream. The name may contain |
| slashes to open streams from embedded substorages. If base stream |
| access has been enabled in the storage, the base stream can be |
| accessed by passing an empty string as stream name. |
| */ |
| ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > |
| openInputStream( const ::rtl::OUString& rStreamName ) const; |
| |
| /** Opens and returns the specified output stream from the base storage. |
| |
| @param rStreamName |
| The name of the embedded storage stream. The name may contain |
| slashes to open streams from embedded substorages. If base stream |
| access has been enabled in the storage, the base stream can be |
| accessed by passing an empty string as stream name. |
| */ |
| ::com::sun::star::uno::Reference< ::com::sun::star::io::XOutputStream > |
| openOutputStream( const ::rtl::OUString& rStreamName ) const; |
| |
| /** Commits changes to base storage (and substorages) */ |
| void commitStorage() const; |
| |
| // helpers ---------------------------------------------------------------- |
| |
| /** Returns a helper for the handling of graphics and graphic objects. */ |
| GraphicHelper& getGraphicHelper() const; |
| |
| /** Returns a helper with containers for various named drawing objects for |
| the imported document. */ |
| ModelObjectHelper& getModelObjectHelper() const; |
| |
| /** Returns a helper for the handling of OLE obejcts. */ |
| ::oox::ole::OleObjectHelper& getOleObjectHelper() const; |
| |
| /** Returns the VBA project manager. */ |
| ::oox::ole::VbaProject& getVbaProject() const; |
| |
| /** Requests the encryption data from the media descriptor or from the user. On |
| success, the encryption data will be inserted into the media descriptor. */ |
| ::com::sun::star::uno::Sequence< ::com::sun::star::beans::NamedValue > |
| requestEncryptionData( ::comphelper::IDocPasswordVerifier& rVerifier ) const; |
| |
| /** Imports the raw binary data from the specified stream. |
| @return True, if the data could be imported from the stream. */ |
| bool importBinaryData( StreamDataSequence& orDataSeq, const ::rtl::OUString& rStreamName ); |
| |
| // com.sun.star.lang.XServiceInfo interface ------------------------------- |
| |
| virtual ::rtl::OUString SAL_CALL |
| getImplementationName() |
| throw( ::com::sun::star::uno::RuntimeException ); |
| |
| virtual sal_Bool SAL_CALL |
| supportsService( const ::rtl::OUString& rServiceName ) |
| throw( ::com::sun::star::uno::RuntimeException ); |
| |
| virtual ::com::sun::star::uno::Sequence< ::rtl::OUString > SAL_CALL |
| getSupportedServiceNames() |
| throw( ::com::sun::star::uno::RuntimeException ); |
| |
| // com.sun.star.lang.XInitialization interface ---------------------------- |
| |
| /** Receives user defined arguments. |
| |
| @param rArgs |
| the sequence of arguments passed to the filter. The implementation |
| expects one or two arguments. The first argument shall be the |
| com.sun.star.lang.XMultiServiceFactory interface of the global |
| service factory. The optional second argument may contain a |
| sequence of com.sun.star.beans.NamedValue objects. The different |
| filter implemetations may support different arguments. |
| */ |
| virtual void SAL_CALL initialize( |
| const ::com::sun::star::uno::Sequence< ::com::sun::star::uno::Any >& rArgs ) |
| throw( ::com::sun::star::uno::Exception, |
| ::com::sun::star::uno::RuntimeException ); |
| |
| // com.sun.star.document.XImporter interface ------------------------------ |
| |
| virtual void SAL_CALL setTargetDocument( |
| const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XComponent >& rxDocument ) |
| throw( ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::uno::RuntimeException ); |
| |
| // com.sun.star.document.XExporter interface ------------------------------ |
| |
| virtual void SAL_CALL setSourceDocument( |
| const ::com::sun::star::uno::Reference< ::com::sun::star::lang::XComponent >& rxDocument ) |
| throw( ::com::sun::star::lang::IllegalArgumentException, |
| ::com::sun::star::uno::RuntimeException ); |
| |
| // com.sun.star.document.XFilter interface -------------------------------- |
| |
| virtual sal_Bool SAL_CALL filter( |
| const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& rMediaDescSeq ) |
| throw( ::com::sun::star::uno::RuntimeException ); |
| |
| virtual void SAL_CALL cancel() |
| throw( ::com::sun::star::uno::RuntimeException ); |
| |
| // ------------------------------------------------------------------------ |
| protected: |
| virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream > |
| implGetInputStream( ::comphelper::MediaDescriptor& rMediaDesc ) const; |
| virtual ::com::sun::star::uno::Reference< ::com::sun::star::io::XStream > |
| implGetOutputStream( ::comphelper::MediaDescriptor& rMediaDesc ) const; |
| |
| private: |
| void setMediaDescriptor( |
| const ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >& rMediaDescSeq ); |
| |
| /** Derived classes may create a specialized graphic helper, e.g. for |
| resolving palette colors. */ |
| virtual GraphicHelper* implCreateGraphicHelper() const; |
| |
| /** Derived classes create a VBA project manager object. */ |
| virtual ::oox::ole::VbaProject* implCreateVbaProject() const = 0; |
| |
| virtual ::rtl::OUString implGetImplementationName() const = 0; |
| |
| virtual StorageRef implCreateStorage( |
| const ::com::sun::star::uno::Reference< ::com::sun::star::io::XInputStream >& rxInStream ) const = 0; |
| virtual StorageRef implCreateStorage( |
| const ::com::sun::star::uno::Reference< ::com::sun::star::io::XStream >& rxOutStream ) const = 0; |
| |
| private: |
| ::std::auto_ptr< FilterBaseImpl > mxImpl; |
| }; |
| |
| // ============================================================================ |
| |
| } // namespace core |
| } // namespace oox |
| |
| #endif |
