Zig 0.17.0-dev (Split by item)

Shortcut keys
?
Show these tips
S
Focus search field
Esc
Clear focus & close tips
U
Jump to source code
↑
Move up in search results
↓
Move down in search results
↵
Go to active search result
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. Public Struct

ConfigHeader

Public Struct

Fields

step: Step
values: std.array_hash_map.String(Value) = .empty
generated_dir: Configuration.GeneratedFileIndex

This directory contains the generated file under the name include_path.

style: Style
input_size_limit: ?u64
include_path: []const u8
include_guard: Configuration.OptionalString

Namespaces

Structs

Types

Values

Functions

pub fn create(owner: *std.Build, options: Options) *ConfigHeader
pub fn addIdent(config_header: *ConfigHeader, name: []const u8, value: []const u8) void
pub fn addValue(config_header: *ConfigHeader, name: []const u8, comptime T: type, value: T) void
fn addValueInner(config_header: *ConfigHeader, name: []const u8, comptime T: type, value: T) !void
pub fn addValues(config_header: *ConfigHeader, values: anytype) void
pub fn getOutputDir(ch: *ConfigHeader) std.Build.LazyPath
pub fn getOutputFile(ch: *ConfigHeader) std.Build.LazyPath

File

Build/Step/ConfigHeader.zig
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
const ConfigHeader = @This();

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

step: Step,
values: std.array_hash_map.String(Value) = .empty,
/// This directory contains the generated file under the name `include_path`.
generated_dir: Configuration.GeneratedFileIndex,

style: Style,
input_size_limit: ?u64,
include_path: []const u8,
include_guard: Configuration.OptionalString,

pub const base_tag: Step.Tag = .config_header;

pub const Style = union(enum) {
    /// A configure format supported by autotools that uses `#undef foo` to
    /// mark lines that can be substituted with different values.
    autoconf_undef: std.Build.LazyPath,
    /// A configure format supported by autotools that uses `@FOO@` output variables.
    autoconf_at: std.Build.LazyPath,
    /// The configure format supported by CMake. It uses `@FOO@`, `${}` and
    /// `#cmakedefine` for template substitution.
    cmake: std.Build.LazyPath,
    /// The configure format supported by Meson. It uses `@FOO@`, and
    /// `#mesondefine` for template substitution.
    meson: std.Build.LazyPath,
    /// Instead of starting with an input file, start with nothing.
    blank,
    /// Start with nothing, like blank, and output a nasm .asm file.
    nasm,

    pub fn getPath(style: Style) ?std.Build.LazyPath {
        switch (style) {
            .autoconf_undef, .autoconf_at, .cmake, .meson => |s| return s,
            .blank, .nasm => return null,
        }
    }
};

pub const Value = union(enum) {
    undef,
    defined,
    boolean: bool,
    int: i64,
    ident: []const u8,
    string: []const u8,
};

pub const Options = struct {
    style: Style = .blank,
    max_bytes: ?u64 = null,
    include_path: ?[]const u8 = null,
    include_guard: ?[]const u8 = null,
    first_ret_addr: ?usize = null,
};

pub fn create(owner: *std.Build, options: Options) *ConfigHeader {
    const graph = owner.graph;
    const arena = graph.arena;
    const wc = &graph.wip_configuration;
    const config_header = graph.create(ConfigHeader);

    const include_path: []const u8 = p: {
        if (options.include_path) |p|
            break :p graph.dupeString(p);

        if (options.style.getPath()) |s| default: {
            const sub_path = switch (s) {
                .src_path => |sp| sp.sub_path,
                .generated => break :default,
                .cwd_relative => |sub_path| sub_path,
                .relative => |r| r.sub_path,
                .dependency => |dependency| dependency.sub_path,
            };
            const basename = Io.Dir.path.basename(sub_path);
            if (std.mem.endsWith(u8, basename, ".h.in"))
                break :p graph.dupeString(basename[0 .. basename.len - 3]);
        }
        break :p "config.h";
    };

    const name = if (options.style.getPath()) |s|
        arena.print("configure {t} header {f} to {s}", .{ options.style, s, include_path }) catch @panic("OOM")
    else
        arena.print("configure {t} header to {s}", .{ options.style, include_path }) catch @panic("OOM");

    config_header.* = .{
        .step = .init(.{
            .tag = base_tag,
            .name = name,
            .owner = owner,
            .first_ret_addr = options.first_ret_addr orelse @returnAddress(),
        }),
        .style = options.style,
        .input_size_limit = options.max_bytes,
        .include_path = include_path,
        .include_guard = if (options.include_guard) |s| .init(wc.addString(s) catch @panic("OOM")) else .none,
        .generated_dir = graph.addGeneratedFile(&config_header.step),
    };

    if (options.style.getPath()) |s| {
        s.addStepDependencies(&config_header.step);
    }
    return config_header;
}

pub fn addIdent(config_header: *ConfigHeader, name: []const u8, value: []const u8) void {
    const arena = config_header.step.owner.allocator;
    config_header.values.put(arena, name, .{ .ident = value }) catch @panic("OOM");
}

pub fn addValue(config_header: *ConfigHeader, name: []const u8, comptime T: type, value: T) void {
    return addValueInner(config_header, name, T, value) catch @panic("OOM");
}

fn addValueInner(config_header: *ConfigHeader, name: []const u8, comptime T: type, value: T) !void {
    const arena = config_header.step.owner.allocator;
    switch (@typeInfo(T)) {
        .null => {
            try config_header.values.put(arena, name, .undef);
        },
        .void => {
            try config_header.values.put(arena, name, .defined);
        },
        .bool => {
            try config_header.values.put(arena, name, .{ .boolean = value });
        },
        .int => {
            try config_header.values.put(arena, name, .{ .int = value });
        },
        .comptime_int => {
            try config_header.values.put(arena, name, .{ .int = value });
        },
        .@"enum", .enum_literal => {
            try config_header.values.put(arena, name, .{ .ident = @tagName(value) });
        },
        .optional => {
            if (value) |x| {
                return addValueInner(config_header, name, @TypeOf(x), x);
            } else {
                try config_header.values.put(arena, name, .undef);
            }
        },
        .pointer => |ptr| {
            switch (@typeInfo(ptr.child)) {
                .array => |array| {
                    if (ptr.size == .one and array.child == u8) {
                        try config_header.values.put(arena, name, .{ .string = value });
                        return;
                    }
                },
                .int => {
                    if (ptr.size == .slice and ptr.child == u8) {
                        try config_header.values.put(arena, name, .{ .string = value });
                        return;
                    }
                },
                else => {},
            }

            @compileError("unsupported ConfigHeader value type: " ++ @typeName(T));
        },
        else => @compileError("unsupported ConfigHeader value type: " ++ @typeName(T)),
    }
}

pub fn addValues(config_header: *ConfigHeader, values: anytype) void {
    const info = @typeInfo(@TypeOf(values)).@"struct";
    inline for (info.field_names, info.field_types) |field_name, field_type| {
        addValue(config_header, field_name, field_type, @field(values, field_name));
    }
}

pub fn getOutputDir(ch: *ConfigHeader) std.Build.LazyPath {
    return .{ .generated = .{ .index = ch.generated_dir } };
}

pub fn getOutputFile(ch: *ConfigHeader) std.Build.LazyPath {
    return ch.getOutputDir().path(ch.step.owner, ch.include_path);
}