XMLRedlineExport.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 <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/Sequence.h>

#include <vector>
#include <memory>
#include <map>

class SvXMLExport;
namespace com::sun::star {
    namespace beans { class XPropertySet; }
    namespace beans { struct PropertyValue; }
    namespace text { class XText; }
    namespace text { class XTextContent; }
    namespace text { class XTextSection; }
}

// store a list of redline properties
typedef ::std::vector<
            css::uno::Reference<css::beans::XPropertySet> > ChangesVectorType;

// store a list of redline properties for each XText
typedef ::std::map<
            css::uno::Reference< css::text::XText>,
            std::unique_ptr<ChangesVectorType> > ChangesMapType;


class XMLRedlineExport
{
    const OUString sDeletion;
    const OUString sFormatChange;
    const OUString sInsertion;

    SvXMLExport& rExport;


    // handling of change recording:

    // To support change tracking in headers and footers we need to
    // write these changes separately. To do this, we record the
    // changes for headers and footers. For the main document body, we
    // get the complete list of changes from the document, which
    // should be much more efficient than recording all of those.

    ChangesMapType aChangeMap;              

    ChangesVectorType* pCurrentChangesList;


public:
    explicit XMLRedlineExport(SvXMLExport& rExp);

    ~XMLRedlineExport();

    void ExportChange(
        const css::uno::Reference<css::beans::XPropertySet> & rPropSet,
        bool bAutoStyle);

    void ExportChangesList(bool bAutoStyles);

    void ExportChangesList(
        const css::uno::Reference<css::text::XText> & rText,
        bool bAutoStyles);

    void SetCurrentXText(
        const css::uno::Reference<css::text::XText> & rText);

    void SetCurrentXText();

    void ExportStartOrEndRedline(
        const css::uno::Reference<
                    css::beans::XPropertySet> & rPropSet,
        bool bStart);   

    void ExportStartOrEndRedline(
        const css::uno::Reference<css::text::XTextContent> & rContent,
        bool bStart);

    void ExportStartOrEndRedline(
        const css::uno::Reference<css::text::XTextSection> & rSection,
        bool bStart);

private:

    void ExportChangeInline(
        const css::uno::Reference<css::beans::XPropertySet> & rPropSet);

    void ExportChangeAutoStyle(
        const css::uno::Reference<css::beans::XPropertySet> & rPropSet);

    void ExportChangesListElements();

    void ExportChangesListAutoStyles();

    void ExportChangedRegion(
        const css::uno::Reference<css::beans::XPropertySet> & rPropSet);

    void ExportChangeInfo(
        const css::uno::Reference<css::beans::XPropertySet> & rPropSet);

    void ExportChangeInfo(
        const css::uno::Sequence<css::beans::PropertyValue> & rValues);

    OUString const & ConvertTypeName(std::u16string_view sApiName);

    static OUString GetRedlineID(
        const css::uno::Reference<css::beans::XPropertySet> & rPropSet);

    void WriteComment(std::u16string_view rComment);
};

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