-
Notifications
You must be signed in to change notification settings - Fork 13
/
harvest.jl
254 lines (204 loc) · 6.48 KB
/
harvest.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
# Parse function and type documentation from julia source files.
# Metadata parsed from a declarations's preceeding comment.
type DeclarationComment
description::String
args::Union(Dict, Nothing)
sections::Dict
function DeclarationComment(description)
new(description, nothing, Dict())
end
end
# pattern to extract comments immediately preceeding declarations:
const decl_comment_pat =
r"
((?:\h*\#[^\n]*\n)+)
\h*(function|immutable|type|const)\s+([A-Za-z_][A-Za-z0-9_?]*)
"xm
# pattern to strip leading whitespace and '#' characters from comments.
const comment_strip_pat = r"\h*\#+"
# Extract comments immediately preceeding declarations.
#
# Args:
# input: Text which is expected to be julia source code.
#
# Returns:
# A three-tuple of the form (decltype, name, comment), where
# decltype is one of "function", "immutable", "type".
#
function extract_declaration_comments(input::String)
mats = {}
for mat in eachmatch(decl_comment_pat, input)
push!(mats, (mat.captures[3],
replace(mat.captures[1], comment_strip_pat, "")))
end
mats
end
# Harvest declaration comments from a package
#
# Args:
# package: Name of a currently installed package.
#
# Returns:
# A dictionary mapping declared identifiers to DeclarationComment objects.
#
function harvest(package::String)
srcdir = joinpath(Pkg.dir(package), "src")
filenames = {}
for filename in walkdir(srcdir)
if match(r"\.jl$", filename) != nothing
push!(filenames, filename)
end
end
harvest(filenames)
end
# Extract and parse decleration-preceeding comments from a set of files.
#
# Args:
# filename: Names of julia source files to harvest from.
#
# Returns:
# A dictionary mapping declared identifiers to DeclarationComment objects.
#
function harvest(filenames::Vector)
declarations = Dict()
for filename in filenames
for (name, comment) in extract_declaration_comments(readall(filename))
declarations[name] = parse_comment(comment)
end
end
declarations
end
# Return a substring of input that is of equal or greater indentation than the
# line starting at i.
function get_indented_block(input::String, i::Integer=1)
output = IOBuffer()
n = length(input)
block_indent = 0
while i < n && (input[i] == ' ' || input[i] == '\t')
block_indent += 1
write(output, input[i])
i = nextind(input, i)
end
j = search(input, '\n', i)
if j == 0
j = n
end
write(output, input[i:j])
i = nextind(input, j)
while i < n
j = i
line_indent = 0
while j < n && (input[j] == ' ' || input[j] == '\t')
line_indent += 1
j = nextind(input, j)
end
k = search(input, '\n', j)
if k == 0
k = n
end
if line_indent < block_indent && j < k
break
end
write(output, input[i:k])
i = nextind(input, k)
end
takebuf_string(output)
end
# TODO: We should not just take fixed section names. Anything should be allowed.
# pattern used to find fileds in a function declaration comment
const func_field_pat = r"^\h*(Args|Returns|Modifies|Throws)\s*:\h*\r?\n"im
# Parse a function declaration comment
#
# Args:
# input: Comment preceeding a funciton declaration, stripped of the leading
# '#' characters.
#
# Returns:
# A DeclarationComment object.
#
function parse_comment(input::String)
mat = match(func_field_pat, input)
if mat == nothing
return DeclarationComment(strip(input))
end
metadata = DeclarationComment(input[1:mat.offset-1])
while mat != nothing
typ = mat.captures[1]
if typ == "Args"
args = get_indented_block(input, mat.offset + length(mat.match))
offset = mat.offset + length(args)
metadata.args = parse_comment_args(args)
else
section = strip(get_indented_block(input, mat.offset + length(mat.match)))
metadata.sections[typ] = section
offset = mat.offset + length(section)
end
mat = match(func_field_pat, input, offset)
end
metadata
end
# pattern to match argument names/descriptions.
const arg_desc_pat = r"^(\h*)([\w_][\w\d_\!]*)\h*:\h*(.*)\r?"m
# Parse the "Args" section of a function declaration comment.
#
# Args:
# input: Everything under the "Args" block.
#
# Returns:
# A dictionary mapping arugment names to their descriptions.
#
function parse_comment_args(input::String)
args = Dict()
mat = match(arg_desc_pat, input)
while mat != nothing
indent = length(mat.captures[1])
name = mat.captures[2]
desc = IOBuffer()
write(desc, mat.captures[3])
offset = mat.offset + length(mat.match)
if offset < length(input) && input[offset] == '\n'
offset = nextind(input, offset)
next_line_indent = 0
i = offset
while i < length(input) && (input[i] == ' ' || input[i] == '\t')
next_line_indent += 1
i = nextind(input, i)
end
if next_line_indent > indent
desc_rest = get_indented_block(input, offset)
write(desc, desc_rest)
offset += length(desc_rest)
end
end
args[name] = takebuf_string(desc)
mat = match(arg_desc_pat, input, offset)
end
args
end
# Generate markdown for each declaration comment.
function generate_declaration_markdown(declarations::Dict)
declaration_markdown = Dict()
for (name, comment) in declarations
out = IOBuffer()
# TODO: in pandoc > 1.10 we can apply a class directly to a header
println(out, "<div class=\"api-doc\">")
println(out, comment.description)
if comment.args != nothing
println(out, "\n#### Args")
for (arg_name, arg_desc) in comment.args
@printf(out, " * `%s`: %s\n", arg_name, arg_desc)
end
end
for (section_name, section_content) in comment.sections
println(out, "\n#### ", section_name)
println(out, section_content)
end
println(out, "</div>")
declaration_markdown[name] = takebuf_string(out)
end
declaration_markdown
end
# Insert function declaration comments into a markdown document.
function expand_declaration_docs(input::String, declaration_markdown::Dict)
Mustache.render(input, declaration_markdown)
end