qcollator.h - mozsearch

Enable keyboard shortcuts

// Copyright (C) 2020 The Qt Company Ltd.

// Copyright (C) 2013 Aleix Pol Gonzalez <aleixpol@kde.org>

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only

// Qt-Security score:significant reason:trivial-impl-only

#ifndef QCOLLATOR_H

#define QCOLLATOR_H

#include <QtCore/qstring.h>

#include <QtCore/qstringlist.h>

#include <QtCore/qlocale.h>

QT_BEGIN_NAMESPACE

class QCollatorPrivate;

class QCollatorSortKeyPrivate;

QT_DECLARE_QESDP_SPECIALIZATION_DTOR(QCollatorSortKeyPrivate)

class Q_CORE_EXPORT QCollatorSortKey

    friend class QCollatorPrivate;

public:

    QCollatorSortKey() = delete;

    QCollatorSortKey(const QCollatorSortKey &other);

    QCollatorSortKey(QCollatorSortKey &&other) noexcept = default;

    ~QCollatorSortKey();

    QCollatorSortKey &operator=(const QCollatorSortKey &other);

    QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QCollatorSortKey)

    void swap(QCollatorSortKey &other) noexcept

    { d.swap(other.d); }

    int compare(const QCollatorSortKey &key) const noexcept;

protected:

    QCollatorSortKey(QCollatorSortKeyPrivate*);

    QExplicitlySharedDataPointer<QCollatorSortKeyPrivate> d;

private:

    friend bool comparesEqual(const QCollatorSortKey &lhs, const QCollatorSortKey &rhs) noexcept

    { return lhs.compare(rhs) == 0; }

    friend Qt::weak_ordering

    compareThreeWay(const QCollatorSortKey &lhs, const QCollatorSortKey &rhs) noexcept

    { return Qt::compareThreeWay(lhs.compare(rhs), 0); }

    Q_DECLARE_WEAKLY_ORDERED(QCollatorSortKey)

};

class Q_CORE_EXPORT QCollator

public:

    enum class CollationOption {

        CaseInsensitive = 0x1,

        IgnorePunctuation = 0x2,

        NumericSort = 0x4,

        DiacriticInsensitive = 0x8,

        WidthInsensitive = 0x10,

};

    Q_DECLARE_FLAGS(CollationOptions, CollationOption)

    QCollator();

    explicit QCollator(const QLocale &locale);

    QCollator(const QCollator &);

    ~QCollator();

    QCollator &operator=(const QCollator &);

    QCollator(QCollator &&other) noexcept

        : d(other.d) { other.d = nullptr; }

    QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_MOVE_AND_SWAP(QCollator)

    void swap(QCollator &other) noexcept

    { qt_ptr_swap(d, other.d); }

    void setLocale(const QLocale &locale);

    QLocale locale() const;

    Qt::CaseSensitivity caseSensitivity() const;

    void setCaseSensitivity(Qt::CaseSensitivity cs);

    void setNumericMode(bool on);

    bool numericMode() const;

    void setIgnorePunctuation(bool on);

    bool ignorePunctuation() const;

    void setOptions(CollationOptions options);

    CollationOptions options() const;

    int compare(const QString &s1, const QString &s2) const

    { return compare(QStringView(s1), QStringView(s2)); }

#if QT_CORE_REMOVED_SINCE(6, 4) && QT_POINTER_SIZE != 4

    int compare(const QChar *s1, int len1, const QChar *s2, int len2) const

    { return compare(QStringView(s1, len1), QStringView(s2, len2)); }

#endif

    int compare(const QChar *s1, qsizetype len1, const QChar *s2, qsizetype len2) const

    { return compare(QStringView(s1, len1), QStringView(s2, len2)); }

    bool operator()(const QString &s1, const QString &s2) const

    { return compare(s1, s2) < 0; }

    int compare(QStringView s1, QStringView s2) const;

    bool operator()(QStringView s1, QStringView s2) const

    { return compare(s1, s2) < 0; }

    QCollatorSortKey sortKey(const QString &string) const;

    static int defaultCompare(QStringView s1, QStringView s2);

    static QCollatorSortKey defaultSortKey(QStringView key);

private:

    friend Q_CORE_EXPORT bool comparesEqual(const QCollator &lhs, const QCollator &rhs) noexcept;

    Q_DECLARE_EQUALITY_COMPARABLE(QCollator)

    mutable QCollatorPrivate *d;

    void detach();

};

Q_DECLARE_SHARED(QCollatorSortKey)

Q_DECLARE_SHARED(QCollator)

Q_DECLARE_OPERATORS_FOR_FLAGS(QCollator::CollationOptions)

QT_END_NAMESPACE

#endif // QCOLLATOR_P_H