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 library itself.

CheckFile.zig

File

Code

const CheckFile = @This();

const std = @import("std");
const Io = std.Io;
const Configuration = std.Build.Configuration;

const Step = @import("../Step.zig");
const Maker = @import("../../Maker.zig");

pub fn make(
    check_file: *CheckFile,
    step_index: Configuration.Step.Index,
    maker: *Maker,
    progress_node: std.Progress.Node,
) Step.ExtendedMakeError!void {
    _ = check_file;
    _ = progress_node;
    const graph = maker.graph;
    const arena = maker.graph.arena; // TODO don't leak into process arena
    const io = graph.io;
    const step = maker.stepByIndex(step_index);
    const conf = &maker.scanned_config.configuration;
    const conf_step = step_index.ptr(conf);
    const conf_cf = conf_step.extended.get(conf.extra).check_file;
    const lazy_path = conf_cf.file.get(conf);

    try step.singleUnchangingWatchInput(maker, arena, lazy_path);

    const src_path = try maker.resolveLazyPath(arena, lazy_path, step_index);
    const limit: Io.Limit = if (conf_cf.max_bytes.value) |x| .limited(x) else .unlimited;

    const contents = src_path.root_dir.handle.readFileAlloc(io, src_path.sub_path, arena, limit) catch |err|
        return step.fail(maker, "failed to read {f}: {t}", .{ src_path, err });

    for (conf_cf.expected_matches.slice) |expected_match_index| {
        const expected_match = expected_match_index.slice(conf);
        if (std.mem.find(u8, contents, expected_match) == null) {
            return step.fail(maker,
                \\
                \\========= expected to find: ===================
                \\{s}
                \\========= but file does not contain it: =======
                \\{s}
                \\===============================================
            , .{ expected_match, contents });
        }
    }

    if (conf_cf.expected_exact.value) |expected_exact_index| {
        const expected_exact = expected_exact_index.slice(conf);
        if (!std.mem.eql(u8, expected_exact, contents)) {
            return step.fail(maker,
                \\
                \\========= expected: =====================
                \\{s}
                \\========= but found: ====================
                \\{s}
                \\========= from the following file: ======
                \\{f}
            , .{ expected_exact, contents, src_path });
        }
    }
}