From 721a3a24aee2a71fb3d72de123401ba81628af4d Mon Sep 17 00:00:00 2001 From: Ned Palacios Date: Mon, 8 Jun 2020 16:28:46 +0800 Subject: [PATCH] vdoc: minor features + fixes --- cmd/tools/vdoc-resources/doc.js | 2 +- cmd/tools/vdoc.v | 104 ++++++++++++++++++++++---------- vlib/v/doc/doc.v | 8 +++ 3 files changed, 80 insertions(+), 34 deletions(-) diff --git a/cmd/tools/vdoc-resources/doc.js b/cmd/tools/vdoc-resources/doc.js index 6cb3062da0..70d89b0b47 100644 --- a/cmd/tools/vdoc-resources/doc.js +++ b/cmd/tools/vdoc-resources/doc.js @@ -6,7 +6,7 @@ active.scrollIntoView({ block: 'center', inline: 'nearest' }); } } - setupScrollSpy(); + // setupScrollSpy(); setupMobileToggle(); setupDarkMode(); setupSearch(); diff --git a/cmd/tools/vdoc.v b/cmd/tools/vdoc.v index 91b01173a0..32f3688b11 100644 --- a/cmd/tools/vdoc.v +++ b/cmd/tools/vdoc.v @@ -30,6 +30,7 @@ enum HighlightTokenTyp { } 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) @@ -134,6 +135,22 @@ fn get_src_link(repo_url string, file_name string, line_nr int) string { return url.str() } +fn js_compress(str string) string { + mut js := strings.new_builder(200) + lines := str.split_into_lines() + rules := [') {', ' = ', ', ', '{ ', ' }', ' (', '; ', ' + ', ' < '] + clean := ['){', '=', ',', '{', '}', '(', ';', '+', '<'] + for line in lines { + mut trimmed := line.trim_space() + if trimmed.starts_with('//') || (trimmed.starts_with('/*') && trimmed.ends_with('*/')) { continue } + for i, _ in rules { + 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']) } @@ -159,7 +176,13 @@ fn (cfg DocConfig) gen_json(idx int) 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'] highlight_code := fn (tok token.Token, typ HighlightTokenTyp) string { - lit := if typ in [.unone, .operator, .punctuation] { tok.kind.str() } else { tok.lit } + 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 { '$lit' } } s := scanner.new_scanner(code, .parse_comments) @@ -172,7 +195,7 @@ fn html_highlight(code string, tb &table.Table) string { mut tok_typ := HighlightTokenTyp.unone match tok.kind { .name { - if tok.lit in builtin { + if tok.lit in builtin || tb.known_type(tok.lit) { tok_typ = .builtin } else if next_tok.kind == .lcbr { tok_typ = .symbol @@ -239,7 +262,7 @@ fn doc_node_html(dd doc.DocNode, link string, head bool, tb &table.Table) string node_id := slug(sym_name) hash_link := if !head { ' #' } else { '' } dnw.writeln('
') - if dd.name != 'README' { + if dd.name != 'README' && dd.parent_type != 'Constants' { dnw.write('
<$head_tag>$sym_name$hash_link') if link.len != 0 { dnw.write('$link_svg') @@ -256,31 +279,54 @@ fn doc_node_html(dd doc.DocNode, link string, head bool, tb &table.Table) string return dnw.str() } +fn write_toc(cn doc.DocNode, nodes []doc.DocNode, toc &strings.Builder) { + toc.write('
  • ${cn.name}') + children := nodes.find_children_of(cn.name) + if children.len != 0 && cn.name != 'Constants' { + toc.writeln('
      ') + for child in children { + cname := cn.name + '.' + child.name + toc.writeln('
    • ${child.name}
      • ') + } + toc.writeln('
    ') + } + toc.writeln('
    • ') +} + +fn (cfg DocConfig) write_content(cn &doc.DocNode, dcs &doc.Doc, hw &strings.Builder) { + base_dir := os.base_dir(os.real_path(cfg.input_path)) + file_path_name := cn.file_path.replace('$base_dir/', '') + src_link := get_src_link(cfg.manifest.repo_url, file_path_name, cn.pos.line) + children := dcs.contents.find_children_of(cn.name) + hw.write(doc_node_html(cn, src_link, false, dcs.table)) + if children.len != 0 { + 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 hw := strings.new_builder(200) mut toc := strings.new_builder(200) // generate toc first + const_node_idx := dcs.contents.index_by_name('Constants') or { -1 } + if const_node_idx != -1 { + write_toc(dcs.contents[const_node_idx], dcs.contents, &toc) + } for cn in dcs.contents { - if cn.parent_type !in ['void', ''] { continue } - toc.write('
  • ${cn.name}') - children := dcs.contents.find_children_of(cn.name) - if children.len != 0 && cn.name != 'Constants' { - toc.writeln('
      ') - for child in children { - cname := cn.name + '.' + child.name - toc.writeln('
    • ${child.name}
      • ') - } - toc.writeln('
    ') - } - toc.writeln('
    • ') + if cn.name == 'Constants' || cn.parent_type !in ['void', ''] { continue } + write_toc(cn, dcs.contents, &toc) } // write head // get resources - doc_css := cfg.get_resource('doc.css', true) - normalize_css := cfg.get_resource('normalize.css', true) - doc_js := cfg.get_resource('doc.js', false) + 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) @@ -369,20 +415,12 @@ fn (cfg DocConfig) gen_html(idx int) string { hw.write('\n\n') hw.write('
    \n
    \n') hw.write(doc_node_html(dcs.head, '', true, dcs.table)) + if const_node_idx != -1 { + cfg.write_content(&dcs.contents[const_node_idx], &dcs, &hw) + } for cn in dcs.contents { - if cn.parent_type !in ['void', ''] { continue } - base_dir := os.base_dir(os.real_path(cfg.input_path)) - file_path_name := cn.file_path.replace('$base_dir/', '') - hw.write(doc_node_html(cn, get_src_link(cfg.manifest.repo_url, file_path_name, cn.pos.line), false, dcs.table)) - - children := dcs.contents.find_children_of(cn.name) - - if children.len != 0 { - for child in children { - child_file_path_name := child.file_path.replace('$base_dir/', '') - hw.write(doc_node_html(child, get_src_link(cfg.manifest.repo_url, child_file_path_name, child.pos.line), false, dcs.table)) - } - } + if cn.parent_type !in ['void', ''] || cn.name == 'Constants' { continue } + cfg.write_content(&cn, &dcs, &hw) } hw.write('\n
    Powered by vdoc. Generated on: $time_gen
    \n
    \n') if cfg.is_multi && cfg.docs.len > 1 && dcs.head.name != 'README' { @@ -573,7 +611,7 @@ fn (mut cfg DocConfig) generate_docs_from_file() { panic(err) } } else { - for fname in ['doc.css', 'normalize.css' 'doc.js'] { + for fname in css_js_assets { os.rm(os.join_path(cfg.output_path, fname)) } } @@ -645,7 +683,7 @@ 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 { - res = res.replace('\n', ' ') + res = if name.ends_with('.js') { js_compress(res) } else { res.replace('\n', ' ') } } // TODO: Make SVG inline for now if cfg.inline_assets || path.ends_with('.svg') { diff --git a/vlib/v/doc/doc.v b/vlib/v/doc/doc.v index 2ebf552d45..194c0b7f3d 100644 --- a/vlib/v/doc/doc.v +++ b/vlib/v/doc/doc.v @@ -178,6 +178,14 @@ pub fn new(input_path string) Doc { } } +pub fn (nodes []DocNode) index_by_name(node_name string) ?int { + for i, node in nodes { + if node.name != node_name { continue } + return i + } + return error('Node with the name "$node_name" was not found.') +} + pub fn (nodes []DocNode) find_children_of(parent_type string) []DocNode { if parent_type.len == 0 { return []DocNode{}