Unifex v1.0.1

View Source Unifex.Specs (Unifex v1.0.1)

Module that handles parsing Unifex specs for native boilerplate code generation.

For information on how to create such specs, see Unifex.Specs.DSL module.

Link to this section Summary

Types

enum_t()
interface_t()

Name of interface generated for the native library. Must be a suffix of code generator module in Unifex.CodeGenerators namespace.

native_name_t()
struct_t()
t()

Functions

parse(specs_file, name)

Parses Unifex specs of native functions.

Link to this section Types

Link to this type

enum_t()

View Source 
@type enum_t() :: {enum_name :: atom(), [enum_field :: atom()]}
Link to this type

interface_t()

View Source 
@type interface_t() :: atom()

Name of interface generated for the native library. Must be a suffix of code generator module in Unifex.CodeGenerators namespace.

Unifex has built-in generators for NIF and CNode interfaces.

Link to this type

native_name_t()

View Source 
@type native_name_t() :: atom()
Link to this type

struct_t()

View Source 
@type struct_t() ::
  {struct_alias :: atom(), struct_module_name :: atom(),
   [{field_name :: atom(), field_type :: {atom() | {:list, atom()}}}]}
Link to this type

t()

View Source 
@type t() :: %Unifex.Specs{
  callbacks: %{
    required(hook :: :load | :upgrade | :unload | :main_function) =>
      function_name :: String.t()
  },
  dirty_functions: %{
    required({function_name :: atom(), function_arity :: non_neg_integer()}) =>
      :cpu | :io
  },
  enums: [],
  functions_args: [
    {function_name :: atom(), [arg_type :: {atom() | {:list, atom()}}]}
  ],
  functions_results: [{function_name :: atom(), return_type :: Macro.t()}],
  interface: [interface_t()] | interface_t() | nil,
  module: Unifex.CodeGenerator.t() | nil,
  name: native_name_t(),
  sends: [{send_name :: atom(), send_term_type :: Macro.t()}],
  state_type: String.t() | nil,
  structs: [struct_t()]
}

Link to this section Functions

Link to this function

parse(specs_file, name)

View Source 
@spec parse(specs_file :: String.t(), native_name_t()) :: t()

Parses Unifex specs of native functions.