xmlfilterbase.hxx

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef INCLUDED_OOX_CORE_XMLFILTERBASE_HXX
#define INCLUDED_OOX_CORE_XMLFILTERBASE_HXX

#include <memory>
#include <string_view>
#include <vector>

#include <com/sun/star/uno/Reference.hxx>
#include <oox/core/filterbase.hxx>
#include <oox/core/relations.hxx>
#include <oox/dllapi.h>
#include <oox/helper/storagebase.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>

namespace com::sun::star {
    namespace document { class XDocumentProperties; }
    namespace io { class XInputStream; }
    namespace io { class XOutputStream; }
    namespace io { class XStream; }
    namespace text { class XText; }
    namespace text { class XTextCursor; }
    namespace text { class XTextField; }
    namespace uno { class XComponentContext; }
    namespace xml::dom { class XDocument; }
    namespace xml::sax { class XFastSAXSerializable; }
}

namespace oox {
    namespace drawingml { class Theme; }
    namespace drawingml::chart { class ChartConverter; }
    namespace drawingml::table {
        class TableStyleList;
        typedef std::shared_ptr< TableStyleList > TableStyleListPtr;
    }
    namespace vml { class Drawing; }
}

namespace rtl { template <class reference_type> class Reference; }

namespace sax_fastparser {
    class FastSerializerHelper;

    typedef std::shared_ptr< FastSerializerHelper > FSHelperPtr;
}

namespace utl { class MediaDescriptor; }

namespace oox::drawingml
{
class Shape;
}

namespace oox::core {

class FragmentHandler;
class FastParser;

struct TextField {
    css::uno::Reference< css::text::XText >       xText;
    css::uno::Reference< css::text::XTextCursor > xTextCursor;
    css::uno::Reference< css::text::XTextField >  xTextField;
};
typedef std::vector< TextField > TextFieldStack;

struct XmlFilterBaseImpl;

using ShapePairs
    = std::map<std::shared_ptr<drawingml::Shape>, css::uno::Reference<css::drawing::XShape>>;
using NamedShapePairs = std::map<OUString, ShapePairs>;

class OOX_DLLPUBLIC XmlFilterBase : public FilterBase
{
public:
    explicit            XmlFilterBase(
                            const css::uno::Reference< css::uno::XComponentContext >& rxContext );

    virtual             ~XmlFilterBase() override;

    virtual const ::oox::drawingml::Theme* getCurrentTheme() const = 0;

    virtual ::oox::vml::Drawing* getVmlDrawing() = 0;

    virtual ::oox::drawingml::chart::ChartConverter* getChartConverter() = 0;

    virtual void useInternalChartDataTable( bool /*bInternal*/ ) { }

    virtual ::oox::drawingml::table::TableStyleListPtr getTableStyles() = 0;


    OUString getFragmentPathFromFirstTypeFromOfficeDoc( std::u16string_view rPart );

    bool importFragment( const rtl::Reference<FragmentHandler>& rxHandler );
    bool importFragment( const rtl::Reference<FragmentHandler>& rxHandler, FastParser& rParser );

    css::uno::Reference< css::xml::dom::XDocument> importFragment( const OUString& rFragmentPath );

    bool importFragment( const ::rtl::Reference< FragmentHandler >& rxHandler,
                         const css::uno::Reference< css::xml::sax::XFastSAXSerializable >& rxSerializer );

    RelationsRef        importRelations( const OUString& rFragmentPath );

    OUString     addRelation( const OUString& rType, std::u16string_view rTarget );

    OUString     addRelation( const css::uno::Reference< css::io::XOutputStream >& rOutputStream, const OUString& rType, std::u16string_view rTarget, bool bExternal = false );

    TextFieldStack& getTextFieldStack() const;

    css::uno::Reference< css::io::XOutputStream >
                        openFragmentStream(
                            const OUString& rStreamName,
                            const OUString& rMediaType );

    ::sax_fastparser::FSHelperPtr
                        openFragmentStreamWithSerializer(
                            const OUString& rStreamName,
                            const OUString& rMediaType );

    sal_Int32 GetUniqueId() { return mnMaxDocId++; }

    void exportDocumentProperties( const css::uno::Reference< css::document::XDocumentProperties >& xProperties, bool bSecurityOptOpenReadOnly );

    void exportCustomFragments();

    void importDocumentProperties();

    static void putPropertiesToDocumentGrabBag(const css::uno::Reference<css::lang::XComponent>& xDstDoc,
                                               const comphelper::SequenceAsHashMap& rProperties);

    static FastParser* createParser();

    bool isMSO2007Document() const;
    bool isMSODocument() const;

    void setMissingExtDrawing();

    void setDiagramFontHeights(NamedShapePairs* pDiagramFontHeights);
    NamedShapePairs* getDiagramFontHeights();

    void checkDocumentProperties(
            const css::uno::Reference<css::document::XDocumentProperties>& xDocProps);

    OUString getNamespaceURL(sal_Int32 nNSID) const;

protected:
    virtual css::uno::Reference< css::io::XInputStream >
        implGetInputStream( utl::MediaDescriptor& rMediaDesc ) const override;

    virtual css::uno::Reference< css::io::XStream >
        implGetOutputStream( utl::MediaDescriptor& rMediaDesc ) const override;

    virtual bool implFinalizeExport( utl::MediaDescriptor& rMediaDescriptor ) override;

private:
    virtual StorageRef  implCreateStorage(
                            const css::uno::Reference< css::io::XInputStream >& rxInStream ) const override;
    virtual StorageRef  implCreateStorage(
                            const css::uno::Reference< css::io::XStream >& rxOutStream ) const override;

    void importCustomFragments(css::uno::Reference<css::embed::XStorage> const & xDocumentStorage);

private:
    ::std::unique_ptr< XmlFilterBaseImpl > mxImpl;
    sal_Int32 mnRelId;
    sal_Int32 mnMaxDocId;
    bool mbMSO2007;
    bool mbMSO;
protected:
    bool mbMissingExtDrawing;
};

} // namespace oox::core

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */