add more methods for get utilities

Author: aviatesk

src/utils.jl

@@ -1,3 +1,6 @@
+# path utilities
+# --------------
+
 include("path_matching.jl")
 
 isuntitled(p) = occursin(r"^(\.\\|\./)?untitled-[\d\w]+(:\d+)?$", p)
@@ -99,6 +102,9 @@ function md_hlines(md)
   return MD(v)
 end
 
+# string utilties
+# ---------------
+
 function strlimit(str::AbstractString, limit::Int = 30, ellipsis::AbstractString = "…")
   will_append = length(str) > limit
 
@@ -122,33 +128,39 @@ shortstr(val) = strlimit(string(val), 20)
 struct Undefined end
 
 # get utilities
+# -------------
+
 using CodeTools
 
 """
-    getfield′(mod::Module, name::String, default = Undefined())
+    getfield′(mod::Module, name::AbstractString, default = Undefined())
     getfield′(mod::Module, name::Symbol, default = Undefined())
+    getfield′(mod::AbstractString, name::Symbol, default = Undefined())
     getfield′(object, name::Symbol, default = Undefined())
+    getfield′(object, name::AbstractString, default = Undefined())
 
 Returns the specified field of a given `Module` or some arbitrary `object`,
 or `default` if no such a field is found.
 """
-getfield′(mod::Module, name::String, default = Undefined()) = CodeTools.getthing(mod, name, default)
+getfield′(mod::Module, name::AbstractString, default = Undefined()) = CodeTools.getthing(mod, name, default)
 getfield′(mod::Module, name::Symbol, default = Undefined()) = getfield′(mod, string(name), default)
+getfield′(mod::AbstractString, name::Symbol, default = Undefined()) = getfield′(getmodule(mod), string(name), default)
 getfield′(@nospecialize(object), name::Symbol, default = Undefined()) = isdefined(object, name) ? getfield(object, name) : default
+getfield′(@nospecialize(object), name::AbstractString, default = Undefined()) = isdefined(object, name) ? getfield(object, Symbol(name)) : default
 
 """
-    getmodule(mod::String)
-    getmodule(parent::Union{Nothing, Module}, mod::String)
+    getmodule(mod::AbstractString)
+    getmodule(parent::Union{Nothing, Module}, mod::AbstractString)
     getmodule(code::AbstractString, pos; filemod)
 
 Calls `CodeTools.getmodule(args...)`, but returns `Main` instead of `nothing` in a fallback case.
 """
 getmodule(args...) = (m = CodeTools.getmodule(args...)) === nothing ? Main : m
 
-getmethods(mod::Module, word::String) = methods(CodeTools.getthing(mod, word))
-getmethods(mod::String, word::String) = getmethods(getmodule(mod), word)
+getmethods(mod::Module, word::AbstractString) = methods(CodeTools.getthing(mod, word))
+getmethods(mod::AbstractString, word::AbstractString) = getmethods(getmodule(mod), word)
 
-getdocs(mod::Module, word::String, fallbackmod::Module = Main) = begin
+getdocs(mod::Module, word::AbstractString, fallbackmod::Module = Main) = begin
   md = if Symbol(word) in keys(Docs.keywords)
     Core.eval(Main, :(@doc($(Symbol(word)))))
   else
@@ -164,13 +176,14 @@ getdocs(mod::Module, word::String, fallbackmod::Module = Main) = begin
   end
   md_hlines(md)
 end
-getdocs(mod::String, word::String, fallbackmod::Module = Main) =
+getdocs(mod::AbstractString, word::AbstractString, fallbackmod::Module = Main) =
   getdocs(getmodule(mod), word, fallbackmod)
 
 cangetdocs(mod::Module, word::Symbol) =
   Base.isbindingresolved(mod, word) &&
   !Base.isdeprecated(mod, word)
-cangetdocs(mod::Module, word::String) = cangetdocs(mod, Symbol(word))
+cangetdocs(mod::Module, word::AbstractString) = cangetdocs(mod, Symbol(word))
+cangetdocs(mod::AbstractString, word::Union{Symbol, AbstractString}) = cangetdocs(getmodule(mod), word)
 
 #=
 module file detections