View Source HypeLib.DSL.Parser behaviour (HypeLib v2.4.1)

changelog

Changelog

2-3-1

2.3.1

Fixed credo errors

Link to this section Summary

Types

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

t()

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

Link to this section Types

@type ast_element() :: term()

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

Full definition:

ast_element() :: term()
@type parse_result() :: {ast_element(), state()}

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

Full definition:

parse_result() :: {ast_element(), state()}
@type state() :: term()

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

Full definition:

state() :: term()
@type t() :: module()

(This type is managed by TypeCheck, which allows checking values against the type at runtime.)

Full definition:

t() :: module()

Link to this section Callbacks

Link to this callback

on_finish(element, parser_state)

View Source (optional)
@callback on_finish(element :: ast_element(), parser_state :: state()) :: parse_result()
@callback on_init() :: state()
Link to this callback

on_node(element, parser_state)

View Source
@callback on_node(element :: ast_element(), parser_state :: state()) :: parse_result()

Link to this section Functions

Link to this function

check_parser_module(module_to_check)

View Source
@spec check_parser_module(module_to_check :: term()) :: nil | none()
Link to this function

get_initial_state(parser_module)

View Source

Returns the initial state of the parser

Link to this function

is_parser(module_to_check)

View Source
@spec is_parser(module_to_check :: term()) :: boolean()
Link to this function

unhandled_element(element, parser_state)

View Source