qt-creator/src/plugins/cpptools/usages.h

/****************************************************************************
**
** Copyright (C) 2016 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 <utils/smallstringview.h>

#include <QString>

#include <vector>
#include <functional>

namespace CppTools {

class Usage
{
public:
    Usage() = default;
    Usage(Utils::SmallStringView path, int line, int column)
        : path(QString::fromUtf8(path.data(), int(path.size()))),
          line(line),
          column(column)
    {}

    friend bool operator==(const Usage &first, const Usage &second)
    {
        return first.line == second.line
            && first.column == second.column
            && first.path == second.path;
    }

    friend bool operator<(const Usage &first, const Usage &second)
    {
        return std::tie(first.path, first.line, first.column)
               < std::tie(second.path, second.line, second.column);
    }

public:
    QString path;
    int line = 0;
    int column = 0;
};

using Usages = std::vector<Usage>;
using UsagesCallback = std::function<void(const Usages &usages)>;

} // namespace CppTools