-
-
Notifications
You must be signed in to change notification settings - Fork 30
/
utils.jl
281 lines (229 loc) · 8.57 KB
/
utils.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
# file utilities
# --------------
function isfile′(p)
try
isfile(p)
catch
false
end
end
iswritablefile(file) = Base.uperm(file) == 0x06
nonwritablefiles(files) = filter(!iswritablefile, files)
function search_up_file(basename, dir)
parent_dir = dirname(dir)
return if (parent_dir == dir || # ensure to escape infinite recursion
isempty(dir)) # reached to the system root
nothing
else
path = joinpath(dir, basename)
isfile(path) ? path : search_up_file(basename, parent_dir)
end
end
# path utilities
# --------------
include("path_matching.jl")
"""
isuntitled(path::AbstractString)
Checks if `path` represents an unsaved editor.
Usualy the string that follows `"untitled-"` is obtained from `editor.getBuffer().getId()`:
e.g. `path = "untitled-266305858c1298b906bed15ddad81cea"`.
"""
isuntitled(path::AbstractString) = occursin(r"^(\.\\|\./)?untitled-[\d\w]+(:\d+)?$", path)
appendline(path, line) = line > 0 ? "$path:$line" : path
function realpath′(p)
try
ispath(p) ? realpath(p) : p
catch e
p
end
end
using Pkg, OrderedCollections
function finddevpackages()
usage_file = joinpath(Pkg.logdir(), "manifest_usage.toml")
manifests = Set{String}()
if isfile(usage_file)
for (manifest_file, infos) in Pkg.TOML.parse(String(read(usage_file)))
push!(manifests, manifest_file)
end
else
push!(manifests, Pkg.Types.Context().env.manifest_file)
end
devpkgs = OrderedDict{String,String}()
for manifest in manifests
isfile(manifest) || continue
try
for (pkg, infos) in Pkg.Types.read_manifest(manifest)
if isdefined(infos, :path)
if infos.path ≠ nothing
devpkgs[infos.name] = infos.path
end
else
haskey(first(infos), "path") && (devpkgs[pkg] = first(infos)["path"])
end
end
catch err
@debug("Error reading manifest.", exception = err)
end
end
sort!(devpkgs)
end
basepath(file) = normpath(Sys.BINDIR::String, Base.DATAROOTDIR, "julia", "base", file)
fullpath(path) =
realpath′(isuntitled(path) || isabspath(path) ? path : basepath(path))
function pkgpath(path)
m = match(r"((?:[^/\\]+[/\\]){2}src[/\\].*)$", path)
m == nothing ? basename(path) : m.captures[1]
end
expandpath(path) =
isempty(path) ? (path, path) :
path == "./missing" ? ("<unknown file>", path) :
isuntitled(path) ? ("untitled", path) :
!isabspath(path) ? (normpath(joinpath("base", path)), basepath(path)) :
occursin(joinpath("julia", "stdlib"), path) ?
begin
p = last(split(path, joinpath("julia", "stdlib", "")))
return (normpath(joinpath("stdlib", p)), isfile′(path) ? path :
normpath(joinpath(basepath(joinpath("..", "stdlib")), p)))
end :
(pkgpath(path), path)
function baselink(path, line)
name, path = expandpath(path)
name == "<unkown file>" ? span(".fade", "<unknown file>") :
link(path, line, Text(appendline(name, line)))
end
using Markdown: MD, HorizontalRule
function md_hlines(md)
if !isa(md, MD) || !haskey(md.meta, :results) || isempty(md.meta[:results])
return md
end
v = Any[]
for (n, doc) in enumerate(md.content)
push!(v, doc)
n == length(md.content) || push!(v, HorizontalRule())
end
return MD(v)
end
# string utilties
# ---------------
"""
strlimit(str::AbstractString, limit::Integer = 30, ellipsis::AbstractString = "…")
Chops off `str` so that its _length_ doesn't exceed `limit`. The excessive part
will be replaced by `ellipsis`.
!!! note
The length of returned string will _never_ exceed `limit`.
"""
function strlimit(str::AbstractString, limit::Integer = 30, ellipsis::AbstractString = "…")
will_append = length(str) > limit
io = IOBuffer()
i = 1
for c in str
will_append && i > limit - length(ellipsis) && break
isvalid(c) || continue
print(io, c)
i += 1
end
will_append && print(io, ellipsis)
return String(take!(io))
end
shortstr(val) = strlimit(string(val), 20)
"""used to strip parent module prefixes e.g.: `"Main.Junk" ⟶ "Junk"`"""
stripdotprefixes(str::AbstractString) = string(last(split(str, '.')))
"""
struct Undefined end
const undefined = Undefined()
The singleton instance that represents a binding to an undefined value.
See also: [`getthing′`](@ref)
"""
struct Undefined end, const undefined = Undefined()
"""
isundefined(x)
Return `true` if `x === undefined`, and return `false` if not.
"""
isundefined(::Any) = false
isundefined(::Undefined) = true
# get utilities
# -------------
using CodeTools
"""
getfield′(mod::Module, name::AbstractString, default = undefined)
getfield′(mod::Module, 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` (set to [`undefined`](@ref) by default) if no such a field is found.
"""
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′(@nospecialize(object), name::Symbol, default = undefined) = isdefined(object, name) ? getfield(object, name) : default
getfield′(@nospecialize(object), name::AbstractString, default = undefined) = getfield′(object, Symbol(name), default)
"""
getmodule(mod::AbstractString)::Module
getmodule(parent::Union{Nothing, Module}, mod::AbstractString)::Module
getmodule(code::AbstractString, pos; filemod)::Module
Calls `CodeTools.getmodule(args...)`, but returns `Main` instead of `nothing` in a fallback case.
"""
getmodule(args...)::Module = (m = CodeTools.getmodule(args...)) === nothing ? Main : m
"""
getmethods(mod::Module, word::AbstractString)
getmethods(mod::AbstractString, word::AbstractString)
Returns the [`MethodList`](@ref) for `word`, which is bound within `mod` module.
"""
getmethods(mod::Module, word::AbstractString) = methods(CodeTools.getthing(mod, word))
getmethods(mod::AbstractString, word::AbstractString) = getmethods(getmodule(mod), word)
"""
getdocs(mod::Module, word::AbstractString, fallbackmod::Module = Main)
getdocs(mod::AbstractString, word::AbstractString, fallbackmod::Module = Main)
Retrieves docs for `mod.word` with [`@doc`](@ref) macro. If `@doc` is not available
within `mod` module, `@doc` will be evaluated in `fallbackmod` module if possible.
!!! note
You may want to run [`cangetdocs`](@ref) in advance.
"""
getdocs(mod::Module, word::AbstractString, fallbackmod::Module = Main) = begin
try
md = if iskeyword(word)
Core.eval(Main, :(@doc($(Symbol(word)))))
else
docsym = Symbol("@doc")
if isdefined(mod, docsym)
include_string(mod, "@doc $word")
elseif isdefined(fallbackmod, docsym)
word = string(mod) * "." * word
include_string(fallbackmod, "@doc $word")
else
MD("@doc is not available in " * string(mod))
end
end
md_hlines(md)
catch err
return MD("")
end
end
getdocs(mod::AbstractString, word::AbstractString, fallbackmod::Module = Main) =
getdocs(getmodule(mod), word, fallbackmod)
"""
cangetdocs(mod::Module, word::Symbol)
cangetdocs(mod::Module, word::AbstractString)
cangetdocs(mod::AbstractString, word::Union{Symbol, AbstractString})
Checks if the documentation bindings for `mod.word` is resolved and `mod.word`
is not deprecated.
"""
cangetdocs(mod::Module, word::Symbol) =
Base.isbindingresolved(mod, word) &&
!Base.isdeprecated(mod, word)
cangetdocs(mod::Module, word::AbstractString) = cangetdocs(mod, Symbol(word))
cangetdocs(mod::AbstractString, word::Union{Symbol, AbstractString}) = cangetdocs(getmodule(mod), word)
# is utilities
# ------------
iskeyword(word::Symbol) = word in keys(Docs.keywords)
iskeyword(word::AbstractString) = iskeyword(Symbol(word))
ismacro(ct::AbstractString) = startswith(ct, '@') || endswith(ct, '"')
ismacro(f::Function) = startswith(string(methods(f).mt.name), "@")
# uri utilties
# ------------
uriopen(file, line = 0) = "atom://julia-client/?open=true&file=$(file)&line=$(line)"
uridocs(mod, word) = "atom://julia-client/?docs=true&mod=$(mod)&word=$(word)"
urigoto(mod, word) = "atom://julia-client/?goto=true&mod=$(mod)&word=$(word)"
urimoduleinfo(mod) = "atom://julia-client/?moduleinfo=true&mod=$(mod)"
function Base.include_string(f, mod, s::AbstractString, fname::AbstractString, line::Integer)
include_string(f, mod, "\n"^(line-1)*s, fname)
end