Merge pull request #200 from FluxML/qq

Define @qq
FluxML · Jan 15, 2024 · 2b843b2 · 2b843b2 · cstjean · Jan 15, 2024
2 parents 6b3034a + 7547d12
commit 2b843b2
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 4 deletions.
diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
@@ -19,7 +19,7 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '1.0'
+          - '1.6'
           - '1'
           - 'nightly'
         os: [ubuntu-latest, macOS-latest, windows-latest]

diff --git a/Project.toml b/Project.toml
@@ -1,13 +1,13 @@
 name = "MacroTools"
 uuid = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09"
-version = "0.5.12"
+version = "0.5.13"
 
 [deps]
 Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a"
 Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
 
 [compat]
-julia = "1"
+julia = "1.6"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

diff --git a/docs/src/utilities.md b/docs/src/utilities.md
@@ -43,6 +43,7 @@ MacroTools.combinearg
 
 ```@docs
 MacroTools.@q
+MacroTools.@qq
 MacroTools.isexpr
 MacroTools.rmlines
 MacroTools.unblock

diff --git a/src/utils.jl b/src/utils.jl
@@ -36,6 +36,29 @@ macro q(ex)
   esc(Expr(:quote, striplines(ex)))
 end
 
+struct Flag end
+
+to_flag(ex) = MacroTools.prewalk(x->x isa LineNumberNode ? Flag() : x, ex)
+to_line(l::LineNumberNode, ex) = MacroTools.prewalk(x->x isa Flag ? l : x, ex)
+
+"""
+    @qq [expression]
+
+Like the `quote` keyword but replace construction site line numbers with __source__.
+Line numbers of interpolated expressions are preserved. The result is that line numbers will be
+attributed to the macro usage site, instead of the macro source code.
+
+Only works inside of a macro definition.
+
+See also: [`@q`](@ref)
+"""
+macro qq(ex)
+    # This was a difficult macro to write; the round-trip to Flag appears to be necessary.
+    # Crucially, we want interpolated expressions to preserve their line numbers.
+    esc(:($MacroTools.to_line(__source__, $(Expr(:quote, to_flag(ex))))))
+end
+
+
 """
     isexpr(x, ts...)
 

diff --git a/test/utils.jl b/test/utils.jl
@@ -1,4 +1,4 @@
-using MacroTools: isdef, flatten, striplines
+using MacroTools: isdef, flatten, striplines, @qq
 
 @testset "utils" begin
     ex1 = :(function foo(a) return a; end)
@@ -45,3 +45,17 @@ end
         @test flatten(ex) |> striplines == ex |> striplines
     end
 end
+
+## Test for @qq
+
+macro my_fff_def(a)
+    @qq function fff() $a end
+end
+
+@my_fff_def begin   # line where fff() is defined
+    function g()    # line where fff()() is defined
+        22
+    end
+end
+
+@test which(fff,()).line == which(fff(),()).line - 1