all: nominate Zig 2024.1.0-mach

[slimsag]

Periodically we nominate a new Zig nightly version to be the version that Mach targets, and begin the meticulous process of updating every Mach project to use that new version.

This is the tracking issue to do that for the next scheduled nomination (see the date in the issue title.)

You may have been linked to this issue because you sent a pull request to update a Mach project to use a new Zig API - if that is the case we do appreciate the PR and will look at merging it once this process begins. In the meantime, your PR may stay open for a while. You can either use a fork of the project, or use the version of Zig that Mach currently supports.

Update process

• It is time to begin (see date in issue title, we aim to begin this checklist between the 1st-4th of that month.)
• In machengine.org repository static/zig folder, wrench script nominate-zig-index-update nominate 2024.1.0-mach-wip has been ran and the index.json has been updated.
• #wrench automation (!wrench schedule-now update-zig-version) has created new pull requests to update the Zig version used in CI of all our projects, and it matches index.json.
• The Nomination history has a new section for the latest nightly Zig version which Wrench used in its PRs, with a warning at the top **IN-PROGRESS:** This version is currently being nominated, see [the tracking issue](https://github.com/hexops/mach/issues/1135) for details. Once everything looks good, the new Zig version is confirmed to be working with Mach, we will declare success, close the issue, and remove this in-progress warning..
• #general Discord message: Beginning the process of nominating a new Zig version! (you should wait to upgrade until we've updated everything to confirm it works) $GITHUB_ISSUE
• #wrench automation (!wrench script-all install-zig) has updated the Zig version used by self-hosted GitHub actions runners. TODO this needs some work.
• "First-order projects" below (which have zero build.zig.zon dependencies) have been updated, their CI is passing/green using the new version.
• "Second-order projects" below (which have build.zig.zon dependencies) have been updated, their CI is passing/green using the new version.
• The mach-glfw build.zig version check has been updated: https://github.com/hexops/mach-glfw/blob/main/build.zig
• The mach-core build.zig version check has been updated: https://github.com/hexops/mach-core/blob/main/build.zig#L222-L227
• https://machengine.org/core/migrations/ has a new entry for Core users looking to update, or changes are not needed.
• The .zigversion file https://github.com/hexops/mach/blob/main/.zigversion has been updated.
• The mach build.zig version check has been updated: https://github.com/hexops/mach/blob/main/build.zig#L187-L192
• https://machengine.org/about/zig-version has been updated
• In machengine.org repository static/zig folder, wrench script nominate-zig-index-update finalize 2024.1.0-mach-wip has been ran and the index.json has had -wip removed and the mach-latest entry has been updated.
• The **IN-PROGRESS** warning in the Nomination history has been removed.
• A new issue has been filed for the next nomination.
• A #progress announcement has been made:

We've just finalized nominating and updating to Zig 2024.1.0-mach. We encourage you to update your projects to that Zig version now. :)

• Get the new Zig version: https://machengine.org/about/nominated-zig/#202410-mach
• Update your mach-core project: https://machengine.org/core/migrations/#mach-core-updated-to-zig-202410-mach-2024-01-14
• Tips on upgrading your own Zig code: all: nominate Zig 2024.1.0-mach #1135 (comment)
• Nomination tracking issue: $GITHUB_ISSUE

First-order projects

These projects have zero build.zig.zon dependencies, we update them first - and in any order.

• mach-ecs
• mach-gamemode
• mach-model3d
• mach-sysjs
• mach-objc-generator
• fastfilter
• spirv-cross
• brotli
• wayland-headers
• x11-headers
• vulkan-headers
• opengl-headers
• linux-audio-headers
• xcode-frameworks
• basisu
• vulkan-zig-generated
• directx-headers
• direct3d-headers
• opus
• flac
• ogg
• mach-core-example-assets
• font-assets

Second-order projects

These projects have dependencies on other projects. We update them in the exact order below, top-to-bottom.

• spirv-tools, which depends on:
  • External package https://github.com/KhronosGroup/SPIRV-Headers
• opusenc, which depends on:
  • opus
• freetype, which depends on:
  • brotli
• opusfile, which depends on:
  • opus
  • ogg
• harfbuzz, which depends on:
  • freetype
  • brotli
• glfw, which depends on:
  • xcode-frameworks
  • vulkan-headers
  • wayland-headers
  • x11-headers
• mach-glfw, which depends on:
  • glfw
• mach-dxcompiler, which depends on:
• mach-basisu, which depends on:
  • basisu
• mach-objc, which depends on:
  • xcode-frameworks
• mach-freetype, which depends on:
  • freetype
  • harfbuzz
  • font-assets
• mach-sysaudio, which depends on:
  • mach-sysjs
  • linux-audio-headers
  • xcode-frameworks
• mach-flac, which depends on:
  • flac
  • mach-sysaudio
  • linux-audio-headers
• mach-opus, which depends on:
  • opusfile
  • opusenc
  • mach-sysaudio
  • linux-audio-headers
• mach-gpu-dawn, which depends on:
  • xcode-frameworks
  • direct3d-headers
  • vulkan-headers
  • x11-headers
• mach-gpu, which depends on:
  • mach-glfw
  • mach-gpu-dawn
• mach-sysgpu, which depends on:
  • vulkan-zig-generated
  • mach-gpu
  • mach-objc
  • direct3d-headers
  • opengl-headers
  • xcode-frameworks
• mach-core, which depends on:
  • build.zig version check
  • mach-core-example-assets
  • mach-gamemode
  • mach-sysgpu
  • mach-gpu
  • mach-glfw
• mach-core-starter-project, which depends on:
  • mach-core
• mach, which depends on:
  • .zigversion
  • build.zig version check
  • mach-ecs
  • mach-core
  • mach-basisu
  • mach-sysaudio
  • mach-freetype
  • mach-sysjs
  • font-assets
• mach-examples, which depends on:
  • zigimg
  • mach
  • mach-freetype
• mach-editor, which depends on:
  • mach
  • mach-sysgpu
  • spirv-cross
  • spirv-tools

[slimsag]

First-order dependencies are almost finished, awesome! Remaining blockers:

• xcode-frameworks may need a change like as in this PR - but I'd like to see an explanation for why it is needed and why we need it and addPaths, instead of a single function? We'll have to try updating a package with xcode-frameworks to learn why. wasn't needed.
• directx-headers needs updating.
• Wrench didn't update spirv-cross, directx-headers, why?
• I will look at integrating some changes from https://github.com/mitchellh/zig-build-macos-sdk into our xcode-frameworks package.
  • This will be done at a later date, since Ghostty doesn't need it.

Additionally, let's try eliminating direct3d-headers in favor of directx-headers during this update process.

[slimsag]

Tips for updating code to Zig 2024.1.0-mach

Renamed:

• unnecessary var -> const changes must be made, if you have ZLS installed and open each Zig file and save, it will do it automatically for you.
• std.build.Builder -> std.Build
• std.build.RunStep -> std.Build.Step.Run
• std.build.CompileStep -> std.Build.Step.Compile
• std.build.ModuleDependency -> std.Build.Module.Import
• std.zig.CrossTarget -> std.Build.ResolvedTarget
• std.mem.copy(T, dst, src) -> @memcpy(dst, src)
• std.fs.openIterableDirAbsolute -> std.fs.openDirAbsolute(dir, .{.iterate = true})
• target.toTarget().os.tag -> target.result.os.tag
• step.target_info -> step.rootModuleTarget()
• target.getOsTag() -> target.os.tag
• target.getAbi() -> target.abi
• target.getCpuArch() -> target.cpu.arch
• target.isWindows() -> target.os.tag == .windows
• std.atomic.Atomic(T) -> std.atomic.Value(T)
• step.addModule("foo", bar) -> step.root_module.addImport("foo", bar)
• .dependencies = &.{} -> .imports = &.{}
• comptime const foo -> const foo

Error resolutions:

error: no field named 'source_file' in struct 'Build.Module.CreateOptions'

Change .source_file -> .root_source_file

error: expected type expression, found 'invalid bytes'

error: expected type expression, found 'invalid bytes'
#include "hb-aat-layout.cc"
^
src/harfbuzz.cc:1:1: note: invalid byte: '#'

.root_source_file can no longer be C/C++ files, only .zig. Remove .root_source_file entirely and add the C/C++ file to the module using e.g. this instead:

    lib.addCSourceFile(.{ .file = .{ .path = "src/harfbuzz.cc" } });

panic: @memcpy arguments have non-equal lengths

Ensure both arguments to memcpy have the same lengths. For example a previously valid copy can be updated like this:

-@memcpy(title[0..], opt.title);
+@memcpy(title[0..opt.title.len], opt.title);

[Techatrix]

• unnecessary var -> const changes must be made, if you have ZLS installed and open each Zig file and save, it will do it automatically for you.

That feature has been removed from autofix in zigtools/zls#1652 so it is only an ordinary code action.
The autofix feature has also been disabled by default in zigtools/zls#1657 😭.

[Cloudef]

gnused, bash alternative

if [[ ! -d "$1" ]]; then
  printf 'error: no such directory: %s\n' "$1"
  exit 1
fi

cd "$1"
has_wontfix=0

while {
    IFS=$':' read -r file line col msg;
} do
  if [[ "$msg" ]]; then
    case "$msg" in
      *"local variable is never mutated")
        printf 'autofix: %s\n' "$file:$line:$col:$msg" 1>&2
        sed -i "''${line}s/var/const/" "$file"
        ;;
      *)
        printf 'wontfix: %s\n' "$file:$line:$col:$msg" 1>&2
        has_wontfix=1
        ;;
    esac
  fi
done < <(zig build 2>&1 | grep "error:")

exit $has_wontfix

[Srekel]

Super useful!!

A couple extra things I had to do when updating Tides (from a pretty old Zig build):

std.builtin.Endian.Little -> little

Actually not sure if this one is correct but I guess so?
comptime var arg_count = ecsu.meta.argCount(function); -> const arg_count = comptime ecsu.meta.argCount(function);

std.zig.system.NativeTargetInfo.detect(target) -> std.zig.system.resolveTargetQuery(target.query)

exe.linkSystemLibraryName("imm32"); -> exe.linkSystemLibrary("imm32");