跳转到内容

std.Build.Step.InstallDir

标准库Zig 0.17.0官方原文
源码std/Build/Step/InstallDir.zig

第 1 行

字段

step: Step
options: Options

std.Build.Step.InstallDir.base_tag

常量

第 12 行

Step.Tag

std.Build.Step.InstallDir.create

函数

第 44 行

pub fn create(owner: *std.Build, options: Options) *InstallDir

参数

owner: *std.Build
options: Options

std.Build.Step.InstallDir.fs

别名

第 5 行

别名目标 std.fs

std.Build.Step.InstallDir.InstallDir

别名

第 1 行

别名目标 std.Build.Step.InstallDir

std.Build.Step.InstallDir.LazyPath

别名

第 7 行

别名目标 std.Build.LazyPath

std.Build.Step.InstallDir.mem

别名

第 4 行

别名目标 std.mem

std.Build.Step.InstallDir.Options

容器

第 14 行

字段

source_dir: LazyPath
install_dir: std.Build.InstallDir
install_subdir: []const u8
exclude_extensions: []const []const u8 = &.{}

以这些后缀中任意一个结尾的文件路径 将被排除,不予安装。

include_extensions: ?[]const []const u8 = null

仅安装以这些后缀中任意一个结尾的文件路径。 null 表示此选项接受所有后缀。 exclude_extensions 优先于 include_extensions。

blank_extensions: []const []const u8 = &.{}

以这些后缀之一结尾的文件路径,会安装为空文件。 主要用于大型 test.zig 文件,以避免不必要的安装体积膨胀。 但若完全不提供这些文件,则 @import("test.zig") 会产生编译错误。

std.Build.Step.InstallDir.Options.dupe

函数

第 32 行

fn dupe(opts: Options, graph: *const std.Build.Graph) Options

参数

opts: Options
graph: *const std.Build.Graph

std.Build.Step.InstallDir.std

别名

第 3 行

别名目标 std

std.Build.Step.InstallDir.Step

别名

第 6 行

别名目标 std.Build.Step

源码

std/Build/Step/InstallDir.zig

const InstallDir = @This();

const std = @import("std");
const mem = std.mem;
const fs = std.fs;
const Step = std.Build.Step;
const LazyPath = std.Build.LazyPath;

step: Step,
options: Options,

pub const base_tag: Step.Tag = .install_dir;

pub const Options = struct {
    source_dir: LazyPath,
    install_dir: std.Build.InstallDir,
    install_subdir: []const u8,
    /// 以这些后缀中任意一个结尾的文件路径
    /// 将被排除,不予安装。
    exclude_extensions: []const []const u8 = &.{},
    /// 仅安装以这些后缀中任意一个结尾的文件路径。
    /// `null` 表示此选项接受所有后缀。
    /// `exclude_extensions` 优先于 `include_extensions`。
    include_extensions: ?[]const []const u8 = null,
    /// 以这些后缀之一结尾的文件路径,会安装为空文件。
    /// 主要用于大型 test.zig 文件,以避免不必要的安装体积膨胀。
    /// 但若完全不提供这些文件,则 `@import("test.zig")` 会产生编译错误。
    ///
    ///
    blank_extensions: []const []const u8 = &.{},

    fn dupe(opts: Options, graph: *const std.Build.Graph) Options {
        return .{
            .source_dir = opts.source_dir.dupe(graph),
            .install_dir = opts.install_dir.dupe(graph),
            .install_subdir = graph.dupeString(opts.install_subdir),
            .exclude_extensions = graph.dupeStrings(opts.exclude_extensions),
            .include_extensions = if (opts.include_extensions) |incs| graph.dupeStrings(incs) else null,
            .blank_extensions = graph.dupeStrings(opts.blank_extensions),
        };
    }
};

pub fn create(owner: *std.Build, options: Options) *InstallDir {
    const install_dir = owner.allocator.create(InstallDir) catch @panic("OOM");
    const graph = owner.graph;
    install_dir.* = .{
        .step = Step.init(.{
            .tag = base_tag,
            .name = owner.fmt("install {f}/", .{options.source_dir}),
            .owner = owner,
        }),
        .options = options.dupe(graph),
    };
    options.source_dir.addStepDependencies(&install_dir.step);
    return install_dir;
}