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 › CompileUnit › SrcLocCache Public Struct SrcLocCache Doc Source Public Struct std.debug.Dwarf.CompileUnit.SrcLocCache
pub const SrcLocCache = struct Fields Structs Values Functions File debug/Dwarf.zig: 133
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167 pub const SrcLocCache = struct {
line_table : LineTable ,
directories : []const FileEntry ,
files : []FileEntry ,
version : u16 ,
pub const LineTable = std .array_hash_map .Auto (u64 , LineEntry );
pub const LineEntry = struct {
line : u32 ,
column : u32 ,
/// Offset by 1 depending on whether Dwarf version is >= 5.
file : u32 ,
pub const invalid : LineEntry = .{
.line = undefined ,
.column = undefined ,
.file = std .math .maxInt (u32 ),
};
pub fn isInvalid (le : LineEntry ) bool {
return le .file == invalid .file ;
}
};
pub fn findSource (slc : *const SrcLocCache , address : u64 ) !LineEntry {
const index = std .sort .upperBound (u64 , slc .line_table .keys (), address , struct {
fn order (context : u64 , item : u64 ) std .math .Order {
return std .math .order (context , item );
}
}.order );
if (index == 0 ) return missing ();
return slc .line_table .values ()[index - 1 ];
}
}