strepsirrhini/office-gobmx
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
office-gobmx/sw/qa/unit/swmodeltestbase.cxx
Noel Grandin 144dd13818 loplugin:unusedmethods 
Change-Id: Ib0a72355972662c6b902bca9a527be91fb3e1d17
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/164930
Tested-by: Jenkins
Reviewed-by: Noel Grandin <noel.grandin@collabora.co.uk>
2024-03-17 13:06:48 +01:00

562 lines
21 KiB
C++
Raw Blame History

/* -*- 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/.
*/
#include <swmodeltestbase.hxx>
#include <com/sun/star/container/XContentEnumerationAccess.hpp>
#include <com/sun/star/document/XFilter.hpp>
#include <com/sun/star/document/XImporter.hpp>
#include <com/sun/star/text/XPageCursor.hpp>
#include <com/sun/star/view/XSelectionSupplier.hpp>
#include <com/sun/star/text/XTextTable.hpp>
#include <com/sun/star/text/XTextViewCursorSupplier.hpp>
#include <comphelper/propertyvalue.hxx>
#include <sfx2/docfile.hxx>
#include <rtl/ustrbuf.hxx>
#include <unotools/streamwrap.hxx>
#include <unotools/ucbstreamhelper.hxx>
#include <vcl/scheduler.hxx>
#include <comphelper/configuration.hxx>
#include <officecfg/Office/Writer.hxx>
#include <IDocumentLayoutAccess.hxx>
#include <docsh.hxx>
#include <LibreOfficeKit/LibreOfficeKitEnums.h>
#include <rootfrm.hxx>
#include <unotxdoc.hxx>
#include <view.hxx>
#include <viewsh.hxx>
using namespace css;
void SwModelTestBase::paste(std::u16string_view aFilename, OUString aInstance,
uno::Reference<text::XTextRange> const& xTextRange)
{
uno::Reference<document::XFilter> xFilter(m_xSFactory->createInstance(aInstance),
uno::UNO_QUERY_THROW);
uno::Reference<document::XImporter> xImporter(xFilter, uno::UNO_QUERY_THROW);
xImporter->setTargetDocument(mxComponent);
std::unique_ptr<SvStream> pStream = utl::UcbStreamHelper::CreateStream(
m_directories.getURLFromSrc(u"/sw/qa/extras/") + aFilename, StreamMode::STD_READ);
CPPUNIT_ASSERT_EQUAL(ERRCODE_NONE, pStream->GetError());
uno::Reference<io::XStream> xStream(new utl::OStreamWrapper(std::move(pStream)));
uno::Sequence aDescriptor{ comphelper::makePropertyValue("InputStream", xStream),
comphelper::makePropertyValue("InsertMode", true),
comphelper::makePropertyValue("TextInsertModeRange", xTextRange) };
CPPUNIT_ASSERT(xFilter->filter(aDescriptor));
}
SwModelTestBase::SwModelTestBase(const OUString& pTestDocumentPath, const OUString& pFilter)
: UnoApiXmlTest(pTestDocumentPath)
, mbExported(false)
, mpXmlBuffer(nullptr)
, mpFilter(pFilter)
, mnStartTime(0)
{
}
void SwModelTestBase::executeLoadVerifyReloadVerify(const char* filename, const char* pPassword)
{
maTempFile.EnableKillingFile(false);
header();
loadURL(createFileURL(OUString::createFromAscii(filename)), pPassword);
verify();
saveAndReload(mpFilter, pPassword);
verify();
finish();
maTempFile.EnableKillingFile();
}
void SwModelTestBase::executeImportExport(const char* filename, const char* pPassword)
{
maTempFile.EnableKillingFile(false);
header();
loadAndSave(filename, pPassword);
maTempFile.EnableKillingFile(false);
verify();
finish();
maTempFile.EnableKillingFile();
}
void SwModelTestBase::dumpLayout(const uno::Reference<lang::XComponent>& rComponent)
{
// create the xml writer
mpXmlBuffer = xmlBufferCreate();
xmlTextWriterPtr pXmlWriter = xmlNewTextWriterMemory(mpXmlBuffer, 0);
(void)xmlTextWriterStartDocument(pXmlWriter, nullptr, nullptr, nullptr);
// create the dump
SwXTextDocument* pTextDoc = dynamic_cast<SwXTextDocument*>(rComponent.get());
CPPUNIT_ASSERT(pTextDoc);
SwDoc* pDoc = pTextDoc->GetDocShell()->GetDoc();
SwRootFrame* pLayout = pDoc->getIDocumentLayoutAccess().GetCurrentLayout();
pLayout->dumpAsXml(pXmlWriter);
// delete xml writer
(void)xmlTextWriterEndDocument(pXmlWriter);
xmlFreeTextWriter(pXmlWriter);
}
void SwModelTestBase::discardDumpedLayout()
{
if (mpXmlBuffer)
{
xmlBufferFree(mpXmlBuffer);
mpXmlBuffer = nullptr;
}
}
void SwModelTestBase::calcLayout()
{
getSwDoc()->getIDocumentLayoutAccess().GetCurrentViewShell()->CalcLayout();
}
OUString SwModelTestBase::getBodyText() const
{
uno::Reference<text::XTextDocument> xTextDocument(mxComponent, uno::UNO_QUERY);
uno::Reference<container::XEnumerationAccess> xParaEnumAccess(xTextDocument->getText(),
uno::UNO_QUERY);
uno::Reference<container::XEnumeration> xParaEnum = xParaEnumAccess->createEnumeration();
OUStringBuffer aBuf;
while (xParaEnum->hasMoreElements())
{
uno::Reference<container::XEnumerationAccess> xRangeEnumAccess(xParaEnum->nextElement(),
uno::UNO_QUERY);
uno::Reference<container::XEnumeration> xRangeEnum = xRangeEnumAccess->createEnumeration();
while (xRangeEnum->hasMoreElements())
{
uno::Reference<text::XTextRange> xRange(xRangeEnum->nextElement(), uno::UNO_QUERY);
aBuf.append(xRange->getString());
}
}
return aBuf.makeStringAndClear();
}
uno::Reference<container::XNameAccess> SwModelTestBase::getStyles(const OUString& aFamily)
{
uno::Reference<style::XStyleFamiliesSupplier> xStyleFamiliesSupplier(mxComponent,
uno::UNO_QUERY);
uno::Reference<container::XNameAccess> xStyleFamilies
= xStyleFamiliesSupplier->getStyleFamilies();
uno::Reference<container::XNameAccess> xStyleFamily(xStyleFamilies->getByName(aFamily),
uno::UNO_QUERY);
return xStyleFamily;
}
uno::Reference<style::XAutoStyleFamily> SwModelTestBase::getAutoStyles(const OUString& aFamily)
{
uno::Reference<style::XAutoStylesSupplier> xAutoStylesSupplier(mxComponent, uno::UNO_QUERY);
uno::Reference<style::XAutoStyles> xAutoStyles(xAutoStylesSupplier->getAutoStyles());
uno::Reference<style::XAutoStyleFamily> xAutoStyleFamily(xAutoStyles->getByName(aFamily),
uno::UNO_QUERY);
return xAutoStyleFamily;
}
xmlDocUniquePtr SwModelTestBase::parseLayoutDump()
{
if (!mpXmlBuffer)
dumpLayout(mxComponent);
auto pBuffer = reinterpret_cast<const char*>(xmlBufferContent(mpXmlBuffer));
SAL_INFO("sw.qa", "SwModelTestBase::parseLayoutDump: pBuffer is '" << pBuffer << "'");
return xmlDocUniquePtr(xmlParseMemory(pBuffer, xmlBufferLength(mpXmlBuffer)));
}
OUString SwModelTestBase::parseDump(const OString& aXPath, const OString& aAttribute)
{
xmlDocUniquePtr pXmlDoc = parseLayoutDump();
xmlXPathContextPtr pXmlXpathCtx = xmlXPathNewContext(pXmlDoc.get());
xmlXPathObjectPtr pXmlXpathObj
= xmlXPathEvalExpression(BAD_CAST(aXPath.getStr()), pXmlXpathCtx);
CPPUNIT_ASSERT_MESSAGE("xpath evaluation failed", pXmlXpathObj);
xmlChar* pXpathStrResult;
if (pXmlXpathObj->type == XPATH_NODESET)
{
xmlNodeSetPtr pXmlNodes = pXmlXpathObj->nodesetval;
int nNodes = xmlXPathNodeSetGetLength(pXmlNodes);
OString aMessage("xpath ('" + aXPath + "') should match exactly 1 node");
CPPUNIT_ASSERT_EQUAL_MESSAGE(aMessage.getStr(), 1, nNodes);
xmlNodePtr pXmlNode = pXmlNodes->nodeTab[0];
if (aAttribute.getLength())
pXpathStrResult = xmlGetProp(pXmlNode, BAD_CAST(aAttribute.getStr()));
else
pXpathStrResult = xmlNodeGetContent(pXmlNode);
}
else
{
// the xpath expression evaluated to a value, not a node
CPPUNIT_ASSERT_EQUAL_MESSAGE("attr name should not be supplied when xpath evals to a value",
sal_Int32(0), aAttribute.getLength());
pXpathStrResult = xmlXPathCastToString(pXmlXpathObj);
CPPUNIT_ASSERT_MESSAGE("xpath result cannot be cast to string", pXpathStrResult);
}
OUString aRet(reinterpret_cast<char*>(pXpathStrResult), xmlStrlen(pXpathStrResult),
RTL_TEXTENCODING_UTF8);
xmlFree(pXpathStrResult);
xmlFree(pXmlXpathObj);
xmlFree(pXmlXpathCtx);
return aRet;
}
bool SwModelTestBase::hasProperty(const uno::Reference<uno::XInterface>& obj,
const OUString& name) const
{
uno::Reference<beans::XPropertySet> properties(obj, uno::UNO_QUERY_THROW);
return properties->getPropertySetInfo()->hasPropertyByName(name);
}
xml::AttributeData SwModelTestBase::getUserDefineAttribute(const uno::Any& obj,
const OUString& name,
const OUString& rValue) const
{
uno::Reference<container::XNameContainer> attrsCnt(
getProperty<uno::Any>(obj, "UserDefinedAttributes"), uno::UNO_QUERY_THROW);
xml::AttributeData aValue;
attrsCnt->getByName(name) >>= aValue;
if (!rValue.isEmpty())
CPPUNIT_ASSERT_EQUAL_MESSAGE("attribute of cell does not contain expected value", rValue,
aValue.Value);
return aValue;
}
int SwModelTestBase::getParagraphs(uno::Reference<text::XText> const& xText)
{
int nRet = 0;
if (!xText.is())
return nRet;
uno::Reference<container::XEnumerationAccess> xParaEnumAccess(xText->getText(), uno::UNO_QUERY);
uno::Reference<container::XEnumeration> xParaEnum = xParaEnumAccess->createEnumeration();
while (xParaEnum->hasMoreElements())
{
xParaEnum->nextElement();
nRet++;
}
return nRet;
}
int SwModelTestBase::getParagraphs()
{
uno::Reference<text::XTextDocument> xTextDocument(mxComponent, uno::UNO_QUERY);
return getParagraphs(xTextDocument->getText());
}
uno::Reference<text::XTextContent>
SwModelTestBase::getParagraphOrTable(int number, uno::Reference<text::XText> const& xText) const
{
assert(number != 0); // this thing is 1-based
uno::Reference<container::XEnumerationAccess> paraEnumAccess;
if (xText.is())
paraEnumAccess.set(xText, uno::UNO_QUERY);
else
{
uno::Reference<text::XTextDocument> textDocument(mxComponent, uno::UNO_QUERY);
paraEnumAccess.set(textDocument->getText(), uno::UNO_QUERY);
}
uno::Reference<container::XEnumeration> paraEnum = paraEnumAccess->createEnumeration();
for (int i = 1; i < number; ++i)
paraEnum->nextElement();
uno::Reference<text::XTextContent> const xElem(paraEnum->nextElement(), uno::UNO_QUERY_THROW);
return xElem;
}
uno::Reference<text::XTextRange> SwModelTestBase::getParagraph(int number,
const OUString& content) const
{
uno::Reference<text::XTextRange> const xParagraph(getParagraphOrTable(number),
uno::UNO_QUERY_THROW);
if (!content.isEmpty())
CPPUNIT_ASSERT_EQUAL_MESSAGE("paragraph does not have expected content", content,
xParagraph->getString());
return xParagraph;
}
sal_Int16 SwModelTestBase::getNumberingTypeOfParagraph(int nPara)
{
sal_Int16 nNumberingType = -1;
uno::Reference<text::XTextRange> xPara(getParagraph(nPara));
uno::Reference<beans::XPropertySet> properties(xPara, uno::UNO_QUERY);
bool isNumber = false;
properties->getPropertyValue("NumberingIsNumber") >>= isNumber;
if (isNumber)
{
uno::Reference<container::XIndexAccess> xLevels(
properties->getPropertyValue("NumberingRules"), uno::UNO_QUERY);
sal_Int16 nNumberingLevel = -1;
properties->getPropertyValue("NumberingLevel") >>= nNumberingLevel;
if (nNumberingLevel >= 0 && nNumberingLevel < xLevels->getCount())
{
uno::Sequence<beans::PropertyValue> aPropertyValue;
xLevels->getByIndex(nNumberingLevel) >>= aPropertyValue;
auto pProp = std::find_if(
std::cbegin(aPropertyValue), std::cend(aPropertyValue),
[](const beans::PropertyValue& rProp) { return rProp.Name == "NumberingType"; });
if (pProp != std::cend(aPropertyValue))
nNumberingType = pProp->Value.get<sal_Int16>();
}
}
return nNumberingType;
}
uno::Reference<text::XTextRange>
SwModelTestBase::getParagraphOfText(int number, uno::Reference<text::XText> const& xText,
const OUString& content) const
{
uno::Reference<text::XTextRange> const xParagraph(getParagraphOrTable(number, xText),
uno::UNO_QUERY);
CPPUNIT_ASSERT(xParagraph.is());
if (!content.isEmpty())
CPPUNIT_ASSERT_EQUAL_MESSAGE("paragraph does not contain expected content", content,
xParagraph->getString());
return xParagraph;
}
uno::Reference<beans::XPropertySet>
SwModelTestBase::getParagraphAnchoredObject(int const index,
uno::Reference<text::XTextRange> const& xPara) const
{
uno::Reference<container::XContentEnumerationAccess> xContentEnumAccess(xPara, uno::UNO_QUERY);
uno::Reference<container::XEnumeration> xContentEnum
= xContentEnumAccess->createContentEnumeration("com.sun.star.text.TextContent");
for (int i = 1; i < index; ++i)
{
xContentEnum->nextElement();
}
return uno::Reference<beans::XPropertySet>(xContentEnum->nextElement(), uno::UNO_QUERY);
}
uno::Reference<text::XTextRange>
SwModelTestBase::getRun(uno::Reference<text::XTextRange> const& xParagraph, int number,
const OUString& content) const
{
uno::Reference<container::XEnumerationAccess> xRunEnumAccess(xParagraph, uno::UNO_QUERY);
uno::Reference<container::XEnumeration> xRunEnum = xRunEnumAccess->createEnumeration();
for (int i = 1; i < number; ++i)
xRunEnum->nextElement();
uno::Reference<text::XTextRange> xRun(xRunEnum->nextElement(), uno::UNO_QUERY);
if (!content.isEmpty())
CPPUNIT_ASSERT_EQUAL_MESSAGE("run does not contain expected content", content,
xRun->getString());
return xRun;
}
OUString SwModelTestBase::getFormula(uno::Reference<text::XTextRange> const& xRun) const
{
uno::Reference<container::XContentEnumerationAccess> xContentEnumAccess(xRun, uno::UNO_QUERY);
uno::Reference<container::XEnumeration> xContentEnum
= xContentEnumAccess->createContentEnumeration("");
uno::Reference<beans::XPropertySet> xFormula(xContentEnum->nextElement(), uno::UNO_QUERY);
return getProperty<OUString>(
getProperty<uno::Reference<beans::XPropertySet>>(xFormula, "Model"), "Formula");
}
uno::Reference<table::XCell>
SwModelTestBase::getCell(uno::Reference<uno::XInterface> const& xTableIfc, OUString const& rCell,
OUString const& rContent)
{
uno::Reference<text::XTextTable> const xTable(xTableIfc, uno::UNO_QUERY_THROW);
uno::Reference<table::XCell> const xCell(xTable->getCellByName(rCell), uno::UNO_SET_THROW);
if (!rContent.isEmpty())
{
uno::Reference<text::XText> const xCellText(xCell, uno::UNO_QUERY_THROW);
CPPUNIT_ASSERT_EQUAL_MESSAGE("cell does not contain expected content", rContent,
xCellText->getString());
}
return xCell;
}
uno::Reference<drawing::XShape> SwModelTestBase::getShape(int number)
{
uno::Reference<drawing::XDrawPageSupplier> xDrawPageSupplier(mxComponent, uno::UNO_QUERY);
uno::Reference<drawing::XDrawPage> xDrawPage = xDrawPageSupplier->getDrawPage();
uno::Reference<drawing::XShape> xShape(xDrawPage->getByIndex(number - 1), uno::UNO_QUERY);
return xShape;
}
void SwModelTestBase::selectShape(int number)
{
SwXTextDocument* pXTextDocument = dynamic_cast<SwXTextDocument*>(mxComponent.get());
uno::Reference<view::XSelectionSupplier> xSelectionSupplier(
pXTextDocument->getCurrentController(), uno::UNO_QUERY);
xSelectionSupplier->select(uno::Any(getShape(number)));
CPPUNIT_ASSERT(xSelectionSupplier->getSelection().hasValue());
SwDoc* pDoc = pXTextDocument->GetDocShell()->GetDoc();
SwView* pView = pDoc->GetDocShell()->GetView();
// Make sure SwTextShell is replaced with SwDrawShell right now, not after 120 ms, as set in the
// SwView ctor.
pView->StopShellTimer();
}
uno::Reference<drawing::XShape> SwModelTestBase::getShapeByName(std::u16string_view aName)
{
uno::Reference<drawing::XShape> xRet;
uno::Reference<drawing::XDrawPageSupplier> xDrawPageSupplier(mxComponent, uno::UNO_QUERY);
uno::Reference<drawing::XDrawPage> xDrawPage = xDrawPageSupplier->getDrawPage();
for (sal_Int32 i = 0; i < xDrawPage->getCount(); ++i)
{
uno::Reference<container::XNamed> xShape(xDrawPage->getByIndex(i), uno::UNO_QUERY);
if (xShape->getName() == aName)
{
xRet.set(xShape, uno::UNO_QUERY);
break;
}
}
return xRet;
}
uno::Reference<drawing::XShape> SwModelTestBase::getTextFrameByName(const OUString& aName)
{
uno::Reference<text::XTextFramesSupplier> xTextFramesSupplier(mxComponent, uno::UNO_QUERY);
uno::Reference<container::XNameAccess> xNameAccess = xTextFramesSupplier->getTextFrames();
uno::Reference<drawing::XShape> xShape(xNameAccess->getByName(aName), uno::UNO_QUERY);
return xShape;
}
void SwModelTestBase::header() {}
void SwModelTestBase::loadURL(OUString const& rURL, const char* pPassword)
{
// Output name at load time, so in the case of a hang, the name of the hanging input file is visible.
if (!isExported())
{
std::cout << rURL << ":\n";
mnStartTime = osl_getGlobalTimer();
}
UnoApiXmlTest::load(rURL, pPassword);
CPPUNIT_ASSERT(!getSwDocShell()->GetMedium()->GetWarningError());
discardDumpedLayout();
calcLayout();
}
void SwModelTestBase::saveAndReload(const OUString& pFilter, const char* pPassword)
{
save(pFilter, pPassword);
mbExported = true;
loadURL(maTempFile.GetURL(), pPassword);
}
void SwModelTestBase::loadAndSave(const char* pName, const char* pPassword)
{
loadURL(createFileURL(OUString::createFromAscii(pName)), pPassword);
save(mpFilter);
mbExported = true;
}
void SwModelTestBase::loadAndReload(const char* pName)
{
loadURL(createFileURL(OUString::createFromAscii(pName)));
saveAndReload(mpFilter);
}
void SwModelTestBase::finish()
{
sal_uInt32 nEndTime = osl_getGlobalTimer();
std::cout << (nEndTime - mnStartTime) << std::endl;
discardDumpedLayout();
}
int SwModelTestBase::getPages() const
{
uno::Reference<frame::XModel> xModel(mxComponent, uno::UNO_QUERY);
uno::Reference<text::XTextViewCursorSupplier> xTextViewCursorSupplier(
xModel->getCurrentController(), uno::UNO_QUERY);
uno::Reference<text::XPageCursor> xCursor(xTextViewCursorSupplier->getViewCursor(),
uno::UNO_QUERY);
xCursor->jumpToLastPage();
return xCursor->getPage();
}
int SwModelTestBase::getShapes() const
{
uno::Reference<drawing::XDrawPageSupplier> xDrawPageSupplier(mxComponent, uno::UNO_QUERY);
uno::Reference<container::XIndexAccess> xDraws = xDrawPageSupplier->getDrawPage();
return xDraws->getCount();
}
void SwModelTestBase::createSwDoc(const char* pName, const char* pPassword)
{
if (!pName)
loadURL("private:factory/swriter");
else
loadURL(createFileURL(OUString::createFromAscii(pName)), pPassword);
uno::Reference<lang::XServiceInfo> xServiceInfo(mxComponent, uno::UNO_QUERY_THROW);
CPPUNIT_ASSERT(xServiceInfo->supportsService("com.sun.star.text.TextDocument"));
}
void SwModelTestBase::createSwWebDoc(const char* pName)
{
if (!pName)
loadURL("private:factory/swriter/web");
else
loadURL(createFileURL(OUString::createFromAscii(pName)));
uno::Reference<lang::XServiceInfo> xServiceInfo(mxComponent, uno::UNO_QUERY_THROW);
CPPUNIT_ASSERT(xServiceInfo->supportsService("com.sun.star.text.WebDocument"));
}
void SwModelTestBase::createSwGlobalDoc(const char* pName)
{
if (!pName)
loadURL("private:factory/swriter/GlobalDocument");
else
loadURL(createFileURL(OUString::createFromAscii(pName)));
uno::Reference<lang::XServiceInfo> xServiceInfo(mxComponent, uno::UNO_QUERY_THROW);
CPPUNIT_ASSERT(xServiceInfo->supportsService("com.sun.star.text.GlobalDocument"));
}
SwDoc* SwModelTestBase::getSwDoc() { return getSwDocShell()->GetDoc(); }
SwDocShell* SwModelTestBase::getSwDocShell()
{
SwXTextDocument* pTextDoc = dynamic_cast<SwXTextDocument*>(mxComponent.get());
CPPUNIT_ASSERT(pTextDoc);
return pTextDoc->GetDocShell();
}
xmlDocUniquePtr SwModelTestBase::WrapReqifFromTempFile()
{
SvMemoryStream aStream;
aStream.WriteOString("<reqif-xhtml:html xmlns:reqif-xhtml=\"http://www.w3.org/1999/xhtml\">\n");
SvFileStream aFileStream(maTempFile.GetURL(), StreamMode::READ);
aStream.WriteStream(aFileStream);
aStream.WriteOString("</reqif-xhtml:html>\n");
aStream.Seek(0);
xmlDocUniquePtr pXmlDoc = parseXmlStream(&aStream);
// Make sure the output is well-formed.
CPPUNIT_ASSERT(pXmlDoc);
return pXmlDoc;
}
void SwModelTestBase::emulateTyping(SwXTextDocument& rTextDoc, const std::u16string_view& rStr)
{
for (const char16_t c : rStr)
{
rTextDoc.postKeyEvent(LOK_KEYEVENT_KEYINPUT, c, 0);
rTextDoc.postKeyEvent(LOK_KEYEVENT_KEYUP, c, 0);
Scheduler::ProcessEventsToIdle();
}
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
Reference in a new issue View git blame Copy permalink