@chestnutlabs/gcode-parser 0.17.0 → 0.19.0

package/dist/rs274.d.ts

@@ -0,0 +1,107 @@
+/** Warning codes surfaced to the IR (DD-017 §4.6). */
+export declare const RS274_WARN: {
+    readonly uninitializedParam: "rs274-uninitialized-param";
+    readonly badExpression: "rs274-bad-expression";
+    readonly nonFiniteValue: "rs274-non-finite-value";
+    readonly unsupportedSysParam: "rs274-unsupported-sysparam";
+    readonly paramLimit: "rs274-param-limit";
+};
+export type WarnFn = (code: string, message: string, srcByte?: number) => void;
+export type PositionProvider = () => {
+    x: number;
+    y: number;
+    z: number;
+};
+/**
+ * True when a line's code section (comment already stripped) uses a parametric construct. A cheap
+ * character scan — the parser runs this per line so a non-parametric line (every FDM line) takes the
+ * untouched fast path and stays byte-identical.
+ */
+export declare function lineUsesParametric(codeSection: string): boolean;
+/** Strip RS274NGC `( … )` comments from a code section (they are comments, never expressions). */
+export declare function stripParenComments(s: string): string;
+/** The result of lexing one parametric line. */
+export type ParametricLine = {
+    kind: 'empty';
+} | {
+    kind: 'plain';
+} | {
+    kind: 'assign';
+} | {
+    kind: 'cmd';
+    codes: string[];
+    params: Record<string, number>;
+};
+/**
+ * The parameter store + expression evaluator for one program. A scope STACK (DD-017 Phase 3): the base
+ * scope is the main program; each subroutine `call` pushes a frame (`#1`–`#30` args + `#<local>` names)
+ * and `return`/`endsub` pops it. `#31`+ numbered and `#<_global>` names are shared across frames.
+ * Numbered/named params default to `0` on read-before-write (with a one-time disclosure). A read-only
+ * allow-list resolves a few system parameters (current position) from live engine state; any other
+ * system parameter reads `0` and is disclosed. With no subroutines the base scope reduces to the single
+ * flat store of Phases 1–2 (byte-identical).
+ */
+export declare class Rs274Context {
+    private readonly warn;
+    private readonly position;
+    private readonly numbered;
+    private readonly numberedWritten;
+    private readonly globalNamed;
+    private readonly scopes;
+    private uninitWarned;
+    private paramLimitWarned;
+    /** True once any parametric construct was executed — drives the `parametricProgram` capability. */
+    used: boolean;
+    /**
+     * True once execution was degraded relative to a clean run: a hit resource limit (iteration cap),
+     * an unbalanced/unsupported O-word, or a malformed control expression (DD-017 §4.6). The
+     * O-word flow interpreter (Phase 2) sets this; it downgrades `parametricProgram` from `known` to
+     * `approximated` (still disclosed via a specific warning — never silently wrong).
+     */
+    degraded: boolean;
+    constructor(warn: WarnFn, position: PositionProvider);
+    private warnUninit;
+    private get scope();
+    /**
+     * Push a fresh call-frame scope with `args` bound to `#1`..`#30` (DD-017 Phase 3 `call`). Args beyond
+     * 30 are ignored (RS274NGC passes at most 30). Balanced by `popScope` on `return`/`endsub`.
+     */
+    pushScope(args: readonly number[]): void;
+    /** Pop the current call-frame scope (never the base/main scope). */
+    popScope(): void;
+    private readNumbered;
+    private readSystem;
+    /** The map a named parameter lives in: underscore-prefixed (`#<_global>`) → global, else scope-local. */
+    private namedMap;
+    private readNamed;
+    private writeNumbered;
+    private writeNamed;
+    /** `EXISTS[#<name>]` → 1 if the named parameter has been assigned in its scope, else 0. */
+    private exists;
+    /**
+     * Lex one RAW parametric line — either apply a `#… = …` assignment, or resolve every word value into a
+     * plain-number `Cmd` for the engine's existing dispatch. Strips `( … )` comments BEFORE the `;` comment
+     * (RS274NGC order, so a `;` inside parens doesn't truncate the line). Malformed constructs are dropped +
+     * disclosed; the line still parses as far as it can.
+     */
+    lexLine(rawLine: string, srcByte?: number): ParametricLine;
+    /**
+     * The `parametricProgram` capability tier (DD-017 §4.6). `unavailable` for a non-parametric file
+     * (all FDM); `known` when params/expressions/O-word flow ran deterministically within limits;
+     * `approximated` when execution was degraded (a hit iteration cap, an unbalanced/unsupported O-word,
+     * or a malformed control expression) — always paired with a specific disclosure, never silently wrong.
+     */
+    parametricConfidence(): 'known' | 'approximated' | 'unavailable';
+    /**
+     * Evaluate a standalone expression (an O-word condition `[#1 GT 2]` or a `repeat` count `[5]`) against
+     * the shared parameter store, for the Phase 2 flow interpreter. Returns the numeric result, or `null`
+     * when the expression is malformed or evaluates to a non-finite value — disclosed either way (the
+     * caller treats `null` as false / zero iterations). Accepts a bracketed expression, a bare `#ref`, or a
+     * literal; trailing garbage is a malformed expression. No `eval`, depth-guarded like every other path.
+     */
+    evalExpression(text: string, srcByte?: number): number | null;
+    _readParam(kind: 'numbered' | 'named', key: number | string, srcByte?: number): number;
+    _writeParam(kind: 'numbered' | 'named', key: number | string, value: number): void;
+    _exists(name: string): number;
+}
+//# sourceMappingURL=rs274.d.ts.map

package/dist/rs274.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rs274.d.ts","sourceRoot":"","sources":["../src/rs274.ts"],"names":[],"mappings":"AAoBA,sDAAsD;AACtD,eAAO,MAAM,UAAU;;;;;;CAMb,CAAC;AAWX,MAAM,MAAM,MAAM,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;AAC/E,MAAM,MAAM,gBAAgB,GAAG,MAAM;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC;AAEzE;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAE/D;AAED,kGAAkG;AAClG,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,GAAG,MAAM,CAWpD;AAED,gDAAgD;AAChD,MAAM,MAAM,cAAc,GACtB;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,OAAO,CAAA;CAAE,GACjB;IAAE,IAAI,EAAE,QAAQ,CAAA;CAAE,GAClB;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,EAAE,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,CAAC;AAgBrE;;;;;;;;GAQG;AACH,qBAAa,YAAY;IA4BrB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,QAAQ;IA3B3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAkC;IAG3D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAgC;IAChE,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA6B;IAEzD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAMrB;IACF,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,gBAAgB,CAAS;IACjC,mGAAmG;IACnG,IAAI,UAAS;IACb;;;;;OAKG;IACH,QAAQ,UAAS;gBAGE,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,gBAAgB;IAG7C,OAAO,CAAC,UAAU;IAMlB,OAAO,KAAK,KAAK,GAEhB;IAED;;;OAGG;IACH,SAAS,CAAC,IAAI,EAAE,SAAS,MAAM,EAAE,GAAG,IAAI;IAUxC,oEAAoE;IACpE,QAAQ,IAAI,IAAI;IAIhB,OAAO,CAAC,YAAY;IAsBpB,OAAO,CAAC,UAAU;IAWlB,yGAAyG;IACzG,OAAO,CAAC,QAAQ;IAIhB,OAAO,CAAC,SAAS;IASjB,OAAO,CAAC,aAAa;IAarB,OAAO,CAAC,UAAU;IAYlB,2FAA2F;IAC3F,OAAO,CAAC,MAAM;IAId;;;;;OAKG;IACH,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,cAAc;IAkF1D;;;;;OAKG;IACH,oBAAoB,IAAI,OAAO,GAAG,cAAc,GAAG,aAAa;IAKhE;;;;;;OAMG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAsB7D,UAAU,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,MAAM;IAGtF,WAAW,CAAC,IAAI,EAAE,UAAU,GAAG,OAAO,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAIlF,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAG9B"}