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 › Progress › windowsApiMoveToMarker Private Function windowsApiMoveToMarker Doc Source Private Function std.Progress.windowsApiMoveToMarker
fn windowsApiMoveToMarker (io : Io , nl_n : usize ) WindowsApiError !void Params File Progress.zig: 962
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999 fn windowsApiMoveToMarker (io : Io , nl_n : usize ) WindowsApiError !void {
const terminal = global_progress .terminal ;
var get_console_info = windows .CONSOLE .USER_IO .GET_SCREEN_BUFFER_INFO ;
switch (try get_console_info .operate (io , terminal )) {
.SUCCESS => {},
else => |status | return windows .unexpectedStatus (status ),
}
const cursor_pos = get_console_info .Data .dwCursorPosition ;
const expected_y = cursor_pos .Y - @as (i16 , @intCast (nl_n ));
var start_pos : windows .COORD = .{ .X = 0 , .Y = expected_y };
while (start_pos .Y >= 0 ) : (start_pos .Y -= 1 ) {
var read_output_char = windows .CONSOLE .USER_IO .READ_OUTPUT_CHARACTER (start_pos , .WideCharacter );
var buffer : [1 ]windows .WCHAR = undefined ;
switch ((try io .operate (.{ .device_io_control = .{
.file = .{
.handle = windows .peb ().ProcessParameters .ConsoleHandle ,
.flags = .{ .nonblocking = false },
},
.code = windows .IOCTL .CONDRV .ISSUE_USER_IO ,
.in = @ptrCast (&read_output_char .request (terminal , 0 , .{}, 1 , .{
.{ .Size = @sizeOf (@TypeOf (buffer )), .Pointer = &buffer },
})),
} })).device_io_control .u .Status ) {
.SUCCESS => {},
.CANCELLED => unreachable ,
else => |status | return windows .unexpectedStatus (status ),
}
if (read_output_char .Data .nLength >= 1 and buffer [0 ] == windows_api_start_marker ) break ;
} else {
// If we couldn't find the marker, then just assume that no lines wrapped
start_pos = .{ .X = 0 , .Y = expected_y };
}
var set_cursor_position = windows .CONSOLE .USER_IO .SET_CURSOR_POSITION (start_pos );
switch (try set_cursor_position .operate (io , terminal )) {
.SUCCESS => {},
else => |status | return windows .unexpectedStatus (status ),
}
}