跳转到内容

std.Build.Step.UpdateSourceFiles

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

第 1 行

字段

step: Step
embeds: std.ArrayList(Embed) = .empty
copies: std.ArrayList(Copy) = .empty

std.Build.Step.UpdateSourceFiles.addBytesToSource

函数

第 54 行

使用提供的字节覆盖相对于包根目录的路径。

由于会更新源码文件,因此不应将其用于 常规构建过程;应将其用作开发者偶尔运行的工具, 专门用于修改源码文件,随后将这些修改提交到版本 控制。

pub fn addBytesToSource(usf: *UpdateSourceFiles, contents: []const u8, sub_path: []const u8) void

参数

usf: *UpdateSourceFiles
contents: []const u8
sub_path: []const u8

std.Build.Step.UpdateSourceFiles.addCopyFileToSource

函数

第 35 行

用另一个文件的内容覆盖相对于构建根目录的路径。

由于会更新源码文件,不应在常规 构建过程中使用,而应作为开发者偶尔运行的工具, 用于主动修改源码文件,并随后将更改提交到版本 控制。

pub fn addCopyFileToSource(usf: *UpdateSourceFiles, src_file: std.Build.LazyPath, sub_path: []const u8) void

参数

usf: *UpdateSourceFiles
src_file: std.Build.LazyPath
sub_path: []const u8

std.Build.Step.UpdateSourceFiles.base_tag

常量

第 11 行

Step.Tag

std.Build.Step.UpdateSourceFiles.Configuration

别名

第 5 行

别名目标 std.Build.Configuration

std.Build.Step.UpdateSourceFiles.Copy

别名

第 14 行

别名目标 std.Build.Step.WriteFile.Copy

std.Build.Step.UpdateSourceFiles.create

函数

第 16 行

pub fn create(owner: *std.Build) *UpdateSourceFiles

参数

owner: *std.Build

std.Build.Step.UpdateSourceFiles.Embed

别名

第 13 行

别名目标 std.Build.Step.WriteFile.Embed

std.Build.Step.UpdateSourceFiles.std

别名

第 3 行

别名目标 std

std.Build.Step.UpdateSourceFiles.Step

别名

第 4 行

别名目标 std.Build.Step

std.Build.Step.UpdateSourceFiles.UpdateSourceFiles

别名

第 1 行

别名目标 std.Build.Step.UpdateSourceFiles

源码

std/Build/Step/UpdateSourceFiles.zig

const UpdateSourceFiles = @This();

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

step: Step,
embeds: std.ArrayList(Embed) = .empty,
copies: std.ArrayList(Copy) = .empty,

pub const base_tag: Step.Tag = .update_source_files;

pub const Embed = Step.WriteFile.Embed;
pub const Copy = Step.WriteFile.Copy;

pub fn create(owner: *std.Build) *UpdateSourceFiles {
    const graph = owner.graph;
    const usf = graph.create(UpdateSourceFiles);
    usf.* = .{
        .step = .init(.{
            .tag = base_tag,
            .name = "UpdateSourceFiles",
            .owner = owner,
        }),
    };
    return usf;
}

/// 用另一个文件的内容覆盖相对于构建根目录的路径。
///
/// 由于会更新源码文件,不应在常规
/// 构建过程中使用,而应作为开发者偶尔运行的工具,
/// 用于主动修改源码文件,并随后将更改提交到版本
/// 控制。
pub fn addCopyFileToSource(usf: *UpdateSourceFiles, src_file: std.Build.LazyPath, sub_path: []const u8) void {
    const graph = usf.step.owner.graph;
    const wc = &graph.wip_configuration;
    const arena = graph.arena;

    usf.copies.append(arena, .{
        .sub_path = wc.addString(sub_path) catch @panic("OOM"),
        .src_file = src_file.dupe(graph),
    }) catch @panic("OOM");

    src_file.addStepDependencies(&usf.step);
}

/// 使用提供的字节覆盖相对于包根目录的路径。
///
/// 由于会更新源码文件,因此不应将其用于
/// 常规构建过程;应将其用作开发者偶尔运行的工具,
/// 专门用于修改源码文件,随后将这些修改提交到版本
/// 控制。
pub fn addBytesToSource(usf: *UpdateSourceFiles, contents: []const u8, sub_path: []const u8) void {
    const graph = usf.step.owner.graph;
    const wc = &graph.wip_configuration;
    const arena = graph.arena;

    usf.embeds.append(arena, .{
        .sub_path = wc.addString(sub_path) catch @panic("OOM"),
        .contents = wc.addBytes(contents) catch @panic("OOM"),
    }) catch @panic("OOM");
}