Implement pkgfiles

Author: timholy

src/CodeTracking.jl

@@ -1,5 +1,6 @@
 module CodeTracking
 
+using Base: PkgId
 using Core: LineInfoNode
 
 export whereis, definition, pkgfiles
@@ -69,12 +70,19 @@ definition(method::Method, ::Type{Expr}) = get(method_definitions, method.sig, n
 definition(method::Method) = definition(method, Expr)
 
 """
-    files = pkgfiles(mod::Module)
+    info = pkgfiles(id::PkgId)
 
-Return a list of the files that were loaded to define `mod`.
+Return a [`PkgFiles`](@ref) structure with information about the files that define package `id`.
+Returns `nothing` if `id` has not been loaded.
 """
-function pkgfiles(mod::Module)
-    error("not implemented")
-end
+pkgfiles(id::PkgId) = get(_pkgfiles, id, nothing)
+
+"""
+    info = pkgfiles(mod::Module)
+
+Return a [`PkgFiles`](@ref) structure with information about the files that were loaded to
+define the package that defined `mod`.
+"""
+pkgfiles(mod::Module) = pkgfiles(PkgId(mod))
 
 end # module

src/data.jl

@@ -1,5 +1,33 @@
 # The variables here get populated by Revise.jl.
 
+"""
+PkgFiles encodes information about the current location of a package.
+Fields:
+- `id`: the `PkgId` of the package
+- `basedir`: the current base directory of the package
+- `files`: a list of files (relative path to `basedir`) that define the package.
+
+Note that `basedir` may be subsequently updated by Pkg operations such as `add` and `dev`.
+"""
+mutable struct PkgFiles
+    id::PkgId
+    basedir::String
+    files::Vector{String}
+end
+
+PkgFiles(id::PkgId, path::AbstractString) = PkgFiles(id, path, String[])
+PkgFiles(id::PkgId, ::Nothing) = PkgFiles(id, "")
+PkgFiles(id::PkgId) = PkgFiles(id, normpath(basepath(id)))
+PkgFiles(id::PkgId, files::AbstractVector{<:AbstractString}) =
+    PkgFiles(id, normpath(basepath(id)), files)
+
+# Abstraction interface
+Base.PkgId(info::PkgFiles) = info.id
+srcfiles(info::PkgFiles) = info.files
+basedir(info::PkgFiles) = info.basedir
+
 const method_locations = IdDict{Type,LineInfoNode}()
 
 const method_definitions = IdDict{Type,Expr}()
+
+const _pkgfiles = Dict{PkgId,PkgFiles}()

src/utils.jl

@@ -14,3 +14,10 @@ function isfuncexpr(ex)
 end
 
 fileline(lin::LineInfoNode) = String(lin.file), lin.line
+
+function basepath(id::PkgId)
+    id.name ∈ ("Main", "Base", "Core") && return ""
+    loc = Base.locate_package(id)
+    loc === nothing && return ""
+    return dirname(dirname(loc))
+end

test/runtests.jl

@@ -19,4 +19,8 @@ include("script.jl")
     @test src == """
     f2(x, y) = x + y
     """
+
+    info = CodeTracking.PkgFiles(Base.PkgId(CodeTracking))
+    @test Base.PkgId(info) === info.id
+    @test CodeTracking.basedir(info) == dirname(@__DIR__)
 end