qt-creator/src/tools/clangbackend/ipcsource/sourcelocation.h

/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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 http://www.qt.io/terms-conditions.  For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#ifndef CLANGBACKEND_SOURCELOCATION_H
#define CLANGBACKEND_SOURCELOCATION_H

#include <clang-c/Index.h>

#include <utf8string.h>

namespace ClangBackEnd {

class SourceLocationContainer;
class TranslationUnit;

class SourceLocation
{
    friend class Diagnostic;
    friend class SourceRange;
    friend class TranslationUnit;
    friend class Cursor;
    friend bool operator==(const SourceLocation &first, const SourceLocation &second);

public:
    SourceLocation();

    const Utf8String &filePath() const;
    uint line() const;
    uint column() const;
    uint offset() const;

    SourceLocationContainer toSourceLocationContainer() const;

private:
    SourceLocation(CXSourceLocation cxSourceLocation);
    SourceLocation(CXTranslationUnit cxTranslationUnit,
                   const Utf8String &filePath,
                   uint line,
                   uint column);

    operator CXSourceLocation() const;

private:
   CXSourceLocation cxSourceLocation;
   Utf8String filePath_;
   uint line_ = 0;
   uint column_ = 0;
   uint offset_ = 0;
};

bool operator==(const SourceLocation &first, const SourceLocation &second);

void PrintTo(const SourceLocation &sourceLocation, ::std::ostream* os);

} // namespace ClangBackEnd

#endif // CLANGBACKEND_SOURCELOCATION_H