defmodule Ergo do
  alias Ergo.Context

  @moduledoc ~S"""
  `Ergo` contains the helper function `parse/2` otherwise see `Ergo.Terminals`, `Ergo.Combinators` and `Ergo.Parsers` for the individual parsers.
  """

  @doc ~S"""
  The `parser/2` function is a simple entry point to parsing inputs that constructs the Context record required.

  # Examples

      iex> alias Ergo.Terminals
      iex> parser = Terminals.literal("Hello")
      iex> Ergo.parse(parser, "Hello World")
      %Ergo.Context{status: :ok, ast: "Hello", char: ?o, input: " World", index: 5, line: 1, col: 6}
  """
  def parse(parser, input) when is_function(parser) and is_binary(input) do
    parser.(Context.new(input))
  end

end