Files
sx/library/modules/ui/pipeline.sx
agra 72593db953 mem: List(T) mutations gain optional alloc: Allocator = context.allocator
The chess panel-text regression (text vanished after the first move on
macOS) had a single root cause: GlyphCache's entries List, hash table,
and shaped_buf grew through `context.allocator` — which during render
is the per-frame arena. On the next arena reset the backing died, and
subsequent glyph lookups read garbage / wrote into freshly-allocated
view-tree memory.

Fix is shaped as the user proposed: `List(T)`'s mutations take an
optional trailing `alloc: Allocator = context.allocator` argument. No
allocator stored on the container, no init ceremony, every existing
`list.append(item)` callsite keeps working unchanged. Long-lived
owners now write `list.append(item, self.parent_allocator)` and the
arena-leak bug becomes impossible to write accidentally.

Default-arg substitution previously only fired for identifier callees
(`expandCallDefaults` at lower.zig:7978). Extended to the generic
struct-method dispatch path (`list.append(...)` lands here) via a new
`appendDefaultArgs` helper that lowers fd.params[i].default_expr in
the caller's scope and appends to the lowered args slice.

Long-lived owners updated to capture `parent_allocator: Allocator` at
init and use it for every internal growth:

- GlyphCache (the chess bug) — entries, shaped_buf, hash_keys,
  hash_vals, atlas bitmap.
- DockInteraction — drops the existing `push Context` workaround in
  `ensure_capacity` for the explicit-arg form.
- StateStore — entries list + per-entry data buffer.
- Gles3Gpu, MetalGPU — shaders, buffers, textures (atlas-grow during
  render would otherwise leak resources into the frame arena).

Also kept: an operator-precedence fix in pipeline.sx
(`(self.frame_index & 1) == 0` instead of
`self.frame_index & 1 == 0`, which parses as
`self.frame_index & (1 == 0)` = always 0). That was a stealth
single-arena-only bug that masked the GlyphCache one for a long time.

Docs:
- specs.md §11 documents `param: T = expr` default parameter values.
  The parser already supported it — formalised in the spec now.
- current/CHECKPOINT-MEM.md logs the change.
- CLAUDE.md REJECTED PATTERNS gains a "Long-lived containers growing
  through context.allocator" section with the `parent_allocator`
  capture template and the list of existing examples to mirror.

155/155 example tests pass — zero-diff against snapshots since every
existing callsite still resolves to `context.allocator`.
2026-05-25 14:41:17 +03:00

189 lines
6.4 KiB
Plaintext
Executable File

#import "modules/std.sx";
#import "modules/allocators.sx";
#import "modules/opengl.sx";
#import "modules/gpu/api.sx";
#import "modules/ui/types.sx";
#import "modules/ui/render.sx";
#import "modules/ui/events.sx";
#import "modules/ui/font.sx";
#import "modules/ui/view.sx";
#import "modules/ui/renderer.sx";
UIPipeline :: struct {
renderer: UIRenderer;
render_tree: RenderTree;
font: GlyphCache;
screen_width: f32;
screen_height: f32;
root: ViewChild;
has_root: bool;
// Frame arena infrastructure. Both arenas are typed `*Arena`
// pointers (per the init-returns-typed-pointer API in
// allocators.sx). Cast to Allocator at use sites via `xx arena_a`.
arena_a: *Arena;
arena_b: *Arena;
frame_index: s64;
body: Closure() -> View;
has_body: bool;
parent_allocator: Allocator;
// GPU protocol backend. When set, the pipeline propagates this to its
// renderer + font, and skips the per-frame GL state setup in
// commit_gpu (Metal bakes blend mode into the pipeline state).
gpu: ?GPU = null;
// Set the GPU dispatch BEFORE calling init() / init_font() so the
// shaders + atlas land on the right backend.
set_gpu :: (self: *UIPipeline, gpu: GPU) {
self.gpu = xx gpu;
self.renderer.gpu = xx gpu;
self.font.gpu = xx gpu;
}
init :: (self: *UIPipeline, width: f32, height: f32) {
self.render_tree = RenderTree.init();
self.renderer.init();
self.screen_width = width;
self.screen_height = height;
self.has_root = false;
self.has_body = false;
self.frame_index = 0;
}
init_font :: (self: *UIPipeline, path: [:0]u8, size: f32, dpi_scale: f32) {
self.font.init(path, size);
self.font.set_dpi_scale(dpi_scale);
self.renderer.dpi_scale = dpi_scale;
set_global_font(@self.font);
}
set_root :: (self: *UIPipeline, view: View) {
self.root = .{ view = view };
self.has_root = true;
}
set_body :: (self: *UIPipeline, body_fn: Closure() -> View) {
self.body = body_fn;
self.has_body = true;
self.parent_allocator = context.allocator;
// Initialize both arenas (256KB initial, grows automatically)
self.arena_a = Arena.init(self.parent_allocator, 262144);
self.arena_b = Arena.init(self.parent_allocator, 262144);
self.frame_index = 0;
}
resize :: (self: *UIPipeline, width: f32, height: f32) {
self.screen_width = width;
self.screen_height = height;
}
// Re-layout and re-render the existing view tree at current screen size.
// Does NOT rebuild from body — safe to call from C callbacks (no arena/context needed).
tick_relayout :: (self: *UIPipeline) {
if self.has_root == false { return; }
proposal := ProposedSize.fixed(self.screen_width, self.screen_height);
self.root.view.size_that_fits(proposal);
self.root.computed_frame = Frame.{
origin = Point.zero(),
size = Size.{ width = self.screen_width, height = self.screen_height }
};
self.root.view.layout(self.root.computed_frame);
self.render_tree.clear();
ctx := RenderContext.init(@self.render_tree);
self.root.view.render(@ctx, self.root.computed_frame);
self.commit_gpu();
}
// Process a single event through the view tree
dispatch_event :: (self: *UIPipeline, event: *Event) -> bool {
if self.has_root == false { return false; }
self.root.view.handle_event(event, self.root.computed_frame);
}
// Run one frame: layout → render → commit
tick :: (self: *UIPipeline) {
if self.has_body {
self.tick_with_body();
return;
}
if self.has_root == false { return; }
proposal := ProposedSize.fixed(self.screen_width, self.screen_height);
// Layout
self.root.view.size_that_fits(proposal);
self.root.computed_frame = Frame.{
origin = Point.zero(),
size = Size.{ width = self.screen_width, height = self.screen_height }
};
self.root.view.layout(self.root.computed_frame);
// Render to tree
self.render_tree.clear();
ctx := RenderContext.init(@self.render_tree);
self.root.view.render(@ctx, self.root.computed_frame);
// Commit to GPU
self.commit_gpu();
}
tick_with_body :: (self: *UIPipeline) {
build_arena : *Arena = if (self.frame_index & 1) == 0 then self.arena_a else self.arena_b;
build_arena.reset();
// Reset render_tree nodes (backing is stale after arena reset)
self.render_tree.nodes.items = null;
self.render_tree.nodes.len = 0;
self.render_tree.nodes.cap = 0;
push Context.{ allocator = xx build_arena, data = context.data } {
// Workaround: self.body() crashes through struct field (issue-0010)
body_fn := self.body;
root_view := body_fn();
self.root = .{ view = root_view };
self.has_root = true;
proposal := ProposedSize.fixed(self.screen_width, self.screen_height);
self.root.view.size_that_fits(proposal);
self.root.computed_frame = Frame.{
origin = Point.zero(),
size = Size.{ width = self.screen_width, height = self.screen_height }
};
self.root.view.layout(self.root.computed_frame);
self.render_tree.clear();
ctx := RenderContext.init(@self.render_tree);
self.root.view.render(@ctx, self.root.computed_frame);
self.commit_gpu();
}
self.frame_index += 1;
}
commit_gpu :: (self: *UIPipeline) {
if self.gpu == null {
glEnable(GL_BLEND);
glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
glDisable(GL_DEPTH_TEST);
}
self.renderer.begin(self.screen_width, self.screen_height, self.font.texture_id);
self.renderer.process(@self.render_tree);
// Push any glyphs rasterized during process() to the GPU atlas BEFORE
// the final draw is recorded. On Metal we deferred per-render_text
// uploads so this is the single point where the atlas reaches the
// GPU. On the GL path it's a no-op (uploads already happened inline).
self.font.upload_atlas_to_gpu();
self.renderer.flush();
if self.gpu == null {
glDisable(GL_BLEND);
}
}
}