better toplevelitems API

Author: aviatesk

src/goto.jl

@@ -194,8 +194,7 @@ function _collecttoplevelitems!(mod::Union{Nothing, String}, entrypath::String,
   _collecttoplevelitems!(mod, entrypath, text, pathitemsmaps)
 end
 function _collecttoplevelitems!(mod::Union{Nothing, String}, entrypath::String, text::String, pathitemsmaps::PathItemsMaps)
-  parsed = CSTParser.parse(text, true)
-  items = toplevelitems(parsed, text; mod = mod)
+  items = toplevelitems(text; mod = mod)
   push!(pathitemsmaps, entrypath => items)
 
   # looking for toplevel `include` calls

src/modules.jl

@@ -199,8 +199,7 @@ function modulefiles(mod::String, entrypath::String, files = Vector{String}())
   push!(files, entrypath)
 
   text = read(entrypath, String)
-  parsed = CSTParser.parse(text, true)
-  items = toplevelitems(parsed, text; mod = mod)
+  items = toplevelitems(text; mod = mod)
 
   for item in items
     if item isa ToplevelCall

src/outline.jl

@@ -15,8 +15,7 @@ end
 
 # NOTE: update outline and symbols cache all in one go
 function updateeditor(text, mod = "Main", path = nothing, updateSymbols = true)
-    parsed = CSTParser.parse(text, true)
-    items = toplevelitems(parsed, text)
+    items = toplevelitems(text)
 
     # update symbols cache
     # ref: https://github.com/JunoLab/Juno.jl/issues/407

src/static/toplevel.jl

@@ -24,10 +24,24 @@ struct ToplevelTupleH <: ToplevelItem
     lines::UnitRange{Int}
 end
 
-function toplevelitems(
-    expr, text, # necessary
+"""
+    toplevelitems(text; kwargs...)
+
+Returns [`ToplevelItem`](@ref)s in `text`.
+
+keyword arguments:
+- `mod::Union{Nothing, String}`: if not `nothing` don't return items within modules
+    other than `mod`, otherwise enter into every module.
+"""
+function toplevelitems(text; kwargs...)
+    parsed = CSTParser.parse(text, true)
+    _toplevelitems(text, parsed; kwargs...)
+end
+
+function _toplevelitems(
+    text, expr,
     items::Vector{ToplevelItem} = Vector{ToplevelItem}(), line = 1, pos = 1;
-    mod::Union{Nothing, String} = nothing, # if given, don't enter into modules other than `mod`
+    mod::Union{Nothing, String} = nothing,
 )
     # binding
     bind = CSTParser.bindingof(expr)
@@ -50,7 +64,7 @@ function toplevelitems(
     if shouldenter(expr, mod)
         if expr.args !== nothing
             for arg in expr.args
-                toplevelitems(arg, text, items, line, pos; mod = mod)
+                _toplevelitems(text, arg, items, line, pos; mod = mod)
                 line += countlines(arg, text, pos)
                 pos += arg.fullspan
             end

test/goto.jl

@@ -182,8 +182,7 @@
 
         @testset "updating toplevel symbols" begin
             function updatesymbols(mod, path, text)
-                parsed = CSTParser.parse(text, true)
-                items = Atom.toplevelitems(parsed, text)
+                items = Atom.toplevelitems(text)
                 Atom.updatesymbols(items, mod, path, text)
             end
 

test/outline.jl

@@ -1,9 +1,5 @@
 @testset "outline" begin
-    function outline(str)
-        parsed = CSTParser.parse(str, true)
-        items = Atom.toplevelitems(parsed, str)
-        Atom.outline(items)
-    end
+    outline(text) = Atom.outline(Atom.toplevelitems(text))
 
     let str = """
         module Foo

test/static/toplevel.jl

@@ -6,20 +6,20 @@
     parsed = CSTParser.parse(text, true)
 
     # basic -- finds every toplevel items when `mod` options is `nothing` (default)
-    @test filter(toplevelitems(parsed, text; mod = nothing)) do item
+    @test filter(toplevelitems(text; mod = nothing)) do item
         item isa Atom.ToplevelBinding &&
         item.bind.name == "imwithdoc"
     end |> length === 3
 
     # don't enter non-target modules, e.g.: submodules
-    @test filter(toplevelitems(parsed, text; mod = "Junk")) do item
+    @test filter(toplevelitems(text; mod = "Junk")) do item
         item isa Atom.ToplevelBinding &&
         item.bind.name == "imwithdoc"
     end |> length === 1 # should only find the `imwithdoc` in Junk module
 
     # don't include items outside of a module
     # FIX: currently broken -- include `imwithdoc` in Junk module as well
-    @test_broken filter(toplevelitems(parsed, text; mod = "SubJunk")) do item
+    @test_broken filter(toplevelitems(text; mod = "SubJunk")) do item
         item isa Atom.ToplevelBinding &&
         item.bind.name == "imwithdoc"
     end |> length === 1 # should only find the `imwithdoc` in SubJunk module