Files
pilotclient/src/blackmisc/simulation/settings/simulatorsettings.cpp
Klaus Basan 50eb93cf40 Ref T229, do not display a directory if same as default
* component: made overlay compliant
* sim.dir can be empty on a machine where no simulator is installed
* formatting
* utility functions
2018-01-30 20:30:12 +01:00

466 lines
21 KiB
C++

/* Copyright (C) 2016
* swift project community / contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
#include "simulatorsettings.h"
#include "blackmisc/simulation/simulatedaircraft.h"
#include "blackmisc/simulation/fscommon/fscommonutil.h"
#include "blackmisc/simulation/xplane/xplaneutil.h"
#include "blackmisc/stringutils.h"
#include <QStringBuilder>
using namespace BlackMisc;
using namespace BlackMisc::PhysicalQuantities;
using namespace BlackMisc::Simulation::FsCommon;
using namespace BlackMisc::Simulation::XPlane;
namespace BlackMisc
{
namespace Simulation
{
namespace Settings
{
CSimulatorSettings::CSimulatorSettings()
{ }
void CSimulatorSettings::setSimulatorDirectory(const QString &simulatorDirectory)
{
m_simulatorDirectory = simulatorDirectory.trimmed();
}
const QString &CSimulatorSettings::getSimulatorDirectory() const
{
return m_simulatorDirectory;
}
bool CSimulatorSettings::hasSimulatorDirectory() const
{
return !getSimulatorDirectory().isEmpty();
}
void CSimulatorSettings::setModelDirectories(const QStringList &modelDirectories)
{
m_modelDirectories = modelDirectories;
}
void CSimulatorSettings::setModelDirectory(const QString &modelDirectory)
{
m_modelDirectories = QStringList({ modelDirectory });
}
const QStringList &CSimulatorSettings::getModelDirectories() const
{
return m_modelDirectories;
}
void CSimulatorSettings::setModelExcludeDirectories(const QStringList &excludeDirectories)
{
m_excludeDirectoryPatterns = excludeDirectories;
}
const QStringList &CSimulatorSettings::getModelExcludeDirectoryPatterns() const
{
return m_excludeDirectoryPatterns;
}
void CSimulatorSettings::resetPaths()
{
m_excludeDirectoryPatterns.clear();
m_modelDirectories.clear();
m_simulatorDirectory.clear();
}
QString CSimulatorSettings::convertToQString(bool i18n) const
{
return convertToQString(", ", i18n);
}
QString CSimulatorSettings::convertToQString(const QString &separator, bool i18n) const
{
Q_UNUSED(i18n);
return QStringLiteral("model directories: ") %
m_modelDirectories.join(',') %
separator %
QStringLiteral("exclude directories: ") %
m_excludeDirectoryPatterns.join(',');
}
CVariant CSimulatorSettings::propertyByIndex(const CPropertyIndex &index) const
{
if (index.isMyself()) { return CVariant::from(*this); }
const ColumnIndex i = index.frontCasted<ColumnIndex>();
switch (i)
{
case IndexSimulatorDirectory: return CVariant::fromValue(m_simulatorDirectory);
case IndexModelDirectory: return CVariant::fromValue(m_modelDirectories);
case IndexModelExcludeDirectoryPatterns: return CVariant::fromValue(m_excludeDirectoryPatterns);
default: return CValueObject::propertyByIndex(index);
}
}
void CSimulatorSettings::setPropertyByIndex(const CPropertyIndex &index, const CVariant &variant)
{
if (index.isMyself()) { (*this) = variant.to<CSimulatorSettings>(); return; }
const ColumnIndex i = index.frontCasted<ColumnIndex>();
switch (i)
{
case IndexSimulatorDirectory: this->setSimulatorDirectory(variant.toQString()); break;
case IndexModelDirectory: this->setSimulatorDirectory(variant.toQString()); break;
case IndexModelExcludeDirectoryPatterns: m_excludeDirectoryPatterns = variant.value<QStringList>(); break;
default: CValueObject::setPropertyByIndex(index, variant); break;
}
}
CMultiSimulatorSettings::CMultiSimulatorSettings(QObject *parent) : QObject(parent)
{
// void
}
CSimulatorSettings CMultiSimulatorSettings::getSettings(const CSimulatorInfo &simulator) const
{
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
switch (simulator.getSimulator())
{
case CSimulatorInfo::FS9: return m_simSettingsFs9.get();
case CSimulatorInfo::FSX: return m_simSettingsFsx.get();
case CSimulatorInfo::P3D: return m_simSettingsP3D.get();
case CSimulatorInfo::XPLANE: return m_simSettingsXP.get();
default:
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
break;
}
return CSimulatorSettings();
}
CStatusMessage CMultiSimulatorSettings::setSettings(const CSimulatorSettings &settings, const CSimulatorInfo &simulator)
{
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
switch (simulator.getSimulator())
{
case CSimulatorInfo::FS9: return m_simSettingsFs9.set(settings);
case CSimulatorInfo::FSX: return m_simSettingsFsx.set(settings);
case CSimulatorInfo::P3D: return m_simSettingsP3D.set(settings);
case CSimulatorInfo::XPLANE: return m_simSettingsXP.set(settings);
default:
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
break;
}
return CStatusMessage({ CLogCategory::settings() }, CStatusMessage::SeverityError, "wrong simulator");
}
CStatusMessage CMultiSimulatorSettings::setAndSaveSettings(const CSimulatorSettings &settings, const CSimulatorInfo &simulator)
{
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
switch (simulator.getSimulator())
{
case CSimulatorInfo::FS9: return m_simSettingsFs9.setAndSave(settings);
case CSimulatorInfo::FSX: return m_simSettingsFsx.setAndSave(settings);
case CSimulatorInfo::P3D: return m_simSettingsP3D.setAndSave(settings);
case CSimulatorInfo::XPLANE: return m_simSettingsXP.setAndSave(settings);
default:
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
break;
}
return CStatusMessage({ CLogCategory::settings() }, CStatusMessage::SeverityError, "wrong simulator");
}
CStatusMessage CMultiSimulatorSettings::saveSettings(const CSimulatorInfo &simulator)
{
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
switch (simulator.getSimulator())
{
case CSimulatorInfo::FS9: return m_simSettingsFs9.save();
case CSimulatorInfo::FSX: return m_simSettingsFsx.save();
case CSimulatorInfo::P3D: return m_simSettingsP3D.save();
case CSimulatorInfo::XPLANE: return m_simSettingsXP.save();
default:
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
break;
}
return CStatusMessage({ CLogCategory::settings() }, CStatusMessage::SeverityError, "wrong simulator");
}
QString CMultiSimulatorSettings::getSimulatorDirectoryIfNotDefault(const CSimulatorInfo &simulator) const
{
const CSimulatorSettings s = this->getSettings(simulator);
const QString dir = s.getSimulatorDirectory();
if (dir.isEmpty() || dir == CMultiSimulatorSettings::getDefaultSimulatorDirectory(simulator))
{
return QStringLiteral("");
}
return s.getSimulatorDirectory();
}
QString CMultiSimulatorSettings::getSimulatorDirectoryOrDefault(const CSimulatorInfo &simulator) const
{
const CSimulatorSettings s = this->getSettings(simulator);
if (s.getSimulatorDirectory().isEmpty())
{
return CMultiSimulatorSettings::getDefaultSimulatorDirectory(simulator);
}
return s.getSimulatorDirectory();
}
QStringList CMultiSimulatorSettings::getModelDirectoriesIfNotDefault(const CSimulatorInfo &simulator) const
{
const CSimulatorSettings s = this->getSettings(simulator);
const QStringList dirs = s.getModelDirectories();
if (dirs.isEmpty() || dirs == CMultiSimulatorSettings::getDefaultModelDirectories(simulator))
{
return QStringList();
}
return dirs;
}
QStringList CMultiSimulatorSettings::getModelDirectoriesOrDefault(const CSimulatorInfo &simulator) const
{
const CSimulatorSettings s = this->getSettings(simulator);
if (s.getModelDirectories().isEmpty())
{
return this->getDefaultModelDirectories(simulator);
}
return s.getModelDirectories();
}
QString CMultiSimulatorSettings::getFirstModelDirectoryOrDefault(const CSimulatorInfo &simulator) const
{
const QStringList models(getModelDirectoriesOrDefault(simulator));
if (models.isEmpty()) { return ""; }
return models.first();
}
QStringList CMultiSimulatorSettings::getDefaultModelDirectories(const CSimulatorInfo &simulator) const
{
static const QStringList e;
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
switch (simulator.getSimulator())
{
case CSimulatorInfo::FS9: return CFsCommonUtil::fs9AircraftDir().isEmpty() ? e : QStringList({ CFsCommonUtil::fs9AircraftDir() });
case CSimulatorInfo::FSX: return CFsCommonUtil::fsxSimObjectsDir().isEmpty() ? e : QStringList({ CFsCommonUtil::fsxSimObjectsDir() });
case CSimulatorInfo::P3D: return CFsCommonUtil::p3dSimObjectsDir().isEmpty() ? e : QStringList({ CFsCommonUtil::p3dSimObjectsDir()});
case CSimulatorInfo::XPLANE: return CXPlaneUtil::xplaneModelDirectories();
default:
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
break;
}
return QStringList();
}
QStringList CMultiSimulatorSettings::getModelExcludeDirectoryPatternsIfNotDefault(const CSimulatorInfo &simulator) const
{
const CSimulatorSettings s = this->getSettings(simulator);
const QStringList patterns = s.getModelExcludeDirectoryPatterns();
if (patterns.isEmpty() || patterns == CMultiSimulatorSettings::getDefaultModelExcludeDirectoryPatterns(simulator))
{
return QStringList();
}
return patterns;
}
QStringList CMultiSimulatorSettings::getModelExcludeDirectoryPatternsOrDefault(const CSimulatorInfo &simulator) const
{
const CSimulatorSettings s = this->getSettings(simulator);
QStringList exclude(s.getModelExcludeDirectoryPatterns());
if (!exclude.isEmpty()) { return exclude; }
exclude = this->getDefaultModelExcludeDirectoryPatterns(simulator);
return exclude;
}
QStringList CMultiSimulatorSettings::getDefaultModelExcludeDirectoryPatterns(const CSimulatorInfo &simulator) const
{
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
switch (simulator.getSimulator())
{
case CSimulatorInfo::FS9: return CFsCommonUtil::fs9AircraftObjectsExcludeDirectoryPatterns();
case CSimulatorInfo::FSX: return CFsCommonUtil::fsxSimObjectsExcludeDirectoryPatterns();
case CSimulatorInfo::P3D: return CFsCommonUtil::p3dSimObjectsExcludeDirectoryPatterns();
case CSimulatorInfo::XPLANE: return CXPlaneUtil::xplaneModelExcludeDirectoryPatterns();
default:
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
break;
}
return QStringList();
}
void CMultiSimulatorSettings::resetToDefaults(const CSimulatorInfo &simulator)
{
CSimulatorSettings s = this->getSettings(simulator);
s.resetPaths();
this->setAndSaveSettings(s, simulator);
}
QString CMultiSimulatorSettings::getDefaultSimulatorDirectory(const CSimulatorInfo &simulator)
{
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
switch (simulator.getSimulator())
{
case CSimulatorInfo::FS9: return CFsCommonUtil::fs9Dir();
case CSimulatorInfo::FSX: return CFsCommonUtil::fsxDir();
case CSimulatorInfo::P3D: return CFsCommonUtil::p3dDir();
case CSimulatorInfo::XPLANE: return CXPlaneUtil::xplaneRootDir(); //! check XPlane
default:
Q_ASSERT_X(simulator.isSingleSimulator(), Q_FUNC_INFO, "No single simulator");
break;
}
static const QString empty;
return empty;
}
CSimulatorMessagesSettings::CSimulatorMessagesSettings()
{
// void
}
void CSimulatorMessagesSettings::setTechnicalLogSeverity(CStatusMessage::StatusSeverity severity)
{
m_technicalLogLevel = static_cast<int>(severity);
}
void CSimulatorMessagesSettings::disableTechnicalMessages()
{
m_technicalLogLevel = -1;
}
bool CSimulatorMessagesSettings::isRelayedErrorsMessages() const
{
if (m_technicalLogLevel < 0) { return false; }
return (m_technicalLogLevel <= CStatusMessage::SeverityError);
}
bool CSimulatorMessagesSettings::isRelayedWarningMessages() const
{
if (m_technicalLogLevel < 0) { return false; }
return (m_technicalLogLevel <= CStatusMessage::SeverityWarning);
}
bool CSimulatorMessagesSettings::isRelayedInfoMessages() const
{
if (m_technicalLogLevel < 0) { return false; }
return (m_technicalLogLevel <= CStatusMessage::SeverityInfo);
}
bool CSimulatorMessagesSettings::isRelayedTechnicalMessages() const
{
return (m_technicalLogLevel >= 0);
}
void CSimulatorMessagesSettings::setRelayedTextMessages(CSimulatorMessagesSettings::TextMessageType messageType)
{
m_messageType = static_cast<int>(messageType);
}
bool CSimulatorMessagesSettings::isRelayedSupervisorTextMessages() const
{
return this->getRelayedTextMessageTypes().testFlag(TextMessageSupervisor);
}
bool CSimulatorMessagesSettings::isRelayedPrivateTextMessages() const
{
return this->getRelayedTextMessageTypes().testFlag(TextMessagePrivate);
}
bool CSimulatorMessagesSettings::isRelayedUnicomTextMessages() const
{
return this->getRelayedTextMessageTypes().testFlag(TextMessagesUnicom);
}
bool CSimulatorMessagesSettings::isRelayedCom1TextMessages() const
{
return this->getRelayedTextMessageTypes().testFlag(TextMessagesCom1);
}
bool CSimulatorMessagesSettings::isRelayedCom2TextMessages() const
{
return this->getRelayedTextMessageTypes().testFlag(TextMessagesCom2);
}
bool CSimulatorMessagesSettings::relayThisStatusMessage(const CStatusMessage &message) const
{
if (message.isEmpty()) { return false; }
if (!this->isGloballyEnabled()) { return false; }
if (!this->isRelayedTechnicalMessages()) { return false; }
int s = static_cast<int>(message.getSeverity());
return (s >= m_technicalLogLevel);
}
bool CSimulatorMessagesSettings::relayThisTextMessage(const Network::CTextMessage &msg, const BlackMisc::Simulation::CSimulatedAircraft &aircraft) const
{
if (msg.isEmpty()) { return false; }
if (!this->isGloballyEnabled()) { return false; }
if (m_messageType == NoTextMessages) { return false; }
const TextMessageType mt = static_cast<TextMessageType>(m_messageType);
if (msg.isPrivateMessage() && mt.testFlag(TextMessagePrivate)) { return true; }
if (msg.isSupervisorMessage() && (mt.testFlag(TextMessagePrivate) || mt.testFlag(TextMessageSupervisor))) { return true; }
if (msg.isSendToUnicom() && mt.testFlag(TextMessagesUnicom)) { return true; }
if (msg.isRadioMessage())
{
const CFrequency f(msg.getFrequency());
if (mt.testFlag(TextMessagesCom1))
{
if (aircraft.getCom1System().isActiveFrequencyWithin8_33kHzChannel(f)) { return true; }
}
if (mt.testFlag(TextMessagesCom2))
{
if (aircraft.getCom2System().isActiveFrequencyWithin8_33kHzChannel(f)) { return true; }
}
}
return false;
}
CSimulatorMessagesSettings::TextMessageType CSimulatorMessagesSettings::getRelayedTextMessageTypes() const
{
return static_cast<CSimulatorMessagesSettings::TextMessageType>(m_messageType);
}
QString CSimulatorMessagesSettings::convertToQString(bool i18n) const
{
Q_UNUSED(i18n);
static const QString s("Enabled %1, text messages: %2, severity: %3");
QString severity;
if (this->isRelayedTechnicalMessages())
{
severity = QStringLiteral("No tech. msgs");
}
else
{
severity = CStatusMessage::severityToString(static_cast<CStatusMessage::StatusSeverity>(m_technicalLogLevel));
}
return s.arg(boolToOnOff(m_globallyEnabled)).arg(m_messageType).arg(severity);
}
CVariant CSimulatorMessagesSettings::propertyByIndex(const CPropertyIndex &index) const
{
if (index.isMyself()) { return CVariant::from(*this); }
const ColumnIndex i = index.frontCasted<ColumnIndex>();
switch (i)
{
case IndexTechnicalLogSeverity: return CVariant::fromValue(m_technicalLogLevel);
case IndexTextMessageRelay: return CVariant::from(m_messageType);
case IndexGloballyEnabled: return CVariant::from(m_globallyEnabled);
default: return CValueObject::propertyByIndex(index);
}
}
void CSimulatorMessagesSettings::setPropertyByIndex(const CPropertyIndex &index, const CVariant &variant)
{
if (index.isMyself()) { (*this) = variant.to<CSimulatorMessagesSettings>(); return; }
const ColumnIndex i = index.frontCasted<ColumnIndex>();
switch (i)
{
case IndexTechnicalLogSeverity: this->setTechnicalLogSeverity(static_cast<CStatusMessage::StatusSeverity>(variant.toInt())); break;
case IndexTextMessageRelay: this->setRelayedTextMessages(static_cast<CSimulatorMessagesSettings::TextMessageType>(variant.toInt())); break;
case IndexGloballyEnabled: this->setGloballyEnabled(variant.toBool()); break;
default: CValueObject::setPropertyByIndex(index, variant); break;
}
}
} // ns
} // ns
} // ns