Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
This is an example of documentation generated by ZigDoc, an alternative to Zig's built-in Auto Doc feature. See also examples in other modes/formats. The project being documented here (as the example) is the Zig standard library. Public Function

generate

Public Function
std.zig.ZonGen.generate
pub fn generate(gpa: Allocator, tree: Ast, options: Options) Allocator.Error!Zoir

Params

File

zig/ZonGen.zig:36
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
pub fn generate(gpa: Allocator, tree: Ast, options: Options) Allocator.Error!Zoir {
    assert(tree.mode == .zon);

    var zg: ZonGen = .{
        .gpa = gpa,
        .tree = tree,
        .options = options,
        .nodes = .empty,
        .extra = .empty,
        .limbs = .empty,
        .string_bytes = .empty,
        .string_table = .empty,
        .compile_errors = .empty,
        .error_notes = .empty,
    };
    defer {
        zg.nodes.deinit(gpa);
        zg.extra.deinit(gpa);
        zg.limbs.deinit(gpa);
        zg.string_bytes.deinit(gpa);
        zg.string_table.deinit(gpa);
        zg.compile_errors.deinit(gpa);
        zg.error_notes.deinit(gpa);
    }

    if (tree.errors.len == 0) {
        const root_ast_node = tree.rootDecls()[0];
        try zg.nodes.append(gpa, undefined); // index 0; root node
        try zg.expr(root_ast_node, .root);
    } else {
        try zg.lowerAstErrors();
    }

    if (zg.compile_errors.items.len > 0) {
        try zg.string_bytes.shrinkToLen(gpa);
        try zg.compile_errors.shrinkToLen(gpa);
        try zg.error_notes.shrinkToLen(gpa);

        return .{
            .nodes = .empty,
            .extra = &.{},
            .limbs = &.{},
            .string_bytes = zg.string_bytes.toOwnedSliceAssert(),
            .compile_errors = zg.compile_errors.toOwnedSliceAssert(),
            .error_notes = zg.error_notes.toOwnedSliceAssert(),
        };
    } else {
        assert(zg.error_notes.items.len == 0);

        try zg.extra.shrinkToLen(gpa);
        try zg.limbs.shrinkToLen(gpa);
        try zg.string_bytes.shrinkToLen(gpa);

        return .{
            .nodes = zg.nodes.toOwnedSlice(),
            .extra = zg.extra.toOwnedSliceAssert(),
            .limbs = zg.limbs.toOwnedSliceAssert(),
            .string_bytes = zg.string_bytes.toOwnedSliceAssert(),
            .compile_errors = &.{},
            .error_notes = &.{},
        };
    }
}