QtQml: Make QLocale an actual value type

We want to be accessible to qmllint and other QML tooling. To this end,
make all legal invocations of its methods properly typed invokables.
Keep two QQmlV4Function overloads to produce error messages if the
methods are called with the wrong parameters. We have to do this because
JavaScript is more liberal in its argument coercion than the methods
would like.

Un-deprecate QJSNumberCoercion::isInteger() since it's actually quite
practical here.

Pick-to: 6.7
Fixes: QTBUG-112366
Change-Id: I016e5edc47efaade44461c504c1b3e2b1b829b58
Reviewed-by: Oliver Eftevaag <oliver.eftevaag@qt.io>
Reviewed-by: Qt CI Bot <qt_ci_bot@qt-project.org>
Reviewed-by: Ulf Hermann <ulf.hermann@qt.io>
Reviewed-by: Fabian Kosmale <fabian.kosmale@qt.io>

1 files changed, 151 insertions, 60 deletions

diff --git a/src/qml/qml/qqmllocale_p.h b/src/qml/qml/qqmllocale_p.h
index b3700ef558..0fc9338015 100644
--- a/src/qml/qml/qqmllocale_p.h
+++ b/src/qml/qml/qqmllocale_p.h
@@ -75,81 +75,172 @@ namespace QQmlLocale
     Q_ENUM_NS(DayOfWeek)
 
     Q_QML_EXPORT QV4::ReturnedValue locale(QV4::ExecutionEngine *engine, const QString &localeName);
-    Q_QML_EXPORT QV4::ReturnedValue wrap(QV4::ExecutionEngine *engine, const QLocale &locale);
     Q_QML_EXPORT void registerStringLocaleCompare(QV4::ExecutionEngine *engine);
     Q_QML_EXPORT QV4::ReturnedValue method_localeCompare(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
 };
 
-namespace QV4 {
+struct DayOfWeekList
+{
+    Q_GADGET
+    QML_ANONYMOUS
+    QML_FOREIGN(QList<QQmlLocale::DayOfWeek>)
+    QML_SEQUENTIAL_CONTAINER(QQmlLocale::DayOfWeek)
+};
+
+class QQmlLocaleValueType
+{
+    QLocale locale;
+
+    Q_PROPERTY(QQmlLocale::DayOfWeek firstDayOfWeek READ firstDayOfWeek CONSTANT)
+    Q_PROPERTY(QLocale::MeasurementSystem measurementSystem READ measurementSystem CONSTANT)
+    Q_PROPERTY(Qt::LayoutDirection textDirection READ textDirection CONSTANT)
+    Q_PROPERTY(QList<QQmlLocale::DayOfWeek> weekDays READ weekDays CONSTANT)
+    Q_PROPERTY(QStringList uiLanguages READ uiLanguages CONSTANT)
+
+    Q_PROPERTY(QString name READ name CONSTANT)
+    Q_PROPERTY(QString nativeLanguageName READ nativeLanguageName CONSTANT)
+#if QT_DEPRECATED_SINCE(6, 6)
+    Q_PROPERTY(QString nativeCountryName READ nativeCountryName CONSTANT)
+#endif
+    Q_PROPERTY(QString nativeTerritoryName READ nativeTerritoryName CONSTANT)
+    Q_PROPERTY(QString decimalPoint READ decimalPoint CONSTANT)
+    Q_PROPERTY(QString groupSeparator READ groupSeparator CONSTANT)
+    Q_PROPERTY(QString percent READ percent CONSTANT)
+    Q_PROPERTY(QString zeroDigit READ zeroDigit CONSTANT)
+    Q_PROPERTY(QString negativeSign READ negativeSign CONSTANT)
+    Q_PROPERTY(QString positiveSign READ positiveSign CONSTANT)
+    Q_PROPERTY(QString exponential READ exponential CONSTANT)
+    Q_PROPERTY(QString amText READ amText CONSTANT)
+    Q_PROPERTY(QString pmText READ pmText CONSTANT)
+
+    Q_PROPERTY(QLocale::NumberOptions numberOptions READ numberOptions WRITE setNumberOptions)
+
+    Q_GADGET
+    QML_ANONYMOUS
+    QML_FOREIGN(QLocale)
+    QML_EXTENDED(QQmlLocaleValueType)
+    QML_CONSTRUCTIBLE_VALUE
+
+public:
+    Q_INVOKABLE QQmlLocaleValueType(const QString &name) : locale(name) {}
 
-namespace Heap {
+    Q_INVOKABLE QString currencySymbol(
+            QLocale::CurrencySymbolFormat format = QLocale::CurrencySymbol) const
+    {
+        return locale.currencySymbol(format);
+    }
 
-struct QQmlLocaleData : Object {
-    inline void init() { locale = new QLocale; }
-    void destroy() {
-        delete locale;
-        Object::destroy();
+    Q_INVOKABLE QString dateTimeFormat(QLocale::FormatType format = QLocale::LongFormat) const
+    {
+        return locale.dateTimeFormat(format);
     }
-    QLocale *locale;
-};
 
-}
+    Q_INVOKABLE QString timeFormat(QLocale::FormatType format = QLocale::LongFormat) const
+    {
+        return locale.timeFormat(format);
+    }
 
-struct QQmlLocaleData : public QV4::Object
-{
-    V4_OBJECT2(QQmlLocaleData, Object)
-    V4_NEEDS_DESTROY
-
-    static QLocale *getThisLocale(QV4::Scope &scope, const QV4::Value *thisObject) {
-        const QV4::Object *o = thisObject->as<Object>();
-        const QQmlLocaleData *data = o ? o->as<QQmlLocaleData>() : nullptr;
-        if (!data) {
-            scope.engine->throwTypeError();
-            return nullptr;
-        }
-        return data->d()->locale;
+    Q_INVOKABLE QString dateFormat(QLocale::FormatType format = QLocale::LongFormat) const
+    {
+        return locale.dateFormat(format);
+    }
+
+    Q_INVOKABLE QString monthName(int index, QLocale::FormatType format = QLocale::LongFormat) const
+    {
+        // +1 added to idx because JS is 0-based, whereas QLocale months begin at 1.
+        return locale.monthName(index + 1, format);
+    }
+
+    Q_INVOKABLE QString standaloneMonthName(
+            int index, QLocale::FormatType format = QLocale::LongFormat) const
+    {
+        // +1 added to idx because JS is 0-based, whereas QLocale months begin at 1.
+        return locale.standaloneMonthName(index + 1, format);
     }
 
-    static QV4::ReturnedValue method_currencySymbol(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_dateTimeFormat(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_timeFormat(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_dateFormat(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_monthName(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_standaloneMonthName(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_dayName(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_standaloneDayName(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_toString(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-
-    static QV4::ReturnedValue method_get_firstDayOfWeek(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_measurementSystem(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_textDirection(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_weekDays(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_uiLanguages(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-
-    static QV4::ReturnedValue method_get_name(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_nativeLanguageName(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
+    Q_INVOKABLE QString dayName(int index, QLocale::FormatType format = QLocale::LongFormat) const
+    {
+        // 0 -> 7 as Qt::Sunday is 7, but Sunday is 0 in JS Date
+        return locale.dayName(index == 0 ? 7 : index, format);
+    }
+
+    Q_INVOKABLE QString standaloneDayName(
+            int index, QLocale::FormatType format = QLocale::LongFormat) const
+    {
+        // 0 -> 7 as Qt::Sunday is 7, but Sunday is 0 in JS Date
+        return locale.standaloneDayName(index == 0 ? 7 : index, format);
+    }
+
+    Q_INVOKABLE void formattedDataSize(QQmlV4Function *args) const;
+    Q_INVOKABLE QString formattedDataSize(
+            double bytes, int precision = 2,
+            QLocale::DataSizeFormats format = QLocale::DataSizeIecFormat) const
+    {
+        return locale.formattedDataSize(
+                qint64(QV4::Value::toInteger(bytes)), precision, format);
+    }
+
+    Q_INVOKABLE void toString(QQmlV4Function *args) const;
+
+    // As a special (undocumented) case, when called with no arguments,
+    // just forward to QDebug. This makes it consistent with other types
+    // in JS that can be converted to a string via toString().
+    Q_INVOKABLE QString toString() const { return QDebug::toString(locale); }
+
+    Q_INVOKABLE QString toString(int i) const { return locale.toString(i); }
+    Q_INVOKABLE QString toString(double f) const
+    {
+        return QJSNumberCoercion::isInteger(f) ? toString(int(f)) : locale.toString(f);
+    }
+    Q_INVOKABLE QString toString(double f, const QString &format, int precision = 6) const
+    {
+        // Lacking a char type, we have to use QString here
+        return format.length() < 1
+                ? QString()
+                : locale.toString(f, format.at(0).toLatin1(), precision);
+    }
+    Q_INVOKABLE QString toString(const QDateTime &dateTime, const QString &format) const
+    {
+        return locale.toString(dateTime, format);
+    }
+    Q_INVOKABLE QString toString(
+            const QDateTime &dateTime, QLocale::FormatType format = QLocale::LongFormat) const
+    {
+        return locale.toString(dateTime, format);
+    }
+
+    QQmlLocale::DayOfWeek firstDayOfWeek() const;
+    QLocale::MeasurementSystem measurementSystem() const { return locale.measurementSystem(); }
+    Qt::LayoutDirection textDirection() const { return locale.textDirection(); }
+    QList<QQmlLocale::DayOfWeek> weekDays() const;
+    QStringList uiLanguages() const { return locale.uiLanguages(); }
+
+    QString name() const { return locale.name(); }
+    QString nativeLanguageName() const { return locale.nativeLanguageName(); }
 #if QT_DEPRECATED_SINCE(6, 6)
-    static QV4::ReturnedValue method_get_nativeCountryName(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
+    QString nativeCountryName() const
+    {
+        QT_IGNORE_DEPRECATIONS(return locale.nativeCountryName();)
+    }
 #endif
-    static QV4::ReturnedValue method_get_nativeTerritoryName(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_decimalPoint(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_groupSeparator(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_percent(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_zeroDigit(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_negativeSign(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_positiveSign(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_exponential(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_amText(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_get_pmText(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-
-    static QV4::ReturnedValue method_get_numberOptions(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-    static QV4::ReturnedValue method_set_numberOptions(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
-
-    static QV4::ReturnedValue method_get_formattedDataSize(const QV4::FunctionObject *, const QV4::Value *thisObject, const QV4::Value *argv, int argc);
+    QString nativeTerritoryName() const { return locale.nativeTerritoryName(); }
+    QString decimalPoint() const { return locale.decimalPoint(); }
+    QString groupSeparator() const { return locale.groupSeparator(); }
+    QString percent() const { return locale.percent(); }
+    QString zeroDigit() const { return locale.zeroDigit(); }
+    QString negativeSign() const { return locale.negativeSign(); }
+    QString positiveSign() const { return locale.positiveSign(); }
+    QString exponential() const { return locale.exponential(); }
+    QString amText() const { return locale.amText(); }
+    QString pmText() const { return locale.pmText(); }
+
+    QLocale::NumberOptions numberOptions() const { return locale.numberOptions(); }
+    void setNumberOptions(const QLocale::NumberOptions &numberOptions)
+    {
+        locale.setNumberOptions(numberOptions);
+    }
 };
 
-}
-
 QT_END_NAMESPACE
 
 #endif