xmloff/source/text/XMLRedlineExport.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_XMLOFF_SOURCE_TEXT_XMLREDLINEEXPORT_HXX
  21 #define INCLUDED_XMLOFF_SOURCE_TEXT_XMLREDLINEEXPORT_HXX
  22
  23 #include <com/sun/star/uno/Reference.h>
  24 #include <com/sun/star/uno/Sequence.h>
  25
  26 #include <vector>
  27 #include <memory>
  28 #include <map>
  29
  30 class SvXMLExport;
  31 namespace com::sun::star {
  32     namespace beans { class XPropertySet; }
  33     namespace beans { struct PropertyValue; }
  34     namespace text { class XText; }
  35     namespace text { class XTextContent; }
  36     namespace text { class XTextSection; }
  37 }
  38
  39 // store a list of redline properties
  40 typedef ::std::vector<
  41             css::uno::Reference<css::beans::XPropertySet> > ChangesVectorType;
  42
  43 // store a list of redline properties for each XText
  44 typedef ::std::map<
  45             css::uno::Reference< css::text::XText>,
  46             std::unique_ptr<ChangesVectorType> > ChangesMapType;
  47
  48
  49 /**
  50  * This class handles the export of redline portions.
  51  * It is to be called from XMLTextParagraphExport.
  52  */
  53 class XMLRedlineExport
  54 {
  55     const OUString sDeletion;
  56     const OUString sFormatChange;
  57     const OUString sInsertion;
  58
  59     SvXMLExport& rExport;
  60
  61
  62     // handling of change recording:
  63
  64     // To support change tracking in headers and footers we need to
  65     // write these changes separately. To do this, we record the
  66     // changes for headers and footers. For the main document body, we
  67     // get the complete list of changes from the document, which
  68     // should be much more efficient than recording all of those.
  69
  70     ChangesMapType aChangeMap;              /// map of recorded changes
  71
  72     /// list of current changes; is NULL or points to member of aChangeMap
  73     ChangesVectorType* pCurrentChangesList;
  74
  75
  76 public:
  77     explicit XMLRedlineExport(SvXMLExport& rExp);
  78
  79     ~XMLRedlineExport();
  80
  81     /// export a change
  82     void ExportChange(
  83         /// PropertySet of RedlinePortion
  84         const css::uno::Reference<css::beans::XPropertySet> & rPropSet,
  85         bool bAutoStyle);
  86
  87     /// export the list of changes (complete list minus recorded changed)
  88     void ExportChangesList(bool bAutoStyles);
  89
  90     /// export the list of changes (recorded changes for this XText only)
  91     void ExportChangesList(
  92         const css::uno::Reference<css::text::XText> & rText,
  93         bool bAutoStyles);
  94
  95     /// set the current XText for which changes should be recorded.
  96     /// An empty XText means: don't record changes
  97     void SetCurrentXText(
  98         const css::uno::Reference<css::text::XText> & rText);
  99
 100     /// Do not record changes.
 101     /// Same as SetCurrentXText(Reference<XText>) with empty argument.
 102     void SetCurrentXText();
 103
 104     /// export redline marks which start or end at start nodes,
 105     /// i.e. that include the complete paragraph/table/section
 106     void ExportStartOrEndRedline(
 107         const css::uno::Reference<
 108                     css::beans::XPropertySet> & rPropSet,
 109         bool bStart);   /// start or end of text entity (e.g. paragraph)?
 110
 111     /// convenience method, calls XPropertySet-version of this method
 112     void ExportStartOrEndRedline(
 113         /// XTextContent; must also be an XPropertySet
 114         const css::uno::Reference<css::text::XTextContent> & rContent,
 115         bool bStart);
 116
 117     /// convenience method, calls XPropertySet-version of this method
 118     void ExportStartOrEndRedline(
 119         /// XTextSection; must also be an XPropertySet
 120         const css::uno::Reference<css::text::XTextSection> & rSection,
 121         bool bStart);
 122
 123 private:
 124
 125     /// export the change mark contained in the text body
 126     void ExportChangeInline(
 127         /// PropertySet of RedlinePortion
 128         const css::uno::Reference<css::beans::XPropertySet> & rPropSet);
 129
 130     /// export the auto styles used in this change
 131     void ExportChangeAutoStyle(
 132         /// PropertySet of RedlinePortion
 133         const css::uno::Reference<css::beans::XPropertySet> & rPropSet);
 134
 135     /// export the changes list (<text:tracked-changes>)
 136     void ExportChangesListElements();
 137
 138     /// export the auto styles needed by the changes list
 139     void ExportChangesListAutoStyles();
 140
 141     /// export the changed-region element
 142     void ExportChangedRegion(
 143         const css::uno::Reference<css::beans::XPropertySet> & rPropSet);
 144
 145     /// export a change-info element (from a PropertySet)
 146     void ExportChangeInfo(
 147         const css::uno::Reference<css::beans::XPropertySet> & rPropSet);
 148
 149     /// export a change-info element (from PropertyValues)
 150     void ExportChangeInfo(
 151         const css::uno::Sequence<css::beans::PropertyValue> & rValues);
 152
 153     /// convert the change type from API to XML names
 154     OUString const & ConvertTypeName(const OUString& sApiName);
 155
 156     /// Get ID string!
 157     static OUString GetRedlineID(
 158         const css::uno::Reference<css::beans::XPropertySet> & rPropSet);
 159
 160     /// write a comment string as sequence of <text:p> elements
 161     void WriteComment(const OUString& rComment);
 162 };
 163
 164 #endif
 165
 166 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */