Skip to content

Bugfix: Macro.escape/1 properly escapes meta in :quote tuples #14773

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Sep 16, 2025
Merged

Bugfix: Macro.escape/1 properly escapes meta in :quote tuples #14773

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
dc12d87
Bugfix: Macro.escape/1 properly escapes meta in :quote tuples
sabiwara Sep 16, 2025
58e1369
escape directly calls do_escape if unquote is false
sabiwara Sep 16, 2025
ff5c1d2
Change op types to :escape | :escape_and_prune
sabiwara Sep 16, 2025
f054dd2
Attempt of skipping the clauses - fails to bootstrap
sabiwara Sep 16, 2025
c9f2b3e
Replace none -> escape, add_context -> quote
sabiwara Sep 16, 2025
8ea7ad8
Revert to previous version - not called when escaping with unquote: f…
sabiwara Sep 16, 2025
a96d1ee
Add a comment about unquote: true pitfall
sabiwara Sep 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/elixir/lib/kernel.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5185,7 +5185,7 @@ defmodule Kernel do
quote(do: Kernel.LexicalTracker.read_cache(unquote(pid), unquote(integer)))

%{} ->
:elixir_quote.escape(block, :none, false)
:elixir_quote.escape(block, :escape, false)
end

versioned_vars = env.versioned_vars
Expand Down Expand Up @@ -5465,7 +5465,7 @@ defmodule Kernel do
store =
case unquoted_expr or unquoted_call do
true ->
:elixir_quote.escape({call, expr}, :none, true)
:elixir_quote.escape({call, expr}, :escape, true)

false ->
key = :erlang.unique_integer()
Expand Down
4 changes: 2 additions & 2 deletions lib/elixir/lib/kernel/utils.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ defmodule Kernel.Utils do
key == :__struct__ and raise(ArgumentError, "cannot set :__struct__ in struct definition")

try do
:elixir_quote.escape(val, :none, false)
:elixir_quote.escape(val, :escape, false)
rescue
e in [ArgumentError] ->
raise ArgumentError, "invalid value for struct field #{key}, " <> Exception.message(e)
Expand Down Expand Up @@ -171,7 +171,7 @@ defmodule Kernel.Utils do

:lists.foreach(foreach, enforce_keys)
struct = :maps.from_list([__struct__: module] ++ fields)
escaped_struct = :elixir_quote.escape(struct, :none, false)
escaped_struct = :elixir_quote.escape(struct, :escape, false)

body =
case bootstrapped? do
Expand Down
2 changes: 1 addition & 1 deletion lib/elixir/lib/macro.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -912,7 +912,7 @@ defmodule Macro do
@spec escape(term, escape_opts) :: t()
def escape(expr, opts \\ []) do
unquote = Keyword.get(opts, :unquote, false)
kind = if Keyword.get(opts, :prune_metadata, false), do: :prune_metadata, else: :none
kind = if Keyword.get(opts, :prune_metadata, false), do: :escape_and_prune, else: :escape
generated = Keyword.get(opts, :generated, false)

case :elixir_quote.escape(expr, kind, unquote) do
Expand Down
8 changes: 4 additions & 4 deletions lib/elixir/src/elixir_quote.erl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
line=false,
file=nil,
context=nil,
op=none, % none | prune_metadata | add_context
op=none, % none | escape | escape_and_prune | add_context
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be:

Suggested change
op=none, % none | escape | escape_and_prune | add_context
op=escape, % escape | escape_and_prune | quote

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I thought elixir_quote:quote would be adding :none too, but turns out it's add_context. Got it!

aliases_hygiene=nil,
imports_hygiene=nil,
unquote=true,
Expand Down Expand Up @@ -156,7 +156,7 @@ escape(Expr, Op, Unquote) ->
false -> do_escape(Expr, Q)
end.

do_escape({Left, Meta, Right}, #elixir_quote{op=prune_metadata} = Q) when is_list(Meta) ->
do_escape({Left, Meta, Right}, #elixir_quote{op=escape_and_prune} = Q) when is_list(Meta) ->
TM = [{K, V} || {K, V} <- Meta, (K == no_parens) orelse (K == line) orelse (K == delimiter)],
TL = do_escape(Left, Q),
TR = do_escape(Right, Q),
Expand Down Expand Up @@ -343,7 +343,7 @@ quote(Expr, Q) ->

%% quote/unquote

do_quote({quote, Meta, [Arg]}, Q) when is_list(Meta) ->
do_quote({quote, Meta, [Arg]}, #elixir_quote{op=Op} = Q) when is_list(Meta), Op /= escape, Op /= escape_and_prune ->
TArg = do_quote(Arg, Q#elixir_quote{unquote=false}),

NewMeta = case Q of
Expand All @@ -353,7 +353,7 @@ do_quote({quote, Meta, [Arg]}, Q) when is_list(Meta) ->

{'{}', [], [quote, meta(NewMeta, Q), [TArg]]};

do_quote({quote, Meta, [Opts, Arg]}, Q) when is_list(Meta) ->
do_quote({quote, Meta, [Opts, Arg]}, #elixir_quote{op=Op} = Q) when is_list(Meta), Op /= escape, Op /= escape_and_prune ->
TOpts = do_quote(Opts, Q),
TArg = do_quote(Arg, Q#elixir_quote{unquote=false}),

Expand Down
3 changes: 3 additions & 0 deletions lib/elixir/test/elixir/macro_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,9 @@ defmodule MacroTest do
test "escapes the content of :quote tuples" do
assert Macro.escape({:quote, [%{}], [{}]}) ==
{:{}, [], [:quote, [{:%{}, [], []}], [{:{}, [], []}]]}

assert Macro.escape({:quote, [%{}], [{}]}, unquote: true) ==
{:{}, [], [:quote, [{:%{}, [], []}], [{:{}, [], []}]]}
end

test "escape container when a reference cannot be escaped" do
Expand Down
Loading