View Source Finitomata.Parser behaviour (Finitomata v0.20.1)

The behaviour, defining the parser to produce FSM out of textual representation.

Summary

parse_error()

The type representing the parsing error which might be passed through to raised CompileError.

lint(binary)

Linter of the input, producing a well-formed representation of FSM understood by JS/markdown parsers.

parse(binary)

Parse function, producing the FSM definition as a list of Transition instances.

validate(list)

Validation of the input.

@type parse_error() ::
  {:error, String.t(), binary(), map(), {pos_integer(), pos_integer()},
   pos_integer()}

The type representing the parsing error which might be passed through to raised CompileError.

@callback lint(binary()) :: binary()

Linter of the input, producing a well-formed representation of FSM understood by JS/markdown parsers.

@callback parse(binary()) ::
  {:ok, [Finitomata.Transition.t()]}
  | {:error, Finitomata.validation_error()}
  | parse_error()

Parse function, producing the FSM definition as a list of Transition instances.

@callback validate([{:transition, [binary()]}]) ::
  {:ok, [Finitomata.Transition.t()]} | {:error, Finitomata.validation_error()}

Validation of the input.