forked from JuliaLang/julia
-
Notifications
You must be signed in to change notification settings - Fork 0
/
help.jl
203 lines (182 loc) · 5.53 KB
/
help.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
module Help
export help, apropos, @help
MODULE_DICT = nothing
FUNCTION_DICT = nothing
function clear_cache()
global MODULE_DICT = nothing
global FUNCTION_DICT = nothing
end
function decor_help_desc(func::String, mfunc::String, desc::String)
sd = convert(Array{ByteString,1}, split(desc, '\n'))
for i = 1:length(sd)
if beginswith(sd[i], func)
sd[i] = mfunc * sd[i][length(func)+1:end]
else
break
end
end
return join(sd, '\n')
end
function helpdb_filename()
root = "$JULIA_HOME/../share/julia"
file = "helpdb.jl"
for loc in [Base.locale()]
fn = joinpath(root, loc, file)
if isfile(fn)
return fn
end
end
joinpath(root, file)
end
function init_help()
global MODULE_DICT, FUNCTION_DICT
if FUNCTION_DICT == nothing
helpdb = evalfile(helpdb_filename())
MODULE_DICT = Dict()
FUNCTION_DICT = Dict()
for (mod,func,desc) in helpdb
if !isempty(mod)
mfunc = mod * "." * func
desc = decor_help_desc(func, mfunc, desc)
else
mfunc = func
end
if !haskey(FUNCTION_DICT, mfunc)
FUNCTION_DICT[mfunc] = []
end
push!(FUNCTION_DICT[mfunc], desc)
if !haskey(MODULE_DICT, func)
MODULE_DICT[func] = []
end
if !in(mod, MODULE_DICT[func])
push!(MODULE_DICT[func], mod)
end
end
end
end
function help(io::IO)
print(io, """
Welcome to Julia. The full manual is available at
https://docs.julialang.org
To get help, try help(function), help("@macro"), or help("variable").
To search all help text, try apropos("string").
""")
end
function print_help_entries(io::IO, entries)
first = true
for desc in entries
if !first
println(io)
end
println(io, strip(desc))
first = false
end
end
func_expr_from_symbols(s::Vector{Symbol}) = length(s) == 1 ? s[1] : Expr(:., func_expr_from_symbols(s[1:end-1]), Expr(:quote, s[end]))
function help(io::IO, fname::String, obj=0)
init_help()
found = false
if haskey(FUNCTION_DICT, fname)
print_help_entries(io, FUNCTION_DICT[fname])
found = true
elseif haskey(MODULE_DICT, fname)
allmods = MODULE_DICT[fname]
alldesc = []
for mod in allmods
mfname = isempty(mod) ? fname : mod * "." * fname
if isgeneric(obj)
mf = eval(func_expr_from_symbols(map(symbol, split(mfname, "."))))
if mf === obj
append!(alldesc, FUNCTION_DICT[mfname])
found = true
end
else
append!(alldesc, FUNCTION_DICT[mfname])
found = true
end
end
found && print_help_entries(io, alldesc)
elseif haskey(FUNCTION_DICT, "Base." * fname)
print_help_entries(io, FUNCTION_DICT["Base." * fname])
found = true
end
if !found
if isa(obj, DataType)
print(io, "DataType : ")
writemime(io, "text/plain", obj)
println(io)
println(io, " supertype: ", super(obj))
if obj.abstract
st = subtypes(obj)
if length(st) > 0
print(io, " subtypes : ")
showcompact(io, st)
println(io)
end
end
if length(obj.names) > 0
println(io, " fields : ", obj.names)
end
elseif isgeneric(obj)
writemime(io, "text/plain", obj); println()
else
println(io, "Symbol not found. Falling back on apropos search ...")
apropos(io, fname)
end
end
end
apropos() = help()
apropos(s::String) = apropos(STDOUT, s)
function apropos(io::IO, txt::String)
init_help()
n = 0
r = Regex("\\Q$txt", Base.PCRE.CASELESS)
for (func, entries) in FUNCTION_DICT
if ismatch(r, func) || any(e->ismatch(r,e), entries)
for desc in entries
nl = search(desc,'\n')
if nl != 0
println(io, desc[1:(nl-1)])
else
println(io, desc)
end
end
n+=1
end
end
if n == 0
println(io, "No help information found.")
end
end
help(io::IO, f::Function) = help(io, string(f), f)
help(io::IO, t::DataType) = help(io, string(t.name), t)
help(io::IO, t::Module) = help(io, string(t))
function help(io::IO, x)
show(io, x)
t = typeof(x)
if isa(t,DataType)
println(io, " is of type")
help(io, t)
else
println(io, " is of type $t")
end
end
help(args...) = help(STDOUT, args...)
help(::IO, args...) = error("too many arguments to help()")
# check whether an expression is a qualified name, e.g. Base.FFTW.FORWARD
isname(n::Symbol) = true
isname(ex::Expr) = ((ex.head == :. && isname(ex.args[1]) && isname(ex.args[2]))
|| (ex.head == :quote && isname(ex.args[1])))
macro help(ex)
if ex === :? || ex === :help
return Expr(:call, :help)
elseif !isa(ex, Expr) || isname(ex)
return Expr(:call, :help, esc(ex))
elseif ex.head == :macrocall && length(ex.args) == 1
# e.g., "julia> @help @printf"
return Expr(:call, :help, string(ex.args[1]))
else
return Expr(:macrocall, symbol("@which"), esc(ex))
end
end
end # module