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 › DebugRangeIterator › init Public Function init Doc Source Public Function std.debug.Dwarf.DebugRangeIterator.init
pub fn init (ranges_value : *const FormValue , di : *const Dwarf , endian : Endian , compile_unit : *const CompileUnit ) !@This () Params File debug/Dwarf.zig: 708
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753 pub fn init (ranges_value : *const FormValue , di : *const Dwarf , endian : Endian , compile_unit : *const CompileUnit ) !@This () {
const section_type = if (compile_unit .version >= 5 ) Section .Id .debug_rnglists else Section .Id .debug_ranges ;
const debug_ranges = di .section (section_type ) orelse return error .MissingDebugInfo ;
const ranges_offset = switch (ranges_value .*) {
.sec_offset , .udata => |off | off ,
.rnglistx => |idx | off : {
switch (compile_unit .format ) {
.@"32" => {
const offset_loc = compile_unit .rnglists_base + 4 * idx ;
if (offset_loc + 4 > debug_ranges .len ) return bad ();
const offset = mem .readInt (u32 , debug_ranges [@intCast (offset_loc )..][0 ..4 ], endian );
break :off compile_unit .rnglists_base + offset ;
},
.@"64" => {
const offset_loc = compile_unit .rnglists_base + 8 * idx ;
if (offset_loc + 8 > debug_ranges .len ) return bad ();
const offset = mem .readInt (u64 , debug_ranges [@intCast (offset_loc )..][0 ..8 ], endian );
break :off compile_unit .rnglists_base + offset ;
},
}
},
else => return bad (),
};
// All the addresses in the list are relative to the value
// specified by DW_AT.low_pc or to some other value encoded
// in the list itself.
// If no starting value is specified use zero.
const base_address = compile_unit .die .getAttrAddr (di , endian , AT .low_pc , compile_unit ) catch |err | switch (err ) {
error .MissingDebugInfo => 0 ,
else => return err ,
};
var fr : Reader = .fixed (debug_ranges );
fr .seek = cast (usize , ranges_offset ) orelse return bad ();
return .{
.base_address = base_address ,
.section_type = section_type ,
.di = di ,
.endian = endian ,
.compile_unit = compile_unit ,
.fr = fr ,
};
}