@knowvah/dot-engine 2.6.8 → 2.6.10

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowvah/dot-engine",
-  "version": "2.6.8",
+  "version": "2.6.10",
   "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/common/htmltable-emit-fill.ts

@@ -18,7 +18,7 @@ import { FillType, PenType } from '../gvc/context.js';
 import { transformPoint } from '../gvc/device.js';
 import { resolveRenderColor } from '../render/color-resolve.js';
 import { emitRoundedBezier } from './poly-shapes.js';
-import { parseStyleFlags } from './style-resolve.js';
+import { htmlStyle } from './htmltable-style.js';
 import {
   BORDER_LEFT,
   BORDER_TOP,
@@ -94,7 +94,7 @@ export interface HtmlPaint {
   pen?: string;
   /** Pen width; default 1.0 (omitted from SVG at 1.0). */
   penWidth?: number;
-  /** Style string; "dashed"/"dotted" map to the pen type. */
+  /** HTML STYLE string; its dashed/dotted flags map to the pen type. */
   penStyle?: string;
   /**
    * Second/stop color of a gradient fill. Presence switches the fill from
@@ -137,10 +137,11 @@ export function resetHtmlFillPenWidth(): void {
   htmlFillPen = 1.0;
 }
 
-/** Map a style string to the C pen type. @see lib/common/htmltable.c:doBorder */
+/** Map an HTML STYLE to the C pen type: dashed wins over dotted. @see lib/common/htmltable.c:doBorder */
 function penTypeOf(style: string | undefined): PenType {
-  if (style !== undefined && style.includes('dashed')) return PenType.Dashed;
-  if (style !== undefined && style.includes('dotted')) return PenType.Dotted;
+  const st = htmlStyle(style);
+  if (st.dashed) return PenType.Dashed;
+  if (st.dotted) return PenType.Dotted;
   return PenType.Solid;
 }
 
@@ -277,7 +278,7 @@ export function doBorder(
   // value persists and leaks into the next bgcolor fill's stroke-width.
   htmlFillPen = border;
   withHtmlPaint({ pen: color, penWidth: border, penStyle: style }, job, () => {
-    if (parseStyleFlags(style).rounded) {
+    if (htmlStyle(style).rounded) {
       // C: round_corners(job, mkPts(AF,b,border), 4, {rounded}, 0) — unfilled
       // rounded border path; emitRoundedBezier transforms the AF ring itself.
       emitRoundedBezier(mkPts(box, border, pos), { x: 0, y: 0 }, false, { renderer, job });

package/src/common/htmltable-emit.ts

@@ -35,7 +35,7 @@ import {
   htmlFillPenWidth, resetHtmlFillPenWidth, type HtmlPaint,
 } from './htmltable-emit-fill.js';
 import { emitRoundedBezier } from './poly-shapes.js';
-import { parseStyleFlags } from './style-resolve.js';
+import { htmlStyle } from './htmltable-style.js';
 import { emitHtmlRules, initHtmlAnchor, endHtmlAnchor, htmlObjImgscale } from './htmltable-emit-rules.js';
 
 export type { PlacedHtml, PlacedCell, PlacedLine, PlacedImage };
@@ -125,7 +125,7 @@ function bgFillPaint(ctx: BgFillCtx): HtmlPaint {
   if (spec === null) return { fill: ctx.bgcolor, penWidth };
   return {
     fill: spec[0], stop: spec[1], gradientAngle: ctx.gradientangle ?? 0,
-    radial: ctx.style !== undefined && ctx.style.includes('radial'), penWidth,
+    radial: htmlStyle(ctx.style).radial, penWidth,
   };
 }
 
@@ -139,7 +139,7 @@ function bgFillPaint(ctx: BgFillCtx): HtmlPaint {
 function emitBgFill(ctx: BgFillCtx): void {
   const { box, pos, border, renderer, job } = ctx;
   withHtmlPaint(bgFillPaint(ctx), job, () => {
-    if (parseStyleFlags(ctx.style).rounded) {
+    if (htmlStyle(ctx.style).rounded) {
       emitRoundedBezier(mkPts(box, border, pos), { x: 0, y: 0 }, true, { renderer, job });
       return;
     }
@@ -258,23 +258,6 @@ export function emitHtmlImg(
  *
  * @see lib/common/htmltable.c:emit_html_cell
  */
-/**
- * True when an HTML element's STYLE declares it invisible.
- *
- * HTML STYLE is lexed by its OWN parser, not the node/edge one: tokens are
- * split on space or comma, compared case-insensitively, and BOTH "INVIS" and
- * "INVISIBLE" set the flag. (The node/edge parser splits on comma only and
- * matches exact-case, so it cannot be reused here.)
- * @see lib/common/htmllex.c:168 (DELIM " ,", strview_case_str_eq)
- */
-function htmlStyleInvisible(style: string | undefined): boolean {
-  if (style === undefined) return false;
-  return style.split(/[ ,]+/).some((tok) => {
-    const t = tok.toUpperCase();
-    return t === 'INVIS' || t === 'INVISIBLE';
-  });
-}
-
 export function emitHtmlCell(
   cell: PlacedCell,
   pos: Point,
@@ -287,7 +270,7 @@ export function emitHtmlCell(
   );
   // An invisible cell emits no fill, no border and no content — only the
   // anchor, which C opens before the gate. @see htmltable.c:emit_html_cell:643
-  if (htmlStyleInvisible(cell.style)) {
+  if (htmlStyle(cell.style).invisible) {
     if (inAnchor) endHtmlAnchor(renderer, job);
     return;
   }
@@ -354,7 +337,7 @@ export function emitHtmlLabel(
   const inAnchor = clustersLast ? false : initHtmlAnchor(anchorData, tblBox, renderer, job);
   // An invisible TABLE suppresses its fill, ALL its cells, and its rules and
   // border — the whole block C guards at emit_html_tbl:542.
-  const tblInvisible = htmlStyleInvisible(placed.style);
+  const tblInvisible = htmlStyle(placed.style).invisible;
   if (!tblInvisible) {
     if (placed.bgcolor !== undefined) {
       emitBgFill({ bgcolor: placed.bgcolor, box: placed.box, pos, border: placed.border,

package/src/common/htmltable-style.ts

@@ -0,0 +1,38 @@
+// SPDX-License-Identifier: EPL-2.0
+/**
+ * The HTML STYLE flags. C's stylefn sets an htmlstyle_t bitfield at lex time;
+ * the port keeps the legal tokens as a string (htmltable-attr-warn.ts joins
+ * them with ' ') and reads the flags back here, token by token in order, so
+ * SOLID still clears only the DOTTED/DASHED before it. HTML STYLE is not the
+ * node/edge style: tokens split on space or comma and compare
+ * case-insensitively, so `parseStyleFlags` cannot read it.
+ *
+ * @see lib/common/htmltable.h:htmlstyle_t
+ * @see lib/common/htmllex.c:stylefn (DELIM " ,", strview_case_str_eq)
+ */
+
+/** @see lib/common/htmltable.h:htmlstyle_t */
+export interface HtmlStyle {
+  radial: boolean;
+  rounded: boolean;
+  invisible: boolean;
+  dotted: boolean;
+  dashed: boolean;
+}
+
+/** Read the htmlstyle_t flags from a kept HTML STYLE string. */
+export function htmlStyle(style: string | undefined): HtmlStyle {
+  const s: HtmlStyle = { radial: false, rounded: false, invisible: false, dotted: false, dashed: false };
+  if (style === undefined) return s;
+  for (const tk of style.split(/[ ,]+/)) {
+    switch (tk.toUpperCase()) {
+      case 'ROUNDED': s.rounded = true; break;
+      case 'RADIAL': s.radial = true; break;
+      case 'SOLID': s.dotted = false; s.dashed = false; break;
+      case 'INVISIBLE': case 'INVIS': s.invisible = true; break;
+      case 'DOTTED': s.dotted = true; break;
+      case 'DASHED': s.dashed = true; break;
+    }
+  }
+  return s;
+}

package/src/common/poly-gencode.ts

@@ -22,7 +22,7 @@ import { FillType } from '../gvc/context.js';
 import { emitHtmlLabel } from './htmltable-emit.js';
 import { transformPoint } from '../gvc/device.js';
 import { nodeAttr } from './poly-init.js';
-import { substObjAnchor, interpretCRNL } from './subst.js';
+import { substObjAnchor, preprocessTooltip } from './subst.js';
 import type { ResolvedFill, PolyStyleFlags } from './style-resolve.js';
 import {
   parseStyleFlags,
@@ -245,7 +245,7 @@ function anchorAttr(n: Node, key: string): string | undefined {
 
 /** Resolve tooltip string: explicit attr, or fall back to label text. */
 function resolveTooltip(n: Node, tooltip: string | undefined): string {
-  if (tooltip !== undefined) return substObjAnchor(interpretCRNL(tooltip), n);
+  if (tooltip !== undefined) return substObjAnchor(preprocessTooltip(tooltip), n);
   const label = n.info.label as TextlabelT | undefined;
   return label?.text ?? '';
 }

package/src/common/subst.ts

@@ -14,6 +14,7 @@ import { Node } from '../model/node.js';
 import { Edge } from '../model/edge.js';
 import { Graph } from '../model/graph.js';
 import type { TextlabelT } from './types.js';
+import { htmlEntityUTF8 } from './html-entities.js';
 
 export type GraphObj = Node | Edge | Graph;
 
@@ -124,3 +125,14 @@ export function interpretCRNL(str: string): string {
   }
   return out;
 }
+
+/**
+ * Tooltip preprocessing: decode HTML entities to UTF-8, then interpret
+ * \n \l \r. C picks latin1ToUTF8 or htmlEntityUTF8 by GD_charset; both decode
+ * entities via htmlEntity, and the port's Latin-1 bytes are already decoded
+ * at input, so one branch serves both (as in make_label).
+ * @see lib/common/emit.c:preprocessTooltip
+ */
+export function preprocessTooltip(s: string): string {
+  return interpretCRNL(htmlEntityUTF8(s));
+}

package/src/gvc/anchor.ts

@@ -17,7 +17,7 @@ import type { Node } from '../model/node.js';
 import type { Point, Box, Spline, Bezier } from '../model/geom.js';
 import type { TextlabelT, PolygonT } from '../common/types.js';
 import type { GraphObj } from '../common/subst.js';
-import { substObjAnchor, interpretCRNL } from '../common/subst.js';
+import { substObjAnchor, preprocessTooltip } from '../common/subst.js';
 import { parseStyleFlags } from '../common/style-resolve.js';
 import { nodeAttr } from '../common/poly-init.js';
 import { bezier } from '../common/bezier.js';
@@ -36,12 +36,13 @@ function subst(s: string, obj: GraphObj): string {
 }
 
 /**
- * preprocessTooltip + strdup_and_subst_obj: interpret \n\l\r escapes, then
- * object substitution — matching the node tooltip path (poly-gencode.ts).
+ * preprocessTooltip + strdup_and_subst_obj: decode entities and interpret
+ * \n\l\r escapes, then object substitution — matching the node tooltip path
+ * (poly-gencode.ts).
  * @see lib/common/emit.c:preprocessTooltip
  */
 function tip(s: string, obj: GraphObj): string {
-  return substObjAnchor(interpretCRNL(s), obj);
+  return substObjAnchor(preprocessTooltip(s), obj);
 }
 
 /** Label text of a textlabel, or null. @see device.ts:labelTextOf */
@@ -71,7 +72,7 @@ function pickEdge(e: Edge, keys: string[]): Picked {
   return pickFirst(e.attrs, keys, (s) => subst(s, e));
 }
 
-/** pickFirst with tooltip preprocessing (interpretCRNL + subst). */
+/** pickFirst with tooltip preprocessing (preprocessTooltip + subst). */
 function pickEdgeTip(e: Edge, keys: string[]): Picked {
   return pickFirst(e.attrs, keys, (s) => tip(s, e));
 }

package/src/render/xml-escape.ts

@@ -1,29 +1,25 @@
 // SPDX-License-Identifier: EPL-2.0
 //
-// XML escaping faithful to graphviz's gv_xml_escape (lib/util/xml.c). '<', '>',
-// '"', and "'" are always escaped; '&' is escaped to &amp; only when it does
-// not begin a valid entity (&name; / &#NNN; / &#xHH;). The text/tooltip variant
-// additionally honors the {raw, dash, nbsp} flags used by the SVG plugin.
+// The SVG renderer's three gv_xml_escape flag sets (lib/util/xml.c), as presets
+// over the faithful port in util/xml.ts. '<', '>', '"' and "'" are always
+// escaped; '&' is escaped only when it does not begin an entity
+// (xml_isentity), except under raw, which escapes every '&'.
 
-// Regexes for quote chars: /"/g and /'/g break Lizard's quote-tracker.
-// Use these named patterns instead to avoid the parser bug.
-const RE_DQUOTE = new RegExp('"', 'g');
-const RE_SQUOTE = new RegExp("'", 'g');
-// A bare '&' that does NOT begin a valid entity (&name; / &#NNN; / &#xHH;).
-// Mirrors xml_isentity (lib/util/xml.c): only such '&' are escaped to &amp;.
-const RE_AMP_NONENTITY = /&(?![A-Za-z]+;|#[0-9]+;|#x[0-9A-Fa-f]+;)/g;
+import { gvXmlEscape, type XmlFlags } from '../util/xml.js';
+
+/** flags {0}. @see plugin/core/gvrender_core_svg.c:svg_begin_anchor (href) */
+const FLAGS_BASE: XmlFlags = { raw: false, dash: false, nbsp: false, utf8: false };
+/** gvputs_xml's flags. @see lib/gvc/gvdevice.c:gvputs_xml */
+const FLAGS_TITLE: XmlFlags = { raw: false, dash: true, nbsp: true, utf8: false };
+/** @see plugin/core/gvrender_core_svg.c:svg_textspan, svg_begin_anchor (tooltip) */
+const FLAGS_TEXT: XmlFlags = { raw: true, dash: true, nbsp: true, utf8: false };
 
 /**
- * Base XML escape (gv_xml_escape with flags {0}): ids, titles, hrefs.
- * @see lib/util/xml.c gv_xml_escape / xml_core / xml_isentity
+ * Base XML escape (gv_xml_escape with flags {0}): ids, hrefs.
+ * @see lib/util/xml.c:gv_xml_escape
  */
 export function escapeXml(s: string): string {
-  let r = s.replace(RE_AMP_NONENTITY, '&amp;');
-  r = r.replace(/</g, '&lt;');
-  r = r.replace(/>/g, '&gt;');
-  r = r.replace(RE_DQUOTE, '&quot;');
-  r = r.replace(RE_SQUOTE, '&#39;');
-  return r;
+  return gvXmlEscape(s, FLAGS_BASE);
 }
 
 /**
@@ -34,23 +30,17 @@ export function escapeXml(s: string): string {
  * @see lib/gvc/gvdevice.c:gvputs_xml, lib/util/xml.c:xml_core
  */
 export function escapeXmlTitle(s: string): string {
-  let r = escapeXml(s);
-  r = r.replace(/-/g, '&#45;');
-  r = r.replace(/ {2,}/g, (m) => ' ' + '&#160;'.repeat(m.length - 1));
-  return r;
+  return gvXmlEscape(s, FLAGS_TITLE);
 }
 
 /**
- * Text/tooltip XML escape (gv_xml_escape with flags {raw, dash, nbsp}):
- * additionally escapes '-'→&#45;, newline/CR→&#10;/&#13;, and 2nd+ consecutive
- * spaces→&#160;. Used for textspans and tooltips.
- * @see plugin/core/gvrender_core_svg.c:546 (svg_textspan flags)
+ * Text/tooltip XML escape (gv_xml_escape with flags {raw, dash, nbsp}): raw
+ * escapes every '&' -- entity-looking or not -- and newline/CR to
+ * &#10;/&#13;; also '-'→&#45; and 2nd+ consecutive spaces→&#160;. Used for
+ * textspans and xlink:title.
+ * @see plugin/core/gvrender_core_svg.c:svg_textspan, svg_begin_anchor
+ * @see lib/util/xml.c:xml_core (`flags.raw || !xml_isentity(s)`)
  */
 export function escapeXmlText(s: string): string {
-  let r = escapeXml(s);
-  r = r.replace(/-/g, '&#45;');
-  r = r.replace(/\n/g, '&#10;');
-  r = r.replace(/\r/g, '&#13;');
-  r = r.replace(/ {2,}/g, (m) => ' ' + '&#160;'.repeat(m.length - 1));
-  return r;
+  return gvXmlEscape(s, FLAGS_TEXT);
 }