docxexport.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_SW_SOURCE_FILTER_WW8_DOCXEXPORT_HXX
#define INCLUDED_SW_SOURCE_FILTER_WW8_DOCXEXPORT_HXX

#include "wrtww8.hxx"

#include <sal/log.hxx>
#include <sax/fshelper.hxx>
#include <rtl/ustring.hxx>

#include <memory>
#include <ndole.hxx>
#include <unotools/securityoptions.hxx>

class DocxAttributeOutput;
class DocxExportFilter;
class SwNode;
class SwEndNode;
class SwTableNode;
class SwTextNode;
class SwGrfNode;
class SwOLENode;
class DocxSdrExport;

namespace oox {
    namespace drawingml { class DrawingML; }
    namespace vml { class VMLExport; }
}

namespace com::sun::star {
    namespace frame { class XModel; }
    namespace drawing { class XShape; }
    namespace awt { class XControlModel; }
}

struct DocxSettingsData
{
    DocxSettingsData();
    bool hasData() const; 
    bool evenAndOddHeaders;
    int defaultTabStop;
    bool revisionView;      // don't show tracked changes
    bool trackRevisions;    // Should 'Track Revisions' be set
};

struct SdtData
{
    OUString namespaces;
    OUString xpath;
    OUString data;
};

class DocxExport : public MSWordExportBase
{
    DocxExportFilter& m_rFilter;

    ::sax_fastparser::FSHelperPtr m_pDocumentFS;

    ::sax_fastparser::FSHelperPtr mpFS;

    std::unique_ptr<oox::drawingml::DrawingML> m_pDrawingML;

    std::unique_ptr<DocxAttributeOutput> m_pAttrOutput;

    std::unique_ptr<MSWordSections> m_pSections;

    sal_Int32 m_nHeaders;

    sal_Int32 m_nFooters;

    sal_Int32 m_nOLEObjects;

    sal_Int32 m_nActiveXControls;

    sal_Int32 m_nHeadersFootersInSection;

    std::unique_ptr<oox::vml::VMLExport> m_pVMLExport;

    std::unique_ptr<DocxSdrExport> m_pSdrExport;

    bool m_bDocm;

    bool const m_bTemplate;

    DocxSettingsData m_aSettings;

    const ww8::Frame *m_pFloatingTableFrame = nullptr;

    std::unique_ptr<SvtSecurityMapPersonalInfo> m_pAuthorIDs;

    std::vector<SdtData> m_SdtData;

public:

    DocxExportFilter& GetFilter() { return m_rFilter; };
    const DocxExportFilter& GetFilter() const { return m_rFilter; };

    const ww8::Frame* GetFloatingTableFrame() const { return m_pFloatingTableFrame; }

    virtual AttributeOutputBase& AttrOutput() const override;

    DocxAttributeOutput& DocxAttrOutput() const;

    virtual MSWordSections& Sections() const override;

    virtual bool FieldsQuoted() const override { return true; }

    virtual bool AddSectionBreaksForTOX() const override { return true; }

    virtual bool ignoreAttributeForStyleDefaults( sal_uInt16 nWhich ) const override;

    virtual bool PreferPageBreakBefore() const override { return false; }

    virtual bool CollapseScriptsforWordOk( sal_uInt16 nScript, sal_uInt16 nWhich ) override;

    virtual void AppendBookmarks( const SwTextNode& rNode, sal_Int32 nCurrentPos, sal_Int32 nLen, const SwRedlineData* pRedlineData = nullptr ) override;

    virtual void AppendBookmark( const OUString& rName ) override;

    virtual void AppendAnnotationMarks( const SwWW8AttrIter& rAttrs, sal_Int32 nCurrentPos, sal_Int32 nLen ) override;

    virtual void ExportGrfBullet(const SwTextNode&) override;

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

    virtual void WriteCR( ww8::WW8TableNodeInfoInner::Pointer_t /*pTableTextNodeInfoInner = ww8::WW8TableNodeInfoInner::Pointer_t()*/ ) override { /* FIXME no-op for docx, most probably should not even be in MSWordExportBase */ }
    virtual void WriteChar( sal_Unicode ) override { SAL_WARN("sw.ww8", "FIXME: WriteChar() has nothing to do for docx."); }

    virtual bool DisallowInheritingOutlineNumbering( const SwFormat &rFormat ) override;

    virtual void WriteHeadersFooters( sal_uInt8 nHeadFootFlags,
            const SwFrameFormat& rFormat, const SwFrameFormat& rLeftHeaderFormat, const SwFrameFormat& rLeftFooterFormat, const SwFrameFormat& rFirstPageFormat,
            sal_uInt8 nBreakCode, bool bEvenAndOddHeaders ) override;

    virtual void OutputField( const SwField* pField, ww::eField eFieldType,
            const OUString& rFieldCmd, FieldFlags nMode = FieldFlags::All ) override;

    virtual void WriteFormData( const ::sw::mark::IFieldmark& rFieldmark ) override;
    virtual void WriteHyperlinkData( const ::sw::mark::IFieldmark& rFieldmark ) override;

    virtual void DoComboBox(const OUString &rName,
                    const OUString &rHelp,
                    const OUString &ToolTip,
                    const OUString &rSelected,
                    const css::uno::Sequence<OUString> &rListItems) override;

    virtual void DoFormText(const SwInputField * pField) override;

    virtual sal_uInt64 ReplaceCr( sal_uInt8 nChar ) override;

    OString OutputChart( css::uno::Reference< css::frame::XModel > const & xModel, sal_Int32 nCount, ::sax_fastparser::FSHelperPtr const & m_pSerializer );
    OString WriteOLEObject(SwOLEObj& rObject, OUString & io_rProgID);
    std::pair<OString,OString> WriteActiveXObject(const uno::Reference<css::drawing::XShape>& rxShape,
                                                  const uno::Reference<awt::XControlModel>& rxControlModel);

    void OutputDML( css::uno::Reference< css::drawing::XShape > const & xShape );

    sal_Int32 WriteOutliner(const OutlinerParaObject& rOutliner, sal_uInt8 nTyp, bool bNeedsLastParaId);

    virtual ExportFormat GetExportFormat() const override { return ExportFormat::DOCX; }

    void AddSdtData(const OUString & namespaces, const OUString & xpath, const OUString & data)
    {
        m_SdtData.push_back({ namespaces, xpath, data });
    }

protected:
    virtual ErrCode ExportDocument_Impl() override;

    virtual void OutputEndNode( const SwEndNode& ) override;

    virtual void OutputGrfNode( const SwGrfNode& ) override;

    virtual void OutputOLENode( const SwOLENode& ) override;

    virtual void OutputLinkedOLE( const OUString& ) override;

    virtual void AppendSection( const SwPageDesc *pPageDesc, const SwSectionFormat* pFormat, sal_uLong nLnNum ) override;

    virtual void SectionBreaksAndFrames( const SwTextNode& /*rNode*/ ) override {}

    virtual void PrepareNewPageDesc( const SfxItemSet* pSet,
                                     const SwNode& rNd,
                                     const SwFormatPageDesc* pNewPgDescFormat,
                                     const SwPageDesc* pNewPgDesc,
                                     bool bExtraPageBreak = false) override;

private:
    void InitStyles();

    void WriteFootnotesEndnotes();

    void WritePostitFields();

    virtual void WriteNumbering() override;

    void WriteHeaderFooter( const SwFormat* pFormat, bool bHeader, const char* pType );

    void WriteFonts();

    void WriteProperties();

    void WriteSettings();

    void WriteDocVars(const sax_fastparser::FSHelperPtr& pFS);

    void WriteTheme();

    void WriteGlossary();

    void WriteCustomXml();

    void WriteEmbeddings();

    void WriteVBA();

    bool isMirroredMargin();

public:
    rtl::Reference<sax_fastparser::FastAttributeList> MainXmlNamespaces();

    void WriteMainText();

    DocxExport( DocxExportFilter& rFilter, SwDoc& rDocument,
            std::shared_ptr<SwUnoCursor> & pCurrentPam, SwPaM& rOriginalPam,
               bool bDocm, bool bTemplate);

    virtual ~DocxExport() override;

    oox::vml::VMLExport& VMLExporter() { return *m_pVMLExport; }

    DocxSdrExport& SdrExporter() { return *m_pSdrExport; }

    void setDefaultTabStop( int stop ) { m_aSettings.defaultTabStop = stop; }

    const ::sax_fastparser::FSHelperPtr& GetFS() const { return mpFS; }

    void SetFS(::sax_fastparser::FSHelperPtr const & mpFS);

    void SetFloatingTableFrame(const ww8::Frame* pF) { m_pFloatingTableFrame = pF; }

    // Get author id to remove personal info
    size_t GetInfoID( const OUString sPersonalInfo ) const { return m_pAuthorIDs->GetInfoID(sPersonalInfo); }

    // needed in docxsdrexport.cxx and docxattributeoutput.cxx
    sal_Int32 getWordCompatibilityModeFromGrabBag() const;

private:
    DocxExport( const DocxExport& ) = delete;

    DocxExport& operator=( const DocxExport& ) = delete;
};

#endif // INCLUDED_SW_SOURCE_FILTER_WW8_DOCXEXPORT_HXX

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