ClangUtils.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 <clang/Basic/Diagnostic.h>
#include <functional>
#include <memory>
#include <string>
#include <vector>
 
// Forward declarations
namespace clang {
class ASTUnit;
class DiagnosticsEngine;
} // namespace clang
 
namespace acav {
 
struct DiagnosticMessage {
  clang::DiagnosticsEngine::Level level = clang::DiagnosticsEngine::Note;
  std::string message;
  std::string file;
  unsigned line = 0;
  unsigned column = 0;
};
 
using DiagnosticCallback = std::function<void(const DiagnosticMessage &)>;

std::string getClangResourceDir(const std::string &overrideResourceDir = "");

std::vector<std::string>
buildToolchainAdjustedCommandLine(const std::vector<std::string> &commandLine,
                                  const std::string &clangResourceDir,
                                  std::string &diagnostic);

std::unique_ptr<clang::ASTUnit>
createAstFromCDB(const std::string &compilationDatabase,
                 const std::string &sourcePath, std::string &errorMessage,
                 const DiagnosticCallback &diagnosticCallback = nullptr,
                 const std::string &clangResourceDirOverride = "");

bool saveAst(clang::ASTUnit &astUnit, const std::string &outputPath,
             std::string &errorMessage);

std::unique_ptr<clang::ASTUnit>
loadAstFromFile(const std::string &astFilePath, std::string &errorMessage,
                const std::string &compilationDbPath = "",
                const std::string &sourcePath = "",
                const DiagnosticCallback &diagnosticCallback = nullptr);

std::vector<std::string>
getSourceFilesFromCompilationDatabase(const std::string &compDbPath,
                                      std::string &errorMessage);
 
} // namespace acav