Support system dependencies (#827)

Closes #813

Author: ken-matsui

.github/workflows/codeql.yml

@@ -59,6 +59,12 @@ jobs:
           # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
           # queries: security-extended,security-and-quality
 
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            libgit2-dev
+
       # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
       # If this step fails, then you should remove it and run the build manually (see below)
       - name: Autobuild

.github/workflows/cpp.yml

@@ -51,6 +51,12 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            libgit2-dev
+
       - name: Build Poac
         run: make RELEASE=1
 

.github/workflows/linux.yml

@@ -43,6 +43,12 @@ jobs:
           chmod +x ./llvm.sh
           sudo ./llvm.sh ${{ matrix.compiler.ver }}
 
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y \
+            libgit2-dev
+
       - name: First Generation Build
         run: make -j4
 

.github/workflows/macos.yml

@@ -22,6 +22,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
+      - name: Install dependencies
+        run: |
+          brew install \
+            libgit2
+
       - name: First Generation Build
         run: make -j4
 

Makefile

@@ -16,7 +16,8 @@ PROJ_NAME = $(OUT_DIR)/poac
 VERSION = $(shell grep -m1 version poac.toml | cut -f 2 -d'"')
 
 DEFINES = -DPOAC_VERSION='"$(VERSION)"'
-INCLUDES = -I$(OUT_DIR)/DEPS/toml11
+INCLUDES = -I$(OUT_DIR)/DEPS/toml11 $(shell pkg-config --cflags libgit2)
+LIBS = $(shell pkg-config --libs libgit2)
 
 SRCS = $(shell find src -name '*.cc')
 OBJS = $(patsubst src/%,$(OUT_DIR)/%,$(SRCS:.cc=.o))
@@ -57,7 +58,7 @@ $(OUT_DIR)/DEPS:
 
 
 $(PROJ_NAME): $(OBJS)
-	$(CXX) $(CXXFLAGS) $^ -o $@
+	$(CXX) $(CXXFLAGS) $^ $(LIBS) -o $@
 
 $(OUT_DIR)/%.o: src/%.cc
 	$(CXX) $(CXXFLAGS) $(DEFINES) $(INCLUDES) -c $< -o $@
@@ -77,20 +78,20 @@ $(OUT_DIR)/tests/test_%.d: src/%.cc | $(OUTSIDE_DEPS) $(OUT_DIR) $(OUT_DIR)/test
 
 $(OUT_DIR)/tests/test_BuildConfig: $(OUT_DIR)/tests/test_BuildConfig.o \
   $(OUT_DIR)/Logger.o $(OUT_DIR)/TermColor.o $(OUT_DIR)/Manifest.o \
-  $(OUT_DIR)/Semver.o
-	$(CXX) $(CXXFLAGS) $^ -o $@
+  $(OUT_DIR)/Semver.o $(OUT_DIR)/Algos.o $(OUT_DIR)/VersionReq.o
+	$(CXX) $(CXXFLAGS) $^ $(LIBS) -o $@
 
 $(OUT_DIR)/tests/test_Algos: $(OUT_DIR)/tests/test_Algos.o $(OUT_DIR)/Logger.o \
   $(OUT_DIR)/TermColor.o
-	$(CXX) $(CXXFLAGS) $^ -o $@
+	$(CXX) $(CXXFLAGS) $^ $(LIBS) -o $@
 
 $(OUT_DIR)/tests/test_Semver: $(OUT_DIR)/tests/test_Semver.o $(OUT_DIR)/Logger.o \
   $(OUT_DIR)/TermColor.o
-	$(CXX) $(CXXFLAGS) $^ -o $@
+	$(CXX) $(CXXFLAGS) $^ $(LIBS) -o $@
 
 $(OUT_DIR)/tests/test_VersionReq: $(OUT_DIR)/tests/test_VersionReq.o \
   $(OUT_DIR)/Logger.o $(OUT_DIR)/TermColor.o $(OUT_DIR)/Semver.o
-	$(CXX) $(CXXFLAGS) $^ -o $@
+	$(CXX) $(CXXFLAGS) $^ $(LIBS) -o $@
 
 
 $(OUT_DIR)/tests/test_%.o: src/%.cc

README.md

@@ -83,16 +83,19 @@ If your environment is not included in the released packages, you have to build
 #### Commands
 
 * make
+* pkg-config
 * find
 * grep
 * mkdir
 * rm
 
 #### Libraries
 
+* libgit2
+
 When running Make, the following libraries will be installed automatically.
 
-* [`toml11`](https://github.com/ToruNiina/toml11): [`9086b11`](https://github.com/ToruNiina/toml11/commit/9086b1114f39a8fb10d08ca704771c2f9f247d02) or later
+* [toml11](https://github.com/ToruNiina/toml11): [`9086b11`](https://github.com/ToruNiina/toml11/commit/9086b1114f39a8fb10d08ca704771c2f9f247d02) or later
   * requires [this commit](https://github.com/ToruNiina/toml11/commit/9086b1114f39a8fb10d08ca704771c2f9f247d02)
   * awaiting the next release above [`v3.7.1`](https://github.com/ToruNiina/toml11/releases/tag/v3.7.1)
 
@@ -106,8 +109,9 @@ make RELEASE=1 install
 
 ### Runtime Requirements
 
-* Make
 * C++ compiler
+* Make
+* pkg-config
 * mkdir
 * echo
 * Git (for Git dependencies)

poac.toml

@@ -12,9 +12,7 @@ version = "0.7.0"
 
 [dependencies]
 "ToruNiina/toml11" = {git = "https://github.com/ToruNiina/toml11.git", rev = "846abd9a49082fe51440aa07005c360f13a67bbf"}
-
-[profile.release]
-lto = true
+libgit2 = {version = "1.1.0", system = true}
 
 [lint.cpplint]
 filters = [

src/Algos.cc

@@ -6,6 +6,19 @@
 #include <memory>
 #include <utility>
 
+String execShell(StringRef cmd) {
+  std::array<char, 128> buffer;
+  String result;
+  std::unique_ptr<FILE, decltype(&pclose)> pipe(popen(cmd.data(), "r"), pclose);
+  if (!pipe) {
+    throw std::runtime_error("popen() failed!");
+  }
+  while (fgets(buffer.data(), buffer.size(), pipe.get()) != nullptr) {
+    result += buffer.data();
+  }
+  return result;
+}
+
 // O(M) where M is the length of the word.
 void trieInsert(TrieNode& root, StringRef word) {
   TrieNode* node = &root;

src/Algos.hpp

@@ -12,6 +12,8 @@
 #include <stdexcept>
 #include <utility>
 
+String execShell(StringRef);
+
 template <typename... Args>
 inline String concat(Args&&... args) {
   return (std::ostringstream{} << ... << std::forward<Args>(args)).str();

src/BuildConfig.cc

@@ -26,8 +26,9 @@ static String OUT_DIR;
 static constexpr StringRef TEST_OUT_DIR = "tests";
 static const String PATH_FROM_OUT_DIR = "../..";
 static String CXX = "clang++";
-static String INCLUDES = "-Iinclude";
 static String DEFINES;
+static String INCLUDES = " -Iinclude";
+static String LIBS;
 
 void setOutDir(const bool isDebug) {
   if (isDebug) {
@@ -43,19 +44,6 @@ String getOutDir() {
   return OUT_DIR;
 }
 
-static String exec(const char* cmd) {
-  std::array<char, 128> buffer;
-  String result;
-  std::unique_ptr<FILE, decltype(&pclose)> pipe(popen(cmd, "r"), pclose);
-  if (!pipe) {
-    throw std::runtime_error("popen() failed!");
-  }
-  while (fgets(buffer.data(), buffer.size(), pipe.get()) != nullptr) {
-    result += buffer.data();
-  }
-  return result;
-}
-
 static Vec<Path> listSourceFilePaths(StringRef directory) {
   Vec<Path> sourceFilePaths;
   for (const auto& entry : fs::recursive_directory_iterator(directory)) {
@@ -293,7 +281,7 @@ String runMM(const String& sourceFile, const bool isTest = false) {
   } else {
     command += " -MM " + sourceFile;
   }
-  return exec(command.c_str());
+  return execShell(command);
 }
 
 static OrderedHashSet<String>
@@ -390,7 +378,7 @@ static void defineLinkTarget(
 ) {
   Vec<String> commands(2);
   commands[0] = echoCmd("Linking", binTarget);
-  commands[1] = buildCmd("$(CXX) $(CXXFLAGS) $^ -o $@");
+  commands[1] = buildCmd("$(CXX) $(CXXFLAGS) $^ $(LIBS) -o $@");
   config.defineTarget(binTarget, commands, deps);
 }
 
@@ -468,18 +456,15 @@ static void setVariables(BuildConfig& config, const bool isDebug) {
             + getPackageVersion().to_string() + "\"'";
   config.defineSimpleVariable("DEFINES", DEFINES);
 
-  const Vec<Path> deps = installGitDependencies();
-  for (const Path& dep : deps) {
-    const Path includeDir = dep / "include";
-    if (fs::exists(includeDir) && fs::is_directory(includeDir)
-        && !fs::is_empty(includeDir)) {
-      INCLUDES += " -I" + includeDir.string();
-    } else {
-      INCLUDES += " -I" + dep.string();
-    }
+  const Vec<DepMetadata> deps = installDependencies();
+  for (const DepMetadata& dep : deps) {
+    INCLUDES += ' ' + dep.includes;
+    LIBS += ' ' + dep.libs;
   }
   Logger::debug("INCLUDES: ", INCLUDES);
+  Logger::debug("LIBS: ", LIBS);
   config.defineSimpleVariable("INCLUDES", INCLUDES);
+  config.defineSimpleVariable("LIBS", LIBS);
 }
 
 static BuildConfig configureBuild(const bool isDebug) {