UmsciAppConfiguration.cpp

Go to the documentation of this file.

/* Copyright (c) 2026, Christian Ahrens
 *
 * This file is part of Umsci <https://github.com/ChristianAhrens/Umsci>
 *
 * This tool is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 3.0 as published
 * by the Free Software Foundation.
 *
 * This tool is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this tool; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#include "UmsciAppConfiguration.h"
 
 
UmsciAppConfiguration::UmsciAppConfiguration(const juce::File& file)
    : JUCEAppBasics::AppConfigurationBase()
{
    InitializeBase(file, JUCEAppBasics::AppConfigurationBase::Version::FromString(Umsci_CONFIG_VERSION));
}
 
UmsciAppConfiguration::~UmsciAppConfiguration()
{
}
 
bool UmsciAppConfiguration::isValid()
{
    return isValid(m_xml);
}
 
bool UmsciAppConfiguration::isValid(const std::unique_ptr<juce::XmlElement>& xmlConfig)
{
    if (!JUCEAppBasics::AppConfigurationBase::isValid(xmlConfig))
        return false;
 
    auto connectionConfigSectionElement = xmlConfig->getChildByName(UmsciAppConfiguration::getTagName(UmsciAppConfiguration::TagID::CONNECTIONCONFIG));
    if (connectionConfigSectionElement)
    {
        if (juce::String("ERROR") == connectionConfigSectionElement->getStringAttribute(UmsciAppConfiguration::getAttributeName(UmsciAppConfiguration::AttributeID::IP), "ERROR"))
            return false;
        if (-1 == connectionConfigSectionElement->getIntAttribute(UmsciAppConfiguration::getAttributeName(UmsciAppConfiguration::AttributeID::PORT), -1))
            return false;
        
        // positive validation outcome - continue
    }
    else
        return false;
 
    auto visuConfigSectionElement = xmlConfig->getChildByName(UmsciAppConfiguration::getTagName(UmsciAppConfiguration::TagID::VISUCONFIG));
    if (visuConfigSectionElement)
    {
        auto controlColourXmlElement = visuConfigSectionElement->getChildByName(UmsciAppConfiguration::getTagName(UmsciAppConfiguration::TagID::CONTROLCOLOUR));
        if (controlColourXmlElement)
        {
            // validate
        }
        else
            return false;
 
        auto lookAndFeelXmlElement = visuConfigSectionElement->getChildByName(UmsciAppConfiguration::getTagName(UmsciAppConfiguration::TagID::LOOKANDFEEL));
        if (lookAndFeelXmlElement)
        {
            // validate
        }
        else
            return false;
    }
    else
        return false;
 
    auto controlConfigSectionElement = xmlConfig->getChildByName(UmsciAppConfiguration::getTagName(UmsciAppConfiguration::TagID::CONTROLCONFIG));
    if (controlConfigSectionElement)
    {
        if (juce::String("ERROR") == controlConfigSectionElement->getStringAttribute(UmsciAppConfiguration::getAttributeName(UmsciAppConfiguration::AttributeID::IOSIZE), "ERROR"))
            return false;
 
        // positive validation outcome - continue
    }
    else
        return false;
 
    auto upmixConfigSectionElement = xmlConfig->getChildByName(UmsciAppConfiguration::getTagName(UmsciAppConfiguration::TagID::UPMIXCONFIG));
    if (upmixConfigSectionElement)
    {
        if (-1 == upmixConfigSectionElement->getIntAttribute(UmsciAppConfiguration::getAttributeName(UmsciAppConfiguration::AttributeID::UPMIXSOURCESTARTID), -1))
            return false;
        if (-1 == upmixConfigSectionElement->getIntAttribute(UmsciAppConfiguration::getAttributeName(UmsciAppConfiguration::AttributeID::UPMIXLIVEMODE), -1))
            return false;
        if (juce::String("ERROR") == upmixConfigSectionElement->getStringAttribute(UmsciAppConfiguration::getAttributeName(UmsciAppConfiguration::AttributeID::UPMIXSHAPE), "ERROR"))
            return false;
 
        // positive validation outcome - continue
    }
    else
        return false;
 
    return true;
}
 
bool UmsciAppConfiguration::ResetToDefault()
{
    auto xmlConfig = juce::parseXML(juce::String(BinaryData::UmsciDefault_config, BinaryData::UmsciDefault_configSize));
    if (xmlConfig)
    {
 
        if (UmsciAppConfiguration::isValid(xmlConfig))
        {
 
            SetFlushAndUpdateDisabled();
            if (resetConfigState(std::move(xmlConfig)))
            {
                ResetFlushAndUpdateDisabled();
                return true;
            }
            else
            {
                jassertfalse; // stop here when debugging, since invalid configurations often lead to endless debugging sessions until this simple explanation was found...
                ResetFlushAndUpdateDisabled();
 
                // ...and trigger generation of a valid config if not.
                triggerConfigurationDump();
            }
        }
        else
        {
            jassertfalse; // stop here when debugging, since invalid configurations often lead to endless debugging sessions until this simple explanation was found...
 
            // ...and trigger generation of a valid config if not.
            triggerConfigurationDump();
        }
    }
    else
    {
        jassertfalse; // stop here when debugging, since invalid configurations often lead to endless debugging sessions until this simple explanation was found...
 
        // ...and trigger generation of a valid config if not.
        triggerConfigurationDump();
    }
 
    return false;
}
 
bool UmsciAppConfiguration::HandleConfigVersionConflict(const JUCEAppBasics::AppConfigurationBase::Version& configVersionFound)
{
    if (configVersionFound != JUCEAppBasics::AppConfigurationBase::Version::FromString(Umsci_CONFIG_VERSION))
    {
        auto conflictTitle = "Incompatible configuration version";
        auto conflictInfo = "The configuration file version detected\ncannot be handled by this version of " + juce::JUCEApplication::getInstance()->getApplicationName();
#ifdef DEBUG
        conflictInfo << "\n(Found " + configVersionFound.ToString() + ", expected " + Umsci_CONFIG_VERSION + ")";
#endif
        juce::AlertWindow::showOkCancelBox(juce::MessageBoxIconType::WarningIcon, conflictTitle, conflictInfo, "Reset to default", "Quit", nullptr, juce::ModalCallbackFunction::create([this](int result) {
            if (1 == result)
            {
                ResetToDefault();
            }
            else
            {
                juce::JUCEApplication::getInstance()->quit();
            }
        }));
 
        return false;
    }
    else
        return true;
}