mirror of
https://github.com/vlang/v.git
synced 2023-08-10 21:13:21 +03:00
939 lines
26 KiB
V
939 lines
26 KiB
V
module main
|
|
|
|
import markdown
|
|
import net
|
|
import net.urllib
|
|
import os
|
|
import os.cmdline
|
|
import time
|
|
import strings
|
|
import v.doc
|
|
import v.scanner
|
|
import v.table
|
|
import v.token
|
|
import v.vmod
|
|
import v.pref
|
|
|
|
enum HighlightTokenTyp {
|
|
unone
|
|
boolean
|
|
builtin
|
|
char
|
|
comment
|
|
function
|
|
keyword
|
|
name
|
|
number
|
|
operator
|
|
punctuation
|
|
string
|
|
symbol
|
|
}
|
|
|
|
const (
|
|
css_js_assets = ['doc.css', 'normalize.css' 'doc.js']
|
|
allowed_formats = ['md', 'markdown', 'json', 'text', 'stdout', 'html', 'htm']
|
|
exe_path = os.executable()
|
|
exe_dir = os.dir(exe_path)
|
|
res_path = os.join_path(exe_dir, 'vdoc-resources')
|
|
vexe_path = os.base_dir(@VEXE)
|
|
html_content = '
|
|
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta http-equiv="x-ua-compatible" content="IE=edge" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<title>{{ title }} | vdoc</title>
|
|
<link href="https://fonts.googleapis.com/css2?family=Roboto:wght@400;500;700&display=swap" rel="stylesheet">
|
|
{{ head_assets }}
|
|
</head>
|
|
<body>
|
|
<div id="page">
|
|
<header class="doc-nav hidden">
|
|
<div class="heading-container">
|
|
<div class="heading">
|
|
<input type="text" id="search" placeholder="Search...">
|
|
<div class="module">{{ head_name }}</div>
|
|
<div class="toggle-version-container">
|
|
<span>{{ version }}</span>
|
|
<div id="dark-mode-toggle" role="switch" aria-checked="false" aria-label="Toggle dark mode">{{ light_icon }}{{ dark_icon }}</div>
|
|
</div>
|
|
{{ menu_icon }}
|
|
</div>
|
|
</div>
|
|
<nav class="content hidden">
|
|
<ul>
|
|
{{ toc_links }}
|
|
</ul>
|
|
</nav>
|
|
</header>
|
|
<div class="doc-container">
|
|
<div class="doc-content">
|
|
{{ contents }}
|
|
<div class="footer">
|
|
{{ footer_content }}
|
|
</div>
|
|
</div>
|
|
{{ right_content }}
|
|
</div>
|
|
</div>
|
|
{{ footer_assets }}
|
|
</body>
|
|
</html>
|
|
'
|
|
)
|
|
|
|
enum OutputType {
|
|
unset
|
|
html
|
|
markdown
|
|
json
|
|
plaintext
|
|
stdout
|
|
}
|
|
|
|
struct DocConfig {
|
|
mut:
|
|
pub_only bool = true
|
|
show_loc bool // for plaintext
|
|
serve_http bool // for html
|
|
is_multi bool
|
|
is_verbose bool
|
|
include_readme bool
|
|
open_docs bool
|
|
server_port int = 8046
|
|
inline_assets bool
|
|
output_path string
|
|
input_path string
|
|
output_type OutputType = .unset
|
|
docs []doc.Doc
|
|
manifest vmod.Manifest
|
|
}
|
|
|
|
fn slug(title string) string {
|
|
return title.replace(' ', '-')
|
|
}
|
|
|
|
fn open_url(url string) {
|
|
$if windows {
|
|
os.system('start $url')
|
|
}
|
|
$if macos {
|
|
os.system('open $url')
|
|
}
|
|
$if linux {
|
|
os.system('xdg-open $url')
|
|
}
|
|
}
|
|
|
|
fn (mut cfg DocConfig) serve_html() {
|
|
docs := cfg.render()
|
|
dkeys := docs.keys()
|
|
if dkeys.len < 1 {
|
|
eprintln('no documentation created, the module has no `pub` functions')
|
|
exit(1)
|
|
}
|
|
def_name := docs.keys()[0]
|
|
//
|
|
server_url := 'http://localhost:' + cfg.server_port.str()
|
|
server := net.listen(cfg.server_port) or {
|
|
panic(err)
|
|
}
|
|
println('Serving docs on: $server_url')
|
|
if cfg.open_docs {
|
|
open_url(server_url)
|
|
}
|
|
content_type := match cfg.output_type {
|
|
.html { 'text/html' }
|
|
.markdown { 'text/markdown' }
|
|
.json { 'application/json' }
|
|
else { 'text/plain' }
|
|
}
|
|
server_context := VdocHttpServerContext {
|
|
docs: docs
|
|
content_type: content_type
|
|
default_filename: def_name
|
|
}
|
|
for {
|
|
mut con := server.accept() or {
|
|
server.close() or { }
|
|
panic(err)
|
|
}
|
|
handle_http_connection(mut con, server_context)
|
|
con.close() or {
|
|
eprintln('error closing the connection: $err')
|
|
}
|
|
}
|
|
}
|
|
|
|
struct VdocHttpServerContext {
|
|
docs map[string]string
|
|
content_type string
|
|
default_filename string
|
|
}
|
|
|
|
fn handle_http_connection(mut con net.Socket, ctx &VdocHttpServerContext) {
|
|
s := con.read_line()
|
|
first_line := s.all_before('\r\n')
|
|
if first_line.len == 0 {
|
|
send_http_response(mut con, 501, ctx.content_type, 'bad request')
|
|
return
|
|
}
|
|
request_parts := first_line.split(' ')
|
|
if request_parts.len != 3 {
|
|
send_http_response(mut con, 501, ctx.content_type, 'bad request')
|
|
return
|
|
}
|
|
urlpath := request_parts[1]
|
|
filename := if urlpath == '/' { ctx.default_filename.trim_left('/') } else { urlpath.trim_left('/') }
|
|
if ctx.docs[filename].len == 0 {
|
|
send_http_response(mut con, 404, ctx.content_type, 'file not found')
|
|
return
|
|
}
|
|
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) {
|
|
content_length := html.len.str()
|
|
shttp_code := http_code.str()
|
|
mut http_response := strings.new_builder(20000)
|
|
http_response.write('HTTP/1.1 ')
|
|
http_response.write(shttp_code)
|
|
http_response.write(' OK\r\n')
|
|
http_response.write('Server: VDoc\r\n')
|
|
http_response.write('Content-Type: ')
|
|
http_response.write(content_type)
|
|
http_response.write('\r\n')
|
|
http_response.write('Content-Length: ')
|
|
http_response.write(content_length)
|
|
http_response.write('\r\n')
|
|
http_response.write('Connection: close\r\n')
|
|
http_response.write('\r\n')
|
|
http_response.write(html)
|
|
sresponse := http_response.str()
|
|
con.send_string(sresponse) or {
|
|
eprintln('error sending http response: $err')
|
|
}
|
|
}
|
|
|
|
fn get_src_link(repo_url string, file_name string, line_nr int) string {
|
|
mut url := urllib.parse(repo_url) or {
|
|
return ''
|
|
}
|
|
if url.path.len <= 1 || file_name.len == 0 {
|
|
return ''
|
|
}
|
|
url.path = url.path.trim_right('/') + match url.host {
|
|
'github.com' { '/blob/master/$file_name' }
|
|
'gitlab.com' { '/-/blob/master/$file_name' }
|
|
'git.sir.ht' { '/tree/master/$file_name' }
|
|
else { '' }
|
|
}
|
|
if url.path == '/' { return '' }
|
|
url.fragment = 'L$line_nr'
|
|
return url.str()
|
|
}
|
|
|
|
fn js_compress(str string) string {
|
|
mut js := strings.new_builder(200)
|
|
lines := str.split_into_lines()
|
|
rules := [') {', ' = ', ', ', '{ ', ' }', ' (', '; ', ' + ', ' < ', ' - ', ' || ', ' var', ': ', ' >= ', ' && ', ' else if', ' === ', ' !== ', ' else ']
|
|
clean := ['){', '=', ',', '{', '}', '(', ';', '+', '<', '-', '||', 'var', ':', '>=', '&&', 'else if', '===', '!==', 'else']
|
|
for line in lines {
|
|
mut trimmed := line.trim_space()
|
|
if trimmed.starts_with('//') || (trimmed.starts_with('/*') && trimmed.ends_with('*/')) { continue }
|
|
for i in 0..rules.len-1 {
|
|
trimmed = trimmed.replace(rules[i], clean[i])
|
|
}
|
|
js.write(trimmed)
|
|
}
|
|
return js.str()
|
|
}
|
|
|
|
fn escape(str string) string {
|
|
return str.replace_each(['"', '\\"', '\r\n', '\\n', '\n', '\\n'])
|
|
}
|
|
|
|
fn (cfg DocConfig) gen_json(idx int) string {
|
|
dcs := cfg.docs[idx]
|
|
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": [')
|
|
for i, cn in dcs.contents {
|
|
name := cn.name.all_after(dcs.head.name)
|
|
jw.writeln('\t\t{')
|
|
jw.writeln('\t\t\t"name": "$name",')
|
|
jw.writeln('\t\t\t"signature": "${escape(cn.content)}",')
|
|
jw.writeln('\t\t\t"description": "${escape(cn.comment)}"')
|
|
jw.write('\t\t}')
|
|
if i < dcs.contents.len-1 { jw.writeln(',') }
|
|
}
|
|
jw.writeln('\n\t],')
|
|
jw.write('\t"generator": "vdoc",\n\t"time_generated": "${dcs.time_generated.str()}"\n}')
|
|
return jw.str()
|
|
}
|
|
|
|
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']
|
|
highlight_code := fn (tok token.Token, typ HighlightTokenTyp) string {
|
|
lit := if typ in [.unone, .operator, .punctuation] {
|
|
tok.kind.str()
|
|
} else if typ == .string {
|
|
"'$tok.lit'"
|
|
} else if typ == .char {
|
|
'`$tok.lit`'
|
|
} else { 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 tok := s.scan()
|
|
mut next_tok := s.scan()
|
|
mut buf := strings.new_builder(200)
|
|
mut i := 0
|
|
for i < code.len {
|
|
if i == tok.pos {
|
|
mut tok_typ := HighlightTokenTyp.unone
|
|
match tok.kind {
|
|
.name {
|
|
if tok.lit in builtin || tb.known_type(tok.lit) {
|
|
tok_typ = .builtin
|
|
} else if next_tok.kind == .lcbr {
|
|
tok_typ = .symbol
|
|
} else if next_tok.kind == .lpar {
|
|
tok_typ = .function
|
|
} else {
|
|
tok_typ = .name
|
|
}
|
|
}
|
|
.comment {
|
|
tok_typ = .comment
|
|
}
|
|
.chartoken {
|
|
tok_typ = .char
|
|
}
|
|
.string {
|
|
tok_typ = .string
|
|
}
|
|
.number {
|
|
tok_typ = .number
|
|
}
|
|
.key_true, .key_false {
|
|
tok_typ = .boolean
|
|
}
|
|
.lpar, .lcbr, .rpar, .rcbr, .lsbr,
|
|
.rsbr, .semicolon, .colon, .comma, .dot {
|
|
tok_typ = .punctuation
|
|
}
|
|
else {
|
|
if token.is_key(tok.lit) || token.is_decl(tok.kind) {
|
|
tok_typ = .keyword
|
|
} else if tok.kind == .decl_assign || tok.kind.is_assign() || tok.is_unary() || tok.kind.is_relational() || tok.kind.is_infix() {
|
|
tok_typ = .operator
|
|
}
|
|
}
|
|
}
|
|
buf.write(highlight_code(tok, tok_typ))
|
|
if next_tok.kind != .eof {
|
|
i = tok.pos + tok.len
|
|
tok = next_tok
|
|
next_tok = s.scan()
|
|
} else {
|
|
break
|
|
}
|
|
} else {
|
|
buf.write_b(code[i])
|
|
i++
|
|
}
|
|
}
|
|
return buf.str()
|
|
}
|
|
|
|
fn doc_node_html(dd doc.DocNode, link string, head bool, tb &table.Table) string {
|
|
mut dnw := strings.new_builder(200)
|
|
link_svg := '<svg xmlns="http://www.w3.org/2000/svg" height="24" viewBox="0 0 24 24" width="24"><path d="M0 0h24v24H0z" fill="none"/><path d="M3.9 12c0-1.71 1.39-3.1 3.1-3.1h4V7H7c-2.76 0-5 2.24-5 5s2.24 5 5 5h4v-1.9H7c-1.71 0-3.1-1.39-3.1-3.1zM8 13h8v-2H8v2zm9-6h-4v1.9h4c1.71 0 3.1 1.39 3.1 3.1s-1.39 3.1-3.1 3.1h-4V17h4c2.76 0 5-2.24 5-5s-2.24-5-5-5z"/></svg>'
|
|
head_tag := if head { 'h1' } else { 'h2' }
|
|
md_content := markdown.to_html(dd.comment)
|
|
hlighted_code := html_highlight(dd.content, tb)
|
|
node_class := if dd.name == 'Constants' { ' const' } else { '' }
|
|
sym_name := if dd.attrs.exists('parent') && dd.attrs['parent'] !in ['void', '', 'Constants'] {
|
|
dd.attrs['parent'] + '.' + dd.name
|
|
} else {
|
|
dd.name
|
|
}
|
|
node_id := slug(sym_name)
|
|
hash_link := if !head { ' <a href="#$node_id">#</a>' } else { '' }
|
|
dnw.writeln('<section id="$node_id" class="doc-node$node_class">')
|
|
if dd.name != 'README' && dd.attrs['parent'] != 'Constants' {
|
|
dnw.write('<div class="title"><$head_tag>$sym_name$hash_link</$head_tag>')
|
|
if link.len != 0 {
|
|
dnw.write('<a class="link" rel="noreferrer" target="_blank" href="$link">$link_svg</a>')
|
|
}
|
|
dnw.write('</div>')
|
|
}
|
|
if head {
|
|
dnw.write(md_content)
|
|
} else {
|
|
dnw.writeln('<pre class="signature"><code>$hlighted_code</code></pre>')
|
|
dnw.writeln(md_content)
|
|
}
|
|
dnw.writeln('</section>')
|
|
return dnw.str()
|
|
}
|
|
|
|
fn (cfg DocConfig) readme_idx() int {
|
|
for i, dc in cfg.docs {
|
|
if dc.head.name != 'README' { continue }
|
|
return i
|
|
}
|
|
return -1
|
|
}
|
|
|
|
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.write('<li class="open"><a href="#$toc_slug">${cn.name}</a>')
|
|
children := nodes.find_children_of(cn.name)
|
|
if cn.name != 'Constants' {
|
|
toc.writeln(' <ul>')
|
|
for child in children {
|
|
cname := cn.name + '.' + child.name
|
|
toc.writeln('<li><a href="#${slug(cname)}">${child.name}</a></li>')
|
|
}
|
|
toc.writeln('</ul>')
|
|
}
|
|
toc.writeln('</li>')
|
|
}
|
|
|
|
fn (cfg DocConfig) write_content(cn &doc.DocNode, dcs &doc.Doc, mut hw strings.Builder) {
|
|
base_dir := os.base_dir(os.real_path(cfg.input_path))
|
|
file_path_name := if cfg.is_multi { cn.file_path.replace('$base_dir/', '') } else { os.file_name(cn.file_path) }
|
|
src_link := get_src_link(cfg.manifest.repo_url, file_path_name, cn.pos.line)
|
|
children := dcs.contents.find_children_of(cn.name)
|
|
if cn.content.len != 0 {
|
|
hw.write(doc_node_html(cn, src_link, false, dcs.table))
|
|
}
|
|
for child in children {
|
|
child_file_path_name := child.file_path.replace('$base_dir/', '')
|
|
child_src_link := get_src_link(cfg.manifest.repo_url, child_file_path_name, child.pos.line)
|
|
hw.write(doc_node_html(child, child_src_link, false, dcs.table))
|
|
}
|
|
}
|
|
|
|
fn (cfg DocConfig) gen_html(idx int) string {
|
|
dcs := cfg.docs[idx]
|
|
time_gen := '$dcs.time_generated.day $dcs.time_generated.smonth() $dcs.time_generated.year $dcs.time_generated.hhmmss()'
|
|
mut toc := strings.new_builder(200)
|
|
mut toc2 := strings.new_builder(200)
|
|
mut contents := strings.new_builder(200)
|
|
// generate toc first
|
|
contents.writeln(doc_node_html(dcs.head, '', true, dcs.table))
|
|
for cn in dcs.contents {
|
|
cfg.write_content(&cn, &dcs, &contents)
|
|
if cn.attrs['parent'] == 'Constants' || cn.attrs['category'] == 'Methods' { continue }
|
|
write_toc(cn, dcs.contents, mut toc)
|
|
} // write head
|
|
// get resources
|
|
doc_css := cfg.get_resource(css_js_assets[0], true)
|
|
normalize_css := cfg.get_resource(css_js_assets[1], true)
|
|
doc_js := cfg.get_resource(css_js_assets[2], !cfg.serve_http)
|
|
light_icon := cfg.get_resource('light.svg', true)
|
|
dark_icon := cfg.get_resource('dark.svg', true)
|
|
menu_icon := cfg.get_resource('menu.svg', true)
|
|
arrow_icon := cfg.get_resource('arrow.svg', true)
|
|
// write css
|
|
version := if cfg.manifest.version.len != 0 { cfg.manifest.version } else { '' }
|
|
header_name := if cfg.is_multi && cfg.docs.len > 1 {
|
|
os.file_name(os.real_path(cfg.input_path))
|
|
} else {
|
|
dcs.head.name
|
|
}
|
|
// write nav1
|
|
if cfg.is_multi || cfg.docs.len > 1 {
|
|
mut submod_prefix := ''
|
|
for i, doc in cfg.docs {
|
|
if i-1 >= 0 && doc.head.name.starts_with(submod_prefix + '.') {
|
|
continue
|
|
}
|
|
names := doc.head.name.split('.')
|
|
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' {
|
|
'./index.html'
|
|
} else if submod_prefix !in cfg.docs.map(it.head.name) {
|
|
'#'
|
|
} else {
|
|
'./' + doc.head.name + '.html'
|
|
}
|
|
submodules := cfg.docs.filter(it.head.name.starts_with(submod_prefix + '.'))
|
|
dropdown := if submodules.len > 0 { arrow_icon } else { '' }
|
|
mut is_submodule_open := false
|
|
for _, cdoc in submodules {
|
|
if cdoc.head.name == dcs.head.name {
|
|
is_submodule_open = true
|
|
}
|
|
}
|
|
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>')
|
|
for j, cdoc in submodules {
|
|
if j == 0 {
|
|
toc2.write('<ul>')
|
|
}
|
|
submod_name := cdoc.head.name.all_after(submod_prefix + '.')
|
|
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>')
|
|
if j == submodules.len - 1 {
|
|
toc2.write('</ul>')
|
|
}
|
|
}
|
|
toc2.write('</li>')
|
|
}
|
|
}
|
|
return html_content
|
|
.replace('{{ title }}', dcs.head.name)
|
|
.replace('{{ head_name }}', header_name)
|
|
.replace('{{ version }}', version)
|
|
.replace('{{ light_icon }}', light_icon)
|
|
.replace('{{ dark_icon }}', dark_icon)
|
|
.replace('{{ menu_icon }}', menu_icon)
|
|
.replace('{{ head_assets }}', if cfg.inline_assets {
|
|
'\n <style>$doc_css</style>\n <style>$normalize_css</style>'
|
|
} else {
|
|
'\n <link rel="stylesheet" href="$doc_css" />\n <link rel="stylesheet" href="$normalize_css" />'
|
|
})
|
|
.replace('{{ toc_links }}', if cfg.is_multi || cfg.docs.len > 1 { toc2.str() } else { toc.str() })
|
|
.replace('{{ contents }}', contents.str())
|
|
.replace('{{ right_content }}', if cfg.is_multi && cfg.docs.len > 1 && dcs.head.name != 'README' {
|
|
'<div class="doc-toc"><ul>' + toc.str() + '</ul></div>'
|
|
} else { '' })
|
|
.replace('{{ footer_content }}', 'Powered by vdoc. Generated on: $time_gen')
|
|
.replace('{{ footer_assets }}', if cfg.inline_assets {
|
|
'<script>$doc_js</script>'
|
|
} else {
|
|
'<script src="$doc_js"></script>'
|
|
})
|
|
}
|
|
|
|
fn (cfg DocConfig) gen_plaintext(idx int) string {
|
|
dcs := cfg.docs[idx]
|
|
mut pw := strings.new_builder(200)
|
|
pw.writeln('${dcs.head.content}\n')
|
|
if dcs.head.comment.trim_space().len > 0 && !cfg.pub_only {
|
|
pw.writeln(dcs.head.comment.split_into_lines().map(' ' + it).join('\n'))
|
|
}
|
|
for cn in dcs.contents {
|
|
pw.writeln(cn.content)
|
|
if cn.comment.len > 0 && !cfg.pub_only {
|
|
pw.writeln(cn.comment.trim_space().split_into_lines().map(' ' + it).join('\n'))
|
|
}
|
|
if cfg.show_loc {
|
|
pw.writeln('Location: ${cn.file_path}:${cn.pos.line}')
|
|
pw.write('\n')
|
|
}
|
|
}
|
|
return pw.str()
|
|
}
|
|
|
|
fn (cfg DocConfig) gen_markdown(idx int, with_toc bool) string {
|
|
dcs := cfg.docs[idx]
|
|
mut hw := strings.new_builder(200)
|
|
mut cw := strings.new_builder(200)
|
|
hw.writeln('# ${dcs.head.content}\n${dcs.head.comment}\n')
|
|
if with_toc {
|
|
hw.writeln('## Contents')
|
|
}
|
|
for cn in dcs.contents {
|
|
name := cn.name.all_after(dcs.head.name + '.')
|
|
|
|
if with_toc {
|
|
hw.writeln('- [#$name](${slug(name)})')
|
|
}
|
|
cw.writeln('## $name')
|
|
cw.writeln('```v\n${cn.content}\n```${cn.comment}\n')
|
|
cw.writeln('[\[Return to contents\]](#Contents)\n')
|
|
}
|
|
cw.writeln('#### Generated by vdoc. Last generated: ${dcs.time_generated.str()}')
|
|
return hw.str() + '\n' + cw.str()
|
|
}
|
|
|
|
fn (cfg DocConfig) render() map[string]string {
|
|
mut docs := map[string]string
|
|
for i, doc in cfg.docs {
|
|
// 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' {
|
|
'index'
|
|
} else if !cfg.is_multi && !os.is_dir(cfg.output_path) {
|
|
os.file_name(cfg.output_path)
|
|
} else {
|
|
doc.head.name
|
|
}
|
|
name = name + match cfg.output_type {
|
|
.html { '.html' }
|
|
.markdown { '.md' }
|
|
.json { '.json' }
|
|
else { '.txt' }
|
|
}
|
|
output := match cfg.output_type {
|
|
.html { cfg.gen_html(i) }
|
|
.markdown { cfg.gen_markdown(i, true) }
|
|
.json { cfg.gen_json(i) }
|
|
else { cfg.gen_plaintext(i) }
|
|
}
|
|
docs[name] = output.trim_space()
|
|
}
|
|
cfg.vprintln('Rendered: ' + docs.keys().str())
|
|
return docs
|
|
}
|
|
|
|
fn (cfg DocConfig) get_readme(path string) string {
|
|
mut fname := ''
|
|
for name in ['readme', 'README'] {
|
|
if os.exists(os.join_path(path, '${name}.md')) {
|
|
fname = name
|
|
break
|
|
}
|
|
}
|
|
if fname == '' {
|
|
return ''
|
|
}
|
|
readme_path := os.join_path(path, '${fname}.md')
|
|
cfg.vprintln('Reading README file from $readme_path')
|
|
readme_contents := os.read_file(readme_path) or { '' }
|
|
return readme_contents
|
|
}
|
|
|
|
fn (mut cfg DocConfig) generate_docs_from_file() {
|
|
if cfg.output_path.len == 0 {
|
|
if cfg.output_type == .unset {
|
|
cfg.output_type = .stdout
|
|
} else {
|
|
cfg.vprintln('No output path has detected. Using input path instead.')
|
|
cfg.output_path = cfg.input_path
|
|
}
|
|
} else if cfg.output_type == .unset {
|
|
cfg.vprintln('Output path detected. Identifying output type..')
|
|
ext := os.file_ext(cfg.output_path)
|
|
cfg.set_output_type_from_str(ext.all_after('.'))
|
|
}
|
|
if cfg.include_readme && cfg.output_type !in [.html, .stdout] {
|
|
eprintln('vdoc: Including README.md for doc generation is supported on HTML output, or when running directly in the terminal.')
|
|
exit(1)
|
|
}
|
|
is_vlib := 'vlib' in cfg.input_path
|
|
dir_path := if is_vlib {
|
|
vexe_path
|
|
} else if os.is_dir(cfg.input_path) {
|
|
cfg.input_path
|
|
} else {
|
|
os.base_dir(cfg.input_path)
|
|
}
|
|
manifest_path := os.join_path(dir_path, 'v.mod')
|
|
if os.exists(manifest_path) {
|
|
cfg.vprintln('Reading v.mod info from $manifest_path')
|
|
if manifest := vmod.from_file(manifest_path) {
|
|
cfg.manifest = manifest
|
|
}
|
|
}
|
|
if cfg.include_readme {
|
|
readme_contents := cfg.get_readme(dir_path)
|
|
if cfg.output_type == .stdout {
|
|
println(markdown.to_plain(readme_contents))
|
|
} else if cfg.output_type == .html && cfg.is_multi {
|
|
cfg.docs << doc.Doc{
|
|
head: doc.DocNode{
|
|
name: 'README',
|
|
comment: readme_contents
|
|
}
|
|
time_generated: time.now()
|
|
}
|
|
}
|
|
}
|
|
dirs := if cfg.is_multi { get_modules_list(cfg.input_path, []string{}) } else { [cfg.input_path] }
|
|
for dirpath in dirs {
|
|
cfg.vprintln('Generating docs for ${dirpath}...')
|
|
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 if you are generating docs of a directory containing 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 ')
|
|
}
|
|
}
|
|
cfg.docs << dcs
|
|
}
|
|
if 'vlib' in cfg.input_path {
|
|
mut docs := cfg.docs.filter(it.head.name == 'builtin')
|
|
docs << cfg.docs.filter(it.head.name != 'builtin')
|
|
cfg.docs = docs
|
|
}
|
|
if cfg.serve_http {
|
|
cfg.serve_html()
|
|
return
|
|
}
|
|
cfg.vprintln('Rendering docs...')
|
|
if cfg.output_path.len == 0 {
|
|
outputs := cfg.render()
|
|
if outputs.len == 0 {
|
|
println('No documentation for $dirs')
|
|
} else {
|
|
first := outputs.keys()[0]
|
|
println(outputs[first])
|
|
}
|
|
} else {
|
|
if !os.is_dir(cfg.output_path) {
|
|
cfg.output_path = os.real_path('.')
|
|
}
|
|
if !os.exists(cfg.output_path) {
|
|
os.mkdir(cfg.output_path) or {
|
|
panic(err)
|
|
}
|
|
}
|
|
if cfg.is_multi {
|
|
cfg.output_path = os.join_path(cfg.output_path, '_docs')
|
|
if !os.exists(cfg.output_path) {
|
|
os.mkdir(cfg.output_path) or {
|
|
panic(err)
|
|
}
|
|
} else {
|
|
for fname in css_js_assets {
|
|
os.rm(os.join_path(cfg.output_path, fname))
|
|
}
|
|
}
|
|
}
|
|
outputs := cfg.render()
|
|
for file_name, content in outputs {
|
|
output_path := os.join_path(cfg.output_path, file_name)
|
|
println('Generating ${output_path}...')
|
|
os.write_file(output_path, content)
|
|
}
|
|
}
|
|
}
|
|
|
|
fn (mut cfg DocConfig) set_output_type_from_str(format string) {
|
|
match format {
|
|
'htm', 'html' {
|
|
cfg.output_type = .html
|
|
}
|
|
'md', 'markdown' {
|
|
cfg.output_type = .markdown
|
|
}
|
|
'json' {
|
|
cfg.output_type = .json
|
|
}
|
|
'stdout' {
|
|
cfg.output_type = .stdout
|
|
}
|
|
else {
|
|
cfg.output_type = .plaintext
|
|
}
|
|
}
|
|
cfg.vprintln('Setting output type to "$cfg.output_type"')
|
|
}
|
|
|
|
fn (cfg DocConfig) vprintln(str string) {
|
|
if cfg.is_verbose {
|
|
println('vdoc: $str')
|
|
}
|
|
}
|
|
|
|
fn get_ignore_paths(path string) ?[]string {
|
|
ignore_file_path := os.join_path(path, '.vdocignore')
|
|
ignore_content := os.read_file(ignore_file_path) or {
|
|
return error_with_code('ignore file not found.', 1)
|
|
}
|
|
if ignore_content.trim_space().len > 0 {
|
|
rules := ignore_content.split_into_lines().map(it.trim_space())
|
|
mut final := []string{}
|
|
for rule in rules {
|
|
if rule.contains('*.') || rule.contains('**') {
|
|
println('vdoc: Wildcards in ignore rules are not allowed for now.')
|
|
continue
|
|
}
|
|
final << rule
|
|
}
|
|
return final.map(os.join_path(path, it.trim_right('/')))
|
|
} else {
|
|
mut dirs := os.ls(path) or {
|
|
return []string{}
|
|
}
|
|
return dirs.map(os.join_path(path, it)).filter(os.is_dir(it))
|
|
}
|
|
}
|
|
|
|
fn lookup_module(mod string) ?string {
|
|
mod_path := mod.replace('.', os.path_separator)
|
|
compile_dir := os.real_path(os.base_dir('.'))
|
|
modules_dir := os.join_path(compile_dir, 'modules', mod_path)
|
|
vlib_path := os.join_path(vexe_path, 'vlib', mod_path)
|
|
vmodules_path := os.join_path(os.home_dir(), '.vmodules', mod_path)
|
|
paths := [modules_dir, vlib_path, vmodules_path]
|
|
for path in paths {
|
|
if os.is_dir_empty(path) { continue }
|
|
return path
|
|
}
|
|
return error('vdoc: Module "${mod}" not found.')
|
|
}
|
|
|
|
fn is_included(path string, ignore_paths []string) bool {
|
|
if path.len == 0 {
|
|
return true
|
|
}
|
|
for ignore_path in ignore_paths {
|
|
if ignore_path !in path { continue }
|
|
return false
|
|
}
|
|
return true
|
|
}
|
|
|
|
fn get_modules_list(path string, ignore_paths2 []string) []string {
|
|
files := os.ls(path) or { return []string{} }
|
|
mut ignore_paths := get_ignore_paths(path) or { []string{} }
|
|
ignore_paths << ignore_paths2
|
|
mut dirs := []string{}
|
|
for file in files {
|
|
fpath := os.join_path(path, file)
|
|
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)))
|
|
} else if fpath.ends_with('.v') && !fpath.ends_with('_test.v') {
|
|
if path in dirs { continue }
|
|
dirs << path
|
|
}
|
|
}
|
|
dirs.sort()
|
|
return dirs
|
|
}
|
|
|
|
fn (cfg DocConfig) get_resource(name string, minify bool) string {
|
|
path := os.join_path(res_path, name)
|
|
mut res := os.read_file(path) or { panic('could not read $path') }
|
|
if minify {
|
|
if name.ends_with('.js') {
|
|
res = js_compress(res)
|
|
} else {
|
|
res = res.split_into_lines().map(it.trim_space()).join('')
|
|
}
|
|
}
|
|
// TODO: Make SVG inline for now
|
|
if cfg.inline_assets || path.ends_with('.svg') {
|
|
return res
|
|
} else {
|
|
output_path := os.join_path(cfg.output_path, name)
|
|
if !os.exists(output_path) {
|
|
println('Generating ${output_path}...')
|
|
os.write_file(output_path, res)
|
|
}
|
|
return name
|
|
}
|
|
}
|
|
|
|
fn main() {
|
|
args := os.args[2..].clone()
|
|
if args.len == 0 || args[0] in ['help', '-h', '--help'] {
|
|
os.system('${@VEXE} help doc')
|
|
exit(0)
|
|
}
|
|
mut cfg := DocConfig{
|
|
manifest: vmod.Manifest{ repo_url: '' }
|
|
}
|
|
for i := 0; i < args.len; i++ {
|
|
arg := args[i]
|
|
current_args := args[i..]
|
|
match arg {
|
|
'-all' {
|
|
cfg.pub_only = false
|
|
}
|
|
'-f' {
|
|
format := cmdline.option(current_args, '-f', '')
|
|
allowed_str := allowed_formats.join(', ')
|
|
if format !in allowed_formats {
|
|
eprintln('vdoc: "$format" is not a valid format. Only $allowed_str are allowed.')
|
|
exit(1)
|
|
}
|
|
cfg.set_output_type_from_str(format)
|
|
i++
|
|
}
|
|
'-inline-assets' {
|
|
cfg.inline_assets = true
|
|
}
|
|
'-l' {
|
|
cfg.show_loc = true
|
|
}
|
|
'-m' {
|
|
cfg.is_multi = true
|
|
}
|
|
'-o' {
|
|
opath := cmdline.option(current_args, '-o', '')
|
|
cfg.output_path = os.real_path(opath)
|
|
i++
|
|
}
|
|
'-open' {
|
|
cfg.open_docs = true
|
|
}
|
|
'-p' {
|
|
s_port := cmdline.option(current_args, '-o', '')
|
|
s_port_int := s_port.int()
|
|
if s_port.len == 0 {
|
|
eprintln('vdoc: No port number specified on "-p".')
|
|
exit(1)
|
|
}
|
|
if s_port != s_port_int.str() {
|
|
eprintln('vdoc: Invalid port number.')
|
|
exit(1)
|
|
}
|
|
cfg.server_port = s_port_int
|
|
}
|
|
'-s' {
|
|
cfg.inline_assets = true
|
|
cfg.serve_http = true
|
|
if cfg.output_type == .unset {
|
|
cfg.output_type = .html
|
|
}
|
|
}
|
|
'-readme' {
|
|
cfg.include_readme = true
|
|
}
|
|
'-v' {
|
|
cfg.is_verbose = true
|
|
}
|
|
else {
|
|
cfg.input_path = arg
|
|
break
|
|
}
|
|
}
|
|
}
|
|
if cfg.input_path.len == 0 {
|
|
eprintln('vdoc: No input path found.')
|
|
exit(1)
|
|
}
|
|
$if windows {
|
|
cfg.input_path = cfg.input_path.replace('/', os.path_separator)
|
|
} $else {
|
|
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 == '.'
|
|
if cfg.input_path == 'vlib' {
|
|
cfg.is_multi = true
|
|
cfg.input_path = os.join_path(vexe_path, 'vlib')
|
|
} else if !is_path {
|
|
cfg.vprintln('Input "$cfg.input_path" is not a valid path. Looking for modules named "$cfg.input_path"...')
|
|
mod_path := lookup_module(cfg.input_path) or {
|
|
eprintln(err)
|
|
exit(1)
|
|
}
|
|
cfg.input_path = mod_path
|
|
}
|
|
cfg.generate_docs_from_file()
|
|
}
|