@knowvah/dot-engine 0.1.0

package/src/layout/dot/position.ts

@@ -0,0 +1,194 @@
+// SPDX-License-Identifier: EPL-2.0
+
+/**
+ * Dot position phase entry point: x-coordinate assignment, graph connectivity,
+ * leaf expansion stubs, and the main dot_position function.
+ * @see lib/dotgen/position.c
+ */
+
+import type { Graph } from '../../model/graph.js';
+import type { Node } from '../../model/node.js';
+import type { Edge } from '../../model/edge.js';
+import { virtualNode } from './fastgr.js';
+import { SLACKNODE, LEAFSET } from './rank.js';
+import { rank } from './ns.js';
+import { markLowclusters } from './cluster.js';
+import {
+  makeAuxEdge, createAuxEdges, removeAuxEdges,
+  graphMinrank, graphMaxrank, nodeRank, nodeUfSize,
+} from './position-aux.js';
+import { posClusters, compressGraph } from './position-cluster.js';
+import { setYcoords } from './position-ycoords.js';
+import { setAspect, placeGraphLabel } from './position-bbox.js';
+import { dotConcentrate } from './conc.js';
+import { flatEdges } from './flat.js';
+
+// ---------------------------------------------------------------------------
+// set_xcoords — AD-8 critical: ND_rank holds x-coord; restore to rank index
+// ---------------------------------------------------------------------------
+
+/**
+ * Reads ND_rank (set to x-coordinate by network simplex), writes to
+ * ND_coord.x, then RESTORES ND_rank = i (actual rank index).
+ *
+ * AD-8: This is the critical dual-use restoration point.
+ * After this function, ND_rank is valid again as a rank index.
+ *
+ * @see lib/dotgen/position.c:set_xcoords
+ */
+/** @see lib/dotgen/position.c:set_xcoords (rank→coord copy + rank restore) */
+export function setXcoordsFromRank(g: Graph): void {
+  const rankArr = g.info.rank!;
+  for (let i = graphMinrank(g); i <= graphMaxrank(g); i++) {
+    const rk = rankArr[i];
+    for (let j = 0; j < rk.n; j++) {
+      const v = rk.v[j];
+      v.info.coord.x = nodeRank(v);
+      v.info.rank = i;
+    }
+  }
+}
+
+/** @see lib/dotgen/position.c:set_xcoords */
+export function setXcoords(g: Graph): void {
+  setXcoordsFromRank(g);
+  g.info.rankIsXCoord = false;
+}
+
+// ---------------------------------------------------------------------------
+// connectGraph — @see lib/dotgen/position.c:connectGraph
+// ---------------------------------------------------------------------------
+
+/** @see lib/dotgen/position.c:connectGraph (check edge list for cross-rank edge) */
+export function edgeListCrossesRank(
+  el: { list: Edge[]; size: number } | undefined,
+  r: number,
+): boolean {
+  if (!el) return false;
+  for (let j = 0; j < el.size; j++) {
+    const e = el.list[j];
+    if ((e.head.info.rank ?? 0) > r || (e.tail.info.rank ?? 0) > r) return true;
+  }
+  return false;
+}
+
+/** @see lib/dotgen/position.c:connectGraph (find node with cross-rank edge in rank) */
+export function rankHasCrossEdge(rk: { v: Node[]; n: number }, r: number): boolean {
+  for (let i = 0; i < rk.n; i++) {
+    const tp = rk.v[i];
+    if (edgeListCrossesRank(tp.info.save_out, r)) return true;
+    if (edgeListCrossesRank(tp.info.save_in, r)) return true;
+  }
+  return false;
+}
+
+/** @see lib/dotgen/position.c:connectGraph */
+export function connectGraph(g: Graph): void {
+  const rankArr = g.info.rank!;
+  for (let r = graphMinrank(g); r <= graphMaxrank(g); r++) {
+    const rp = rankArr[r];
+    if (rp.n === 0 || rankHasCrossEdge(rp, r)) continue;
+    const anchor = rp.v[0];
+    const neighbor = r < graphMaxrank(g) ? rankArr[r + 1].v[0] : rankArr[r - 1].v[0];
+    if (!neighbor) continue;
+    const sn = virtualNode(g);
+    sn.info.node_type = SLACKNODE;
+    makeAuxEdge(sn, anchor, 0, 0);
+    makeAuxEdge(sn, neighbor, 0, 0);
+    sn.info.rank = Math.min(nodeRank(anchor), nodeRank(neighbor));
+  }
+}
+
+// ---------------------------------------------------------------------------
+// nsiter2 — @see lib/dotgen/position.c:nsiter2
+// ---------------------------------------------------------------------------
+
+/** @see lib/dotgen/position.c:nsiter2 — nslimit attribute not yet ported */
+export function nsiter2(_g: Graph): number { return 2147483647; }
+
+// ---------------------------------------------------------------------------
+// make_leafslots / expand_leaves — @see lib/dotgen/position.c
+// ---------------------------------------------------------------------------
+
+/** @internal — expand rank slot array for leaf nodes */
+export function expandRankSlots(rk: { v: Node[]; n: number }, newN: number): void {
+  const newV: Node[] = new Array(newN + 1);
+  for (let i = rk.n - 1; i >= 0; i--) {
+    const v = rk.v[i];
+    newV[v.info.order!] = v;
+  }
+  rk.n = newN;
+  rk.v = newV;
+}
+
+/** @see lib/dotgen/position.c:make_leafslots */
+export function makeLeafslots(g: Graph): void {
+  const rankArr = g.info.rank!;
+  for (let r = graphMinrank(g); r <= graphMaxrank(g); r++) {
+    const rk = rankArr[r];
+    let j = 0;
+    for (let i = 0; i < rk.n; i++) {
+      const v = rk.v[i];
+      v.info.order = j;
+      j += (v.info.ranktype === LEAFSET) ? nodeUfSize(v) : 1;
+    }
+    if (j > rk.n) expandRankSlots(rk, j);
+  }
+}
+
+/** @see lib/dotgen/position.c:1015 expand_leaves */
+export function expandLeaves(g: Graph): void {
+  // Faithful port: upstream expand_leaves is make_leafslots(g) only. Its
+  // per-node loop body is dead because of a dormant self-subtraction bug at
+  // position.c:1025 —  d = ND_rank(aghead(e)) - ND_rank(aghead(e))  is
+  // headRank - headRank, identically 0, so `if (d == 0) continue;` always
+  // fires and the zapinlist/fast_edge body never runs (present since the 2004
+  // initial revision, never fixed; the oracle is built from this exact tree).
+  // Also, LEAFSET ranktype is never assigned anywhere upstream (const.h:39
+  // defines it; only ever read), so makeLeafslots' expand branch is itself a
+  // no-op for every input. Net effect on node positions: none. The literal
+  // dead loop is omitted to keep the port dead-code/coverage clean.
+  makeLeafslots(g);
+}
+
+// flat_edges is imported from ./flat.js (the real driver). Previously a local
+// stub `flatEdges(_g){return false;}` shadowed it, so flatNode/abomination never
+// ran and labeled flat edges dropped their labels. @see lib/dotgen/position.c:139
+
+// ---------------------------------------------------------------------------
+// dot_position — @see lib/dotgen/position.c:dot_position
+// ---------------------------------------------------------------------------
+
+/** @see lib/dotgen/position.c:dot_position */
+export function dotPosition(g: Graph): number {
+  if (g.info.nlist === undefined) return 0;
+  markLowclusters(g);
+  setYcoords(g);
+  if (g.info.concentrate) {
+    const rc = dotConcentrate(g);
+    if (rc !== 0) return rc;
+  }
+  expandLeaves(g);
+  if (flatEdges(g)) setYcoords(g);
+  createAuxEdges(g, posClusters, compressGraph);
+  g.info.rankIsXCoord = true;
+  if (rank(g, 2, nsiter2(g))) {
+    connectGraph(g);
+    rank(g, 2, nsiter2(g));
+  }
+  setXcoords(g);
+  /* C does NOT normalize the x-frame here: rank(g,2,…) is balance=2/LR_balance,
+   * which skips scan_and_normalize, so the frame stays un-normalized (the
+   * leftmost real node may be negative). The port's x-NS is bit-exact with C
+   * (T0: plans/fix-xns-absolute-anchor), so it already reproduces C's exact
+   * integer frame. A former port-only normalizeXcoords step shifted the leftmost
+   * NORMAL node to x≈0 — a band-aid for a since-fixed NS anchor mismatch that
+   * displaced un-translated spline-less edge labels off C's frame. Removed: it
+   * was 0-regression (XNS_NONORM survey) and required for faithful degenerate
+   * labeled-flat emission. @see lib/dotgen/position.c:set_xcoords (no normalize) */
+  setAspect(g);
+  placeGraphLabel(g);
+  /* remove_aux_edges must come after set_aspect: GD_ln/GD_rn used for bbox width */
+  removeAuxEdges(g);
+  return 0;
+}