/****************************************************************************
**
** Copyright (C) 2016 Denis Mingulov
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#include "classviewsymbolinformation.h"

#include "classviewconstants.h"
#include "classviewutils.h"

#include <utils/utilsicons.h>

#include <QPair>
#include <QHash>

namespace ClassView {
namespace Internal {

/*!
    \class SymbolInformation
    \brief The SymbolInformation class provides the name, type, and icon for a
    single item in the Class View tree.
*/

SymbolInformation::SymbolInformation() :
    m_iconType(INT_MIN),
    m_hash(0)
{
}

SymbolInformation::SymbolInformation(const QString &valueName, const QString &valueType,
                                     int valueIconType)
    : m_iconType(valueIconType)
#if QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)
    , m_hash(qHashMulti(0, valueIconType, valueName, valueType))
#else
    , m_hash(qHash(qMakePair(valueIconType, qMakePair(valueName, valueType))))
#endif
    , m_name(valueName)
    , m_type(valueType)
{
}

/*!
    Returns an icon type sort order number. It is not pre-calculated, as it is
    needed for converting to standard item only.
*/

int SymbolInformation::iconTypeSortOrder() const
{
    namespace Icons = Utils::CodeModelIcon;
    constexpr int IconSortOrder[] = {
            Icons::Namespace,
            Icons::Enum,
            Icons::Class,
            Icons::FuncPublic,
            Icons::FuncProtected,
            Icons::FuncPrivate,
            Icons::FuncPublicStatic,
            Icons::FuncProtectedStatic,
            Icons::FuncPrivateStatic,
            Icons::Signal,
            Icons::SlotPublic,
            Icons::SlotProtected,
            Icons::SlotPrivate,
            Icons::VarPublic,
            Icons::VarProtected,
            Icons::VarPrivate,
            Icons::VarPublicStatic,
            Icons::VarProtectedStatic,
            Icons::VarPrivateStatic,
            Icons::Enumerator,
            Icons::Keyword,
            Icons::Macro,
            Icons::Unknown
    };

    static QHash<int, int> sortOrder;

    // TODO: Check if this static initialization is OK when SymbolInformation object are
    // instantiated in different threads.
    if (sortOrder.isEmpty()) {
        for (int i : IconSortOrder)
            sortOrder.insert(i, sortOrder.count());
    }

    // if it is missing - return the same value
    if (!sortOrder.contains(m_iconType))
        return m_iconType;

    return sortOrder[m_iconType];
}

bool SymbolInformation::operator<(const SymbolInformation &other) const
{
    // comparsion is not a critical for speed
    if (iconType() != other.iconType()) {
        int l = iconTypeSortOrder();
        int r = other.iconTypeSortOrder();
        if (l < r)
            return true;
        if (l > r)
            return false;
    }

    // The desired behavior here is to facilitate case insensitive
    // sorting without generating false case sensitive equalities.
    // Performance should be appropriate since in C++ there aren't
    // many symbols that differ by case only.

    int cmp = name().compare(other.name(), Qt::CaseInsensitive);
    if (cmp == 0)
        cmp = name().compare(other.name());
    if (cmp < 0)
        return true;
    if (cmp > 0)
        return false;
    return type().compare(other.type()) < 0;
}

} // namespace Internal
} // namespace ClassView