@typecad/ui 0.1.0-alpha.2 → 1.0.0-alpha.11

package/src/ui-engine/ui-lowering.ts

@@ -22,7 +22,6 @@ import type { CSSRule, CSSProperty } from "./css-parser.js";
 import type { DisplayProfile } from "@typecad/cuttlefish/api/shared";
 import type { UIFontAssetModel } from "./font-assets.js";
 import type { Diagnostic } from "@typecad/cuttlefish/api/shared";
-import { analyzeScrollMemory } from "./scroll-memory-diagnostics.js";
 import { getListBindings } from "@typecad/cuttlefish/ir/transformers/ui-reactive";
 
 export interface LoweredUI {
@@ -40,8 +39,6 @@ export interface LoweredUI {
   imageTables: string;
   /** C++ keyframe data arrays + animation table. */
   keyframeTables: string;
-  /** Compile-time warnings for scroll viewports that exceed the canvas budget. */
-  scrollMemoryDiagnostics: Diagnostic[];
   /** Layout-time diagnostics (viewport overflow, text overflow). Populated by
    *  lowerOnMount after the boxes are computed; empty until then. */
   diagnostics: Diagnostic[];
@@ -62,16 +59,14 @@ export function lowerUIToCpp(
   allScreens: StyledNode[] = [],
   imageAssetIds: Map<string, number> = new Map(),
   keyframeSets: KeyframeSetModel[] = [],
-  scrollCanvasBudgetBytes?: number,
 ): LoweredUI {
   void storage;
   const model = lowerUIToModel(root, boxes, colorFormat, display, fontAssets, allScreens, imageAssetIds, keyframeSets);
-  const scrollMemoryDiagnostics = analyzeScrollMemory(model.nodes, scrollCanvasBudgetBytes);
 
   // Tables are mutable RAM (ui_tick updates bg/dirty/elapsed/active each
   // frame), so no PROGMEM/flash storage keyword — those imply read-only.
   const fontTables = emitFontTables(model);
-  const nodeTable = emitNodeTable(model) + "\n" + emitScrollNodeIdLookup(model);
+  const nodeTable = emitNodeTable(model);
   const transitionTable = emitTransitionTable(model);
   const typeDecl = emitTypeDecl(root);
 
@@ -111,7 +106,7 @@ export function lowerUIToCpp(
   const screenCount = model.nodes.length > 0 ? Math.max(...model.nodes.map(n => n.screenId)) + 1 : 1;
   const imageTables = "const UIImage __ui_images[] = {};\nconst uint16_t __ui_image_count = 0;";
   const keyframeTables = emitKeyframeTables(model);
-  return { fontTables, nodeTable, transitionTable, typeDecl, keyboardLoaders, keyboardDispatch, screenCount, imageTables, keyframeTables, scrollMemoryDiagnostics, diagnostics: [] };
+  return { fontTables, nodeTable, transitionTable, typeDecl, keyboardLoaders, keyboardDispatch, screenCount, imageTables, keyframeTables, diagnostics: [] };
 }
 
 function sanitizedId(id: string): string {
@@ -199,7 +194,22 @@ function emitKeyboardLoader(name: string, kb: KeyboardTemplate, rules: CSSRule[]
 
 /** Emit one key's keys[] + styles[] lines, resolving CSS classes to colors. */
 function emitKeyLine(key: UIKeyTemplate, kbClasses: string[] | undefined, rules: CSSRule[], colorFormat: ColorFormat): string {
-  const chEsc = key.ch === "\\" ? "\\\\" : key.ch === "'" ? "\\'" : key.ch;
+  // The C++ UIKey.ch field is a single `char`. Special keys (shift=1, bs=2,
+  // ok=3, page=4) use the `special` field for their behavior and label — the
+  // `ch` value is never read. Their label strings ("OK", "123", "⇧", "⌫") are
+  // multi-char or multi-byte and would overflow `char` if emitted as literals.
+  // Emit a space placeholder for any key whose ch isn't a single ASCII byte.
+  const isSingleAscii = key.special === 0 && key.ch.length === 1 && key.ch.charCodeAt(0) < 128;
+  if (key.special === 0 && !isSingleAscii) {
+    console.warn(
+      `[cuttlefish] keyboard key ch="${key.ch}" is non-ASCII and will be emitted as ` +
+      `a space placeholder. The native C++ UIKey.ch field is a single char and ` +
+      `cannot hold multi-byte codepoints. Use a custom keyboard layout or the ` +
+      `Adafruit path for full Unicode key labels.`,
+    );
+  }
+  const chRaw = isSingleAscii ? key.ch : ' ';
+  const chEsc = chRaw === "\\" ? "\\\\" : chRaw === "'" ? "\\'" : chRaw;
   const style = resolveKeyStyle(key.classes, kbClasses, rules);
   const bg = style.background ? resolveColor(style.background, colorFormat) : DEFAULT_KEY_BG;
   const fg = style.color ? resolveColor(style.color, colorFormat) : DEFAULT_KEY_FG;
@@ -219,6 +229,7 @@ function cppKind(kind: UINodeModel["kind"]): string {
     case "img": return "NODE_IMG";
     case "list": return "NODE_LIST";
     case "canvas": return "NODE_CANVAS";
+    case "select": return "NODE_SELECT";
     case "text": return "NODE_TEXT";
   }
 }
@@ -278,24 +289,6 @@ function emitFontTables(model: UIProgram): string {
    return lines.join("\n");
  }
 
-function emitScrollNodeIdLookup(model: UIProgram): string {
-  const cases: string[] = [];
-  for (const n of model.nodes) {
-    if (!n.scrollable || n.contentHeight <= n.box.h || !n.id) continue;
-    const id = n.id.replace(/\\/g, "\\\\").replace(/"/g, '\\"');
-    cases.push(`  if (idx == ${n.index}) return "${id}";`);
-  }
-  if (cases.length === 0) {
-    return "static inline const char* __ui_scroll_node_id(uint16_t idx) { (void)idx; return nullptr; }";
-  }
-  return [
-    "static inline const char* __ui_scroll_node_id(uint16_t idx) {",
-    ...cases,
-    "  return nullptr;",
-    "}",
-  ].join("\n");
-}
-
 function emitNodeTable(model: UIProgram): string {
   // Map node index → list binding so virtualized nodes carry their count/item/
   // tap function pointers on-node (no UIListBinding side table at runtime).

package/src/ui-engine/ui-registry.ts

@@ -28,7 +28,6 @@ import { selectEngine } from "./select-engine.js";
 import { measure, measureWithFonts, Box } from "./layout-engine.js";
 import { lowerUIToCpp, LoweredUI } from "./ui-lowering.js";
 import { getDisplayProfile } from "@typecad/cuttlefish/stores/display-profile-store";
-import { resolveScrollConfig } from "@typecad/cuttlefish/api/shared";
 import { buildUIFontAssets } from "./font-assets.js";
 import type { UIFontAssetModel } from "./font-assets.js";
 import { emitImageTables, loadImageAssets } from "./image-assets.js";
@@ -220,12 +219,7 @@ export function lowerOnMount(htmlPath: string, opts: LowerOptions): LoweredUI {
 
   const imageAssets = loadImageAssets(allStyled.length > 0 ? allStyled : [mod.styled], path.dirname(abs));
 
-  const scrollBudget = resolveScrollConfig(getDisplayProfile(), { buildTarget: getDisplayProfile()._buildTarget }).scrollCanvasBudgetBytes;
-  const result = lowerUIToCpp(mod.styled, allBoxes, opts.colorFormat, opts.storage, mod.keyboards, mod.rules, getDisplayProfile(), mod.fontAssets, allStyled, imageAssets.nodeIdToAssetIndex, keyframeSets, scrollBudget);
-
-  for (const d of result.scrollMemoryDiagnostics) {
-    mod.mountDiagnostics.push({ ...d, source: d.source ?? path.basename(mod.htmlPath) });
-  }
+  const result = lowerUIToCpp(mod.styled, allBoxes, opts.colorFormat, opts.storage, mod.keyboards, mod.rules, getDisplayProfile(), mod.fontAssets, allStyled, imageAssets.nodeIdToAssetIndex, keyframeSets);
 
   // Layout diagnostics: viewport-overflow (node bottom past the viewport) and
   // text-overflow (node right edge past its parent). Both reference the node by

package/dist/ui-engine/scroll-memory-diagnostics.d.ts

@@ -1,16 +0,0 @@
-import type { Diagnostic } from "@typecad/cuttlefish/api/shared";
-import type { UINodeModel } from "./model.js";
-import { DEFAULT_SCROLL_CANVAS_BUDGET_BYTES } from "@typecad/cuttlefish/api/shared";
-export { DEFAULT_SCROLL_CANVAS_BUDGET_BYTES };
-export interface ScrollMemoryIssue {
-    nodeIndex: number;
-    id?: string;
-    width: number;
-    height: number;
-    canvasBytes: number;
-    budgetBytes: number;
-}
-/** Collect overflow scroll nodes whose viewport canvas exceeds the budget. */
-export declare function collectScrollMemoryIssues(nodes: UINodeModel[], budgetBytes?: number): ScrollMemoryIssue[];
-/** Emit transpile warnings for scroll viewports that cannot fit a Mode B canvas. */
-export declare function analyzeScrollMemory(nodes: UINodeModel[], budgetBytes?: number): Diagnostic[];

package/dist/ui-engine/scroll-memory-diagnostics.js

@@ -1,58 +0,0 @@
-// Compile-time scroll viewport memory analysis. Overflow scroll containers
-// need a viewport-sized RGB565 canvas (~w×h×2 bytes) for smooth Mode B
-// scrolling; when that exceeds the device budget, runtime falls back to
-// Mode C strip scroll or freezes until memory is available.
-import { DEFAULT_SCROLL_CANVAS_BUDGET_BYTES } from "@typecad/cuttlefish/api/shared";
-export { DEFAULT_SCROLL_CANVAS_BUDGET_BYTES };
-/** Collect overflow scroll nodes whose viewport canvas exceeds the budget. */
-export function collectScrollMemoryIssues(nodes, budgetBytes = DEFAULT_SCROLL_CANVAS_BUDGET_BYTES) {
-    const issues = [];
-    for (const node of nodes) {
-        if (!node.scrollable)
-            continue;
-        if (node.contentHeight <= node.box.h)
-            continue;
-        const canvasBytes = node.box.w * node.box.h * 2;
-        if (canvasBytes <= budgetBytes)
-            continue;
-        issues.push({
-            nodeIndex: node.index,
-            id: node.id,
-            width: node.box.w,
-            height: node.box.h,
-            canvasBytes,
-            budgetBytes,
-        });
-    }
-    return issues;
-}
-function formatKb(bytes) {
-    return `${Math.round(bytes / 1024)} KB`;
-}
-function minimizationHint(issue) {
-    const maxArea = Math.floor(issue.budgetBytes / 2);
-    const maxHAtWidth = issue.width > 0 ? Math.floor(maxArea / issue.width) : 0;
-    const maxWAtHeight = issue.height > 0 ? Math.floor(maxArea / issue.height) : 0;
-    return [
-        `Reduce the scroll viewport in CSS (e.g. height ≤ ${maxHAtWidth}px at ${issue.width}px width, or width ≤ ${maxWAtHeight}px at ${issue.height}px height).`,
-        "Trim fonts, images, or inactive screens to free heap for canvas allocation.",
-        "Use PSRAM or a board with more SRAM if you need a larger scroll viewport.",
-        "Adjust display.scroll.scrollCanvasBudgetBytes in cuttlefish.config.ts only if your target has more headroom (runtime allocation may still fail).",
-    ].join("\n");
-}
-/** Emit transpile warnings for scroll viewports that cannot fit a Mode B canvas. */
-export function analyzeScrollMemory(nodes, budgetBytes = DEFAULT_SCROLL_CANVAS_BUDGET_BYTES) {
-    return collectScrollMemoryIssues(nodes, budgetBytes).map((issue) => {
-        const label = issue.id ? `#${issue.id}` : `node ${issue.nodeIndex}`;
-        return {
-            severity: "warning",
-            code: "scroll-canvas-memory",
-            message: `Scroll viewport ${label} (${issue.width}×${issue.height}px) needs ${issue.canvasBytes} bytes ` +
-                `(${formatKb(issue.canvasBytes)}) for accurate smooth scrolling, exceeding the ` +
-                `${issue.budgetBytes}-byte budget (~${formatKb(issue.budgetBytes)}). ` +
-                "Rendering will fall back to Mode C strip scroll or freeze updates until memory is available — " +
-                "scrolling may tear, stutter, or skip frames.",
-            hint: minimizationHint(issue),
-        };
-    });
-}

package/src/ui-engine/scroll-memory-diagnostics.ts

@@ -1,79 +0,0 @@
-// Compile-time scroll viewport memory analysis. Overflow scroll containers
-// need a viewport-sized RGB565 canvas (~w×h×2 bytes) for smooth Mode B
-// scrolling; when that exceeds the device budget, runtime falls back to
-// Mode C strip scroll or freezes until memory is available.
-
-import type { Diagnostic } from "@typecad/cuttlefish/api/shared";
-import type { UINodeModel } from "./model.js";
-import { DEFAULT_SCROLL_CANVAS_BUDGET_BYTES } from "@typecad/cuttlefish/api/shared";
-
-export { DEFAULT_SCROLL_CANVAS_BUDGET_BYTES };
-
-export interface ScrollMemoryIssue {
-  nodeIndex: number;
-  id?: string;
-  width: number;
-  height: number;
-  canvasBytes: number;
-  budgetBytes: number;
-}
-
-/** Collect overflow scroll nodes whose viewport canvas exceeds the budget. */
-export function collectScrollMemoryIssues(
-  nodes: UINodeModel[],
-  budgetBytes: number = DEFAULT_SCROLL_CANVAS_BUDGET_BYTES,
-): ScrollMemoryIssue[] {
-  const issues: ScrollMemoryIssue[] = [];
-  for (const node of nodes) {
-    if (!node.scrollable) continue;
-    if (node.contentHeight <= node.box.h) continue;
-    const canvasBytes = node.box.w * node.box.h * 2;
-    if (canvasBytes <= budgetBytes) continue;
-    issues.push({
-      nodeIndex: node.index,
-      id: node.id,
-      width: node.box.w,
-      height: node.box.h,
-      canvasBytes,
-      budgetBytes,
-    });
-  }
-  return issues;
-}
-
-function formatKb(bytes: number): string {
-  return `${Math.round(bytes / 1024)} KB`;
-}
-
-function minimizationHint(issue: ScrollMemoryIssue): string {
-  const maxArea = Math.floor(issue.budgetBytes / 2);
-  const maxHAtWidth = issue.width > 0 ? Math.floor(maxArea / issue.width) : 0;
-  const maxWAtHeight = issue.height > 0 ? Math.floor(maxArea / issue.height) : 0;
-  return [
-    `Reduce the scroll viewport in CSS (e.g. height ≤ ${maxHAtWidth}px at ${issue.width}px width, or width ≤ ${maxWAtHeight}px at ${issue.height}px height).`,
-    "Trim fonts, images, or inactive screens to free heap for canvas allocation.",
-    "Use PSRAM or a board with more SRAM if you need a larger scroll viewport.",
-    "Adjust display.scroll.scrollCanvasBudgetBytes in cuttlefish.config.ts only if your target has more headroom (runtime allocation may still fail).",
-  ].join("\n");
-}
-
-/** Emit transpile warnings for scroll viewports that cannot fit a Mode B canvas. */
-export function analyzeScrollMemory(
-  nodes: UINodeModel[],
-  budgetBytes: number = DEFAULT_SCROLL_CANVAS_BUDGET_BYTES,
-): Diagnostic[] {
-  return collectScrollMemoryIssues(nodes, budgetBytes).map((issue) => {
-    const label = issue.id ? `#${issue.id}` : `node ${issue.nodeIndex}`;
-    return {
-      severity: "warning" as const,
-      code: "scroll-canvas-memory",
-      message:
-        `Scroll viewport ${label} (${issue.width}×${issue.height}px) needs ${issue.canvasBytes} bytes ` +
-        `(${formatKb(issue.canvasBytes)}) for accurate smooth scrolling, exceeding the ` +
-        `${issue.budgetBytes}-byte budget (~${formatKb(issue.budgetBytes)}). ` +
-        "Rendering will fall back to Mode C strip scroll or freeze updates until memory is available — " +
-        "scrolling may tear, stutter, or skip frames.",
-      hint: minimizationHint(issue),
-    };
-  });
-}