Repository files navigation

Build C, C++ and ASM files in C++

BuildCC aims to be an alternative toMakefiles while using the feature rich C++ language instead of a custom DSL.

• Complete flexibility for custom workflows and toolchains
• C++ language feature benefits anddebuggable build binaries
• Optimized rebuilds through serialization. Seetarget.fbs schema
  • Can optimize for rebuilds by comparing the previous stored build with current build.
  • Also see theFAQ for more details on Serialization
• Customizable for community plugins. More details provided in theCommunity Plugin section.

• C++17 Compiler with
  • C++17 filesystem library support
  • C++11 thread library support
• Third Party Libraries (See License below)
  • Nlohmann::Json v3.11.2
  • Taskflow v3.1.0
  • CLI11 v2.1.0
  • Tiny Process Library v2.0.4
  • fmt v8.0.1
  • spdlog v1.9.2
  • CppUTest v4.0
  • Tl::Optional (master)

• A one stageinput / output procedure is called aGenerator with a wide variety of use cases
  • Single input creates single output
  • Single input creates multiple outputs
  • Multiple inputs create single output
  • Multiple inputs creates multiple outputs
• A two stagecompile andlink procedure is called aTarget
  • This means that Executables, StaticLibraries and DynamicLibraries are all categorized as Targets
  • In the future C++20 modules can also be its own target depending on compiler implementations
• Every Target requires a complementary (and compatible)Toolchain
  • This ensures that cross compiling is very easy and explicit in nature.
  • Multiple toolchains can bemixed in a single build file i.e we can generate targets using the GCC, Clang, MSVC and many other compilerssimultaneously.
• Thecompile_command (pch and object commands) andlink_command (target command) is fed to theprocess call to invoke theToolchain.
• EachTarget can depend on other targets efficiently through Parallel Programming usingTaskflow.
  • Dependency between targets is explicitly mentioned through the Taskflow APIs
  • This has been made easier for the user through thebuildcc::Register module.
• Build files can be customized through command line arguments
  • Command line arguments can be stored in configurable.toml files and passed using the--config flag.
  • Users can define their own custom arguments.
  • Argument passing has been made easy using thebuildcc::Args module.

• See alsohow to generate graphs using CMake

See alsohow to create uml diagrams using VSCode

• buildcc::base::Generator,buildcc::base::TargetInfo andbuildcc::base::Target contains public getters that can be used to construct unique community plugins.
• Common tools and plugins would have first-party support in buildcc.
• All other tools and plugins can be maintained by individual developers.

Current state of BuildCC supported plugins

• ClangCompileCommands
• BuildCCFind
  • Host system executable
  • BuildCC Library
  • BuildCC Plugin
• ClangFormat
• Target graph visualizer (through Taskflow)

Containsproof of concept andreal worldexamples.

Taskflow dependency for hybrid/simple example

• Build GCC and MSVC Targets simultaneously
• 1 C and 1 CPP example for both toolchains

Taskflow dependency for hybrid/pch example

• Activate PCH for GCC and MSVC Targets
• 1 C and 1 CPP example for both toolchains

Taskflow dependency for hybrid/dep_chaining example

• ChainGenerator withTargets for Dependency
• 1 C and 1 CPP example for both toolchains

Developers interested in usingBuildCC

• Installation using CMake

Developers interested in contributing toBuildCC

• Project internal information

• How do I supply my own customcompile_command andlink_command to targets?

• Understandingpath.fbs
• Understandinggenerator.fbs
• Understandingtarget.fbs

• Why hasthis third-party library been chosen?
• Why do you trackinclude directories andheader files?

• Why-Wl,--allow-multiple-definition for MINGW?

List of features to be implemented before buildcc can be considered production ready.

I would also like to request help from the Community for the following:

• Code reviews
• Design patterns
• Optimization strategies
• TODO discussions

BuildCC is licensed under the Apache License, Version 2.0. SeeLICENSE for the full license text.BuildCC aims to use open-source libraries containing permissive licenses.

Developers who would like to suggest an alternative library, raise an issue with thelicense andadvantages clearly outlined.

• Fmtlib (Formatting) [MIT License]
• Spdlog (Logging) [MIT License]
• Tiny Process Library (Process handling) [MIT License]
• Taskflow (Parallel Programming) [MIT License] [Header Only]
  • See also3rd-Party used by Taskflow
• Nlohmann::Json (JSON Serialization) [MIT License] [Header Only]
• CLI11 (Argument Parsing) [BSD-3-Clause License] [Header Only]
• CppUTest (Unit Testing/Mocking) [BSD-3-Clause License]
• Tl::Optional (Optional support) [CC0-1.0 License]