mirror of
https://github.com/dexoron/dcr.git
synced 2026-10-21 12:28:30 +00:00
Added:
- `dcr gen` command for IDE integration and build tool support
- `dcr gen project-info`: Output project metadata as JSON
- `dcr gen compile-commands`: Generate `compile_commands.json` for clangd and clang-tidy
- `dcr gen vscode`: Generate VS Code `.vscode/` integration (launch.json, tasks.json, settings.json)
- `dcr gen clion`: Generate JetBrains CLion `.idea/` integration (run configurations, build targets)
- Full workspace support for all `gen` subcommands
This commit is contained in:
@@ -18,12 +18,19 @@ Current DCR focuses on a simple, predictable workflow:
|
||||
- C++: `*.cpp`, `*.cxx`, `*.cc`
|
||||
- Compiler selection from `dcr.toml` (`clang`, `gcc`, `cl`, `clang-cl`, etc.).
|
||||
- ASM support via `language = "asm"` (GCC/Clang, NASM, GAS).
|
||||
- Mixed language builds via `language = ["c", "asm"]` and similar combinations.
|
||||
- Three build kinds:
|
||||
- `bin` (default)
|
||||
- `staticlib`
|
||||
- `sharedlib`
|
||||
- Optional custom output directory via `build.target`.
|
||||
- Optional `build.platform` to pass architecture hints (`-march` / `/arch`).
|
||||
- Optional `build.exclude`/`build.include` for source/header selection.
|
||||
- Optional `build.roots`/`build.src_disable` to replace the default `src/` root.
|
||||
- Optional build steps with `build.steps` and `build.post_steps`.
|
||||
- Optional `build.pkg_config` integration.
|
||||
- Optional `build.clean` and `build.expect`.
|
||||
- Optional `[run].cmd` to override run command.
|
||||
- Workspace builds via `[workspace]` with per-project `dcr.toml`.
|
||||
- Path dependencies with include/lib resolution and `dcr.lock` generation.
|
||||
|
||||
@@ -31,7 +38,7 @@ Current DCR focuses on a simple, predictable workflow:
|
||||
|
||||
- `dcr.toml` is required for `build`, `run`, and `clean`.
|
||||
- `run` works only with `build.kind = "bin"`.
|
||||
- Incremental rebuild currently tracks source file timestamps (not header dependency graphs).
|
||||
- Incremental rebuild tracks source file timestamps and header dependencies (rebuilds when either source or included headers change).
|
||||
- Object files are always created under `target/<profile>/obj/`.
|
||||
|
||||
## Repository
|
||||
|
||||
@@ -24,6 +24,7 @@
|
||||
* [dcr build](commands/dcr-build.md)
|
||||
* [dcr run](commands/dcr-run.md)
|
||||
* [dcr clean](commands/dcr-clean.md)
|
||||
* [dcr gen](commands/dcr-gen.md)
|
||||
|
||||
## Dependencies & Build
|
||||
|
||||
|
||||
@@ -8,6 +8,8 @@ Builds the project in `debug` or `release` profile.
|
||||
dcr build
|
||||
dcr build --debug
|
||||
dcr build --release
|
||||
dcr build --release --force
|
||||
dcr build --debug --clean
|
||||
```
|
||||
|
||||
## What `build` does
|
||||
@@ -30,17 +32,33 @@ dcr build --release
|
||||
- `build.platform`
|
||||
- `build.cflags`
|
||||
- `build.ldflags`
|
||||
- `build.debug` / `build.release`
|
||||
- `build.exclude`
|
||||
- `build.include`
|
||||
- `build.pkg_config`
|
||||
- `build.steps`
|
||||
- `build.post_steps`
|
||||
- `build.generated`
|
||||
- `build.expect`
|
||||
- `build.clean`
|
||||
|
||||
## Source selection
|
||||
|
||||
- `language = "c"` -> `*.c`
|
||||
- `language = "c++" | "cpp" | "cxx"` -> `*.cpp`, `*.cxx`, `*.cc`
|
||||
- `language = "asm"` -> `*.s`, `*.S`, `*.asm`
|
||||
- Mixed languages are supported with arrays, for example `language = ["c", "asm"]`.
|
||||
- By default sources are searched in `src/`; use `build.roots` and `build.src_disable` to override.
|
||||
|
||||
## Notes
|
||||
|
||||
- The profile is selected from the first argument only.
|
||||
- Unknown profile flags return an error.
|
||||
- Incremental rebuild is based on source/object mtime comparison.
|
||||
- `--force` skips build cache checks and recompiles.
|
||||
- `--clean` removes `target/<profile>` and `build.clean` paths before building.
|
||||
- For `language = "asm"` with `compiler = "as"`/`"gas"`, use `.s` files (no preprocessing). For `.S`, use `gcc` or `clang`.
|
||||
- In workspace root, `dcr build` builds all members in dependency order.
|
||||
- `build.exclude` removes paths from source/header collection; `build.include` re-allows matching paths and has priority over `exclude`.
|
||||
- `build.steps` run before compilation; `build.post_steps` run after linking.
|
||||
- `build.generated` is cleaned when `build.steps` need to rerun; `build.expect` is verified after post-steps.
|
||||
|
||||
@@ -17,6 +17,8 @@ dcr clean --release --all
|
||||
- Without arguments: removes entire `target/`.
|
||||
- With profile: removes only `target/<profile>/`.
|
||||
- With `--all`: also cleans all workspace members.
|
||||
- Additionally removes paths from `build.clean` if configured.
|
||||
- `build.clean` supports `{profile}` and version placeholders.
|
||||
|
||||
## Validation
|
||||
|
||||
|
||||
@@ -8,6 +8,8 @@ Builds the project and runs the resulting binary.
|
||||
dcr run
|
||||
dcr run --debug
|
||||
dcr run --release
|
||||
dcr run --release --force
|
||||
dcr run --debug --clean
|
||||
```
|
||||
|
||||
## Behavior
|
||||
@@ -16,11 +18,20 @@ dcr run --release
|
||||
2. Reads `package.name`, `build.kind`, and optional `build.target`.
|
||||
3. Runs the same build flow as `dcr build`.
|
||||
4. Executes the built artifact path for the selected profile.
|
||||
5. If `[run].cmd` is set, runs that command instead of the built binary.
|
||||
|
||||
## Restrictions
|
||||
|
||||
- If `build.kind = "staticlib"` or `build.kind = "sharedlib"`, `run` exits with error.
|
||||
- The profile is selected from the first argument.
|
||||
- `--force` skips build cache checks and recompiles.
|
||||
- `--clean` removes `target/<profile>` and `build.clean` paths before building.
|
||||
|
||||
## `run.cmd` variables
|
||||
|
||||
`run.cmd` supports the same variables as build steps: `{profile}`, `{version}`, `{version_major}`,
|
||||
`{version_minor}`, `{version_patch}`, `{version_suffix}`, `{version_suffix_dash}`.
|
||||
The command runs via `sh -c` on Unix and `cmd /C` on Windows.
|
||||
|
||||
## On build failure
|
||||
|
||||
|
||||
@@ -14,6 +14,8 @@ dcr run --release
|
||||
dcr clean --debug
|
||||
```
|
||||
|
||||
You can also add `--force` or `--clean` to `build`/`run`.
|
||||
|
||||
## Default profile flags
|
||||
|
||||
### GCC/Clang-like toolchains
|
||||
@@ -55,3 +57,18 @@ Shared library mode (`kind = "sharedlib"`):
|
||||
- Linux: `lib<name>.so`
|
||||
- macOS: `lib<name>.dylib`
|
||||
- Windows: `<name>.dll`
|
||||
|
||||
## Profile overrides
|
||||
|
||||
Use `[build.debug]` and `[build.release]` to override build settings per profile.
|
||||
All values inherit from `[build]`. If a field is present in the profile table, it replaces the base value.
|
||||
For arrays (like `cflags`/`ldflags`), the profile value is appended to the base array.
|
||||
|
||||
```toml
|
||||
[build.debug]
|
||||
cflags = ["-g3"]
|
||||
|
||||
[build.release]
|
||||
cflags = ["-O3"]
|
||||
ldflags = ["-s"]
|
||||
```
|
||||
|
||||
@@ -13,11 +13,20 @@ kind = "bin"
|
||||
# platform = "x86_64"
|
||||
# cflags = ["-Wall"]
|
||||
# ldflags = ["-lm"]
|
||||
# exclude = ["src/vendor", "src/legacy/**"]
|
||||
# include = ["src/legacy/boot/**"]
|
||||
# roots = ["kernel", "drivers"]
|
||||
# src_disable = true
|
||||
# pkg_config = ["Qt6Core", "Qt6Widgets"]
|
||||
# generated = ["src/ui/*.h"]
|
||||
# expect = ["./target/{profile}/boot/*.bin"]
|
||||
# clean = ["./target/{profile}/boot", "/tmp/image/*.img"]
|
||||
```
|
||||
|
||||
## Fields
|
||||
|
||||
- `language` (string, required): `c`, `c++`, `cpp`, `cxx`, or `asm`.
|
||||
- `language` (string or array, required): `c`, `c++`, `cpp`, `cxx`, or `asm`.
|
||||
Mixed languages can be specified as an array, for example `["c", "c++", "asm"]`.
|
||||
- `standard` (string, required): language standard passed to compiler.
|
||||
- `compiler` (string, required): compiler command (for example `clang`, `gcc`, `cl`).
|
||||
- `kind` (string, required): `bin`, `staticlib`, or `sharedlib`.
|
||||
@@ -25,6 +34,62 @@ kind = "bin"
|
||||
- `platform` (string, optional): architecture hint for compiler (used for `-march` or `/arch`).
|
||||
- `cflags` (string array, optional): extra compile flags.
|
||||
- `ldflags` (string array, optional): extra link flags.
|
||||
- `exclude` (string array, optional): paths or glob patterns to skip during source/header collection.
|
||||
- `include` (string array, optional): allowlist paths or globs that override `exclude`.
|
||||
- `include` directory entries (non-glob) are also passed to the compiler as `-I` include paths.
|
||||
- `roots` (string array, optional): additional source roots to scan instead of `src/`.
|
||||
- `src_disable` (bool, optional): disables default `src/` root when true.
|
||||
- `pkg_config` (string array, optional): packages used to append `pkg-config --cflags/--libs`.
|
||||
- `generated` (string array, optional): generated files to delete when build steps rerun.
|
||||
- `expect` (string array, optional): artifacts that must exist after build/post-steps.
|
||||
- `clean` (string array, optional): additional paths removed by `dcr clean` and `--clean`.
|
||||
|
||||
Notes for `exclude`/`include`:
|
||||
- Supports `*` and `**` glob patterns.
|
||||
- If `include` is set, it has priority over `exclude`.
|
||||
- Use `include` to re-allow nested paths, for example exclude `src/boot` but allow `src/boot/arch/**`.
|
||||
When using glob patterns in `exclude`, DCR converts them internally, so `exclude` globs still work as expected.
|
||||
|
||||
### Build steps
|
||||
|
||||
Build steps run shell commands before compilation. Post steps run after linking.
|
||||
|
||||
```toml
|
||||
[[build.steps]]
|
||||
name = "uic"
|
||||
in = "src/ui/*.ui"
|
||||
out = "src/ui/{stem}.h"
|
||||
cmd = "{uic} {in} -o {out}"
|
||||
|
||||
[[build.post_steps]]
|
||||
name = "image"
|
||||
in = "target/{profile}/boot/*.bin"
|
||||
out = "/tmp/image/os-{version}.img"
|
||||
cmd = "dd if=/dev/zero of={out} bs=1M count=8"
|
||||
```
|
||||
|
||||
Step notes:
|
||||
- `in` supports glob patterns.
|
||||
- If `in` expands to multiple files, `out` must include `{stem}`.
|
||||
- Steps run only when inputs are newer than outputs.
|
||||
- Variables: `{in}`, `{out}`, `{stem}`, `{cflags}`, `{uic}`, `{moc}`, `{rcc}`, `{profile}`,
|
||||
`{version}`, `{version_major}`, `{version_minor}`, `{version_patch}`, `{version_suffix}`, `{version_suffix_dash}`.
|
||||
|
||||
`build.clean` supports `{profile}` and version placeholders (`{version}`, `{version_major}`, ...).
|
||||
|
||||
### Profile overrides
|
||||
|
||||
Profile tables inherit all values from `[build]`. Any field present in the profile table replaces the base value.
|
||||
Array fields (like `cflags`/`ldflags`) are appended to the base array.
|
||||
|
||||
```toml
|
||||
[build.debug]
|
||||
cflags = ["-g3"]
|
||||
|
||||
[build.release]
|
||||
cflags = ["-O3"]
|
||||
ldflags = ["-s"]
|
||||
```
|
||||
|
||||
## Toolchain section
|
||||
|
||||
@@ -35,6 +100,9 @@ cxx = "clang++"
|
||||
as = "as"
|
||||
ar = "ar"
|
||||
ld = "ld"
|
||||
uic = "uic"
|
||||
moc = "moc"
|
||||
rcc = "rcc"
|
||||
```
|
||||
|
||||
## Behavior notes
|
||||
|
||||
@@ -45,6 +45,19 @@ Workspace-only root:
|
||||
- `build.target`
|
||||
- `build.cflags`
|
||||
- `build.ldflags`
|
||||
- `build.exclude`
|
||||
- `build.include`
|
||||
- `build.roots`
|
||||
- `build.src_disable`
|
||||
- `build.pkg_config`
|
||||
- `build.steps`
|
||||
- `build.post_steps`
|
||||
- `build.generated`
|
||||
- `build.expect`
|
||||
- `build.clean`
|
||||
- `build.debug`
|
||||
- `build.release`
|
||||
- dependency fields (`include`, `lib`, `libs`, `system`)
|
||||
- `[toolchain]` overrides (`cc`, `cxx`, `as`, `ar`, `ld`)
|
||||
- `[toolchain]` overrides (`cc`, `cxx`, `as`, `ar`, `ld`, `uic`, `moc`, `rcc`)
|
||||
- `[workspace]` members
|
||||
- `[run]` overrides (`cmd`)
|
||||
|
||||
@@ -15,8 +15,11 @@ DCR picks a backend from `build.compiler`:
|
||||
## Compilation model
|
||||
|
||||
- Source files are found recursively in `src/` based on `build.language`.
|
||||
- `build.roots` and `build.src_disable` can replace the default `src/` root.
|
||||
- Mixed language builds use arrays, for example `build.language = ["c", "asm"]`.
|
||||
- Each source is compiled to `target/<profile>/obj/<relative-path>.o` (`.obj` on MSVC).
|
||||
- Recompile happens when source mtime is newer than object mtime.
|
||||
- `build.exclude` removes paths from source/header collection; `build.include` re-allows matching paths and has priority over `exclude`.
|
||||
|
||||
## Default build flags
|
||||
|
||||
@@ -46,10 +49,12 @@ If `[toolchain]` is set, DCR uses its values to override compiler/linker tools:
|
||||
- `cc`, `cxx`, `as` override compilers for C/C++/ASM
|
||||
- `ar` overrides the archiver (used for `staticlib`)
|
||||
- `ld` overrides the linker (used by GCC/Clang/NASM/GAS backends)
|
||||
- `uic`, `moc`, `rcc` override Qt tools used in `build.steps`
|
||||
|
||||
Environment overrides (highest priority):
|
||||
- `DCR_COMPILER` (all languages)
|
||||
- `DCR_CC`, `DCR_CXX`, `DCR_AS`, `DCR_AR`, `DCR_LD`
|
||||
- `DCR_DEBUG` enables verbose build logging
|
||||
|
||||
## Linking
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@ Debug (default):
|
||||
dcr build
|
||||
# or
|
||||
dcr build --debug
|
||||
dcr build --debug --clean
|
||||
```
|
||||
|
||||
Release:
|
||||
@@ -22,6 +23,7 @@ dcr build --release
|
||||
dcr run
|
||||
# or
|
||||
dcr run --release
|
||||
dcr run --release --force
|
||||
```
|
||||
|
||||
`dcr run` first builds, then launches the produced binary.
|
||||
@@ -47,3 +49,4 @@ dcr clean --release --all
|
||||
- Build profile flag is parsed from the first command argument.
|
||||
- Unknown profile flags produce an error.
|
||||
- In workspace root, `clean --all` cleans all member projects.
|
||||
- `--clean` for `build`/`run` removes `target/<profile>` and paths from `build.clean`.
|
||||
|
||||
@@ -8,7 +8,7 @@ name = "string" # required
|
||||
version = "string" # required
|
||||
|
||||
[build]
|
||||
language = "c|c++|cpp|cxx|asm" # required
|
||||
language = "c|c++|cpp|cxx|asm" # required (string or array)
|
||||
standard = "string" # required
|
||||
compiler = "string" # required
|
||||
kind = "bin|staticlib|sharedlib" # required
|
||||
@@ -16,6 +16,42 @@ target = "string" # optional
|
||||
platform = "string" # optional
|
||||
cflags = ["string", "..."] # optional
|
||||
ldflags = ["string", "..."] # optional
|
||||
exclude = ["string", "..."] # optional
|
||||
include = ["string", "..."] # optional
|
||||
roots = ["string", "..."] # optional
|
||||
src_disable = false # optional
|
||||
pkg_config = ["string", "..."] # optional
|
||||
generated = ["string", "..."] # optional
|
||||
expect = ["string", "..."] # optional
|
||||
clean = ["string", "..."] # optional
|
||||
|
||||
[[build.steps]]
|
||||
name = "string"
|
||||
in = "glob"
|
||||
out = "path or glob"
|
||||
cmd = "string"
|
||||
|
||||
[[build.post_steps]]
|
||||
name = "string"
|
||||
in = "glob"
|
||||
out = "path or glob"
|
||||
cmd = "string"
|
||||
|
||||
# Inline array form (equivalent to [[build.steps]] / [[build.post_steps]])
|
||||
steps = [
|
||||
{ name = "string", in = "glob", out = "path or glob", cmd = "string" },
|
||||
]
|
||||
post_steps = [
|
||||
{ name = "string", in = "glob", out = "path or glob", cmd = "string" },
|
||||
]
|
||||
|
||||
[build.debug]
|
||||
cflags = ["string", "..."] # optional
|
||||
ldflags = ["string", "..."] # optional
|
||||
|
||||
[build.release]
|
||||
cflags = ["string", "..."] # optional
|
||||
ldflags = ["string", "..."] # optional
|
||||
|
||||
[toolchain]
|
||||
cc = "string" # optional
|
||||
@@ -23,6 +59,12 @@ cxx = "string" # optional
|
||||
as = "string" # optional
|
||||
ar = "string" # optional
|
||||
ld = "string" # optional
|
||||
uic = "string" # optional
|
||||
moc = "string" # optional
|
||||
rcc = "string" # optional
|
||||
|
||||
[run]
|
||||
cmd = "string" # optional
|
||||
|
||||
[workspace]
|
||||
name = { path = "string", deps = ["string", "..."] }
|
||||
@@ -42,6 +84,15 @@ name = {
|
||||
- Required string fields must be non-empty.
|
||||
- `build.kind` must be `bin`, `staticlib`, or `sharedlib`.
|
||||
- Dependency fields `include/lib/libs` must be string arrays when provided.
|
||||
- `build.exclude`/`build.include` must be string arrays when provided.
|
||||
- `build.roots` must be a string array when provided.
|
||||
- `build.src_disable` must be boolean when provided.
|
||||
- `build.clean`/`build.generated`/`build.pkg_config`/`build.expect` must be string arrays when provided.
|
||||
- `build.debug`/`build.release` must be tables; their `cflags`/`ldflags` must be string arrays.
|
||||
- `build.steps`/`build.post_steps` entries must include `name`, `in`, `out`, `cmd`.
|
||||
- `build.language` may be a string or array (for example `["c", "c++", "asm"]`).
|
||||
- `[build.<profile>]` tables inherit all base values and override any fields they specify.
|
||||
Array fields (like `cflags`/`ldflags`) are appended to the base array.
|
||||
|
||||
## Generated defaults (`dcr new` / `dcr init`)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user