-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
/
methodshow.jl
385 lines (365 loc) · 12 KB
/
methodshow.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
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
# This file is a part of Julia. License is MIT: https://julialang.org/license
# Method and method table pretty-printing
function argtype_decl(env, n, sig::DataType, i::Int, nargs, isva::Bool) # -> (argname, argtype)
t = sig.parameters[i]
if i == nargs && isva && !isvarargtype(t)
t = Vararg{t,length(sig.parameters)-nargs+1}
end
if isa(n,Expr)
n = n.args[1] # handle n::T in arg list
end
s = string(n)
i = findfirst(isequal('#'), s)
if i !== nothing
s = s[1:i-1]
end
if t === Any && !isempty(s)
return s, ""
end
if isvarargtype(t)
v1, v2 = nothing, nothing
if isa(t, UnionAll)
v1 = t.var
t = t.body
if isa(t, UnionAll)
v2 = t.var
t = t.body
end
end
ut = unwrap_unionall(t)
tt, tn = ut.parameters[1], ut.parameters[2]
if isa(tn, TypeVar) && (tn === v1 || tn === v2)
if tt === Any || (isa(tt, TypeVar) && (tt === v1 || tt === v2))
return string(s, "..."), ""
else
return s, string_with_env(env, tt) * "..."
end
end
return s, string_with_env(env, "Vararg{", tt, ",", tn, "}")
end
return s, string_with_env(env, t)
end
function method_argnames(m::Method)
argnames = ccall(:jl_uncompress_argnames, Vector{Any}, (Any,), m.slot_syms)
isempty(argnames) && return argnames
return argnames[1:m.nargs]
end
function arg_decl_parts(m::Method)
tv = Any[]
sig = m.sig
while isa(sig, UnionAll)
push!(tv, sig.var)
sig = sig.body
end
file = m.file
line = m.line
argnames = method_argnames(m)
if length(argnames) >= m.nargs
show_env = ImmutableDict{Symbol, Any}()
for t in tv
show_env = ImmutableDict(show_env, :unionall_env => t)
end
decls = Any[argtype_decl(show_env, argnames[i], sig, i, m.nargs, m.isva)
for i = 1:m.nargs]
else
decls = Any[("", "") for i = 1:length(sig.parameters)]
end
return tv, decls, file, line
end
const empty_sym = Symbol("")
function kwarg_decl(m::Method, kwtype::DataType)
sig = rewrap_unionall(Tuple{kwtype, Any, unwrap_unionall(m.sig).parameters...}, m.sig)
kwli = ccall(:jl_methtable_lookup, Any, (Any, Any, UInt), kwtype.name.mt, sig, get_world_counter())
if kwli !== nothing
kwli = kwli::Method
slotnames = ccall(:jl_uncompress_argnames, Vector{Any}, (Any,), kwli.slot_syms)
kws = filter(x -> !(x === empty_sym || '#' in string(x)), slotnames[(kwli.nargs + 1):end])
# ensure the kwarg... is always printed last. The order of the arguments are not
# necessarily the same as defined in the function
i = findfirst(x -> endswith(string(x), "..."), kws)
if i !== nothing
push!(kws, kws[i])
deleteat!(kws, i)
end
return kws
end
return ()
end
function show_method_params(io::IO, tv)
if !isempty(tv)
print(io, " where ")
if length(tv) == 1
show(io, tv[1])
else
print(io, "{")
for i = 1:length(tv)
if i > 1
print(io, ", ")
end
x = tv[i]
show(io, x)
io = IOContext(io, :unionall_env => x)
end
print(io, "}")
end
end
end
# In case the line numbers in the source code have changed since the code was compiled,
# allow packages to set a callback function that corrects them.
# (Used by Revise and perhaps other packages.)
default_methodloc(method::Method) = method.file, method.line
const methodloc_callback = Ref{Function}(default_methodloc)
function show(io::IO, m::Method; kwtype::Union{DataType, Nothing}=nothing)
tv, decls, file, line = arg_decl_parts(m)
sig = unwrap_unionall(m.sig)
ft0 = sig.parameters[1]
ft = unwrap_unionall(ft0)
d1 = decls[1]
if sig === Tuple
print(io, m.name)
decls = Any[(), ("...", "")]
elseif ft <: Function && isa(ft, DataType) &&
isdefined(ft.name.module, ft.name.mt.name) &&
# TODO: more accurate test? (tn.name === "#" name)
ft0 === typeof(getfield(ft.name.module, ft.name.mt.name))
print(io, ft.name.mt.name)
elseif isa(ft, DataType) && ft.name === Type.body.name
f = ft.parameters[1]
if isa(f, DataType) && isempty(f.parameters)
print(io, f)
else
print(io, "(", d1[1], "::", d1[2], ")")
end
else
print(io, "(", d1[1], "::", d1[2], ")")
end
print(io, "(")
join(io, [isempty(d[2]) ? d[1] : d[1]*"::"*d[2] for d in decls[2:end]],
", ", ", ")
if kwtype !== nothing
kwargs = kwarg_decl(m, kwtype)
if !isempty(kwargs)
print(io, "; ")
join(io, kwargs, ", ", ", ")
end
end
print(io, ")")
show_method_params(io, tv)
print(io, " in ", m.module)
if line > 0
try
file, line = invokelatest(methodloc_callback[], m)
catch
end
print(io, " at ", file, ":", line)
end
end
function show_method_list_header(io::IO, ms::MethodList, namefmt::Function)
mt = ms.mt
name = mt.name
hasname = isdefined(mt.module, name) &&
typeof(getfield(mt.module, name)) <: Function
n = length(ms)
if mt.module === Core && n == 0 && mt.defs === nothing && mt.cache !== nothing
# try to detect Builtin
print(io, "# built-in function; no methods")
else
m = n==1 ? "method" : "methods"
print(io, "# $n $m")
sname = string(name)
namedisplay = namefmt(sname)
if hasname
what = startswith(sname, '@') ? "macro" : "generic function"
print(io, " for ", what, " ", namedisplay)
elseif '#' in sname
print(io, " for anonymous function ", namedisplay)
elseif mt === _TYPE_NAME.mt
print(io, " for type constructor")
end
print(io, ":")
end
end
function show_method_table(io::IO, ms::MethodList, max::Int=-1, header::Bool=true)
mt = ms.mt
name = mt.name
hasname = isdefined(mt.module, name) &&
typeof(getfield(mt.module, name)) <: Function
if header
show_method_list_header(io, ms, str -> "\""*str*"\"")
end
kwtype = isdefined(mt, :kwsorter) ? typeof(mt.kwsorter) : nothing
n = rest = 0
local last
resize!(LAST_SHOWN_LINE_INFOS, 0)
for meth in ms
if max==-1 || n<max
n += 1
println(io)
print(io, "[$(n)] ")
show(io, meth; kwtype=kwtype)
file, line = meth.file, meth.line
try
file, line = invokelatest(methodloc_callback[], meth)
catch
end
push!(LAST_SHOWN_LINE_INFOS, (string(file), line))
else
rest += 1
last = meth
end
end
if rest > 0
println(io)
if rest == 1
show(io, last; kwtype=kwtype)
else
print(io, "... $rest methods not shown")
if hasname
print(io, " (use methods($name) to see them all)")
end
end
end
end
show(io::IO, ms::MethodList) = show_method_table(io, ms)
show(io::IO, mt::Core.MethodTable) = show_method_table(io, MethodList(mt))
function inbase(m::Module)
if m == Base
true
else
parent = parentmodule(m)
parent === m ? false : inbase(parent)
end
end
fileurl(file) = let f = find_source_file(file); f === nothing ? "" : "file://"*f; end
function url(m::Method)
M = m.module
(m.file == :null || m.file == :string) && return ""
file = string(m.file)
line = m.line
line <= 0 || occursin(r"In\[[0-9]+\]", file) && return ""
Sys.iswindows() && (file = replace(file, '\\' => '/'))
libgit2_id = PkgId(UUID((0x76f85450_5226_5b5a,0x8eaa_529ad045b433)), "LibGit2")
if inbase(M)
if isempty(Base.GIT_VERSION_INFO.commit)
# this url will only work if we're on a tagged release
return "https://github.com/JuliaLang/julia/tree/v$VERSION/base/$file#L$line"
else
return "https://github.com/JuliaLang/julia/tree/$(Base.GIT_VERSION_INFO.commit)/base/$file#L$line"
end
elseif root_module_exists(libgit2_id)
LibGit2 = root_module(libgit2_id)
try
d = dirname(file)
return LibGit2.with(LibGit2.GitRepoExt(d)) do repo
LibGit2.with(LibGit2.GitConfig(repo)) do cfg
u = LibGit2.get(cfg, "remote.origin.url", "")
u = match(LibGit2.GITHUB_REGEX,u).captures[1]
commit = string(LibGit2.head_oid(repo))
root = LibGit2.path(repo)
if startswith(file, root) || startswith(realpath(file), root)
"https://github.com/$u/tree/$commit/"*file[length(root)+1:end]*"#L$line"
else
fileurl(file)
end
end
end
catch
return fileurl(file)
end
else
return fileurl(file)
end
end
function show(io::IO, ::MIME"text/html", m::Method; kwtype::Union{DataType, Nothing}=nothing)
tv, decls, file, line = arg_decl_parts(m)
sig = unwrap_unionall(m.sig)
ft0 = sig.parameters[1]
ft = unwrap_unionall(ft0)
d1 = decls[1]
if ft <: Function && isa(ft, DataType) &&
isdefined(ft.name.module, ft.name.mt.name) &&
ft0 === typeof(getfield(ft.name.module, ft.name.mt.name))
print(io, ft.name.mt.name)
elseif isa(ft, DataType) && ft.name === Type.body.name
f = ft.parameters[1]
if isa(f, DataType) && isempty(f.parameters)
print(io, f)
else
print(io, "(", d1[1], "::<b>", d1[2], "</b>)")
end
else
print(io, "(", d1[1], "::<b>", d1[2], "</b>)")
end
print(io, "(")
join(io, [isempty(d[2]) ? d[1] : d[1]*"::<b>"*d[2]*"</b>"
for d in decls[2:end]], ", ", ", ")
if kwtype !== nothing
kwargs = kwarg_decl(m, kwtype)
if !isempty(kwargs)
print(io, "; <i>")
join(io, kwargs, ", ", ", ")
print(io, "</i>")
end
end
print(io, ")")
if !isempty(tv)
print(io,"<i>")
show_method_params(io, tv)
print(io,"</i>")
end
print(io, " in ", m.module)
if line > 0
try
file, line = invokelatest(methodloc_callback[], m)
catch
end
u = url(m)
if isempty(u)
print(io, " at ", file, ":", line)
else
print(io, """ at <a href="$u" target="_blank">""",
file, ":", line, "</a>")
end
end
end
function show(io::IO, mime::MIME"text/html", ms::MethodList)
mt = ms.mt
show_method_list_header(io, ms, str -> "<b>"*str*"</b>")
kwtype = isdefined(mt, :kwsorter) ? typeof(mt.kwsorter) : nothing
print(io, "<ul>")
for meth in ms
print(io, "<li> ")
show(io, mime, meth; kwtype=kwtype)
print(io, "</li> ")
end
print(io, "</ul>")
end
show(io::IO, mime::MIME"text/html", mt::Core.MethodTable) = show(io, mime, MethodList(mt))
# pretty-printing of AbstractVector{Method}
function show(io::IO, mime::MIME"text/plain", mt::AbstractVector{Method})
resize!(LAST_SHOWN_LINE_INFOS, 0)
first = true
for (i, m) in enumerate(mt)
first || println(io)
first = false
print(io, "[$(i)] ")
show(io, m)
file, line = m.file, m.line
try
file, line = invokelatest(methodloc_callback[], m)
catch
end
push!(LAST_SHOWN_LINE_INFOS, (string(file), line))
end
end
function show(io::IO, mime::MIME"text/html", mt::AbstractVector{Method})
summary(io, mt)
if !isempty(mt)
print(io, ":<ul>")
for d in mt
print(io, "<li> ")
show(io, mime, d)
end
print(io, "</ul>")
end
end