@strategicprojects/rpic 0.12.0 → 0.13.0

package/README.md

@@ -81,7 +81,7 @@ first build. In Node, pass the math artifact's bytes:
 | Function | Description |
 |----------|-------------|
 | `ready(wasmInput?, {math?})` | Initialize WASM. Browser: no arg. Node: pass `.wasm` bytes/URL. `math: true` loads the math-enabled build; conflicting later calls reject. |
-| `compile(src, {circuits?, texlabels?})` | → `{ svg, animations, diagnostics, warnings, objects }` (throws on a pic error with `errorInfo`). |
+| `compile(src, {circuits?, texlabels?, scene?, flatten?, outline?})` | → `{ svg, animations, diagnostics, warnings, objects, places?, passthrough?, scene? }` (throws on a pic error with `errorInfo`; `places` = named `Label: position` points in SVG units, `passthrough` = troff `.` lines, each present only when the source has some). `scene: true` adds the device-independent resolved draw list ([docs/scene.md](https://github.com/milkway/rpic-lang/blob/main/docs/scene.md)); `flatten` (inches) delivers its curves as polylines. |
 | `renderSvg(src, {circuits?, texlabels?})` | → SVG string. |
 | `animate(root, animations, gsap)` | Build/play a GSAP timeline (`draw`/`fade`/`pop`). Browser only. |
 

package/index.d.ts

@@ -108,6 +108,54 @@ export interface SceneItem {
   }[];
   /** block items: the child item ids */
   items?: string[];
+  /**
+   * block items: where the block came from — the outermost macro call that
+   * expanded to it, or its opening `[` when written inline
+   */
+  span?: SourceSpan;
+  /** block items made by a macro: that outermost call */
+  call?: { name: string; args: string[] };
+}
+
+/** A source position, relative to its own source unit (like diagnostics). */
+export interface SourceSpan {
+  line: number;
+  col: number;
+  end_col: number;
+  /** absent = the user's input; `"circuits"` = the `-c` library; else the `copy` name */
+  file?: string;
+}
+
+/** A named place (`Label: position`) in the scene. */
+export interface ScenePlace {
+  /** the resolved label, subscripts included (`R[2]`) */
+  label: string;
+  /** scene units, the same frame as the items */
+  at: [number, number];
+  /** enclosing block item ids, outermost first */
+  block?: string[];
+  span?: SourceSpan;
+}
+
+/** A named place in the compile bundle: SVG user units, the `objects` frame. */
+export interface Place {
+  label: string;
+  x: number;
+  y: number;
+  line?: number;
+  col?: number;
+  end_col?: number;
+  file?: string;
+}
+
+/** A troff request line (`.` in column 1) set aside before lexing. */
+export interface Passthrough {
+  /** the line as written, leading `.` included */
+  text: string;
+  line: number;
+  col: number;
+  end_col: number;
+  file?: string;
 }
 
 /**
@@ -129,6 +177,8 @@ export interface Scene {
   source?: string;
   /** final values of every variable (user + pic built-ins) */
   vars: Record<string, number>;
+  /** named places (`Label: position`), evaluation order; empty when none */
+  places: ScenePlace[];
   items: SceneItem[];
 }
 
@@ -143,6 +193,10 @@ export interface Bundle {
   warnings: Diagnostic[];
   /** per-object geometry, index-aligned with the `<g id="sN">` groups */
   objects: ObjectGeometry[];
+  /** named places (`Label: position`) in SVG user units. Present only when the source defines some. */
+  places?: Place[];
+  /** troff request lines set aside before lexing. Present only when the source has some. */
+  passthrough?: Passthrough[];
   /**
    * `true` when the source used `animate scroll`, hinting the host to scrub
    * the timeline on scroll rather than autoplay. Present only when set.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strategicprojects/rpic",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "The pic graphics language compiled to SVG with animation manifests, via WebAssembly. Browser + Node.",
   "type": "module",
   "main": "./index.js",