Skip to content

Added ccache support and missing documentation #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dpjudas merged 2 commits into from
Jun 17, 2026
Merged

Added ccache support and missing documentation #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
def21f0
Added ccache support and missing documentation
bleze Jun 17, 2026
cd342b4
No need to check if ccache is installed if enabled
bleze Jun 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CPPBuild/BuildSetup.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,7 @@ class BuildSetup
int version = 1;
std::string sourcePath;
BuildProject project;
bool ccache = false;

static BuildSetup fromJson(const JsonValue& json);
};
8 changes: 7 additions & 1 deletion CPPBuild/CPPBuild.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -287,7 +287,13 @@ void CPPBuild::createPackage()

BuildSetup CPPBuild::loadBuildSetup()
{
return BuildSetup::fromJson(JsonValue::parse(File::readAllText(FilePath::combine(cppbuildDir, "config.json"))));
BuildSetup setup = BuildSetup::fromJson(JsonValue::parse(File::readAllText(FilePath::combine(cppbuildDir, "config.json"))));
JsonValue properties = loadProperties(FilePath::combine(getGlobalConfigDir(), "properties.json"));
JsonValue localProperties = loadProperties(FilePath::combine(getLocalConfigDir(), "properties.json"));
for (const auto& it : localProperties.properties())
properties[it.first] = it.second;
setup.ccache = (properties["ccache.enable"].to_string() == "true");
return setup;
}

std::vector<std::string> CPPBuild::getBuildOrder(BuildSetup& setup, std::string targetName, std::string configuration)
Expand Down
6 changes: 6 additions & 0 deletions CPPBuild/Target.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1004,6 +1004,12 @@ void Target::loadTarget(BuildSetup& setup, PackageManager* packages)
ar = "ar";
isGcc = true;
#endif

if (setup.ccache)
{
cc = "ccache " + cc;
ccpp = "ccache " + ccpp;
}
}

wwwrootDir = FilePath::combine(sourcePath, targetDef.wwwRootDir);
Expand Down
34 changes: 29 additions & 5 deletions Docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ CPPBuild is a build system and a project generator for C and C++ projects.
```
cppbuild configure [source path]
cppbuild set [--global] <property> <value>
cppbuild [--workdir <path>] build <target> <configuration>
cppbuild [--workdir <path>] clean <target> <configuration>
cppbuild [--workdir <path>] rebuild <target> <configuration>
cppbuild [--workdir <path>] build [--no-deps] <target> <configuration>
cppbuild [--workdir <path>] clean [--no-deps] <target> <configuration>
cppbuild [--workdir <path>] rebuild [--no-deps] <target> <configuration>
cppbuild [--workdir <path>] create-package
cppbuild [--workdir <path>] create-installer
```
Expand All @@ -22,16 +22,40 @@ After this the project can be built either by running cppbuild directly, opening
`cppbuild set` sets a property value that can then be read via `Project.getProperty(name)` in the configure script. If `--global` is
specified the property is set globally for all cppbuild projects.

`cppbuild build` will build a specific target.
`cppbuild build` will build a specific target and all of its dependencies in the correct order.

`cppbuild clean` will remove all intermediate and output files from earlier builds.
`cppbuild clean` will remove all intermediate and output files for a target and its dependencies.

`cppbuild rebuild` is shorthand for first running clean followed by build.

The optional `--no-deps` flag skips dependency resolution and builds only the named target itself. This is used internally by the generated Visual Studio project files, where Visual Studio handles dependency ordering via project references.

`cppbuild create-package` creates packages described via `PackageInstaller.add()`.

`cppbuild create-installer` creates MSI installers described via `Installer.add()`.

## Built-in Properties

Some properties are recognized directly by CPPBuild and affect how it builds targets. They are set with `cppbuild set` like any other property.

| Property | Platform | Values | Default | Description |
|---|---|---|---|---|
| `ccache.enable` | Linux, macOS | `true` / `false` | `false` | Prepends `ccache` to the C and C++ compiler commands. ccache must be installed. Has no effect if ccache is not found on `PATH`. |
| `cppbuild.vsversion` | Windows | VS display name | latest installed | Selects the Visual Studio installation used when generating the solution. The value must match the VS display name exactly, e.g. `Visual Studio 2022`. If not set, the most recently installed version is used. |

Examples:

```
cppbuild set ccache.enable true
cppbuild set cppbuild.vsversion "Visual Studio 2022"
```

Use `--global` to apply the setting to all CPPBuild projects on the machine:

```
cppbuild set --global ccache.enable true
```

## Configure.js

A basic configure script might look like this:
Expand Down
Loading