@knowvah/dot-engine 2.0.1 → 2.0.2

package/src/layout/neato/index.ts

@@ -25,7 +25,7 @@ import {
   MODEL_MDS,
 } from './init.js';
 import { neatoMode } from './start.js';
-import { adjustNodesFull } from './fdp-adjust.js';
+import { removeOverlapWith, graphAdjustMode, type AdjustData } from './fdp-adjust.js';
 import { splineEdgesShifted, EDGETYPE_LINE } from './splines.js';
 import { setEdgeTypeFromAttr } from '../dot/index.js';
 import {
@@ -100,15 +100,14 @@ export function parseModel(g: Graph): number {
 // ---------------------------------------------------------------------------
 
 /**
- * Remove node overlaps per the `overlap` attribute: C's removeOverlapWith
- * dispatch (prism, scale family, oscale, ortho*, portho*, vpsc, voronoi) for
- * every mode, as neato_layout's adjustNodes call does.
+ * Remove node overlaps with the mode neato_layout resolved once
+ * (graphAdjustMode): C's removeOverlapWith dispatch for every mode.
  *
- * @see lib/neatogen/neatoinit.c:neato_layout (adjustNodes call)
+ * @see lib/neatogen/neatoinit.c:neato_layout (removeOverlapWith calls)
  * @see lib/neatogen/adjust.c:removeOverlapWith
  */
-export function maybeRemoveOverlap(g: Graph): void {
-  adjustNodesFull(g);
+export function maybeRemoveOverlap(g: Graph, am: AdjustData): void {
+  removeOverlapWith(g, am);
 }
 
 // ---------------------------------------------------------------------------
@@ -164,6 +163,8 @@ export function neatoLayout(g: Graph): void {
   }
 
   const mode = parseMode(g);
+  // C resolves the overlap mode once, before any component. @see neatoinit.c:1369
+  const am = graphAdjustMode(g);
   const model = parseModel(g);
 
   // C uses pccomps (pin-aware): components with a pinned node are collected
@@ -172,10 +173,10 @@ export function neatoLayout(g: Graph): void {
     ? pccomps(g, '_neato_cc')
     : { graphs: [g], pinned: false };
   if (comps.length > 1) {
-    layoutComponents(g, comps, mode, model, pinned);
+    layoutComponents(g, comps, { mode, model, am }, pinned);
   } else {
     solveModel(g, mode, model); // srand48 happens inside (C checkStart)
-    maybeRemoveOverlap(g);
+    maybeRemoveOverlap(g, am);
     // C: spline_edges shifts pos to the origin, syncs coord, routes.
     splineEdgesShifted(g);
   }
@@ -236,13 +237,13 @@ function addClusters(g: Graph): void {
  * @see lib/neatogen/neatoinit.c:neato_layout (Pack >= 0 branch)
  */
 function layoutComponents(
-  g: Graph, comps: Graph[], mode: number, model: number, pinned: boolean,
+  g: Graph, comps: Graph[], solve: { mode: number; model: number; am: AdjustData }, pinned: boolean,
 ): void {
   for (const gc of comps) {
     // @see lib/neatogen/neatoinit.c:1398 (setEdgeType FUNCTION, per component)
     setEdgeTypeFromAttr(gc, EDGETYPE_LINE);
-    solveModel(gc, mode, model);
-    maybeRemoveOverlap(gc);
+    solveModel(gc, solve.mode, solve.model);
+    maybeRemoveOverlap(gc, solve.am);
     splineEdgesShifted(gc);
   }
   // C sets fixed[0]=true when a pinned node is present: pccomps merges every

package/src/layout/sfdp/index.ts

@@ -31,7 +31,7 @@ import { CL_OFFSET } from '../twopi/pipeline.js';
 import { placeGraphLabel } from '../dot/position-bbox.js';
 import { gvPostprocess } from '../../common/postproc.js';
 import { aggetGraph } from '../fdp/fdp-model.js';
-import { overlapPrismTries, adjustNodesFull } from '../neato/fdp-adjust.js';
+import { overlapPrismTries, adjustNodesFull, warnUnrecognizedOverlap } from '../neato/fdp-adjust.js';
 import { lateDouble } from '../../common/nodeinit.js';
 import {
   type SpringElectricalControl,
@@ -98,6 +98,7 @@ function resolveControl(g: Graph): {
   // graphAdjustMode(g, &am, "prism0"): agget NULL (unset) → "prism0" default.
   const overlap = aggetGraph(g, 'overlap');
   const flag = overlap === undefined ? 'prism0' : overlap;
+  warnUnrecognizedOverlap(flag); // graphAdjustMode → getAdjustMode, once per layout
   const ntry = overlapPrismTries(flag);
   if (ntry !== null) {
     // AM_PRISM && doAdjust: overlap removal happens inside sfdp.

package/src/render/public.ts

@@ -60,13 +60,14 @@ export interface RenderOptions {
 }
 
 // ---------------------------------------------------------------------------
-// Private helpers (mirrors index.ts)
+// Argument validation (shared with the async entry points)
 // ---------------------------------------------------------------------------
 
-
-
-/** Reject a bad `g` / `format` / `opts` before any work starts. */
-function checkRenderArgs(g: unknown, format: unknown, opts: unknown): void {
+/**
+ * Reject a bad `g` / `format` / `opts` before any work starts.
+ * @internal shared with src/async/render-async.ts; not part of the public API.
+ */
+export function checkRenderArgs(g: unknown, format: unknown, opts: unknown): void {
   if (typeof g !== 'object' || g === null) {
     throw invalidArgType('g', 'object', g);
   }

package/dist/layout/neato/overlap.d.ts

@@ -1,85 +0,0 @@
-/**
- * VPSC-based overlap removal for the neato layout engine.
- *
- * Two independent VPSC passes (X then Y) ensure that no two node bounding
- * boxes intersect after the call returns. Each pass builds its own Variables,
- * Rectangles, and Constraints; none are shared between passes.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust
- * @see lib/vpsc/csolve_VPSC.h
- */
-import type { Node } from '../../model/node.js';
-import { type Variable, type Constraint, VPSC, Rectangle } from '../../vpsc/index.js';
-/**
- * Builds one Rectangle per node centred on pos[], expanding each half-size
- * by sep/2 so the VPSC gap `(w_i+w_j)/2` incorporates the padding.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust
- */
-export declare function buildRectangles(nodes: Node[], sep: {
-    x: number;
-    y: number;
-}): Rectangle[];
-/**
- * Allocates one Variable per node for a single VPSC axis pass.
- *
- * @see lib/vpsc/csolve_VPSC.h:newVariable
- */
-export declare function allocateVariables(nodes: Node[], axis: 0 | 1): Variable[];
-/**
- * Writes solved positions back into node.info.pos[axis].
- *
- * @see lib/neatogen/adjust.c:vpscAdjust (position write-back loop)
- */
-export declare function writePositions(nodes: Node[], vars: Variable[], axis: 0 | 1): void;
-/**
- * Tears down a VPSC pass in mandatory order (AD-4):
- * deleteVPSC → deleteConstraints → deleteVariable per variable.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust teardown sequence
- */
-export declare function teardownPass(vpsc: VPSC, constraints: Constraint[], vars: Variable[]): void;
-/**
- * Runs one complete VPSC axis pass: solve constraints then write positions.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust
- */
-export declare function runAxisPass(nodes: Node[], sep: {
-    x: number;
-    y: number;
-}, constraints: Constraint[], vars: Variable[], axis: 0 | 1): void;
-/**
- * One full VPSC pass on the X axis.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust (X pass section)
- */
-export declare function runXPass(nodes: Node[], sep: {
-    x: number;
-    y: number;
-}): void;
-/**
- * One full VPSC pass on the Y axis.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust (Y pass section)
- */
-export declare function runYPass(nodes: Node[], sep: {
-    x: number;
-    y: number;
-}): void;
-/**
- * Removes overlaps between nodes using two independent VPSC passes (X then Y).
- *
- * After this call no two node bounding boxes intersect (with sep padding).
- * Positions are written into node.info.pos[0] (X) and node.info.pos[1] (Y).
- *
- * @param nodes - Nodes with info.pos, info.width, info.height set.
- * @param sep   - Minimum padding added beyond each node's half-size per axis.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust
- * @see lib/vpsc/csolve_VPSC.h
- */
-export declare function removeOverlap(nodes: Node[], sep: {
-    x: number;
-    y: number;
-}): void;
-//# sourceMappingURL=overlap.d.ts.map

package/dist/layout/neato/overlap.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"overlap.d.ts","sourceRoot":"","sources":["../../../src/layout/neato/overlap.ts"],"names":[],"mappings":"AAEA;;;;;;;;;GASG;AAEH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAQL,KAAK,QAAQ,EACb,KAAK,UAAU,EACf,IAAI,EACJ,SAAS,EACV,MAAM,qBAAqB,CAAC;AAE7B;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,IAAI,EAAE,EACb,GAAG,EAAE;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,GAC5B,SAAS,EAAE,CAQb;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,GAAG,QAAQ,EAAE,CAExE;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAC5B,KAAK,EAAE,IAAI,EAAE,EACb,IAAI,EAAE,QAAQ,EAAE,EAChB,IAAI,EAAE,CAAC,GAAG,CAAC,GACV,IAAI,CAON;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,IAAI,EACV,WAAW,EAAE,UAAU,EAAE,EACzB,IAAI,EAAE,QAAQ,EAAE,GACf,IAAI,CAIN;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,KAAK,EAAE,IAAI,EAAE,EACb,GAAG,EAAE;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,EAC7B,WAAW,EAAE,UAAU,EAAE,EACzB,IAAI,EAAE,QAAQ,EAAE,EAChB,IAAI,EAAE,CAAC,GAAG,CAAC,GACV,IAAI,CAKN;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,IAAI,EAAE,EACb,GAAG,EAAE;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,GAC5B,IAAI,CAKN;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CACtB,KAAK,EAAE,IAAI,EAAE,EACb,GAAG,EAAE;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,GAC5B,IAAI,CAKN;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,aAAa,CAC3B,KAAK,EAAE,IAAI,EAAE,EACb,GAAG,EAAE;IAAE,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,EAAE,MAAM,CAAA;CAAE,GAC5B,IAAI,CAIN"}

package/src/layout/neato/overlap.ts

@@ -1,158 +0,0 @@
-// SPDX-License-Identifier: EPL-2.0
-
-/**
- * VPSC-based overlap removal for the neato layout engine.
- *
- * Two independent VPSC passes (X then Y) ensure that no two node bounding
- * boxes intersect after the call returns. Each pass builds its own Variables,
- * Rectangles, and Constraints; none are shared between passes.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust
- * @see lib/vpsc/csolve_VPSC.h
- */
-
-import type { Node } from '../../model/node.js';
-import {
-  newVariable,
-  deleteVariable,
-  deleteVPSC,
-  deleteConstraints,
-  solveVPSC,
-  genXConstraints,
-  genYConstraints,
-  type Variable,
-  type Constraint,
-  VPSC,
-  Rectangle,
-} from '../../vpsc/index.js';
-
-/**
- * Builds one Rectangle per node centred on pos[], expanding each half-size
- * by sep/2 so the VPSC gap `(w_i+w_j)/2` incorporates the padding.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust
- */
-export function buildRectangles(
-  nodes: Node[],
-  sep: { x: number; y: number },
-): Rectangle[] {
-  return nodes.map((n) => {
-    const x = n.info.pos?.[0] ?? 0;
-    const y = n.info.pos?.[1] ?? 0;
-    const hw = n.info.width / 2 + sep.x / 2;
-    const hh = n.info.height / 2 + sep.y / 2;
-    return new Rectangle(x - hw, x + hw, y - hh, y + hh);
-  });
-}
-
-/**
- * Allocates one Variable per node for a single VPSC axis pass.
- *
- * @see lib/vpsc/csolve_VPSC.h:newVariable
- */
-export function allocateVariables(nodes: Node[], axis: 0 | 1): Variable[] {
-  return nodes.map((n, i) => newVariable(i, n.info.pos?.[axis] ?? 0, 1));
-}
-
-/**
- * Writes solved positions back into node.info.pos[axis].
- *
- * @see lib/neatogen/adjust.c:vpscAdjust (position write-back loop)
- */
-export function writePositions(
-  nodes: Node[],
-  vars: Variable[],
-  axis: 0 | 1,
-): void {
-  for (let i = 0; i < nodes.length; i++) {
-    const n = nodes[i]!;
-    if (!n.info.pos) n.info.pos = [0, 0];
-    n.info.pos[axis] =
-      vars[i]!.block !== null ? vars[i]!.position() : vars[i]!.desiredPosition;
-  }
-}
-
-/**
- * Tears down a VPSC pass in mandatory order (AD-4):
- * deleteVPSC → deleteConstraints → deleteVariable per variable.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust teardown sequence
- */
-export function teardownPass(
-  vpsc: VPSC,
-  constraints: Constraint[],
-  vars: Variable[],
-): void {
-  deleteVPSC(vpsc);
-  deleteConstraints(constraints);
-  for (const v of vars) deleteVariable(v);
-}
-
-/**
- * Runs one complete VPSC axis pass: solve constraints then write positions.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust
- */
-export function runAxisPass(
-  nodes: Node[],
-  sep: { x: number; y: number },
-  constraints: Constraint[],
-  vars: Variable[],
-  axis: 0 | 1,
-): void {
-  const vpsc = new VPSC(vars, constraints);
-  solveVPSC(vpsc);
-  writePositions(nodes, vars, axis);
-  teardownPass(vpsc, constraints, vars);
-}
-
-/**
- * One full VPSC pass on the X axis.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust (X pass section)
- */
-export function runXPass(
-  nodes: Node[],
-  sep: { x: number; y: number },
-): void {
-  const rects = buildRectangles(nodes, sep);
-  const vars = allocateVariables(nodes, 0);
-  const cs = genXConstraints(rects, vars, true);
-  runAxisPass(nodes, sep, cs, vars, 0);
-}
-
-/**
- * One full VPSC pass on the Y axis.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust (Y pass section)
- */
-export function runYPass(
-  nodes: Node[],
-  sep: { x: number; y: number },
-): void {
-  const rects = buildRectangles(nodes, sep);
-  const vars = allocateVariables(nodes, 1);
-  const cs = genYConstraints(rects, vars);
-  runAxisPass(nodes, sep, cs, vars, 1);
-}
-
-/**
- * Removes overlaps between nodes using two independent VPSC passes (X then Y).
- *
- * After this call no two node bounding boxes intersect (with sep padding).
- * Positions are written into node.info.pos[0] (X) and node.info.pos[1] (Y).
- *
- * @param nodes - Nodes with info.pos, info.width, info.height set.
- * @param sep   - Minimum padding added beyond each node's half-size per axis.
- *
- * @see lib/neatogen/adjust.c:vpscAdjust
- * @see lib/vpsc/csolve_VPSC.h
- */
-export function removeOverlap(
-  nodes: Node[],
-  sep: { x: number; y: number },
-): void {
-  if (nodes.length < 2) return;
-  runXPass(nodes, sep);
-  runYPass(nodes, sep);
-}