![Darkman Trilogy [Blu-ray]](https://techcratic.com/wp-content/uploads/2024/11/81O0DPjiK9L._SL1500_-360x180.jpg)
2024-10-24 13:53:00
github.com
Library test status:
Run mix zig.get
Zigler is available in Hex, and the package can be installed
by adding zigler to your list of dependencies in mix.exs:
def deps do
[
{:zigler, "~> 0.13.2", runtime: false}
]
end
TBD.
~/.cache/zigler/zig-linux-
Erlang is only supported via rebar3. You must enable the rebar_mix plugin and
add zigler to your deps in rebar3.
Note that erlang support is highly experimental. Please submit issues if you
have difficulty.
{plugins, [rebar_mix]}.
{deps, [{zigler, "0.13"}]}.
Docs can be found at https://hexdocs.pm/zigler.
-
Linux
-
FreeBSD (tested, but not subjected to CI)
-
MacOS
-
Nerves cross-compilation is supported out of the box.
Wouldn’t it be nice if you could make NIFs as easily as you can use the asm
keyword in C?
This is now possible, using the magic of Zig.
defmodule ExampleZig do
use Zig, otp_app: :zigler
~Z"""
pub fn example_fun(value1: f64, value2: f64) bool {
return value1 > value2;
}
"""
end
test "example nifs" do
assert ExampleZig.example_fun(0.8, -0.8)
refute ExampleZig.example_fun(0.1, 0.4)
end
Zigler will do automatic type marshalling between Elixir code and Zig code.
It will also convert trickier types into types you care about, for example:
defmodule ZigCollections do
use Zig, otp_app: :zigler
~Z"""
pub fn string_count(string: []u8) i64 {
return @intCast(string.len);
}
pub fn list_sum(array: []f64) f64 {
var sum: f64 = 0.0;
for(array) | item | {
sum += item;
}
return sum;
}
"""
end
test "type marshalling" do
assert 9 == ZigCollections.string_count("hello zig")
assert 6.0 == ZigCollections.list_sum([1.0, 2.0, 3.0])
end
Memory allocation with zigler is easy! A standard BEAM allocator is provided for you,
so any zig code you import will play nice with the BEAM.
defmodule Allocations do
use Zig, otp_app: :zigler
~Z"""
const beam = @import("beam");
pub fn double_atom(string: []u8) !beam.term {
var double_string = try beam.allocator.alloc(u8, string.len * 2);
defer beam.allocator.free(double_string);
for (string, 0..) | char, i | {
double_string[i] = char;
double_string[i + string.len] = char;
}
return beam.make_into_atom(double_string, .{});
}
"""
end
test "allocations" do
assert :foofoo == Allocations.double_atom("foo")
end
It is a goal for Zigler to make using it to bind C libraries easier
than using C to bind C libraries. Here is an example:
if {:unix, :linux} == :os.type() do
defmodule Blas do
use Zig,
otp_app: :zigler,
c: [link_lib: {:system, "blas"}]
~Z"""
const beam = @import("beam");
const blas = @cImport({
@cInclude("cblas.h");
});
const BadArgs = error { badarg };
pub fn blas_axpy(a: f64, x: []f64, y: []f64) ![]f64 {
if (x.len != y.len) return error.badarg;
blas.cblas_daxpy(@intCast(x.len), a, x.ptr, 1, y.ptr, 1);
return y;
}
"""
end
test "we can use a blas shared library" do
# returns aX+Y
assert [11.0, 18.0] == Blas.blas_axpy(3.0, [2.0, 4.0], [5.0, 6.0])
end
end
You can document nif functions, local functions, zig structs, variables, and types.
If you document a nif function, it will be a part of the module documentation, and
accessible using the iex h method, etc.
Example:
defmodule Documentation do
use Zig, otp_app: :zigler
~Z"""
/// a zero-arity function which returns 47.
pub fn zero_arity() i64 {
return 47;
}
"""
end
Zigler ships with a formatter. To activate the formatter, adapt the following to your
.formatter.exs:
[
inputs: ~w[
{mix,.formatter,.credo}.exs
{config,lib,rel,test}/**/*.{ex,exs,zig}
installer/**/*.{ex,exs}
],
plugins: [Zig.Formatter]
]
Use of Zigler with erlang is possible using parse transforms. You must obtain
zigler using the rebar3 and the rebar_mix plugin. Modules with zigler
nifs should inculde code into one or more zig_code attribute and pass
zigler options (identical to the elixir options) into a zig_opts attribute.
Zigler will then create appropriate functions matching the zig functions as
it does with elixir. Please not that some features (such as integers > 64
bits) are not currently supported in erlang, although nearly full feature parity
is planned.
-module(erlang_zigler_module).
-compile({parse_transform, zigler}).
-export([foo/1, foo/0]).
-zig_code("
pub fn foo() i32 {
return 47;
}
").
-zig_opts([{otp_app, zigler}]).
foo(X) ->
47 + X.
- Make being a good citizen of the BEAM easy.
- Use magic, but sparingly, only to prevent errors.
- Let the user see behind the curtain.
- Let the user opt out of magic.
- Magic shouldn’t get in the way.
Support Techcratic
If you find value in Techcratic’s insights and articles, consider supporting us with Bitcoin. Your support helps me, as a solo operator, continue delivering high-quality content while managing all the technical aspects, from server maintenance to blog writing, future updates, and improvements. Support Innovation! Thank you.
Bitcoin Address:
bc1qlszw7elx2qahjwvaryh0tkgg8y68enw30gpvge
Please verify this address before sending funds.
Bitcoin QR Code
Simply scan the QR code below to support Techcratic.
Please read the Privacy and Security Disclaimer on how Techcratic handles your support.
Disclaimer: As an Amazon Associate, Techcratic may earn from qualifying purchases.
