Watch

History

Repository files (latest commit first)
Filename	Latest commit message	Latest commit date
Istvan Matejcsok bbeef6d20e feat(wasm): kicad_editor — merge the pcbnew+eeschema kifaces into ONE bundle (Part 2) All four editors (PCB / Footprint / Schematic / Symbol) are now runtime --frame choices of a single kicad_editor.wasm (178 MB at -O1 vs 147+82 separate; shared wx/common/boost linked once). One editor per page load, as before; frames pcb / fpedit / sch / symedit. - wasm/editor/: the merged executable target (single_top + both kiface library sets, whole-archive pcbcommon) + the safety-net focus-walk Kiface() dispatch TU. Gated by KICAD_WASM_MERGED_EDITOR (kicad submodule bump carries the fork side: per-engine Kiface/getter binding + ODR renames + dual-kiface launcher). - wasm/bindings/: per-editor collab entries renamed pcbCollab/schCollab (JS names unchanged); duplicate kicadOpenFile/kicadCollabOnSave + shared-name registrations guarded behind KICAD_MERGED_EMBIND; new kicad_editor_embind.cpp registers each shared JS name once, dispatching on the live frame. - Build: kicad_editor app (build wrapper, target case arms, 3-object embind compile with the ABI-critical flags, STUB_APP=pcbnew); docker/build.sh "all" = kicad_editor calculator pl_editor gerbview (pcbnew/eeschema stay as explicit debug apps); scripts/kicad/audit-merged-symbols.sh = repeatable ODR-collision audit (run on kicad bumps). - Frontend: Bundle type (bundle ≠ tool); TOOL_BUNDLE maps all four editors to kicad_editor; explicit --frame tokens for pcbnew (pcb) and eeschema (sch); publish list = the 4 real bundles. - Tests/CI: five harnesses load kicad_editor.js with explicit frame tokens; PCBNEW_FAMILY_SPECS renamed BIG_MODULE_SPECS + the 8 eeschema-family specs (they now boot the merged module — SpiderMonkey x86 CI OOM routing); frame-runtime spec covers all four frames from the one bundle. Validated so far: frame-runtime 4/4 (each frame boots with the right title, no aborts, no duplicate embind registration); 24-spec merged-module regression green; 3D raytracer renders. Known pre-existing failure: 3d-viewer title-bar drag deadlock, fixed on main by `7630c7e` (2N+8 pthread pre-warm) — picked up by the follow-up rebase. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>		2026-07-02 17:56:02 +02:00
..
build.sh	feat(wasm): kicad_editor — merge the pcbnew+eeschema kifaces into ONE bundle (Part 2)	2026-07-02 17:56:02 +02:00
docker-compose.yml	feat(wasm-eh): migrate the WASM build to native wasm exceptions (+ 3D viewer default-on)	2026-06-30 09:40:26 +02:00
Dockerfile	feat(wasm-eh): migrate the WASM build to native wasm exceptions (+ 3D viewer default-on)	2026-06-30 09:40:26 +02:00
entrypoint.sh	fix(docker): make container emsdk authoritative for exec, stop host emsdk leak	2026-05-25 19:41:55 +02:00
README.md	Add Quick Start docs and branch-specific Docker builds	2026-01-03 09:08:12 +01:00
shell.sh	feat(wasm-eh): migrate the WASM build to native wasm exceptions (+ 3D viewer default-on)	2026-06-30 09:40:26 +02:00

README.md

Docker Build Environment for KiCad WASM

This directory contains Docker configuration for building KiCad for WebAssembly in a reproducible, isolated environment.

Prerequisites

Docker Desktop (with Docker Compose v2)
Git submodules initialized: git submodule update --init --recursive

Quick Start

# Build KiCad WASM (full build)
./docker/build.sh

# Build with options
./docker/build.sh --no-clean    # Skip cleaning build directory
./docker/build.sh --debug       # Build with debug symbols

# Interactive shell for debugging
./docker/shell.sh

Branch-Specific Builds

Each git branch gets isolated Docker containers and volumes, enabling parallel development:

# On branch 'main' → containers/volumes prefixed with 'kicad-wasm-main'
# On branch 'feature-x' → containers/volumes prefixed with 'kicad-wasm-feature-x'

This allows you to:

Work on multiple branches simultaneously using git worktrees
Each worktree has its own build cache (no conflicts)
Switch branches without rebuilding from scratch

Using git worktrees for parallel development:

# Create a worktree for a new branch
git worktree add ../kicad-wasm-feature path/to/branch

# Build in the worktree (uses isolated Docker volumes)
cd ../kicad-wasm-feature
./docker/build.sh

# List all worktrees
git worktree list

What Gets Built

The build process includes:

Dependencies (cached in Docker volume):
- GLM (header-only)
- Zstd, Protobuf
- FreeType, HarfBuzz
- Pixman, Cairo
- Boost (Locale)
- OpenCASCADE (optional, for 3D/STEP)
- CURL headers, libgit2 headers (stubs)
wxWidgets (built from submodule)
KiCad PCBnew (main application)

Container Resources

Configured for M4 Max (adjust in docker-compose.yml):

CPUs: 10 cores
Memory: 16GB

Volume Strategy

Path	Type	Purpose
`/workspace`	Bind mount	Source code
`/workspace/build-wasm`	Named volume	Build cache (deps, sysroot)
`/workspace/output`	Bind mount	Final WASM output

Common Commands

# Start container
docker compose -f docker/docker-compose.yml up -d

# Run a command inside
docker compose -f docker/docker-compose.yml exec kicad-wasm-builder <command>

# View logs
docker compose -f docker/docker-compose.yml logs -f

# Stop container
docker compose -f docker/docker-compose.yml down

# Clear build cache (full rebuild)
docker volume rm docker_kicad-build-cache

Troubleshooting

Build freezes

The OpenCASCADE build is very resource-intensive. If it freezes:

Reduce parallel jobs: Edit script to use -j4 instead of -j$(nproc)
Monitor with docker stats
Consider building OpenCASCADE separately with ./scripts/deps/build-opencascade.sh

Permission issues

Files created in container are owned by root. To fix:

sudo chown -R $(whoami) output/

Cache issues

# Clear all cached builds
docker volume rm docker_kicad-build-cache

# Or clear specific stamps inside container
./docker/shell.sh
rm /workspace/build-wasm/stamps/*.stamp