Unifex v1.0.0

View Source Unifex.CodeGenerator behaviour (Unifex v1.0.0)

Behaviour for code generation.

Link to this section Summary

Types

code_t()
generated_code_t()
t()

Callbacks

generate_header(specs)
generate_source(specs)
identification_constant()
interface_io_name()

Functions

bundlex_interface(atom)
generate_code(specs)

Generates boilerplate code using generator implementation from Unifex.CodeGenerators.

interface_generator(interface)

Link to this section Types

Link to this type

code_t()

View Source 
@type code_t() :: String.t()
Link to this type

generated_code_t()

View Source 
@type generated_code_t() :: {header :: code_t(), source :: code_t(), generator :: t()}
Link to this type

t()

View Source 
@type t() :: module()

Link to this section Callbacks

Link to this callback

generate_header(specs)

View Source 
@callback generate_header(specs :: Unifex.Specs.t()) :: code_t()
Link to this callback

generate_source(specs)

View Source 
@callback generate_source(specs :: Unifex.Specs.t()) :: code_t()
Link to this callback

identification_constant()

View Source 
@callback identification_constant() :: String.t()
Link to this callback

interface_io_name()

View Source 
@callback interface_io_name() :: String.t()

Link to this section Functions

Link to this function

bundlex_interface(atom)

View Source 
@spec bundlex_interface(Bundlex.Native.interface_t()) :: Unifex.Specs.interface_t()
Link to this function

generate_code(specs)

View Source 
@spec generate_code(Unifex.Specs.t()) :: [generated_code_t()]

Generates boilerplate code using generator implementation from Unifex.CodeGenerators.

Link to this function

interface_generator(interface)

View Source 
@spec interface_generator(Unifex.Specs.interface_t()) :: t()