`tiny.filigree.Output`

Reference tiny.filigree Output

Defined in tiny.filigree.

API (28)

Public operations.

activate
appendCluster
appendGlyph
clearRetainingCapacity
clusterCapacity
deinit: Releases the initialization slab through the same allocator used by init.
ensureUnused
glyphCapacity
init: Acquires and activates exact output storage.
ligatureCaretCapacity
run: Returns a borrowed glyph run invalidated by mutation, clearRetainingCapacity, or deinit.

Public types and contracts.

Public fields and members.

Static calls · unresolved targets: unknown · external targets: unknown.

Source

Source: lib/filigree/src/shape/output.zig:64

1pub const Output = struct {2    phase: alloc_phase.capacity.Phase,3    capacity: Capacity,4    bytes: []align(storage_alignment) u8,5    glyphs: std.ArrayList(ShapedGlyph),6    clusters: std.ArrayList(Cluster),7    ligature_carets: std.ArrayList(LigatureCaret),8    total_x_advance: i32 = 0,9    total_y_advance: i32 = 0,10    direction: Direction = .ltr,11    writing_mode: WritingMode = .horizontal,12    output_order: OutputOrder = .visual,1314    pub const Limits: type = OutputLimits;15    pub const Capacity: type = OutputCapacity;16    pub const Exhaustion = error{OutputCapacityExceeded};17    pub const InitError = std.mem.Allocator.Error || error{CapacityOverflow};18    pub const storage_alignment: usize = @max(19        @alignOf(ShapedGlyph),20        @alignOf(Cluster),21        @alignOf(LigatureCaret),22    );2324    pub const claim: alloc_phase.capacity.Declaration = .{25        .source = .{26            .id = "filigree.shape_output",27            .kind = .phase_static,28            .limit_source = .caller,29            .storage = .{30                .covered = &.{31                    .{32                        .id = "shaped_glyphs",33                        .lifetime = .steady,34                        .detail = "glyph positions and source associations",35                    },36                    .{37                        .id = "shaped_clusters",38                        .lifetime = .steady,39                        .detail = "at most one cluster per glyph slot",40                    },41                    .{42                        .id = "ligature_carets",43                        .lifetime = .steady,44                        .detail = "caller-budgeted font caret records",45                    },46                },47                .excluded = &.{48                    "source text and font bytes",49                    "shape context scratch and fallback segmentation",50                },51            },52            .capacity = .{53                .inputs = &.{54                    alloc_phase.capacity.bindInput(Limits, "max_glyphs", "max_glyphs"),55                    alloc_phase.capacity.bindInput(56                        Limits,57                        "max_ligature_carets",58                        "max_ligature_carets",59                    ),60                },61                .type_selectors = &.{62                    alloc_phase.capacity.bindType(ShapedGlyph, "shapedglyph"),63                    alloc_phase.capacity.bindType(Cluster, "cluster"),64                    alloc_phase.capacity.bindType(LigatureCaret, "ligaturecaret"),65                },66                .nodes = &.{67                    .{ .input = 0 },68                    .{ .input = 1 },69                    .{ .scale = .{70                        .node = 0,71                        .coefficient = .{ .size_of_concrete_type = 0 },72                    } },73                    .{ .alignment = .{ .node = 2, .alignment = .{ .concrete_type = 1 } } },74                    .{ .scale = .{75                        .node = 0,76                        .coefficient = .{ .size_of_concrete_type = 1 },77                    } },78                    .{ .add = .{ .left = 3, .right = 4 } },79                    .{ .alignment = .{ .node = 5, .alignment = .{ .concrete_type = 2 } } },80                    .{ .scale = .{81                        .node = 1,82                        .coefficient = .{ .size_of_concrete_type = 2 },83                    } },84                    .{ .add = .{ .left = 6, .right = 7 } },85                },86                .assertions = &.{.{87                    .scope = .closure_total,88                    .measure = .retained,89                    .relation = .exact,90                    .expression = 8,91                }},92            },93            .overload = .{94                .kind = .reject_before_mutation,95                .detail = "appends reject before mutation; shape calls clear failed runs",96            },97            .risks = .{98                .transitive = .{99                    .status = .witnessed,100                    .detail = "operations use the slab without allocator capability",101                },102                .foreign = .{103                    .status = .excluded,104                    .detail = "output storage crosses no foreign boundary",105                },106            },107            .obligations = &.{108                .{ .key = "filigree_shape_output_capacity", .role = .capacity_model },109                .{ .key = "filigree_shape_output_oom", .role = .custom },110                .{ .key = "filigree_shape_output_boundaries", .role = .overload },111                .{ .key = "filigree_shape_output_sealed", .role = .transitive_risk },112                .{ .key = "filigree_shape_output_root", .role = .custom },113            },114        },115        .bindings = .{116            .owner = @This(),117            .seal = .{118                .family = alloc_phase.capacity.selector(@This().activate),119                .premise = .{ .class = .checked_semantic_fact, .authority = .checker },120            },121            .teardown = .{122                .family = alloc_phase.capacity.selector(@This().deinit),123                .premise = .{ .class = .checked_semantic_fact, .authority = .checker },124            },125        },126    };127128    /// Acquires and activates exact output storage. Font substitutions can expand129    /// glyphs and carets, so callers select both limits independently of source length.130    pub fn init(allocator: std.mem.Allocator, limits: Limits) InitError!Output {131        const capacity = try Capacity.derive(limits);132        const bytes = try allocator.alignedAlloc(133            u8,134            .fromByteUnits(storage_alignment),135            capacity.storage_bytes,136        );137        var output: Output = .{138            .phase = .initialization,139            .capacity = capacity,140            .bytes = bytes,141            .glyphs = .initBuffer(typedSlice(ShapedGlyph, bytes, 0, limits.max_glyphs)),142            .clusters = .initBuffer(typedSlice(143                Cluster,144                bytes,145                capacity.cluster_offset,146                limits.max_glyphs,147            )),148            .ligature_carets = .initBuffer(typedSlice(149                LigatureCaret,150                bytes,151                capacity.caret_offset,152                limits.max_ligature_carets,153            )),154        };155        output.activate();156        return output;157    }158159    pub fn activate(self: *Output) void {160        std.debug.assert(self.phase == .initialization);161        self.assertStorage();162        self.phase = .steady;163    }164165    /// Releases the initialization slab through the same allocator used by init.166    pub fn deinit(self: *Output, allocator: std.mem.Allocator) void {167        self.assertStorage();168        allocator.free(self.bytes);169        self.* = undefined;170    }171172    pub fn ensureUnused(173        self: *const Output,174        glyphs: usize,175        clusters: usize,176        carets: usize,177    ) Exhaustion!void {178        std.debug.assert(self.phase == .steady);179        std.debug.assert(self.glyphs.items.len <= self.glyphs.capacity);180        std.debug.assert(self.clusters.items.len <= self.clusters.capacity);181        std.debug.assert(self.ligature_carets.items.len <= self.ligature_carets.capacity);182        if (glyphs > self.glyphs.capacity - self.glyphs.items.len or183            clusters > self.clusters.capacity - self.clusters.items.len or184            carets > self.ligature_carets.capacity - self.ligature_carets.items.len)185        {186            return error.OutputCapacityExceeded;187        }188    }189190    pub fn appendGlyph(self: *Output, glyph: ShapedGlyph) Exhaustion!void {191        try self.ensureUnused(1, 0, 0);192        self.glyphs.appendAssumeCapacity(glyph);193    }194195    pub fn appendCluster(self: *Output, cluster: Cluster) Exhaustion!void {196        try self.ensureUnused(0, 1, 0);197        self.clusters.appendAssumeCapacity(cluster);198    }199200    fn assertStorage(self: *const Output) void {201        std.debug.assert(self.bytes.len == self.capacity.storage_bytes);202        std.debug.assert(self.glyphs.capacity == self.capacity.limits.max_glyphs);203        std.debug.assert(self.clusters.capacity == self.capacity.limits.max_glyphs);204        std.debug.assert(self.ligature_carets.capacity == self.capacity.limits.max_ligature_carets);205        std.debug.assert(self.glyphs.items.len <= self.glyphs.capacity);206        std.debug.assert(self.clusters.items.len <= self.clusters.capacity);207        std.debug.assert(self.ligature_carets.items.len <= self.ligature_carets.capacity);208    }209210    pub fn clearRetainingCapacity(self: *Output) void {211        std.debug.assert(self.phase == .steady);212        self.glyphs.clearRetainingCapacity();213        self.clusters.clearRetainingCapacity();214        self.ligature_carets.clearRetainingCapacity();215        self.total_x_advance = 0;216        self.total_y_advance = 0;217        self.direction = .ltr;218        self.writing_mode = .horizontal;219        self.output_order = .visual;220    }221222    /// Returns a borrowed glyph run invalidated by mutation, `clearRetainingCapacity`, or deinit.223    pub fn run(self: *const Output) GlyphRun {224        return .{225            .glyphs = self.glyphs.items,226            .clusters = self.clusters.items,227            .ligature_carets = self.ligature_carets.items,228            .total_x_advance = self.total_x_advance,229            .total_y_advance = self.total_y_advance,230            .direction = self.direction,231            .writing_mode = self.writing_mode,232            .output_order = self.output_order,233        };234    }235236    pub fn glyphCapacity(self: *const Output) usize {237        return self.glyphs.capacity;238    }239240    pub fn clusterCapacity(self: *const Output) usize {241        return self.clusters.capacity;242    }243244    pub fn ligatureCaretCapacity(self: *const Output) usize {245        return self.ligature_carets.capacity;246    }247};

Source: lib/filigree/src/root.zig:81

1pub const Output = shape.Output;

Static calls · unresolved targets: 0 · external targets: 0.

Static calls · unresolved targets: 0 · external targets: 1.

Static calls · unresolved targets: 0 · external targets: 0.

Static calls · unresolved targets: 0 · external targets: 1.

Static calls · unresolved targets: 0 · external targets: 0.

Static calls · unresolved targets: 1 · external targets: 1.

Static calls · unresolved targets: 0 · external targets: 0.

Also reachable as

shape.Output.

Complete caller list for `Output.deinit`

112 direct callers.

Complete caller list for `Output.init`

112 direct callers.

Complete caller list for `Output.run`

111 direct callers.

Audit

Definitions	18
Public names	36
Members	12
Version	`26.7.0`
Revision	`daab053ee433`

tiny.filigree.Output

API (28)

Actions

Types and contracts

Fields and members

Source

Also reachable as

Complete caller list for Output.deinit

Complete caller list for Output.init

Complete caller list for Output.run

Audit

`tiny.filigree.Output`

Complete caller list for `Output.deinit`

Complete caller list for `Output.init`

Complete caller list for `Output.run`