mirror of
https://github.com/RTimothyEdwards/magic.git
synced 2026-08-29 01:24:51 +02:00
Intubun
8560027569
The user-facing layer of the WASM port: a publishable npm package
plus the GitHub Actions that build and ship it.
* npm/package.json — publishes as `magic-vlsi-wasm`, ESM-only, HPND
licensed, version tracks Magic's own VERSION file (8.3.637).
Whitelists the published files and exposes index.js + index.d.ts.
* npm/index.js, npm/index.d.ts — thin JS/TS wrapper around the four
WASM exports. createMagic(opts) returns { init, runCommand,
sourceFile, update, FS } so consumers can write into the
Emscripten virtual filesystem and dispatch Magic commands from
Node.js, browsers or Web Workers.
* npm/build.sh — end-to-end build: locates emsdk (via PATH or
EMSDK_DIR), runs distclean+configure+make in the right order
(techs before mains so embed-files are present), copies
magic.js / magic.wasm into npm/. Optional --release, --test,
--pack flags. Preserves configure's exec bits across invocations.
* npm/pack.sh — produces a reproducible npm tarball by touching
every file to the build time and exporting SOURCE_DATE_EPOCH so
pacote does not rewrite mtimes to its 1985 fallback.
* npm/examples/ — runnable smoke tests for the four common
workflows (extract, gds, drc, cif), driven by examples/all.js.
Each example is self-contained and uses the bundled siliwiz
technology. helpers.js encapsulates the boilerplate.
* npm/LICENSE, npm/README.md — license text and consumer-facing
docs (install, quick-start, API, examples, build-from-source,
license, third-party content notice).
* .github/workflows/main.yml — adds a `simple_build_wasm` job that
installs a pinned emsdk (3.1.56), builds the WASM module, runs
the example test suite and uploads the npm tarball as an
artifact. Pinned for reproducibility against the post-build.sh
patches; switchable to "latest" by commenting two lines.
* .github/workflows/main-aarch64.yml — drops the now-redundant
WASM ARM job. WASM is architecture-independent.
* .github/workflows/npm-publish.yml — new workflow. Publishes to
npm on `v*` tag pushes (manual `workflow_dispatch` supported as
a dry-run). Uses the same pinned emsdk and pack.sh.
Also sets FORCE_JAVASCRIPT_ACTIONS_TO_NODE24 in both workflows to
silence the Node.js 20 deprecation warnings until
actions/upload-artifact@v6 ships a Node-24 release.
41 lines
1.4 KiB
JavaScript
41 lines
1.4 KiB
JavaScript
// example.js — GDS → CIF format conversion using the Magic WASM module.
|
|
//
|
|
// Usage:
|
|
// node examples/example.js [input.gds] [output.cif]
|
|
//
|
|
// Defaults:
|
|
// input: design.gds (in current working directory)
|
|
// output: design.cif (in current working directory)
|
|
|
|
import { readFileSync, writeFileSync } from 'node:fs';
|
|
import { fileURLToPath } from 'node:url';
|
|
import { dirname, resolve, basename } from 'node:path';
|
|
import createMagicModule from '../magic.js';
|
|
|
|
const __dirname = dirname(fileURLToPath(import.meta.url));
|
|
|
|
const wasmBinary = readFileSync(resolve(__dirname, '../magic.wasm'));
|
|
|
|
const inputGds = process.argv[2] ?? 'design.gds';
|
|
const outputCif = process.argv[3] ?? inputGds.replace(/\.gds$/i, '.cif');
|
|
const cellName = basename(inputGds, '.gds');
|
|
|
|
const module = await createMagicModule({
|
|
wasmBinary,
|
|
print: msg => console.log('[magic]', msg),
|
|
printErr: msg => console.error('[magic]', msg),
|
|
});
|
|
|
|
module.FS.mkdirTree('/work');
|
|
module.FS.writeFile(`/work/${cellName}.gds`, readFileSync(inputGds));
|
|
|
|
module._magic_wasm_init();
|
|
module.cwrap('magic_wasm_run_command', 'number', ['string'])(`gds read /work/${cellName}`);
|
|
module.cwrap('magic_wasm_run_command', 'number', ['string'])(`load ${cellName}`);
|
|
module.cwrap('magic_wasm_run_command', 'number', ['string'])(`cif write /work/${cellName}`);
|
|
|
|
const cifBytes = module.FS.readFile(`/work/${cellName}.cif`);
|
|
writeFileSync(outputCif, cifBytes);
|
|
|
|
console.log(`Converted ${inputGds} → ${outputCif}`);
|