2026-07-30 19:08:57 +02:00
|
|
|
/*
|
|
|
|
|
* GerbView embind bindings.
|
|
|
|
|
*
|
|
|
|
|
* GerbView boots without a document (it is one of `FILELESS_TOOLS`), but a
|
|
|
|
|
* project route CAN name a gerber: clicking `Production/gerbers/board-F_Cu.gbr`
|
|
|
|
|
* on the project page deep-links here. Until this TU existed the bundle had no
|
|
|
|
|
* embind surface at all, so the shell staged the file into MEMFS and then had
|
|
|
|
|
* no way to say "open it" — GerbView came up empty and the user had to walk
|
|
|
|
|
* File→Open themselves.
|
|
|
|
|
*
|
|
|
|
|
* A gerber is rarely useful alone (a fabrication set is a stack of layers plus
|
|
|
|
|
* drill files), and `GERBVIEW_FRAME::OpenProjectFiles` already takes a LIST and
|
|
|
|
|
* auto-routes each entry by filename to the gerber / Excellon / job / archive
|
|
|
|
|
* loader, then zoom-fits. So the primary entry point here is the multi-file
|
|
|
|
|
* one: the shell hands over every gerber+drill sibling in the clicked file's
|
|
|
|
|
* folder, and the whole board renders.
|
|
|
|
|
*/
|
|
|
|
|
#include <emscripten.h>
|
|
|
|
|
#include <emscripten/bind.h>
|
|
|
|
|
#include <gerbview_frame.h>
|
|
|
|
|
#include <kiway_player.h>
|
|
|
|
|
#include <nlohmann/json.hpp>
|
|
|
|
|
#include <string>
|
|
|
|
|
#include <vector>
|
|
|
|
|
#include <wx/app.h>
|
|
|
|
|
#include <wx/string.h>
|
|
|
|
|
#include "open_gate.h"
|
jspi: migration phases 0-7 — build knob, scheduler shim, test successor suite
Toolchain: emsdk 6.0.6 (versions.sh; cache-hash keys on it). Build knob
PCBJAM_ASYNC_BACKEND=jspi|asyncify: build-kicad-target.sh links editors with
-sJSPI + -sJSPI_EXPORTS=@scripts/common/jspi-exports.txt + --pre-js
jspi-scheduler.js (no DYNCALLS, no post-link asyncify pipeline); wx build
stamps the backend and forces clean on flip or unknown provenance;
docker/build.sh passes the knob, seeds the emscripten ports cache from the
volume every launch, jspi postprocess = patch-env-shim only.
scripts/common/shims/jspi-scheduler.js: the JSPI successor scheduler —
token-wait registry, resume turnstile (one armed resume between engine
re-entries, SP swaps only at microtask boundaries), green-region spill
stacks (16-aligned tops), S1 embind mutator FIFO lane + parker wraps, S6
shutdown, libctx integration hooks (suspend/end/quarantine + g_current
arm/clear), SuspendError attributor, lost-wake + stuck-window watchdogs,
__wxWaitDump observability.
Embind: PARKER registrations get emscripten::async() under PCBJAM_JSPI
(wasm/bindings/pcbjam_async_policy.h). nanosleep yields route via the shim.
Tests: tests/asyncify -> tests/jspi successor suite (jspi-stack red/green
shadow-stack battery, jspi-coroutine MiniCoro harness, suspend-races
semantic scenarios + __wxWaitDump books coherence); projects jspi-firefox/
jspi-chrome (asyncify-webkit retired — no JSPI in WebKit); unconditional
Firefox JSPI pref; guard-beacons -> wait-beacons (+wxScheduler/libctxJspi
families); Makefile.wasm links test apps against JSPI with the shim as a
tracked link prerequisite.
Web: WasmTool setRo await + __wxWaitDump forensics, open-flow contained
promise, scheduler-shim.test.ts retargeted (8 green).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NDeBaKKhQztd8KiVtHuyXr
2026-08-13 07:06:24 +02:00
|
|
|
#include "pcbjam_async_policy.h"
|
2026-07-30 19:08:57 +02:00
|
|
|
|
|
|
|
|
using namespace emscripten;
|
|
|
|
|
using json = nlohmann::json;
|
|
|
|
|
|
|
|
|
|
static GERBVIEW_FRAME* gerbFrame()
|
|
|
|
|
{
|
|
|
|
|
return wxTheApp ? dynamic_cast<GERBVIEW_FRAME*>( wxTheApp->GetTopWindow() ) : nullptr;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
static bool openFileSet( const std::vector<wxString>& aFiles )
|
|
|
|
|
{
|
jspi cleanup: remove the asyncify-era residue — dead code, conditionals, pipeline scaffolding, stale prose
The runtime is JSPI-only; this removes everything that still pretended
otherwise. Three exhaustive sweeps (C++/JS+build+CI/tests+docs) drove
the inventory; every deletion verified by grep closure + full gates.
Broken-right-now fixes:
- deploy-staging.yml passed the retired opt_level input — the workflow
could not even start. Removed.
- env.sh carried dead exports with a live -sASYNCIFY=1 inside
(WASM_LDFLAGS/PTHREAD_LDFLAGS, zero consumers). Removed; the
WASM_LEGACY_EXCEPTIONS rationale rewritten to the real reason.
- docker/build.sh exported PCBJAM_ASYNC_BACKEND (read nowhere). Gone.
Dead weight removed:
- binaryen submodule (nothing builds or invokes it), wasm-opt-bench
workflow + scripts/bench/, get-wasm-opt.sh, diagnostics.js (242 lines
of Asyncify-API-only code), the KICAD_PIPELINE background-postprocess
scaffolding (existed to parallelize the deleted wasm-opt phase; the
postprocess is a seconds-long node script and now runs inline),
build-monitor's dead asyncify rows, sched-context orphan build
output, dead .gitignore entries, the .jspi-assets spike dir (the two
wf-result research JSONs moved to docs/features/async/migration-evidence/).
- bindings: fiber_park.h + its 12 embind registrations (broken-if-
called under JSPI), the kicadOpenFileStart/OPEN_JOB starter route,
main_stack_runner.h + 5 includes, the always-null context-sleep weak
hook in nanosleep_yield.c.
- shim: the backend field (installed-flag idempotency instead),
noteContextWait (dead both sides), the __wxAsyncifyDump alias (+ the
WasmTool fallback and string-dump normalize branch).
- web: the emscripten-6-ignored mainScriptUrlOrBlob option in boot.ts
(gerber-demo keeps it: it loads the deployed CDN release, which
predates emscripten 6 — noted inline).
Conditionals: all 'backend === jspi' checks reduced to scheduler-
presence checks; races_quiescent re-keyed from Asyncify.state (vacuous)
to real backlog quiescence (resumeReady/mutatorQueue — NOT _windowLive,
which is the probing activation's own window by definition).
Renames (identifiers only, no file renames): ASYNC_LINK_FLAGS→
JSPI_LINK_FLAGS and Makefile ASYNC_LDFLAGS→JSPI_LDFLAGS,
kicadCollabFiberBusy→kicadCollabBusy (embind + web + tests),
collab_common.h fiber*→apply*/coroutine naming, asyncifySignatures→
wasmTrapSignatures (lists byte-identical).
Tests: the two remaining vacuous [wx-asyncify]/fiber-resume-refused
asserts re-keyed to live JSPI beacons; eeschema-load's failure message
no longer sends the developer to a deleted script; wait-beacons' dead
families/parser deleted; lane-0 legacy-glue guards removed (lane 0 is
unconstructible); the embind test.fail re-gated with the JSPI reason
(plain embind invokers cannot suspend — verified still failing);
lint-determinism now scans tests/jspi (166 files clean);
eeschema-collab local-move gated to chromium (~50% flaky on FF even
solo; pcbnew twin covers both engines).
Docs: DEBUG.md rewritten as the JSPI debugging guide; build.md
describes the single-phase build; docs/features/async/README.md
banner-marked historical and repointed at the NEW
23-jspi-runtime.md (current architecture: export census, turnstile,
libcontext ownership + refusal contract, embind call shapes, the
em-pthread service-wrapper trick, exception policy, known gaps).
Gates on the cleaned tree: test:e2e 725 passed / 0 failed (after the
quiescence-probe fix; the 3 other reds were verified contention flakes
solo-green or the documented FF gate), web 76/0, jspi 18/18 both
engines, vitest 295/295 + 17/17, all lints green, live-app census
clean.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_016X9eh1s5sTx1o9Em9KBuwR
2026-08-14 09:25:32 +02:00
|
|
|
// Held across every suspension of the load (open_gate.h): the layer load
|
|
|
|
|
// suspends, and a wx timer dispatched into a half-built layer set traps.
|
2026-07-30 19:08:57 +02:00
|
|
|
pcbjam_open::BusyGuard busy;
|
|
|
|
|
|
|
|
|
|
GERBVIEW_FRAME* frame = gerbFrame();
|
|
|
|
|
|
|
|
|
|
if( !frame || aFiles.empty() )
|
|
|
|
|
return false;
|
|
|
|
|
|
|
|
|
|
return frame->OpenProjectFiles( aFiles, 0 );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/** Open ONE gerber/drill file (the generic single-file entry every app has). */
|
|
|
|
|
static bool kicadOpenFile( std::string path )
|
|
|
|
|
{
|
|
|
|
|
return openFileSet( { wxString::FromUTF8( path.c_str() ) } );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Open a whole fabrication set: a JSON array of MEMFS paths. Order is the
|
|
|
|
|
* caller's (the shell sorts, so layer order is stable across reloads).
|
|
|
|
|
* GERBVIEW_FRAME caps the set at GERBER_DRAWLAYERS_COUNT internally.
|
|
|
|
|
*/
|
|
|
|
|
static bool kicadOpenFiles( std::string pathsJson )
|
|
|
|
|
{
|
|
|
|
|
json paths = json::parse( pathsJson, nullptr, /*allow_exceptions*/ false );
|
|
|
|
|
|
|
|
|
|
if( !paths.is_array() )
|
|
|
|
|
return false;
|
|
|
|
|
|
|
|
|
|
std::vector<wxString> files;
|
|
|
|
|
|
|
|
|
|
for( const auto& entry : paths )
|
|
|
|
|
{
|
|
|
|
|
if( entry.is_string() )
|
|
|
|
|
files.push_back( wxString::FromUTF8( entry.get<std::string>().c_str() ) );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return openFileSet( files );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/** JS-pollable open-in-flight probe — same contract as the editors. */
|
|
|
|
|
static bool kicadOpenFileBusy()
|
|
|
|
|
{
|
|
|
|
|
return pcbjam_open::busy();
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EMSCRIPTEN_BINDINGS( gerbview )
|
|
|
|
|
{
|
jspi: migration phases 0-7 — build knob, scheduler shim, test successor suite
Toolchain: emsdk 6.0.6 (versions.sh; cache-hash keys on it). Build knob
PCBJAM_ASYNC_BACKEND=jspi|asyncify: build-kicad-target.sh links editors with
-sJSPI + -sJSPI_EXPORTS=@scripts/common/jspi-exports.txt + --pre-js
jspi-scheduler.js (no DYNCALLS, no post-link asyncify pipeline); wx build
stamps the backend and forces clean on flip or unknown provenance;
docker/build.sh passes the knob, seeds the emscripten ports cache from the
volume every launch, jspi postprocess = patch-env-shim only.
scripts/common/shims/jspi-scheduler.js: the JSPI successor scheduler —
token-wait registry, resume turnstile (one armed resume between engine
re-entries, SP swaps only at microtask boundaries), green-region spill
stacks (16-aligned tops), S1 embind mutator FIFO lane + parker wraps, S6
shutdown, libctx integration hooks (suspend/end/quarantine + g_current
arm/clear), SuspendError attributor, lost-wake + stuck-window watchdogs,
__wxWaitDump observability.
Embind: PARKER registrations get emscripten::async() under PCBJAM_JSPI
(wasm/bindings/pcbjam_async_policy.h). nanosleep yields route via the shim.
Tests: tests/asyncify -> tests/jspi successor suite (jspi-stack red/green
shadow-stack battery, jspi-coroutine MiniCoro harness, suspend-races
semantic scenarios + __wxWaitDump books coherence); projects jspi-firefox/
jspi-chrome (asyncify-webkit retired — no JSPI in WebKit); unconditional
Firefox JSPI pref; guard-beacons -> wait-beacons (+wxScheduler/libctxJspi
families); Makefile.wasm links test apps against JSPI with the shim as a
tracked link prerequisite.
Web: WasmTool setRo await + __wxWaitDump forensics, open-flow contained
promise, scheduler-shim.test.ts retargeted (8 green).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NDeBaKKhQztd8KiVtHuyXr
2026-08-13 07:06:24 +02:00
|
|
|
function( "kicadOpenFile", &kicadOpenFile PCBJAM_PARKER_POLICY );
|
|
|
|
|
function( "kicadOpenFiles", &kicadOpenFiles PCBJAM_PARKER_POLICY );
|
2026-07-30 19:08:57 +02:00
|
|
|
function( "kicadOpenFileBusy", &kicadOpenFileBusy );
|
|
|
|
|
}
|