qcollator_macx.cpp

Go to the documentation of this file.

// Copyright (C) 2020 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:critical reason:data-parser
 
#include "qcollator_p.h"
#include "qlocale_p.h"
#include "qstringlist.h"
#include "qstring.h"
 
#include <QtCore/private/qcore_mac_p.h>
 
#include <CoreFoundation/CoreFoundation.h>
#include <CoreFoundation/CFLocale.h>
 
#include <cstring>
#include <QDebug>
 
QT_BEGIN_NAMESPACE
 
void QCollatorPrivate::init()
{
    cleanup();
    /*
      LocaleRefFromLocaleString() will accept "POSIX" as the locale name, but
      the locale it produces (named "pos") doesn't implement the [A-Z] < [a-z]
      behavior we expect of the C locale.  We can use QStringView to get round
      that for collation, but this leaves no way to do a sort key.
    */
    if (isC())
        return;
 
    LocaleRef localeRef;
    OSStatus status =
        LocaleRefFromLocaleString(QLocalePrivate::get(locale)->bcp47Name().constData(), &localeRef);
    if (status != 0)
        qCWarning(lcQCollator, "Couldn't initialize the locale (%d)", int(status));
 
    UInt32 collationOptions = 0;
    // enable normalization by default
    collationOptions |= kUCCollateComposeInsensitiveMask;
 
    if (options.testFlag(Opt::CaseInsensitive))
        collationOptions |= kUCCollateCaseInsensitiveMask;
    if (options.testFlag(Opt::NumericSort))
        collationOptions |= kUCCollateDigitsAsNumberMask | kUCCollateDigitsOverrideMask;
    if (!options.testFlag(Opt::IgnorePunctuation))
        collationOptions |= kUCCollatePunctuationSignificantMask;
    if (options.testFlag(Opt::DiacriticInsensitive))
        collationOptions |= kUCCollateDiacritInsensitiveMask;
    if (options.testFlag(Opt::WidthInsensitive))
        collationOptions |= kUCCollateWidthInsensitiveMask;
 
    status = UCCreateCollator(localeRef, 0, collationOptions, &collator);
    if (status != 0)
        qCWarning(lcQCollator, "Couldn't initialize the collator (%d)", int(status));
 
    dirty = false;
}
 
void QCollatorPrivate::cleanup()
{
    if (collator)
        UCDisposeCollator(&collator);
    collator = 0;
}
 
int QCollator::compare(QStringView s1, QStringView s2) const
{
    if (!s1.size())
        return s2.size() ? -1 : 0;
    if (!s2.size())
        return +1;
 
    if (!d)
        d = new QCollatorPrivate(QLocale().collation());
 
    d->ensureInitialized();
 
    if (!d->collator)
        return s1.compare(s2, caseSensitivity());
 
    SInt32 result;
    Boolean equivalent;
    UCCompareText(d->collator,
                  reinterpret_cast<const UniChar *>(s1.data()), s1.size(),
                  reinterpret_cast<const UniChar *>(s2.data()), s2.size(),
                  &equivalent,
                  &result);
    if (equivalent)
        return 0;
    return result < 0 ? -1 : 1;
}
 
QCollatorSortKey QCollator::sortKey(const QString &string) const
{
    if (!d)
        d = new QCollatorPrivate(QLocale().collation());
 
    d->ensureInitialized();
 
    QList<UCCollationValue> ret;
    if (!d->collator) {
        // What should (or even *can*) we do here ? (See init()'s comment.)
        qCWarning(lcQCollator, "QCollator doesn't support sort keys for the C locale on Darwin");
        return QCollatorPrivate::sortKeyFromData(std::move(ret));
    }
 
    auto text = reinterpret_cast<const UniChar *>(string.constData());
    // Documentation recommends having it 5 times as big as the input
    ret.resizeForOverwrite(string.size() * 5);
    ItemCount actualSize;
    int status = UCGetCollationKey(d->collator, text, string.size(),
                                   ret.size(), &actualSize, ret.data());
 
    ret.resize(actualSize + 1);
    if (status == kUCOutputBufferTooSmall) {
        status = UCGetCollationKey(d->collator, text, string.size(),
                                   ret.size(), &actualSize, ret.data());
        Q_ASSERT(status != kUCOutputBufferTooSmall);
        Q_ASSERT(ret.size() == qsizetype(actualSize + 1));
    }
    ret[actualSize] = 0;
    return QCollatorPrivate::sortKeyFromData(std::move(ret));
}
 
int QCollatorSortKey::compare(const QCollatorSortKey &key) const noexcept
{
    SInt32 order;
    UCCompareCollationKeys(d->m_key.data(), d->m_key.size(),
                           key.d->m_key.data(), key.d->m_key.size(),
                           nullptr, &order);
    return order;
}
 
QT_END_NAMESPACE