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 › shellEscape Private Function shellEscape Doc Source Private Function std.zig.shellEscape
fn shellEscape (writer : *Io .Writer , string : []const u8 , is_argv0 : bool ) !void Params writer : *Io .Writer string : []const u8 is_argv0 : bool File zig.zig: 1266
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297 fn shellEscape (writer : *Io .Writer , string : []const u8 , is_argv0 : bool ) !void {
for (string ) |c | {
if (switch (c ) {
else => true ,
'%' , '+' ...':' , '@' ...'Z' , '_' , 'a' ...'z' => false ,
'=' => is_argv0 ,
}) break ;
} else return writer .writeAll (string );
try writer .writeByte ('"' );
for (string ) |c | {
if (switch (c ) {
std .ascii .control_code .nul => break ,
'!' , '"' , '$' , '\\' , '`' => true ,
else => !std .ascii .isPrint (c ),
}) try writer .writeByte ('\\' );
switch (c ) {
std .ascii .control_code .nul => unreachable ,
std .ascii .control_code .bel => try writer .writeByte ('a' ),
std .ascii .control_code .bs => try writer .writeByte ('b' ),
std .ascii .control_code .ht => try writer .writeByte ('t' ),
std .ascii .control_code .lf => try writer .writeByte ('n' ),
std .ascii .control_code .vt => try writer .writeByte ('v' ),
std .ascii .control_code .ff => try writer .writeByte ('f' ),
std .ascii .control_code .cr => try writer .writeByte ('r' ),
std .ascii .control_code .esc => try writer .writeByte ('E' ),
' ' ...'~' => try writer .writeByte (c ),
else => try writer .print ("{o:0>3}" , .{c }),
}
}
try writer .writeByte ('"' );
}