View Source Unifex.CodeGenerator.Utils (Unifex v1.2.0)

Utilities for code generation.

Summary

Functions

generate_enums_definitions(config, generator, ctx)

generate_functions(config, generator, ctx)

generate_functions_declarations(config, generator, ctx)

generate_maybe_unused_args_statements(args)

generate_serialization(atom, serializers)

Traverses Elixir specification AST and creates C data types serialization with serializers.

generate_structs_definitions(config, generator, ctx)

sanitize_var_name(var_name)

Replaces special characters such as: ., -> and array brackets e.g. var_name[i] with underscores.

sigil_g(content, flags)

Sigil used for templating generated code.

Functions

generate_enums_definitions(config, generator, ctx)

@spec generate_enums_definitions(
  config :: Enumerable.t(),
  generator :: (term(), map() -> Unifex.CodeGenerator.code_t()),
  ctx :: map()
) :: Unifex.CodeGenerator.code_t()

generate_functions(config, generator, ctx)

@spec generate_functions(
  config :: Enumerable.t(),
  generator :: (term(), map() -> Unifex.CodeGenerator.code_t()),
  ctx :: map()
) :: Unifex.CodeGenerator.code_t()

generate_functions_declarations(config, generator, ctx)

@spec generate_functions_declarations(
  config :: Enumerable.t(),
  generator :: (term(), map() -> Unifex.CodeGenerator.code_t()),
  ctx :: map()
) :: Unifex.CodeGenerator.code_t()

generate_maybe_unused_args_statements(args)

@spec generate_maybe_unused_args_statements(args :: [String.t()]) :: [String.t()]

generate_serialization(atom, serializers)

@spec generate_serialization(
  ast :: Macro.t(),
  serializers :: %{
    arg_serializer:
      (type :: Unifex.CodeGenerator.BaseType.t(), name :: atom() -> output),
    tuple_serializer: ([output] -> output)
  }
) ::
  {output,
   label: atom(),
   arg: {name :: atom(), type :: Unifex.CodeGenerator.BaseType.t()}}
when output: term()

Traverses Elixir specification AST and creates C data types serialization with serializers.

generate_structs_definitions(config, generator, ctx)

@spec generate_structs_definitions(
  config :: Enumerable.t(),
  generator :: (term(), map() -> Unifex.CodeGenerator.code_t()),
  ctx :: map()
) :: Unifex.CodeGenerator.code_t()

sanitize_var_name(var_name)

@spec sanitize_var_name(String.t()) :: String.t()

Replaces special characters such as: ., -> and array brackets e.g. var_name[i] with underscores.

In case of arrays var_name[i] results in var_name_i.

sigil_g(content, flags)

@spec sigil_g(String.t(), []) :: String.t()

Sigil used for templating generated code.