Fact.cc

Go to the documentation of this file.

#include <cmath>
#include <cstdio>
#include <cstdlib>
#include <cstring>
#include <limits>
 
#include "Fact.h"
#include "FactValueSliderListModel.h"
#include "AppMessages.h"
#include "QGCApplication.h"
#include "QGCCorePlugin.h"
#include "QGCLoggingCategory.h"
#include "SettingsManager.h"
 
QGC_LOGGING_CATEGORY(FactLog, "FactSystem.Fact")
 
Fact::Fact(QObject *parent)
    : QObject(parent)
{
    // qCDebug(FactLog) << Q_FUNC_INFO << this;
 
    FactMetaData *const metaData = new FactMetaData(_type, this);
    setMetaData(metaData);
 
    _init();
}
 
Fact::Fact(int componentId, const QString &name, FactMetaData::ValueType_t type, QObject *parent)
    : QObject(parent)
    , _name(name)
    , _componentId(componentId)
    , _type(type)
{
    // qCDebug(FactLog) << Q_FUNC_INFO << this;
 
    FactMetaData *const metaData = new FactMetaData(_type, this);
    setMetaData(metaData);
 
    _init();
}
 
Fact::Fact(const QString& settingsGroup, FactMetaData *metaData, QObject *parent)
    : QObject(parent)
    , _name(metaData->name())
    , _componentId(0)
    , _type(metaData->type())
{
    // qCDebug(FactLog) << Q_FUNC_INFO << this;
 
    bool visible = true;
    SettingsManager::adjustSettingMetaData(settingsGroup, *metaData, visible);
    setMetaData(metaData, true /* setDefaultFromMetaData */);
 
    if (!QGC::runningUnitTests()) {
        if (metaData->defaultValueAvailable() && !visible) {
            // If setting is not visible, we force to default value
            const QVariant defaultValue = metaData->rawDefaultValue();
            QMutexLocker<QRecursiveMutex> locker(&_rawValueMutex);
            _rawValue = defaultValue;
        }
    }
 
    _init();
}
 
Fact::Fact(const Fact &other, QObject *parent)
    : QObject(parent)
{
    // qCDebug(FactLog) << Q_FUNC_INFO << this;
 
    *this = other;
 
    _init();
}
 
Fact::~Fact()
{
    // qCDebug(FactLog) << Q_FUNC_INFO << this;
}
 
void Fact::_init()
{
    (void) connect(this, &Fact::containerRawValueChanged, this, &Fact::_checkForRebootMessaging);
}
 
const Fact &Fact::operator=(const Fact& other)
{
    if (this == &other) {
        return *this;
    }
 
    QMutexLocker<QRecursiveMutex> otherLocker(&other._rawValueMutex);
    QMutexLocker<QRecursiveMutex> locker(&_rawValueMutex);
 
    _name = other._name;
    _componentId = other._componentId;
    _rawValue = other._rawValue;
    _type = other._type;
    _sendValueChangedSignals = other._sendValueChangedSignals;
    _deferredValueChangeSignal = other._deferredValueChangeSignal;
    _valueSliderModel = nullptr;
    if (_metaData && other._metaData) {
        *_metaData = *other._metaData;
    } else {
        _metaData = nullptr;
    }
 
    return *this;
}
 
void Fact::forceSetRawValue(const QVariant &value)
{
    if (_metaData) {
        QVariant typedValue;
        QString errorString;
 
        if (_metaData->convertAndValidateRaw(value, true /* convertOnly */, typedValue, errorString)) {
            {
                QMutexLocker<QRecursiveMutex> locker(&_rawValueMutex);
                _rawValue = typedValue;
            }
 
            const QVariant cooked = _metaData->rawTranslator()(typedValue);
            _sendValueChangedSignal(cooked);
            //-- Must be in this order
            emit containerRawValueChanged(typedValue);
            emit rawValueChanged(typedValue);
        }
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
    }
}
 
void Fact::setRawValue(const QVariant &value)
{
    if (_metaData) {
        QVariant typedValue;
        QString errorString;
 
        if (_metaData->convertAndValidateRaw(value, true /* convertOnly */, typedValue, errorString)) {
            bool changed = false;
            {
                QMutexLocker<QRecursiveMutex> locker(&_rawValueMutex);
                if (typedValue != _rawValue) {
                    _rawValue = typedValue;
                    changed = true;
                }
            }
 
            if (changed) {
                const QVariant cooked = _metaData->rawTranslator()(typedValue);
                _sendValueChangedSignal(cooked);
                //-- Must be in this order
                emit containerRawValueChanged(typedValue);
                emit rawValueChanged(typedValue);
            }
        }
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
    }
}
 
void Fact::setCookedValue(const QVariant& value)
{
    if (_metaData) {
        setRawValue(_metaData->cookedTranslator()(value));
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
    }
}
 
int Fact::valueIndex(const QString &value) const
{
    if (_metaData) {
        return _metaData->enumStrings().indexOf(value);
    }
    qCWarning(FactLog) << kMissingMetadata << name();
    return -1;
}
 
void Fact::setEnumStringValue(const QString &value)
{
    const int index = valueIndex(value);
    if (index != -1) {
        setCookedValue(_metaData->enumValues()[index]);
    }
}
 
void Fact::setEnumIndex(int index)
{
    if (_metaData) {
        setCookedValue(_metaData->enumValues()[index]);
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
    }
}
 
void Fact::containerSetRawValue(const QVariant &value)
{
    QVariant cooked;
    QVariant currentRaw = value;
    bool changed = false;
    {
        QMutexLocker<QRecursiveMutex> locker(&_rawValueMutex);
        if (_rawValue != value) {
            _rawValue = value;
            changed = true;
        }
        currentRaw = _rawValue;
        if (_metaData) {
            cooked = _metaData->rawTranslator()(_rawValue);
        } else {
            cooked = _rawValue;
        }
    }
 
    if (changed) {
        _sendValueChangedSignal(cooked);
        emit rawValueChanged(currentRaw);
    }
 
    // This always need to be signalled in order to support forceSetRawValue usage and waiting for vehicleUpdated signal
    emit vehicleUpdated(currentRaw);
}
 
QVariant Fact::cookedValue() const
{
    QMutexLocker<QRecursiveMutex> locker(&_rawValueMutex);
    if (_metaData) {
        return _metaData->rawTranslator()(_rawValue);
    }
 
    qCWarning(FactLog) << kMissingMetadata << name();
    return _rawValue;
}
 
QVariant Fact::rawToCooked(const QVariant &rawValue) const
{
    if (_metaData) {
        return _metaData->rawTranslator()(rawValue);
    }
 
    qCWarning(FactLog) << kMissingMetadata << name();
    return rawValue;
}
 
QString Fact::enumStringValue()
{
    if (_metaData) {
        const int enumIndex = this->enumIndex();
        if ((enumIndex >= 0) && (enumIndex < _metaData->enumStrings().count())) {
            return _metaData->enumStrings()[enumIndex];
        }
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
    }
 
    return QString();
}
 
int Fact::enumIndex()
{
    if (_metaData) {
        //-- Only enums have an index
        if (!_metaData->enumValues().isEmpty()) {
            int index = 0;
            for (const QVariant &enumValue: _metaData->enumValues()) {
                if (enumValue == rawValue()) {
                    return index;
                }
                //-- Float comparisons don't always work
                if ((type() == FactMetaData::valueTypeFloat) || (type() == FactMetaData::valueTypeDouble)) {
                    const double diff = fabs(enumValue.toDouble() - rawValue().toDouble());
                    static constexpr double accuracy = 1.0 / 1000000.0;
                    if (diff < accuracy) {
                        return index;
                    }
                }
                index++;
            }
            // Current value is not in list, add it manually. Defer the signal since this can
            // be called from within a QML binding read and a synchronous emit causes binding loops.
            _metaData->addEnumInfo(tr("Unknown: %1").arg(rawValue().toString()), rawValue());
            QMetaObject::invokeMethod(this, &Fact::enumsChanged, Qt::QueuedConnection);
            return index;
        }
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
    }
    return -1;
}
 
QStringList Fact::enumStrings() const
{
    if (_metaData) {
        return _metaData->enumStrings();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QStringList();
    }
}
 
QVariantList Fact::enumValues() const
{
    if (_metaData) {
        return _metaData->enumValues();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QVariantList();
    }
}
 
void Fact::setEnumInfo(const QStringList &strings, const QVariantList &values)
{
    if (_metaData) {
        _metaData->setEnumInfo(strings, values);
        emit enumsChanged();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
    }
}
 
QStringList Fact::bitmaskStrings() const
{
    if (_metaData) {
        return _metaData->bitmaskStrings();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QStringList();
    }
}
 
QVariantList Fact::bitmaskValues() const
{
    if (_metaData) {
        return _metaData->bitmaskValues();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QVariantList();
    }
}
 
QStringList Fact::selectedBitmaskStrings() const
{
    if (_metaData) {
        const auto values = _metaData->bitmaskValues();
        const auto strings = _metaData->bitmaskStrings();
        if (values.size() != strings.size()) {
            qCWarning(FactLog) << "Size of bitmask value and string is different."  << name();
            return {};
        }
 
        QStringList selected;
        for (qsizetype i = 0; i < values.size(); i++) {
            if (rawValue().toInt() & values[i].toInt()) {
                selected += strings[i];
            }
        }
 
        if (selected.isEmpty()) {
            selected += "Not value selected";
        }
 
        return selected;
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return {};
    }
}
 
QString Fact::_variantToString(const QVariant &variant, int decimalPlaces) const
{
    QString valueString;
 
    const auto stripNegativeZero = [](QString &candidate) {
        static const QRegularExpression reNegativeZero(QStringLiteral("^-0\\.0+$"));
        const auto match = reNegativeZero.match(candidate);
        if (match.hasMatch() || candidate == QStringLiteral("-0")) {
            candidate = candidate.mid(1);
        }
    };
 
    switch (type()) {
    case FactMetaData::valueTypeFloat:
    {
        const float fValue = variant.toFloat();
        if (qIsNaN(fValue)) {
            valueString = invalidValueString(decimalPlaces);
        } else {
            valueString = QStringLiteral("%1").arg(fValue, 0, 'f', decimalPlaces);
            stripNegativeZero(valueString);
        }
    }
        break;
    case FactMetaData::valueTypeDouble:
    {
        const double dValue = variant.toDouble();
        if (qIsNaN(dValue)) {
            valueString = invalidValueString(decimalPlaces);
        } else {
            valueString = QStringLiteral("%1").arg(dValue, 0, 'f', decimalPlaces);
            stripNegativeZero(valueString);
        }
        break;
    }
    case FactMetaData::valueTypeBool:
        valueString = variant.toBool() ? tr("true") : tr("false");
        break;
    case FactMetaData::valueTypeElapsedTimeInSeconds:
    {
        const double dValue = variant.toDouble();
        if (qIsNaN(dValue)) {
            valueString = invalidValueString(decimalPlaces);
        } else {
            QTime time(0, 0, 0, 0);
            time = time.addSecs(dValue);
            valueString = time.toString(QStringLiteral("hh:mm:ss"));
        }
        break;
    }
    default:
        valueString = variant.toString();
        break;
    }
 
    return valueString;
}
 
QString Fact::invalidValueString(int decimalPlaces) const {
    switch (type()) {
    case FactMetaData::valueTypeFloat:
    case FactMetaData::valueTypeDouble:
        if (decimalPlaces <= 0) {
            return QStringLiteral("–");
        }
        return QStringLiteral("–.") +
               QString(decimalPlaces, QChar(u'–'));
    case FactMetaData::valueTypeElapsedTimeInSeconds:
        return QStringLiteral("––:––:––");
    default:
        return QStringLiteral("–");
    }
}
 
QString Fact::rawValueStringFullPrecision() const
{
    if (type() == FactMetaData::valueTypeFloat) {
        const float fValue = rawValue().toFloat();
        if (std::isnan(fValue)) {
            return invalidValueString(0);
        }
        // Find the shortest decimal string that round-trips back to the same float bits.
        // snprintf with "%.*g" formats to p significant digits; strtof checks the round-trip.
        // TODO: replace with std::to_chars once macOS min target >= 13.3
        char buf[32];
        for (int p = 1; p <= std::numeric_limits<float>::max_digits10; ++p) {
            std::snprintf(buf, sizeof(buf), "%.*g", p, static_cast<double>(fValue));
            if (std::strtof(buf, nullptr) == fValue) {
                break;
            }
        }
        if (std::strcmp(buf, "-0") == 0) {
            buf[0] = '0';
            buf[1] = '\0';
        }
        return QString::fromLatin1(buf);
    } else if (type() == FactMetaData::valueTypeDouble) {
        const double dValue = rawValue().toDouble();
        if (std::isnan(dValue)) {
            return invalidValueString(0);
        }
        // TODO: replace with std::to_chars once macOS min target >= 13.3
        QString result = QString::number(dValue, 'g', QLocale::FloatingPointShortest);
        if (result == QStringLiteral("-0")) {
            result = QStringLiteral("0");
        }
        return result;
    } else {
        return _variantToString(rawValue(), 0);
    }
}
 
QString Fact::rawValueString() const
{
    return _variantToString(rawValue(), decimalPlaces());
}
 
QString Fact::cookedValueString() const
{
    return _variantToString(cookedValue(), decimalPlaces());
}
 
QVariant Fact::rawDefaultValue() const
{
    if (_metaData) {
        if (!_metaData->defaultValueAvailable()) {
            qCDebug(FactLog) << "Access to unavailable default value";
        }
        return _metaData->rawDefaultValue();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QVariant(0);
    }
}
 
QVariant Fact::cookedDefaultValue() const
{
    if (_metaData) {
        if (!_metaData->defaultValueAvailable()) {
            qCDebug(FactLog) << "Access to unavailable default value";
        }
        return _metaData->cookedDefaultValue();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QVariant(0);
    }
}
 
QString Fact::cookedDefaultValueString() const
{
    return _variantToString(cookedDefaultValue(), decimalPlaces());
}
 
QString Fact::shortDescription() const
{
    if (_metaData) {
        return _metaData->shortDescription();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QString();
    }
}
 
QString Fact::label() const
{
    if (_metaData) {
        // Fall back for older metadata which is missing a label
        if (!_metaData->label().isEmpty()) {
            return _metaData->label();
        }
        if (!_metaData->shortDescription().isEmpty()) {
            return _metaData->shortDescription();
        }
        return name();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QString();
    }
}
 
QString Fact::longDescription() const
{
    if (_metaData) {
        return _metaData->longDescription();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QString();
    }
}
 
QString Fact::rawUnits() const
{
    if (_metaData) {
        return _metaData->rawUnits();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QString();
    }
}
 
QString Fact::cookedUnits() const
{
    if (_metaData) {
        return _metaData->cookedUnits();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QString();
    }
}
 
QVariant Fact::rawMin() const
{
    if (_metaData) {
        return _metaData->rawMin();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QVariant(0);
    }
}
 
QVariant Fact::cookedMin() const
{
    if (_metaData) {
        return _metaData->cookedMin();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QVariant(0);
    }
}
 
QVariant Fact::rawUserMin() const
{
    if (_metaData) {
        return _metaData->rawUserMin();
    }
 
    qCWarning(FactLog) << kMissingMetadata << name();
    return QVariant(0);
}
 
QVariant Fact::cookedUserMin() const
{
    if (_metaData) {
        return _metaData->cookedUserMin();
    }
 
    qCWarning(FactLog) << kMissingMetadata << name();
    return QVariant(0);
}
 
QString Fact::cookedMinString() const
{
    return _variantToString(cookedMin(), decimalPlaces());
}
 
QString Fact::cookedUserMinString() const
{
    return _variantToString(cookedUserMin(), decimalPlaces());
}
 
QVariant Fact::rawMax() const
{
    if (_metaData) {
        return _metaData->rawMax();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QVariant(0);
    }
}
 
QVariant Fact::cookedMax() const
{
    if (_metaData) {
        return _metaData->cookedMax();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QVariant(0);
    }
}
 
QVariant Fact::rawUserMax() const
{
    if (_metaData) {
        return _metaData->rawUserMax();
    }
 
    qCWarning(FactLog) << kMissingMetadata << name();
    return QVariant(0);
}
 
QVariant Fact::cookedUserMax() const
{
    if (_metaData) {
        return _metaData->cookedUserMax();
    }
 
    qCWarning(FactLog) << kMissingMetadata << name();
    return QVariant(0);
}
 
QString Fact::cookedMaxString() const
{
    return _variantToString(cookedMax(), decimalPlaces());
}
 
QString Fact::cookedUserMaxString() const
{
    return _variantToString(cookedUserMax(), decimalPlaces());
}
 
bool Fact::minIsDefaultForType() const
{
    if (_metaData) {
        return _metaData->minIsDefaultForType();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return false;
    }
}
 
bool Fact::maxIsDefaultForType() const
{
    if (_metaData) {
        return _metaData->maxIsDefaultForType();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return false;
    }
}
 
int Fact::decimalPlaces() const
{
    if (_metaData) {
        return _metaData->decimalPlaces();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return FactMetaData::kDefaultDecimalPlaces;
    }
}
 
int Fact::maxStringLength() const
{
    if (_metaData) {
        return _metaData->maxStringLength();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return 0;
    }
}
 
QString Fact::category() const
{
    if (_metaData) {
        return _metaData->category();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QString();
    }
}
 
QString Fact::group() const
{
    if (_metaData) {
        return _metaData->group();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QString();
    }
}
 
void Fact::setMetaData(FactMetaData *metaData, bool setDefaultFromMetaData)
{
    _metaData = metaData;
    if (setDefaultFromMetaData && metaData->defaultValueAvailable()) {
        setRawValue(rawDefaultValue());
    }
    emit valueChanged(cookedValue());
}
 
bool Fact::valueEqualsDefault() const
{
    if (_metaData) {
        if (_metaData->defaultValueAvailable()) {
            return _metaData->rawDefaultValue() == rawValue();
        } else {
            return false;
        }
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return false;
    }
}
 
bool Fact::defaultValueAvailable() const
{
    if (_metaData) {
        return _metaData->defaultValueAvailable();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return false;
    }
}
 
QString Fact::validate(const QString &cookedValue, bool convertOnly)
{
    if (_metaData) {
        QVariant typedValue;
        QString errorString;
 
        _metaData->convertAndValidateCooked(cookedValue, convertOnly, typedValue, errorString);
 
        return errorString;
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return QStringLiteral("Internal error: Meta data pointer missing");
    }
}
 
QVariant Fact::clamp(const QString &cookedValue)
{
    if (_metaData) {
        QVariant typedValue;
        if (_metaData->clampValue(cookedValue, typedValue)) {
            return typedValue;
        } else {
            //-- If conversion failed, return current value
            return rawValue();
        }
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
    }
    return QVariant();
}
 
bool Fact::vehicleRebootRequired() const
{
    if (_metaData) {
        return _metaData->vehicleRebootRequired();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return false;
    }
}
 
bool Fact::qgcRebootRequired() const
{
    if (_metaData) {
        return _metaData->qgcRebootRequired();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return false;
    }
}
 
void Fact::setSendValueChangedSignals(bool sendValueChangedSignals)
{
    if (sendValueChangedSignals != _sendValueChangedSignals) {
        _sendValueChangedSignals = sendValueChangedSignals;
        emit sendValueChangedSignalsChanged(_sendValueChangedSignals);
    }
}
 
void Fact::_sendValueChangedSignal(const QVariant &value)
{
    if (_sendValueChangedSignals) {
        emit valueChanged(value);
        _deferredValueChangeSignal = false;
    } else {
        _deferredValueChangeSignal = true;
    }
}
 
void Fact::sendDeferredValueChangedSignal()
{
    if (_deferredValueChangeSignal) {
        _deferredValueChangeSignal = false;
        emit valueChanged(cookedValue());
    }
}
 
QString Fact::enumOrValueString()
{
    if (_metaData) {
        if (_metaData->enumStrings().count()) {
            return enumStringValue();
        } else {
            return cookedValueString();
        }
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
    }
    return QString();
}
 
double Fact::rawIncrement() const
{
    if (_metaData) {
        return _metaData->rawIncrement();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
    }
    return std::numeric_limits<double>::quiet_NaN();
}
 
double Fact::cookedIncrement() const
{
    if (_metaData) {
        return _metaData->cookedIncrement();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
    }
    return std::numeric_limits<double>::quiet_NaN();
}
 
bool Fact::hasControl() const
{
    if (_metaData) {
        return _metaData->hasControl();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return false;
    }
}
 
bool Fact::readOnly() const
{
    if (_metaData) {
        return _metaData->readOnly();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return false;
    }
}
 
bool Fact::writeOnly() const
{
    if (_metaData) {
        return _metaData->writeOnly();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return false;
    }
}
 
bool Fact::volatileValue() const
{
    if (_metaData) {
        return _metaData->volatileValue();
    } else {
        qCWarning(FactLog) << kMissingMetadata << name();
        return false;
    }
}
 
FactValueSliderListModel *Fact::valueSliderModel()
{
    if (!_valueSliderModel) {
        _valueSliderModel = new FactValueSliderListModel(*this);
    }
 
    return _valueSliderModel;
}
 
void Fact::_checkForRebootMessaging()
{
    if (qgcApp()) {
        // showAppMessage() logs during unit tests (and additionally shows the real
        // dialog in UI test mode), so tests assert this messaging via expectAppMessage()
        if (vehicleRebootRequired()) {
            QGC::showRebootVehicleMessage(tr("Reboot vehicle for changes to take effect."));
        } else if (qgcRebootRequired()) {
            QGC::showRebootAppMessage(tr("Restart application for changes to take effect."));
        }
    }
}