Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ module name the member declares, and configures it there.

```toml
[build-dependencies.mcpp]
plugins = { version = "0.25.0", features = ["rules-spirv"], host-module = true }
plugins = { version = "0.26.0", features = ["rules-spirv"], host-module = true }
```

```cpp
Expand Down
9 changes: 7 additions & 2 deletions dist/apk.cppm
Original file line number Diff line number Diff line change
Expand Up @@ -2490,7 +2490,8 @@ inline plan plan_for(options opt = {}) {
kt.inputs = kotlinFiles;
for (auto const& f : javaFiles) kt.inputs.push_back(f);
for (auto const& c : classpath) kt.inputs.push_back(c);
attach(kt, id("apk-kotlinc", "aab-kotlinc"), steps::program{}.run(command).touch(kt.output));
attach(kt, id("apk-kotlinc", "aab-kotlinc"),
steps::program{}.remove(kotlinClassesDir).run(command).touch(kt.output));
p.steps.push_back(kt);
kotlinStamp = kt.output;
}
Expand All @@ -2508,8 +2509,12 @@ inline plan plan_for(options opt = {}) {
javacStep.inputs = javaFiles;
for (auto const& c : classpath) javacStep.inputs.push_back(c);
if (!kotlinStamp.empty()) javacStep.inputs.push_back(kotlinStamp);
// THE DIRECTORY IS EMPTIED FIRST: a compiler adds classes and never
// removes one, so a source that left the package -- a library dropped
// from the graph, a file deleted -- would otherwise keep its class in
// the directory d8 lists, and in the package.
attach(javacStep, id("apk-javac", "aab-javac"),
steps::program{}.run(javacCommand).touch(javacStep.output));
steps::program{}.remove(classesDir).run(javacCommand).touch(javacStep.output));
p.steps.push_back(javacStep);

const std::string dexDir = (outDir / "dex").string();
Expand Down
2 changes: 1 addition & 1 deletion docs/dist-apk.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

Module `mcpp.dist.apk`; engine floor: 2026.10.1.3 from 0.19.0 (mcpp#755), whose protocol 15 states where a tool comes from and installs `xim:bundletool` only when a bundle asks for it; 2026.9.14.2 from 0.10.0, which stages the closure this member reads; before it 2026.9.13.1, raised alongside `dist-web` in the same 0.9.0 release: this member's own manifest-template and Java-array changes ask nothing new of the engine, but this collection publishes one package at one version, and this is the release CI verifies it under from here on.

**Needs and behaviour.** `xim:android-build-tools`, `xim:android-platform` (versioned by API level, read back for `targetSdkVersion`), `xim:jdk-temurin` (`java`/`javac`/`jar`/`jarsigner`; `android-build-tools`' own runtime dependency provisions a JDK for its OWN wrappers only), `xim:android-debug-keystore`, `xim:bundletool` (0.10.0, for `--format aab`), `xim:cmake` (0.25.0, asked for when a package is planned: the runner of the steps of more than one command until mcpp-community/mcpp#955), all on the `cfg(env = "android")` axis. Generates `AndroidManifest.xml` and signs with the published Android debug key by default. Level 0 needs no Java (`hasCode="false"`, `android.app.NativeActivity`); `options::java_sources` adds `javac` + `d8` and a real `<activity>`. `options::manifest_template` renders a project manifest with six tokens substituted verbatim; `{{application_id}}` and `{{activity}}` are required always and `{{lib_name}}` at level 0, each refused by name at plan time when missing (naming `assets/mcpp-run.json`, which `adb-run` reads them from too) or when the template names an unknown token; empty renders 0.8.0's manifest byte-identically. From 0.9.3 the manifest template gains `{{version_name}}` / `{{version_code}}` (the package version, and `major * 1000000 + minor * 1000 + patch`). `options::resources` is a project's own `res/`, linked as the application's base resources from 0.9.1 (0.9.0 linked it as an aapt2 overlay, which refuses every resource the base does not already define -- a launcher icon could not be supplied). `options::java_sources` is an array: one `javac` over every root's `.java` files and one `d8` over the result, so a project's own sources and a path dependency's join without being merged into one directory first, and `rerun_if_changed_glob` is declared only for a root under `mcpp::manifest_dir()` -- a dependency root's files are already inputs of the `javac` action and its version is already in the build's fingerprint. Android only -- an `app` target is a shared object on this row (#622 A3). From 0.10.0, with mcpp 2026.9.14.2, the member reads the native closure the engine stages -- the application object, the graph's shared libraries and `libc++_shared.so` under `lib/` for one `--target`, `lib/<abi>/` for several -- and packs every ABI the tree carries into one APK; its own `NEEDED` walk and the stamp that lost a dependency's library on a second pack are gone. A stage manifest without `needs` lines comes from an engine below 2026.9.14.2 and is refused naming that floor, as is an incomplete closure, naming the unresolved libraries; every refusal is also a `mcpp::warning`, because the engine discards a build program's output when it exits 0. `--format aab` shares every step but the last three: `aapt2 link --proto-format` (with `--version-code` / `--version-name`, which bundletool requires), a base module in the layout bundletool reads, `bundletool build-bundle` from `xim:bundletool` (declared on the same axis), and `jarsigner` with the same keystore. CI packages both level 0 and level 1 and checks the archive (`mcpp::deploy`'d files under `assets/`), and on `tests/apk-consumer-shared` two packs in a row, a two-ABI APK (`aapt2` reports both, `apksigner` verifies it), an App Bundle (`bundletool validate`, `jarsigner -verify`, a universal APK from `bundletool build-apks`), a refusal's reason in `mcpp pack`'s output, and the floor refusal; the runner has no emulator or device, so the two rows that actually run were measured locally on 2026-09-12, through `adb-run`, against a KVM-accelerated x86_64 emulator and a physical arm64-v8a phone, both printing `1-2-3` and exiting 0. From 0.11.0: Kotlin sources (`dist-apk-kotlin`, which declares `xim:kotlin`), R classes, Android libraries from source, local AARs and JARs, a Maven graph through a lock file (`dist-apk-maven`, which declares `xim:coursier`), a manifest merge, and an unsigned package -- see [`dist-apk`: Kotlin, libraries and a Maven graph](#dist-apk-kotlin-libraries-and-a-maven-graph). From 0.11.1 the native libraries are packed as the Android Gradle plugin packs them: each is stripped with the build's own `llvm-strip --strip-unneeded` (the NDK's, beside the compiler `mcpp::toolchain_dir()` reports; `options::keep_debug_symbols` packs them as staged), and a manifest stating `android:extractNativeLibs="false"` gets them stored uncompressed on a 16 KB page, which loading them from the APK in place requires; CI checks both, and the symbol table `keep_debug_symbols` keeps. From 0.12.0 the engine's strip decision governs these libraries as well: under mcpp 2026.9.16.1, which publishes it to build programs as `MCPP_PACK_STRIP` and `MCPP_PACK_DEBUG_SYMBOLS_DIR`, that engine strips and separates the libraries it stages itself and the member packs them as staged, while the libraries the engine did not stage -- an archive's `jni/` libraries -- follow the same decision inside the member: `--no-strip` packs them as they are, and `--debug-symbols <dir>` separates each one's debug information into `<dir>/<abi>/<library>.debug` with `llvm-objcopy` before stripping it and linking the packed copy to that file (`.gnu_debuglink`). A library is stripped unless either `keep_debug_symbols` or the engine says to keep it, and under an older engine, which publishes neither variable, the member strips every library as before. Because that engine strips before the member reads the tree, `keep_debug_symbols` keeps only the member's own strip off and `--no-strip` is what ships the symbols of the libraries the graph built; the member warns when the option is set and the engine stripped. From 0.12.0 a library in the resolved graph contributes libraries and archives through `[package.metadata.dist-apk]`, ranked below the application's own -- see [A library states its contribution](#a-library-states-its-contribution-packagemetadatadist-apk). From 0.23.1 a Java or Kotlin root inside the build's output (`mcpp::out_dir()`, `target/`), which a build program generated, is an input of the `javac` action and declares no re-run glob, which could never match there. From 0.24.0 the member runs on Windows and macOS hosts as on Linux: `d8`, `apksigner`, bundletool, the Kotlin compiler and coursier run from their jars on the JDK's `java`, and the four `/bin/sh` helpers are one Java source file, `DistApk.java`, run by that `java`. From 0.25.0 those four steps are step programs (`tools-steps`): the member describes each and a runner runs it, `cmake -P` until mcpp runs them itself (mcpp-community/mcpp#955); `DistApk.java` is gone, and `options::cmake` names another `cmake`
**Needs and behaviour.** `xim:android-build-tools`, `xim:android-platform` (versioned by API level, read back for `targetSdkVersion`), `xim:jdk-temurin` (`java`/`javac`/`jar`/`jarsigner`; `android-build-tools`' own runtime dependency provisions a JDK for its OWN wrappers only), `xim:android-debug-keystore`, `xim:bundletool` (0.10.0, for `--format aab`), `xim:cmake` (0.25.0, asked for when a package is planned: the runner of the steps of more than one command until mcpp-community/mcpp#955), all on the `cfg(env = "android")` axis. Generates `AndroidManifest.xml` and signs with the published Android debug key by default. Level 0 needs no Java (`hasCode="false"`, `android.app.NativeActivity`); `options::java_sources` adds `javac` + `d8` and a real `<activity>`. `options::manifest_template` renders a project manifest with six tokens substituted verbatim; `{{application_id}}` and `{{activity}}` are required always and `{{lib_name}}` at level 0, each refused by name at plan time when missing (naming `assets/mcpp-run.json`, which `adb-run` reads them from too) or when the template names an unknown token; empty renders 0.8.0's manifest byte-identically. From 0.9.3 the manifest template gains `{{version_name}}` / `{{version_code}}` (the package version, and `major * 1000000 + minor * 1000 + patch`). `options::resources` is a project's own `res/`, linked as the application's base resources from 0.9.1 (0.9.0 linked it as an aapt2 overlay, which refuses every resource the base does not already define -- a launcher icon could not be supplied). `options::java_sources` is an array: one `javac` over every root's `.java` files and one `d8` over the result, so a project's own sources and a path dependency's join without being merged into one directory first, and `rerun_if_changed_glob` is declared only for a root under `mcpp::manifest_dir()` -- a dependency root's files are already inputs of the `javac` action and its version is already in the build's fingerprint. Android only -- an `app` target is a shared object on this row (#622 A3). From 0.10.0, with mcpp 2026.9.14.2, the member reads the native closure the engine stages -- the application object, the graph's shared libraries and `libc++_shared.so` under `lib/` for one `--target`, `lib/<abi>/` for several -- and packs every ABI the tree carries into one APK; its own `NEEDED` walk and the stamp that lost a dependency's library on a second pack are gone. A stage manifest without `needs` lines comes from an engine below 2026.9.14.2 and is refused naming that floor, as is an incomplete closure, naming the unresolved libraries; every refusal is also a `mcpp::warning`, because the engine discards a build program's output when it exits 0. `--format aab` shares every step but the last three: `aapt2 link --proto-format` (with `--version-code` / `--version-name`, which bundletool requires), a base module in the layout bundletool reads, `bundletool build-bundle` from `xim:bundletool` (declared on the same axis), and `jarsigner` with the same keystore. CI packages both level 0 and level 1 and checks the archive (`mcpp::deploy`'d files under `assets/`), and on `tests/apk-consumer-shared` two packs in a row, a two-ABI APK (`aapt2` reports both, `apksigner` verifies it), an App Bundle (`bundletool validate`, `jarsigner -verify`, a universal APK from `bundletool build-apks`), a refusal's reason in `mcpp pack`'s output, and the floor refusal; the runner has no emulator or device, so the two rows that actually run were measured locally on 2026-09-12, through `adb-run`, against a KVM-accelerated x86_64 emulator and a physical arm64-v8a phone, both printing `1-2-3` and exiting 0. From 0.11.0: Kotlin sources (`dist-apk-kotlin`, which declares `xim:kotlin`), R classes, Android libraries from source, local AARs and JARs, a Maven graph through a lock file (`dist-apk-maven`, which declares `xim:coursier`), a manifest merge, and an unsigned package -- see [`dist-apk`: Kotlin, libraries and a Maven graph](#dist-apk-kotlin-libraries-and-a-maven-graph). From 0.11.1 the native libraries are packed as the Android Gradle plugin packs them: each is stripped with the build's own `llvm-strip --strip-unneeded` (the NDK's, beside the compiler `mcpp::toolchain_dir()` reports; `options::keep_debug_symbols` packs them as staged), and a manifest stating `android:extractNativeLibs="false"` gets them stored uncompressed on a 16 KB page, which loading them from the APK in place requires; CI checks both, and the symbol table `keep_debug_symbols` keeps. From 0.12.0 the engine's strip decision governs these libraries as well: under mcpp 2026.9.16.1, which publishes it to build programs as `MCPP_PACK_STRIP` and `MCPP_PACK_DEBUG_SYMBOLS_DIR`, that engine strips and separates the libraries it stages itself and the member packs them as staged, while the libraries the engine did not stage -- an archive's `jni/` libraries -- follow the same decision inside the member: `--no-strip` packs them as they are, and `--debug-symbols <dir>` separates each one's debug information into `<dir>/<abi>/<library>.debug` with `llvm-objcopy` before stripping it and linking the packed copy to that file (`.gnu_debuglink`). A library is stripped unless either `keep_debug_symbols` or the engine says to keep it, and under an older engine, which publishes neither variable, the member strips every library as before. Because that engine strips before the member reads the tree, `keep_debug_symbols` keeps only the member's own strip off and `--no-strip` is what ships the symbols of the libraries the graph built; the member warns when the option is set and the engine stripped. From 0.12.0 a library in the resolved graph contributes libraries and archives through `[package.metadata.dist-apk]`, ranked below the application's own -- see [A library states its contribution](#a-library-states-its-contribution-packagemetadatadist-apk). From 0.23.1 a Java or Kotlin root inside the build's output (`mcpp::out_dir()`, `target/`), which a build program generated, is an input of the `javac` action and declares no re-run glob, which could never match there. From 0.24.0 the member runs on Windows and macOS hosts as on Linux: `d8`, `apksigner`, bundletool, the Kotlin compiler and coursier run from their jars on the JDK's `java`, and the four `/bin/sh` helpers are one Java source file, `DistApk.java`, run by that `java`. From 0.25.0 those four steps are step programs (`tools-steps`): the member describes each and a runner runs it, `cmake -P` until mcpp runs them itself (mcpp-community/mcpp#955); `DistApk.java` is gone, and `options::cmake` names another `cmake`. From 0.26.0 the `javac` and `kotlinc` steps empty their class directories first, so a source that left the package, such as a library no longer in the graph, leaves no class in the next package.

## `dist-apk`: Kotlin, libraries and a Maven graph

Expand Down
2 changes: 1 addition & 1 deletion docs/plugin-development.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ mcpp-index refuses such a package.

```toml
[build-dependencies.mcpp]
plugins = { version = "0.25.0", features = ["plugins-core"], host-module = true, reexport = true }
plugins = { version = "0.26.0", features = ["plugins-core"], host-module = true, reexport = true }
```

`reexport = true` is needed when the plugin's consumers import L2 modules in
Expand Down
2 changes: 1 addition & 1 deletion docs/tools-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Module `mcpp.tools.steps`; engine floor: 2026.10.1.3; implied by `dist-apk` and
| `touch(file)`, `mkdir(dir)` | creates or updates a file, creating its directory; creates a directory |
| `remove(path)`, `remove_glob(pattern)` | removes a file or a tree, or the files a pattern matches; absent is not an error |
| `copy_file(from, to)`, `copy_tree(from, to, if_exists)`, `copy_glob(pattern, dir)`, `rename(from, to)`, `symlink(target, link)` | file operations; `copy_tree` copies a directory's contents, and with `if_exists` skips a source that is not a directory |
| `glob(list, pattern, {recursive, relative_to})` | appends the matching files, sorted, to a named list |
| `glob(list, pattern, {recursive, relative_to, exclude})` | appends the matching files, sorted, to a named list; from 0.26.0 `exclude` drops a match whose whole path matches one of its patterns, where `*` crosses a `/` |
| `append(list, values)`, `require(list, message)` | appends values known at plan time; fails the step with `message` when the list is empty |

Every value is taken verbatim, so a path keeps its spaces, semicolons and backslashes. A list is named by letters, digits and `_`, and starts empty. A pattern's wildcards (`*`, `?`, `[...]`) apply to its last component, and `recursive` matches it in every subdirectory.
Expand Down
2 changes: 1 addition & 1 deletion mcpp.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "plugins"
namespace = "mcpp"
version = "0.25.0"
version = "0.26.0"
# The first mcpp release that speaks protocol 17 (SPEC-013, mcpp#847): the
# platform's directives `mcpp.plugins.platform` states (`link_driver`,
# `link_input`, `artifact_name`, `seal`, `run_host`), the `platform` phase, and
Expand Down
13 changes: 13 additions & 0 deletions tests/all-rules-compile/build.mcpp
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,19 @@ int main() {
"execute_process(COMMAND [==[a b]==] [==[c;d]==] ${mcpp_steps_found}\n"
" WORKING_DIRECTORY [==[w]==]\n COMMAND_ERROR_IS_FATAL ANY)\n";
}
// An exclusion applies to the whole path: `*` crosses a `/`, a character
// a regular expression gives meaning to stands for itself, and `[!...]`
// is a negated set.
{
mcpp::tools::steps::program s;
s.glob("objects", "obj/*.o", { .recursive = true, .exclude = { "*/platform/ios/App/*", "a.b+[!x]?" } });
ok = ok && mcpp::tools::steps::cmake_backend::render(s)
== "set(mcpp_steps_objects)\n"
"file(GLOB_RECURSE mcpp_steps_matched LIST_DIRECTORIES false [==[obj/*.o]==])\n"
"list(FILTER mcpp_steps_matched EXCLUDE REGEX [==[^.*/platform/ios/App/.*$]==])\n"
"list(FILTER mcpp_steps_matched EXCLUDE REGEX [==[^a\\.b\\+[^x].$]==])\n"
"list(APPEND mcpp_steps_objects ${mcpp_steps_matched})\n";
}

// `dist-wix`, `dist-apple` and `dist-web` are neither rules nor tools, but the same
// property is worth asserting on every platform for the same reason: a
Expand Down
Loading
Loading