Md.Listener behaviour (md v0.10.7)

The listener behaviour to attach to the parser to receive callbacks when the elements are encountered and processed.

Summary

Types

attributes()

branch()

callback()

context()

element()

leaf()

parse_mode()

state()

trace()

Callbacks

element(context, state)

Types

attributes()

@type attributes() :: XmlBuilder.Element.attrs()

branch()

@type branch() :: XmlBuilder.Element.content()

callback()

@type callback() :: (state() -> state())

context()

@type context() ::
  :start
  | :break
  | :linefeed
  | :whitespace
  | :custom
  | {:substitute, {binary(), binary()}}
  | {:esc, binary()}
  | {:char, binary()}
  | {:tag, {binary(), element()}, atom()}
  | :finalize
  | :end

element()

@type element() :: XmlBuilder.Element.name()

leaf()

@type leaf() :: XmlBuilder.Element.content()

parse_mode()

@type parse_mode() ::
  :idle
  | :finished
  | :raw
  | :skip
  | :comment
  | :magnet
  | :md
  | {:linefeed, non_neg_integer()}
  | {:nested, element(), non_neg_integer()}
  | {:inner, :raw}
  | {:inner, element(), non_neg_integer()}

state()

@type state() :: %Md.Parser.State{
  path: [trace()],
  mode: [parse_mode()],
  type: module(),
  ast: [branch()],
  listener: nil | module(),
  payload: any(),
  bag: %{indent: [non_neg_integer()], stock: [branch()], deferred: [binary()]}
}

trace()

@type trace() :: branch()

Callbacks

element(context, state)

@callback element(context(), state()) :: :ok | {:update, state()}