office-gobmx/uui/source/iahndl-filter.cxx
Mike Kaganski 8a017d25a6 Avoid COW overhead using css::uno::Sequence
The scenarios are:

1. Calling sequence's begin() and end() in pairs to pass to algorithms
   (both calls use getArray(), which does the COW checks)
2. In addition to #1, calling end() again when checking result of find
   algorithms, and/or begin() to calculate result's distance
3. Using non-const sequences in range-based for loops, which internally
   do #1
4. Assigning sequence to another sequence variable, and then modifying
   one of them

In many cases, the sequences could be made const, or treated as const
for the purposes of the algorithms (using std::as_const, std::cbegin,
and std::cend). Where algorithm modifies the sequence, it was changed
to only call getArray() once. For that, css::uno::toNonConstRange was
introduced, which returns a struct (sublclass of std::pair) with two
iterators [begin, end], that are calculated using one call to begin()
and one call to getLength().

To handle #4, css::uno::Sequence::swap was introduced, that swaps the
internal pointer to uno_Sequence. So when a local Sequence variable
should be assigned to another variable, and the latter will be modified
further, it's now possible to use swap instead, so the two sequences
are kept independent.

The modified places were found by temporarily removing non-const end().

Change-Id: I8fe2787f200eecb70744e8b77fbdf7a49653f628
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/123542
Tested-by: Jenkins
Reviewed-by: Mike Kaganski <mike.kaganski@collabora.com>
2021-10-14 06:00:49 +02:00

315 lines
11 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 <com/sun/star/beans/XPropertyAccess.hpp>
#include <com/sun/star/container/XContainerQuery.hpp>
#include <com/sun/star/container/XNameAccess.hpp>
#include <com/sun/star/document/FilterOptionsRequest.hpp>
#include <com/sun/star/document/NoSuchFilterRequest.hpp>
#include <com/sun/star/document/XImporter.hpp>
#include <com/sun/star/document/XInteractionFilterOptions.hpp>
#include <com/sun/star/document/XInteractionFilterSelect.hpp>
#include <com/sun/star/task/XInteractionAbort.hpp>
#include <com/sun/star/task/XInteractionRequest.hpp>
#include <com/sun/star/ui/dialogs/XExecutableDialog.hpp>
#include <comphelper/propertysequence.hxx>
#include <comphelper/sequenceashashmap.hxx>
#include <vcl/svapp.hxx>
#include "getcontinuations.hxx"
#include "fltdlg.hxx"
#include "iahndl.hxx"
using namespace com::sun::star;
namespace {
void
executeFilterDialog(
weld::Window* pParent ,
OUString const & rURL ,
uui::FilterNameList const & rFilters,
OUString & rFilter )
{
SolarMutexGuard aGuard;
uui::FilterDialog aDialog(pParent);
aDialog.SetURL(rURL);
aDialog.ChangeFilters(&rFilters);
uui::FilterNameListPtr pSelected = rFilters.end();
if (aDialog.AskForFilter(pSelected))
{
rFilter = pSelected->sInternal;
}
}
void
handleNoSuchFilterRequest_(
weld::Window* pParent,
uno::Reference< uno::XComponentContext > const & xContext,
document::NoSuchFilterRequest const & rRequest,
uno::Sequence< uno::Reference< task::XInteractionContinuation > > const &
rContinuations )
{
uno::Reference< task::XInteractionAbort > xAbort;
uno::Reference< document::XInteractionFilterSelect > xFilterTransport;
getContinuations(rContinuations, &xAbort, &xFilterTransport);
// check necessary resources - if they don't exist - abort or
// break this operation
if (!xAbort.is())
return;
if (!xFilterTransport.is())
{
xAbort->select();
return;
}
uno::Reference< container::XContainerQuery > xFilterContainer;
try
{
xFilterContainer.set( xContext->getServiceManager()->createInstanceWithContext(
"com.sun.star.document.FilterFactory", xContext ),
uno::UNO_QUERY );
}
catch ( uno::Exception const & )
{
}
if (!xFilterContainer.is())
{
xAbort->select();
return;
}
uui::FilterNameList lNames;
// Note: We look for all filters here which match the following criteria:
// - they are import filters as minimum (of course they can
// support export too)
// - we don't show any filter which are flagged as "don't show it
// at the UI" or "they are not installed"
// - we ignore filters, which have not set any valid
// DocumentService (e.g. our pure graphic filters)
// - we show it sorted by her UIName's
// - We don't use the order flag or prefer default filters.
// (Because this list shows all filters and the user should
// find his filter very easy by his UIName ...)
// - We use "_query_all" here ... but we filter graphic filters
// out by using DocumentService property later!
uno::Reference< container::XEnumeration > xFilters
= xFilterContainer->createSubSetEnumerationByQuery(
"_query_all:sort_prop=uiname:iflags=1:eflags=143360");
while (xFilters->hasMoreElements())
{
try
{
::comphelper::SequenceAsHashMap lProps(xFilters->nextElement());
uui::FilterNamePair aPair;
aPair.sInternal = lProps.getUnpackedValueOrDefault(
"Name", OUString());
aPair.sUI = lProps.getUnpackedValueOrDefault(
"UIName", OUString());
if ( aPair.sInternal.isEmpty() || aPair.sUI.isEmpty() )
{
continue;
}
lNames.push_back( aPair );
}
catch(const uno::RuntimeException&)
{
throw;
}
catch(const uno::Exception&)
{
continue;
}
}
// no list available for showing
// -> abort operation
if (lNames.empty())
{
xAbort->select();
return;
}
// let the user select the right filter
OUString sSelectedFilter;
executeFilterDialog( pParent,
rRequest.URL,
lNames,
sSelectedFilter );
// If he doesn't select anyone
// -> abort operation
if (sSelectedFilter.isEmpty())
{
xAbort->select();
return;
}
// otherwise set it for return
xFilterTransport->setFilter( sSelectedFilter );
xFilterTransport->select();
}
void
handleFilterOptionsRequest_(
uno::Reference<awt::XWindow> const & rWindow,
uno::Reference< uno::XComponentContext > const & xContext,
document::FilterOptionsRequest const & rRequest,
uno::Sequence< uno::Reference< task::XInteractionContinuation > > const &
rContinuations)
{
uno::Reference< task::XInteractionAbort > xAbort;
uno::Reference< document::XInteractionFilterOptions > xFilterOptions;
getContinuations(rContinuations, &xAbort, &xFilterOptions);
uno::Reference< container::XNameAccess > xFilterCFG;
try
{
xFilterCFG.set( xContext->getServiceManager()->createInstanceWithContext(
"com.sun.star.document.FilterFactory", xContext ),
uno::UNO_QUERY );
}
catch ( uno::Exception const & )
{
}
if( xFilterCFG.is() && rRequest.rProperties.hasElements() )
{
try
{
OUString aFilterName;
auto pProperty = std::find_if(rRequest.rProperties.begin(), rRequest.rProperties.end(),
[](const beans::PropertyValue& rProp) { return rProp.Name == "FilterName"; });
if (pProperty != rRequest.rProperties.end())
{
pProperty->Value >>= aFilterName;
}
uno::Sequence < beans::PropertyValue > aProps;
if ( xFilterCFG->getByName( aFilterName ) >>= aProps )
{
auto pProp = std::find_if(std::cbegin(aProps), std::cend(aProps),
[](const beans::PropertyValue& rProp) { return rProp.Name == "UIComponent"; });
if (pProp != std::cend(aProps))
{
OUString aServiceName;
pProp->Value >>= aServiceName;
if( !aServiceName.isEmpty() )
{
uno::Sequence<uno::Any> aDialogArgs(comphelper::InitAnyPropertySequence(
{
{"ParentWindow", uno::Any(rWindow)},
}));
uno::Reference<
ui::dialogs::XExecutableDialog > xFilterDialog(
xContext->getServiceManager()->createInstanceWithArgumentsAndContext(
aServiceName, aDialogArgs, xContext ),
uno::UNO_QUERY );
uno::Reference< beans::XPropertyAccess >
xFilterProperties( xFilterDialog,
uno::UNO_QUERY );
if( xFilterDialog.is() && xFilterProperties.is() )
{
uno::Reference<
document::XImporter > xImporter(
xFilterDialog, uno::UNO_QUERY );
if( xImporter.is() )
xImporter->setTargetDocument( rRequest.rModel );
xFilterProperties->setPropertyValues(
rRequest.rProperties );
if( xFilterDialog->execute() )
{
xFilterOptions->setFilterOptions(
xFilterProperties->getPropertyValues() );
xFilterOptions->select();
return;
}
}
}
}
}
}
catch( container::NoSuchElementException& )
{
// the filter name is unknown
}
catch( uno::Exception& )
{
}
}
xAbort->select();
}
} // namespace
bool
UUIInteractionHelper::handleNoSuchFilterRequest(
uno::Reference< task::XInteractionRequest > const & rRequest)
{
uno::Any aAnyRequest(rRequest->getRequest());
document::NoSuchFilterRequest aNoSuchFilterRequest;
if (aAnyRequest >>= aNoSuchFilterRequest)
{
uno::Reference<awt::XWindow> xParent = getParentXWindow();
handleNoSuchFilterRequest_(Application::GetFrameWeld(xParent),
m_xContext,
aNoSuchFilterRequest,
rRequest->getContinuations());
return true;
}
return false;
}
bool
UUIInteractionHelper::handleFilterOptionsRequest(
uno::Reference< task::XInteractionRequest > const & rRequest)
{
uno::Any aAnyRequest(rRequest->getRequest());
document::FilterOptionsRequest aFilterOptionsRequest;
if (aAnyRequest >>= aFilterOptionsRequest)
{
handleFilterOptionsRequest_(getParentXWindow(),
m_xContext,
aFilterOptionsRequest,
rRequest->getContinuations());
return true;
}
return false;
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */