Files
libreoffice/xmloff/source/text/XMLRedlineExport.cxx
Daniel Vogelheim 6f7e8313b2 - added: change tracking export added
(still buggy and therfore disabled in txtparae.cxx)
2001-01-02 13:38:40 +00:00

359 lines
11 KiB
C++

/*************************************************************************
*
* $RCSfile: XMLRedlineExport.cxx,v $
*
* $Revision: 1.1 $
*
* last change: $Author: dvo $ $Date: 2001-01-02 14:38:40 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#ifndef _XMLOFF_XMLREDLINEEXPORT_HXX
#include "XMLRedlineExport.hxx"
#endif
#ifndef _TOOLS_DEBUG_HXX
#include <tools/debug.hxx>
#endif
#ifndef _RTL_USTRING_HXX_
#include <rtl/ustring.hxx>
#endif
#ifndef _RTL_USTRBUF_HXX_
#include <rtl/ustrbuf.hxx>
#endif
#ifndef _COM_SUN_STAR_BEANS_XPROPERTYSET_HPP_
#include <com/sun/star/beans/XPropertySet.hpp>
#endif
#ifndef _COM_SUN_STAR_TEXT_XTEXT_HPP_
#include <com/sun/star/text/XText.hpp>
#endif
#ifndef _COM_SUN_STAR_UTIL_DATETIME_HPP_
#include <com/sun/star/util/DateTime.hpp>
#endif
#ifndef _XMLOFF_XMLKYWD_HXX
#include "xmlkywd.hxx"
#endif
#ifndef _XMLOFF_XMLNMSPE_HXX
#include "xmlnmspe.hxx"
#endif
#ifndef _XMLOFF_XMLEXP_HXX
#include "xmlexp.hxx"
#endif
#ifndef _XMLOFF_XMLUCONV_HXX
#include "xmluconv.hxx"
#endif
using namespace ::com::sun::star;
using ::rtl::OUString;
using ::rtl::OUStringBuffer;
using ::com::sun::star::text::XText;
using ::com::sun::star::beans::XPropertySet;
using ::com::sun::star::util::DateTime;
using ::com::sun::star::uno::Reference;
using ::com::sun::star::uno::Any;
using ::std::list;
XMLRedlineExport::XMLRedlineExport(SvXMLExport& rExp) :
sDelete(RTL_CONSTASCII_USTRINGPARAM("Delete")),
sDeletion(RTL_CONSTASCII_USTRINGPARAM(sXML_deletion)),
sFormat(RTL_CONSTASCII_USTRINGPARAM("Format")),
sFormatChange(RTL_CONSTASCII_USTRINGPARAM(sXML_format_change)),
sInsert(RTL_CONSTASCII_USTRINGPARAM("Insert")),
sInsertion(RTL_CONSTASCII_USTRINGPARAM(sXML_insertion)),
sIsCollapsed(RTL_CONSTASCII_USTRINGPARAM("IsCollapsed")),
sIsStart(RTL_CONSTASCII_USTRINGPARAM("IsStart")),
sRL(RTL_CONSTASCII_USTRINGPARAM("RL")),
sRedlineAuthor(RTL_CONSTASCII_USTRINGPARAM("RedlineAuthor")),
sRedlineComment(RTL_CONSTASCII_USTRINGPARAM("RedlineComment")),
sRedlineDateTime(RTL_CONSTASCII_USTRINGPARAM("RedlineDateTime")),
sRedlineSuccessorData(RTL_CONSTASCII_USTRINGPARAM("RedlineSuccessorData")),
sRedlineType(RTL_CONSTASCII_USTRINGPARAM("RedlineType")),
sStyle(RTL_CONSTASCII_USTRINGPARAM("Style")),
sTextTable(RTL_CONSTASCII_USTRINGPARAM("TextTable")),
sUnknownChange(RTL_CONSTASCII_USTRINGPARAM("UnknownChange")),
rExport(rExp),
aChangesList(),
nCountCallsExportChangedRegion(0),
nCountCallsExportChangeInline(0)
{
}
XMLRedlineExport::~XMLRedlineExport()
{
}
void XMLRedlineExport::ExportChange(
const Reference<XPropertySet> & rPropSet,
sal_Bool bAutoStyle)
{
if (bAutoStyle)
{
CollectChange(rPropSet);
}
else
{
ExportChangeInline(rPropSet);
}
}
void XMLRedlineExport::CollectChange(
const Reference<XPropertySet> & rPropSet)
{
// collect change in the big list
aChangesList.push_back(rPropSet);
}
void XMLRedlineExport::ExportChangesList()
{
// write changes list only if we have redlines
if (aChangesList.size() > 0)
{
// changes container element
SvXMLElementExport aChanges(rExport, XML_NAMESPACE_TEXT,
sXML_tracked_changes, sal_True, sal_True);
// iterate over all changes and call ExportChangeRegion, the
// discard changes lists
ChangesListType::iterator aEnd = aChangesList.end();
for(ChangesListType::iterator aIter = aChangesList.begin();
aIter != aEnd;
aIter++)
{
ExportChangedRegion(*aIter);
}
aChangesList.clear();
}
// else: no redlines -> no export
}
void XMLRedlineExport::ExportChangeInline(
const Reference<XPropertySet> & rPropSet)
{
// silly ID handling: (see GetRedlineID())
++nCountCallsExportChangeInline;
// determine element name (depending on collapsed, start/end)
sal_Char* pElement = NULL;
Any aAny = rPropSet->getPropertyValue(sIsCollapsed);
sal_Bool bCollapsed = *(sal_Bool *)aAny.getValue();
sal_Bool bStart = sal_True; // ignored if bCollapsed = sal_True
if (bCollapsed)
{
pElement = sXML_change;
}
else
{
aAny = rPropSet->getPropertyValue(sIsStart);
bStart = *(sal_Bool *)aAny.getValue();
pElement = bStart ? sXML_change_start : sXML_change_end;
}
if (NULL != pElement)
{
// we always need the ID
rExport.AddAttribute(XML_NAMESPACE_TEXT, sXML_change_id,
GetRedlineID(rPropSet, sal_False,
bCollapsed||bStart));
// export the element (no whitespace because we're in the text body)
SvXMLElementExport aChangeElem(rExport, XML_NAMESPACE_TEXT,
pElement, sal_False, sal_False);
}
}
void XMLRedlineExport::ExportChangedRegion(
const Reference<XPropertySet> & rPropSet)
{
// silly ID handling: (see GetRedlineID())
++nCountCallsExportChangedRegion;
// determine collapsed, start, end
Any aAny = rPropSet->getPropertyValue(sIsCollapsed);
sal_Bool bCollapsed = *(sal_Bool *)aAny.getValue();
aAny = rPropSet->getPropertyValue(sIsStart);
sal_Bool bStart = *(sal_Bool *)aAny.getValue();
// only export changed-region once per change
if (bStart || bCollapsed)
{
// export changed-region element (with change-ID)
rExport.AddAttribute(XML_NAMESPACE_TEXT, sXML_id,
GetRedlineID(rPropSet, sal_True, sal_True) );
SvXMLElementExport aChangedRegion(rExport, XML_NAMESPACE_TEXT,
sXML_changed_region,
sal_True, sal_True);
// scope for change element
{
Any aAny = rPropSet->getPropertyValue(sRedlineType);
OUString sType;
aAny >>= sType;
SvXMLElementExport aChange(rExport, XML_NAMESPACE_TEXT,
ConvertTypeName(sType),
sal_True, sal_True);
ExportChangeInfo(rPropSet);
}
// if the region is collapsed, we need to export it's content
if (bCollapsed)
{
// get XText from the redline text portion
Reference<XText> xText(rPropSet, uno::UNO_QUERY);
if (xText.is())
{
rExport.GetTextParagraphExport()->collectTextAutoStyles(xText);
// default parameters: bProgress, bExportParagraph ???
rExport.GetTextParagraphExport()->exportText(xText);
// default parameters: bProgress, bExportParagraph ???
}
// else: no text, no export. Bummer!
}
// else: not collapsed: content will be exported inline
}
// else: region end: don't export
}
const OUString XMLRedlineExport::ConvertTypeName(
const OUString& sApiName)
{
if (sApiName == sDelete)
{
return sDeletion;
}
else if (sApiName == sInsert)
{
return sInsertion;
}
else if (sApiName == sFormat)
{
return sFormatChange;
}
else
{
DBG_ERROR("unknown redline type");
return sUnknownChange;
}
}
/*
* The current method of identifying redlines is this:
* a) We rely on the fact that they appear in the same order. Therefore
* it is sufficient to simply count the calls to CollectChange and
* ExportChangeInline, and to use the current count as ID number.
* b) We rely on the fact that changes cannot overlap. To identify start
* with end change elements, we simply subtract one for the end elements.
*/
const OUString XMLRedlineExport::GetRedlineID(
const Reference<XPropertySet> & rPropSet,
sal_Bool bFirstPass,
sal_Bool bIsStart)
{
sal_Int32 nId = bFirstPass ? nCountCallsExportChangedRegion :
nCountCallsExportChangeInline;
if (!bIsStart)
nId--;
OUStringBuffer sBuf(sRL);
sBuf.append(nId);
return sBuf.makeStringAndClear();
}
void XMLRedlineExport::ExportChangeInfo(
const Reference<XPropertySet> & rPropSet)
{
Any aAny = rPropSet->getPropertyValue(sRedlineAuthor);
OUString sTmp;
aAny >>= sTmp;
if (sTmp.getLength() > 0)
{
rExport.AddAttribute(XML_NAMESPACE_TEXT, sXML_chg_author, sTmp);
}
aAny = rPropSet->getPropertyValue(sRedlineComment);
aAny >>= sTmp;
if (sTmp.getLength() > 0)
{
rExport.AddAttribute(XML_NAMESPACE_TEXT, sXML_chg_comment, sTmp);
}
aAny = rPropSet->getPropertyValue(sRedlineDateTime);
util::DateTime aDateTime;
aAny >>= aDateTime;
OUStringBuffer sBuf;
rExport.GetMM100UnitConverter().convertDateTime(sBuf, aDateTime);
rExport.AddAttribute(XML_NAMESPACE_TEXT, sXML_chg_date_time,
sBuf.makeStringAndClear());
SvXMLElementExport aChangeInfo(rExport, XML_NAMESPACE_TEXT,
sXML_change_info, sal_True, sal_True);
}