diff --git a/.gitignore b/.gitignore index ee7098f..9ad6b22 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ zig-out/ zig-cache/ +.zig-cache/ diff --git a/build.zig b/build.zig index eb49f6a..acacc4e 100644 --- a/build.zig +++ b/build.zig @@ -15,17 +15,21 @@ pub fn build(b: *std.Build) void { // set a preferred release mode, allowing the user to decide how to optimize. const optimize = b.standardOptimizeOption(.{}); - _ = b.addModule("bit-string", .{ .root_source_file = .{ .path = "src/lib.zig" } }); - const lib = b.addStaticLibrary(.{ .name = "bit-string", // In this case the main source file is merely a path, however, in more // complicated build scripts, this could be a generated file. - .root_source_file = .{ .path = "src/lib.zig" }, + .root_source_file = b.path("src/lib.zig"), .target = target, .optimize = optimize, }); + const docs = b.addInstallDirectory(.{ + .install_dir = .prefix, + .install_subdir = "docs", + .source_dir = lib.getEmittedDocs(), + }); + // This declares intent for the library to be installed into the standard // location when the user invokes the "install" step (the default step when // running `zig build`). @@ -33,27 +37,20 @@ pub fn build(b: *std.Build) void { // Creates a step for unit testing. This only builds the test executable // but does not run it. - const lib_tests = b.addTest(.{ - .root_source_file = .{ .path = "src/test.zig" }, + const lib_unit_tests = b.addTest(.{ + .root_source_file = b.path("src/test.zig"), .target = target, .optimize = optimize, }); - const run_main_tests = b.addRunArtifact(lib_tests); + const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests); - // This creates a build step. It will be visible in the `zig build --help` menu, - // and can be selected like this: `zig build test` - // This will evaluate the `test` step rather than the default, which is "install". - const test_step = b.step("test", "Run library tests"); - test_step.dependOn(&run_main_tests.step); + // Similar to creating the run step earlier, this exposes a `test` step to + // the `zig build --help` menu, providing a way for the user to request + // running the unit tests. + const test_step = b.step("test", "Run unit tests"); + test_step.dependOn(&run_lib_unit_tests.step); - // Build Documentation - const doc = b.addInstallDirectory(.{ - .source_dir = lib.getEmittedDocs(), - .install_dir = .prefix, - .install_subdir = "docs", - }); - - const doc_step = b.step("doc", "Generate documentation"); - doc_step.dependOn(&doc.step); + const docs_step = b.step("docs", "Emit docs"); + docs_step.dependOn(&docs.step); } diff --git a/build.zig.zon b/build.zig.zon index d6e04dd..a2eb69d 100644 --- a/build.zig.zon +++ b/build.zig.zon @@ -1,12 +1,72 @@ .{ + // This is the default name used by packages depending on this one. For + // example, when a user runs `zig fetch --save `, this field is used + // as the key in the `dependencies` table. Although the user can choose a + // different name, most users will stick with this provided value. + // + // It is redundant to include "zig" in this name because it is already + // within the Zig package namespace. .name = "bit-string", + + // This is a [Semantic Version](https://semver.org/). + // In a future version of Zig it will be used for package deduplication. .version = "0.1.0", + + // This field is optional. + // This is currently advisory only; Zig does not yet do anything + // with this value. + //.minimum_zig_version = "0.11.0", + + // This field is optional. + // Each dependency must either provide a `url` and `hash`, or a `path`. + // `zig build --fetch` can be used to fetch all dependencies of a package, recursively. + // Once all dependencies are fetched, `zig build` no longer requires + // internet connectivity. + .dependencies = .{ + // See `zig fetch --save ` for a command-line interface for adding dependencies. + //.example = .{ + // // When updating this field to a new URL, be sure to delete the corresponding + // // `hash`, otherwise you are communicating that you expect to find the old hash at + // // the new URL. + // .url = "https://example.com/foo.tar.gz", + // + // // This is computed from the file contents of the directory of files that is + // // obtained after fetching `url` and applying the inclusion rules given by + // // `paths`. + // // + // // This field is the source of truth; packages do not come from a `url`; they + // // come from a `hash`. `url` is just one of many possible mirrors for how to + // // obtain a package matching this `hash`. + // // + // // Uses the [multihash](https://multiformats.io/multihash/) format. + // .hash = "...", + // + // // When this is provided, the package is found in a directory relative to the + // // build root. In this case the package's hash is irrelevant and therefore not + // // computed. This field and `url` are mutually exclusive. + // .path = "foo", + + // // When this is set to `true`, a package is declared to be lazily + // // fetched. This makes the dependency only get fetched if it is + // // actually used. + // .lazy = false, + //}, + }, + + // Specifies the set of files and directories that are included in this package. + // Only files and directories listed here are included in the `hash` that + // is computed for this package. Only files listed here will remain on disk + // when using the zig package manager. As a rule of thumb, one should list + // files required for compilation plus any license(s). + // Paths are relative to the build root. Use the empty string (`""`) to refer to + // the build root itself. + // A directory listed here means that all files within, recursively, are included. .paths = .{ "build.zig", "build.zig.zon", - "LICENSE", - "README.md", - "src" + "src", + // For example... + //"LICENSE", + //"README.md", }, - .dependencies = .{}, } diff --git a/src/lib.zig b/src/lib.zig index 40a2662..e31e4ab 100644 --- a/src/lib.zig +++ b/src/lib.zig @@ -287,7 +287,7 @@ pub fn Bitfield(comptime bit_string: []const u8) type { }; return @Type(.{ .Struct = .{ - .layout = .Auto, + .layout = .auto, .fields = &fields, .decls = &.{}, .is_tuple = false, @@ -327,7 +327,7 @@ const pext = struct { } inline fn sw(comptime T: type, value: T, mask: T) T { - // FIXME: will be replaced in the future by https://github.com/ziglang/zig/issues/14995 (hopefully?) + // FIXME: will be replaced in the future by https://github.com/ziglang/zig/issues/14995 (hopefully?) return switch (T) { u32, u64 => {