test_codegen_filelist.cpp

#include <cassert>
#include <cstdio>
#include <filesystem>
#include <functional>
#include <fstream>
#include <set>
#include <string>
#include <unistd.h>
#include <vector>

namespace picker { namespace codegen {
    void gen_filelist(const std::vector<std::string> &source_file, const std::vector<std::string> &ifilelists,
                      std::string &ofilelist, std::vector<std::string> &incdirs);
    void append_incdirs_to_vflag(const std::string &simulator, const std::vector<std::string> &incdirs,
                                 std::string &vflag);
}} // namespace picker::codegen

static void write_text(const std::filesystem::path &p, const std::string &t)
{
    std::ofstream o(p, std::ios::trunc);
    o << t;
}

static bool contains_line(const std::string &haystack, const std::string &needle)
{
    return haystack.find(needle) != std::string::npos;
}

static std::string capture_stderr(const std::function<void()> &fn)
{
    std::fflush(stderr);
    FILE *tmp = std::tmpfile();
    assert(tmp != nullptr);

    int saved_stderr = dup(fileno(stderr));
    assert(saved_stderr != -1);
    assert(dup2(fileno(tmp), fileno(stderr)) != -1);

    fn();

    std::fflush(stderr);
    assert(dup2(saved_stderr, fileno(stderr)) != -1);
    close(saved_stderr);

    std::rewind(tmp);
    std::string captured;
    char buffer[256];
    while (std::fgets(buffer, sizeof(buffer), tmp) != nullptr) {
        captured += buffer;
    }
    std::fclose(tmp);
    return captured;
}

int main()
{
    namespace fs = std::filesystem;
    const fs::path base = fs::temp_directory_path() / "picker_test_filelist";
    const fs::path cwd_base = fs::temp_directory_path() / "picker_test_filelist_cwd";
    fs::remove_all(base);
    fs::remove_all(cwd_base);
    fs::create_directories(base / "inc1");
    fs::create_directories(base / "inc2");
    fs::create_directories(base / "inc3");
    fs::create_directories(base / "inc4");
    fs::create_directories(base / "sub");
    fs::create_directories(base / "sub2");
    fs::create_directories(cwd_base / "inc_shadow");

    write_text(base / "rtl1.sv", "module m; endmodule\n");
    write_text(base / "defs.vh", "`define DEF_W 8\n");
    write_text(base / "macro.svh", "`include \"defs.vh\"\n");
    write_text(base / "sub" / "rtl2.v", "module n; endmodule\n");
    write_text(base / "sub2" / "ignore.txt", "noop\n");
    write_text(base / "sub2" / "rtl3.sv", "module p; endmodule\n");
    write_text(base / "dependency.so", "shared library placeholder\n");
    write_text(base / "dependency.a", "archive placeholder\n");
    write_text(base / "dependency.o", "object placeholder\n");
    write_text(cwd_base / "rtl1.sv", "module wrong; endmodule\n");

    const fs::path filelist = base / "filelist.f";
    write_text(filelist,
               "# comment\n"
               "+incdir+inc1+inc2\n"
               "-I inc3\n"
               "-Iinc4\n"
               "rtl1.sv\n"
               "sub/\n");

    std::string ofilelist;
    std::vector<std::string> incdirs;
    std::string stderr_output = capture_stderr([&]() {
        picker::codegen::gen_filelist({}, {filelist.string()}, ofilelist, incdirs);
    });
    assert(stderr_output.empty());

    std::set<std::string> incset(incdirs.begin(), incdirs.end());
    assert(incset.size() == 4);
    assert(incset.count((base / "inc1").string()) == 1);
    assert(incset.count((base / "inc2").string()) == 1);
    assert(incset.count((base / "inc3").string()) == 1);
    assert(incset.count((base / "inc4").string()) == 1);

    assert(contains_line(ofilelist, (base / "rtl1.sv").string()));
    assert(contains_line(ofilelist, (base / "sub" / "rtl2.v").string()));
    assert(!contains_line(ofilelist, "incdir"));

    std::string vflag;
    picker::codegen::append_incdirs_to_vflag("verilator", incdirs, vflag);
    assert(contains_line(vflag, "-I" + (base / "inc1").string()));

    std::string vflag_vcs;
    picker::codegen::append_incdirs_to_vflag("vcs", incdirs, vflag_vcs);
    assert(contains_line(vflag_vcs, "+incdir+" + (base / "inc1").string()));

    // second scenario: duplicates, comments, and source_file skip
    const fs::path filelist2 = base / "filelist2.f";
    write_text(filelist2,
               "+incdir+inc1+inc1\n"
               "  # full line comment\n"
               "rtl1.sv # trailing comment\n"
               "sub2/\n");

    std::string ofilelist2;
    std::vector<std::string> incdirs2;
    stderr_output = capture_stderr([&]() {
        picker::codegen::gen_filelist({(base / "rtl1.sv").string()}, {filelist2.string()}, ofilelist2, incdirs2);
    });
    assert(stderr_output.empty());
    // rtl1.sv should be skipped because it is in source_file
    assert(!contains_line(ofilelist2, (base / "rtl1.sv").string()));
    // sub2/ should include rtl3.sv but not ignore.txt
    assert(contains_line(ofilelist2, (base / "sub2" / "rtl3.sv").string()));
    assert(!contains_line(ofilelist2, (base / "sub2" / "ignore.txt").string()));
    // duplicate incdir should collapse
    std::set<std::string> incset2(incdirs2.begin(), incdirs2.end());
    assert(incset2.size() == 1);
    assert(incset2.count((base / "inc1").string()) == 1);

    const fs::path filelist3 = base / "filelist3.f";
    write_text(filelist3,
               "+incdir+.\n"
               "rtl1.sv\n");

    const fs::path original_cwd = fs::current_path();
    fs::current_path(cwd_base);

    std::string ofilelist3;
    std::vector<std::string> incdirs3;
    stderr_output = capture_stderr([&]() {
        picker::codegen::gen_filelist({}, {filelist3.string()}, ofilelist3, incdirs3);
    });

    fs::current_path(original_cwd);

    assert(stderr_output.empty());
    assert(incdirs3.size() == 1);
    // Some standard libraries preserve a trailing separator for "base/.", so
    // compare the existing directories rather than their spellings.
    assert(fs::equivalent(fs::path(incdirs3.front()), base));
    assert(contains_line(ofilelist3, (base / "rtl1.sv").string()));
    assert(!contains_line(ofilelist3, (cwd_base / "rtl1.sv").string()));

    const fs::path filelist4 = base / "filelist4.f";
    write_text(filelist4,
               "defs.vh\n"
               "macro.svh\n"
               "rtl1.sv\n"
               "dependency.so\n"
               "dependency.a\n"
               "dependency.o\n");

    std::string ofilelist4;
    std::vector<std::string> incdirs4;
    stderr_output = capture_stderr([&]() {
        picker::codegen::gen_filelist({}, {filelist4.string()}, ofilelist4, incdirs4);
    });

    assert(stderr_output.empty());
    assert(contains_line(ofilelist4, (base / "rtl1.sv").string()));
    assert(!contains_line(ofilelist4, (base / "defs.vh").string()));
    assert(!contains_line(ofilelist4, (base / "macro.svh").string()));
    assert(contains_line(ofilelist4, (base / "dependency.so").string()));
    assert(contains_line(ofilelist4, (base / "dependency.a").string()));
    assert(contains_line(ofilelist4, (base / "dependency.o").string()));
    std::set<std::string> incset4(incdirs4.begin(), incdirs4.end());
    assert(incset4.size() == 1);
    assert(incset4.count(base.string()) == 1);

    fs::remove_all(cwd_base);
    fs::remove_all(base);
    return 0;
}