Allow using Unifex enums and structs in NIF/Cnode state (#120)

* Allow using enums and structs in NIF/Cnode state

* Update test fixtures

* Add missing test fixtures

* Fix dialyzer

* Set version to 1.2.3

* Remove leftover

* Add types tie header

* Add special tie header for generated files

* Drop separate types tie header

Collapse the two tie headers introduced in c2a9153 / 4bcbdc7 back into a
single `_generated/<name>.h` that includes both `<interface>/<name>.h`
and `<interface>/<name>_types.h`. Document the typedef-include-struct
pattern users follow to put custom types in their state.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

* Refactor typo

* Update lib/unifex/code_generators/nif.ex

* Fix pragma typo

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com>
Co-authored-by: Jakub Pryc <94321002+Noarkhh@users.noreply.github.com>

Author: 3 people

lib/tasks/compile_unifex.ex

@@ -18,9 +18,12 @@ defmodule Mix.Tasks.Compile.Unifex do
     |> Enum.each(fn {name, dir, specs_file} ->
       codes = specs_file |> Specs.parse(name) |> CodeGenerator.generate_code()
       Enum.each(codes, &InterfaceIO.store_interface!(name, dir, &1))
-      generators = Enum.map(codes, fn {_header, _source, generator} -> generator end)
+
+      generators = codes |> Enum.map(& &1.generator)
+
       tie_header = Unifex.CodeGenerator.TieHeader.generate_header(name, generators)
       InterfaceIO.store_tie_header!(name, dir, tie_header)
+
       InterfaceIO.store_gitignore!(dir)
     end)
   end

lib/unifex/code_generator.ex

@@ -7,11 +7,12 @@ defmodule Unifex.CodeGenerator do
 
   @type t :: module
   @type code_t :: String.t()
-  @type generated_code_t :: {header :: code_t, source :: code_t, generator :: t}
+  @type generated_code_t :: %{header: code_t, types_header: code_t, source: code_t, generator: t}
 
   @callback identification_constant() :: String.t()
   @callback interface_io_name() :: String.t()
-  @callback generate_header(specs :: Specs.t()) :: code_t
+  @callback generate_main_header(specs :: Specs.t()) :: code_t
+  @callback generate_types_header(specs :: Specs.t()) :: code_t
   @callback generate_source(specs :: Specs.t()) :: code_t
 
   @doc """
@@ -20,9 +21,16 @@ defmodule Unifex.CodeGenerator do
   @spec generate_code(Specs.t()) :: [generated_code_t()]
   def generate_code(specs) do
     for generator <- get_generators(specs) do
-      header = generator.generate_header(specs)
+      header = generator.generate_main_header(specs)
+      types_header = generator.generate_types_header(specs)
       source = generator.generate_source(specs)
-      {header, source, generator}
+
+      %{
+        header: header,
+        types_header: types_header,
+        source: source,
+        generator: generator
+      }
     end
   end
 

lib/unifex/code_generator/tie_header.ex

@@ -11,7 +11,6 @@ defmodule Unifex.CodeGenerator.TieHeader do
   def generate_header(name, generators) do
     ~g"""
     #pragma once
-
     #{generate_includes(name, generators)}
     """
   end
@@ -21,8 +20,11 @@ defmodule Unifex.CodeGenerator.TieHeader do
   end
 
   defp generate_include(name, generator) do
+    types_header_filename = Unifex.InterfaceIO.types_header_filename(name)
+
     ~g"""
     #ifdef #{generator.identification_constant()}
+    #include "#{generator.interface_io_name()}/#{types_header_filename}"
     #include "#{generator.interface_io_name()}/#{name}.h"
     #endif
     """

lib/unifex/code_generators/cnode.ex

@@ -17,28 +17,12 @@ defmodule Unifex.CodeGenerators.CNode do
   def interface_io_name(), do: "cnode"
 
   @impl CodeGenerator
-  def generate_header(specs) do
+  def generate_main_header(specs) do
     ctx = Common.create_ctx(specs)
 
     ~g"""
-    #pragma once
-
-    #include <stdio.h>
-    #include <stdint.h>
-    #include <string.h>
-    #include <stdlib.h>
-
-    // required for ei.h to work
-    #ifndef _REENTRANT
-    #define _REENTRANT
-    #endif
-
-    #include <ei.h>
-    #include <ei_connect.h>
-
-    #include <unifex/unifex.h>
-    #include <unifex/cnode.h>
-    #include <unifex/payload.h>
+    #{pragma_and_includes()}
+    #include "#{InterfaceIO.types_header_filename(specs.name)}"
     #include "#{InterfaceIO.user_header_path(specs.name)}"
 
     #ifdef __cplusplus
@@ -47,13 +31,6 @@ defmodule Unifex.CodeGenerators.CNode do
 
     #{generate_state_related_declarations(specs)}
 
-    #{Utils.generate_enums_definitions(specs.enums,
-    &Common.generate_enum_native_definition/2,
-    ctx)}
-
-    #{Utils.generate_structs_definitions(specs.structs,
-    &generate_struct_native_definition/2,
-    ctx)}
 
     #{Utils.generate_functions_declarations(specs.functions_args,
     &generate_implemented_function_declaration/2,
@@ -75,12 +52,35 @@ defmodule Unifex.CodeGenerators.CNode do
     """
   end
 
+  @impl CodeGenerator
+  def generate_types_header(specs) do
+    ~g"""
+    #pragma once
+
+    #ifdef __cplusplus
+    extern "C" {
+    #endif
+
+    #{Utils.generate_enums_definitions(specs.enums,
+    &Common.generate_enum_native_definition/2,
+    %{})}
+
+    #{Utils.generate_structs_definitions(specs.structs,
+    &generate_struct_native_definition/2,
+    %{})}
+
+    #ifdef __cplusplus
+    }
+    #endif
+    """
+  end
+
   @impl CodeGenerator
   def generate_source(specs) do
     ctx = Common.create_ctx(specs)
 
     ~g"""
-    #include <stdio.h>
+    #{pragma_and_includes()}
     #include "#{specs.name}.h"
 
     #{generate_state_related_functions(specs)}
@@ -95,6 +95,29 @@ defmodule Unifex.CodeGenerators.CNode do
     """
   end
 
+  defp pragma_and_includes() do
+    ~g"""
+    #pragma once
+
+    #include <stdio.h>
+    #include <stdint.h>
+    #include <string.h>
+    #include <stdlib.h>
+
+    // required for ei.h to work
+    #ifndef _REENTRANT
+    #define _REENTRANT
+    #endif
+
+    #include <ei.h>
+    #include <ei_connect.h>
+
+    #include <unifex/unifex.h>
+    #include <unifex/cnode.h>
+    #include <unifex/payload.h>
+    """
+  end
+
   defp generate_main_function_declaration(callbacks) do
     main = Map.get(callbacks, :main, "unifex_cnode_main_function")
     ~g<int #{main}(int argc, char** argv);>

lib/unifex/code_generators/nif.ex

@@ -17,17 +17,12 @@ defmodule Unifex.CodeGenerators.NIF do
   def interface_io_name(), do: "nif"
 
   @impl CodeGenerator
-  def generate_header(specs) do
+  def generate_main_header(specs) do
     ctx = Common.create_ctx(specs)
 
     ~g"""
-    #pragma once
-
-    #include <stdio.h>
-    #include <stdint.h>
-    #include <erl_nif.h>
-    #include <unifex/unifex.h>
-    #include <unifex/payload.h>
+    #{pragma_and_includes()}
+    #include "#{InterfaceIO.types_header_filename(specs.name)}"
     #include "#{InterfaceIO.user_header_path(specs.name)}"
 
     #ifdef __cplusplus
@@ -42,14 +37,6 @@ defmodule Unifex.CodeGenerators.NIF do
 
     #{generate_state_related_declarations(specs)}
 
-    #{Utils.generate_enums_definitions(specs.enums,
-    &Common.generate_enum_native_definition/2,
-    ctx)}
-
-    #{Utils.generate_structs_definitions(specs.structs,
-    &generate_struct_native_definition/2,
-    ctx)}
-
     /*
      * Declaration of native functions for module #{specs.module}.
      * The implementation have to be provided by the user.
@@ -96,6 +83,43 @@ defmodule Unifex.CodeGenerators.NIF do
     """
   end
 
+  @impl CodeGenerator
+  def generate_types_header(specs) do
+    ctx = Common.create_ctx(specs)
+
+    ~g"""
+    #{pragma_and_includes()}
+
+    #ifdef __cplusplus
+    extern "C" {
+    #endif
+
+    #{Utils.generate_enums_definitions(specs.enums,
+    &Common.generate_enum_native_definition/2,
+    ctx)}
+
+    #{Utils.generate_structs_definitions(specs.structs,
+    &generate_struct_native_definition/2,
+    ctx)}
+
+    #ifdef __cplusplus
+    }
+    #endif
+    """
+  end
+
+  defp pragma_and_includes() do
+    ~g"""
+    #pragma once
+
+    #include <stdio.h>
+    #include <stdint.h>
+    #include <erl_nif.h>
+    #include <unifex/unifex.h>
+    #include <unifex/payload.h>
+    """
+  end
+
   @impl CodeGenerator
   def generate_source(specs) do
     ctx = Common.create_ctx(specs)

lib/unifex/interface_IO.ex

@@ -5,6 +5,7 @@ defmodule Unifex.InterfaceIO do
 
   @spec_name_sufix ".spec.exs"
   @generated_dir_name "_generated"
+  @types_header_suffix "_types"
 
   @spec user_header_path(Specs.native_name_t()) :: String.t()
   def user_header_path(name) do
@@ -34,7 +35,7 @@ defmodule Unifex.InterfaceIO do
           extension :: String.t()
         ) :: String.t()
   def out_path(name, dir, generator, extension \\ "") do
-    Path.join(out_dir(dir, generator), "#{name}#{extension}")
+    out_dir(dir, generator) |> Path.join("#{name}#{extension}")
   end
 
   @spec out_dir(base_dir :: String.t(), CodeGenerator.t()) :: String.t()
@@ -47,26 +48,24 @@ defmodule Unifex.InterfaceIO do
           dir :: String.t(),
           code :: CodeGenerator.generated_code_t()
         ) :: :ok
-  def store_interface!(name, dir, {header, source, generator}) do
+  def store_interface!(name, dir, generated_code) do
+    %{header: header, types_header: types_header, source: source, generator: generator} =
+      generated_code
+
     File.mkdir_p!(out_dir(dir, generator))
     out_base_path = out_path(name, dir, generator)
     File.write!("#{out_base_path}.h", header)
+    File.write!("#{out_base_path}#{@types_header_suffix}.h", types_header)
     File.write!("#{out_base_path}.c", source)
     File.write!("#{out_base_path}.cpp", source)
 
-    # Format generated code only when clang-format is available
-    if Unifex.Utils.clang_format_installed?() do
-      System.cmd(
-        "clang-format",
-        [
-          "-style={BasedOnStyle: llvm, IndentWidth: 2}",
-          "-i",
-          "#{out_base_path}.h",
-          "#{out_base_path}.c",
-          "#{out_base_path}.cpp"
-        ]
-      )
-    end
+    :ok =
+      run_clang_format_if_installed([
+        "#{out_base_path}.h",
+        "#{out_base_path}#{@types_header_suffix}.h",
+        "#{out_base_path}.c",
+        "#{out_base_path}.cpp"
+      ])
 
     :ok
   end
@@ -77,10 +76,29 @@ defmodule Unifex.InterfaceIO do
     out_dir_name = Path.join(dir, @generated_dir_name)
     File.mkdir_p!(out_dir_name)
     out_base_path = Path.join(out_dir_name, "#{name}.h")
-    File.write!(out_base_path, code)
+    :ok = File.write!(out_base_path, code)
+    :ok = run_clang_format_if_installed(out_base_path)
+
+    :ok
+  end
+
+  defp run_clang_format_if_installed(files) when is_list(files) do
+    if Unifex.Utils.clang_format_installed?() do
+      System.cmd(
+        "clang-format",
+        [
+          "-style={BasedOnStyle: llvm, IndentWidth: 2}",
+          "-i"
+        ] ++ files
+      )
+    end
+
     :ok
   end
 
+  defp run_clang_format_if_installed(file) when is_binary(file),
+    do: run_clang_format_if_installed([file])
+
   @spec store_gitignore!(String.t()) :: :ok
   def store_gitignore!(dir) do
     out_dir_name = Path.join(dir, @generated_dir_name)
@@ -94,4 +112,9 @@ defmodule Unifex.InterfaceIO do
 
     :ok
   end
+
+  @spec types_header_filename(Specs.native_name_t()) :: String.t()
+  def types_header_filename(name) do
+    "#{name}#{@types_header_suffix}.h"
+  end
 end

mix.exs

@@ -1,7 +1,7 @@
 defmodule Unifex.MixProject do
   use Mix.Project
 
-  @version "1.2.2"
+  @version "1.2.3"
   @github_url "https://github.com/membraneframework/unifex"
 
   def project do