office-gobmx/include/vcl/FilterConfigItem.hxx
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

94 lines
3.7 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 .
*/
#ifndef INCLUDED_VCL_FILTERCONFIGITEM_HXX
#define INCLUDED_VCL_FILTERCONFIGITEM_HXX
#include <sal/config.h>
#include <string_view>
#include <vcl/dllapi.h>
#include <rtl/ustring.hxx>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/uno/Reference.h>
#include <com/sun/star/uno/Sequence.hxx>
namespace com::sun::star::beans { class XPropertySet; }
namespace com::sun::star::task { class XStatusIndicator; }
namespace com::sun::star::uno { class Any; }
namespace com::sun::star::uno { class XInterface; }
class VCL_DLLPUBLIC FilterConfigItem
{
css::uno::Reference< css::uno::XInterface > xUpdatableView;
css::uno::Reference< css::beans::XPropertySet > xPropSet;
css::uno::Sequence< css::beans::PropertyValue > aFilterData;
bool bModified;
static bool ImplGetPropertyValue( css::uno::Any& rAny,
const css::uno::Reference< css::beans::XPropertySet >& rXPropSet,
const OUString& rPropName );
void ImpInitTree( std::u16string_view rTree );
static const css::beans::PropertyValue* GetPropertyValue(
const css::uno::Sequence< css::beans::PropertyValue >& rPropSeq,
const OUString& rName );
static bool WritePropertyValue(
css::uno::Sequence< css::beans::PropertyValue >& rPropSeq,
const css::beans::PropertyValue& rPropValue );
public:
FilterConfigItem( std::u16string_view rSubTree );
FilterConfigItem( css::uno::Sequence< css::beans::PropertyValue > const * pFilterData );
FilterConfigItem( std::u16string_view rSubTree, css::uno::Sequence< css::beans::PropertyValue > const * pFilterData );
/// Writes config in destructor
~FilterConfigItem();
/// Writes config and sets unmodified state again.
void WriteModifiedConfig();
// all read methods are trying to return values in following order:
// 1. FilterData PropertySequence
// 2. configuration
// 3. given default
bool ReadBool( const OUString& rKey, bool bDefault );
sal_Int32 ReadInt32( const OUString& rKey, sal_Int32 nDefault );
OUString
ReadString( const OUString& rKey, const OUString& rDefault );
// try to store to configuration
// and always stores into the FilterData sequence
void WriteBool( const OUString& rKey, bool bValue );
void WriteInt32( const OUString& rKey, sal_Int32 nValue );
const css::uno::Sequence< css::beans::PropertyValue >& GetFilterData() const { return aFilterData;}
// GetStatusIndicator is returning the "StatusIndicator" property of the FilterData sequence
css::uno::Reference< css::task::XStatusIndicator > GetStatusIndicator() const;
};
#endif // INCLUDED_VCL_FILTERCONFIGITEM_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */