/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** 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.
**
****************************************************************************/

#pragma once

#include <stringcachefwd.h>

#include <clangsupport_global.h>

#include <utils/smallstring.h>
#include <utils/sizedarray.h>

#include <limits>
#include <unordered_map>
#include <iosfwd>

namespace ClangBackEnd {

using SymbolIndex = long long;

class SymbolEntry
{
public:
    SymbolEntry(Utils::PathString &&usr,
                Utils::SmallString &&symbolName,
                SymbolKind symbolKind,
                SymbolTags symbolTags={})
        : usr(std::move(usr)),
          symbolName(std::move(symbolName)),
          symbolKind(symbolKind),
          symbolTags(symbolTags)
    {}

    Utils::PathString usr;
    Utils::SmallString symbolName;
    SymbolKind symbolKind;
    SymbolTags symbolTags;

    friend bool operator==(const SymbolEntry &first, const SymbolEntry &second)
    {
        return first.usr == second.usr
            && first.symbolName == second.symbolName
            && first.symbolKind == second.symbolKind;
    }
};

using SymbolEntries = std::unordered_map<SymbolIndex, SymbolEntry>;

} // namespace ClangBackEnd