diff --git a/docs/modernization/build-inventory.md b/docs/modernization/build-inventory.md index f63cdb0..cae6703 100644 --- a/docs/modernization/build-inventory.md +++ b/docs/modernization/build-inventory.md @@ -303,13 +303,15 @@ powershell -ExecutionPolicy Bypass -File scripts\automation\apple-remote-build.p app-core write/publish executor to the planned retained face filename set and falls back to `Canvas::export_cube_faces` if snapshot capture, PNG generation, or file writing fails. PNG equirectangular export writes a pure - document/paint-renderer equirectangular PNG before falling back to the - retained writer. Payload-complete layer and animation-frame PNG collections + document/paint-renderer equirectangular PNG through the app-core file + write/publish executor before falling back to the retained writer. + Payload-complete layer and animation-frame PNG collections write pure document/paint-renderer equirectangular PNG sequences through the app-core collection write/publish executor before retained fallback. JPEG equirectangular export writes a pure document/paint-renderer JPEG with GPano - XMP metadata before retained fallback; Web handoff, incomplete-readback - collection cases, and video export remain on retained writer paths. Depth + XMP metadata through the same app-core file write/publish executor before + retained fallback; Web handoff, incomplete-readback collection cases, and + video export remain on retained writer paths. Depth export now plans the retained image/depth output paths in `pp_app_core` and logs a tested `pp_paint_renderer` depth render plan plus the shared document-frame renderer-readiness report before retained @@ -1188,14 +1190,15 @@ powershell -ExecutionPolicy Bypass -File scripts\automation\apple-remote-build.p app-core planned legacy work-directory face paths through the app-core write/publish executor before falling back to the retained writer, PNG equirectangular export writes the pure document/paint-renderer - equirectangular PNG before retained fallback, payload-complete layer and + equirectangular PNG through the app-core file write/publish executor before + retained fallback, payload-complete layer and animation-frame collections write pure document/paint-renderer PNG sequences through the app-core collection write/publish executor, depth export plans image/depth targets and logs the paint-renderer render plan plus shared renderer readiness before retained execution, and JPEG equirectangular export - writes a pure document/paint-renderer JPEG with GPano XMP metadata before - retained fallback while Web/incomplete-readback collection cases remain on - older retained paths. It + writes a pure document/paint-renderer JPEG with GPano XMP metadata through + the same app-core file write/publish executor before retained fallback while + Web/incomplete-readback collection cases remain on older retained paths. It also bridges timelapse and animation MP4 export picker-selected paths while preserving desktop worker-thread timelapse behavior, mobile/Web save callbacks, `App::rec_export`, animation `Canvas::export_anim_mp4`, and diff --git a/docs/modernization/debt.md b/docs/modernization/debt.md index e184144..66eeac5 100644 --- a/docs/modernization/debt.md +++ b/docs/modernization/debt.md @@ -606,6 +606,13 @@ agent or engineer to remove them without reconstructing context from chat. unsupported-target JSON contract. The actual depth perspective render, depth-payload readback, write execution, progress/threading parity, and retained Web handoff remain open. +- 2026-06-06: DEBT-0010/DEBT-0043 were narrowed again. `pp_app_core` now owns a + tested single-file export write/publish executor, and the live PNG/JPEG + equirectangular document-snapshot writer uses it before retained fallback. + The retained bridge still provides the filesystem/publish adapter, while + Web prepared-file handoff, incomplete-readback collection fallback, + depth/video export execution, progress/threading parity, and broader storage + service ownership remain open. - 2026-06-05: DEBT-0010/DEBT-0036/DEBT-0043 were narrowed again. `pp_paint_renderer` now exports independent layer equirectangular PNGs and merged animation-frame equirectangular PNGs from payload-complete @@ -650,7 +657,7 @@ agent or engineer to remove them without reconstructing context from chat. | DEBT-0007 | Open | Modernization | `vcpkg.json` and `windows-msvc-vcpkg-headless` are validated for the headless Windows component matrix, and root CMake now exposes a focused `panopainter_platform_build_vcpkg_ui_core` target for the vcpkg-backed `pp_ui_core`/tinyxml2 boundary, but app targets still use vendored libraries and Android/Apple triplets are not proven | Dependency migration must stay incremental while SDK/patched/vendor dependencies remain in use | `cmake --preset windows-msvc-vcpkg-headless`; `ctest --preset desktop-fast-vcpkg --build-config Debug`; `cmake --build --preset windows-msvc-default --config Debug --target panopainter_platform_build_vcpkg_ui_core` | Component targets consume vcpkg packages where reliable and desktop app, Android, and Apple triplets are validated or explicitly documented as permanent vendor exceptions | | DEBT-0008 | Open | Modernization | `windows-msvc-default` and `windows-msvc-vcpkg-headless` explicitly select Visual Studio 18 2026 for local validation, but non-VS2026 CMake executables on PATH may not know that generator | The local machine has VS 2026, but using an older CMake can still default to Ninja or reject the VS 2026 generator | `cmake --preset windows-msvc-default`; `cmake --build --preset windows-msvc-default --config Debug --target PanoPainter`; `ctest --preset desktop-fast --build-config Debug` | The repo automation invokes or locates a CMake executable that supports `Visual Studio 18 2026`, and VS 2026 generator validation is the normal Windows path without manual tool selection | | DEBT-0009 | Open | Modernization | Android root CMake validation currently builds headless targets only, while retained standard/Quest/Focus package CMake paths now have a refreshed CMake 3.10/C++23 baseline outside root CMake; automation queries `sdkmanager`, installs newer or missing SDK Manager NDK/CMake packages, selects the resulting pair before configure, and reports update decisions; root CMake exposes non-default platform-build and retained native package validation targets | Platform app entrypoints still live in legacy Gradle/CMake projects and need Phase 6 alignment | `powershell -ExecutionPolicy Bypass -File scripts\automation\platform-build.ps1 -Presets android-arm64`; `cmake --build --preset android-x64`; `cmake --build --preset android-quest-arm64`; `cmake --build --preset android-focus-arm64`; `cmake --build --preset windows-msvc-default --config Debug --target panopainter_platform_build_android_assets`; `powershell -ExecutionPolicy Bypass -File scripts\automation\android-legacy-package-build.ps1 -Packages standard`; `powershell -ExecutionPolicy Bypass -File scripts\automation\android-legacy-package-build.ps1 -Packages quest,focus -ConfigureOnly`; `powershell -ExecutionPolicy Bypass -File scripts\automation\package-smoke.ps1 -ReadinessOnly -AndroidNativeChecks -PackageKinds android-standard-apk,android-quest-apk,android-focus-apk`; `cmake --build --preset windows-msvc-default --config Debug --target panopainter_android_native_package_smoke` | Android standard, Quest, and Focus/Wave package targets consume shared component targets and have package smoke commands | -| DEBT-0010 | Open | Modernization | `pp_document` is a pure layer/frame/document/undo-history model with alpha-lock metadata, snapshot construction, per-layer frame metadata, renderer-free RGBA8 face payload storage, snapshot-embedded face-payload validation, renderer-free alpha8 selection-mask storage, PPI import/export helpers, stroke-script-to-face-payload CLI automation, `pp_paint_renderer` document face/frame compositors, renderer-neutral six-face texture upload, pure six-face PNG export, pure equirectangular PNG export, pure equirectangular JPEG+XMP export, pure layer/animation-frame PNG collection export, shared document-frame export readiness reporting, depth export render-plan reporting, OpenGL command-planner validation through CLI render automation, live Canvas snapshot projection through `pp_app_core`/`legacy_document_canvas_services`, captured RGBA8 payload attachment to `pp_document`, live Save/Save As/Save Version/save-before-workflow snapshot-readiness reporting before retained save execution, pure app-core PPI export for payload-complete canvas snapshots, payload-complete canvas-snapshot renderer-upload plus face-PNG export automation, live cube-face face-PNG writer execution using app-core face target planning and write/publish service dispatch with retained fallback, live PNG/JPEG equirectangular writer execution using the paint-renderer equirectangular exports with retained fallback, live payload-complete layer/animation-frame collection writer execution using paint-renderer PNG sequences and app-core collection write/publish dispatch with retained fallback, tested app-core document-snapshot export route policy for writer versus retained fallback including current-platform support, and live equirectangular/layer/animation-frame/depth/cube-face export snapshot/render/export-readiness reporting through the shared readiness helper plus the depth render plan, but action-command adoption, live save-writer replacement, Web and incomplete-readback collection handoff, progress/threading parity, broader renderer-owned export execution, exact GPU/golden parity, depth render/readback replacement, and renderer-owned cube-face readback ownership are not yet wired | Keep extraction incremental while preserving app behavior | `ctest --preset desktop-fast --build-config Debug`; `pano_cli create-document --width 64 --height 32 --layers 2`; `pano_cli load-project --path tests\data\projects\minimal-project.ppi`; `pano_cli simulate-document-render --width 64 --height 32`; `pano_cli plan-canvas-document-snapshot --width 64 --height 32`; `pano_cli plan-canvas-document-snapshot --captured-face-payloads-per-layer 1`; `pano_cli plan-export-snapshot-route --kind layers-collection --captured-face-payloads 3 --pending-face-payloads 6`; `pp_document_tests`; `pp_document_ppi_import_tests`; `pp_document_ppi_export_tests`; `pp_paint_renderer_compositor_tests`; `pp_app_core_document_canvas_tests`; `pp_app_core_document_export_tests`; `pano_cli_simulate_document_edits_smoke`; `pano_cli_simulate_document_export_smoke`; `pano_cli_simulate_document_render_smoke`; `pano_cli_plan_canvas_document_snapshot_smoke`; `pano_cli_plan_canvas_document_snapshot_payload_smoke`; `pano_cli_plan_export_snapshot_route_pending_smoke`; `pano_cli_save_document_project_roundtrip_smoke`; `pano_cli_apply_stroke_script_roundtrip_smoke`; `pano_cli_apply_stroke_script_rejects_tiny_canvas` | Legacy document behavior is represented by `pp_document`/`pp_paint_renderer` tests and the app consumes it through a boundary/facade | +| DEBT-0010 | Open | Modernization | `pp_document` is a pure layer/frame/document/undo-history model with alpha-lock metadata, snapshot construction, per-layer frame metadata, renderer-free RGBA8 face payload storage, snapshot-embedded face-payload validation, renderer-free alpha8 selection-mask storage, PPI import/export helpers, stroke-script-to-face-payload CLI automation, `pp_paint_renderer` document face/frame compositors, renderer-neutral six-face texture upload, pure six-face PNG export, pure equirectangular PNG export, pure equirectangular JPEG+XMP export, pure layer/animation-frame PNG collection export, shared document-frame export readiness reporting, depth export render-plan reporting, OpenGL command-planner validation through CLI render automation, live Canvas snapshot projection through `pp_app_core`/`legacy_document_canvas_services`, captured RGBA8 payload attachment to `pp_document`, live Save/Save As/Save Version/save-before-workflow snapshot-readiness reporting before retained save execution, pure app-core PPI export for payload-complete canvas snapshots, payload-complete canvas-snapshot renderer-upload plus face-PNG export automation, live cube-face face-PNG writer execution using app-core face target planning and write/publish service dispatch with retained fallback, live PNG/JPEG equirectangular writer execution using the paint-renderer equirectangular exports plus app-core file write/publish dispatch with retained fallback, live payload-complete layer/animation-frame collection writer execution using paint-renderer PNG sequences and app-core collection write/publish dispatch with retained fallback, tested app-core document-snapshot export route policy for writer versus retained fallback including current-platform support, and live equirectangular/layer/animation-frame/depth/cube-face export snapshot/render/export-readiness reporting through the shared readiness helper plus the depth render plan, but action-command adoption, live save-writer replacement, Web and incomplete-readback collection handoff, progress/threading parity, broader renderer-owned export execution, exact GPU/golden parity, depth render/readback replacement, and renderer-owned cube-face readback ownership are not yet wired | Keep extraction incremental while preserving app behavior | `ctest --preset desktop-fast --build-config Debug`; `pano_cli create-document --width 64 --height 32 --layers 2`; `pano_cli load-project --path tests\data\projects\minimal-project.ppi`; `pano_cli simulate-document-render --width 64 --height 32`; `pano_cli plan-canvas-document-snapshot --width 64 --height 32`; `pano_cli plan-canvas-document-snapshot --captured-face-payloads-per-layer 1`; `pano_cli plan-export-snapshot-route --kind layers-collection --captured-face-payloads 3 --pending-face-payloads 6`; `pp_document_tests`; `pp_document_ppi_import_tests`; `pp_document_ppi_export_tests`; `pp_paint_renderer_compositor_tests`; `pp_app_core_document_canvas_tests`; `pp_app_core_document_export_tests`; `pano_cli_simulate_document_edits_smoke`; `pano_cli_simulate_document_export_smoke`; `pano_cli_simulate_document_render_smoke`; `pano_cli_plan_canvas_document_snapshot_smoke`; `pano_cli_plan_canvas_document_snapshot_payload_smoke`; `pano_cli_plan_export_snapshot_route_pending_smoke`; `pano_cli_save_document_project_roundtrip_smoke`; `pano_cli_apply_stroke_script_roundtrip_smoke`; `pano_cli_apply_stroke_script_rejects_tiny_canvas` | Legacy document behavior is represented by `pp_document`/`pp_paint_renderer` tests and the app consumes it through a boundary/facade | | DEBT-0011 | Open | Modernization | `package-smoke` validates the Windows CMake app artifact and launch-folder DLL payload, and reports a structured package readiness matrix for Windows AppX, Android standard/Quest/Focus APKs, Apple bundles, Linux app output, and WebGL output; the Windows app smoke passes the configure-time CMake executable so VS 2026 generator validation does not depend on `cmake` from PATH, retained Android package native CMake paths, and retained Linux/WebGL CMake baseline metadata are reachable from package validation and root CMake package-readiness targets, but Windows AppX/APK/Linux/Apple/WebGL package outputs are still `blocked` because root CMake package targets do not exist yet | Platform package targets are not migrated to root CMake yet | `powershell -ExecutionPolicy Bypass -File scripts\automation\package-smoke.ps1 -Preset windows-msvc-default -Configuration Debug`; `cmake --build --preset windows-msvc-default --config Debug --target panopainter_windows_app_package_smoke`; `powershell -ExecutionPolicy Bypass -File scripts\automation\package-smoke.ps1 -ReadinessOnly -AndroidNativeChecks -PackageKinds android-standard-apk,android-quest-apk,android-focus-apk`; `cmake --build --preset windows-msvc-default --config Debug --target panopainter_android_native_package_smoke`; `cmake --build --preset windows-msvc-default --config Debug --target panopainter_linux_webgl_package_readiness`; `python scripts/dev/check_package_smoke_readiness.py`; `bash -n scripts/automation/package-smoke.sh` | Package-smoke builds and validates Windows AppX, Android APK variants, Linux app, Apple bundles, and WebGL output where local toolchains are present | | DEBT-0012 | Open | Modernization | `pp_ui_core` uses vcpkg tinyxml2 on `windows-msvc-vcpkg-headless`, but retains `pp_vendor_tinyxml2` for default and unproven platform presets | Mobile/AppX/Apple triplets and app packaging still need validation before removing the vendored fallback | `ctest --preset desktop-fast-vcpkg --build-config Debug`; `ctest --preset desktop-fast --build-config Debug`; `powershell -ExecutionPolicy Bypass -File scripts\automation\platform-build.ps1 -Presets android-arm64` | All supported presets consume vcpkg tinyxml2 or document a permanent vendored exception | | DEBT-0013 | Open | Modernization | `pp_assets`, `pp_document`, `pano_cli inspect-project`, `pano_cli load-project`, and `pano_cli save-project` validate the fixed PPI header, thumbnail/body byte layout, generated multi-layer/multi-frame PPI writing with explicit layer opacity/blend/alpha-lock/visibility metadata, per-layer frame durations, metadata-only and targeted dirty-face-payload save/load round-trips, layer/frame index, dirty-face descriptors, dirty-face PNG payload metadata, asset-level RGBA PNG payload decoding, pure document-to-PPI export, CLI document export automation, file-writing document export automation, stroke-script-generated document payload export, decoded pixel attachment to `pp_document`, live save-path snapshot-readiness reporting, and app-core canvas-snapshot-to-PPI export automation, but full legacy PPI round-trip parity and pure live save writer replacement are not yet extracted | Full PPI save parity requires staged extraction of legacy `Canvas` serialization and image/layer payload handling | `ctest --preset desktop-fast --build-config Debug`; `pp_assets_image_pixels_tests`; `pp_assets_ppi_header_tests`; `pp_document_ppi_import_tests`; `pp_document_ppi_export_tests`; `pano_cli_inspect_project_layout_smoke`; `pano_cli_load_project_metadata_smoke`; `pano_cli_save_project_roundtrip_smoke`; `pano_cli_save_project_payload_roundtrip_smoke`; `pano_cli_simulate_document_export_smoke`; `pano_cli_save_document_project_roundtrip_smoke`; `pano_cli_apply_stroke_script_roundtrip_smoke`; `pano_cli_apply_stroke_script_rejects_tiny_canvas` | Full PPI load/save fixtures cover thumbnails, decoded layer face payloads attached to documents, frames, corrupt payloads, dirty-face payload saving, arbitrary legacy canvas payload/layout combinations, and legacy app round-trip compatibility | @@ -682,7 +689,7 @@ agent or engineer to remove them without reconstructing context from chat. | DEBT-0040 | Open | Modernization | Close request, document save, save-before-workflow planning/execution dispatch, and close/save-before/save-error prompt metadata now consume pure `pp_app_core` through `App::request_close`, `App::save_document`, `App::continue_document_workflow_after_optional_save`, `pano_cli simulate-app-session`, `pano_cli plan-document-session-prompt`, `DocumentSaveServices`, `CloseRequestServices`, `DocumentWorkflowServices`, and `src/legacy_document_session_services.*`; close/save-before prompt creation now uses `src/legacy_app_dialog_services.*`, Save dialog working-directory picker visibility/path formatting now dispatches through `PlatformServices`, and existing-project save/save-before-workflow execution prepares a payload-bearing canvas snapshot report before retained saving, but the bridge still opens retained save dialogs, wires prompt callbacks directly, delegates actual writing to `Canvas::project_save`, mutates the unsaved flag on close confirmation, invokes native app close, and routes save-version through the retained legacy dialog | Preserve current close/save/dirty-workflow behavior while document session execution moves toward app/document/UI/platform services | `pp_app_core_document_session_tests`; `pp_platform_api_tests`; `pano_cli plan-document-session-prompt --kind close-unsaved`; `pano_cli plan-document-session-prompt --kind save-before-workflow`; `pano_cli simulate-app-session --unsaved --save-intent save-dirty-version`; `pano_cli simulate-app-session --no-canvas`; `pano_cli plan-document-file --work-dir D:/Paint --name demo --target-exists`; `pano_cli plan-document-version --directory D:/Paint --doc-name demo.01 --existing-path D:/Paint/demo.02.ppi`; `ctest --preset desktop-fast --build-config Debug` | Close prompt execution, native close requests, dirty-workflow save prompts, existing-project saves, save dialogs, save-version execution, and unsaved-flag mutation are owned by injected app/document/UI/platform services with `App` methods acting only as adapters | | DEBT-0041 | Open | Modernization | Accepted new-document planning/execution dispatch and new-document overwrite prompt metadata now consume pure `pp_app_core` through `App::dialog_newdoc`, `pano_cli plan-new-document`, `pano_cli plan-document-session-prompt`, `NewDocumentServices`, and `src/legacy_document_session_services.*`; new-document overwrite prompt creation now uses `src/legacy_app_dialog_services.*`, and New Document dialog working-directory picker visibility/path formatting now dispatches through `PlatformServices`, but the bridge still mutates legacy app document fields, clears legacy layer UI, resizes legacy `Canvas`, clears legacy history, creates the default layer through legacy UI, mutates unsaved/new-document flags, updates the title, wires overwrite callbacks directly, and handles keyboard/dialog cleanup directly | Preserve current New Document dialog behavior while document creation moves toward app/document/UI services | `pp_app_core_document_session_tests`; `pp_platform_api_tests`; `pano_cli plan-new-document --work-dir D:/Paint --name demo --resolution-index 3`; `pano_cli plan-new-document --work-dir D:/Paint --name demo --resolution-index 3 --target-exists`; `pano_cli plan-document-session-prompt --kind new-document-overwrite`; `pano_cli simulate-app-session --save-intent save`; `ctest --preset desktop-fast --build-config Debug` | New document creation, overwrite confirmation, canvas/document allocation, default layer creation, history clearing, title updates, dirty/new-document state, and keyboard/dialog cleanup are owned by injected app/document/UI services with `App::dialog_newdoc` acting only as a UI adapter | | DEBT-0042 | Open | Modernization | Accepted Save As and Save Version planning/execution dispatch plus Save As overwrite prompt metadata now consumes pure `pp_app_core` through `App::dialog_save`, `App::dialog_save_ver`, `pano_cli plan-document-file`, `pano_cli plan-document-version`, `pano_cli plan-document-session-prompt`, `DocumentFileSaveServices`, `DocumentVersionSaveServices`, and `src/legacy_document_session_services.*`; Save As overwrite prompt creation now uses `src/legacy_app_dialog_services.*`, and accepted Save As/Save Version execution prepares a payload-bearing canvas snapshot report before retained saving, but the bridge still wires overwrite callbacks directly, delegates actual writing to legacy `Canvas::project_save`, mutates app document name/path/directory fields, marks version saves dirty before saving, updates the title, and handles keyboard/dialog cleanup directly | Preserve current Save As and Save Version behavior while document persistence moves toward app/document/storage/UI services | `pp_app_core_document_session_tests`; `pano_cli plan-document-file --work-dir D:/Paint --name demo --target-exists`; `pano_cli plan-document-session-prompt --kind file-overwrite --name demo`; `pano_cli plan-document-version --directory D:/Paint --doc-name demo.01 --existing-path D:/Paint/demo.02.ppi`; `pano_cli simulate-app-session --save-intent save-as`; `pano_cli simulate-app-session --save-intent save-version`; `ctest --preset desktop-fast --build-config Debug` | Save As overwrite prompting, project-save execution, app document metadata updates, title updates, version-save dirty-state handling, and keyboard/dialog cleanup are owned by injected app/document/storage/UI services with `App::dialog_save` and `App::dialog_save_ver` acting only as UI adapters | -| DEBT-0043 | Open | Modernization | Equirectangular, layer, animation-frame, depth, and cube-face export planning/execution dispatch now consumes pure `pp_app_core` through `App::dialog_export`, `App::dialog_export_layers`, `App::dialog_export_anim_frames`, `App::dialog_export_depth`, `App::dialog_export_cube_faces`, `pano_cli plan-export-*`, `DocumentExportServices`, and `src/legacy_document_export_services.*`; layer/frame dialogs also consume `plan_document_export_collection_target` plus `PlatformServices::uses_work_directory_document_export_collections()` instead of spelling local iOS branches, export success/failure/license dialog metadata plus execution log labels now come from `pp_app_core`, equirectangular/layer/animation-frame/depth/cube-face execution prepares a payload-bearing document snapshot plus the shared `pp_paint_renderer::prepare_document_frame_export_readiness` report, document-snapshot writer-versus-retained fallback routing now comes from tested `pp_app_core` policy including current-platform support consumed by the live bridge, depth export target naming and two-payload write order are covered by tested `pp_app_core` helpers, cube-face export writes the pure face PNG bytes to `pp_app_core` planned work-directory face paths through `execute_document_cube_face_export_write` before falling back to retained Canvas execution on failure, PNG/JPEG equirectangular export writes the pure `pp_paint_renderer` equirectangular payload before retained fallback, and payload-complete layer/animation-frame collections write pure `pp_paint_renderer` PNG sequences through `execute_document_export_collection_write` before retained fallback, but the bridge still adapts retained filesystem writes/exported-image publishing locally, still calls legacy `Canvas` export methods for Web/incomplete-readback collection exports and depth rendering, creates export directories, handles picker-selected stems, performs Web prepared-file handoff directly, and leaves depth render/readback plus the legacy `.png`/JPEG payload mismatch on the retained path | Preserve current image/collection/depth/cube export behavior while export execution moves toward document/renderer/platform/storage services | `pp_app_core_document_export_tests`; `pp_platform_api_tests`; `pano_cli plan-export-start --requires-license --demo`; `pano_cli plan-export-menu --kind layers`; `pano_cli plan-export-target --kind collection --work-dir D:/Paint --doc-name demo --suffix _layers`; `pano_cli plan-export-target --kind cube-faces --work-dir D:/Paint --doc-name demo`; `pano_cli plan-export-message --kind equirectangular --destination work --detail D:/Paint`; `pano_cli plan-export-report --kind license-disabled`; `pano_cli plan-export-snapshot-route --kind layers-collection --captured-face-payloads 3 --pending-face-payloads 6`; `pano_cli simulate-document-export`; `ctest --preset desktop-fast --build-config Debug` | File, collection, stem, depth, and remaining retained export execution, export-directory creation, Web file handoff, picker-selected stem handling, and legacy canvas export calls are owned by injected document/renderer/platform/storage services with export dialogs acting only as UI adapters | +| DEBT-0043 | Open | Modernization | Equirectangular, layer, animation-frame, depth, and cube-face export planning/execution dispatch now consumes pure `pp_app_core` through `App::dialog_export`, `App::dialog_export_layers`, `App::dialog_export_anim_frames`, `App::dialog_export_depth`, `App::dialog_export_cube_faces`, `pano_cli plan-export-*`, `DocumentExportServices`, and `src/legacy_document_export_services.*`; layer/frame dialogs also consume `plan_document_export_collection_target` plus `PlatformServices::uses_work_directory_document_export_collections()` instead of spelling local iOS branches, export success/failure/license dialog metadata plus execution log labels now come from `pp_app_core`, equirectangular/layer/animation-frame/depth/cube-face execution prepares a payload-bearing document snapshot plus the shared `pp_paint_renderer::prepare_document_frame_export_readiness` report, document-snapshot writer-versus-retained fallback routing now comes from tested `pp_app_core` policy including current-platform support consumed by the live bridge, depth export target naming and two-payload write order are covered by tested `pp_app_core` helpers, cube-face export writes the pure face PNG bytes to `pp_app_core` planned work-directory face paths through `execute_document_cube_face_export_write` before falling back to retained Canvas execution on failure, PNG/JPEG equirectangular export writes the pure `pp_paint_renderer` equirectangular payload through `execute_document_export_file_write` before retained fallback, and payload-complete layer/animation-frame collections write pure `pp_paint_renderer` PNG sequences through `execute_document_export_collection_write` before retained fallback, but the bridge still adapts retained filesystem writes/exported-image publishing locally, still calls legacy `Canvas` export methods for Web/incomplete-readback collection exports and depth rendering, creates export directories, handles picker-selected stems, performs Web prepared-file handoff directly, and leaves depth render/readback plus the legacy `.png`/JPEG payload mismatch on the retained path | Preserve current image/collection/depth/cube export behavior while export execution moves toward document/renderer/platform/storage services | `pp_app_core_document_export_tests`; `pp_platform_api_tests`; `pano_cli plan-export-start --requires-license --demo`; `pano_cli plan-export-menu --kind layers`; `pano_cli plan-export-target --kind collection --work-dir D:/Paint --doc-name demo --suffix _layers`; `pano_cli plan-export-target --kind cube-faces --work-dir D:/Paint --doc-name demo`; `pano_cli plan-export-message --kind equirectangular --destination work --detail D:/Paint`; `pano_cli plan-export-report --kind license-disabled`; `pano_cli plan-export-snapshot-route --kind layers-collection --captured-face-payloads 3 --pending-face-payloads 6`; `pano_cli simulate-document-export`; `ctest --preset desktop-fast --build-config Debug` | File, collection, stem, depth, and remaining retained export execution, export-directory creation, Web file handoff, picker-selected stem handling, and legacy canvas export calls are owned by injected document/renderer/platform/storage services with export dialogs acting only as UI adapters | | DEBT-0044 | Open | Modernization | Timelapse and animation MP4 export execution dispatch now consumes pure `pp_app_core` through `App::dialog_timelapse_export`, `App::dialog_export_mp4`, `pano_cli plan-export-menu`, `pano_cli plan-export-target --kind name`, `pano_cli plan-export-message`, `pano_cli plan-export-report`, `DocumentVideoExportServices`, and `src/legacy_document_export_services.*`, and success/failure/license dialog metadata plus execution log labels now come from `pp_app_core`, but the bridge still launches legacy desktop timelapse worker threads, calls `App::rec_export`, calls `Canvas::export_anim_mp4`, and owns mobile/Web save callbacks | Preserve current MP4/timelapse export behavior while video export moves toward app/document/renderer/video/platform/storage services | `pp_app_core_document_export_tests`; `pano_cli plan-export-menu --kind animation-mp4`; `pano_cli plan-export-menu --kind timelapse`; `pano_cli plan-export-target --kind name --doc-name demo --suffix -animation`; `pano_cli plan-export-target --kind name --doc-name demo --suffix -timelapse`; `pano_cli plan-export-message --kind timelapse --destination success`; `pano_cli plan-export-report --kind animation-mp4 --message "video export path must not be empty"`; `ctest --preset desktop-fast --build-config Debug` | Timelapse and animation MP4 execution, desktop worker threading, frame readback/video encoding handoff, and mobile/Web save callbacks are owned by injected app/document/renderer/video/platform/storage services with export dialogs acting only as UI adapters | | DEBT-0045 | Open | Modernization | Options-menu preference execution now consumes pure `pp_app_core` through UI scale, viewport scale, RTL direction, VR mode, VR-controller, auto-timelapse, and canvas cursor-mode callbacks plus `AppPreferenceServices` and `src/legacy_app_preference_services.*`; viewport-density and cursor-mode execution now delegate to `src/legacy_canvas_view_services.*`, but the bridges still call legacy `App::set_ui_scale`, `App::set_ui_rtl`, `App::rec_start`, `App::rec_stop`, retained canvas view mutation, and `Settings::save` directly; VR mode callbacks now call `App` VR wrappers that dispatch to `PlatformServices`, whose desktop runtime policy prefers OpenXR while the actual Windows OpenVR SDK bridge still lives in `WindowsPlatformServices` under DEBT-0061 | Preserve current options-menu behavior while preferences move toward app/UI/platform/storage services | `pp_app_core_app_preferences_tests`; `pp_app_core_canvas_view_tests`; `pano_cli plan-app-preferences --ui-scale 1.5 --display-density 2 --current-scale 1.6 --scale-option 1 --scale-option 1.5 --rtl`; `pano_cli plan-canvas-view-density --density 1.5`; `pano_cli plan-canvas-view-cursor-mode --mode 3`; `ctest --preset desktop-fast --build-config Debug`; `cmake --build --preset windows-msvc-default --config Debug --target PanoPainter` | Preference persistence, UI/layout direction, viewport density, cursor mode, VR mode start/stop/failure handling, VR-controller state, and auto-timelapse recording side effects are owned by injected app/UI/platform/storage services with options-menu callbacks acting only as UI adapters | | DEBT-0046 | Open | Modernization | Startup preference/runtime execution and startup resource sequencing now consume pure `pp_app_core` through `App::init`, `pano_cli plan-app-startup`, `pano_cli plan-app-startup-resources`, `AppStartupServices`, `AppStartupResourceServices`, and `src/legacy_app_startup_services.*`, but the bridge still calls legacy `Settings::set`, `Settings::save`, `App::rec_start`, app VR-controller state mutation, message-box license warning execution, shader loading, asset initialization, layout creation, title updates, and UI render-target creation directly | Preserve current startup behavior while app startup moves toward app/preferences/storage/recording/UI/renderer services | `pp_app_core_app_startup_tests`; `pano_cli plan-app-startup --run-counter 7 --vr-controllers-disabled --license-invalid`; `pano_cli plan-app-startup --run-counter -1`; `pano_cli plan-app-startup-resources --width 1280 --height 720`; `pano_cli plan-app-startup-resources --bad-size`; `ctest --preset desktop-fast --build-config Debug`; `cmake --build --preset windows-msvc-default --config Debug --target PanoPainter` | Startup preference persistence, auto-timelapse startup, stored VR-controller state, license validation/warning, startup resource initialization, title updates, and UI render-target allocation are owned by injected app/preferences/storage/recording/UI/renderer services with `App::init` acting only as orchestration | diff --git a/docs/modernization/roadmap.md b/docs/modernization/roadmap.md index 308c10e..82d65a1 100644 --- a/docs/modernization/roadmap.md +++ b/docs/modernization/roadmap.md @@ -723,13 +723,15 @@ document/renderer-owned PNG bytes through a tested app-core write/publish executor using the app-core-planned legacy face filenames when available and falls back to retained `Canvas::export_cube_faces` on snapshot/write failure. PNG equirectangular export now uses the same document/composite payload to -generate an equirectangular PNG through `pp_paint_renderer` before the retained -fallback. Payload-complete layer and animation-frame PNG collections now use +generate an equirectangular PNG through `pp_paint_renderer`, then writes it +through the app-core file write/publish executor before the retained fallback. +Payload-complete layer and animation-frame PNG collections now use pure `pp_paint_renderer` equirectangular PNG generation plus app-core collection write/publish execution before retained fallback. Payload-complete desktop JPEG equirectangular export now uses the same projection through -`pp_paint_renderer`, `pp_assets` JPEG encoding, and GPano XMP injection before -retained fallback. `pp_app_core` now owns the document-snapshot export route +`pp_paint_renderer`, `pp_assets` JPEG encoding, GPano XMP injection, and the +same app-core file write/publish executor before retained fallback. +`pp_app_core` now owns the document-snapshot export route decision used by those live adapters, covering platform support, target support, PNG/JPEG equirectangular target support, collection/cube target support, and incomplete renderer-payload fallback; `pano_cli plan-export-snapshot-route` @@ -2606,15 +2608,17 @@ Results: write/publish service executor before falling back to retained `Canvas` execution on failure. PNG equirectangular export now writes a `pp_paint_renderer` equirectangular PNG from the same composited document - frame before falling back to retained `Canvas` execution; payload-complete + frame through the app-core file write/publish executor before falling back to + retained `Canvas` execution; payload-complete layer and animation-frame PNG collections now write pure `pp_paint_renderer` equirectangular PNG sequences through a tested app-core collection write/publish executor before retained fallback. Depth export now prepares the same document/canvas snapshot, logs the shared renderer-upload readiness report, and records a tested paint-renderer depth render plan before retained `Canvas` execution. JPEG equirectangular export now writes a - pure `pp_paint_renderer`/`pp_assets` JPEG with GPano XMP metadata before - retained fallback. Web prepared-file handoff, video, and incomplete-readback + pure `pp_paint_renderer`/`pp_assets` JPEG with GPano XMP metadata through the + same app-core file write/publish executor before retained fallback. + Web prepared-file handoff, video, and incomplete-readback collection cases remain on their prior retained writer paths. Actual broader writer replacement remains tracked under export debt. - Snapshot creation now rejects invalid embedded RGBA8 face payloads before diff --git a/src/app_core/document_export.h b/src/app_core/document_export.h index 3371b9c..c749216 100644 --- a/src/app_core/document_export.h +++ b/src/app_core/document_export.h @@ -52,6 +52,10 @@ struct DocumentDepthExportPayload { std::span depth_bytes; }; +struct DocumentExportFilePayload { + std::span bytes; +}; + struct DocumentExportCollectionPngPayload { std::string path_suffix; std::span bytes; @@ -231,6 +235,16 @@ public: virtual void publish_exported_image(std::string_view path) = 0; }; +class DocumentExportFileWriteServices { +public: + virtual ~DocumentExportFileWriteServices() = default; + + virtual pp::foundation::Status write_binary_file( + std::string_view path, + std::span bytes) = 0; + virtual void publish_exported_image(std::string_view path) = 0; +}; + class DocumentExportCollectionWriteServices { public: virtual ~DocumentExportCollectionWriteServices() = default; @@ -928,6 +942,27 @@ document_cube_face_export_names() noexcept return pp::foundation::Status::success(); } +[[nodiscard]] inline pp::foundation::Status execute_document_export_file_write( + const DocumentExportFileTarget& target, + DocumentExportFilePayload payload, + DocumentExportFileWriteServices& services) +{ + if (target.path.empty()) { + return pp::foundation::Status::invalid_argument("export file target requires a path"); + } + if (payload.bytes.empty()) { + return pp::foundation::Status::invalid_argument("export file payload must not be empty"); + } + + const auto write_status = services.write_binary_file(target.path, payload.bytes); + if (!write_status.ok()) { + return write_status; + } + services.publish_exported_image(target.path); + + return pp::foundation::Status::success(); +} + [[nodiscard]] inline pp::foundation::Status execute_document_export_collection_write( const DocumentExportCollectionTarget& target, std::span payloads, diff --git a/src/legacy_document_export_services.cpp b/src/legacy_document_export_services.cpp index d3338c0..56537ef 100644 --- a/src/legacy_document_export_services.cpp +++ b/src/legacy_document_export_services.cpp @@ -55,6 +55,7 @@ pp::foundation::Status write_export_binary_file(std::string_view path, std::span class LegacyExportWriteServices final : public pp::app::DocumentCubeFaceExportWriteServices , public pp::app::DocumentDepthExportWriteServices + , public pp::app::DocumentExportFileWriteServices , public pp::app::DocumentExportCollectionWriteServices { public: explicit LegacyExportWriteServices(App& app) noexcept @@ -320,13 +321,13 @@ pp::foundation::Status export_equirectangular_from_document_snapshot( "document snapshot equirectangular export currently supports PNG and JPEG targets only"); } - const auto write_status = write_export_binary_file(target.path, bytes); - if (!write_status.ok()) { - return write_status; - } - - app.publish_exported_image(target.path); - return pp::foundation::Status::success(); + LegacyExportWriteServices services(app); + return pp::app::execute_document_export_file_write( + target, + pp::app::DocumentExportFilePayload { + .bytes = bytes, + }, + services); } class LegacyDocumentExportServices final : public pp::app::DocumentExportServices { diff --git a/tests/app_core/document_export_tests.cpp b/tests/app_core/document_export_tests.cpp index bf8bee7..2fed361 100644 --- a/tests/app_core/document_export_tests.cpp +++ b/tests/app_core/document_export_tests.cpp @@ -155,6 +155,7 @@ public: class FakeDocumentCubeFaceExportWriteServices final : public pp::app::DocumentCubeFaceExportWriteServices , public pp::app::DocumentDepthExportWriteServices + , public pp::app::DocumentExportFileWriteServices , public pp::app::DocumentExportCollectionWriteServices { public: pp::foundation::Status write_binary_file( @@ -461,6 +462,83 @@ void depth_export_writer_rejects_malformed_inputs(pp::tests::Harness& harness) PP_EXPECT(harness, services.publish_calls == 0); } +void file_export_writer_writes_and_publishes_target(pp::tests::Harness& harness) +{ + const auto target = pp::app::make_document_export_file_target("D:/Paint", "demo", ".png"); + const std::array bytes {}; + FakeDocumentCubeFaceExportWriteServices services; + + PP_EXPECT(harness, target); + PP_EXPECT( + harness, + pp::app::execute_document_export_file_write( + target.value(), + pp::app::DocumentExportFilePayload { + .bytes = std::span(bytes), + }, + services) + .ok()); + PP_EXPECT(harness, services.write_calls == 1); + PP_EXPECT(harness, services.publish_calls == 1); + PP_EXPECT(harness, services.total_bytes == 4U); + PP_EXPECT(harness, services.last_path == "D:/Paint/demo.png"); + PP_EXPECT(harness, services.last_published_path == "D:/Paint/demo.png"); + PP_EXPECT(harness, services.call_order == "write:D:/Paint/demo.png;publish:D:/Paint/demo.png;"); +} + +void file_export_writer_stops_before_publish_on_write_failure(pp::tests::Harness& harness) +{ + const auto target = pp::app::make_document_export_file_target("D:/Paint", "demo", ".jpg"); + const std::array bytes {}; + FakeDocumentCubeFaceExportWriteServices services; + services.fail_on_write_call = 1; + + PP_EXPECT(harness, target); + const auto status = pp::app::execute_document_export_file_write( + target.value(), + pp::app::DocumentExportFilePayload { + .bytes = std::span(bytes), + }, + services); + PP_EXPECT(harness, !status.ok()); + PP_EXPECT(harness, services.write_calls == 1); + PP_EXPECT(harness, services.publish_calls == 0); + PP_EXPECT(harness, services.call_order == "write:D:/Paint/demo.jpg;"); +} + +void file_export_writer_rejects_malformed_inputs(pp::tests::Harness& harness) +{ + const auto target = pp::app::make_document_export_file_target("D:/Paint", "demo", ".png"); + const std::array bytes {}; + FakeDocumentCubeFaceExportWriteServices services; + + PP_EXPECT(harness, target); + auto empty_path = target.value(); + empty_path.path.clear(); + PP_EXPECT( + harness, + !pp::app::execute_document_export_file_write( + empty_path, + pp::app::DocumentExportFilePayload { + .bytes = std::span(bytes), + }, + services) + .ok()); + + PP_EXPECT( + harness, + !pp::app::execute_document_export_file_write( + target.value(), + pp::app::DocumentExportFilePayload { + .bytes = {}, + }, + services) + .ok()); + + PP_EXPECT(harness, services.write_calls == 0); + PP_EXPECT(harness, services.publish_calls == 0); +} + void collection_export_builds_legacy_path_suffixes(pp::tests::Harness& harness) { PP_EXPECT( @@ -1273,6 +1351,11 @@ int main() "depth export writer stops before depth publish on write failure", depth_export_writer_stops_before_depth_publish_on_write_failure); harness.run("depth export writer rejects malformed inputs", depth_export_writer_rejects_malformed_inputs); + harness.run("file export writer writes and publishes target", file_export_writer_writes_and_publishes_target); + harness.run( + "file export writer stops before publish on write failure", + file_export_writer_stops_before_publish_on_write_failure); + harness.run("file export writer rejects malformed inputs", file_export_writer_rejects_malformed_inputs); harness.run("collection export builds legacy path suffixes", collection_export_builds_legacy_path_suffixes); harness.run( "collection export writer writes and publishes payloads in order",