Add zig build to CI (#622)

It's not ideal, but at least it's being tested. I have added support for pcre2test, so that we can run the unit tests against the library which Zig builds.

Author: NWilson

.github/workflows/dev.yml

@@ -274,6 +274,31 @@ jobs:
       - name: Test
         run: cd build && ctest -j3 --output-on-failure
 
+  zebrilus:
+    # Tests with: Zig compiler
+    name: Zig
+    runs-on: ubuntu-latest
+    if: github.event_name != 'pull_request'
+    steps:
+      - name: Setup
+        run: |
+          sudo snap install zig --classic --beta
+
+      - name: Checkout
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+        with:
+          submodules: true
+
+      - name: Build
+        run: zig build
+
+      - name: Test
+        run: |
+          # Zig does something weird with the stack - it uses more space than the
+          # equivalent plain C program.
+          ulimit -S -s 16384
+          srcdir=`pwd` pcre2test=`pwd`/zig-out/bin/pcre2test ./RunTest
+
   bazel:
     # Tests with: Bazel build system
     name: Bazel

build.zig

@@ -12,9 +12,39 @@ pub fn build(b: *std.Build) !void {
     const linkage = b.option(std.builtin.LinkMode, "linkage", "whether to statically or dynamically link the library") orelse @as(std.builtin.LinkMode, if (target.result.isGnuLibC()) .dynamic else .static);
     const codeUnitWidth = b.option(CodeUnitWidth, "code-unit-width", "Sets the code unit width") orelse .@"8";
 
-    const copyFiles = b.addWriteFiles();
-    _ = copyFiles.addCopyFile(b.path("src/config.h.generic"), "config.h");
-    _ = copyFiles.addCopyFile(b.path("src/pcre2.h.generic"), "pcre2.h");
+    const pcre2_header_dir = b.addWriteFiles();
+    const pcre2_header = pcre2_header_dir.addCopyFile(b.path("src/pcre2.h.generic"), "pcre2.h");
+
+    const config_header = b.addConfigHeader(
+        .{
+            .style = .{ .cmake = b.path("config-cmake.h.in") },
+            .include_path = "config.h",
+        },
+        .{
+            .HAVE_ASSERT_H = true,
+            .HAVE_UNISTD_H = (target.result.os.tag != .windows),
+            .HAVE_WINDOWS_H = (target.result.os.tag == .windows),
+
+            .HAVE_MEMMOVE = true,
+            .HAVE_STRERROR = true,
+
+            .SUPPORT_PCRE2_8 = codeUnitWidth == CodeUnitWidth.@"8",
+            .SUPPORT_PCRE2_16 = codeUnitWidth == CodeUnitWidth.@"16",
+            .SUPPORT_PCRE2_32 = codeUnitWidth == CodeUnitWidth.@"32",
+            .SUPPORT_UNICODE = true,
+
+            .PCRE2_EXPORT = null,
+            .PCRE2_LINK_SIZE = 2,
+            .PCRE2_HEAP_LIMIT = 20000000,
+            .PCRE2_MATCH_LIMIT = 10000000,
+            .PCRE2_MATCH_LIMIT_DEPTH = "MATCH_LIMIT",
+            .PCRE2_MAX_VARLOOKBEHIND = 255,
+            .NEWLINE_DEFAULT = 2,
+            .PCRE2_PARENS_NEST_LIMIT = 250,
+        },
+    );
+
+    // pcre2-8/16/32.so
 
     const lib = std.Build.Step.Compile.create(b, .{
         .name = b.fmt("pcre2-{s}", .{@tagName(codeUnitWidth)}),
@@ -27,22 +57,20 @@ pub fn build(b: *std.Build) !void {
         .linkage = linkage,
     });
 
+    lib.defineCMacro("HAVE_CONFIG_H", null);
+    lib.defineCMacro("PCRE2_CODE_UNIT_WIDTH", @tagName(codeUnitWidth));
     if (linkage == .static) {
-        try lib.root_module.c_macros.append(b.allocator, "-DPCRE2_STATIC");
+        lib.defineCMacro("PCRE2_STATIC", null);
     }
 
-    lib.root_module.addCMacro("PCRE2_CODE_UNIT_WIDTH", @tagName(codeUnitWidth));
+    lib.addConfigHeader(config_header);
+    lib.addIncludePath(pcre2_header_dir.getDirectory());
+    lib.addIncludePath(b.path("src"));
 
     lib.addCSourceFile(.{
-        .file = copyFiles.addCopyFile(b.path("src/pcre2_chartables.c.dist"), "pcre2_chartables.c"),
-        .flags = &.{
-            "-DHAVE_CONFIG_H",
-        },
+        .file = b.addWriteFiles().addCopyFile(b.path("src/pcre2_chartables.c.dist"), "pcre2_chartables.c"),
     });
 
-    lib.addIncludePath(b.path("src"));
-    lib.addIncludePath(copyFiles.getDirectory());
-
     lib.addCSourceFiles(.{
         .files = &.{
             "src/pcre2_auto_possess.c",
@@ -56,6 +84,7 @@ pub fn build(b: *std.Build) !void {
             "src/pcre2_error.c",
             "src/pcre2_extuni.c",
             "src/pcre2_find_bracket.c",
+            "src/pcre2_jit_compile.c",
             "src/pcre2_maketables.c",
             "src/pcre2_match.c",
             "src/pcre2_match_data.c",
@@ -73,12 +102,72 @@ pub fn build(b: *std.Build) !void {
             "src/pcre2_valid_utf.c",
             "src/pcre2_xclass.c",
         },
-        .flags = &.{
-            "-DHAVE_CONFIG_H",
-            "-DPCRE2_STATIC",
-        },
     });
 
-    lib.installHeader(b.path("src/pcre2.h.generic"), "pcre2.h");
+    lib.installHeader(pcre2_header, "pcre2.h");
     b.installArtifact(lib);
+
+
+    // pcre2test
+
+    const pcre2test = b.addExecutable(.{
+        .name = "pcre2test",
+        .target = target,
+        .optimize = optimize,
+    });
+
+
+    // pcre2-posix.so
+
+    if (codeUnitWidth == CodeUnitWidth.@"8") {
+        const posixLib = std.Build.Step.Compile.create(b, .{
+            .name = "pcre2-posix",
+            .root_module = .{
+                .target = target,
+                .optimize = optimize,
+                .link_libc = true,
+            },
+            .kind = .lib,
+            .linkage = linkage,
+        });
+
+        posixLib.defineCMacro("HAVE_CONFIG_H", null);
+        posixLib.defineCMacro("PCRE2_CODE_UNIT_WIDTH", @tagName(codeUnitWidth));
+        if (linkage == .static) {
+            posixLib.defineCMacro("PCRE2_STATIC", null);
+        }
+
+        posixLib.addConfigHeader(config_header);
+        posixLib.addIncludePath(pcre2_header_dir.getDirectory());
+        posixLib.addIncludePath(b.path("src"));
+
+        posixLib.addCSourceFiles(.{
+            .files = &.{
+                "src/pcre2posix.c",
+            },
+        });
+
+        posixLib.installHeader(b.path("src/pcre2posix.h"), "pcre2posix.h");
+        b.installArtifact(posixLib);
+
+        pcre2test.linkLibrary(posixLib);
+    }
+
+
+    // pcre2test (again)
+
+    pcre2test.defineCMacro("HAVE_CONFIG_H", null);
+
+    pcre2test.addConfigHeader(config_header);
+    pcre2test.addIncludePath(pcre2_header_dir.getDirectory());
+    pcre2test.addIncludePath(b.path("src"));
+
+    pcre2test.addCSourceFile(.{
+        .file = b.path("src/pcre2test.c"),
+    });
+
+    pcre2test.linkLibC();
+    pcre2test.linkLibrary(lib);
+
+    b.installArtifact(pcre2test);
 }

config-cmake.h.in

@@ -41,11 +41,11 @@
 #cmakedefine HEAP_MATCH_RECURSE 1
 #cmakedefine NEVER_BACKSLASH_C 1
 
-#define PCRE2_EXPORT		@PCRE2_EXPORT@
-#define LINK_SIZE		@PCRE2_LINK_SIZE@
+#define PCRE2_EXPORT            @PCRE2_EXPORT@
+#define LINK_SIZE               @PCRE2_LINK_SIZE@
 #define HEAP_LIMIT              @PCRE2_HEAP_LIMIT@
-#define MATCH_LIMIT		@PCRE2_MATCH_LIMIT@
-#define MATCH_LIMIT_DEPTH	@PCRE2_MATCH_LIMIT_DEPTH@
+#define MATCH_LIMIT             @PCRE2_MATCH_LIMIT@
+#define MATCH_LIMIT_DEPTH       @PCRE2_MATCH_LIMIT_DEPTH@
 #define MAX_VARLOOKBEHIND       @PCRE2_MAX_VARLOOKBEHIND@
 #define NEWLINE_DEFAULT         @NEWLINE_DEFAULT@
 #define PARENS_NEST_LIMIT       @PCRE2_PARENS_NEST_LIMIT@