SourceLocation.h

Go to the documentation of this file.

/*$!{
* Aurora Clang AST Viewer (ACAV)
* 
* Copyright (c) 2026 Min Liu
* Copyright (c) 2026 Michael David Adams
* 
* SPDX-License-Identifier: GPL-2.0-or-later
* 
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* 
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
* GNU General Public License for more details.
* 
* You should have received a copy of the GNU General Public License along
* with this program; if not, see <https://www.gnu.org/licenses/>.
}$!*/

#pragma once
 
#include "common/FileManager.h"
 
// Forward declarations for Clang types
namespace clang {
class SourceLocation;
class SourceManager;
class SourceRange;
} // namespace clang
 
namespace acav {

class SourceLocation {
public:
  SourceLocation() = delete;
  SourceLocation(FileID fileId, unsigned line, unsigned column);
 
  FileID fileID() const { return fileId_; }
  unsigned line() const { return line_; }
  unsigned column() const { return column_; }
  bool isValid() const { return fileId_ != FileManager::InvalidFileID; }

  static SourceLocation fromClang(const clang::SourceLocation &loc,
                                   const clang::SourceManager &sm,
                                   FileManager &fileMgr);

  static void resetCache();
 
private:
  FileID fileId_ = 0;  // File identifier (0 = invalid)
  unsigned line_;      // 1-based line number
  unsigned column_;    // 1-based column number
};

class SourceRange {
public:
  SourceRange() = delete;
  SourceRange(SourceLocation begin, SourceLocation end);
 
  SourceLocation begin() const { return begin_; }
  SourceLocation end() const { return end_; }

  static SourceRange fromClang(const clang::SourceRange &range,
                                const clang::SourceManager &sm,
                                FileManager &fileMgr);

  static void resetCache();
 
private:
  SourceLocation begin_;
  SourceLocation end_;
};
 
} // namespace acav