office-gobmx/configmgr/source/xcuparser.hxx
Stephan Bergmann 7f927322d9 configmgr: Better handling of finalized vs. non-finalized in the same layer
When there are multiple competing configuration settings for the same
configuration layer (e.g., in xcu files of two different extensions from the
same extension layer), then the setting that is read last always won, even if
any of the settings read earlier is marked as finalized.  (The reason for
originally doing it that way was that it kept the code logic somewhat simple.)

However, esp. for a scenario of multiple extensions in one extension layer
(bundled, shared, or user), it can be unexpected by a user that a non-finalized
setting (that comes from the extension that happens to be read last) can win
over a finalized one.

Therefore, change the logic accordingly.  Now, if any of the competing settings
are finalized, the first finalized one that is read wins.

Change-Id: I22aeade543a5b26d95d49cfcb561f974cd7a5081
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/177737
Tested-by: Jenkins
Reviewed-by: Stephan Bergmann <stephan.bergmann@allotropia.de>
2024-12-03 16:26:52 +01:00

154 lines
4.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 .
*/
#pragma once
#include <sal/config.h>
#include <set>
#include <stack>
#include <string_view>
#include <rtl/ref.hxx>
#include <rtl/ustring.hxx>
#include <utility>
#include <xmlreader/xmlreader.hxx>
#include "additions.hxx"
#include "node.hxx"
#include "nodemap.hxx"
#include "parser.hxx"
#include "type.hxx"
#include "valueparser.hxx"
namespace xmlreader { struct Span; }
namespace configmgr {
class GroupNode;
class LocalizedPropertyNode;
class Modifications;
class Partial;
class PropertyNode;
class SetNode;
struct Data;
class XcuParser: public Parser {
public:
XcuParser(
int layer, Data & data, Partial const * partial,
Modifications * broadcastModifications, Additions * additions);
private:
virtual ~XcuParser() override;
virtual xmlreader::XmlReader::Text getTextMode() override;
virtual bool startElement(
xmlreader::XmlReader & reader, int nsId, xmlreader::Span const & name,
std::set< OUString > const * existingDependencies) override;
virtual void endElement(xmlreader::XmlReader const & reader) override;
virtual void characters(xmlreader::Span const & span) override;
enum Operation {
OPERATION_MODIFY, OPERATION_REPLACE, OPERATION_FUSE, OPERATION_REMOVE };
static Operation parseOperation(xmlreader::Span const & text);
bool isAlreadyFinalized(int finalizedLayer) const;
void handleComponentData(xmlreader::XmlReader & reader);
void handleItem(xmlreader::XmlReader & reader);
void handlePropValue(xmlreader::XmlReader & reader, PropertyNode * prop);
void handleLocpropValue(
xmlreader::XmlReader & reader, LocalizedPropertyNode * locprop);
void handleGroupProp(xmlreader::XmlReader & reader, GroupNode * group);
void handleUnknownGroupProp(
xmlreader::XmlReader const & reader, GroupNode const * group,
OUString const & name, Type type, Operation operation,
bool finalized);
void handlePlainGroupProp(
xmlreader::XmlReader const & reader, GroupNode * group,
NodeMap::iterator const & propertyIndex, std::u16string_view name,
Type type, Operation operation, bool finalized);
void handleLocalizedGroupProp(
xmlreader::XmlReader const & reader, LocalizedPropertyNode * property,
OUString const & name, Type type, Operation operation,
bool finalized);
void handleGroupNode(
xmlreader::XmlReader & reader, rtl::Reference< Node > const & group);
void handleSetNode(xmlreader::XmlReader & reader, SetNode * set);
void recordModification(bool addition);
struct State {
rtl::Reference< Node > node; // empty if ignore or <items>
OUString name; // empty and ignored if !insert
bool ignore;
bool insert;
bool pop;
static State Ignore(bool thePop) { return State(thePop); }
static State Modify(rtl::Reference< Node > const & theNode)
{ return State(theNode); }
static State Insert(
rtl::Reference< Node > const & theNode, OUString const & theName)
{ return State(theNode, theName); }
private:
explicit State(bool thePop): ignore(true), insert(false), pop(thePop) {}
explicit State(rtl::Reference< Node > theNode):
node(std::move(theNode)), ignore(false), insert(false), pop(true)
{}
State(
rtl::Reference< Node > theNode, OUString theName):
node(std::move(theNode)), name(std::move(theName)), ignore(false), insert(true), pop(true)
{}
};
ValueParser valueParser_;
Data & data_;
Partial const * partial_;
Modifications * broadcastModifications_;
Additions * additions_;
bool recordModifications_;
bool trackPath_;
OUString componentName_;
std::stack< State > state_;
std::vector<OUString> path_;
};
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */