OOXMLDocument.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 .
 */
#pragma once
 
#include <sal/types.h>
#include <com/sun/star/beans/NamedValue.hpp>
#include <com/sun/star/uno/Reference.hxx>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <dmapper/resourcemodel.hxx>
#include <com/sun/star/task/XStatusIndicator.hpp>
#include <com/sun/star/xml/sax/XFastParser.hpp>
#include <com/sun/star/xml/sax/XFastTokenHandler.hpp>
#include <com/sun/star/xml/dom/XDocument.hpp>
#include <com/sun/star/frame/XModel.hpp>
#include <com/sun/star/drawing/XDrawPage.hpp>
#include <oox/shape/ShapeContextHandler.hxx>
#include <oox/drawingml/theme.hxx>
 
namespace writerfilter::ooxml
{
 
class OOXMLStream : public virtual SvRefBase
{
public:
    enum StreamType_t { UNKNOWN, DOCUMENT, STYLES, WEBSETTINGS, FONTTABLE, NUMBERING,
        FOOTNOTES, ENDNOTES, COMMENTS, COMMENTS_EXTENDED, THEME, CUSTOMXML, CUSTOMXMLPROPS, GLOSSARY, CHARTS, EMBEDDINGS, SETTINGS, VBAPROJECT, FOOTER, HEADER, VBADATA };
    typedef tools::SvRef<OOXMLStream> Pointer_t;
 
    virtual css::uno::Reference<css::xml::sax::XFastParser> getFastParser() = 0;
 
    virtual css::uno::Reference<css::io::XInputStream> getDocumentStream() = 0;
 
    virtual css::uno::Reference<css::uno::XComponentContext> getContext() = 0;
 
    virtual OUString getTargetForId(const OUString & rId) = 0;
 
    virtual const OUString & getTarget() const = 0;
 
    virtual css::uno::Reference<css::xml::sax::XFastTokenHandler>
    getFastTokenHandler() = 0;
 
};
 
class OOXMLDocument : public writerfilter::Reference<Stream>
{
public:
    typedef tools::SvRef<OOXMLDocument> Pointer_t;
 
    virtual void resolve(Stream & rStream) override = 0;
 
    virtual void resolveFootnote(Stream & rStream,
                                 Id aNoteType,
                                 const sal_Int32 nNoteId) = 0;
    virtual void resolveEndnote(Stream & rStream,
                                Id  aNoteType,
                                const sal_Int32 NoteId) = 0;
 
    virtual void resolveComment(Stream & rStream,
                                const sal_Int32 nCommentId) = 0;
 
    virtual void resolvePicture(Stream & rStream,
                                const OUString & rPictureId) = 0;
 
    virtual void resolveHeader(Stream & rStream,
                               const sal_Int32 type,
                               const OUString & rId) = 0;
 
    virtual void resolveFooter(Stream & rStream,
                               const sal_Int32 type,
                               const OUString & rId) = 0;
 
 
    virtual OUString getTargetForId(const OUString & rId) = 0;
 
    virtual void setModel(css::uno::Reference<css::frame::XModel> xModel) = 0;
    virtual css::uno::Reference<css::frame::XModel> getModel() = 0;
    virtual void setDrawPage(css::uno::Reference<css::drawing::XDrawPage> xDrawPage) = 0;
    virtual css::uno::Reference<css::drawing::XDrawPage> getDrawPage() = 0;
    virtual css::uno::Reference<css::io::XInputStream> getInputStreamForId(const OUString & rId) = 0;
    virtual void setXNoteId(const sal_Int32 nId) = 0;
    virtual sal_Int32 getXNoteId() const = 0;
    virtual const OUString & getTarget() const = 0;
    virtual rtl::Reference<oox::shape::ShapeContextHandler> getShapeContext( ) = 0;
    virtual void setShapeContext( rtl::Reference<oox::shape::ShapeContextHandler> xContext ) = 0;
    virtual const oox::drawingml::ThemePtr & getTheme() const = 0;
 
    virtual void pushShapeContext() = 0;
    virtual void popShapeContext() = 0;
    virtual css::uno::Reference<css::xml::dom::XDocument> getThemeDom( ) = 0;
    virtual css::uno::Reference<css::xml::dom::XDocument> getGlossaryDocDom( ) = 0;
    virtual css::uno::Sequence<css::uno::Sequence< css::beans::NamedValue> > getGlossaryDomList() = 0;
    virtual css::uno::Sequence<css::uno::Reference<css::xml::dom::XDocument> > getCustomXmlDomList( ) = 0;
    virtual css::uno::Sequence<css::uno::Reference<css::xml::dom::XDocument> > getCustomXmlDomPropsList( ) = 0;
    virtual css::uno::Sequence<css::beans::PropertyValue > getEmbeddingsList() = 0;
};
 
 
class OOXMLDocumentFactory
{
public:
    static OOXMLStream::Pointer_t
    createStream(const css::uno::Reference<css::uno::XComponentContext>& rContext,
                 const css::uno::Reference<css::io::XInputStream>& rStream,
                 bool bRepairStorage);
 
    static OOXMLStream::Pointer_t
    createStream(const OOXMLStream::Pointer_t& pStream,
                 OOXMLStream::StreamType_t nStreamType);
 
    static OOXMLStream::Pointer_t
    createStream(const OOXMLStream::Pointer_t& pStream, const OUString & rId);
 
    static OOXMLDocument *
    createDocument(const OOXMLStream::Pointer_t& pStream,
                 const css::uno::Reference<css::task::XStatusIndicator>& xStatusIndicator,
                 bool bSkipImage, const css::uno::Sequence<css::beans::PropertyValue>& rDescriptor);
 
};
 
std::string fastTokenToId(sal_uInt32 nToken);
 
}
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */