vieter-v
/
v
2
0
Fork 0
Code Issues Pull Requests Releases Activity

vdoc: document variables in a specific pos/scope; support `v doc os File` (#6354)

pull/6445/head
Ned Palacios 2020-09-21 22:40:39 +08:00 committed by GitHub
parent 8c0b8c5ef7
commit 744f685973
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 396 additions and 241 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

348
cmd/tools/vdoc.v
View File

@ -31,7 +31,7 @@ enum HighlightTokenTyp {
} }
const ( const (
css_js_assets = ['doc.css', 'normalize.css' 'doc.js'] css_js_assets = ['doc.css', 'normalize.css', 'doc.js']
allowed_formats = ['md', 'markdown', 'json', 'text', 'stdout', 'html', 'htm'] allowed_formats = ['md', 'markdown', 'json', 'text', 'stdout', 'html', 'htm']
exe_path = os.executable() exe_path = os.executable()
exe_dir = os.dir(exe_path) exe_dir = os.dir(exe_path)
@ -95,17 +95,21 @@ enum OutputType {
struct DocConfig { struct DocConfig {
mut: mut:
is_local bool
local_filename string
local_pos int
pub_only bool = true pub_only bool = true
show_loc bool // for plaintext show_loc bool // for plaintext
serve_http bool // for html serve_http bool // for html
is_multi bool is_multi bool
is_verbose bool is_verbose bool
include_readme bool include_readme bool
open_docs bool open_docs bool
server_port int = 8046 server_port int = 8046
inline_assets bool inline_assets bool
output_path string output_path string
input_path string input_path string
symbol_name string
output_type OutputType = .unset output_type OutputType = .unset
docs []doc.Doc docs []doc.Doc
manifest vmod.Manifest manifest vmod.Manifest
@ -150,7 +154,7 @@ fn (mut cfg DocConfig) serve_html() {
.json { 'application/json' } .json { 'application/json' }
else { 'text/plain' } else { 'text/plain' }
} }
server_context := VdocHttpServerContext { server_context := VdocHttpServerContext{
docs: docs docs: docs
content_type: content_type content_type: content_type
default_filename: def_name default_filename: def_name
@ -168,8 +172,8 @@ fn (mut cfg DocConfig) serve_html() {
} }
struct VdocHttpServerContext { struct VdocHttpServerContext {
docs map[string]string docs map[string]string
content_type string content_type string
default_filename string default_filename string
} }
@ -194,7 +198,7 @@ fn handle_http_connection(mut con net.Socket, ctx &VdocHttpServerContext) {
send_http_response(mut con, 200, ctx.content_type, ctx.docs[filename]) send_http_response(mut con, 200, ctx.content_type, ctx.docs[filename])
} }
fn send_http_response(mut con net.Socket, http_code int, content_type string, html string) { fn send_http_response(mut con net.Socket, http_code int, content_type, html string) {
content_length := html.len.str() content_length := html.len.str()
shttp_code := http_code.str() shttp_code := http_code.str()
mut http_response := strings.new_builder(20000) mut http_response := strings.new_builder(20000)
@ -217,7 +221,7 @@ fn send_http_response(mut con net.Socket, http_code int, content_type string, ht
} }
} }
fn get_src_link(repo_url string, file_name string, line_nr int) string { fn get_src_link(repo_url, file_name string, line_nr int) string {
mut url := urllib.parse(repo_url) or { mut url := urllib.parse(repo_url) or {
return '' return ''
} }
@ -230,7 +234,9 @@ fn get_src_link(repo_url string, file_name string, line_nr int) string {
'git.sir.ht' { '/tree/master/$file_name' } 'git.sir.ht' { '/tree/master/$file_name' }
else { '' } else { '' }
} }
if url.path == '/' { return '' } if url.path == '/' {
return ''
}
url.fragment = 'L$line_nr' url.fragment = 'L$line_nr'
return url.str() return url.str()
} }
@ -238,12 +244,16 @@ fn get_src_link(repo_url string, file_name string, line_nr int) string {
fn js_compress(str string) string { fn js_compress(str string) string {
mut js := strings.new_builder(200) mut js := strings.new_builder(200)
lines := str.split_into_lines() lines := str.split_into_lines()
rules := [') {', ' = ', ', ', '{ ', ' }', ' (', '; ', ' + ', ' < ', ' - ', ' || ', ' var', ': ', ' >= ', ' && ', ' else if', ' === ', ' !== ', ' else '] rules := [') {', ' = ', ', ', '{ ', ' }', ' (', '; ', ' + ', ' < ', ' - ', ' || ', ' var',
clean := ['){', '=', ',', '{', '}', '(', ';', '+', '<', '-', '||', 'var', ':', '>=', '&&', 'else if', '===', '!==', 'else'] ': ', ' >= ', ' && ', ' else if', ' === ', ' !== ', ' else ']
clean := ['){', '=', ',', '{', '}', '(', ';', '+', '<', '-', '||', 'var', ':', '>=', '&&',
'else if', '===', '!==', 'else']
for line in lines { for line in lines {
mut trimmed := line.trim_space() mut trimmed := line.trim_space()
if trimmed.starts_with('//') || (trimmed.starts_with('/*') && trimmed.ends_with('*/')) { continue } if trimmed.starts_with('//') || (trimmed.starts_with('/*') && trimmed.ends_with('*/')) {
for i in 0..rules.len-1 { continue
}
for i in 0 .. rules.len - 1 {
trimmed = trimmed.replace(rules[i], clean[i]) trimmed = trimmed.replace(rules[i], clean[i])
} }
js.write(trimmed) js.write(trimmed)
@ -252,29 +262,41 @@ fn js_compress(str string) string {
} }
fn escape(str string) string { fn escape(str string) string {
return str.replace_each(['"', '\\"', '\r\n', '\\n', '\n', '\\n']) return str.replace_each(['"', '\\"', '\r\n', '\\n', '\n', '\\n', '\t', '\\t'])
} }
fn (cfg DocConfig) gen_json(idx int) string { fn (cfg DocConfig) gen_json(idx int) string {
dcs := cfg.docs[idx] dcs := cfg.docs[idx]
mut jw := strings.new_builder(200) mut jw := strings.new_builder(200)
jw.writeln('{\n\t"module_name": "$dcs.head.name",\n\t"description": "${escape(dcs.head.comment)}",\n\t"contents": [') jw.write('{"module_name":"$dcs.head.name","description":"${escape(dcs.head.comment)}","contents":[')
for i, cn in dcs.contents { for i, cn in dcs.contents {
name := cn.name.all_after(dcs.head.name) name := cn.name.all_after(dcs.head.name)
jw.writeln('\t\t{') jw.write('{"name":"$name","signature":"${escape(cn.content)}",')
jw.writeln('\t\t\t"name": "$name",') jw.write('"description":"${escape(cn.comment)}",')
jw.writeln('\t\t\t"signature": "${escape(cn.content)}",') jw.write('"position":[$cn.pos.line,$cn.pos.col,$cn.pos.len],')
jw.writeln('\t\t\t"description": "${escape(cn.comment)}"') jw.write('"file_path":"$cn.file_path",')
jw.write('\t\t}') jw.write('"attrs":{')
if i < dcs.contents.len-1 { jw.writeln(',') } mut j := 0
for n, v in cn.attrs {
jw.write('"$n":"$v"')
if j < cn.attrs.len - 1 {
jw.write(',')
}
j++
}
jw.write('}')
jw.write('}')
if i < dcs.contents.len - 1 {
jw.write(',')
}
} }
jw.writeln('\n\t],') jw.write('],"generator":"vdoc","time_generated":"$dcs.time_generated.str()"}')
jw.write('\t"generator": "vdoc",\n\t"time_generated": "${dcs.time_generated.str()}"\n}')
return jw.str() return jw.str()
} }
fn html_highlight(code string, tb &table.Table) string { fn html_highlight(code string, tb &table.Table) string {
builtin := ['bool', 'string', 'i8', 'i16', 'int', 'i64', 'i128', 'byte', 'u16', 'u32', 'u64', 'u128', 'rune', 'f32', 'f64', 'any_int', 'any_float', 'byteptr', 'voidptr', 'any'] builtin := ['bool', 'string', 'i8', 'i16', 'int', 'i64', 'i128', 'byte', 'u16', 'u32', 'u64',
'u128', 'rune', 'f32', 'f64', 'any_int', 'any_float', 'byteptr', 'voidptr', 'any']
highlight_code := fn (tok token.Token, typ HighlightTokenTyp) string { highlight_code := fn (tok token.Token, typ HighlightTokenTyp) string {
lit := if typ in [.unone, .operator, .punctuation] { lit := if typ in [.unone, .operator, .punctuation] {
tok.kind.str() tok.kind.str()
@ -282,8 +304,14 @@ fn html_highlight(code string, tb &table.Table) string {
"'$tok.lit'" "'$tok.lit'"
} else if typ == .char { } else if typ == .char {
'`$tok.lit`' '`$tok.lit`'
} else { tok.lit } } else {
return if typ in [.unone, .name] { lit } else { '<span class="token $typ">$lit</span>' } tok.lit
}
return if typ in [.unone, .name] {
lit
} else {
'<span class="token $typ">$lit</span>'
}
} }
mut s := scanner.new_scanner(code, .parse_comments, &pref.Preferences{}) mut s := scanner.new_scanner(code, .parse_comments, &pref.Preferences{})
mut tok := s.scan() mut tok := s.scan()
@ -320,14 +348,14 @@ fn html_highlight(code string, tb &table.Table) string {
.key_true, .key_false { .key_true, .key_false {
tok_typ = .boolean tok_typ = .boolean
} }
.lpar, .lcbr, .rpar, .rcbr, .lsbr, .lpar, .lcbr, .rpar, .rcbr, .lsbr, .rsbr, .semicolon, .colon, .comma, .dot {
.rsbr, .semicolon, .colon, .comma, .dot {
tok_typ = .punctuation tok_typ = .punctuation
} }
else { else {
if token.is_key(tok.lit) || token.is_decl(tok.kind) { if token.is_key(tok.lit) || token.is_decl(tok.kind) {
tok_typ = .keyword tok_typ = .keyword
} else if tok.kind == .decl_assign || tok.kind.is_assign() || tok.is_unary() || tok.kind.is_relational() || tok.kind.is_infix() { } else if tok.kind == .decl_assign || tok.kind.is_assign() || tok.is_unary() ||
tok.kind.is_relational() || tok.kind.is_infix() {
tok_typ = .operator tok_typ = .operator
} }
} }
@ -355,11 +383,8 @@ fn doc_node_html(dd doc.DocNode, link string, head bool, tb &table.Table) string
md_content := markdown.to_html(dd.comment) md_content := markdown.to_html(dd.comment)
hlighted_code := html_highlight(dd.content, tb) hlighted_code := html_highlight(dd.content, tb)
node_class := if dd.name == 'Constants' { ' const' } else { '' } node_class := if dd.name == 'Constants' { ' const' } else { '' }
sym_name := if dd.attrs.exists('parent') && dd.attrs['parent'] !in ['void', '', 'Constants'] { sym_name := if dd.attrs.exists('parent') && dd.attrs['parent'] !in ['void', '', 'Constants'] { dd.attrs['parent'] +
dd.attrs['parent'] + '.' + dd.name '.' + dd.name } else { dd.name }
} else {
dd.name
}
node_id := slug(sym_name) node_id := slug(sym_name)
hash_link := if !head { ' <a href="#$node_id">#</a>' } else { '' } hash_link := if !head { ' <a href="#$node_id">#</a>' } else { '' }
dnw.writeln('<section id="$node_id" class="doc-node$node_class">') dnw.writeln('<section id="$node_id" class="doc-node$node_class">')
@ -382,7 +407,9 @@ fn doc_node_html(dd doc.DocNode, link string, head bool, tb &table.Table) string
fn (cfg DocConfig) readme_idx() int { fn (cfg DocConfig) readme_idx() int {
for i, dc in cfg.docs { for i, dc in cfg.docs {
if dc.head.name != 'README' { continue } if dc.head.name != 'README' {
continue
}
return i return i
} }
return -1 return -1
@ -390,13 +417,13 @@ fn (cfg DocConfig) readme_idx() int {
fn write_toc(cn doc.DocNode, nodes []doc.DocNode, mut toc strings.Builder) { fn write_toc(cn doc.DocNode, nodes []doc.DocNode, mut toc strings.Builder) {
toc_slug := if cn.content.len == 0 { '' } else { slug(cn.name) } toc_slug := if cn.content.len == 0 { '' } else { slug(cn.name) }
toc.write('<li class="open"><a href="#$toc_slug">${cn.name}</a>') toc.write('<li class="open"><a href="#$toc_slug">$cn.name</a>')
children := nodes.find_children_of(cn.name) children := nodes.find_children_of(cn.name)
if cn.name != 'Constants' { if cn.name != 'Constants' {
toc.writeln(' <ul>') toc.writeln(' <ul>')
for child in children { for child in children {
cname := cn.name + '.' + child.name cname := cn.name + '.' + child.name
toc.writeln('<li><a href="#${slug(cname)}">${child.name}</a></li>') toc.writeln('<li><a href="#${slug(cname)}">$child.name</a></li>')
} }
toc.writeln('</ul>') toc.writeln('</ul>')
} }
@ -428,9 +455,11 @@ fn (cfg DocConfig) gen_html(idx int) string {
contents.writeln(doc_node_html(dcs.head, '', true, dcs.table)) contents.writeln(doc_node_html(dcs.head, '', true, dcs.table))
for cn in dcs.contents { for cn in dcs.contents {
cfg.write_content(&cn, &dcs, &contents) cfg.write_content(&cn, &dcs, &contents)
if cn.attrs['parent'] == 'Constants' || cn.attrs['category'] == 'Methods' { continue } if cn.attrs['parent'] == 'Constants' || cn.attrs['category'] == 'Methods' {
continue
}
write_toc(cn, dcs.contents, mut toc) write_toc(cn, dcs.contents, mut toc)
} // write head } // write head
// get resources // get resources
doc_css := cfg.get_resource(css_js_assets[0], true) doc_css := cfg.get_resource(css_js_assets[0], true)
normalize_css := cfg.get_resource(css_js_assets[1], true) normalize_css := cfg.get_resource(css_js_assets[1], true)
@ -441,21 +470,19 @@ fn (cfg DocConfig) gen_html(idx int) string {
arrow_icon := cfg.get_resource('arrow.svg', true) arrow_icon := cfg.get_resource('arrow.svg', true)
// write css // write css
version := if cfg.manifest.version.len != 0 { cfg.manifest.version } else { '' } version := if cfg.manifest.version.len != 0 { cfg.manifest.version } else { '' }
header_name := if cfg.is_multi && cfg.docs.len > 1 { header_name := if cfg.is_multi && cfg.docs.len > 1 { os.file_name(os.real_path(cfg.input_path)) } else { dcs.head.name }
os.file_name(os.real_path(cfg.input_path))
} else {
dcs.head.name
}
// write nav1 // write nav1
if cfg.is_multi || cfg.docs.len > 1 { if cfg.is_multi || cfg.docs.len > 1 {
mut submod_prefix := '' mut submod_prefix := ''
for i, doc in cfg.docs { for i, doc in cfg.docs {
if i-1 >= 0 && doc.head.name.starts_with(submod_prefix + '.') { if i - 1 >= 0 && doc.head.name.starts_with(submod_prefix + '.') {
continue continue
} }
names := doc.head.name.split('.') names := doc.head.name.split('.')
submod_prefix = if names.len > 1 { names[0] } else { doc.head.name } submod_prefix = if names.len > 1 { names[0] } else { doc.head.name }
href_name := if ('vlib' in cfg.input_path && doc.head.name == 'builtin' && !cfg.include_readme) || doc.head.name == 'README' { href_name := if ('vlib' in cfg.input_path &&
doc.head.name == 'builtin' && !cfg.include_readme) ||
doc.head.name == 'README' {
'./index.html' './index.html'
} else if submod_prefix !in cfg.docs.map(it.head.name) { } else if submod_prefix !in cfg.docs.map(it.head.name) {
'#' '#'
@ -471,14 +498,14 @@ fn (cfg DocConfig) gen_html(idx int) string {
} }
} }
active_class := if doc.head.name == dcs.head.name { ' active' } else { '' } active_class := if doc.head.name == dcs.head.name { ' active' } else { '' }
toc2.write('<li class="open$active_class"><div class="menu-row">$dropdown<a href="$href_name">${submod_prefix}</a></div>') toc2.write('<li class="open$active_class"><div class="menu-row">$dropdown<a href="$href_name">$submod_prefix</a></div>')
for j, cdoc in submodules { for j, cdoc in submodules {
if j == 0 { if j == 0 {
toc2.write('<ul>') toc2.write('<ul>')
} }
submod_name := cdoc.head.name.all_after(submod_prefix + '.') submod_name := cdoc.head.name.all_after(submod_prefix + '.')
sub_selected_classes := if cdoc.head.name == dcs.head.name { ' class="active"' } else { '' } sub_selected_classes := if cdoc.head.name == dcs.head.name { ' class="active"' } else { '' }
toc2.write('<li$sub_selected_classes><a href="./${cdoc.head.name}.html">${submod_name}</a></li>') toc2.write('<li$sub_selected_classes><a href="./${cdoc.head.name}.html">$submod_name</a></li>')
if j == submodules.len - 1 { if j == submodules.len - 1 {
toc2.write('</ul>') toc2.write('</ul>')
} }
@ -486,35 +513,33 @@ fn (cfg DocConfig) gen_html(idx int) string {
toc2.write('</li>') toc2.write('</li>')
} }
} }
return html_content return html_content.replace('{{ title }}', dcs.head.name).replace('{{ head_name }}',
.replace('{{ title }}', dcs.head.name) header_name).replace('{{ version }}', version).replace('{{ light_icon }}', light_icon).replace('{{ dark_icon }}',
.replace('{{ head_name }}', header_name) dark_icon).replace('{{ menu_icon }}', menu_icon).replace('{{ head_assets }}', if cfg.inline_assets {
.replace('{{ version }}', version) '\n <style>$doc_css</style>\n <style>$normalize_css</style>'
.replace('{{ light_icon }}', light_icon) } else {
.replace('{{ dark_icon }}', dark_icon) '\n <link rel="stylesheet" href="$doc_css" />\n <link rel="stylesheet" href="$normalize_css" />'
.replace('{{ menu_icon }}', menu_icon) }).replace('{{ toc_links }}', if cfg.is_multi || cfg.docs.len > 1 {
.replace('{{ head_assets }}', if cfg.inline_assets { toc2.str()
'\n <style>$doc_css</style>\n <style>$normalize_css</style>' } else {
} else { toc.str()
'\n <link rel="stylesheet" href="$doc_css" />\n <link rel="stylesheet" href="$normalize_css" />' }).replace('{{ contents }}', contents.str()).replace('{{ right_content }}', if cfg.is_multi &&
}) cfg.docs.len > 1 && dcs.head.name != 'README' {
.replace('{{ toc_links }}', if cfg.is_multi || cfg.docs.len > 1 { toc2.str() } else { toc.str() }) '<div class="doc-toc"><ul>' + toc.str() + '</ul></div>'
.replace('{{ contents }}', contents.str()) } else {
.replace('{{ right_content }}', if cfg.is_multi && cfg.docs.len > 1 && dcs.head.name != 'README' { ''
'<div class="doc-toc"><ul>' + toc.str() + '</ul></div>' }).replace('{{ footer_content }}', 'Powered by vdoc. Generated on: $time_gen').replace('{{ footer_assets }}',
} else { '' }) if cfg.inline_assets {
.replace('{{ footer_content }}', 'Powered by vdoc. Generated on: $time_gen') '<script>$doc_js</script>'
.replace('{{ footer_assets }}', if cfg.inline_assets { } else {
'<script>$doc_js</script>' '<script src="$doc_js"></script>'
} else { })
'<script src="$doc_js"></script>'
})
} }
fn (cfg DocConfig) gen_plaintext(idx int) string { fn (cfg DocConfig) gen_plaintext(idx int) string {
dcs := cfg.docs[idx] dcs := cfg.docs[idx]
mut pw := strings.new_builder(200) mut pw := strings.new_builder(200)
pw.writeln('${dcs.head.content}\n') pw.writeln('$dcs.head.content\n')
if dcs.head.comment.trim_space().len > 0 && !cfg.pub_only { if dcs.head.comment.trim_space().len > 0 && !cfg.pub_only {
pw.writeln(dcs.head.comment.split_into_lines().map(' ' + it).join('\n')) pw.writeln(dcs.head.comment.split_into_lines().map(' ' + it).join('\n'))
} }
@ -524,7 +549,7 @@ fn (cfg DocConfig) gen_plaintext(idx int) string {
pw.writeln(cn.comment.trim_space().split_into_lines().map(' ' + it).join('\n')) pw.writeln(cn.comment.trim_space().split_into_lines().map(' ' + it).join('\n'))
} }
if cfg.show_loc { if cfg.show_loc {
pw.writeln('Location: ${cn.file_path}:${cn.pos.line}') pw.writeln('Location: $cn.file_path:$cn.pos.line')
pw.write('\n') pw.write('\n')
} }
} }
@ -535,29 +560,30 @@ fn (cfg DocConfig) gen_markdown(idx int, with_toc bool) string {
dcs := cfg.docs[idx] dcs := cfg.docs[idx]
mut hw := strings.new_builder(200) mut hw := strings.new_builder(200)
mut cw := strings.new_builder(200) mut cw := strings.new_builder(200)
hw.writeln('# ${dcs.head.content}\n${dcs.head.comment}\n') hw.writeln('# $dcs.head.content\n$dcs.head.comment\n')
if with_toc { if with_toc {
hw.writeln('## Contents') hw.writeln('## Contents')
} }
for cn in dcs.contents { for cn in dcs.contents {
name := cn.name.all_after(dcs.head.name + '.') name := cn.name.all_after(dcs.head.name + '.')
if with_toc { if with_toc {
hw.writeln('- [#$name](${slug(name)})') hw.writeln('- [#$name](${slug(name)})')
} }
cw.writeln('## $name') cw.writeln('## $name')
cw.writeln('```v\n${cn.content}\n```${cn.comment}\n') cw.writeln('```v\n$cn.content\n```$cn.comment\n')
cw.writeln('[\[Return to contents\]](#Contents)\n') cw.writeln('[\[Return to contents\]](#Contents)\n')
} }
cw.writeln('#### Generated by vdoc. Last generated: ${dcs.time_generated.str()}') cw.writeln('#### Generated by vdoc. Last generated: $dcs.time_generated.str()')
return hw.str() + '\n' + cw.str() return hw.str() + '\n' + cw.str()
} }
fn (cfg DocConfig) render() map[string]string { fn (cfg DocConfig) render() map[string]string {
mut docs := map[string]string mut docs := map[string]string{}
for i, doc in cfg.docs { for i, doc in cfg.docs {
// since builtin is generated first, ignore it // since builtin is generated first, ignore it
mut name := if ('vlib' in cfg.input_path && doc.head.name == 'builtin' && !cfg.include_readme) || doc.head.name == 'README' { mut name := if ('vlib' in cfg.input_path &&
doc.head.name == 'builtin' && !cfg.include_readme) ||
doc.head.name == 'README' {
'index' 'index'
} else if !cfg.is_multi && !os.is_dir(cfg.output_path) { } else if !cfg.is_multi && !os.is_dir(cfg.output_path) {
os.file_name(cfg.output_path) os.file_name(cfg.output_path)
@ -595,7 +621,9 @@ fn (cfg DocConfig) get_readme(path string) string {
} }
readme_path := os.join_path(path, '${fname}.md') readme_path := os.join_path(path, '${fname}.md')
cfg.vprintln('Reading README file from $readme_path') cfg.vprintln('Reading README file from $readme_path')
readme_contents := os.read_file(readme_path) or { '' } readme_contents := os.read_file(readme_path) or {
''
}
return readme_contents return readme_contents
} }
@ -638,7 +666,7 @@ fn (mut cfg DocConfig) generate_docs_from_file() {
} else if cfg.output_type == .html && cfg.is_multi { } else if cfg.output_type == .html && cfg.is_multi {
cfg.docs << doc.Doc{ cfg.docs << doc.Doc{
head: doc.DocNode{ head: doc.DocNode{
name: 'README', name: 'README'
comment: readme_contents comment: readme_contents
} }
time_generated: time.now() time_generated: time.now()
@ -648,30 +676,66 @@ fn (mut cfg DocConfig) generate_docs_from_file() {
dirs := if cfg.is_multi { get_modules_list(cfg.input_path, []string{}) } else { [cfg.input_path] } dirs := if cfg.is_multi { get_modules_list(cfg.input_path, []string{}) } else { [cfg.input_path] }
for dirpath in dirs { for dirpath in dirs {
cfg.vprintln('Generating docs for ${dirpath}...') cfg.vprintln('Generating docs for ${dirpath}...')
mut dcs := doc.generate(dirpath, cfg.pub_only, true) or { if cfg.is_local && !cfg.is_multi {
mut err_msg := err dcs := doc.generate_from_pos(dirpath, cfg.local_filename, cfg.local_pos) or {
if errcode == 1 { mut err_msg := err
mod_list := get_modules_list(cfg.input_path, []string{}) if errcode == 1 {
println('Available modules:\n==================') mod_list := get_modules_list(cfg.input_path, []string{})
for mod in mod_list { println('Available modules:\n==================')
println(mod.all_after('vlib/').all_after('modules/').replace('/', '.')) for mod in mod_list {
println(mod.all_after('vlib/').all_after('modules/').replace('/',
'.'))
}
err_msg += ' Use the `-m` flag when generating docs from a directory that has multiple modules.'
} }
err_msg += ' Use the `-m` flag if you are generating docs of a directory containing multiple modules.' eprintln(err_msg)
exit(1)
} }
eprintln(err_msg) if dcs.contents.len == 0 {
exit(1) continue
}
if dcs.contents.len == 0 { continue }
if cfg.is_multi || (!cfg.is_multi && cfg.include_readme) {
readme_contents := cfg.get_readme(dirpath)
dcs.head.comment = readme_contents
}
if cfg.pub_only {
for i, c in dcs.contents {
dcs.contents[i].content = c.content.all_after('pub ')
} }
cfg.docs << dcs
} else {
mut dcs := doc.generate(dirpath, cfg.pub_only, true) or {
mut err_msg := err
if errcode == 1 {
mod_list := get_modules_list(cfg.input_path, []string{})
println('Available modules:\n==================')
for mod in mod_list {
println(mod.all_after('vlib/').all_after('modules/').replace('/',
'.'))
}
err_msg += ' Use the `-m` flag when generating docs from a directory that has multiple modules.'
}
eprintln(err_msg)
exit(1)
}
if dcs.contents.len == 0 {
continue
}
if cfg.is_multi || (!cfg.is_multi && cfg.include_readme) {
readme_contents := cfg.get_readme(dirpath)
dcs.head.comment = readme_contents
}
if cfg.pub_only {
for i, c in dcs.contents {
dcs.contents[i].content = c.content.all_after('pub ')
}
}
if !cfg.is_multi && cfg.symbol_name.len > 0 {
mut new_contents := []doc.DocNode{}
for cn in dcs.contents {
if cn.name != cfg.symbol_name {
continue
}
new_contents << cn
break
}
new_contents << dcs.contents.find_children_of(cfg.symbol_name)
dcs.contents = new_contents
}
cfg.docs << dcs
} }
cfg.docs << dcs
} }
if 'vlib' in cfg.input_path { if 'vlib' in cfg.input_path {
mut docs := cfg.docs.filter(it.head.name == 'builtin') mut docs := cfg.docs.filter(it.head.name == 'builtin')
@ -683,7 +747,7 @@ fn (mut cfg DocConfig) generate_docs_from_file() {
return return
} }
cfg.vprintln('Rendering docs...') cfg.vprintln('Rendering docs...')
if cfg.output_path.len == 0 { if cfg.output_path.len == 0 || cfg.output_path == 'stdout' {
outputs := cfg.render() outputs := cfg.render()
if outputs.len == 0 { if outputs.len == 0 {
println('No documentation for $dirs') println('No documentation for $dirs')
@ -723,21 +787,11 @@ fn (mut cfg DocConfig) generate_docs_from_file() {
fn (mut cfg DocConfig) set_output_type_from_str(format string) { fn (mut cfg DocConfig) set_output_type_from_str(format string) {
match format { match format {
'htm', 'html' { 'htm', 'html' { cfg.output_type = .html }
cfg.output_type = .html 'md', 'markdown' { cfg.output_type = .markdown }
} 'json' { cfg.output_type = .json }
'md', 'markdown' { 'stdout' { cfg.output_type = .stdout }
cfg.output_type = .markdown else { cfg.output_type = .plaintext }
}
'json' {
cfg.output_type = .json
}
'stdout' {
cfg.output_type = .stdout
}
else {
cfg.output_type = .plaintext
}
} }
cfg.vprintln('Setting output type to "$cfg.output_type"') cfg.vprintln('Setting output type to "$cfg.output_type"')
} }
@ -780,10 +834,12 @@ fn lookup_module(mod string) ?string {
vmodules_path := os.join_path(os.home_dir(), '.vmodules', mod_path) vmodules_path := os.join_path(os.home_dir(), '.vmodules', mod_path)
paths := [modules_dir, vlib_path, vmodules_path] paths := [modules_dir, vlib_path, vmodules_path]
for path in paths { for path in paths {
if os.is_dir_empty(path) { continue } if os.is_dir_empty(path) {
continue
}
return path return path
} }
return error('vdoc: Module "${mod}" not found.') return error('vdoc: Module "$mod" not found.')
} }
fn is_included(path string, ignore_paths []string) bool { fn is_included(path string, ignore_paths []string) bool {
@ -791,15 +847,21 @@ fn is_included(path string, ignore_paths []string) bool {
return true return true
} }
for ignore_path in ignore_paths { for ignore_path in ignore_paths {
if ignore_path !in path { continue } if ignore_path !in path {
continue
}
return false return false
} }
return true return true
} }
fn get_modules_list(path string, ignore_paths2 []string) []string { fn get_modules_list(path string, ignore_paths2 []string) []string {
files := os.ls(path) or { return []string{} } files := os.ls(path) or {
mut ignore_paths := get_ignore_paths(path) or { []string{} } return []string{}
}
mut ignore_paths := get_ignore_paths(path) or {
[]string{}
}
ignore_paths << ignore_paths2 ignore_paths << ignore_paths2
mut dirs := []string{} mut dirs := []string{}
for file in files { for file in files {
@ -807,7 +869,9 @@ fn get_modules_list(path string, ignore_paths2 []string) []string {
if os.is_dir(fpath) && is_included(fpath, ignore_paths) && !os.is_link(path) { if os.is_dir(fpath) && is_included(fpath, ignore_paths) && !os.is_link(path) {
dirs << get_modules_list(fpath, ignore_paths.filter(it.starts_with(fpath))) dirs << get_modules_list(fpath, ignore_paths.filter(it.starts_with(fpath)))
} else if fpath.ends_with('.v') && !fpath.ends_with('_test.v') { } else if fpath.ends_with('.v') && !fpath.ends_with('_test.v') {
if path in dirs { continue } if path in dirs {
continue
}
dirs << path dirs << path
} }
} }
@ -817,7 +881,9 @@ fn get_modules_list(path string, ignore_paths2 []string) []string {
fn (cfg DocConfig) get_resource(name string, minify bool) string { fn (cfg DocConfig) get_resource(name string, minify bool) string {
path := os.join_path(res_path, name) path := os.join_path(res_path, name)
mut res := os.read_file(path) or { panic('could not read $path') } mut res := os.read_file(path) or {
panic('could not read $path')
}
if minify { if minify {
if name.ends_with('.js') { if name.ends_with('.js') {
res = js_compress(res) res = js_compress(res)
@ -845,7 +911,9 @@ fn main() {
exit(0) exit(0)
} }
mut cfg := DocConfig{ mut cfg := DocConfig{
manifest: vmod.Manifest{ repo_url: '' } manifest: vmod.Manifest{
repo_url: ''
}
} }
for i := 0; i < args.len; i++ { for i := 0; i < args.len; i++ {
arg := args[i] arg := args[i]
@ -854,6 +922,11 @@ fn main() {
'-all' { '-all' {
cfg.pub_only = false cfg.pub_only = false
} }
'-filename' {
cfg.is_local = true
cfg.local_filename = cmdline.option(current_args, '-filename', '')
i++
}
'-f' { '-f' {
format := cmdline.option(current_args, '-f', '') format := cmdline.option(current_args, '-f', '')
allowed_str := allowed_formats.join(', ') allowed_str := allowed_formats.join(', ')
@ -875,12 +948,20 @@ fn main() {
} }
'-o' { '-o' {
opath := cmdline.option(current_args, '-o', '') opath := cmdline.option(current_args, '-o', '')
cfg.output_path = os.real_path(opath) cfg.output_path = if opath == 'stdout' { opath } else { os.real_path(opath) }
i++ i++
} }
'-open' { '-open' {
cfg.open_docs = true cfg.open_docs = true
} }
'-pos' {
if !cfg.is_local {
eprintln('vdoc: `-pos` is only allowed with `-filename` flag.')
exit(1)
}
cfg.local_pos = cmdline.option(current_args, '-pos', '').int()
i++
}
'-p' { '-p' {
s_port := cmdline.option(current_args, '-o', '') s_port := cmdline.option(current_args, '-o', '')
s_port_int := s_port.int() s_port_int := s_port.int()
@ -908,8 +989,14 @@ fn main() {
cfg.is_verbose = true cfg.is_verbose = true
} }
else { else {
cfg.input_path = arg if cfg.input_path.len < 1 {
break cfg.input_path = arg
} else {
cfg.symbol_name = arg
}
if i == args.len - 1 {
break
}
} }
} }
} }
@ -922,7 +1009,8 @@ fn main() {
} $else { } $else {
cfg.input_path = cfg.input_path.replace('\\', os.path_separator) cfg.input_path = cfg.input_path.replace('\\', os.path_separator)
} }
is_path := cfg.input_path.ends_with('.v') || cfg.input_path.split(os.path_separator).len > 1 || cfg.input_path == '.' is_path := cfg.input_path.ends_with('.v') || cfg.input_path.split(os.path_separator).len >
1 || cfg.input_path == '.'
if cfg.input_path == 'vlib' { if cfg.input_path == 'vlib' {
cfg.is_multi = true cfg.is_multi = true
cfg.input_path = os.join_path(vexe_path, 'vlib') cfg.input_path = os.join_path(vexe_path, 'vlib')

7
cmd/v/help/doc.txt
View File

@ -1,8 +1,9 @@
Usage: Usage:
v doc [flags] [module_name / folder / V file] v doc [flags] [module_name / folder / V file] [symbol name]
Examples: Examples:
v doc os v doc os
v doc os File
v doc -o math.html math v doc -o math.html math
v doc -m -f html vlib/ v doc -m -f html vlib/
@ -16,8 +17,12 @@ Options:
-h, -help Prints this help text. -h, -help Prints this help text.
-m Generate docs for modules listed in that folder. -m Generate docs for modules listed in that folder.
-o Specifies the output file/folder path where to store the generated docs. -o Specifies the output file/folder path where to store the generated docs.
Set it to "stdout" to print the output instead of saving the contents
to a file.
-readme Include README.md to docs if present. -readme Include README.md to docs if present.
-v Enables verbose logging. For debugging purposes. -v Enables verbose logging. For debugging purposes.
-filename Specifies the specific file to document.
-pos Specifies the position. Used with `-filename`.
For HTML mode: For HTML mode:
-inline-assets Embeds the contents of the CSS and JS assets into the webpage directly. -inline-assets Embeds the contents of the CSS and JS assets into the webpage directly.

282
vlib/v/doc/doc.v
View File

@ -4,6 +4,7 @@ import os
import strings import strings
import time import time
import v.ast import v.ast
import v.checker
import v.fmt import v.fmt
import v.parser import v.parser
import v.pref import v.pref
@ -17,18 +18,28 @@ pub mut:
input_path string input_path string
prefs &pref.Preferences = &pref.Preferences{} prefs &pref.Preferences = &pref.Preferences{}
table &table.Table = &table.Table{} table &table.Table = &table.Table{}
checker checker.Checker = checker.Checker{
table: 0
cur_fn: 0
pref: 0
}
pub_only bool = true pub_only bool = true
head DocNode head DocNode
with_comments bool = true with_comments bool = true
contents []DocNode contents []DocNode
fmt fmt.Fmt fmt fmt.Fmt
time_generated time.Time time_generated time.Time
with_pos bool
filename string
pos int
is_vlib bool
} }
pub struct DocPos { pub struct DocPos {
pub: pub:
line int line int
col int col int
len int
} }
pub struct DocNode { pub struct DocNode {
@ -36,7 +47,7 @@ pub mut:
name string name string
content string content string
comment string comment string
pos DocPos = DocPos{-1, -1} pos DocPos = DocPos{-1, -1, 0}
file_path string file_path string
attrs map[string]string attrs map[string]string
} }
@ -103,6 +114,7 @@ fn convert_pos(file_path string, pos token.Position) DocPos {
return DocPos{ return DocPos{
line: pos.line_nr + 1 line: pos.line_nr + 1
col: util.imax(1, column + 1) col: util.imax(1, column + 1)
len: pos.len
} }
} }
@ -175,6 +187,7 @@ pub fn new(input_path string) Doc {
is_debug: false is_debug: false
table: d.table table: d.table
} }
d.checker = checker.new_checker(d.table, d.prefs)
return d return d
} }
@ -282,9 +295,133 @@ fn get_parent_mod(dir string) ?string {
return file_ast.mod.name return file_ast.mod.name
} }
fn (mut d Doc) generate_from_ast(file_ast ast.File, orig_mod_name string) {
mut const_idx := -1
stmts := file_ast.stmts
d.fmt.file = file_ast
d.fmt.set_current_module_name(orig_mod_name)
d.fmt.process_file_imports(file_ast)
mut last_import_stmt_idx := 0
for sidx, stmt in stmts {
if stmt is ast.Import {
last_import_stmt_idx = sidx
}
}
mut prev_comments := []ast.Comment{}
mut imports_section := true
for sidx, stmt in stmts {
// eprintln('stmt typeof: ' + typeof(stmt))
if stmt is ast.ExprStmt {
if stmt.expr is ast.Comment as cmt {
prev_comments << cmt
continue
}
}
// TODO: Fetch head comment once
if stmt is ast.Module {
// the previous comments were probably a copyright/license one
module_comment := get_comment_block_right_before(prev_comments)
prev_comments = []
if !d.is_vlib && !module_comment.starts_with('Copyright (c)') {
if module_comment in ['', d.head.comment] {
continue
}
if d.head.comment != '' {
d.head.comment += '\n'
}
d.head.comment += module_comment
}
continue
}
if last_import_stmt_idx > 0 && sidx == last_import_stmt_idx {
// the accumulated comments were interspersed before/between the imports;
// just add them all to the module comment:
import_comments := merge_comments(prev_comments)
if d.head.comment != '' {
d.head.comment += '\n'
}
d.head.comment += import_comments
prev_comments = []
imports_section = false
}
if stmt is ast.Import {
continue
}
signature := d.get_signature(stmt, file_ast)
pos := d.get_pos(stmt)
mut name := d.get_name(stmt)
if (!signature.starts_with('pub') && d.pub_only) || stmt is ast.GlobalDecl {
prev_comments = []
continue
}
if name.starts_with(orig_mod_name + '.') {
name = name.all_after(orig_mod_name + '.')
}
mut node := DocNode{
name: name
content: signature
comment: ''
pos: convert_pos(file_ast.path, pos)
file_path: file_ast.path
}
if node.name.len == 0 && node.comment.len == 0 && node.content.len == 0 {
continue
}
if stmt is ast.FnDecl {
if stmt.is_deprecated {
continue
}
if stmt.receiver.typ != 0 {
node.attrs['parent'] = d.fmt.type_to_str(stmt.receiver.typ).trim_left('&')
p_idx := d.contents.index_by_name(node.attrs['parent'])
if p_idx == -1 && node.attrs['parent'] != 'void' {
d.contents << DocNode{
name: node.attrs['parent']
content: ''
comment: ''
attrs: {
'category': 'Structs'
}
}
}
}
}
if stmt is ast.ConstDecl {
if const_idx == -1 {
const_idx = sidx
} else {
node.attrs['parent'] = 'Constants'
}
}
match stmt {
ast.ConstDecl { node.attrs['category'] = 'Constants' }
ast.EnumDecl { node.attrs['category'] = 'Enums' }
ast.InterfaceDecl { node.attrs['category'] = 'Interfaces' }
ast.StructDecl { node.attrs['category'] = 'Structs' }
ast.TypeDecl { node.attrs['category'] = 'Typedefs' }
ast.FnDecl { node.attrs['category'] = if node.attrs['parent'] in ['void', ''] ||
!node.attrs.exists('parent') { 'Functions' } else { 'Methods' } }
else {}
}
d.contents << node
if d.with_comments && (prev_comments.len > 0) {
last_comment := d.contents[d.contents.len - 1].comment
cmt := last_comment + '\n' + get_comment_block_right_before(prev_comments)
d.contents[d.contents.len - 1].comment = cmt
}
prev_comments = []
}
}
fn (mut d Doc) expr_typ_to_string(ex ast.Expr) string {
expr_typ := d.checker.expr(ex)
return d.fmt.type_to_str(expr_typ)
}
fn (mut d Doc) generate() ?Doc { fn (mut d Doc) generate() ?Doc {
// get all files // get all files
base_path := if os.is_dir(d.input_path) { d.input_path } else { os.real_path(os.base_dir(d.input_path)) } base_path := if os.is_dir(d.input_path) { d.input_path } else { os.real_path(os.base_dir(d.input_path)) }
d.is_vlib = 'vlib' !in base_path
project_files := os.ls(base_path) or { project_files := os.ls(base_path) or {
return error_with_code(err, 0) return error_with_code(err, 0)
} }
@ -296,17 +433,22 @@ fn (mut d Doc) generate() ?Doc {
mut file_asts := []ast.File{} mut file_asts := []ast.File{}
// TODO: remove later for vlib // TODO: remove later for vlib
comments_mode := if d.with_comments { scanner.CommentsMode.toplevel_comments } else { scanner.CommentsMode.skip_comments } comments_mode := if d.with_comments { scanner.CommentsMode.toplevel_comments } else { scanner.CommentsMode.skip_comments }
mut fname_has_set := false
for file in v_files { for file in v_files {
file_ast := parser.parse_file(file, d.table, comments_mode, d.prefs, &ast.Scope{ file_ast := parser.parse_file(file, d.table, comments_mode, d.prefs, &ast.Scope{
parent: 0 parent: 0
}) })
if d.filename.len > 0 && d.filename in file && !fname_has_set {
d.filename = file
fname_has_set = true
}
file_asts << file_ast file_asts << file_ast
} }
mut module_name := '' mut module_name := ''
mut parent_mod_name := '' mut parent_mod_name := ''
mut orig_mod_name := '' mut orig_mod_name := ''
mut const_idx := -1
for i, file_ast in file_asts { for i, file_ast in file_asts {
d.checker.check(file_ast)
if i == 0 { if i == 0 {
parent_mod_name = get_parent_mod(base_path) or { parent_mod_name = get_parent_mod(base_path) or {
'' ''
@ -324,119 +466,29 @@ fn (mut d Doc) generate() ?Doc {
} else if file_ast.mod.name != orig_mod_name { } else if file_ast.mod.name != orig_mod_name {
continue continue
} }
stmts := file_ast.stmts d.generate_from_ast(file_ast, orig_mod_name)
d.fmt.file = file_ast if file_ast.path == d.filename {
d.fmt.set_current_module_name(orig_mod_name) lscope := file_ast.scope.innermost(d.pos)
d.fmt.process_file_imports(file_ast) for name, val in lscope.objects {
mut last_import_stmt_idx := 0 if val !is ast.Var {
for sidx, stmt in stmts {
if stmt is ast.Import {
last_import_stmt_idx = sidx
}
}
mut prev_comments := []ast.Comment{}
mut imports_section := true
for sidx, stmt in stmts {
// eprintln('stmt typeof: ' + typeof(stmt))
if stmt is ast.ExprStmt {
if stmt.expr is ast.Comment as cmt {
prev_comments << cmt
continue continue
} }
} vr_data := val as ast.Var
// TODO: Fetch head comment once vr_expr := vr_data.expr
if stmt is ast.Module { l_node := DocNode{
// the previous comments were probably a copyright/license one name: name
module_comment := get_comment_block_right_before(prev_comments) content: ''
prev_comments = [] comment: ''
if 'vlib' !in base_path && !module_comment.starts_with('Copyright (c)') { pos: convert_pos(file_ast.path, vr_data.pos)
if module_comment in ['', d.head.comment] { file_path: file_ast.path
continue attrs: {
} 'category': 'Variable'
if d.head.comment != '' { 'return_type': d.expr_typ_to_string(vr_expr)
d.head.comment += '\n' 'local': 'true'
}
d.head.comment += module_comment
}
continue
}
if last_import_stmt_idx > 0 && sidx == last_import_stmt_idx {
// the accumulated comments were interspersed before/between the imports;
// just add them all to the module comment:
import_comments := merge_comments(prev_comments)
if d.head.comment != '' {
d.head.comment += '\n'
}
d.head.comment += import_comments
prev_comments = []
imports_section = false
}
if stmt is ast.Import {
continue
}
signature := d.get_signature(stmt, file_ast)
pos := d.get_pos(stmt)
mut name := d.get_name(stmt)
if (!signature.starts_with('pub') && d.pub_only) || stmt is ast.GlobalDecl {
prev_comments = []
continue
}
if name.starts_with(orig_mod_name + '.') {
name = name.all_after(orig_mod_name + '.')
}
mut node := DocNode{
name: name
content: signature
comment: ''
pos: convert_pos(v_files[i], pos)
file_path: v_files[i]
}
if node.name.len == 0 && node.comment.len == 0 && node.content.len == 0 {
continue
}
if stmt is ast.FnDecl {
if stmt.is_deprecated {
continue
}
if stmt.receiver.typ != 0 {
node.attrs['parent'] = d.fmt.type_to_str(stmt.receiver.typ).trim_left('&')
p_idx := d.contents.index_by_name(node.attrs['parent'])
if p_idx == -1 && node.attrs['parent'] != 'void' {
d.contents << DocNode{
name: node.attrs['parent']
content: ''
comment: ''
attrs: {
'category': 'Structs'
}
}
} }
} }
d.contents << l_node
} }
if stmt is ast.ConstDecl {
if const_idx == -1 {
const_idx = sidx
} else {
node.attrs['parent'] = 'Constants'
}
}
match stmt {
ast.ConstDecl { node.attrs['category'] = 'Constants' }
ast.EnumDecl { node.attrs['category'] = 'Enums' }
ast.InterfaceDecl { node.attrs['category'] = 'Interfaces' }
ast.StructDecl { node.attrs['category'] = 'Structs' }
ast.TypeDecl { node.attrs['category'] = 'Typedefs' }
ast.FnDecl { node.attrs['category'] = if node.attrs['parent'] in ['void', ''] ||
!node.attrs.exists('parent') { 'Functions' } else { 'Methods' } }
else {}
}
d.contents << node
if d.with_comments && (prev_comments.len > 0) {
last_comment := d.contents[d.contents.len - 1].comment
cmt := last_comment + '\n' + get_comment_block_right_before(prev_comments)
d.contents[d.contents.len - 1].comment = cmt
}
prev_comments = []
} }
d.fmt.mod2alias = map[string]string{} d.fmt.mod2alias = map[string]string{}
} }
@ -446,6 +498,16 @@ fn (mut d Doc) generate() ?Doc {
return *d return *d
} }
pub fn generate_from_pos(input_path, filename string, pos int) ?Doc {
mut doc := new(input_path)
doc.pub_only = false
doc.with_comments = true
doc.with_pos = true
doc.filename = filename
doc.pos = pos
return doc.generate()
}
pub fn generate(input_path string, pub_only, with_comments bool) ?Doc { pub fn generate(input_path string, pub_only, with_comments bool) ?Doc {
mut doc := new(input_path) mut doc := new(input_path)
doc.pub_only = pub_only doc.pub_only = pub_only