defmodule Sourceror do
  @external_resource "README.md"
  @moduledoc @external_resource
             |> File.read!()
             |> String.split("<!-- MDOC !-->")
             |> Enum.fetch!(1)

  alias Sourceror.TraversalState

  @line_fields ~w[closing do end end_of_expression]a
  # @start_fields ~w[line do]a
  @end_fields ~w[end closing end_of_expression]a

  @re_newline ~r/\n|\r|\r\n/

  @type comment :: %{
          line: integer,
          previous_eol_count: integer,
          next_eol_count: integer,
          text: String.t()
        }

  @type position :: keyword

  @type traversal_function :: (Macro.t(), TraversalState.t() -> {Macro.t(), TraversalState.t()})

  @code_module (if Version.match?(System.version(), "~> 1.13") do
                  Code
                else
                  Sourceror.Code
                end)

  @doc """
  A wrapper around `Code.string_to_quoted_with_comments!/2` for compatibility
  with pre 1.13 Elixir versions.
  """
  defmacro string_to_quoted!(string, opts) do
    map_literal_fix? = Version.match?(System.version(), "< 1.17.0")

    quote bind_quoted: [
            code_module: @code_module,
            string: string,
            opts: opts,
            map_literal_fix?: map_literal_fix?
          ] do
      code_module.string_to_quoted_with_comments!(string, opts)
      |> Sourceror.map_literal_fix(map_literal_fix?)
    end
  end

  @doc """
  A wrapper around `Code.string_to_quoted_with_comments/2` for compatibility
  with pre 1.13 Elixir versions.
  """
  defmacro string_to_quoted(string, opts) do
    map_literal_fix? = Version.match?(System.version(), "< 1.17.0")

    quote bind_quoted: [
            code_module: @code_module,
            string: string,
            opts: opts,
            map_literal_fix?: map_literal_fix?
          ] do
      code_module.string_to_quoted_with_comments(string, opts)
      |> Sourceror.map_literal_fix(map_literal_fix?)
    end
  end

  @doc false
  def map_literal_fix(result, false),
    do: result

  def map_literal_fix({:error, reason}, _),
    do: {:error, reason}

  def map_literal_fix({:ok, quoted, comments}, true) do
    {quoted, comments} = map_literal_fix({quoted, comments}, true)
    {:ok, quoted, comments}
  end

  def map_literal_fix({quoted, comments}, true) do
    quoted =
      Macro.postwalk(quoted, fn
        {:%{}, meta, args} ->
          {:%{}, Keyword.replace(meta, :column, meta[:column] - 1), args}

        quoted ->
          quoted
      end)

    {quoted, comments}
  end

  @doc """
  A wrapper around `Code.quoted_to_algebra/2` for compatibility with pre 1.13
  Elixir versions.
  """
  defmacro quoted_to_algebra(quoted, opts) do
    quote bind_quoted: [code_module: @code_module, quoted: quoted, opts: opts] do
      if opts |> Keyword.get(:quoted_to_algebra) |> is_function(2) do
        opts[:quoted_to_algebra].(quoted, opts)
      else
        code_module.quoted_to_algebra(quoted, opts)
      end
    end
  end

  @doc """
  Parses the source code into an extended AST suitable for source manipulation
  as described in `Code.quoted_to_algebra/2`.

  Two additional fields are added to nodes metadata:
    * `:leading_comments` - a list holding the comments found *before* the node.
    * `:trailing_comments` - a list holding the comments found before the end of
      the node. For example, comments right before the `end` keyword.

  Comments are the same maps returned by `Code.string_to_quoted_with_comments/2`.

  ## Options

    - `:line` - the line number where the source code starts. Defaults to `1`.
    - `:column` - the column number where the source code starts. Defaults to `1`.
  """
  @spec parse_string(String.t(), Keyword.t()) :: {:ok, Macro.t()} | {:error, term()}
  def parse_string(source, opts \\ []) do
    opts = Keyword.take(opts, [:line, :column, :indentation])

    {source, opts} = maybe_apply_columns_fix(source, opts)

    with {:ok, quoted, comments} <- string_to_quoted(source, opts ++ to_quoted_opts()) do
      {:ok, Sourceror.Comments.merge_comments(quoted, comments)}
    end
  end

  @doc """
  Same as `parse_string/2` but raises on error.
  """
  @spec parse_string!(String.t()) :: Macro.t()
  def parse_string!(source, opts \\ []) do
    opts = Keyword.take(opts, [:line, :column, :indentation])

    {source, opts} = maybe_apply_columns_fix(source, opts)

    {quoted, comments} = string_to_quoted!(source, opts ++ to_quoted_opts())
    Sourceror.Comments.merge_comments(quoted, comments)
  end

  cond do
    Version.match?(System.version(), ">= 1.16.0 and < 1.19.0") ->
      defp maybe_apply_columns_fix(source, opts) do
        {source, opts} =
          case Keyword.get(opts, :column) do
            start_column when is_integer(start_column) ->
              source = String.duplicate(" ", start_column - 1) <> source
              opts = Keyword.delete(opts, :column)
              {source, opts}

            _ ->
              {source, opts}
          end

        apply_indentation_fix(source, opts)
      end

    Version.match?(System.version(), "< 1.19.0") ->
      defp maybe_apply_columns_fix(source, opts) do
        apply_indentation_fix(source, opts)
      end

    true ->
      defp maybe_apply_columns_fix(source, opts) do
        apply_indentation_fix(source, opts)
      end
  end

  defp apply_indentation_fix(source, opts) do
    case Keyword.get(opts, :indentation) do
      indentation when is_integer(indentation) ->
        opts = Keyword.delete(opts, :indentation)
        source = indent(source, " ", indentation - 1)

        {source, opts}

      _ ->
        {source, opts}
    end
  end

  defp to_quoted_opts do
    [
      literal_encoder: &{:ok, {:__block__, &2, [&1]}},
      token_metadata: true,
      unescape: false,
      columns: true,
      warn_on_unnecessary_quotes: false,
      emit_warnings: false
    ]
  end

  @doc """
  Parses a single expression from the given string. It tries to parse on a
  per-line basis.

  Returns `{:ok, quoted, rest}` on success or `{:error, source}` on error.

  ## Examples
      iex> ~S"\""
      ...> 42
      ...>
      ...> :ok
      ...> "\"" |> Sourceror.parse_expression()
      {:ok, {:__block__, [trailing_comments: [], leading_comments: [],
                          token: "42", line: 2, column: 1], [42]}, "\\n:ok"}

  ## Options
    * `:from_line` - The line at where the parsing should start. Defaults to `1`.
  """
  @spec parse_expression(String.t(), keyword) ::
          {:ok, Macro.t(), String.t()} | {:error, String.t()}
  def parse_expression(string, opts \\ []) do
    from_line = Keyword.get(opts, :from_line, 1)

    lines =
      Regex.split(@re_newline, String.trim(string))
      |> Enum.drop(from_line - 1)

    do_parse_expression(lines, "")
  end

  defp do_parse_expression([], acc), do: {:error, acc}

  defp do_parse_expression([line | rest], acc) do
    string = Enum.join([acc, line], "\n")

    case parse_string(string) do
      # Skip empty lines
      {:ok, {:__block__, _, []}} ->
        do_parse_expression(rest, string)

      {:ok, quoted} ->
        {:ok, quoted, Enum.join(rest, "\n")}

      {:error, _reason} ->
        do_parse_expression(rest, string)
    end
  end

  @doc """
  Converts a quoted expression to a string.

  The comments line number will be ignored and the line number of the associated
  node will be used when formatting the code.

  If you're using Elixir >=1.13, the `locals_without_parens` from your project
  formatter configuration will be used. You can pass a different set of options
  by using the `locals_without_parens` option. If you want to disable that option
  entirely, use `locals_without_parens: []`.

  ## Options
    * `:formatter` - A function that will perform the formatting. It must accept
      the quoted expression and a keyword list with the options. The function
      must return a string.

    * `:indent` - how many indentations to insert at the start of each line.
      Note that this only prepends the indents without checking the indentation
      of nested blocks. Defaults to `0`.

    * `:indent_type` - the type of indentation to use. It can be one of `:spaces`,
      `:single_space` or `:tabs`. Defaults to `:spaces`.

    * `:format` - if set to `:splicing`, if the quoted expression is a list, it
      will strip the square brackets. This is useful to print a single element
      of a keyword list.

    * `:quoted_to_algebra` - expects a function of the type
      `(Macro.t(), keyword -> Inspect.Algebra.t())` to convert the given quoted
      expression to an algebra document.

  For more options see `Code.format_string!/1` and `Code.quoted_to_algebra/2`.
  """
  @spec to_string(Macro.t(), keyword) :: String.t()
  def to_string(quoted, opts \\ []) do
    format_fn =
      case opts[:formatter] do
        format_fn when is_function(format_fn, 2) ->
          format_fn

        _ ->
          &format_quoted/2
      end

    indent = Keyword.get(opts, :indent, 0)

    indent_str =
      case Keyword.get(opts, :indent_type, :spaces) do
        :spaces -> "\s\s"
        :single_space -> "\s"
        :tabs -> "\t"
      end

    quoted
    |> format_fn.(opts)
    |> indent(indent_str, indent)
    |> splice(quoted, opts[:format])
  end

  defp indent(text, _indent_str, 0), do: text

  defp indent(text, indent_str, indent) when indent > 0 do
    text
    |> String.split("\n")
    |> Enum.map_join("\n", fn line ->
      String.duplicate(indent_str, indent) <> line
    end)
  end

  defp splice(text, quoted, :splicing) when is_list(quoted) do
    String.slice(text, 1..-2//1)
  end

  defp splice(text, _quoted, _format), do: text

  defp format_quoted(quoted, opts) do
    line_length = Keyword.get(opts, :line_length, 98)

    quoted
    |> to_algebra(opts)
    |> Inspect.Algebra.format(line_length)
    |> IO.iodata_to_binary()
  end

  @doc false
  def to_algebra(quoted, opts \\ []) do
    extract_comments_opts = [collapse_comments: true, correct_lines: true] ++ opts

    {quoted, comments} = Sourceror.Comments.extract_comments(quoted, extract_comments_opts)

    to_algebra_opts =
      opts
      |> Keyword.merge(comments: comments, escape: false)
      |> Keyword.put_new_lazy(:locals_without_parens, &locals_without_parens/0)

    quoted_to_algebra(quoted, to_algebra_opts)
  end

  @doc """
  Performs a depth-first post-order traversal of a quoted expression.

  See `postwalk/3` for more information.
  """
  @spec postwalk(Macro.t(), traversal_function) ::
          Macro.t()
  def postwalk(quoted, fun) do
    {quoted, _} = postwalk(quoted, nil, fun)
    quoted
  end

  @doc """
  Performs a depth-first post-order traversal of a quoted expression with an
  accumulator.

  `fun` is a function that will receive the current node as a first argument and
  the traversal state as the second one. It must return a `{quoted, state}`,
  in the same way it would return `{quoted, acc}` when using `Macro.postwalk/3`.

  The state is a map with the following keys:
    * `:acc` - The accumulator. Defaults to `nil` if none is given.
  """
  @spec postwalk(Macro.t(), term, traversal_function) ::
          {Macro.t(), term}
  def postwalk(quoted, acc, fun) do
    {quoted, %{acc: acc}} = Macro.traverse(quoted, %TraversalState{acc: acc}, &{&1, &2}, fun)

    {quoted, acc}
  end

  @doc """
  Performs a depth-first pre-order traversal of a quoted expression.

  See `prewalk/3` for more information.
  """
  @spec prewalk(Macro.t(), traversal_function) ::
          Macro.t()
  def prewalk(quoted, fun) do
    {quoted, _} = prewalk(quoted, nil, fun)
    quoted
  end

  @doc """
  Performs a depth-first pre-order traversal of a quoted expression with an
  accumulator.

  `fun` is a function that will receive the current node as a first argument and
  the traversal state as the second one. It must return a `{quoted, state}`,
  in the same way it would return `{quoted, acc}` when using `Macro.prewalk/3`.

  The state is a map with the following keys:
    * `:acc` - The accumulator. Defaults to `nil` if none is given.
  """
  @spec prewalk(Macro.t(), term, traversal_function) ::
          {Macro.t(), term}
  def prewalk(quoted, acc, fun) do
    {quoted, %{acc: acc}} = Macro.traverse(quoted, %TraversalState{acc: acc}, fun, &{&1, &2})

    {quoted, acc}
  end

  @doc """
  Shifts the line numbers of the node or metadata by the given `line_correction`.

  This function will update the `:line`, `:closing`, `:do`, `:end` and
  `:end_of_expression` line numbers of the node metadata if such fields are
  present.
  """
  @spec correct_lines(Macro.t() | Macro.metadata(), integer, Macro.metadata()) ::
          Macro.t() | Macro.metadata()
  def correct_lines(meta, line_correction, opts \\ [])

  def correct_lines(meta, line_correction, opts) when is_list(meta) do
    skip = Keyword.get(opts, :skip, [])

    meta
    |> apply_line_corrections(line_correction, skip)
    |> maybe_correct_line(line_correction, skip)
  end

  def correct_lines(quoted, line_correction, _opts) do
    Macro.update_meta(quoted, &correct_lines(&1, line_correction))
  end

  defp correct_line(meta, key, line_correction) do
    case Keyword.get(meta, key, []) do
      value when value != [] ->
        value =
          if value[:line] do
            put_in(value, [:line], value[:line] + line_correction)
          else
            value
          end

        [{key, value}]

      _ ->
        []
    end
  end

  defp apply_line_corrections(meta, line_correction, skip) do
    to_correct = @line_fields -- skip

    corrections = Enum.map(to_correct, &correct_line(meta, &1, line_correction))

    Enum.reduce(corrections, meta, fn correction, meta ->
      Keyword.merge(meta, correction)
    end)
  end

  defp maybe_correct_line(meta, line_correction, skip) do
    if Keyword.has_key?(meta, :line) and :line not in skip do
      Keyword.put(meta, :line, meta[:line] + line_correction)
    else
      meta
    end
  end

  @doc """
  Returns the metadata of the given node.

      iex> Sourceror.get_meta({:foo, [line: 5], []})
      [line: 5]
  """
  @spec get_meta(Macro.t()) :: Macro.metadata()
  def get_meta({_, meta, _}) when is_list(meta) do
    meta
  end

  @doc """
  Returns the arguments of the node.

      iex> Sourceror.get_args({:foo, [], [{:__block__, [], [:ok]}]})
      [{:__block__, [], [:ok]}]
  """
  @spec get_args(Macro.t()) :: [Macro.t()]
  def get_args({_, _, args}) do
    args
  end

  @doc """
  Updates the arguments for the given node.

      iex> node = {:foo, [line: 1], [{:__block__, [line: 1], [2]}]}
      iex> updater = fn args -> Enum.map(args, &Sourceror.correct_lines(&1, 2)) end
      iex> Sourceror.update_args(node, updater)
      {:foo, [line: 1], [{:__block__, [line: 3], [2]}]}
  """
  @spec update_args(Macro.t(), ([Macro.t()] -> [Macro.t()])) :: Macro.t()
  def update_args({form, meta, args}, fun) when is_function(fun, 1) and is_list(args) do
    {form, meta, fun.(args)}
  end

  @doc """
  Returns the line of a node. If none is found, the default value is
  returned(defaults to 1).

  A default of `nil` may also be provided if the line number is meant to be
  coalesced with a value that is not known upfront.

      iex> Sourceror.get_line({:foo, [line: 5], []})
      5

      iex> Sourceror.get_line({:foo, [], []}, 3)
      3
  """
  @spec get_line(Macro.t(), default :: integer | nil) :: integer | nil
  def get_line({_, meta, _}, default \\ 1)
      when is_list(meta) and (is_integer(default) or is_nil(default)) do
    Keyword.get(meta, :line, default)
  end

  @doc """
  Returns the column of a node. If none is found, the default value is
  returned(defaults to 1).

  A default of `nil` may also be provided if the column number is meant to be
  coalesced with a value that is not known upfront.

      iex> Sourceror.get_column({:foo, [column: 5], []})
      5

      iex> Sourceror.get_column({:foo, [], []}, 3)
      3
  """
  @spec get_column(Macro.t(), default :: integer | nil) :: integer | nil
  def get_column({_, meta, _}, default \\ 1)
      when is_list(meta) and (is_integer(default) or is_nil(default)) do
    Keyword.get(meta, :column, default)
  end

  @doc """
  Returns the line where the given node ends. It recursively checks for `end`,
  `closing` and `end_of_expression` line numbers. If none is found, the default
  value is returned(defaults to 1).

      iex> Sourceror.get_end_line({:foo, [end: [line: 4]], []})
      4

      iex> Sourceror.get_end_line({:foo, [closing: [line: 2]], []})
      2

      iex> Sourceror.get_end_line({:foo, [end_of_expression: [line: 5]], []})
      5

      iex> Sourceror.get_end_line({:foo, [closing: [line: 2], end: [line: 4]], []})
      4

      iex> "\""
      ...> alias Foo.{
      ...>   Bar
      ...> }
      ...> "\"" |> Sourceror.parse_string!() |> Sourceror.get_end_line()
      3
  """
  @spec get_end_line(Macro.t(), integer) :: integer
  def get_end_line(quoted, default \\ 1) when is_integer(default) do
    get_end_position(quoted, line: default, column: 1)[:line]
  end

  @doc """
  Returns the start metadata position of a node.

  Note that this position is the literal contents of the metadata found
  in the node. For accurate start positions, use `get_range/1`.

      iex> quoted = Sourceror.parse_string!(" :foo")
      iex> Sourceror.get_start_position(quoted)
      [line: 1, column: 2]

      iex> quoted = Sourceror.parse_string!("\\n\\nfoo()")
      iex> Sourceror.get_start_position(quoted)
      [line: 3, column: 1]

      iex> quoted = Sourceror.parse_string!("Foo.{Bar}")
      iex> Sourceror.get_start_position(quoted)
      [line: 1, column: 1]

      iex> quoted = Sourceror.parse_string!("foo[:bar]")
      iex> Sourceror.get_start_position(quoted)
      [line: 1, column: 1]

      iex> quoted = Sourceror.parse_string!("foo(:bar)")
      iex> Sourceror.get_start_position(quoted)
      [line: 1, column: 1]
  """
  @spec get_start_position(Macro.t(), position) :: position
  def get_start_position(quoted, default \\ [line: 1, column: 1])

  def get_start_position({{:., _, [Access, :get]}, _, [left | _]}, default) do
    get_start_position(left, default)
  end

  def get_start_position({{:., _, [Kernel, :to_string]}, _, [left | _]}, default) do
    get_start_position(left, default)
  end

  def get_start_position({{:., _, [List, :to_charlist]}, meta, _}, default) do
    position = Keyword.take(meta, [:line, :column])
    Keyword.merge(default, position)
  end

  def get_start_position({{:., _, [left | _]}, _, _}, default) do
    get_start_position(left, default)
  end

  def get_start_position({_, meta, _}, default) do
    position = Keyword.take(meta, [:line, :column])
    Keyword.merge(default, position)
  end

  @doc """
  Returns the end position of the quoted expression. It recursively checks for
  `end`, `closing` and `end_of_expression` positions. If none is found, the
  default value is returned(defaults to `[line: 1, column: 1]`).

  Note that this position is the literal contents of the metadata found
  in the node. For accurate end positions, use `get_range/1`.

      iex> quoted = ~S"\""
      ...> A.{
      ...>   B
      ...> }
      ...> "\"" |>  Sourceror.parse_string!()
      iex> Sourceror.get_end_position(quoted)
      [line: 3, column: 1]

      iex> quoted = ~S"\""
      ...> foo do
      ...>   :ok
      ...> end
      ...> "\"" |>  Sourceror.parse_string!()
      iex> Sourceror.get_end_position(quoted)
      #{if Version.match?(System.version(), "< 1.17.0"),
    do: "[line: 3, column: 1]",
    else: "[line: 3, column: 3]"}

      iex> quoted = ~S"\""
      ...> foo(
      ...>   :a,
      ...>   :b
      ...>    )
      ...> "\"" |>  Sourceror.parse_string!()
      iex> Sourceror.get_end_position(quoted)
      [line: 4, column: 4]
  """
  @spec get_end_position(Macro.t(), position) :: position
  def get_end_position(quoted, default \\ [line: 1, column: 1]) do
    {_, position} =
      Macro.postwalk(quoted, default, fn
        {_, _, _} = quoted, end_position ->
          current_end_position = get_node_end_position(quoted, default)

          end_position =
            if compare_positions(end_position, current_end_position) == :gt do
              end_position
            else
              current_end_position
            end

          {quoted, end_position}

        terminal, end_position ->
          {terminal, end_position}
      end)

    position
  end

  defp get_node_end_position(quoted, default) do
    meta = get_meta(quoted)

    start_position = [
      line: meta[:line] || default[:line],
      column: meta[:column] || default[:column]
    ]

    get_meta(quoted)
    |> Keyword.take(@end_fields)
    |> Keyword.values()
    |> Enum.map(fn end_field ->
      position = Keyword.take(end_field, [:line, :column])

      # If the node contains newlines, a newline is included in the
      # column count. We subtract it so that the column represents the
      # last non-whitespace character.
      if Keyword.has_key?(end_field, :newlines) do
        Keyword.update(position, :column, nil, &(&1 - 1))
      else
        position
      end
    end)
    |> Enum.concat([start_position])
    |> Enum.max_by(
      & &1,
      fn prev, next ->
        compare_positions(prev, next) == :gt
      end,
      fn -> default end
    )
  end

  @doc """
  Compares two positions.

  Returns `:gt` if the first position comes after the second one, and `:lt` for
  vice versa. If the two positions are equal, `:eq` is returned.

  `nil` values for lines or columns are coalesced to `0` for integer
  comparisons.
  """
  @spec compare_positions(position, position) :: :gt | :eq | :lt
  def compare_positions(left, right) do
    left = coalesce_position(left)
    right = coalesce_position(right)

    cond do
      left == right ->
        :eq

      left[:line] > right[:line] ->
        :gt

      left[:line] == right[:line] and left[:column] > right[:column] ->
        :gt

      true ->
        :lt
    end
  end

  defp coalesce_position(position) do
    line = position[:line] || 0
    column = position[:column] || 0

    [line: line, column: column]
  end

  @doc """
  Gets the range used by the given quoted expression in the source code.

  The quoted expression must have at least line and column metadata, otherwise
  it is not possible to calculate an accurate range, or to calculate it at all.
  Additionally, certain syntax constructs desugar into ASTs without a
  meaningful range. In these cases, `get_range/1` returns `nil`.

  This function is most useful when used after `Sourceror.parse_string/2`,
  before any kind of modification to the AST.

      iex> quoted = ~S"\""
      ...> def foo do
      ...>   :ok
      ...> end
      ...> "\"" |> Sourceror.parse_string!()
      iex> Sourceror.get_range(quoted)
      %Sourceror.Range{start: [line: 1, column: 1], end: [line: 3, column: 4]}

      iex> quoted = ~S"\""
      ...> Foo.{
      ...>   Bar
      ...> }
      ...> "\"" |> Sourceror.parse_string!()
      iex> Sourceror.get_range(quoted)
      %Sourceror.Range{start: [line: 1, column: 1], end: [line: 3, column: 2]}

  ## Options

  - `:include_comments` - When `true`, it includes the comments into the range. Defaults to `false`.

  ```elixir
  iex> ~S"\""
  ...> # Foo
  ...> :baz # Bar
  ...> "\""
  ...> |> Sourceror.parse_string!()
  ...> |> Sourceror.get_range(include_comments: true)
  %Sourceror.Range{start: [line: 1, column: 1], end: [line: 2, column: 11]}
  ```
  """
  @spec get_range(Macro.t()) :: Sourceror.Range.t() | nil
  def get_range(quoted, opts \\ []) do
    Sourceror.Range.get_range(quoted, opts)
  end

  @doc """
  Prepends comments to the leading or trailing comments of a node.
  """
  @spec prepend_comments(
          quoted :: Macro.t(),
          comments :: [comment],
          position :: :leading | :trailing
        ) :: Macro.t()
  def prepend_comments(quoted, comments, position \\ :leading)
      when position in [:leading, :trailing] do
    do_add_comments(quoted, comments, :prepend, position)
  end

  @doc """
  Appends comments to the leading or trailing comments of a node.
  """
  @spec append_comments(
          quoted :: Macro.t(),
          comments :: [comment],
          position :: :leading | :trailing
        ) ::
          Macro.t()
  def append_comments(quoted, comments, position \\ :leading)
      when position in [:leading, :trailing] do
    do_add_comments(quoted, comments, :append, position)
  end

  defp do_add_comments({_, meta, _} = quoted, comments, mode, position) do
    key =
      case position do
        :leading -> :leading_comments
        :trailing -> :trailing_comments
      end

    current_comments = Keyword.get(meta, key, [])

    current_comments =
      case mode do
        :append -> current_comments ++ comments
        :prepend -> comments ++ current_comments
      end

    Macro.update_meta(quoted, &Keyword.put(&1, key, current_comments))
  end

  @doc false
  @spec has_closing_line?(Macro.t()) :: boolean
  def has_closing_line?({_, meta, _}) do
    for field <- @end_fields do
      Keyword.has_key?(meta, field)
    end
    |> Enum.any?()
  end

  @doc """
  Applies one or more patches to the given string.

  A patch is a map containing the following values:

    * `:range` - a map containing `:start` and `:end` keys, whose values are
      keyword lists containing the `:line` and `:column` representing the
      boundary of the patch.
    * `:change` - the string being patched in or a function that takes the
      text of the patch range and returns the replacement.
    * `:preserve_indentation` (default `true`) - whether to automatically
      correct the indentation of the patch string to preserve the indentation
      level of the patch range (see examples below)

  Note that `:line` and `:column` start at 1 and represent a cursor positioned
  before the targeted position. For instance, here's how you would select the
  string `"ToBePatched"` in the following example:

      defmodule ToBePatched do
      #         ^          ^
      # col     11         22

      %{range: %{start: [line: 1, column: 11], end: [line: 1, column: 22]}}

  Ranges are usually derived from parsed AST nodes. See `get_range/2` for more.

  Patches are applied bottom-up, such that patches to the beginning of the
  string do not interfere with the line/column of patches that come later.
  However, no checks are done for overlapping ranges, so take care to pass in
  non-overlapping patches.

  ## Examples

      iex> original = ~S"\""
      ...> if not allowed? do
      ...>   raise "Not allowed!"
      ...> end
      ...> "\""
      iex> patch = %Sourceror.Patch{
      ...>   change: "unless allowed? do\\n  raise \\"Not allowed!\\"\\nend",
      ...>   range: %Sourceror.Range{start: [line: 1, column: 1], end: [line: 3, column: 4]}
      ...> }
      iex> Sourceror.patch_string(original, [patch])
      ~S"\""
      unless allowed? do
        raise "Not allowed!"
      end
      "\""

  A range can also be a function, in which case the original text in the patch
  range will be given as an argument:

      iex> original = ~S"\""
      ...> hello :world
      ...> "\""
      iex> patch = %Sourceror.Patch{
      ...>   change: &String.upcase/1,
      ...>   range: %Sourceror.Range{start: [line: 1, column: 7], end: [line: 1, column: 13]}
      ...> }
      iex> Sourceror.patch_string(original, [patch])
      ~S"\""
      hello :WORLD
      "\""

  By default, lines after the first line of the patch will be indented relative to
  the indentation level at the start of the range:

      iex> original = ~S"\""
      ...> outer do
      ...>   inner(foo do
      ...>     :original
      ...>   end)
      ...> end
      ...> "\""
      iex> patch = %Sourceror.Patch{
      ...>   change: "bar do\\n  :replacement\\nend",
      ...>   range: %Sourceror.Range{start: [line: 2, column: 9], end: [line: 4, column: 6]}
      ...> }
      iex> Sourceror.patch_string(original, [patch])
      ~S"\""
      outer do
        inner(bar do
          :replacement
        end)
      end
      "\""

  If you don't want this behavior, you can add `:preserve_indentation: false` to
  your patch:

      iex> original = ~S"\""
      ...> outer do
      ...>   inner(foo do
      ...>     :original
      ...>   end)
      ...> end
      ...> "\""
      iex> patch = %Sourceror.Patch{
      ...>   change: "bar do\\n  :replacement\\nend",
      ...>   range: %Sourceror.Range{start: [line: 2, column: 9], end: [line: 4, column: 6]},
      ...>   preserve_indentation: false
      ...> }
      iex> Sourceror.patch_string(original, [patch])
      ~S"\""
      outer do
        inner(bar do
        :replacement
      end)
      end
      "\""
  """
  @spec patch_string(String.t(), [Sourceror.Patch.t()]) :: String.t()
  def patch_string(string, patches) do
    patches = Enum.sort_by(patches, &{&1.range.start[:line], &1.range.start[:column]}, &>=/2)

    lines =
      string
      |> split_lines()
      |> Enum.reverse()

    do_patch_string(lines, patches, [], length(lines))
    |> Enum.join()
  end

  @doc """
  A convenience utility function for stripping all meta data out of
  a quoted expression. This is useful when debugging for readability of very large
  ASTs.
  """
  @spec strip_meta(quoted :: Macro.t()) :: Macro.t()
  def strip_meta(quoted) do
    Macro.prewalk(quoted, [], fn
      {name, _meta, args}, acc -> {{name, {}, args}, acc}
      other, acc -> {other, acc}
    end)
    |> elem(0)
  end

  defp do_patch_string(lines, [], seen, _), do: Enum.reverse(lines) ++ seen

  defp do_patch_string([], _, seen, _), do: seen

  defp do_patch_string([line | rest], patches, seen, current_line) do
    {applicable, patches} = split_applicable_patches(patches, current_line)
    seen = Enum.reduce(applicable, [line | seen], &apply_patch_to_lines/2)
    do_patch_string(rest, patches, seen, current_line - 1)
  end

  defp split_applicable_patches(patches, current_line) do
    Enum.split_while(patches, &(&1.range.start[:line] == current_line))
  end

  defp apply_patch_to_lines(patch, lines) do
    {{prefix, first_line}, middle_lines, {last_line, suffix}, rest} =
      relevant_patch_lines(patch, lines)

    to_patch = IO.iodata_to_binary([first_line, middle_lines, last_line])

    patch_text =
      if is_binary(patch.change) do
        patch.change
      else
        patch.change.(to_patch)
      end

    patched =
      case split_lines(patch_text) do
        [patched] ->
          patched

        [first_patched | rest_patched] ->
          rest_patched =
            if is_binary(patch.change) && Map.get(patch, :preserve_indentation, true) do
              indent = get_indent(prefix)
              Enum.map(rest_patched, &[indentation(indent), &1])
            else
              rest_patched
            end

          [first_patched | rest_patched]
      end

    [prefix, patched, suffix, rest]
    |> IO.iodata_to_binary()
    |> split_lines()
  end

  defp relevant_patch_lines(%{range: range}, lines) do
    case range.end[:line] - range.start[:line] + 1 do
      1 ->
        [line | rest] = lines
        {prefix, rest_line} = String.split_at(line, range.start[:column] - 1)

        {to_patch, suffix} =
          String.split_at(rest_line, range.end[:column] - String.length(prefix) - 1)

        {{prefix, to_patch}, [], {"", suffix}, rest}

      line_span ->
        {[first_line | rest_to_patch], rest} = Enum.split(lines, line_span)
        {last_line, rest_to_patch} = List.pop_at(rest_to_patch, -1, "")
        {prefix, first_to_patch} = String.split_at(first_line, range.start[:column] - 1)
        {last_to_patch, suffix} = String.split_at(last_line, range.end[:column] - 1)

        {{prefix, first_to_patch}, rest_to_patch, {last_to_patch, suffix}, rest}
    end
  end

  defp get_indent(string, count \\ 0)
  defp get_indent("\s\s" <> rest, count), do: get_indent(rest, count + 1)
  defp get_indent(_, count), do: count

  defp indentation(indent), do: String.duplicate("\s\s", indent)

  defp split_lines(string) do
    string
    |> String.split(@re_newline, include_captures: true)
    |> Enum.chunk_every(2)
    |> Enum.map(&Enum.join/1)
  end

  defp locals_without_parens do
    if Version.match?(System.version(), ">= 1.13.0") do
      # credo:disable-for-next-line
      {_formatter, formatter_opts} = Mix.Tasks.Format.formatter_for_file("elixir.ex")
      Keyword.get(formatter_opts, :locals_without_parens, [])
    else
      []
    end
  end
end
