qt-creator/src/tools/clangbackend/source/sourcerange.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 "sourcelocation.h"

namespace ClangBackEnd {

class SourceRangeContainer;

class SourceRange
{
    friend class Diagnostic;
    friend class FixIt;
    friend class Cursor;
    friend bool operator==(const SourceRange &first, const SourceRange &second);
    friend std::ostream &operator<<(std::ostream &os, const SourceRange &sourceRange);

public:
    SourceRange();
    SourceRange(CXTranslationUnit cxTranslationUnit, CXSourceRange cxSourceRange);
    SourceRange(const SourceLocation &start, const SourceLocation &end);

    bool isNull() const;
    bool isValid() const;

    SourceLocation start() const;
    SourceLocation end() const;

    bool contains(int line, int column) const;

    SourceRangeContainer toSourceRangeContainer() const;

    operator CXSourceRange() const;
    operator SourceRangeContainer() const;

    CXTranslationUnit tu() const { return cxTranslationUnit; }

private:
    CXSourceRange cxSourceRange;
    CXTranslationUnit cxTranslationUnit = nullptr;
};

} // namespace ClangBackEnd