Zig 0.17.0-dev (Split by item) 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.
std › zig › Ast › parseTokens Public Function parseTokens Doc Source Public Function std.zig.Ast.parseTokens
pub fn parseTokens (
gpa : Allocator ,
source : [:0 ]const u8 ,
tokens : Ast .TokenList .Slice ,
options : ParseOptions ,
) Allocator .Error !Ast Params File zig/Ast.zig: 172
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216 pub fn parseTokens (
gpa : Allocator ,
source : [:0 ]const u8 ,
tokens : Ast .TokenList .Slice ,
options : ParseOptions ,
) Allocator .Error !Ast {
var parser : Parse = .{
.source = source ,
.gpa = gpa ,
.tokens = tokens ,
.errors = .empty ,
.nodes = .empty ,
.extra_data = .empty ,
.scratch = .empty ,
.tok_i = 0 ,
.recover = options .recover ,
};
defer parser .errors .deinit (gpa );
defer parser .nodes .deinit (gpa );
defer parser .extra_data .deinit (gpa );
defer parser .scratch .deinit (gpa );
// Empirically, Zig source code has a 2:1 ratio of tokens to AST nodes.
// Make sure at least 1 so we can use appendAssumeCapacity on the root node below.
const estimated_node_count = (tokens .len + 2 ) / 2 ;
try parser .nodes .ensureTotalCapacity (gpa , estimated_node_count );
switch (options .mode ) {
.zig => try parser .parseRoot (),
.zon => try parser .parseZon (),
}
try parser .extra_data .shrinkToLen (gpa );
try parser .errors .shrinkToLen (gpa );
// TODO experiment with compacting the MultiArrayList slices here
return .{
.source = source ,
.mode = options .mode ,
.tokens = tokens ,
.nodes = parser .nodes .toOwnedSlice (),
.extra_data = parser .extra_data .toOwnedSliceAssert (),
.errors = parser .errors .toOwnedSliceAssert (),
};
}