budget-app/budget-capture/README.md

38 lines
2.2 KiB
Markdown

# budget-capture
Native permission/capture integration for the existing Makepad Budget app.
Financial review and workbook writes belong to `app`, not this crate.
- `src/lib.rs`, `permissions.rs`, `error.rs`: existing Android-style capability and permission facade.
- `src/sys/android`: JNI and Java sources for the tile, movable overlay, fresh projection consent, offline OCR, review and Share to Budget private inbox.
- `src/desktop.rs`: separate desktop tray/one-frame worker facade; does not label desktop capture as an Android tile or projection capability.
- `src/sys/desktop`: macOS/Windows/X11 capture, native trays, and an in-memory Wayland portal/PipeWire backend.
- `src/ocr.rs`: shared embedded, offline OCR engine with bounded input.
- `src/build.rs`: verified build-time model embedding and Java compilation for Cargo/Makepad packaging.
- `tests`: owner-local native, OCR, pixel-buffer, cancellation and Java tests.
## Android stays Gradle-free
Required Java lives directly under `src/sys/android`; there is no Android library
project or Gradle wrapper. The two-member virtual workspace is packaged with
`cargo makepad android build/run -p budget --release`. The existing packaging
metadata and Makepad patch are documented in `../docs/GRADLE_FREE_VALIDATION.md`.
`DrawOverlays` is Settings access, notifications are optional runtime permission
on API 33+, and screen capture is always per-capture consent. `UiRequested` means
only that native UI was queued, not permission or capture success. JNI uses
`robius-android-env` with the Makepad provider, the Activity classloader, and
clears failed-lookup exceptions. Rust and Java share `CapturePermissions`.
There is no Android INTERNET permission, AccessibilityService or screenshot
persistence. Projection stops before OCR; confirmed products enter the host's
private inbox, never an automatic payment.
## Desktop and remaining targets
See `../docs/DESKTOP_CAPTURE.md` for consent, worker/session teardown, native
libraries, platform validation limits and the **HarmonyOS PC SDK blocker**.
The iOS facade remains explicitly unsupported for cross-app tile/overlay
capture. Its optional Swift Vision helper is only for an image supplied by a
future host/share extension; it is not host-integrated or Xcode-tested here.