mirror of
https://github.com/RTimothyEdwards/magic.git
synced 2026-09-05 08:51:53 +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.
58 lines
1.7 KiB
TypeScript
58 lines
1.7 KiB
TypeScript
export interface MagicInstance {
|
|
/**
|
|
* Initialize Magic (idempotent — safe to call multiple times).
|
|
* Returns 0 on success, non-zero on failure.
|
|
*/
|
|
init(): number;
|
|
|
|
/**
|
|
* Dispatch a single Magic command string.
|
|
* Calls init() automatically on the first invocation.
|
|
* Returns 0 on success, non-zero on failure.
|
|
*/
|
|
runCommand(command: string): number;
|
|
|
|
/**
|
|
* Read and execute a command file at the given virtual filesystem path.
|
|
* Calls init() automatically on the first invocation.
|
|
* Returns 0 on success, -1 if the file could not be opened.
|
|
*/
|
|
sourceFile(path: string): number;
|
|
|
|
/**
|
|
* Drive a display-update cycle.
|
|
* No-op in headless builds — the null display driver suspends all redraws.
|
|
*/
|
|
update(): void;
|
|
|
|
/**
|
|
* Emscripten virtual filesystem.
|
|
* Use FS.writeFile / FS.readFile to pass layout files in and out of Magic.
|
|
* See https://emscripten.org/docs/api_reference/Filesystem-API.html
|
|
*/
|
|
FS: any;
|
|
}
|
|
|
|
/**
|
|
* Create a Magic WASM instance.
|
|
*
|
|
* @param options Emscripten module options. Useful keys:
|
|
* - `wasmBinary` Pre-fetched ArrayBuffer of magic.wasm (avoids a second fetch)
|
|
* - `print` Callback for stdout lines (default: console.log)
|
|
* - `printErr` Callback for stderr lines (default: console.error)
|
|
*
|
|
* @example
|
|
* ```js
|
|
* import createMagic from 'magic-vlsi-wasm';
|
|
*
|
|
* const { runCommand, FS } = await createMagic();
|
|
* FS.writeFile('/work/inv.mag', layoutBytes);
|
|
* runCommand('tech load sky130A');
|
|
* runCommand('load /work/inv');
|
|
* runCommand('gds write /work/inv');
|
|
* const gds = FS.readFile('/work/inv.gds');
|
|
* ```
|
|
*/
|
|
export default function createMagic(options?: Record<string, unknown>): Promise<MagicInstance>;
|
|
export { createMagic };
|