Packages

ergo

0.9.9
1.0.7 1.0.6 1.0.5 1.0.4 1.0.3 1.0.1 1.0.0 0.9.9 0.9.8 0.9.7 0.9.4 0.9.3 0.8.0 0.7.0 0.6.2 0.6.1 0.6.0 0.5.7 0.4.6 0.4.5 0.4.4 0.4.2 0.4.1 0.3.5 0.3.1 0.3.0 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0

A pragmatic parser combinator library

HexDocs

Current section

Files

Jump to
Readme
31 Versions
2 Dependencies
Dependants
Files
Activity
ergo lib ergo.ex
Raw

lib/ergo.ex 

defmodule Ergo do

  @moduledoc "README.md"

             |> File.read!()

             |> String.split("<!-- MDOC !-->")

             |> Enum.fetch!(1)



  alias Ergo.{Context, Parser}



  use Application



  @doc ~S"""

  `start/2` should be called before



  """

  def start(_type, _args) do

    Supervisor.start_link([Ergo.ParserRefs], strategy: :one_for_one)

  end



  @doc ~S"""

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



  Options

    debug: [true | false]



  # Examples



      iex> alias Ergo.Terminals

      iex> parser = Terminals.literal("Hello")

      iex> assert %Ergo.Context{status: :ok, ast: "Hello", input: " World", index: 5, line: 1, col: 6} = Ergo.parse(parser, "Hello World")

  """

  def parse(%Parser{} = parser, input, opts \\ []) when is_binary(input) do

    input

    |> Context.new(opts)

    |> Parser.invoke(parser)

  end

end