-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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.
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
added @macroexpand
#18660
added @macroexpand
#18660
Changes from all commits
988f7a1
bff375b
0b2c3ca
2dfe407
691052d
ebe9b53
c66c096
f8157dc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -1052,6 +1052,7 @@ export | |
expand, | ||
gensym, | ||
macroexpand, | ||
@macroexpand, | ||
parse, | ||
|
||
# help and reflection | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -61,6 +61,42 @@ Takes the expression `x` and returns an equivalent expression with all macros re | |
""" | ||
macroexpand(x::ANY) = ccall(:jl_macroexpand, Any, (Any,), x) | ||
|
||
""" | ||
@macroexpand | ||
|
||
Return equivalent expression with all macros removed (expanded). | ||
|
||
There is a subtle difference between `@macroexpand` and `macroexpand` in that expansion takes place in | ||
different contexts. This is best seen in the following example: | ||
|
||
```jldoctest | ||
julia> module M | ||
macro m() | ||
1 | ||
end | ||
function f() | ||
(@macroexpand(@m), macroexpand(:(@m))) | ||
end | ||
end | ||
M | ||
|
||
julia> macro m() | ||
2 | ||
end | ||
@m (macro with 1 method) | ||
|
||
julia> M.f() | ||
(1,2) | ||
``` | ||
With `@macroexpand` the expression expands where `@macroexpand` appears in the code (module `M`). | ||
With `macroexpand` the expressions expands in the current module where the code was finally called (REPL). | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. this isn't the repl if the function is run in a script, is it? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let me explain it differently. If you call There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That makes sense. I'm referring to the "where the code was finally called (REPL)." here. I don't see why "(REPL)" is accurate. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. But in the example it is the REPL? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're making a general statement here "with There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @martinholters I am happy with either formulation, so rephrase it as you see fit. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. a few words saying "in the example" sounds like a good clarification, thanks |
||
Note that when calling `macroexpand` or `@macroexpand` directly from the REPL, both of these contexts coincide, hence there is no difference. | ||
""" | ||
macro macroexpand(code) | ||
code_expanded = macroexpand(code) | ||
QuoteNode(code_expanded) | ||
end | ||
|
||
## misc syntax ## | ||
|
||
""" | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It should be documented that the expansion happens in the module where the
@macroexpand
macro is expanded (i.e. the same module if the expression is used directly) and not the current module when the returned code runs (which is the module if you callmacroexpand
) The difference is demonstrated belowThis makes no difference when used in the REPL and as I said the current
@macroexpand
might be slightly better but this should still be documented.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you give a usecase this would actually make a difference? And why is
@macroexpand
potentially better for interactive use?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's exactly what the code above is showing.
I said