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 › debug › Dwarf › Die › getAttrString Public Function getAttrString Doc Source Public Function std.debug.Dwarf.Die.getAttrString
pub fn getAttrString (
self : *const Die ,
di : *Dwarf ,
endian : Endian ,
id : u64 ,
opt_str : ?[]const u8 ,
compile_unit : *const CompileUnit ,
) error Params File debug/Dwarf.zig: 260
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293 pub fn getAttrString (
self : *const Die ,
di : *Dwarf ,
endian : Endian ,
id : u64 ,
opt_str : ?[]const u8 ,
compile_unit : *const CompileUnit ,
) error { InvalidDebugInfo , MissingDebugInfo }![]const u8 {
const form_value = self .getAttr (id ) orelse return error .MissingDebugInfo ;
switch (form_value .*) {
.string => |value | return value ,
.strp => |offset | return di .getString (offset ),
.strx => |index | {
const debug_str_offsets = di .section (.debug_str_offsets ) orelse return bad ();
if (compile_unit .str_offsets_base == 0 ) return bad ();
switch (compile_unit .format ) {
.@"32" => {
const byte_offset = compile_unit .str_offsets_base + 4 * index ;
if (byte_offset + 4 > debug_str_offsets .len ) return bad ();
const offset = mem .readInt (u32 , debug_str_offsets [@intCast (byte_offset )..][0 ..4 ], endian );
return getStringGeneric (opt_str , offset );
},
.@"64" => {
const byte_offset = compile_unit .str_offsets_base + 8 * index ;
if (byte_offset + 8 > debug_str_offsets .len ) return bad ();
const offset = mem .readInt (u64 , debug_str_offsets [@intCast (byte_offset )..][0 ..8 ], endian );
return getStringGeneric (opt_str , offset );
},
}
},
.line_strp => |offset | return di .getLineString (offset ),
else => return bad (),
}
}