feat: symbol_editor WASM port

docker/build.sh

@@ -9,7 +9,9 @@
 #   pcbnew         PCB editor
 #   eeschema       schematic editor
 #   calculator     PCB calculator
-#   all          build pcbnew, eeschema, calculator sequentially
+#   pl_editor      drawing-sheet editor
+#   symbol_editor  symbol editor (eeschema kiface, FRAME_SCH_SYMBOL_EDITOR)
+#   all            build all of the above sequentially
 #
 # Any extra args are forwarded to scripts/kicad/build-<app>.sh (e.g. -j 8,
 # --full, --release, --diag=gal).
@@ -46,7 +48,7 @@ trap 'kw_fail 130; exit 130' INT TERM
 
 cd "$(dirname "$0")/.."
 
-VALID_APPS="pcbnew | eeschema | calculator | pl_editor | all"
+VALID_APPS="pcbnew | eeschema | calculator | pl_editor | symbol_editor | all"
 
 usage() {
     echo "Usage: ./docker/build.sh <app> [args...]" >&2
@@ -69,7 +71,7 @@ APP_NAME="$1"
 shift
 
 case "$APP_NAME" in
-    pcbnew|eeschema|calculator|pl_editor|all) ;;
+    pcbnew|eeschema|calculator|pl_editor|symbol_editor|all) ;;
     *)
         echo "Error: unknown app '$APP_NAME' (expected: ${VALID_APPS})" >&2
         usage
@@ -134,6 +136,7 @@ kicad_subdir_for() {
     case "$1" in
         calculator)    echo "pcb_calculator" ;;
         pl_editor)     echo "pagelayout_editor" ;;
+        symbol_editor) echo "eeschema" ;;
         *)             echo "$1" ;;
     esac
 }
@@ -182,10 +185,11 @@ build_app() {
 }
 
 if [[ "${APP_NAME}" == "all" ]]; then
-    build_app pcbnew 1 4
+    build_app pcbnew 1 5
-    build_app eeschema 2 4
+    build_app eeschema 2 5
-    build_app calculator 3 4
+    build_app calculator 3 5
-    build_app pl_editor 4 4
+    build_app pl_editor 4 5
+    build_app symbol_editor 5 5
 else
     build_app "${APP_NAME}" 1 1
 fi

features/symbol-editor/0001-symbol-editor-port.md

@@ -0,0 +1,85 @@
+# Symbol Editor WASM port — design notes
+
+## Goal
+
+Bring up KiCad's Symbol Editor (`FRAME_SCH_SYMBOL_EDITOR`, the `.kicad_sym`
+library editor) in the browser, to the same "boots, canvas visible, click
+around" level as the other ported apps. Scope is launch-only — library
+load/save and the symbol viewer/chooser sub-frames are out of scope for now.
+
+## Key insight
+
+Unlike pcbnew / pl_editor, the symbol editor is **not a separate program**. It is
+served by the **eeschema kiface**: its sources already compile into
+`eeschema_kiface_objects` (`EESCHEMA_LIBEDIT_SRCS` + the `symbol_editor_*` tools in
+`kicad/eeschema/CMakeLists.txt`). KiCad's universal launcher `common/single_top.cpp`
+opens whichever frame the compile-time `TOP_FRAME` macro names.
+
+So the port is just **a second launcher executable (`symbol_editor`) that links the
+same eeschema kiface but compiles `single_top.cpp` with
+`TOP_FRAME=FRAME_SCH_SYMBOL_EDITOR`** — no new sources, no new kiface, no extracting
+symbol-editor code. The eeschema kiface (deps, navlib, stubs, libraries) is reused
+verbatim.
+
+## Changes
+
+### kicad submodule (2 files)
+
+- **`kicad/eeschema/CMakeLists.txt`** — a WASM-only (`if( EMSCRIPTEN )`) block adds the
+  `symbol_editor` executable. Because `single_top.cpp`'s `COMPILE_DEFINITIONS` are
+  directory-scoped (already pinned to `TOP_FRAME=FRAME_SCH` for the `eeschema` exe),
+  we `configure_file`-copy it to a private TU (`symbol_editor_single_top.cpp`) and set
+  that copy's `TOP_FRAME=FRAME_SCH_SYMBOL_EDITOR;PGM_DATA_FILE_EXT="kicad_sym"`. The exe
+  links `EESCHEMA_KIFACE_LIBRARIES` directly with `LINKER:--allow-multiple-definition`,
+  mirroring the eeschema/pcbnew static-link pattern.
+- **`kicad/eeschema/eeschema.cpp`** — `IFACE::CreateKiWindow`'s `FRAME_SCH_SYMBOL_EDITOR`
+  case was stubbed to `return nullptr` on `__EMSCRIPTEN__` during the eeschema MVP
+  (see `features/schematic/0001-eeschema-iface-stubs.md`). That stub is now removed so
+  the frame is constructed in WASM like the native build. This was THE blocker: with the
+  stub, `Kiway.Player(FRAME_SCH_SYMBOL_EDITOR)` returned null, `single_top`'s `OnInit`
+  bailed, and the app sat idle with a blank canvas (no abort, no error).
+
+  The symbol viewer (`FRAME_SCH_VIEWER`) and chooser (`FRAME_SYMBOL_CHOOSER`) remain
+  stubbed — out of scope, and the chooser needs bundled libraries we don't ship.
+
+### Root repo
+
+- **`scripts/kicad/build-symbol_editor.sh`** — thin wrapper around
+  `build-kicad-target.sh symbol_editor`.
+- **`scripts/kicad/build-kicad-target.sh`** — adds `symbol_editor` to the `case`. CMake
+  target is `symbol_editor` but its build subdir is `eeschema` (it's part of that
+  kiface), so a `KICAD_SUBDIR` variable now distinguishes target name from subdir for
+  the output-path log and embind include.
+- **`docker/build.sh`** — adds `symbol_editor` to valid apps, the `all` loop, and
+  `kicad_subdir_for` (`symbol_editor → eeschema`); artifacts land at
+  `build-wasm/kicad-symbol_editor/eeschema/symbol_editor.{js,wasm}`.
+- **`tests/apps/kicad/symbol_editor.html`** — browser shell (copy of eeschema.html with
+  title + `thisProgram=/usr/bin/symbol_editor` + `symbol_editor.js`).
+- **`tests/scripts/setup-kicad-wasm.sh`** — `copy_app symbol_editor` + subdir map entry.
+- **`tests/kicad/symbol_editor.spec.ts`** + **`tests/package.json`** — launch-scope smoke
+  test (canvas visible, registry populated, toolbars present, no WASM abort), mirroring
+  eeschema's wizard-aware flow.
+
+### wxwidgets submodule
+
+No changes needed — the file-dialog and double-click fixes landed with the pl_editor port.
+
+## Build & verify
+
+```
+./docker/build.sh symbol_editor
+cd tests && npm run setup:kicad && npm run test:symbol_editor
+# or serve tests/apps/kicad and open symbol_editor.html
+```
+
+Expect: the symbol editor window opens — menu bar, top + left + right toolbars
+(incl. pin/rect/circle/line drawing tools), the symbol library tree pane with the
+filter box, the gridded canvas with the symbol-origin crosshair, and a status bar.
+
+## Known limitations
+
+- No bundled symbol libraries, so the library tree is empty (`SyncLibraries` reports
+  `libCount=0`). Opening/creating/saving `.kicad_sym` files is untested (out of scope).
+- Symbol viewer and symbol chooser frames are still stubbed out for WASM.
+- No persistent storage (MEMFS only).
+</content>

kicad

@@ -1 +1 @@
-Subproject commit 881ab171814da6e73e116f91e9e18fb4dd9fcf6b
+Subproject commit 211ab47df18abe03af3c8c1c8cfbbe5a42520129

scripts/kicad/build-kicad-target.sh

@@ -31,21 +31,37 @@
 set -e
 
 if [ -z "$1" ]; then
-    echo "Error: missing <app> argument (pcbnew | eeschema | calculator | pl_editor)" >&2
+    echo "Error: missing <app> argument (pcbnew | eeschema | calculator | pl_editor | symbol_editor)" >&2
     exit 1
 fi
 APP_NAME="$1"
 shift
 
+# KICAD_TARGET: the CMake/make target name.
+# KICAD_SUBDIR: the source/build subdirectory the target's artifacts land in.
+# Most apps share all three names; the exceptions:
+#   - calculator:    target+subdir are both pcb_calculator (OUTPUT_NAME=calculator)
+#   - pl_editor:     subdir is pagelayout_editor (upstream source dir name)
+#   - symbol_editor: served by the eeschema kiface, so it builds in eeschema/
 case "$APP_NAME" in
-    pcbnew|eeschema|pl_editor)
+    pcbnew|eeschema)
         KICAD_TARGET="$APP_NAME"
+        KICAD_SUBDIR="$APP_NAME"
+        ;;
+    pl_editor)
+        KICAD_TARGET="pl_editor"
+        KICAD_SUBDIR="pagelayout_editor"
         ;;
     calculator)
         KICAD_TARGET="pcb_calculator"
+        KICAD_SUBDIR="pcb_calculator"
+        ;;
+    symbol_editor)
+        KICAD_TARGET="symbol_editor"
+        KICAD_SUBDIR="eeschema"
         ;;
     *)
-        echo "Error: unknown app '$APP_NAME' (expected: pcbnew | eeschema | calculator | pl_editor)" >&2
+        echo "Error: unknown app '$APP_NAME' (expected: pcbnew | eeschema | calculator | pl_editor | symbol_editor)" >&2
         exit 1
         ;;
 esac
@@ -378,7 +394,7 @@ emcmake cmake "${KICAD_DIR}" \
 if [ -f "${EMBIND_SRC}" ]; then
     log_info "Compiling Embind bindings (${APP_NAME})..."
     # Use the same includes and flags that KiCad uses
-    KICAD_INCLUDES="-I${KICAD_BUILD} -I${KICAD_DIR}/include -I${KICAD_DIR}/${KICAD_TARGET} -I${KICAD_DIR}/common"
+    KICAD_INCLUDES="-I${KICAD_BUILD} -I${KICAD_DIR}/include -I${KICAD_DIR}/${KICAD_SUBDIR} -I${KICAD_DIR}/common"
     KICAD_INCLUDES+=" -I${KICAD_DIR}/libs/core/include -I${KICAD_DIR}/libs/kimath/include -I${KICAD_DIR}/libs/kiplatform/include"
     KICAD_INCLUDES+=" -I${KICAD_DIR}/thirdparty/clipper2/Clipper2Lib/include"
     KICAD_INCLUDES+=" -I${KICAD_DIR}/thirdparty/nlohmann_json"
@@ -410,4 +426,4 @@ emmake make bitmap_archive_build
 # Step 9: Create stamp file
 create_stamp "${KICAD_STAMP}"
 log_info "KiCad ${APP_NAME} build complete!"
-log_info "Output: ${KICAD_BUILD}/${KICAD_TARGET}/${APP_NAME}.js"
+log_info "Output: ${KICAD_BUILD}/${KICAD_SUBDIR}/${APP_NAME}.js"

scripts/kicad/build-symbol_editor.sh

@@ -0,0 +1,7 @@
+#!/bin/bash
+# Build KiCad Symbol Editor for WebAssembly.
+# Thin wrapper around build-kicad-target.sh — see that script for options.
+
+set -e
+SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+exec "${SCRIPT_DIR}/build-kicad-target.sh" symbol_editor "$@"

tests/apps/kicad/symbol_editor.html

@@ -0,0 +1,199 @@
+<!DOCTYPE html>
+<html lang="en-us">
+<head>
+  <meta charset="utf-8">
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <title>KiCad Symbol Editor WASM</title>
+  <style>
+    .emscripten { padding-right: 0; margin-left: auto; margin-right: auto; display: block; }
+    div.emscripten { text-align: center; }
+    /* the canvas *must not* have any border or padding, or mouse coords will be wrong */
+    canvas.emscripten { border: 0px none; }
+
+    .window {
+      position: absolute;
+      pointer-events: none;
+      z-index: 10;
+      background-color: black;
+      overflow: hidden;
+      width: 0;
+      height: 0;
+    }
+
+    .window-canvas {
+      position: absolute;
+      top: 0;
+      left: 0;
+      pointer-events: none;
+    }
+
+    #status {
+      position: fixed;
+      bottom: 10px;
+      left: 10px;
+      color: #fff;
+      font-family: monospace;
+      z-index: 1000;
+      background: rgba(0,0,0,0.7);
+      padding: 10px;
+      border-radius: 5px;
+    }
+
+    #progress {
+      width: 300px;
+      height: 20px;
+      background: #333;
+      margin-top: 5px;
+    }
+
+    #progress-bar {
+      height: 100%;
+      background: #4CAF50;
+      width: 0%;
+      transition: width 0.3s;
+    }
+  </style>
+</head>
+<body style="margin: 0; padding: 0; width: 100%; height: 100%; overflow: hidden; background: #1a1a2e;">
+  <div id="main-window" style="width: 100vw; height: 100vh; position: absolute; top: 0; left: 0;"></div>
+
+  <div id="status">
+    <div id="status-text">Initializing...</div>
+    <div id="progress"><div id="progress-bar"></div></div>
+  </div>
+
+  <div id="window-container"></div>
+
+  <script>
+    var mainWindow = document.getElementById('main-window');
+    var statusText = document.getElementById('status-text');
+    var progressBar = document.getElementById('progress-bar');
+
+    var showError = function(msg) {
+      console.error('[KICAD_ERROR] ' + msg);
+      statusText.textContent = 'Error: ' + msg;
+      statusText.style.color = 'red';
+    };
+
+    var createCanvas = function() {
+      var canvas = document.createElement('canvas');
+      canvas.id = 'canvas';
+      canvas.style.display = 'none';
+      // wx.js owns the backing-store size via setWindowRect(); keep the HTML
+      // shell responsible only for the CSS size.
+      var width = window.innerWidth;
+      var height = window.innerHeight;
+      canvas.style.width = width + 'px';
+      canvas.style.height = height + 'px';
+      canvas.oncontextmenu = function() { event.preventDefault(); };
+      canvas.addEventListener("webglcontextlost", function(e) {
+        showError('WebGL context lost. You will need to reload the page.');
+        e.preventDefault();
+      }, false);
+
+      mainWindow.appendChild(canvas);
+      Module.canvas = canvas;
+
+      console.log('[KICAD] preRun complete, canvas created: ' + width + 'x' + height);
+    };
+
+    var onRuntimeInitialized = function() {
+      console.log('[KICAD] Runtime initialized');
+      var canvas = Module.canvas;
+      canvas.style.display = 'block';
+      document.getElementById('status').style.display = 'none';
+    };
+
+    // Pre-fetched resource data (fetched before symbol_editor.js loads)
+    var resourceData = null;
+
+    // Start fetching images.tar.gz immediately (runs in parallel with WASM loading)
+    fetch('images.tar.gz')
+      .then(function(response) {
+        if (!response.ok) throw new Error('HTTP ' + response.status);
+        return response.arrayBuffer();
+      })
+      .then(function(buffer) {
+        resourceData = new Uint8Array(buffer);
+        console.log('[KICAD] Prefetched images.tar.gz (' + resourceData.length + ' bytes)');
+      })
+      .catch(function(err) {
+        console.warn('[KICAD] Could not prefetch images.tar.gz:', err.message);
+      });
+
+    // Write pre-fetched resources to FS (called in preRun after FS is available)
+    var writeResources = function() {
+      // Create directory structure matching KiCad's compiled-in KICAD_DATA path
+      // This path is baked in during CMake configuration
+      var resourcePath = '/workspace/build-wasm/sysroot/share/kicad/resources';
+      FS.mkdirTree(resourcePath);
+
+      // Write pre-fetched data if available
+      if (resourceData) {
+        FS.writeFile(resourcePath + '/images.tar.gz', resourceData);
+        console.log('[KICAD] Wrote images.tar.gz to ' + resourcePath);
+      } else {
+        console.warn('[KICAD] images.tar.gz not ready yet (WASM loaded faster than fetch)');
+      }
+    };
+
+    var Module = {
+      thisProgram: '/usr/bin/symbol_editor',  // Fake absolute path for argv[0] (KiCad DEBUG check)
+
+      preRun: [createCanvas, writeResources],
+      postRun: [],
+
+      print: function(text) {
+        if (arguments.length > 1)
+          text = Array.prototype.slice.call(arguments).join(' ');
+        console.log('[KICAD_OUT] ' + text);
+      },
+
+      printErr: function(text) {
+        if (arguments.length > 1)
+          text = Array.prototype.slice.call(arguments).join(' ');
+        console.error('[KICAD_ERR] ' + text);
+      },
+
+      setStatus: function(text) {
+        console.log('[KICAD_STATUS] ' + text);
+        statusText.textContent = text;
+
+        // Parse progress from status text
+        var match = text.match(/(\d+)\/(\d+)/);
+        if (match) {
+          var pct = (parseInt(match[1]) / parseInt(match[2])) * 100;
+          progressBar.style.width = pct + '%';
+        }
+      },
+
+      totalDependencies: 0,
+      monitorRunDependencies: function(left) {
+        this.totalDependencies = Math.max(this.totalDependencies, left);
+        Module.setStatus(left ? 'Preparing... (' + (this.totalDependencies-left) + '/' + this.totalDependencies + ')' : 'All downloads complete.');
+      },
+
+      onRuntimeInitialized: onRuntimeInitialized,
+
+      // Required for locating .wasm and .worker.js files
+      locateFile: function(path) {
+        return path;
+      }
+    };
+
+    Module.setStatus('Downloading...');
+
+    window.onerror = function(msg, url, line) {
+      showError(msg + ' at ' + url + ':' + line);
+      Module.setStatus = function(text) {
+        if (text) Module.printErr('[post-exception status] ' + text);
+      };
+      return false;
+    };
+  </script>
+
+  <!-- wxWidgets WASM glue code (defines getConfigEntryLength, etc.) -->
+  <script src="wx.js"></script>
+  <script async src="symbol_editor.js"></script>
+</body>
+</html>

tests/kicad/symbol_editor.spec.ts

@@ -0,0 +1,105 @@
+import type { Page } from '@playwright/test';
+import { test, expect } from './fixtures';
+import { clickByLabel } from '../e2e/utils/element-tracker';
+
+/**
+ * Symbol Editor WASM E2E Tests
+ *
+ * The symbol editor (FRAME_SCH_SYMBOL_EDITOR) is served by the eeschema kiface;
+ * the standalone `symbol_editor` launcher opens that frame directly. It shares
+ * the same first-run setup wizard as eeschema/pcbnew, so the launch flow mirrors
+ * eeschema.spec.ts: wait for the canvas, click through the wizard, then assert the
+ * editor chrome built. Scope is launch-only — the editor must start, paint a
+ * canvas + toolbars, populate the element registry, and produce no WASM abort.
+ * Library load/save and other features are intentionally out of scope here.
+ */
+
+async function completeWizard(page: Page): Promise<void> {
+    await expect(page.locator('#canvas')).toBeVisible({ timeout: 90000 });
+    await page.waitForFunction(() => !!window.wxElementRegistry, null, { timeout: 90000 });
+    // The frame builds its UI a beat after the registry object appears; wait for
+    // the registry to actually have entries (the wizard or the editor itself)
+    // before driving it, otherwise we screenshot a blank canvas.
+    await page.waitForFunction(() => {
+        const registry = window.wxElementRegistry;
+        return !!registry && registry.findAll({}).length > 0;
+    }, null, { timeout: 90000 });
+    await page.waitForTimeout(2000);
+
+    await page.screenshot({ path: 'test-results/symbol_editor-wizard-00-initial.png', scale: 'device' });
+
+    for (let i = 1; i <= 10; i++) {
+        let clicked = await clickByLabel(page, 'Next >');
+
+        if (!clicked) {
+            clicked = await clickByLabel(page, 'Finish');
+
+            if (clicked) {
+                await page.waitForTimeout(500);
+                await page.screenshot({
+                    path: `test-results/symbol_editor-wizard-${String(i).padStart(2, '0')}-finish.png`,
+                    scale: 'device'
+                });
+            }
+
+            break;
+        }
+
+        await page.waitForTimeout(500);
+        await page.screenshot({
+            path: `test-results/symbol_editor-wizard-${String(i).padStart(2, '0')}.png`,
+            scale: 'device'
+        });
+    }
+
+    await page.waitForTimeout(2000);
+}
+
+function hasAbort(testLogger: { consoleLogs: string[]; errors: string[] }): boolean {
+    return [...testLogger.consoleLogs, ...testLogger.errors].some(line => line.includes('Aborted('));
+}
+
+test.describe('symbol_editor WASM', () => {
+    test.beforeEach(async ({ page }) => {
+        await page.goto('/kicad/symbol_editor.html');
+    });
+
+    test('app loads, canvas visible, no WASM abort', async ({ page, testLogger }) => {
+        await completeWizard(page);
+        await page.screenshot({ path: 'test-results/symbol_editor-01-loaded.png', scale: 'device' });
+
+        expect(hasAbort(testLogger), 'no WASM abort during load').toBe(false);
+
+        const canvasCount = await page.locator('canvas').count();
+        expect(canvasCount).toBeGreaterThan(0);
+    });
+
+    test('canvas + toolbar metrics look sane', async ({ page, testLogger }) => {
+        await completeWizard(page);
+
+        const metrics = await page.evaluate(() => {
+            const registry = window.wxElementRegistry;
+            const all = registry ? registry.findAll({ visible: true }) : [];
+            const toolbars = all.filter((el: { typeName: string }) => /ToolBar/.test(el.typeName));
+            const glCanvas = document.querySelector('canvas[id^="glcanvas-"]') as HTMLCanvasElement | null;
+
+            return {
+                registryTotal: all.length,
+                toolbarCount: toolbars.length,
+                mainCanvasOk: (() => {
+                    const c = document.getElementById('canvas') as HTMLCanvasElement | null;
+                    return !!c && c.width > 0 && c.height > 0;
+                })(),
+                glCanvasOk: !!glCanvas && glCanvas.width > 0 && glCanvas.height > 0,
+            };
+        });
+
+        await page.screenshot({ path: 'test-results/symbol_editor-02-metrics.png', scale: 'device' });
+
+        expect(metrics.registryTotal, 'registry should be populated').toBeGreaterThan(10);
+        expect(metrics.toolbarCount, 'at least one toolbar should be visible').toBeGreaterThanOrEqual(1);
+        expect(metrics.mainCanvasOk, 'main canvas has nonzero dimensions').toBe(true);
+        expect(metrics.glCanvasOk, 'GL canvas has nonzero dimensions').toBe(true);
+        expect(hasAbort(testLogger)).toBe(false);
+    });
+});

tests/package.json

@@ -23,6 +23,10 @@
     "test:calculator:chrome": "npm run setup:kicad && playwright test --config=playwright-kicad.config.ts --project=chromium --headed kicad/calculator.spec.ts",
     "test:calculator": "npm run test:calculator:firefox",
     "test:calculator:headed": "npm run test:calculator:chrome",
+    "test:symbol_editor:firefox": "npm run setup:kicad && playwright test --config=playwright-kicad.config.ts --project=firefox kicad/symbol_editor.spec.ts",
+    "test:symbol_editor:chrome": "npm run setup:kicad && playwright test --config=playwright-kicad.config.ts --project=chromium --headed kicad/symbol_editor.spec.ts",
+    "test:symbol_editor": "npm run test:symbol_editor:firefox",
+    "test:symbol_editor:headed": "npm run test:symbol_editor:chrome",
     "test:coroutine:firefox": "playwright test --config=playwright-coroutine.config.ts --project=firefox",
     "test:coroutine:chrome": "playwright test --config=playwright-coroutine.config.ts --project=chromium --headed"
   },

tests/scripts/setup-kicad-wasm.sh

@@ -23,6 +23,7 @@ kicad_subdir_for() {
     case "$1" in
         calculator)    echo "pcb_calculator" ;;
         pl_editor)     echo "pagelayout_editor" ;;
+        symbol_editor) echo "eeschema" ;;
         *)             echo "$1" ;;
     esac
 }
@@ -67,9 +68,10 @@ copy_app pcbnew     && found_any=1
 copy_app eeschema      && found_any=1
 copy_app calculator    && found_any=1
 copy_app pl_editor     && found_any=1
+copy_app symbol_editor && found_any=1
 
 if [ "$found_any" -eq 0 ]; then
-    echo "Error: no pcbnew/eeschema/calculator/pl_editor artifacts found in output/ or docker volume" >&2
+    echo "Error: no pcbnew/eeschema/calculator/pl_editor/symbol_editor artifacts found in output/ or docker volume" >&2
     exit 1
 fi