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

vdoc: parse with `enable_globals: true`

pull/6245/head
Delyan Angelov 2020-08-28 08:53:12 +03:00
parent 0975f3bd4c
commit d80843bf53
2 changed files with 26 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
vlib/.vdocignore
View File

@ -7,7 +7,6 @@ net/websocket/examples
uiold/ uiold/
v/tests/ v/tests/
v/checker/tests/ v/checker/tests/
v/gen/js/ v/gen/js/tests/
v/gen/x64/ v/gen/x64/tests/
v/gen/tests/ v/gen/tests/
sokol/sapp

33
vlib/v/doc/doc.v
View File

@ -153,10 +153,16 @@ pub fn (d Doc) get_name(stmt ast.Stmt) string {
} }
} }
pub fn new_vdoc_preferences() &pref.Preferences {
// vdoc should be able to parse as much user code as possible
// so its preferences should be permissive:
return &pref.Preferences{ enable_globals: true }
}
pub fn new(input_path string) Doc { pub fn new(input_path string) Doc {
mut d := Doc{ mut d := Doc{
input_path: os.real_path(input_path) input_path: os.real_path(input_path)
prefs: &pref.Preferences{} prefs: new_vdoc_preferences()
table: table.new_table() table: table.new_table()
head: DocNode{} head: DocNode{}
contents: []DocNode{} contents: []DocNode{}
@ -219,6 +225,12 @@ pub fn (nodes []DocNode) find_nodes_with_attr(attr_name, value string) []DocNode
return subgroup return subgroup
} }
// get_parent_mod - return the parent mod name, in dot format.
// It works by climbing up the folder hierarchy, until a folder,
// that either contains main .v files, or a v.mod file is reached.
// For example, given something like /languages/v/vlib/x/websocket/tests/autobahn
// it returns `x.websocket.tests`, because /languages/v/ has v.mod file in it.
// NB: calling this is expensive, so keep the result, instead of recomputing it.
fn get_parent_mod(dir string) ?string { fn get_parent_mod(dir string) ?string {
$if windows { $if windows {
// windows root path is C: or D: // windows root path is C: or D:
@ -231,20 +243,23 @@ fn get_parent_mod(dir string) ?string {
} }
} }
base_dir := os.base_dir(dir) base_dir := os.base_dir(dir)
if os.file_name(base_dir) in ['encoding', 'v'] && 'vlib' in base_dir { fname_base_dir := os.file_name(base_dir)
return os.file_name(base_dir) prefs := new_vdoc_preferences()
} fentries := os.ls(base_dir) or {
prefs := &pref.Preferences{}
files := os.ls(base_dir) or {
[]string{} []string{}
} }
files := fentries.filter(!os.is_dir(it))
if 'v.mod' in files {
// the top level is reached, no point in climbing up further
return ''
}
v_files := prefs.should_compile_filtered_files(base_dir, files) v_files := prefs.should_compile_filtered_files(base_dir, files)
if v_files.len == 0 { if v_files.len == 0 {
parent_mod := get_parent_mod(base_dir) or { parent_mod := get_parent_mod(base_dir) or {
'' return fname_base_dir
} }
if parent_mod.len > 0 { if parent_mod.len > 0 {
return parent_mod + '.' + os.file_name(base_dir) return parent_mod + '.' + fname_base_dir
} }
return error('No V files found.') return error('No V files found.')
} }
@ -257,7 +272,7 @@ fn get_parent_mod(dir string) ?string {
return '' return ''
} }
parent_mod := get_parent_mod(base_dir) or { parent_mod := get_parent_mod(base_dir) or {
'' return fname_base_dir
} }
if parent_mod.len > 0 { if parent_mod.len > 0 {
return parent_mod + '.' + file_ast.mod.name return parent_mod + '.' + file_ast.mod.name