Builder: add BuildProfile & debug -> dev (#1151)

Author: ken-matsui

Diff for: .github/workflows/cpp.yml

@@ -102,12 +102,12 @@ jobs:
         run: ./build/cabin --verbose run test --verbose
 
       - name: Stage 2 - Print version
-        run: ./cabin-out/debug/cabin version --verbose
+        run: ./cabin-out/dev/cabin version --verbose
 
       - name: Stage 2 - Integration Test
         run: find tests -maxdepth 1 -name '[0-9]*.sh' -print0 | xargs -0 -I {} sh -c 'sh {} -v'
         env:
-          CABIN: ${{ github.workspace }}/cabin-out/debug/cabin
+          CABIN: ${{ github.workspace }}/cabin-out/dev/cabin
           CABIN_TERM_COLOR: auto
 
       # - name: Print coverage

Diff for: docs/hello-world.md

@@ -18,7 +18,7 @@ you:~$ cd hello_world
 you:~/hello_world$ cabin run
  Compiling src/main.cc
    Linking hello_world
-  Finished debug target(s) in 0.45386s
-   Running cabin-out/debug/hello_world
+  Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.45386s
+   Running cabin-out/dev/hello_world
 Hello, world!
 ```

Diff for: docs/usage.md

@@ -27,16 +27,16 @@ In most cases, you want to execute the generated binary as well as build the pro
 you:~/hello_world$ cabin run
  Compiling src/main.cc
    Linking hello_world
-  Finished debug target(s) in 0.45386s
-   Running cabin-out/debug/hello_world
+  Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.45386s
+   Running cabin-out/dev/hello_world
 Hello, world!
 ```
 
 If you just want to build it, run the `build` command:
 
 ```console
 you:~/hello_world$ cabin build
-  Finished debug target(s) in 0.00866317s
+  Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.00866317s
 ```
 
 Cabin uses a cache since we executed the command with no changes.
@@ -111,7 +111,7 @@ you:~/hello_world$ cabin build
 Downloaded ToruNiina/toml11 846abd9a49082fe51440aa07005c360f13a67bbf
  Compiling src/main.cc
    Linking hello_world
-  Finished debug target(s) in 0.70s
+  Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.70s
 ```
 
 ### Remove dependencies

Diff for: src/BuildConfig.cc

@@ -61,7 +61,7 @@ operator<<(std::ostream& os, VarType type) {
 }
 
 Result<BuildConfig>
-BuildConfig::init(const Manifest& manifest, const bool isDebug) {
+BuildConfig::init(const Manifest& manifest, BuildProfile buildProfile) {
   using std::string_view_literals::operator""sv;
 
   std::string libName;
@@ -71,20 +71,17 @@ BuildConfig::init(const Manifest& manifest, const bool isDebug) {
     libName = fmt::format("lib{}.a", manifest.package.name);
   }
 
-  fs::path outBasePath;
   const fs::path projectBasePath = manifest.path.parent_path();
-  if (isDebug) {
-    outBasePath = projectBasePath / "cabin-out" / "debug";
-  } else {
-    outBasePath = projectBasePath / "cabin-out" / "release";
-  }
+  fs::path outBasePath =
+      projectBasePath / "cabin-out" / fmt::format("{}", buildProfile);
   fs::path buildOutPath = outBasePath / (manifest.package.name + ".d");
   fs::path unittestOutPath = outBasePath / "unittests";
 
   Project project = Try(Project::init(fs::current_path()));
   return Ok(BuildConfig(
-      manifest, isDebug, std::move(libName), std::move(outBasePath),
-      std::move(buildOutPath), std::move(unittestOutPath), std::move(project)
+      manifest, std::move(buildProfile), std::move(libName),
+      std::move(outBasePath), std::move(buildOutPath),
+      std::move(unittestOutPath), std::move(project)
   ));
 }
 
@@ -501,7 +498,7 @@ BuildConfig::installDeps(const bool includeDevDeps) {
 
 void
 BuildConfig::setVariables() {
-  project.setBuildProfile(isDebug);
+  project.setBuildProfile(buildProfile);
 
   defineSimpleVar("CXX", project.compiler.cxx);
   defineSimpleVar(
@@ -814,10 +811,11 @@ BuildConfig::configureBuild() {
 
 Result<BuildConfig>
 emitMakefile(
-    const Manifest& manifest, const bool isDebug, const bool includeDevDeps
+    const Manifest& manifest, const BuildProfile& buildProfile,
+    const bool includeDevDeps
 ) {
-  const Profile& profile = manifest.profiles.at(modeToProfile(isDebug));
-  auto config = Try(BuildConfig::init(manifest, isDebug));
+  const Profile& profile = manifest.profiles.at(buildProfile);
+  auto config = Try(BuildConfig::init(manifest, buildProfile));
 
   // When emitting Makefile, we also build the project.  So, we need to
   // make sure the dependencies are installed.
@@ -860,9 +858,10 @@ emitMakefile(
 /// @returns the directory where the compilation database is generated.
 Result<std::string>
 emitCompdb(
-    const Manifest& manifest, const bool isDebug, const bool includeDevDeps
+    const Manifest& manifest, const BuildProfile& buildProfile,
+    const bool includeDevDeps
 ) {
-  auto config = Try(BuildConfig::init(manifest, isDebug));
+  auto config = Try(BuildConfig::init(manifest, buildProfile));
 
   // compile_commands.json also needs INCLUDES, but not LIBS.
   Try(config.installDeps(includeDevDeps));
@@ -879,16 +878,6 @@ emitCompdb(
   return Ok(config.outBasePath);
 }
 
-std::string_view
-modeToString(const bool isDebug) {
-  return isDebug ? "debug" : "release";
-}
-
-const char*
-modeToProfile(const bool isDebug) {
-  return isDebug ? "dev" : "release";
-}
-
 Command
 getMakeCommand() {
   Command makeCommand("make");

Diff for: src/BuildConfig.hpp

@@ -1,6 +1,7 @@
 #pragma once
 
-#include "./Builder/Project.hpp"
+#include "Builder/BuildProfile.hpp"
+#include "Builder/Project.hpp"
 #include "Command.hpp"
 #include "Manifest.hpp"
 
@@ -59,7 +60,7 @@ class BuildConfig {
   std::string libName;
   fs::path buildOutPath;
   fs::path unittestOutPath;
-  bool isDebug;
+  BuildProfile buildProfile;
 
   // if we are building an binary
   bool hasBinaryTarget{ false };
@@ -81,18 +82,18 @@ class BuildConfig {
   ) const;
 
   explicit BuildConfig(
-      const Manifest& manifest, bool isDebug, std::string libName,
+      const Manifest& manifest, BuildProfile buildProfile, std::string libName,
       fs::path outBasePath, fs::path buildOutPath, fs::path unittestOutPath,
       Project project
   )
       : outBasePath(std::move(outBasePath)), manifest(manifest),
         libName(std::move(libName)), buildOutPath(std::move(buildOutPath)),
-        unittestOutPath(std::move(unittestOutPath)), isDebug(isDebug),
-        project(std::move(project)) {}
+        unittestOutPath(std::move(unittestOutPath)),
+        buildProfile(std::move(buildProfile)), project(std::move(project)) {}
 
 public:
   static Result<BuildConfig>
-  init(const Manifest& manifest, bool isDebug = true);
+  init(const Manifest& manifest, BuildProfile buildProfile = BuildProfile::Dev);
 
   bool hasBinTarget() const {
     return hasBinaryTarget;
@@ -212,12 +213,14 @@ class BuildConfig {
   Result<void> configureBuild();
 };
 
-Result<BuildConfig>
-emitMakefile(const Manifest& manifest, bool isDebug, bool includeDevDeps);
-Result<std::string>
-emitCompdb(const Manifest& manifest, bool isDebug, bool includeDevDeps);
-std::string_view modeToString(bool isDebug);
-const char* modeToProfile(bool isDebug);
+Result<BuildConfig> emitMakefile(
+    const Manifest& manifest, const BuildProfile& buildProfile,
+    bool includeDevDeps
+);
+Result<std::string> emitCompdb(
+    const Manifest& manifest, const BuildProfile& buildProfile,
+    bool includeDevDeps
+);
 Command getMakeCommand();
 
 }  // namespace cabin

Diff for: src/Builder/BuildProfile.hpp

@@ -0,0 +1,67 @@
+#pragma once
+
+#include <fmt/format.h>
+#include <string>
+#include <utility>
+#include <variant>
+
+namespace cabin {
+
+class BuildProfile {
+  friend struct fmt::formatter<BuildProfile>;
+  friend struct std::hash<BuildProfile>;
+
+public:
+  enum Type : uint8_t {
+    Dev,
+    Release,
+  };
+
+private:
+  using TypeT = std::variant<Type, std::string>;
+  TypeT type;
+
+public:
+  BuildProfile() : type(Type::Dev) {}
+  BuildProfile(Type type) : type(type) {}  // NOLINT
+  explicit BuildProfile(std::string type) : type(std::move(type)) {}
+
+  bool operator==(const BuildProfile& other) const {
+    return type == other.type;
+  }
+};
+
+}  // namespace cabin
+
+template <>
+struct std::hash<cabin::BuildProfile> {
+  std::size_t operator()(const cabin::BuildProfile& bp) const noexcept {
+    return std::hash<cabin::BuildProfile::TypeT>{}(bp.type);
+  }
+};
+
+template <>
+struct fmt::formatter<cabin::BuildProfile> {
+  // NOLINTNEXTLINE(*-static)
+  constexpr auto parse(fmt::format_parse_context& ctx) {
+    return ctx.begin();
+  }
+
+  template <typename FormatContext>
+  auto
+  format(const cabin::BuildProfile& buildProfile, FormatContext& ctx) const {
+    if (std::holds_alternative<cabin::BuildProfile::Type>(buildProfile.type)) {
+      switch (std::get<cabin::BuildProfile::Type>(buildProfile.type)) {
+        case cabin::BuildProfile::Dev:
+          return fmt::format_to(ctx.out(), "dev");
+        case cabin::BuildProfile::Release:
+          return fmt::format_to(ctx.out(), "release");
+      }
+      __builtin_unreachable();
+    } else {
+      return fmt::format_to(
+          ctx.out(), "{}", std::get<std::string>(buildProfile.type)
+      );
+    }
+  }
+};

Diff for: src/Builder/Project.cc

@@ -4,6 +4,7 @@
 #include "../Git2.hpp"
 #include "../Rustify/Result.hpp"
 #include "../TermColor.hpp"
+#include "BuildProfile.hpp"
 
 #include <filesystem>
 #include <spdlog/spdlog.h>
@@ -98,8 +99,8 @@ getEnvFlags(const char* name) {
 }
 
 void
-Project::setBuildProfile(const bool isDebug) {
-  const Profile& profile = manifest.profiles.at(isDebug ? "dev" : "release");
+Project::setBuildProfile(const BuildProfile& buildProfile) {
+  const Profile& profile = manifest.profiles.at(buildProfile);
   if (profile.debug) {
     compiler.opts.cFlags.others.emplace_back("-g");
     compiler.opts.cFlags.macros.emplace_back("DEBUG", "");
@@ -154,7 +155,7 @@ Project::setBuildProfile(const bool isDebug) {
   defines.emplace("COMMIT_HASH", commitHash);
   defines.emplace("COMMIT_SHORT_HASH", commitShortHash);
   defines.emplace("COMMIT_DATE", commitDate);
-  defines.emplace("PROFILE", std::string(isDebug ? "dev" : "release"));
+  defines.emplace("PROFILE", fmt::format("{}", buildProfile));
 
   const auto quote = [](auto&& val) {
     if constexpr (std::is_same_v<std::decay_t<decltype(val)>, std::string>) {

Diff for: src/Builder/Project.hpp

@@ -2,6 +2,7 @@
 
 #include "../Manifest.hpp"
 #include "../Rustify/Result.hpp"
+#include "BuildProfile.hpp"
 #include "Compiler.hpp"
 
 #include <filesystem>
@@ -21,7 +22,7 @@ class Project {
 
   static Result<Project> init(const fs::path& rootDir);
 
-  void setBuildProfile(bool isDebug);
+  void setBuildProfile(const BuildProfile& buildProfile);
 };
 
 }  // namespace cabin