Skip to content

Commit 97c1419

Browse files
xxxbxxxxxxbxxx
committed
std.Build: add an option to addCSourceFiles() to include a precompiled header
1 parent d35a562 commit 97c1419

File tree

8 files changed

+166
-2
lines changed

8 files changed

+166
-2
lines changed

‎lib/std/Build/Module.zig

+13
Original file line numberDiff line numberDiff line change
@@ -126,18 +126,21 @@ pub const CSourceFiles = struct {
126126
files: []const []const u8,
127127
lang: ?CSourceLang = null,
128128
flags: []const []const u8,
129+
precompiled_header: ?LazyPath = null,
129130
};
130131

131132
pub const CSourceFile = struct {
132133
file: LazyPath,
133134
lang: ?CSourceLang = null,
134135
flags: []const []const u8 = &.{},
136+
precompiled_header: ?LazyPath = null,
135137

136138
pub fn dupe(file: CSourceFile, b: *std.Build) CSourceFile {
137139
return .{
138140
.file = file.file.dupe(b),
139141
.lang = file.lang,
140142
.flags = b.dupeStrings(file.flags),
143+
.precompiled_header = file.precompiled_header,
141144
};
142145
}
143146
};
@@ -529,6 +532,7 @@ pub const AddCSourceFilesOptions = struct {
529532
files: []const []const u8,
530533
lang: ?CSourceLang = null,
531534
flags: []const []const u8 = &.{},
535+
precompiled_header: ?LazyPath = null,
532536
};
533537

534538
/// Handy when you have many C/C++ source files and want them all to have the same flags.
@@ -551,9 +555,14 @@ pub fn addCSourceFiles(m: *Module, options: AddCSourceFilesOptions) void {
551555
.files = b.dupeStrings(options.files),
552556
.lang = options.lang,
553557
.flags = b.dupeStrings(options.flags),
558+
.precompiled_header = options.precompiled_header,
554559
};
555560
m.link_objects.append(allocator, .{ .c_source_files = c_source_files }) catch @panic("OOM");
556561
addLazyPathDependenciesOnly(m, c_source_files.root);
562+
563+
if (options.precompiled_header) |pch| {
564+
addLazyPathDependenciesOnly(m, pch);
565+
}
557566
}
558567

559568
pub fn addCSourceFile(m: *Module, source: CSourceFile) void {
@@ -563,6 +572,10 @@ pub fn addCSourceFile(m: *Module, source: CSourceFile) void {
563572
c_source_file.* = source.dupe(b);
564573
m.link_objects.append(allocator, .{ .c_source_file = c_source_file }) catch @panic("OOM");
565574
addLazyPathDependenciesOnly(m, source.file);
575+
576+
if (source.precompiled_header) |pch| {
577+
addLazyPathDependenciesOnly(m, pch);
578+
}
566579
}
567580

568581
/// Resource files must have the extension `.rc`.

‎lib/std/Build/Step/Compile.zig

+14-2
Original file line numberDiff line numberDiff line change
@@ -1246,7 +1246,7 @@ fn getZigArgs(compile: *Compile) ![][]const u8 {
12461246
.c_source_file => |c_source_file| l: {
12471247
if (!my_responsibility) break :l;
12481248

1249-
if (c_source_file.flags.len == 0) {
1249+
if (c_source_file.flags.len == 0 and c_source_file.precompiled_header == null) {
12501250
if (prev_has_cflags) {
12511251
try zig_args.append("-cflags");
12521252
try zig_args.append("--");
@@ -1257,6 +1257,11 @@ fn getZigArgs(compile: *Compile) ![][]const u8 {
12571257
for (c_source_file.flags) |arg| {
12581258
try zig_args.append(arg);
12591259
}
1260+
if (c_source_file.precompiled_header) |pch| {
1261+
try zig_args.append("-include-pch");
1262+
try zig_args.append(pch.getPath(b));
1263+
try zig_args.append("-fpch-validate-input-files-content");
1264+
}
12601265
try zig_args.append("--");
12611266
prev_has_cflags = true;
12621267
}
@@ -1273,7 +1278,7 @@ fn getZigArgs(compile: *Compile) ![][]const u8 {
12731278
.c_source_files => |c_source_files| l: {
12741279
if (!my_responsibility) break :l;
12751280

1276-
if (c_source_files.flags.len == 0) {
1281+
if (c_source_files.flags.len == 0 and c_source_files.precompiled_header == null) {
12771282
if (prev_has_cflags) {
12781283
try zig_args.append("-cflags");
12791284
try zig_args.append("--");
@@ -1284,6 +1289,13 @@ fn getZigArgs(compile: *Compile) ![][]const u8 {
12841289
for (c_source_files.flags) |flag| {
12851290
try zig_args.append(flag);
12861291
}
1292+
1293+
if (c_source_files.precompiled_header) |pch| {
1294+
try zig_args.append("-include-pch");
1295+
try zig_args.append(pch.getPath(b));
1296+
try zig_args.append("-fpch-validate-input-files-content");
1297+
}
1298+
12871299
try zig_args.append("--");
12881300
prev_has_cflags = true;
12891301
}

‎test/standalone/build.zig.zon

+3
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,9 @@
173173
.dependencyFromBuildZig = .{
174174
.path = "dependencyFromBuildZig",
175175
},
176+
.precompiled_c_headers = .{
177+
.path = "pch",
178+
},
176179
.run_output_paths = .{
177180
.path = "run_output_paths",
178181
},

‎test/standalone/pch/build.zig

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
const std = @import("std");
2+
3+
pub fn build(b: *std.Build) void {
4+
const test_step = b.step("test", "Test it");
5+
b.default_step = test_step;
6+
7+
const target = b.standardTargetOptions(.{});
8+
const optimize = b.standardOptimizeOption(.{});
9+
10+
// c-header
11+
{
12+
const exe = b.addExecutable(.{
13+
.name = "pchtest",
14+
.target = target,
15+
.optimize = optimize,
16+
.link_libc = true,
17+
});
18+
19+
const pch = b.addPrecompiledCHeader(.{
20+
.name = "pch_c",
21+
.target = target,
22+
.optimize = optimize,
23+
.link_libc = true,
24+
}, .{
25+
.file = b.path("include_a.h"),
26+
.flags = &[_][]const u8{},
27+
.lang = .h,
28+
});
29+
30+
exe.addCSourceFiles(.{
31+
.files = &.{"test.c"},
32+
.flags = &[_][]const u8{},
33+
.lang = .c,
34+
.precompiled_header = pch.getEmittedBin(),
35+
});
36+
37+
test_step.dependOn(&b.addRunArtifact(exe).step);
38+
}
39+
40+
// c++-header
41+
{
42+
const exe = b.addExecutable(.{
43+
.name = "pchtest++",
44+
.target = target,
45+
.optimize = optimize,
46+
.link_libc = true,
47+
});
48+
exe.linkLibCpp();
49+
50+
const pch = b.addPrecompiledCHeader(.{
51+
.name = "pch_c++",
52+
.target = target,
53+
.optimize = optimize,
54+
.link_libcpp = true,
55+
}, .{
56+
.file = b.path("include_a.h"),
57+
.flags = &[_][]const u8{},
58+
.lang = .hpp,
59+
});
60+
61+
exe.addCSourceFile(.{
62+
.file = b.path("test.cpp"),
63+
.flags = &[_][]const u8{},
64+
.precompiled_header = pch.getEmittedBin(),
65+
});
66+
67+
test_step.dependOn(&b.addRunArtifact(exe).step);
68+
}
69+
}

‎test/standalone/pch/include_a.h

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#pragma once
2+
3+
#include "include_b.h"
4+
5+
#include <string.h>
6+
#include <stdlib.h>
7+
8+
#if defined(__cplusplus)
9+
#include <iostream>
10+
#else
11+
#include <stdio.h>
12+
#endif
13+
14+
#define A_INCLUDED 1
15+

‎test/standalone/pch/include_b.h

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#pragma once
2+
3+
#include <math.h>
4+
5+
typedef double real;
6+
7+
#define B_INCLUDED 1

‎test/standalone/pch/test.c

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
2+
// includes commented out to make sure the symbols come from the precompiled header.
3+
//#include "include_a.h"
4+
//#include "include_b.h"
5+
6+
#ifndef A_INCLUDED
7+
#error "pch not included"
8+
#endif
9+
#ifndef B_INCLUDED
10+
#error "pch not included"
11+
#endif
12+
13+
int main(int argc, char *argv[])
14+
{
15+
real a = 0.123;
16+
17+
if (argc > 1) {
18+
fprintf(stdout, "abs(%g)=%g\n", a, fabs(a));
19+
}
20+
21+
return EXIT_SUCCESS;
22+
}

‎test/standalone/pch/test.cpp

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
// includes commented out to make sure the symbols come from the precompiled header.
3+
//#include "includeA.h"
4+
//#include "includeB.h"
5+
6+
#ifndef A_INCLUDED
7+
#error "pch not included"
8+
#endif
9+
#ifndef B_INCLUDED
10+
#error "pch not included"
11+
#endif
12+
13+
int main(int argc, char *argv[])
14+
{
15+
real a = -0.123;
16+
17+
if (argc > 1) {
18+
std::cout << "abs(" << a << ")=" << fabs(a) << "\n";
19+
}
20+
21+
return EXIT_SUCCESS;
22+
}
23+

0 commit comments

Comments
 (0)