d75f4673ac
... XMLDashStyleImport and XMLEventExport See tdf#94879 for motivation. Change-Id: I203cc1c789a1a33721b27754412da35c3ca8a56a Reviewed-on: https://gerrit.libreoffice.org/c/core/+/151755 Reviewed-by: Miklos Vajna <vmiklos@collabora.com> Tested-by: Jenkins
320 lines
12 KiB
C++
320 lines
12 KiB
C++
/* -*- 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 .
|
|
*/
|
|
|
|
#include <xmloff/XMLEventExport.hxx>
|
|
|
|
#include <com/sun/star/beans/PropertyValue.hpp>
|
|
|
|
#include <com/sun/star/document/XEventsSupplier.hpp>
|
|
|
|
#include <com/sun/star/container/XNameReplace.hpp>
|
|
#include <sal/log.hxx>
|
|
#include <osl/diagnose.h>
|
|
#include <xmloff/xmlexp.hxx>
|
|
#include <xmloff/xmltoken.hxx>
|
|
#include <xmloff/xmlnamespace.hxx>
|
|
#include <xmloff/namespacemap.hxx>
|
|
|
|
|
|
using namespace ::com::sun::star::uno;
|
|
|
|
using ::com::sun::star::beans::PropertyValue;
|
|
using ::com::sun::star::document::XEventsSupplier;
|
|
using ::com::sun::star::container::XNameReplace;
|
|
using ::com::sun::star::container::XNameAccess;
|
|
using ::xmloff::token::XML_EVENT_LISTENERS;
|
|
|
|
constexpr OUStringLiteral gsEventType(u"EventType");
|
|
|
|
XMLEventExport::XMLEventExport(SvXMLExport& rExp) :
|
|
m_rExport(rExp),
|
|
m_bExtNamespace(false)
|
|
{
|
|
}
|
|
|
|
XMLEventExport::~XMLEventExport()
|
|
{
|
|
// delete all handlers
|
|
m_aHandlerMap.clear();
|
|
}
|
|
|
|
void XMLEventExport::AddHandler( const OUString& rName,
|
|
std::unique_ptr<XMLEventExportHandler> pHandler )
|
|
{
|
|
assert(pHandler);
|
|
m_aHandlerMap[rName] = std::move(pHandler);
|
|
}
|
|
|
|
void XMLEventExport::AddTranslationTable(
|
|
const XMLEventNameTranslation* pTransTable )
|
|
{
|
|
if (nullptr != pTransTable)
|
|
{
|
|
// put translation table into map
|
|
for(const XMLEventNameTranslation* pTrans = pTransTable;
|
|
pTrans->sAPIName != nullptr;
|
|
pTrans++)
|
|
{
|
|
m_aNameTranslationMap[OUString::createFromAscii(pTrans->sAPIName)] =
|
|
XMLEventName(pTrans->nPrefix, pTrans->sXMLName);
|
|
}
|
|
}
|
|
// else? ignore!
|
|
}
|
|
|
|
void XMLEventExport::Export( Reference<XEventsSupplier> const & rSupplier,
|
|
bool bWhitespace)
|
|
{
|
|
if (rSupplier.is())
|
|
{
|
|
Export(rSupplier->getEvents(), bWhitespace);
|
|
}
|
|
// else: no supplier, no export -> ignore!
|
|
}
|
|
|
|
void XMLEventExport::Export( Reference<XNameReplace> const & rReplace,
|
|
bool bWhitespace)
|
|
{
|
|
Reference<XNameAccess> xAccess(rReplace);
|
|
Export(xAccess, bWhitespace);
|
|
}
|
|
|
|
void XMLEventExport::Export( Reference<XNameAccess> const & rAccess,
|
|
bool bWhitespace)
|
|
{
|
|
// early out if we don't actually get any events
|
|
if (!rAccess.is())
|
|
{
|
|
return;
|
|
}
|
|
|
|
// have we already processed an element?
|
|
bool bStarted = false;
|
|
|
|
// iterate over all event types
|
|
const Sequence<OUString> aNames = rAccess->getElementNames();
|
|
for(const auto& rName : aNames)
|
|
{
|
|
// translate name
|
|
NameMap::iterator aIter = m_aNameTranslationMap.find(rName);
|
|
if (aIter != m_aNameTranslationMap.end())
|
|
{
|
|
const XMLEventName& rXmlName = aIter->second;
|
|
|
|
// get PropertyValues for this event
|
|
Any aAny = rAccess->getByName( rName );
|
|
Sequence<PropertyValue> aValues;
|
|
aAny >>= aValues;
|
|
|
|
// now export the current event
|
|
ExportEvent( aValues, rXmlName, bWhitespace, bStarted );
|
|
}
|
|
else
|
|
{
|
|
// don't proceed further
|
|
SAL_WARN("xmloff", "Unknown event name:" << rName );
|
|
}
|
|
}
|
|
|
|
// close <script:events> element (if it was opened before)
|
|
if (bStarted)
|
|
{
|
|
EndElement(bWhitespace);
|
|
}
|
|
}
|
|
|
|
void XMLEventExport::ExportExt( Reference<XNameAccess> const & rAccess )
|
|
{
|
|
// set bExtNamespace flag to use XML_NAMESPACE_OFFICE_EXT namespace
|
|
// for events element (not for child elements)
|
|
m_bExtNamespace = true;
|
|
Export(rAccess);
|
|
m_bExtNamespace = false; // reset for future Export calls
|
|
}
|
|
|
|
/// export a singular event and write <office:events> container
|
|
void XMLEventExport::ExportSingleEvent(
|
|
const Sequence<PropertyValue>& rEventValues,
|
|
const OUString& rApiEventName,
|
|
bool bUseWhitespace )
|
|
{
|
|
// translate the name
|
|
NameMap::iterator aIter = m_aNameTranslationMap.find(rApiEventName);
|
|
if (aIter != m_aNameTranslationMap.end())
|
|
{
|
|
const XMLEventName& rXmlName = aIter->second;
|
|
|
|
// export the event ...
|
|
bool bStarted = false;
|
|
ExportEvent( rEventValues, rXmlName, bUseWhitespace, bStarted );
|
|
|
|
// ... and close the container element (if necessary)
|
|
if (bStarted)
|
|
{
|
|
EndElement(bUseWhitespace);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// don't proceed further
|
|
SAL_WARN("xmloff", "Unknown event name:" << rApiEventName );
|
|
}
|
|
}
|
|
|
|
|
|
/// export a single event
|
|
void XMLEventExport::ExportEvent(
|
|
const Sequence<PropertyValue>& rEventValues,
|
|
const XMLEventName& rXmlEventName,
|
|
bool bUseWhitespace,
|
|
bool& rExported )
|
|
{
|
|
// search for EventType value and then delegate to EventHandler
|
|
const PropertyValue* pValue = std::find_if(rEventValues.begin(), rEventValues.end(),
|
|
[](const PropertyValue& rValue) { return gsEventType == rValue.Name; });
|
|
|
|
if (pValue == rEventValues.end())
|
|
return;
|
|
|
|
// found! Now find handler and delegate
|
|
OUString sType;
|
|
pValue->Value >>= sType;
|
|
|
|
if (m_aHandlerMap.count(sType))
|
|
{
|
|
if (! rExported)
|
|
{
|
|
// OK, we have't yet exported the enclosing
|
|
// element. So we do that now.
|
|
rExported = true;
|
|
StartElement(bUseWhitespace);
|
|
}
|
|
|
|
OUString aEventQName(
|
|
m_rExport.GetNamespaceMap().GetQNameByKey(
|
|
rXmlEventName.m_nPrefix, rXmlEventName.m_aName ) );
|
|
|
|
// delegate to proper ExportEventHandler
|
|
m_aHandlerMap[sType]->Export(m_rExport, aEventQName,
|
|
rEventValues, bUseWhitespace);
|
|
}
|
|
else
|
|
{
|
|
if ( sType != "None" )
|
|
{
|
|
OSL_FAIL("unknown event type returned by API");
|
|
// unknown type -> error (ignore)
|
|
}
|
|
// else: we ignore None fields
|
|
}
|
|
}
|
|
|
|
|
|
void XMLEventExport::StartElement(bool bWhitespace)
|
|
{
|
|
if (bWhitespace)
|
|
{
|
|
m_rExport.IgnorableWhitespace();
|
|
}
|
|
sal_uInt16 nNamespace = m_bExtNamespace ? XML_NAMESPACE_OFFICE_EXT
|
|
: XML_NAMESPACE_OFFICE;
|
|
m_rExport.StartElement( nNamespace, XML_EVENT_LISTENERS,
|
|
bWhitespace);
|
|
}
|
|
|
|
void XMLEventExport::EndElement(bool bWhitespace)
|
|
{
|
|
sal_uInt16 nNamespace = m_bExtNamespace ? XML_NAMESPACE_OFFICE_EXT
|
|
: XML_NAMESPACE_OFFICE;
|
|
m_rExport.EndElement(nNamespace, XML_EVENT_LISTENERS, bWhitespace);
|
|
if (bWhitespace)
|
|
{
|
|
m_rExport.IgnorableWhitespace();
|
|
}
|
|
}
|
|
|
|
|
|
// implement aStandardEventTable (defined in xmlevent.hxx)
|
|
const XMLEventNameTranslation aStandardEventTable[] =
|
|
{
|
|
{ "OnSelect", XML_NAMESPACE_DOM, "select" }, // "on-select"
|
|
{ "OnInsertStart", XML_NAMESPACE_OFFICE, "insert-start" }, // "on-insert-start"
|
|
{ "OnInsertDone", XML_NAMESPACE_OFFICE, "insert-done" }, // "on-insert-done"
|
|
{ "OnMailMerge", XML_NAMESPACE_OFFICE, "mail-merge" }, // "on-mail-merge"
|
|
{ "OnAlphaCharInput", XML_NAMESPACE_OFFICE, "alpha-char-input" }, // "on-alpha-char-input"
|
|
{ "OnNonAlphaCharInput", XML_NAMESPACE_OFFICE, "non-alpha-char-input" }, // "on-non-alpha-char-input"
|
|
{ "OnResize", XML_NAMESPACE_DOM, "resize" }, // "on-resize"
|
|
{ "OnMove", XML_NAMESPACE_OFFICE, "move" }, // "on-move"
|
|
{ "OnPageCountChange", XML_NAMESPACE_OFFICE, "page-count-change" }, // "on-page-count-change"
|
|
{ "OnMouseOver", XML_NAMESPACE_DOM, "mouseover" }, // "on-mouse-over"
|
|
{ "OnClick", XML_NAMESPACE_DOM, "click" }, // "on-click"
|
|
{ "OnMouseOut", XML_NAMESPACE_DOM, "mouseout" }, // "on-mouse-out"
|
|
{ "OnLoadError", XML_NAMESPACE_OFFICE, "load-error" }, // "on-load-error"
|
|
{ "OnLoadCancel", XML_NAMESPACE_OFFICE, "load-cancel" }, // "on-load-cancel"
|
|
{ "OnLoadDone", XML_NAMESPACE_OFFICE, "load-done" }, // "on-load-done"
|
|
{ "OnLoad", XML_NAMESPACE_DOM, "load" }, // "on-load"
|
|
{ "OnUnload", XML_NAMESPACE_DOM, "unload" }, // "on-unload"
|
|
{ "OnStartApp", XML_NAMESPACE_OFFICE, "start-app" }, // "on-start-app"
|
|
{ "OnCloseApp", XML_NAMESPACE_OFFICE, "close-app" }, // "on-close-app"
|
|
{ "OnNew", XML_NAMESPACE_OFFICE, "new" }, // "on-new"
|
|
{ "OnSave", XML_NAMESPACE_OFFICE, "save" }, // "on-save"
|
|
{ "OnSaveAs", XML_NAMESPACE_OFFICE, "save-as" }, // "on-save-as"
|
|
{ "OnFocus", XML_NAMESPACE_DOM, "DOMFocusIn" }, // "on-focus"
|
|
{ "OnUnfocus", XML_NAMESPACE_DOM, "DOMFocusOut" }, // "on-unfocus"
|
|
{ "OnPrint", XML_NAMESPACE_OFFICE, "print" }, // "on-print"
|
|
{ "OnError", XML_NAMESPACE_DOM, "error" }, // "on-error"
|
|
{ "OnLoadFinished", XML_NAMESPACE_OFFICE, "load-finished" }, // "on-load-finished"
|
|
{ "OnSaveFinished", XML_NAMESPACE_OFFICE, "save-finished" }, // "on-save-finished"
|
|
{ "OnModifyChanged", XML_NAMESPACE_OFFICE, "modify-changed" }, // "on-modify-changed"
|
|
{ "OnPrepareUnload", XML_NAMESPACE_OFFICE, "prepare-unload" }, // "on-prepare-unload"
|
|
{ "OnNewMail", XML_NAMESPACE_OFFICE, "new-mail" }, // "on-new-mail"
|
|
{ "OnToggleFullscreen", XML_NAMESPACE_OFFICE, "toggle-fullscreen" }, // "on-toggle-fullscreen"
|
|
{ "OnSaveDone", XML_NAMESPACE_OFFICE, "save-done" }, // "on-save-done"
|
|
{ "OnSaveAsDone", XML_NAMESPACE_OFFICE, "save-as-done" }, // "on-save-as-done"
|
|
{ "OnCopyTo", XML_NAMESPACE_OFFICE, "copy-to" },
|
|
{ "OnCopyToDone", XML_NAMESPACE_OFFICE, "copy-to-done" },
|
|
{ "OnViewCreated", XML_NAMESPACE_OFFICE, "view-created" },
|
|
{ "OnPrepareViewClosing", XML_NAMESPACE_OFFICE, "prepare-view-closing" },
|
|
{ "OnViewClosed", XML_NAMESPACE_OFFICE, "view-close" },
|
|
{ "OnVisAreaChanged", XML_NAMESPACE_OFFICE, "visarea-changed" }, // "on-visarea-changed"
|
|
{ "OnCreate", XML_NAMESPACE_OFFICE, "create" },
|
|
{ "OnSaveAsFailed", XML_NAMESPACE_OFFICE, "save-as-failed" },
|
|
{ "OnSaveFailed", XML_NAMESPACE_OFFICE, "save-failed" },
|
|
{ "OnCopyToFailed", XML_NAMESPACE_OFFICE, "copy-to-failed" },
|
|
{ "OnTitleChanged", XML_NAMESPACE_OFFICE, "title-changed" },
|
|
{ "OnModeChanged", XML_NAMESPACE_OFFICE, "mode-changed" },
|
|
{ "OnSaveTo", XML_NAMESPACE_OFFICE, "save-to" },
|
|
{ "OnSaveToDone", XML_NAMESPACE_OFFICE, "save-to-done" },
|
|
{ "OnSaveToFailed", XML_NAMESPACE_OFFICE, "save-to-failed" },
|
|
{ "OnSubComponentOpened", XML_NAMESPACE_OFFICE, "subcomponent-opened" },
|
|
{ "OnSubComponentClosed", XML_NAMESPACE_OFFICE, "subcomponent-closed" },
|
|
{ "OnStorageChanged", XML_NAMESPACE_OFFICE, "storage-changed" },
|
|
{ "OnMailMergeFinished", XML_NAMESPACE_OFFICE, "mail-merge-finished" },
|
|
{ "OnFieldMerge", XML_NAMESPACE_OFFICE, "field-merge" },
|
|
{ "OnFieldMergeFinished", XML_NAMESPACE_OFFICE, "field-merge-finished" },
|
|
{ "OnLayoutFinished", XML_NAMESPACE_OFFICE, "layout-finished" },
|
|
{ "OnDoubleClick", XML_NAMESPACE_OFFICE, "dblclick" },
|
|
{ "OnRightClick", XML_NAMESPACE_OFFICE, "contextmenu" },
|
|
{ "OnChange", XML_NAMESPACE_OFFICE, "content-changed" },
|
|
{ "OnCalculate", XML_NAMESPACE_OFFICE, "calculated" },
|
|
|
|
{ nullptr, 0, nullptr }
|
|
};
|
|
|
|
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|