atml_pdf

defmodule AtmlPdf do
  @moduledoc """
  Public API for rendering ATML templates to PDF.

  ATML is an XML-based format for authoring printable label templates.
  This module provides two entry points:

  - `render/3` — parse, layout, and write a PDF file to disk.
  - `render_binary/2` — parse, layout, and return the PDF as a binary.

  Both functions run the same three-stage pipeline:

      ATML XML string
        → AtmlPdf.Parser    (XML → element structs)
        → AtmlPdf.Layout    (resolve dimensions & font inheritance)
        → AtmlPdf.Renderer  (element tree → PDF via configured backend)

  ## Configuration

  Configure the PDF backend in your application config:

      config :atml_pdf,
        pdf_backend: AtmlPdf.PdfBackend.PdfAdapter  # Default

  Or specify per-render call:

      AtmlPdf.render(xml, path, backend: AtmlPdf.PdfBackend.ExGutenAdapter)

  ## Examples

      iex> xml = ~s|<document page-width="100pt" page-height="100pt"></document>|
      iex> {:ok, binary} = AtmlPdf.render_binary(xml)
      iex> is_binary(binary) and byte_size(binary) > 0
      true

  """

  alias AtmlPdf.Layout
  alias AtmlPdf.Parser
  alias AtmlPdf.Renderer

  @doc """
  Parses `template`, resolves its layout, and writes the resulting PDF to
  `path`.

  Returns `:ok` on success or `{:error, reason}` on failure.

  ## Parameters

  - `template` — ATML XML string.
  - `path` — Destination file path (will be created or overwritten).
  - `opts` — Options including `:backend` to override default PDF backend.

  ## Examples

      iex> xml = ~s|<document page-width="100pt" page-height="100pt"></document>|
      iex> path = Path.join(System.tmp_dir!(), "atml_test_render.pdf")
      iex> AtmlPdf.render(xml, path)
      :ok
      iex> File.exists?(path)
      true

  """
  @spec render(String.t(), Path.t(), keyword()) :: :ok | {:error, String.t()}
  def render(template, path, opts \\ []) do
    with {:ok, tree} <- Parser.parse(template),
         {:ok, resolved} <- Layout.resolve(tree),
         {:ok, ctx} <- Renderer.render(resolved, opts) do
      backend = ctx.backend_module
      backend.write_to(ctx.backend_state, path)
      backend.cleanup(ctx.backend_state)
      :ok
    end
  end

  @doc """
  Parses `template`, resolves its layout, and returns the PDF as a binary.

  Returns `{:ok, binary}` on success or `{:error, reason}` on failure.

  ## Parameters

  - `template` — ATML XML string.
  - `opts` — Options including `:backend` to override default PDF backend.

  ## Examples

      iex> xml = ~s|<document page-width="100pt" page-height="100pt"></document>|
      iex> {:ok, binary} = AtmlPdf.render_binary(xml)
      iex> is_binary(binary) and byte_size(binary) > 0
      true

  """
  @spec render_binary(String.t(), keyword()) :: {:ok, binary()} | {:error, String.t()}
  def render_binary(template, opts \\ []) do
    with {:ok, tree} <- Parser.parse(template),
         {:ok, resolved} <- Layout.resolve(tree),
         {:ok, ctx} <- Renderer.render(resolved, opts) do
      backend = ctx.backend_module
      binary = backend.export(ctx.backend_state)
      backend.cleanup(ctx.backend_state)
      {:ok, binary}
    end
  end
end