@knowvah/dot-engine 1.3.0 → 1.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowvah/dot-engine",
-  "version": "1.3.0",
+  "version": "1.5.0",
   "description": "Faithful TypeScript port of Graphviz (dot, neato, fdp, sfdp, circo, twopi, osage, patchwork) — no C: no native binary, no WASM. Oracle-verified against the C implementation, runs in the browser.",
   "keywords": [
     "graphviz",

package/src/api/geometry.ts

@@ -106,13 +106,37 @@ export interface NodeGeometry {
  * type) still holds calloc-zero coordinates, so it is reported as absent
  * rather than as a label at the origin.
  *
+ * `sp`/`ep` are the arrow attachment points. When an end carries an arrow the
+ * spline is shortened to leave room for it, and the arrow spans from the
+ * terminal control point out to this point — so a consumer drawing its own
+ * arrowheads reads the tip here instead of extrapolating one. Each is present
+ * only when that end actually has an arrow (C `sflag`/`eflag`); with no arrow
+ * the field holds the calloc-zero point, which is not geometry.
+ *
+ * These are the *attachment* points on the node boundary, verbatim from the
+ * bezier — with `arrowhead=none` the spline simply ends there. Graphviz's own
+ * renderer insets the arrow polygon it draws by a penwidth-dependent amount
+ * (measured: ~1.5pt at `penwidth=1`, ~6.2pt at `penwidth=5`), so `ep` is the
+ * point to draw an arrow *to*, not a copy of the rendered polygon's tip.
+ *
  * @see lib/common/types.h:ED_spl, ED_label, ED_tail_label, ED_head_label
+ * @see lib/common/types.h:bezier (sflag/eflag, sp/ep)
  */
 export interface EdgeGeometry {
   tail: string;
   head: string;
   /** Bezier control points for the edge spline, in points. */
   points: { x: number; y: number }[];
+  /**
+   * Arrow attachment point at the tail end, if that end carries an arrow.
+   * @see lib/common/types.h:bezier.sp
+   */
+  sp?: { x: number; y: number };
+  /**
+   * Arrow attachment point at the head end, if that end carries an arrow.
+   * @see lib/common/types.h:bezier.ep
+   */
+  ep?: { x: number; y: number };
   /** Centre edge label position, if present. @see lib/common/types.h:ED_label */
   label?: { x: number; y: number };
   /**
@@ -140,7 +164,15 @@ export interface EdgeGeometry {
  * `class="cluster"` polygon, so a consumer quantizing to SVG precision gets
  * byte-conformant geometry.
  *
+ * `label` is the cluster title's placed position and measured size, present
+ * only when the cluster declares a label. Unlike the edge port labels, it is
+ * *not* gated on the label's `set` flag: C draws a cluster label on existence
+ * alone (emit.c:3920 has no `->set` test, unlike emit_edge_label:2891), so an
+ * unplaced one still renders at whatever pos it holds. Gating here would hide
+ * geometry `render()` acts on.
+ *
  * @see lib/common/types.h:GD_bb (of a cluster subgraph)
+ * @see lib/common/types.h:GD_label (textlabel_t.pos / .dimen)
  */
 export interface ClusterGeometry {
   /** Cluster subgraph name (e.g. `cluster6`); encodes nesting. */
@@ -149,6 +181,13 @@ export interface ClusterGeometry {
   y: number;
   width: number;
   height: number;
+  /**
+   * Cluster label placement, if the cluster has one. `x`/`y` are the **centre**
+   * of the label space (matching `EdgeGeometry.label`, not the box corner
+   * `x`/`y` above); `width`/`height` are its measured size.
+   * @see lib/common/postproc.c:place_graph_label
+   */
+  label?: { x: number; y: number; width: number; height: number };
 }
 
 /**
@@ -237,10 +276,33 @@ function placedLabelPos(
   return { x: lbl.pos.x, y: flipY(lbl.pos.y) };
 }
 
+/**
+ * Arrow attachment points, one per end that actually carries an arrow.
+ * C keeps `sp`/`ep` beside the control points and gates them on
+ * `sflag`/`eflag`; with no arrow at that end the flag is 0 and the point is
+ * still calloc-zero, so an ungated read would publish (0, 0) as geometry.
+ * Indexes the bezier array by `spl.size` (not `list.length`), matching C.
+ * @see lib/common/types.h:bezier
+ * @see lib/common/postproc.c:endPoints
+ */
+function arrowAttachPoints(
+  edge: Edge,
+  flipY: (y: number) => number,
+): { sp?: { x: number; y: number }; ep?: { x: number; y: number } } {
+  const spl = edge.info.spl;
+  if (spl === undefined || spl.size === 0) return {};
+  const out: { sp?: { x: number; y: number }; ep?: { x: number; y: number } } = {};
+  const first = spl.list[0];
+  if (first.sflag !== 0) out.sp = { x: first.sp.x, y: flipY(first.sp.y) };
+  const last = spl.list[spl.size - 1];
+  if (last.eflag !== 0) out.ep = { x: last.ep.x, y: flipY(last.ep.y) };
+  return out;
+}
+
 /**
  * Snapshot one edge's geometry.
  * @see lib/common/types.h:ED_spl, ED_label, ED_tail_label, ED_head_label
- *   (textlabel_t.pos)
+ *   (textlabel_t.pos), bezier.sp/ep
  */
 function snapshotEdge(edge: Edge, flipY: (y: number) => number): EdgeGeometry {
   const geom: EdgeGeometry = {
@@ -256,6 +318,9 @@ function snapshotEdge(edge: Edge, flipY: (y: number) => number): EdgeGeometry {
   if (tailLabel !== undefined) geom.tailLabel = tailLabel;
   const headLabel = placedLabelPos(edge.info.head_label, flipY);
   if (headLabel !== undefined) geom.headLabel = headLabel;
+  const { sp, ep } = arrowAttachPoints(edge, flipY);
+  if (sp !== undefined) geom.sp = sp;
+  if (ep !== undefined) geom.ep = ep;
   return geom;
 }
 
@@ -266,13 +331,18 @@ function snapshotEdge(edge: Edge, flipY: (y: number) => number): EdgeGeometry {
  * native lower-left corner (ll); `yAxis:'down'` returns the top-left corner
  * (ll.x, flipped ur.y). `width`/`height` are frame-independent (ur - ll).
  *
+ * The label rides in the same call because place_graph_label runs on the same
+ * layout pass that fills GD_bb; `pos` is the centre of the label space, so it
+ * flips like any other coordinate rather than like the box corner.
+ *
  * @see lib/common/types.h:GD_bb (cluster subgraph)
+ * @see lib/common/postproc.c:place_graph_label
  */
 function snapshotCluster(
   sg: Graph, yAxis: YAxis, flipY: (y: number) => number,
 ): ClusterGeometry {
   const bb = sg.info.bb;
-  return {
+  const geom: ClusterGeometry = {
     name: sg.name,
     x: bb.ll.x,
     // 'up' keeps the lower-left y; 'down' flips the upper-right y to the
@@ -281,6 +351,16 @@ function snapshotCluster(
     width: bb.ur.x - bb.ll.x,
     height: bb.ur.y - bb.ll.y,
   };
+  const lab = sg.info.label as TextlabelT | undefined;
+  if (lab !== undefined) {
+    geom.label = {
+      x: lab.pos.x,
+      y: flipY(lab.pos.y),
+      width: lab.dimen.x,
+      height: lab.dimen.y,
+    };
+  }
+  return geom;
 }
 
 /**