qspinbox.cpp

Go to the documentation of this file.

// Copyright (C) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
 
#include <private/qabstractspinbox_p.h>
#include <qspinbox.h>
 
#include <qlineedit.h>
#include <qlocale.h>
#include <qvalidator.h>
#include <qdebug.h>
 
#include <algorithm>
#include <cmath>
#include <float.h>
 
QT_BEGIN_NAMESPACE
 
using namespace Qt::StringLiterals;
 
//#define QSPINBOX_QSBDEBUG
#ifdef QSPINBOX_QSBDEBUG
#  define QSBDEBUG qDebug
#else
#  define QSBDEBUG if (false) qDebug
#endif
 
class QSpinBoxPrivate : public QAbstractSpinBoxPrivate
{
    Q_DECLARE_PUBLIC(QSpinBox)
public:
    QSpinBoxPrivate();
    void emitSignals(EmitPolicy ep, const QVariant &) override;
 
    virtual QVariant valueFromText(const QString &n) const override;
    virtual QString textFromValue(const QVariant &n) const override;
    QVariant validateAndInterpret(QString &input, int &pos,
                                  QValidator::State &state) const;
 
    inline void init() {
        Q_Q(QSpinBox);
        q->setInputMethodHints(Qt::ImhDigitsOnly);
        setLayoutItemMargins(QStyle::SE_SpinBoxLayoutItem);
    }
 
    int displayIntegerBase;
 
    QVariant calculateAdaptiveDecimalStep(int steps) const override;
};
 
class QDoubleSpinBoxPrivate : public QAbstractSpinBoxPrivate
{
    Q_DECLARE_PUBLIC(QDoubleSpinBox)
public:
    QDoubleSpinBoxPrivate();
    void emitSignals(EmitPolicy ep, const QVariant &) override;
 
    virtual QVariant valueFromText(const QString &n) const override;
    virtual QString textFromValue(const QVariant &n) const override;
    QVariant validateAndInterpret(QString &input, int &pos,
                                  QValidator::State &state) const;
    double round(double input) const;
    // variables
    int decimals;
 
    inline void init() {
        Q_Q(QDoubleSpinBox);
        q->setInputMethodHints(Qt::ImhFormattedNumbersOnly);
    }
 
    // When fiddling with the decimals property, we may lose precision in these properties.
    double actualMin;
    double actualMax;
 
    QVariant calculateAdaptiveDecimalStep(int steps) const override;
};
 
 
QSpinBox::QSpinBox(QWidget *parent)
    : QAbstractSpinBox(*new QSpinBoxPrivate, parent)
{
    Q_D(QSpinBox);
    d->init();
}
 
QSpinBox::~QSpinBox() {}
 
int QSpinBox::value() const
{
    Q_D(const QSpinBox);
    return d->value.toInt();
}
 
void QSpinBox::setValue(int value)
{
    Q_D(QSpinBox);
    d->setValue(QVariant(value), EmitIfChanged);
}
 
QString QSpinBox::prefix() const
{
    Q_D(const QSpinBox);
    return d->prefix;
}
 
void QSpinBox::setPrefix(const QString &prefix)
{
    Q_D(QSpinBox);
 
    d->prefix = prefix;
    d->updateEdit();
 
    d->cachedSizeHint = QSize();
    d->cachedMinimumSizeHint = QSize(); // minimumSizeHint cares about the prefix
    updateGeometry();
}
 
QString QSpinBox::suffix() const
{
    Q_D(const QSpinBox);
 
    return d->suffix;
}
 
void QSpinBox::setSuffix(const QString &suffix)
{
    Q_D(QSpinBox);
 
    d->suffix = suffix;
    d->updateEdit();
 
    d->cachedSizeHint = QSize();
    updateGeometry();
}
 
QString QSpinBox::cleanText() const
{
    Q_D(const QSpinBox);
 
    return d->stripped(d->edit->displayText());
}
 
 
int QSpinBox::singleStep() const
{
    Q_D(const QSpinBox);
 
    return d->singleStep.toInt();
}
 
void QSpinBox::setSingleStep(int value)
{
    Q_D(QSpinBox);
    if (value >= 0) {
        d->singleStep = QVariant(value);
        d->updateEdit();
    }
}
 
int QSpinBox::minimum() const
{
    Q_D(const QSpinBox);
 
    return d->minimum.toInt();
}
 
void QSpinBox::setMinimum(int minimum)
{
    Q_D(QSpinBox);
    const QVariant m(minimum);
    d->setRange(m, (QSpinBoxPrivate::variantCompare(d->maximum, m) > 0 ? d->maximum : m));
}
 
int QSpinBox::maximum() const
{
    Q_D(const QSpinBox);
 
    return d->maximum.toInt();
}
 
void QSpinBox::setMaximum(int maximum)
{
    Q_D(QSpinBox);
    const QVariant m(maximum);
    d->setRange((QSpinBoxPrivate::variantCompare(d->minimum, m) < 0 ? d->minimum : m), m);
}
 
void QSpinBox::setRange(int minimum, int maximum)
{
    Q_D(QSpinBox);
    d->setRange(QVariant(minimum), QVariant(maximum));
}
 
void QSpinBox::setStepType(QAbstractSpinBox::StepType stepType)
{
    Q_D(QSpinBox);
    d->stepType = stepType;
}
 
QAbstractSpinBox::StepType QSpinBox::stepType() const
{
    Q_D(const QSpinBox);
    return d->stepType;
}
 
int QSpinBox::displayIntegerBase() const
{
    Q_D(const QSpinBox);
    return d->displayIntegerBase;
}
 
void QSpinBox::setDisplayIntegerBase(int base)
{
    Q_D(QSpinBox);
    // Falls back to base 10 on invalid bases (like QString)
    if (Q_UNLIKELY(base < 2 || base > 36)) {
        qWarning("QSpinBox::setDisplayIntegerBase: Invalid base (%d)", base);
        base = 10;
    }
 
    if (base != d->displayIntegerBase) {
        d->displayIntegerBase = base;
        d->updateEdit();
    }
}
 
QString QSpinBox::textFromValue(int value) const
{
    Q_D(const QSpinBox);
    QString str;
 
    if (d->displayIntegerBase != 10) {
        const auto prefix = value < 0 ? "-"_L1 : ""_L1;
        str = prefix + QString::number(qAbs(value), d->displayIntegerBase);
    } else {
        str = locale().toString(value);
        if (!d->showGroupSeparator && (qAbs(value) >= 1000 || value == INT_MIN)) {
            str.remove(locale().groupSeparator());
        }
    }
 
    return str;
}
 
int QSpinBox::valueFromText(const QString &text) const
{
    Q_D(const QSpinBox);
 
    QString copy = text;
    int pos = d->edit->cursorPosition();
    QValidator::State state = QValidator::Acceptable;
    return d->validateAndInterpret(copy, pos, state).toInt();
}
 
QValidator::State QSpinBox::validate(QString &text, int &pos) const
{
    Q_D(const QSpinBox);
 
    QValidator::State state;
    d->validateAndInterpret(text, pos, state);
    return state;
}
 
 
void QSpinBox::fixup(QString &input) const
{
    if (!isGroupSeparatorShown())
        input.remove(locale().groupSeparator());
}
 
 
// --- QDoubleSpinBox ---
 
QDoubleSpinBox::QDoubleSpinBox(QWidget *parent)
    : QAbstractSpinBox(*new QDoubleSpinBoxPrivate, parent)
{
    Q_D(QDoubleSpinBox);
    d->init();
}
 
QDoubleSpinBox::~QDoubleSpinBox() {}
 
double QDoubleSpinBox::value() const
{
    Q_D(const QDoubleSpinBox);
 
    return d->value.toDouble();
}
 
void QDoubleSpinBox::setValue(double value)
{
    Q_D(QDoubleSpinBox);
    QVariant v(d->round(value));
    d->setValue(v, EmitIfChanged);
}
QString QDoubleSpinBox::prefix() const
{
    Q_D(const QDoubleSpinBox);
 
    return d->prefix;
}
 
void QDoubleSpinBox::setPrefix(const QString &prefix)
{
    Q_D(QDoubleSpinBox);
 
    d->prefix = prefix;
    d->updateEdit();
 
    d->cachedSizeHint = QSize();
    d->cachedMinimumSizeHint = QSize(); // minimumSizeHint cares about the prefix
    updateGeometry();
}
 
QString QDoubleSpinBox::suffix() const
{
    Q_D(const QDoubleSpinBox);
 
    return d->suffix;
}
 
void QDoubleSpinBox::setSuffix(const QString &suffix)
{
    Q_D(QDoubleSpinBox);
 
    d->suffix = suffix;
    d->updateEdit();
 
    d->cachedSizeHint = QSize();
    updateGeometry();
}
 
QString QDoubleSpinBox::cleanText() const
{
    Q_D(const QDoubleSpinBox);
 
    return d->stripped(d->edit->displayText());
}
 
double QDoubleSpinBox::singleStep() const
{
    Q_D(const QDoubleSpinBox);
 
    return d->singleStep.toDouble();
}
 
void QDoubleSpinBox::setSingleStep(double value)
{
    Q_D(QDoubleSpinBox);
 
    if (value >= 0) {
        d->singleStep = value;
        d->updateEdit();
    }
}
 
double QDoubleSpinBox::minimum() const
{
    Q_D(const QDoubleSpinBox);
 
    return d->minimum.toDouble();
}
 
void QDoubleSpinBox::setMinimum(double minimum)
{
    Q_D(QDoubleSpinBox);
    d->actualMin = minimum;
    const QVariant m(d->round(minimum));
    d->setRange(m, (QDoubleSpinBoxPrivate::variantCompare(d->maximum, m) > 0 ? d->maximum : m));
}
 
double QDoubleSpinBox::maximum() const
{
    Q_D(const QDoubleSpinBox);
 
    return d->maximum.toDouble();
}
 
void QDoubleSpinBox::setMaximum(double maximum)
{
    Q_D(QDoubleSpinBox);
    d->actualMax = maximum;
    const QVariant m(d->round(maximum));
    d->setRange((QDoubleSpinBoxPrivate::variantCompare(d->minimum, m) < 0 ? d->minimum : m), m);
}
 
void QDoubleSpinBox::setRange(double minimum, double maximum)
{
    Q_D(QDoubleSpinBox);
    d->actualMin = minimum;
    d->actualMax = maximum;
    d->setRange(QVariant(d->round(minimum)), QVariant(d->round(maximum)));
}
 
void QDoubleSpinBox::setStepType(StepType stepType)
{
    Q_D(QDoubleSpinBox);
    d->stepType = stepType;
}
 
QAbstractSpinBox::StepType QDoubleSpinBox::stepType() const
{
    Q_D(const QDoubleSpinBox);
    return d->stepType;
}
 
int QDoubleSpinBox::decimals() const
{
    Q_D(const QDoubleSpinBox);
 
    return d->decimals;
}
 
void QDoubleSpinBox::setDecimals(int decimals)
{
    Q_D(QDoubleSpinBox);
    d->decimals = qBound(0, decimals, DBL_MAX_10_EXP + DBL_DIG);
 
    setRange(d->actualMin, d->actualMax); // make sure values are rounded
    setValue(value());
}
 
QString QDoubleSpinBox::textFromValue(double value) const
{
    Q_D(const QDoubleSpinBox);
    QString str = locale().toString(value, 'f', d->decimals);
    if (!d->showGroupSeparator && qAbs(value) >= 1000.0)
        str.remove(locale().groupSeparator());
 
    return str;
}
 
double QDoubleSpinBox::valueFromText(const QString &text) const
{
    Q_D(const QDoubleSpinBox);
 
    QString copy = text;
    int pos = d->edit->cursorPosition();
    QValidator::State state = QValidator::Acceptable;
    return d->validateAndInterpret(copy, pos, state).toDouble();
}
 
QValidator::State QDoubleSpinBox::validate(QString &text, int &pos) const
{
    Q_D(const QDoubleSpinBox);
 
    QValidator::State state;
    d->validateAndInterpret(text, pos, state);
    return state;
}
 
 
void QDoubleSpinBox::fixup(QString &input) const
{
    input.remove(locale().groupSeparator());
}
 
// --- QSpinBoxPrivate ---
 
QSpinBoxPrivate::QSpinBoxPrivate()
{
    minimum = QVariant((int)0);
    maximum = QVariant((int)99);
    value = minimum;
    displayIntegerBase = 10;
    singleStep = QVariant((int)1);
    type = QMetaType::Int;
}
 
void QSpinBoxPrivate::emitSignals(EmitPolicy ep, const QVariant &old)
{
    Q_Q(QSpinBox);
    if (ep != NeverEmit) {
        pendingEmit = false;
        if (ep == AlwaysEmit || value != old) {
            emit q->textChanged(edit->displayText());
            emit q->valueChanged(value.toInt());
        }
    }
}
 
QString QSpinBoxPrivate::textFromValue(const QVariant &value) const
{
    Q_Q(const QSpinBox);
    return q->textFromValue(value.toInt());
}
QVariant QSpinBoxPrivate::valueFromText(const QString &text) const
{
    Q_Q(const QSpinBox);
 
    return QVariant(q->valueFromText(text));
}
 
 
QVariant QSpinBoxPrivate::validateAndInterpret(QString &input, int &pos,
                                               QValidator::State &state) const
{
    if (cachedText == input && !input.isEmpty()) {
        state = cachedState;
        QSBDEBUG() << "cachedText was '" << cachedText << "' state was "
                   << state << " and value was " << cachedValue;
 
        return cachedValue;
    }
    const int max = maximum.toInt();
    const int min = minimum.toInt();
 
    QString copy = stripped(input, &pos);
    QSBDEBUG() << "input" << input << "copy" << copy;
    state = QValidator::Acceptable;
    int num = min;
 
    if (max != min && (copy.isEmpty()
                       || (min < 0 && copy == "-"_L1)
                       || (max >= 0 && copy == "+"_L1))) {
        state = QValidator::Intermediate;
        QSBDEBUG() << __FILE__ << __LINE__<< "num is set to" << num;
    } else if (copy.startsWith(u'-') && min >= 0) {
        state = QValidator::Invalid; // special-case -0 will be interpreted as 0 and thus not be invalid with a range from 0-100
    } else {
        bool ok = false;
        if (displayIntegerBase != 10) {
            num = copy.toInt(&ok, displayIntegerBase);
        } else {
            num = locale.toInt(copy, &ok);
            if (!ok && (max >= 1000 || min <= -1000)) {
                const QString sep(locale.groupSeparator());
                const QString doubleSep = sep + sep;
                if (copy.contains(sep) && !copy.contains(doubleSep)) {
                    QString copy2 = copy;
                    copy2.remove(sep);
                    num = locale.toInt(copy2, &ok);
                }
            }
        }
        QSBDEBUG() << __FILE__ << __LINE__<< "num is set to" << num;
        if (!ok) {
            state = QValidator::Invalid;
        } else if (num >= min && num <= max) {
            state = QValidator::Acceptable;
        } else if (max == min) {
            state = QValidator::Invalid;
        } else {
            if ((num >= 0 && num > max) || (num < 0 && num < min)) {
                state = QValidator::Invalid;
                QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
            } else {
                state = QValidator::Intermediate;
                QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Intermediate";
            }
        }
    }
    if (state != QValidator::Acceptable)
        num = max > 0 ? min : max;
    input = prefix + copy + suffix;
    cachedText = input;
    cachedState = state;
    cachedValue = QVariant((int)num);
 
    QSBDEBUG() << "cachedText is set to '" << cachedText << "' state is set to "
               << state << " and value is set to " << cachedValue;
    return cachedValue;
}
 
QVariant QSpinBoxPrivate::calculateAdaptiveDecimalStep(int steps) const
{
    const int intValue = value.toInt();
    const int absValue = qAbs(intValue);
 
    if (absValue < 100)
        return 1;
 
    const bool valueNegative = intValue < 0;
    const bool stepsNegative = steps < 0;
    const int signCompensation = (valueNegative == stepsNegative) ? 0 : 1;
 
    const int log = static_cast<int>(std::log10(absValue - signCompensation)) - 1;
    return static_cast<int>(std::pow(10, log));
}
 
// --- QDoubleSpinBoxPrivate ---
 
QDoubleSpinBoxPrivate::QDoubleSpinBoxPrivate()
{
    actualMin = 0.0;
    actualMax = 99.99;
    minimum = QVariant(actualMin);
    maximum = QVariant(actualMax);
    value = minimum;
    singleStep = QVariant(1.0);
    decimals = 2;
    type = QMetaType::Double;
}
 
void QDoubleSpinBoxPrivate::emitSignals(EmitPolicy ep, const QVariant &old)
{
    Q_Q(QDoubleSpinBox);
    if (ep != NeverEmit) {
        pendingEmit = false;
        if (ep == AlwaysEmit || value != old) {
            emit q->textChanged(edit->displayText());
            emit q->valueChanged(value.toDouble());
        }
    }
}
 
 
QVariant QDoubleSpinBoxPrivate::valueFromText(const QString &f) const
{
    Q_Q(const QDoubleSpinBox);
    return QVariant(q->valueFromText(f));
}
 
double QDoubleSpinBoxPrivate::round(double value) const
{
    return QString::number(value, 'f', decimals).toDouble();
}
 
 
QVariant QDoubleSpinBoxPrivate::validateAndInterpret(QString &input, int &pos,
                                                     QValidator::State &state) const
{
    if (cachedText == input && !input.isEmpty()) {
        state = cachedState;
        QSBDEBUG() << "cachedText was '" << cachedText << "' state was "
                   << state << " and value was " << cachedValue;
        return cachedValue;
    }
    const double max = maximum.toDouble();
    const double min = minimum.toDouble();
 
    QString copy = stripped(input, &pos);
    QSBDEBUG() << "input" << input << "copy" << copy;
    int len = copy.size();
    double num = min;
    const bool plus = max >= 0;
    const bool minus = min <= 0;
 
    const QString group(locale.groupSeparator());
    const uint groupUcs = (group.isEmpty() ? 0 :
                           (group.size() > 1 && group.at(0).isHighSurrogate()
                            ? QChar::surrogateToUcs4(group.at(0), group.at(1))
                            : group.at(0).unicode()));
    switch (len) {
    case 0:
        state = max != min ? QValidator::Intermediate : QValidator::Invalid;
        goto end;
    case 1:
        if (copy.at(0) == locale.decimalPoint()
            || (plus && copy.at(0) == u'+')
            || (minus && copy.at(0) == u'-')) {
            state = QValidator::Intermediate;
            goto end;
        }
        break;
    case 2:
        if (copy.at(1) == locale.decimalPoint()
            && ((plus && copy.at(0) == u'+') || (minus && copy.at(0) == u'-'))) {
            state = QValidator::Intermediate;
            goto end;
        }
        break;
    default: break;
    }
 
    if (groupUcs && copy.startsWith(group)) {
        QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
        state = QValidator::Invalid;
        goto end;
    } else if (len > 1) {
        const int dec = copy.indexOf(locale.decimalPoint());
        if (dec != -1) {
            if (dec + 1 < copy.size() && copy.at(dec + 1) == locale.decimalPoint() && pos == dec + 1) {
                copy.remove(dec + 1, 1); // typing a delimiter when you are on the delimiter
            } // should be treated as typing right arrow
 
            if (copy.size() - dec > decimals + 1) {
                QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
                state = QValidator::Invalid;
                goto end;
            }
            for (int i = dec + 1; i < copy.size(); ++i) {
                if (copy.at(i).isSpace()
                    || (groupUcs && QStringView{copy}.sliced(i).startsWith(group))) {
                    QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
                    state = QValidator::Invalid;
                    goto end;
                }
            }
        } else {
            const QChar last = copy.back();
            const bool groupEnd = groupUcs && copy.endsWith(group);
            const QStringView head(copy.constData(), groupEnd ? len - group.size() : len - 1);
            const QChar secondLast = head.back();
            if ((groupEnd || last.isSpace())
                && ((groupUcs && head.endsWith(group)) || secondLast.isSpace())) {
                state = QValidator::Invalid;
                QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
                goto end;
            } else if (last.isSpace() && (!QChar::isSpace(groupUcs) || secondLast.isSpace())) {
                state = QValidator::Invalid;
                QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
                goto end;
            }
        }
    }
 
    {
        bool ok = false;
        num = locale.toDouble(copy, &ok);
        QSBDEBUG() << __FILE__ << __LINE__ << locale << copy << num << ok;
 
        if (!ok) {
            if (QChar::isPrint(groupUcs)) {
                if (max < 1000 && min > -1000 && groupUcs && copy.contains(group)) {
                    state = QValidator::Invalid;
                    QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
                    goto end;
                }
 
                const int len = copy.size();
                for (int i = 0; i < len - 1;) {
                    if (groupUcs && QStringView{copy}.sliced(i).startsWith(group)) {
                        if (QStringView(copy).mid(i + group.size()).startsWith(group)) {
                            QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
                            state = QValidator::Invalid;
                            goto end;
                        }
                        i += group.size();
                    } else {
                        i++;
                    }
                }
 
                QString copy2 = copy;
                if (groupUcs)
                    copy2.remove(group);
                num = locale.toDouble(copy2, &ok);
                QSBDEBUG() << group << num << copy2 << ok;
 
                if (!ok) {
                    state = QValidator::Invalid;
                    QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
                    goto end;
                }
            }
        }
 
        if (!ok) {
            state = QValidator::Invalid;
            QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
        } else if (num >= min && num <= max) {
            state = QValidator::Acceptable;
            QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Acceptable";
        } else if (max == min) { // when max and min is the same the only non-Invalid input is max (or min)
            state = QValidator::Invalid;
            QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
        } else {
            if ((num >= 0 && num > max) || (num < 0 && num < min)) {
                state = QValidator::Invalid;
                QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Invalid";
            } else {
                state = QValidator::Intermediate;
                QSBDEBUG() << __FILE__ << __LINE__<< "state is set to Intermediate";
            }
        }
    }
 
end:
    if (state != QValidator::Acceptable) {
        num = max > 0 ? min : max;
    }
 
    input = prefix + copy + suffix;
    cachedText = input;
    cachedState = state;
    cachedValue = QVariant(num);
    return QVariant(num);
}
 
/*
    \internal
    \reimp
*/
 
QString QDoubleSpinBoxPrivate::textFromValue(const QVariant &f) const
{
    Q_Q(const QDoubleSpinBox);
    return q->textFromValue(f.toDouble());
}
 
QVariant QDoubleSpinBoxPrivate::calculateAdaptiveDecimalStep(int steps) const
{
    const double doubleValue = value.toDouble();
    const double minStep = std::pow(10, -decimals);
    double absValue = qAbs(doubleValue);
 
    if (absValue < minStep)
        return minStep;
 
    const bool valueNegative = doubleValue < 0;
    const bool stepsNegative = steps < 0;
    if (valueNegative != stepsNegative)
        absValue /= 1.01;
 
    const double shift = std::pow(10, 1 - std::floor(std::log10(absValue)));
    const double absRounded = round(absValue * shift) / shift;
    const double log = floorf(std::log10(absRounded)) - 1;
 
    return std::max(minStep, std::pow(10, log));
}
 
bool QSpinBox::event(QEvent *event)
{
    Q_D(QSpinBox);
    if (event->type() == QEvent::StyleChange
#ifdef Q_OS_MAC
            || event->type() == QEvent::MacSizeChange
#endif
            )
        d->setLayoutItemMargins(QStyle::SE_SpinBoxLayoutItem);
    return QAbstractSpinBox::event(event);
}
 
QT_END_NAMESPACE
 
#include "moc_qspinbox.cpp"