kingchenc
167f7b3ffe
Adds a Java binding (`bindings/java`) over the C ABI hub — the fourth language stecker after C#, Go and R, reaching the hub through the Java Foreign Function & Memory API (Panama, `java.lang.foreign`, final in Java 22) rather than JNI or jextract. ## What's here - **`bindings/java`** — a Maven module (`org.wickra:wickra`) exposing all 514 indicators as idiomatic `AutoCloseable` classes. The downcall handles (`internal/NativeMethods.java`), the per-indicator wrappers and the output records are generated from `bindings/c/include/wickra.h` (same eight-archetype taxonomy as the C#/Go/R generators: scalar/batch, multi-output, bars, profile, values-profile, array-input). The opaque handle is a `MemorySegment` freed by a registered `java.lang.ref.Cleaner` action; multi-output returns a `record` (`null` at warmup), bars a `record[]`, profiles a record with a trailing `double[]`. The hand-written `WickraNative` resolves the native library (a bundled per-platform copy, or a `target/release` fallback for local development) and validates it against a sentinel symbol. repr(C) struct offsets are computed in the generator so the FFM reads land on the exact bytes. - **`examples/java`** — the full example suite mirroring C/C#/Go/R: streaming, backtest, multi_timeframe, parallel_assets (parallel streams), three strategies, and `FetchBtcusdt`/`LiveBinance`. - **CI** — a `java` job builds the C ABI library, sets up JDK 22 (Temurin, with a CDN-flake retry), runs the archetype test suite and the seven offline examples on Linux, macOS and Windows. - **Release** — a gated `java-publish` job (skipped until the `JAVA_PUBLISH_ENABLED` repository variable is set) stages the native libraries from the `wickra-c-<triple>.tar.gz` assets into the binding's resources and deploys to Maven Central with GPG signing. Independent of the GitHub-release job, like the NuGet job. - **Docs** — Java added to the README languages table, project layout, building/testing and comparison table, CONTRIBUTING, ARCHITECTURE, the examples index, the issue/PR templates, the About-description template, and the other binding READMEs. ## Requirements Java 22+ (the FFM API is final since Java 22). The binding requires `--enable-native-access=ALL-UNNAMED` at runtime; the test and example runners pass it automatically. No Rust crate or `Cargo.toml` change — the Java binding is standalone and additive. The generated `*.java` are committed (like the node `index.js`/`index.d.ts`); the generator stays private.
38 lines
1.8 KiB
Markdown
38 lines
1.8 KiB
Markdown
# Roadmap
|
|
|
|
This roadmap describes the project's direction at a high level. It is
|
|
intentionally non-binding: priorities shift with feedback and available time,
|
|
and the authoritative, up-to-date view of planned work is the
|
|
[issue tracker](https://github.com/wickra-lib/wickra/issues). Shipped changes
|
|
are recorded in [`CHANGELOG.md`](CHANGELOG.md).
|
|
|
|
## Status
|
|
|
|
Wickra is **pre-1.0**. The public API is largely stable but may still change in
|
|
minor releases; breaking changes are called out in the changelog.
|
|
|
|
## Themes
|
|
|
|
- **Indicator coverage.** Continue broadening the indicator catalogue across
|
|
families (trend, momentum, volatility, volume, statistics, market profile,
|
|
and more), each with the same streaming/batch parity and test guarantees.
|
|
- **API stabilization toward 1.0.** Settle the public `Indicator` and
|
|
`BarBuilder` traits and the binding surfaces, then commit to semantic
|
|
versioning stability for a 1.0 release.
|
|
- **Performance.** Keep per-tick updates O(1) and maintain the benchmark suite;
|
|
investigate further allocation and cache improvements.
|
|
- **Bindings parity.** Keep the Python, Node.js and WebAssembly bindings — plus
|
|
the C ABI and the C# / .NET, Go, Java and R bindings generated from it — in lockstep with the
|
|
Rust core, including type stubs and platform coverage.
|
|
- **Documentation.** Maintain a deep-dive page per indicator on
|
|
<https://docs.wickra.org>, plus quickstarts and cookbook material.
|
|
- **Project health.** Maintain test coverage, static and dynamic analysis,
|
|
signed releases, and supply-chain monitoring.
|
|
|
|
## How to influence the roadmap
|
|
|
|
Open or comment on an issue, or start with the
|
|
[feature-request template](.github/ISSUE_TEMPLATE/feature_request.md).
|
|
Well-scoped proposals and pull requests are the most effective way to move an
|
|
item forward.
|