Replace mach-glfw with pkg/glfw (#6708)

Closes #6702

This removes our mach-glfw dependency and replaces it with an in-tree
pkg/glfw that includes both the source for compiling glfw as well as the
Zig bindings. This matches the pattern from our other packages.

This is based on the upstream mach-glfw work and therefore includes the
original license and copyright information.

The reasoning is stated in the issue but to summarize for the commit:

  - mach-glfw is no longer maintained, so we have to take ownership
- mach-glfw depended on some large blobs of header files to enable
cross-compilation but this isn't something we actually care about, so we
can (and do) drop the blobs
- mach-glfw blobs were hosted on mach hosts. given mach-glfw is
unmaintained, we can't rely on this hosting
- mach-glfw relied on a "glfw" package which was owned by another person
to be Zig 0.14 compatible, but we no longer need to rely on this
  - mach-glfw builds were outdated based on latest Zig practices

Author: mitchellh

.gitattributes

@@ -5,6 +5,7 @@ vendor/** linguist-vendored
 website/** linguist-documentation
 pkg/breakpad/vendor/** linguist-vendored
 pkg/cimgui/vendor/** linguist-vendored
+pkg/glfw/wayland-headers/** linguist-vendored
 pkg/libintl/config.h linguist-generated=true
 pkg/libintl/libintl.h linguist-generated=true
 pkg/simdutf/vendor/** linguist-vendored

.github/workflows/test.yml

@@ -10,14 +10,15 @@ jobs:
     name: "Required Checks: Test"
     runs-on: namespace-profile-ghostty-sm
     needs:
-      - build
       - build-bench
+      - build-linux
       - build-linux-libghostty
       - build-nix
       - build-snap
       - build-macos
       - build-macos-matrix
       - build-windows
+      - build-windows-cross
       - test
       - test-gtk
       - test-sentry-linux
@@ -48,23 +49,9 @@ jobs:
           echo "One or more required build workflows failed: ${{ steps.status.outputs.results }}"
           exit 1
 
-  build:
-    strategy:
-      fail-fast: false
-      matrix:
-        os: ["namespace-profile-ghostty-md"]
-
-        target: [
-            aarch64-linux,
-            x86_64-linux,
-            x86-windows-gnu,
-            x86_64-windows-gnu,
-            # We don't support cross-compiling to macOS because the macOS build
-            # requires xcode due to the swift harness.
-            #aarch64-macos,
-            #x86_64-macos,
-          ]
-    runs-on: ${{ matrix.os }}
+  build-bench:
+    # We build benchmarks on large because it uses ReleaseFast
+    runs-on: namespace-profile-ghostty-lg
     needs: test
     env:
       ZIG_LOCAL_CACHE_DIR: /zig/local-cache
@@ -89,14 +76,15 @@ jobs:
           name: ghostty
           authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
 
-      # Cross-compile the binary. We always use static building for this
-      # because its the only way to access the headers.
-      - name: Test Build
-        run: nix develop -c zig build -Dapp-runtime=glfw -Dtarget=${{ matrix.target }}
+      - name: Build Benchmarks
+        run: nix develop -c zig build -Dapp-runtime=glfw -Demit-bench
 
-  build-bench:
-    # We build benchmarks on large because it uses ReleaseFast
-    runs-on: namespace-profile-ghostty-lg
+  build-linux:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [namespace-profile-ghostty-md, namespace-profile-ghostty-md-arm64]
+    runs-on: ${{ matrix.os }}
     needs: test
     env:
       ZIG_LOCAL_CACHE_DIR: /zig/local-cache
@@ -121,8 +109,8 @@ jobs:
           name: ghostty
           authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
 
-      - name: Build Benchmarks
-        run: nix develop -c zig build -Dapp-runtime=glfw -Demit-bench
+      - name: Test Build
+        run: nix develop -c zig build -Dapp-runtime=glfw
 
   build-linux-libghostty:
     runs-on: namespace-profile-ghostty-md
@@ -373,6 +361,52 @@ jobs:
         shell: pwsh
         run: Get-Content -Path ".\build.log"
 
+  build-windows-cross:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["namespace-profile-ghostty-md"]
+
+        target: [
+            x86-windows-gnu,
+            x86_64-windows-gnu,
+            # We don't support cross-compiling to macOS or Linux because
+            # we require system libraries.
+            #aarch64-linux,
+            #x86_64-linux,
+            #aarch64-macos,
+            #x86_64-macos,
+          ]
+    runs-on: ${{ matrix.os }}
+    needs: test
+    env:
+      ZIG_LOCAL_CACHE_DIR: /zig/local-cache
+      ZIG_GLOBAL_CACHE_DIR: /zig/global-cache
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Cache
+        uses: namespacelabs/[email protected]
+        with:
+          path: |
+            /nix
+            /zig
+
+      # Install Nix and use that to run our tests so our environment matches exactly.
+      - uses: cachix/install-nix-action@v30
+        with:
+          nix_path: nixpkgs=channel:nixos-unstable
+      - uses: cachix/cachix-action@v15
+        with:
+          name: ghostty
+          authToken: "${{ secrets.CACHIX_AUTH_TOKEN }}"
+
+      # Cross-compile the binary. We always use static building for this
+      # because its the only way to access the headers.
+      - name: Test Build
+        run: nix develop -c zig build -Dapp-runtime=glfw -Dtarget=${{ matrix.target }}
+
   test:
     if: github.repository == 'ghostty-org/ghostty'
     runs-on: namespace-profile-ghostty-md

build.zig.zon

@@ -11,12 +11,6 @@
             .url = "https://github.com/mitchellh/libxev/archive/3df9337a9e84450a58a2c4af434ec1a036f7b494.tar.gz",
             .hash = "libxev-0.0.0-86vtc-ziEgDbLP0vihUn1MhsxNKY4GJEga6BEr7oyHpz",
         },
-        .mach_glfw = .{
-            // mitchellh/mach-glfw
-            .url = "https://github.com/mitchellh/mach-glfw/archive/d84bc11b0601cdad71035a0e9cf21572d76aa0d2.zip",
-            .hash = "mach_glfw-0.2.0-EJSQm2M9BQCiYGTd9VcKjg2DhSD7WT4kS-MfX68ORRT_",
-            .lazy = true,
-        },
         .vaxis = .{
             // rockorager/libvaxis
             .url = "git+https://github.com/rockorager/libvaxis#1e24e0dfb509e974e1c8713bcd119d0ae032a8c7",
@@ -62,6 +56,7 @@
         .cimgui = .{ .path = "./pkg/cimgui" },
         .fontconfig = .{ .path = "./pkg/fontconfig" },
         .freetype = .{ .path = "./pkg/freetype" },
+        .glfw = .{ .path = "./pkg/glfw" },
         .gtk4_layer_shell = .{ .path = "./pkg/gtk4-layer-shell" },
         .harfbuzz = .{ .path = "./pkg/harfbuzz" },
         .highway = .{ .path = "./pkg/highway" },

build.zig.zon.nix

@@ -41,6 +41,7 @@
   harfbuzz,
   libpng,
   libGL,
+  libxkbcommon,
   libX11,
   libXcursor,
   libXext,
@@ -83,6 +84,7 @@
       glslang
       spirv-cross
 
+      libxkbcommon
       libX11
       libXcursor
       libXi
@@ -162,6 +164,7 @@ in
         glslang
         spirv-cross
 
+        libxkbcommon
         libX11
         libXcursor
         libXext