From 22c7c341ce38d66418fd31f3acbc059ef17a083e Mon Sep 17 00:00:00 2001 From: dingo Date: Fri, 2 Oct 2026 07:53:17 -0400 Subject: [PATCH] Qualify pinned Dear ImGui toolkit for M9.8a --- CMakeLists.txt | 3 +- README.md | 15 +++ cmake/ClientProbe.cmake | 15 +++ cmake/EngineeringUi.cmake | 22 +++++ deploy/docker/Dockerfile | 9 +- docs/ROADMAP.md | 5 +- docs/adr/0084-engineering-ui-toolkit.md | 29 ++++-- docs/adr/README.md | 2 +- docs/engineering/M9_8_DELIVERY_PLAN.md | 12 ++- docs/engineering/VALIDATION.md | 35 +++++++ experiments/ui/main.cpp | 121 ++++++++++++++++++++++++ third_party/imgui/README.md | 14 +++ tools/ci/ci-paths-check.sh | 3 + tools/ci/ci-paths.sh | 2 +- tools/imgui-pin.cmake | 4 + tools/prepare-imgui.cmake | 22 +++++ 16 files changed, 293 insertions(+), 20 deletions(-) create mode 100644 cmake/EngineeringUi.cmake create mode 100644 experiments/ui/main.cpp create mode 100644 third_party/imgui/README.md create mode 100644 tools/imgui-pin.cmake create mode 100644 tools/prepare-imgui.cmake diff --git a/CMakeLists.txt b/CMakeLists.txt index a2e92f6..51a3572 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -24,6 +24,7 @@ option(EVO_ENABLE_TIDY "Run clang-tidy during compilation" OFF) option(EVO_BUILD_FUZZER "Build the Clang libFuzzer snapshot target" OFF) option(EVO_BUILD_ECS_EXPERIMENT "Build the isolated EnTT comparison (explicit preparation required)" OFF) option(EVO_BUILD_POSTGRES "Build the isolated Linux PostgreSQL persistence adapter" OFF) +option(EVO_BUILD_UI_PROBE "Build the isolated M9.8a Dear ImGui compatibility probe" OFF) option(EVO_BUILD_CLIENT_PROBE "Build the isolated M9.1 SDL dependency probe" OFF) option(EVO_BUILD_CLIENT "Build the native M9 engineering client" OFF) option(EVO_BUILD_NETWORK "Build the M9.6 dev session protocol and TLS adapter (explicit Mbed TLS preparation required)" OFF) @@ -106,7 +107,7 @@ endif() if(EVO_BUILD_NETWORK) include(cmake/Network.cmake) endif() -if(EVO_BUILD_CLIENT_PROBE OR EVO_BUILD_CLIENT) +if(EVO_BUILD_CLIENT_PROBE OR EVO_BUILD_CLIENT OR EVO_BUILD_UI_PROBE) include(cmake/ClientProbe.cmake) endif() if(EVO_BUILD_POSTGRES) diff --git a/README.md b/README.md index ffdce39..ba598fb 100644 --- a/README.md +++ b/README.md @@ -193,3 +193,18 @@ See [DEV_SESSION_PROTOCOL](docs/networking/DEV_SESSION_PROTOCOL.md) and ADR-0082 M9.7 connects `evo-client` (preset `client-network`) to a dev region running `evo-server --session-listen ...`; see [DEV_SESSION_OPERATIONS](docs/networking/DEV_SESSION_OPERATIONS.md). Windows: `tools/windows-check.ps1 -Preset network -Action check`. + + +M9.8a engineering UI compatibility probe (does not change evo-client yet): + +```sh +cmake -P tools/prepare-sdl3.cmake +cmake -P tools/prepare-imgui.cmake +cmake --preset client-probe -DEVO_BUILD_UI_PROBE=ON +cmake --build build/client-probe --target evo-ui-probe +ctest --test-dir build/client-probe -R ui-probe --output-on-failure +``` + +Use an MSVC developer shell on Windows. See ADR-0084 and +[the M9.8 plan](docs/engineering/M9_8_DELIVERY_PLAN.md) for the remaining UI, +local Windows packaging and low-spec qualification work. diff --git a/cmake/ClientProbe.cmake b/cmake/ClientProbe.cmake index 2a0beee..332655d 100644 --- a/cmake/ClientProbe.cmake +++ b/cmake/ClientProbe.cmake @@ -97,3 +97,18 @@ if(EVO_BUILD_CLIENT) ENVIRONMENT "SDL_VIDEO_DRIVER=evo-invalid" WILL_FAIL TRUE TIMEOUT 20 LABELS "client") endif() endif() + +if(EVO_BUILD_UI_PROBE) + include("${PROJECT_SOURCE_DIR}/cmake/EngineeringUi.cmake") + add_executable(evo-ui-probe experiments/ui/main.cpp) + target_link_libraries(evo-ui-probe PRIVATE evo_imgui SDL3::SDL3) + evo_owned_target(evo-ui-probe) + evo_client_runtime(evo-ui-probe) + if(BUILD_TESTING) + add_test(NAME ui-probe COMMAND evo-ui-probe --renderer software) + add_test(NAME ui-probe-invalid-renderer COMMAND evo-ui-probe --renderer evo-invalid) + set_tests_properties(ui-probe ui-probe-invalid-renderer PROPERTIES + ENVIRONMENT "SDL_VIDEO_DRIVER=dummy" TIMEOUT 30 LABELS "client;ui") + set_tests_properties(ui-probe-invalid-renderer PROPERTIES WILL_FAIL TRUE) + endif() +endif() diff --git a/cmake/EngineeringUi.cmake b/cmake/EngineeringUi.cmake new file mode 100644 index 0000000..de5b6e2 --- /dev/null +++ b/cmake/EngineeringUi.cmake @@ -0,0 +1,22 @@ +# Scoped toolkit target. No toolkit types leave the private native client boundary. +include("${PROJECT_SOURCE_DIR}/tools/imgui-pin.cmake") +set(imgui_source "${PROJECT_SOURCE_DIR}/build/external/imgui/imgui-${EVO_IMGUI_VERSION}") +if(NOT EXISTS "${imgui_source}/evo-verified.sha256") + message(FATAL_ERROR "Prepare Dear ImGui explicitly: cmake -P tools/prepare-imgui.cmake") +endif() +file(STRINGS "${imgui_source}/evo-verified.sha256" verified_imgui) +if(NOT verified_imgui STREQUAL EVO_IMGUI_SHA256) + message(FATAL_ERROR "Prepared Dear ImGui does not match the reviewed source pin") +endif() +add_library(evo_imgui STATIC + "${imgui_source}/imgui.cpp" "${imgui_source}/imgui_draw.cpp" + "${imgui_source}/imgui_tables.cpp" "${imgui_source}/imgui_widgets.cpp" + "${imgui_source}/backends/imgui_impl_sdl3.cpp" + "${imgui_source}/backends/imgui_impl_sdlrenderer3.cpp") +target_include_directories(evo_imgui SYSTEM PUBLIC "${imgui_source}" "${imgui_source}/backends") +target_link_libraries(evo_imgui PRIVATE SDL3::SDL3) +# Third-party source does not inherit owned warnings-as-errors/static analysis. +# Instrument it during sanitizer probes, so toolkit lifecycle is checked as well. +if(EVO_SANITIZER STREQUAL "address" AND NOT MSVC) + target_compile_options(evo_imgui PRIVATE -fsanitize=address,undefined -fno-omit-frame-pointer) +endif() diff --git a/deploy/docker/Dockerfile b/deploy/docker/Dockerfile index 117a322..bd53f24 100644 --- a/deploy/docker/Dockerfile +++ b/deploy/docker/Dockerfile @@ -40,15 +40,18 @@ RUN apt-get update && apt-get install -y --no-install-recommends \ libx11-dev libxext-dev libxrandr-dev libxcursor-dev libxi-dev libxss-dev libxtst-dev xvfb xauth \ && rm -rf /var/lib/apt/lists/* RUN cmake -P tools/prepare-sdl3.cmake \ + && cmake -P tools/prepare-imgui.cmake \ && cmake --preset client-probe -DCMAKE_CXX_COMPILER=clang++-19 -DCMAKE_C_COMPILER=clang-19 \ - -DEVO_BUILD_CLIENT=ON -DEVO_ENABLE_TIDY=ON -DSDL_X11=ON -DSDL_WAYLAND=OFF \ - && cmake --build build/client-probe --target evo-client-probe evo-client evo-client-lifecycle-tests evo-client-environment-tests evo-client-organism-tests --parallel 2 \ + -DEVO_BUILD_CLIENT=ON -DEVO_BUILD_UI_PROBE=ON -DEVO_ENABLE_TIDY=ON -DSDL_X11=ON -DSDL_WAYLAND=OFF \ + && cmake --build build/client-probe --target evo-ui-probe evo-client-probe evo-client evo-client-lifecycle-tests evo-client-environment-tests evo-client-organism-tests --parallel 2 \ && ctest --preset client-probe --no-tests=error \ && xvfb-run -a env SDL_VIDEO_DRIVER=x11 ./build/client-probe/evo-client-probe --renderer software \ + && xvfb-run -a env SDL_VIDEO_DRIVER=x11 ./build/client-probe/evo-ui-probe --renderer software \ && xvfb-run -a env SDL_VIDEO_DRIVER=x11 ./build/client-probe/evo-client-lifecycle-tests \ && cmake --preset client-probe -DEVO_BUILD_CLIENT=ON -DEVO_SANITIZER=address -DEVO_ENABLE_TIDY=OFF \ - && cmake --build build/client-probe --target evo-client evo-client-lifecycle-tests evo-client-environment-tests evo-client-organism-tests --parallel 2 \ + && cmake --build build/client-probe --target evo-ui-probe evo-client evo-client-lifecycle-tests evo-client-environment-tests evo-client-organism-tests --parallel 2 \ && ctest --preset client-probe --no-tests=error \ + && xvfb-run -a env SDL_VIDEO_DRIVER=x11 ./build/client-probe/evo-ui-probe --renderer software \ && xvfb-run -a env SDL_VIDEO_DRIVER=x11 ./build/client-probe/evo-client-lifecycle-tests FROM ci-source AS ci-network diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md index ce45cb0..d1ed01f 100644 --- a/docs/ROADMAP.md +++ b/docs/ROADMAP.md @@ -454,9 +454,12 @@ terrain meshing or procedural creature animation is required. | 9.7 Connect to one authoritative dev region | src/client/session, src/server/session adapter | 9.6, M8-dev/stage | Real desktop-to-server connection, snapshot display and minimal admitted intent; reconnect requests fresh baseline; final outcomes reflect durable server ACK | Disconnect/reconnect, stale epoch, server pod restart, rejected intention and duplicate session tests | Client state or reconnect becomes authority | | 9.8 Validate presentation and package the client | tools/client packaging, tests/client, docs/engineering | 9.1-9.7 | Reproducible native artifact, bounded snapshot/render queues, frame/memory report and documented manual visual checks | Install/run on supported dev platforms; long session, resolution/DPI matrix, headless regression suite | Declaring FUN or multiplayer scalability from a viewer | +**M9.8a (2026-10-02):** isolated Dear ImGui 1.92.9b probe qualified on Windows/Linux; +application UI integration remains next. ADR-0084 is accepted for this probe. + **M9.8 planning (2026-10-02):** user-confirmed Windows ZIP, temporary Gitea Actions artifacts, labelled engineering UI/launcher and control rebinding. See the -[delivery segments](engineering/M9_8_DELIVERY_PLAN.md) and proposed ADR-0084. +[delivery segments](engineering/M9_8_DELIVERY_PLAN.md) and ADR-0084. Low-spec VM qualification and live cluster evidence remain outstanding; neither is implied by packaging completion. diff --git a/docs/adr/0084-engineering-ui-toolkit.md b/docs/adr/0084-engineering-ui-toolkit.md index 881a721..074c4db 100644 --- a/docs/adr/0084-engineering-ui-toolkit.md +++ b/docs/adr/0084-engineering-ui-toolkit.md @@ -1,10 +1,14 @@ # ADR-0084: Engineering UI toolkit and ownership boundary ## Status -Proposed, 2026-10-02. User authorized evaluating/adopting a maintained framework. -Preferred candidate: Dear ImGui for the engineering client only. Adoption requires -an exact source pin, licence inventory and Windows/Linux compatibility probe in -M9.8a. No dependency has been added by this ADR. Final player UI remains undecided. +Accepted for the isolated M9.8a engineering UI probe, 2026-10-02. User delegated +UI selection. Dear ImGui 1.92.9b, MIT, upstream commit +`f1cc2ae15e53a861a874c3034aae6798fde194ab`; archive SHA-256 +`21d8a0a565e85dce943e375db00812c2f3f0ab21f3f0f7964e364a63422d7f99`. +Published 2026-07-31; upstream latest-release API and tag checked 2026-10-02. +Checksum is locally measured over the upstream HTTPS archive, not an independent +signature. The pin is in tools/imgui-pin.cmake. Broader application integration +follows the probe. Final player UI remains undecided. ## Context M9.4/M9.5 intentionally used rectangles and unlabelled gauges. M9.8 now requires @@ -12,7 +16,7 @@ readable text, a launcher, dialogs, dismissible notifications, click selection a control rebinding. The existing client uses SDL3 and SDL_Renderer. The headless libraries and immutable biological views must remain toolkit-independent. -## Decision proposed +## Decision Use Dear ImGui's upstream SDL3 platform and SDL_Renderer3 rendering adapters behind the private native client boundary. Implement owned application state for toasts, selection, dialogs and action bindings; do not equate toolkit widget state with @@ -57,12 +61,21 @@ segment, not inferred from this high-level comparison. ## Consequences Revisits ADR-0081's scoped decision to defer ImGui once labelled engineering UI is -needed. M9.8a must change this status to accepted only with the pin and probe evidence. +needed. M9.8a records the pin and executed probe evidence in VALIDATION.md. M9.8 delivery is tracked in ../engineering/M9_8_DELIVERY_PLAN.md. ## Primary-source evidence reviewed 2026-10-02 - https://github.com/ocornut/imgui/blob/master/docs/BACKENDS.md — upstream SDL3 and SDL_Renderer3 adapters; platform/render separation. -- https://github.com/ocornut/imgui/blob/master/LICENSE.txt — MIT licence; pin-time notice audit still required. +- https://github.com/ocornut/imgui/blob/master/LICENSE.txt — MIT licence; notice inventory in third_party/imgui/README.md. - https://github.com/ocornut/imgui/blob/master/docs/FAQ.md — input capture guidance and integration responsibilities. -- https://github.com/ocornut/imgui/releases — release/maintenance evidence; no version selected here. +- https://github.com/ocornut/imgui/releases — release/maintenance evidence; v1.92.9b selected above. - https://mikke89.github.io/RmlUiDoc/pages/cpp_manual/integrating.html — context and rendering integration requirements for the alternative. + + +The probe compiles core, draw, tables, widgets and the SDL3/SDL_Renderer3 backends; +no demo, docking, multi-viewport, FreeType or external font dependency is introduced. +Use the embedded ProggyClean bitmap font explicitly for the probe. Retain LICENSE.txt, +docs/FONTS.md, imgui_draw.cpp and the stb headers' embedded notices at +packaging. The bundled ProggyForever data also carries notices in imgui_draw.cpp; +include the source notice inventory even when that font is not selected. +Normal headless/client configuration does not require ImGui until explicitly enabled. diff --git a/docs/adr/README.md b/docs/adr/README.md index 310658f..c79019d 100644 --- a/docs/adr/README.md +++ b/docs/adr/README.md @@ -96,4 +96,4 @@ design. No unadopted candidate is a link dependency of the proof. - [ADR-0082: Dev session transport](0082-dev-session-transport.md) - TLS 1.3-only Mbed TLS 4.1.1 LTS (pinned, compiled-down), dev-only HMAC grants, versioned bounded protocol v1 and session admission for M9. - [ADR-0083: Dev region sessions](0083-dev-region-sessions.md) - session server in evo-server, durable no-effect intentions on synthetic carriers, empty organism presentation, reconnect with fresh baselines, loopback-only drill-time dev deployment. -- [ADR-0084: Engineering UI toolkit](0084-engineering-ui-toolkit.md) - proposed Dear ImGui boundary; adoption waits for the exact pin and compatibility probe. +- [ADR-0084: Engineering UI toolkit](0084-engineering-ui-toolkit.md) - accepted for the isolated M9.8a Dear ImGui 1.92.9b compatibility probe; application UI follows. diff --git a/docs/engineering/M9_8_DELIVERY_PLAN.md b/docs/engineering/M9_8_DELIVERY_PLAN.md index 9aad587..d35804e 100644 --- a/docs/engineering/M9_8_DELIVERY_PLAN.md +++ b/docs/engineering/M9_8_DELIVERY_PLAN.md @@ -1,7 +1,7 @@ # M9.8 delivery plan -Status: planned; user choices recorded 2026-10-02. No implementation or deployment -is claimed by this document. See ADR-0084 for the proposed UI toolkit boundary. +Status: M9.8a isolated toolkit probe complete, 2026-10-02; remaining segments planned. +No application UI or deployment completion is claimed. See ADR-0084 for the toolkit boundary. ## Confirmed scope @@ -21,7 +21,8 @@ is claimed by this document. See ADR-0084 for the proposed UI toolkit boundary. qualification can complete independently; M9's live-deployment evidence remains open. - Cluster uses MetalLB and nginx. User reports 172.10.1.160 reachable from the development machine, with deployment through existing Gitea/GitOps machinery. - Whether this address belongs to a node or the ingress service is unconfirmed. + This is the RKE2 control-plane address, not a confirmed MetalLB service address. + Testing is internal from the development machine for now. - Available DNS names: sys, void, srs, cloud, assets under aeternalisgames.com. No assignment or route is implemented. Proposed dev session name: void; proposed future download name: assets. DNS existence is not evidence of service reachability. @@ -56,10 +57,11 @@ All selected biological data remains a read-only presentation copy. ## Infrastructure and packaging decisions still needed -- Windows runner label/toolchain availability. Do not silently route a Windows +- No Windows runner exists yet (confirmed 2026-10-02). Local builds are the initial path. Do not silently route a Windows package job to the existing Linux runner or assume an untested cross-compile. The packaging script can run on the existing Windows development host meanwhile. -- Exact role of 172.10.1.160, nginx implementation/configuration, exposed TCP port, +- Confirmed control plane: 172.10.1.160. Still needed for direct service routing: + nginx implementation/configuration, exposed TCP port, source restrictions and certificate name. The protocol is TLS/TCP, not HTTP; a standard HTTP Ingress rule does not implement it. Port-forward remains supported. - VM specification and whether graphics acceleration is available. Hardware-specific diff --git a/docs/engineering/VALIDATION.md b/docs/engineering/VALIDATION.md index ca6fcd8..5383b46 100644 --- a/docs/engineering/VALIDATION.md +++ b/docs/engineering/VALIDATION.md @@ -3602,3 +3602,38 @@ in M9_8_DELIVERY_PLAN.md. ADR-0084 proposes the UI boundary and comparison; no l version or dependency was adopted. Reviewed upstream toolkit documentation, checked repository-relative links and git diff --check. Documentation only: no code tests, package build, runner execution, endpoint verification or deployment performed. + + +## 2026-10-02 — M9.8a pinned engineering UI probe + +Adopted Dear ImGui 1.92.9b for an isolated SDL3/SDL_Renderer3 compatibility probe; +normal client/headless builds do not require it. Exact upstream commit, locally +measured archive checksum, maintenance and notice evidence are in ADR-0084 and +third_party/imgui/README.md. No upstream code modified. Embedded bitmap font used; +no extra font dependency. Source preparation is explicit, with hash verification. + +Executed: Windows MSVC Release probe CTest 2/2; Linux GCC14 Release 2/2; +Clang19 ASan/UBSan 2/2 (including instrumented toolkit sources); real X11 software +renderer probes under Xvfb in Release and sanitizer builds. Three full SDL/UI +initialize/render/shutdown cycles per successful invocation. A synthetic press and +release activates a real widget exactly once; geometry bounds and pixel readback +are checked under NDEBUG. Invalid explicit renderer fails. This is synthetic input +and render evidence, not physical keyboard/DPI/accessibility acceptance. + +clang-tidy19 on owned probe: no owned diagnostics; clang-format19 and CI selector +fixtures passed, including a new toolkit-pin selection case. Fresh headless configure +with client/network/probes off passed without evaluating SDL/ImGui dependencies. +An initial const mismatch with upstream's mutable draw API was corrected. Initial +static analysis used a GCC database with unsupported module flags; rerun against the +Clang database passed. Edited shell scripts were normalized to LF before selector +fixtures ran successfully. + +Artifact observations: Windows Release probe EXE 398336 bytes, SDL3.dll 1998848; +Linux Release executable 1098464 bytes. These are probe totals, not a final client +package size or an incremental apples-to-apples benchmark. No minimum hardware, +frame-rate or accessibility claim yet. Low-spec VM pending; live cluster drill is +explicitly deferred; control-plane IP is not assumed to be a MetalLB endpoint. + +Not run: Docker/Gitea image execution, physical GPU/DPI matrix, VM soak, client UI +integration/launcher or packaging acceptance. Existing network and headless simulation +behavior is unchanged; no simulation version or golden was modified. diff --git a/experiments/ui/main.cpp b/experiments/ui/main.cpp new file mode 100644 index 0000000..155ec99 --- /dev/null +++ b/experiments/ui/main.cpp @@ -0,0 +1,121 @@ +// M9.8a toolkit qualification only: no simulation, network, or authority state. +#include +#include +#include +#include +#include +#include +#include +#include +#include + +namespace { +void require(bool ok, const char* message) { + if (!ok) + throw std::runtime_error(message); +} +struct Runtime { + ~Runtime() { + SDL_Quit(); + } +}; +struct Ui { + bool platform{}, renderer{}; + Ui() { + ImGui::CreateContext(); + } + ~Ui() { + if (renderer) + ImGui_ImplSDLRenderer3_Shutdown(); + if (platform) + ImGui_ImplSDL3_Shutdown(); + ImGui::DestroyContext(); + } + Ui(const Ui&) = delete; + Ui& operator=(const Ui&) = delete; +}; +void run(const char* driver) { + require(SDL_Init(SDL_INIT_VIDEO), "SDL init"); + const Runtime runtime; + const std::unique_ptr window{ + SDL_CreateWindow("Aeternalis engineering UI probe", 640, 480, SDL_WINDOW_HIDDEN), + SDL_DestroyWindow}; + require(window != nullptr, "window"); + const std::unique_ptr renderer{ + SDL_CreateRenderer(window.get(), driver), SDL_DestroyRenderer}; + require(renderer != nullptr, "renderer"); + IMGUI_CHECKVERSION(); + Ui ui; + auto& io = ImGui::GetIO(); + io.IniFilename = nullptr; + io.LogFilename = nullptr; + io.ConfigFlags |= ImGuiConfigFlags_NavEnableKeyboard; + require(io.Fonts->AddFontDefaultBitmap() != nullptr, "embedded font"); + ui.platform = ImGui_ImplSDL3_InitForSDLRenderer(window.get(), renderer.get()); + require(ui.platform, "platform backend"); + ui.renderer = ImGui_ImplSDLRenderer3_Init(renderer.get()); + require(ui.renderer, "render backend"); + int clicks = 0; + ImVec2 button_center{}; + bool edited = false; + for (int frame = 0; frame < 5; ++frame) { + SDL_Event event{}; + while (SDL_PollEvent(&event)) + ImGui_ImplSDL3_ProcessEvent(&event); + ImGui_ImplSDLRenderer3_NewFrame(); + ImGui_ImplSDL3_NewFrame(); + // Known synthetic input tests real widget state, not physical mouse hardware. + if (frame >= 1) + io.AddMousePosEvent(button_center.x, button_center.y); + if (frame == 2) + io.AddMouseButtonEvent(0, true); + if (frame == 3) + io.AddMouseButtonEvent(0, false); + ImGui::NewFrame(); + ImGui::SetNextWindowPos({20, 20}, ImGuiCond_Always); + ImGui::SetNextWindowSize({560, 400}, ImGuiCond_Always); + ImGui::Begin("Engineering UI", nullptr, + ImGuiWindowFlags_NoResize | ImGuiWindowFlags_NoMove); + ImGui::TextUnformatted("LOCAL FIXTURE | toolkit compatibility probe"); + ImGui::TextUnformatted("Water (fg): present / missing / stale"); + if (ImGui::Button("Select organism", {200, 40})) + ++clicks; + const auto low = ImGui::GetItemRectMin(), high = ImGui::GetItemRectMax(); + button_center = {(low.x + high.x) / 2, (low.y + high.y) / 2}; + ImGui::Checkbox("Inspector", &edited); + ImGui::TextUnformatted("Keyboard and modal capture qualification follows in M9.8b."); + ImGui::End(); + ImGui::Render(); + auto* draw = ImGui::GetDrawData(); + require(draw != nullptr && draw->TotalVtxCount > 0 && draw->TotalVtxCount < 100000, + "bounded nonempty widget geometry"); + require(SDL_SetRenderDrawColor(renderer.get(), 16, 20, 28, 255) && + SDL_RenderClear(renderer.get()), + "clear"); + ImGui_ImplSDLRenderer3_RenderDrawData(draw, renderer.get()); + const std::unique_ptr pixels{ + SDL_RenderReadPixels(renderer.get(), nullptr), SDL_DestroySurface}; + require(pixels != nullptr, "readback"); + Uint8 red{}, green{}, blue{}, alpha{}; + require(SDL_ReadSurfacePixel(pixels.get(), 25, 25, &red, &green, &blue, &alpha), "pixel"); + require(red != 16 || green != 20 || blue != 28, "UI modifies render target"); + require(SDL_RenderPresent(renderer.get()), "present"); + } + require(clicks == 1, "press and release must activate exactly once"); + std::printf("imgui=%s renderer=%s clicks=%d font=textured teardown=next\n", IMGUI_VERSION, + SDL_GetRendererName(renderer.get()), clicks); +} +} // namespace +int main(int argc, char** argv) try { + const char* driver = nullptr; + if (argc == 3 && std::string_view{argv[1]} == "--renderer") + driver = argv[2]; + else if (argc != 1) + return 2; + for (int cycle = 0; cycle < 3; ++cycle) + run(driver); + return 0; +} catch (const std::exception& error) { + std::fprintf(stderr, "UI probe failed: %s (%s)\n", error.what(), SDL_GetError()); + return 1; +} diff --git a/third_party/imgui/README.md b/third_party/imgui/README.md new file mode 100644 index 0000000..27a5bc3 --- /dev/null +++ b/third_party/imgui/README.md @@ -0,0 +1,14 @@ +# Dear ImGui 1.92.9b notice inventory (ADR-0084) + +Source pin: tools/imgui-pin.cmake; prepared source stays in ignored build/external. +Upstream MIT licence: LICENSE.txt (Omar Cornut, 2014–2026). +Embedded fonts: imgui_draw.cpp and docs/FONTS.md: ProggyClean (Tristan Grimmer, +2004–2005, MIT); ProggyForever (Disco Hello 2026; Tristan Grimmer 2019,2023, MIT). +The probe explicitly selects ProggyClean; do not omit notices for bundled data. +The imstb_* headers retain their stb licences (MIT or public-domain option). + +Packaging must copy the upstream LICENSE.txt, docs/FONTS.md, imgui_draw.cpp, +and imstb_rectpack.h, imstb_textedit.h, imstb_truetype.h into third-party notices, +and retain the embedded font notice blocks from imgui_draw.cpp. This inventory is +not a substitute for those licence texts. No external font, FreeType, or icon pack. +The ImGui demo file is not compiled. No upstream source is modified. diff --git a/tools/ci/ci-paths-check.sh b/tools/ci/ci-paths-check.sh index 4b49efd..7d70464 100644 --- a/tools/ci/ci-paths-check.sh +++ b/tools/ci/ci-paths-check.sh @@ -47,6 +47,9 @@ mkdir -p tools client_base="$(git rev-parse HEAD)" echo pin > tools/sdl3-pin.cmake; git add .; git commit -qm client-pin expect "push: SDL pin runs client" 0 CI_EVENT=push "CI_BEFORE=$client_base" -- client +ui_base="$(git rev-parse HEAD)" +echo pin > tools/imgui-pin.cmake; git add .; git commit -qm ui-pin +expect "push: ImGui pin runs client" 0 CI_EVENT=push "CI_BEFORE=$ui_base" -- client # A TLS dependency update must select the isolated network gate, not only the image. network_base="$(git rev-parse HEAD)" echo pin > tools/mbedtls-pin.cmake; git add .; git commit -qm network-pin diff --git a/tools/ci/ci-paths.sh b/tools/ci/ci-paths.sh index 84338f3..ad90495 100755 --- a/tools/ci/ci-paths.sh +++ b/tools/ci/ci-paths.sh @@ -34,7 +34,7 @@ native='CMakeLists\.txt|CMakePresets\.json|cmake/|include/|src/|apps/' postgres_tools='migrations/|tools/prepare-postgres\.sh|tools/migrate-postgres\.sh|tools/backup/|tools/ci/postgres-check\.sh|tools/ci/backup-check\.sh|tools/ci/dr-check\.sh|tools/ci/upgrade-check\.sh' case "$suite" in client) - pattern="$common|$native|experiments/client/|tools/prepare-sdl3\\.cmake|tools/sdl3-pin\\.cmake|deploy/docker/Dockerfile" + pattern="$common|$native|experiments/(client|ui)/|tools/(prepare-imgui|imgui-pin)\.cmake|tools/prepare-sdl3\\.cmake|tools/sdl3-pin\\.cmake|deploy/docker/Dockerfile" ;; network) pattern="$common|$native|tests/network_|tests/fuzz/dev_session|third_party/mbedtls/|tools/prepare-mbedtls\.cmake|tools/mbedtls-pin\.cmake|deploy/docker/Dockerfile" diff --git a/tools/imgui-pin.cmake b/tools/imgui-pin.cmake new file mode 100644 index 0000000..c7636ad --- /dev/null +++ b/tools/imgui-pin.cmake @@ -0,0 +1,4 @@ +set(EVO_IMGUI_VERSION "1.92.9b") +set(EVO_IMGUI_COMMIT "f1cc2ae15e53a861a874c3034aae6798fde194ab") +set(EVO_IMGUI_SHA256 "21d8a0a565e85dce943e375db00812c2f3f0ab21f3f0f7964e364a63422d7f99") +set(EVO_IMGUI_URL "https://github.com/ocornut/imgui/archive/refs/tags/v${EVO_IMGUI_VERSION}.tar.gz") diff --git a/tools/prepare-imgui.cmake b/tools/prepare-imgui.cmake new file mode 100644 index 0000000..0f1e859 --- /dev/null +++ b/tools/prepare-imgui.cmake @@ -0,0 +1,22 @@ +cmake_minimum_required(VERSION 3.28) +include("${CMAKE_CURRENT_LIST_DIR}/imgui-pin.cmake") +set(root "${CMAKE_CURRENT_LIST_DIR}/../build/external/imgui") +file(MAKE_DIRECTORY "${root}") +if(NOT DEFINED IMGUI_ARCHIVE) + set(IMGUI_ARCHIVE "${root}/imgui-${EVO_IMGUI_VERSION}.tar.gz") + if(NOT EXISTS "${IMGUI_ARCHIVE}") + file(DOWNLOAD "${EVO_IMGUI_URL}" "${IMGUI_ARCHIVE}" TLS_VERIFY ON + EXPECTED_HASH "SHA256=${EVO_IMGUI_SHA256}" STATUS result) + list(GET result 0 code) + if(NOT code EQUAL 0) + message(FATAL_ERROR "Dear ImGui download failed: ${result}") + endif() + endif() +endif() +file(SHA256 "${IMGUI_ARCHIVE}" actual) +if(NOT actual STREQUAL EVO_IMGUI_SHA256) + message(FATAL_ERROR "Dear ImGui archive checksum mismatch; refusing extraction") +endif() +file(ARCHIVE_EXTRACT INPUT "${IMGUI_ARCHIVE}" DESTINATION "${root}") +file(WRITE "${root}/imgui-${EVO_IMGUI_VERSION}/evo-verified.sha256" "${actual}\n") +message(STATUS "Prepared Dear ImGui ${EVO_IMGUI_VERSION}; retain LICENSE.txt and docs/FONTS.md notices")