Instantiator.cpp

Go to the documentation of this file.

#include <filesystem>
#include <fstream>
#include <iostream>
#include <system_error>
#include <unordered_set>
 
#include "fmt/color.h"
#include "fmt/ranges.h"
#include "fmt/std.h"
#include "spdlog/cfg/env.h"
#include "spdlog/spdlog.h"
 
#include "clang/AST/ASTImporter.h"
#include "clang/ASTMatchers/ASTMatchFinder.h"
#include "clang/ASTMatchers/ASTMatchers.h"
#include "clang/Rewrite/Core/Rewriter.h"
#include "clang/Tooling/CommonOptionsParser.h"
#include "clang/Tooling/Tooling.h"
#include "llvm/Support/CommandLine.h"
 
#include "ASTCreation.hpp"
#include "Callbacks/DeleteInstantiations.hpp"
#include "Callbacks/GetNeededInstantiations.hpp"
#include "Callbacks/InjectInstantiation.hpp"
#include "IO/ProgressBar.hpp"
#include "Injection.hpp"
#include "Matcher/Matcher.hpp"
 
//
// Command line options
//
static llvm::cl::OptionCategory InstantiatorOptions("Instantiator options");
 
static llvm::cl::opt<bool> Invasive("invasive",
                                    llvm::cl::desc("Inject instantiations invasively. (Directly after function definition.)"),
                                    llvm::cl::cat(InstantiatorOptions));
 
static llvm::cl::opt<bool> Progress("progress", llvm::cl::desc("Print out a progress bar."), llvm::cl::cat(InstantiatorOptions));
 
static llvm::cl::opt<bool> Clean("clean", llvm::cl::desc("Delete all explicit instantiations."), llvm::cl::cat(InstantiatorOptions));
static llvm::cl::list<std::string> excludePatterns(
    "exclude-namespace",
    llvm::cl::desc("List of namespaces which should be excluded. Several namespaces can be added by multiple --exclude-namespace calls."),
    llvm::cl::value_desc("namespace"),
    llvm::cl::cat(InstantiatorOptions));
static llvm::cl::alias excludePatternA("e", llvm::cl::desc("Alias for --exclude-namespace"), llvm::cl::aliasopt(excludePatterns));
 
static llvm::cl::list<std::string> includePatterns(
    "include-namespace",
    llvm::cl::desc("List of namespaces which should be included. Several namespaces can be added by multiple --include-namespace calls."),
    llvm::cl::value_desc("namespace"),
    llvm::cl::cat(InstantiatorOptions));
static llvm::cl::alias includePatternA("i", llvm::cl::desc("Alias for --include-namespace"), llvm::cl::aliasopt(includePatterns));
 
static llvm::cl::extrahelp CommonHelp(clang::tooling::CommonOptionsParser::HelpMessage);
 
int main(int argc, const char** argv)
{
    spdlog::cfg::load_env_levels();
 
    auto ExpectedParser = clang::tooling::CommonOptionsParser::create(argc, argv, InstantiatorOptions, llvm::cl::OneOrMore);
    if(!ExpectedParser) {
        // Fail gracefully for unsupported options.
        llvm::errs() << ExpectedParser.takeError();
        return 1;
    }
    clang::tooling::CommonOptionsParser& OptionsParser = ExpectedParser.get();
 
    if(excludePatterns.size() == 0) { excludePatterns.push_back("std"); }
    if(includePatterns.size() == 0) { includePatterns.push_back(".*"); }
    auto excludedNameMatcher = clang::ast_matchers::matchesName("^::" + excludePatterns[0] + "::.*$");
    for(auto it = excludePatterns.begin() + 1; it != excludePatterns.end(); it++) {
        excludedNameMatcher = clang::ast_matchers::anyOf(excludedNameMatcher, clang::ast_matchers::matchesName("^::" + *it + "::.*$"));
    }
    auto includedNameMatcher = clang::ast_matchers::matchesName("^::" + includePatterns[0] + "::.*$");
    for(auto it = includePatterns.begin() + 1; it != includePatterns.end(); it++) {
        includedNameMatcher = clang::ast_matchers::anyOf(includedNameMatcher, clang::ast_matchers::matchesName("^::" + *it + "::.*$"));
    }
 
    clang::ast_matchers::DeclarationMatcher TemplateInstantiationMatcher = TemplInstWithoutDef(excludedNameMatcher, includedNameMatcher);
 
    clang::ast_matchers::DeclarationMatcher FunctionDefMatcher = FuncWithDef(excludedNameMatcher, includedNameMatcher);
 
    std::error_code tmp_create_error;
    auto tmpdir = std::filesystem::temp_directory_path(tmp_create_error);
    if(tmp_create_error) {
        std::cerr << "Error (" << tmp_create_error.value() << ") while getting temporary directory:\n" << tmp_create_error.message() << std::endl;
        return 1;
    }
 
    std::vector<std::filesystem::path> main_and_injection_files;
    for(const auto& file : OptionsParser.getCompilations().getAllFiles()) { main_and_injection_files.push_back(std::filesystem::path(file)); }
 
    spdlog::info("Source files from CompilationDatabase:\n{}", main_and_injection_files);
    llvm::ArrayRef<std::filesystem::path> sources(main_and_injection_files.data(), main_and_injection_files.size());
 
    if(Clean) {
        ProgressBar deletion_bar(sources.size());
        for(std::size_t i = 0; i < sources.size(); i++) {
            // deletion_bar.message = sources[i].string();
            bool HAS_INJECTED_INSTANTIATION = true;
            while(HAS_INJECTED_INSTANTIATION) {
                // deletion_bar.set_option(indicators::option::PostfixText{"Processing: " + sources[i].string()});
                if(not Invasive) {
                    auto gen_file = sources[i];
                    gen_file.replace_extension("gen.cpp");
                    std::ofstream f(gen_file, std::ios::out | std::ios::trunc);
                    f.close();
                    HAS_INJECTED_INSTANTIATION = false;
                } else {
                    std::unique_ptr<clang::ASTUnit> AST;
                    parseOrLoadAST(AST, OptionsParser.getCompilations(), sources[i], tmpdir);
                    clang::Rewriter rewriter(AST->getSourceManager(), AST->getLangOpts());
                    DeleteInstantiations Deleter;
                    Deleter.rewriter = &rewriter;
                    clang::ast_matchers::MatchFinder Inst_Finder;
                    Inst_Finder.addMatcher(/*Matcher*/ TemplInst(excludedNameMatcher, includedNameMatcher), /*Callback*/ &Deleter);
                    Inst_Finder.matchAST(AST->getASTContext());
                    rewriter.overwriteChangedFiles();
                    HAS_INJECTED_INSTANTIATION = rewriter.buffer_begin() != rewriter.buffer_end();
                }
            }
            if(Progress) { deletion_bar.step(); }
        }
        fmt::print("\n");
        return 0;
    }
 
    GetNeededInstantiations Getter;
 
    std::vector<Injection> toDoList;
    Getter.toDoList = &toDoList;
    clang::ast_matchers::MatchFinder Finder;
    Finder.addMatcher(/*Matcher*/ TemplateInstantiationMatcher, /*Callback*/ &Getter);
 
    // match in current main file.
    std::unordered_set<std::string> workList;
    workList.insert(OptionsParser.getSourcePathList()[0]);
 
    while(workList.size() > 0) {
        auto copyOf_workList = workList;
        for(const auto& item : copyOf_workList) {
            spdlog::info("Processing file {}", item);
            workList.erase(item);
            std::unique_ptr<clang::ASTUnit> source_AST;
            parseOrLoadAST(source_AST, OptionsParser.getCompilations(), item, tmpdir);
            spdlog::debug("Got AST for file {}", item);
            Finder.matchAST(source_AST->getASTContext());
            spdlog::info("Found {} todos for file {}", toDoList.size(), item);
            for(const auto& toDo : toDoList) { spdlog::debug("\t{}", toDo); }
            ProgressBar inner_bar(main_and_injection_files.size());
 
            for(const auto& file_for_search : main_and_injection_files) {
                if(toDoList.size() == 0) {
                    // inner_bar.set_option(indicators::option::PostfixText{"ToDoList became empty. "});
                    if(Progress) { inner_bar.update(inner_bar.numTasks()); }
                    break;
                }
                std::unique_ptr<clang::ASTUnit> target_AST;
                parseOrLoadAST(target_AST, OptionsParser.getCompilations(), file_for_search, tmpdir);
                spdlog::info("Search in AST of file {}", file_for_search);
                clang::Rewriter rewriter(target_AST->getSourceManager(), target_AST->getLangOpts());
                clang::ast_matchers::MatchFinder FuncFinder;
                InjectInstantiation instantiator;
                instantiator.toDoList = &toDoList;
                instantiator.rewriter = &rewriter;
                instantiator.invasive = Invasive;
                FuncFinder.addMatcher(/*Matcher*/ FunctionDefMatcher, /*Callback*/ &instantiator);
                FuncFinder.matchAST(target_AST->getASTContext());
                spdlog::debug("Called matchAST()");
                rewriter.overwriteChangedFiles();
                spdlog::debug("Called rewriter");
                bool HAS_INJECTED_INTANTIATION = rewriter.buffer_begin() != rewriter.buffer_end();
                if(HAS_INJECTED_INTANTIATION) {
                    spdlog::info("HAS_INJECTED={}", fmt::format(fg(fmt::color::green), "{}", HAS_INJECTED_INTANTIATION));
                    workList.insert(file_for_search);
                } else {
                    spdlog::info("HAS_INJECTED={}", fmt::format(fg(fmt::color::red), "{}", HAS_INJECTED_INTANTIATION));
                }
                if(Progress) { inner_bar.step(); }
            }
        }
    }
    spdlog::critical("#toDos that are left: {}", toDoList.size());
    if(toDoList.size() > 0) { spdlog::critical("toDos left:"); }
    std::size_t count = 0ul;
    for(const auto& toDo : toDoList) { spdlog::critical("{}: {}", count++, toDo); }
}