From 7b1b3bfe18f4c68250ed32ae8e2522af53962fdc Mon Sep 17 00:00:00 2001 From: David Rebbe Date: Fri, 13 Dec 2024 14:22:36 -0500 Subject: [PATCH] added icsneo zig example --- examples/icsneo/zig/simple/.gitignore | 22 ++++++ examples/icsneo/zig/simple/build.zig | 97 ++++++++++++++++++++++++ examples/icsneo/zig/simple/build.zig.zon | 72 ++++++++++++++++++ examples/icsneo/zig/simple/src/main.zig | 34 +++++++++ examples/icsneo/zig/simple/src/root.zig | 13 ++++ 5 files changed, 238 insertions(+) create mode 100644 examples/icsneo/zig/simple/.gitignore create mode 100644 examples/icsneo/zig/simple/build.zig create mode 100644 examples/icsneo/zig/simple/build.zig.zon create mode 100644 examples/icsneo/zig/simple/src/main.zig create mode 100644 examples/icsneo/zig/simple/src/root.zig diff --git a/examples/icsneo/zig/simple/.gitignore b/examples/icsneo/zig/simple/.gitignore new file mode 100644 index 0000000..8e179b9 --- /dev/null +++ b/examples/icsneo/zig/simple/.gitignore @@ -0,0 +1,22 @@ +# This file is for zig-specific build artifacts. +# If you have OS-specific or editor-specific files to ignore, +# such as *.swp or .DS_Store, put those in your global +# ~/.gitignore and put this in your ~/.gitconfig: +# +# [core] +# excludesfile = ~/.gitignore +# +# Cheers! +# -andrewrk + +.zig-cache/ +zig-out/ +/release/ +/debug/ +/build/ +/build-*/ +/docgen_tmp/ + +# Although this was renamed to .zig-cache, let's leave it here for a few +# releases to make it less annoying to work with multiple branches. +zig-cache/ \ No newline at end of file diff --git a/examples/icsneo/zig/simple/build.zig b/examples/icsneo/zig/simple/build.zig new file mode 100644 index 0000000..4c91dfc --- /dev/null +++ b/examples/icsneo/zig/simple/build.zig @@ -0,0 +1,97 @@ +const std = @import("std"); + +// Although this function looks imperative, note that its job is to +// declaratively construct a build graph that will be executed by an external +// runner. +pub fn build(b: *std.Build) void { + // Standard target options allows the person running `zig build` to choose + // what target to build for. Here we do not override the defaults, which + // means any target is allowed, and the default is native. Other options + // for restricting supported target set are available. + const target = b.standardTargetOptions(.{ .default_target = .{ .abi = .msvc } }); + + // Standard optimization options allow the person running `zig build` to select + // between Debug, ReleaseSafe, ReleaseFast, and ReleaseSmall. Here we do not + // set a preferred release mode, allowing the user to decide how to optimize. + const optimize = b.standardOptimizeOption(.{}); + + const lib = b.addStaticLibrary(.{ + .name = "simple", + // 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 = b.path("src/root.zig"), + .target = target, + .optimize = optimize, + }); + + // 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`). + b.installArtifact(lib); + + const exe = b.addExecutable(.{ + .name = "simple", + .root_source_file = b.path("src/main.zig"), + .target = target, + .optimize = optimize, + }); + + // Add support for icsneo + exe.linkLibC(); + exe.addIncludePath(b.path("../../../../include")); + exe.addLibraryPath(b.path("../../../../build")); + exe.linkSystemLibrary("icsneo"); + + // This declares intent for the executable to be installed into the + // standard location when the user invokes the "install" step (the default + // step when running `zig build`). + b.installArtifact(exe); + + // This *creates* a Run step in the build graph, to be executed when another + // step is evaluated that depends on it. The next line below will establish + // such a dependency. + const run_cmd = b.addRunArtifact(exe); + + // By making the run step depend on the install step, it will be run from the + // installation directory rather than directly from within the cache directory. + // This is not necessary, however, if the application depends on other installed + // files, this ensures they will be present and in the expected location. + run_cmd.step.dependOn(b.getInstallStep()); + + // This allows the user to pass arguments to the application in the build + // command itself, like this: `zig build run -- arg1 arg2 etc` + if (b.args) |args| { + run_cmd.addArgs(args); + } + + // This creates a build step. It will be visible in the `zig build --help` menu, + // and can be selected like this: `zig build run` + // This will evaluate the `run` step rather than the default, which is "install". + const run_step = b.step("run", "Run the app"); + run_step.dependOn(&run_cmd.step); + + // Creates a step for unit testing. This only builds the test executable + // but does not run it. + const lib_unit_tests = b.addTest(.{ + .root_source_file = b.path("src/root.zig"), + .target = target, + .optimize = optimize, + }); + + const run_lib_unit_tests = b.addRunArtifact(lib_unit_tests); + + const exe_unit_tests = b.addTest(.{ + .root_source_file = b.path("src/main.zig"), + .target = target, + .optimize = optimize, + }); + + const run_exe_unit_tests = b.addRunArtifact(exe_unit_tests); + + // 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); + test_step.dependOn(&run_exe_unit_tests.step); +} diff --git a/examples/icsneo/zig/simple/build.zig.zon b/examples/icsneo/zig/simple/build.zig.zon new file mode 100644 index 0000000..4640a95 --- /dev/null +++ b/examples/icsneo/zig/simple/build.zig.zon @@ -0,0 +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 = "simple", + + // This is a [Semantic Version](https://semver.org/). + // In a future version of Zig it will be used for package deduplication. + .version = "0.0.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", + "src", + // For example... + //"LICENSE", + //"README.md", + }, +} diff --git a/examples/icsneo/zig/simple/src/main.zig b/examples/icsneo/zig/simple/src/main.zig new file mode 100644 index 0000000..9631edd --- /dev/null +++ b/examples/icsneo/zig/simple/src/main.zig @@ -0,0 +1,34 @@ +const std = @import("std"); +const print = @import("std").debug.print; + +const ics = @cImport({ + @cInclude("icsneo/icsneo.h"); +}); + +pub fn find_all() !void { + // Find devices connected to host. + const MAX_DEVICE_COUNT: u32 = 255; + var device_buffer: [MAX_DEVICE_COUNT]?*ics.icsneo_device_t = undefined; + var devices_count: u32 = MAX_DEVICE_COUNT; + var res: ics.icsneo_error_t = ics.icsneo_device_find_all(&device_buffer, &devices_count, null); + if (res != ics.icsneo_error_success) { + print("Failed to find device(s) with error: {}\n", .{res}); + } + // Lets just take a slice of the entire device buffer + const devices = device_buffer[0..devices_count]; + print("Found {} devices!\n", .{devices.len}); + // Lets display all the devices we found. + for (devices, 1..) |device, i| { + var description: [128]u8 = [_:0]u8{'a'} ** 128; + var description_length: u32 = 128; + res = ics.icsneo_device_get_description(device, &description, &description_length); + if (res != ics.icsneo_error_success) { + print("Failed to find devices with error: {}\n", .{res}); + } + print("\t{}. {s}\n", .{ i, description }); + } +} + +pub fn main() !void { + try find_all(); +} diff --git a/examples/icsneo/zig/simple/src/root.zig b/examples/icsneo/zig/simple/src/root.zig new file mode 100644 index 0000000..f034ca3 --- /dev/null +++ b/examples/icsneo/zig/simple/src/root.zig @@ -0,0 +1,13 @@ +//! By convention, root.zig is the root source file when making a library. If +//! you are making an executable, the convention is to delete this file and +//! start with main.zig instead. +const std = @import("std"); +const testing = std.testing; + +export fn add(a: i32, b: i32) i32 { + return a + b; +} + +test "basic add functionality" { + try testing.expect(add(3, 7) == 10); +}