v/vlib/v
Delyan Angelov df8a4a03a0
tests: support `// vtest retry: 4` for marking flaky tests
2021-09-18 11:48:32 +03:00
..
ast checker: require `params` attribute to use struct as keyword arguments in function (#11135) 2021-09-14 00:05:30 +03:00
builder v.builder: fix `-cc msvc -cflags /O2` and support CFLAGS and LDFLAGS env vars 2021-09-18 09:14:21 +03:00
callgraph v: support -show-depgraph in addition to -show-callgraph 2021-07-28 16:42:11 +03:00
cflag all: improve unused variable warning (fix `x = 1`, `x += 1` etc) 2021-04-23 13:33:48 +03:00
checker checker, cgen: generate .free() methods for custom structs automatically (#11529) 2021-09-18 09:38:42 +03:00
depgraph v: support -show-depgraph in addition to -show-callgraph 2021-07-28 16:42:11 +03:00
doc all: more chdir/chmod fixes 2021-08-28 12:52:48 +03:00
dotgraph v: support -show-depgraph in addition to -show-callgraph 2021-07-28 16:42:11 +03:00
embed_file ci: fix byteptr cast in embed_file.v 2021-04-05 07:27:26 +03:00
errors v.builder: implement a `-check` mode, that runs only the parser + the checker, without codegen (#11414) 2021-09-07 07:17:53 +03:00
eval all: a massive merge of ast and table modules 2021-04-02 01:57:09 +03:00
fmt v.fmt, v.gen.js: use 'if foo in [TypeA, TypeB]' in fmt.v and js.v (#11524) 2021-09-17 21:59:16 +03:00
gen checker, cgen: generate .free() methods for custom structs automatically (#11529) 2021-09-18 09:38:42 +03:00
live tests: support `// vtest retry: 4` for marking flaky tests 2021-09-18 11:48:32 +03:00
markused v.markused: remove __print_assert_failure from all_fn_root_names 2021-09-17 21:47:22 +03:00
parser all: implement `if foo in [Foo1, Foo2, Foo3]` (#11486) 2021-09-14 15:56:12 +03:00
pkgconfig vlib: remove deprecated map{} usages as well as deprecated functions (#11035) 2021-08-04 12:44:41 +03:00
pref v.builder: fix `-cc msvc -cflags /O2` and support CFLAGS and LDFLAGS env vars 2021-09-18 09:14:21 +03:00
preludes builtin: fix leak in rune.str(), fix leaks in most assert x == y statements in tests (#11091) 2021-08-13 18:37:34 +03:00
preludes_js v.gen.js: refactor code, fix alias codegen, `-stats` now again works with tests on the JS backend (#11512) 2021-09-16 14:00:15 +03:00
scanner scanner, fmt: fix multi-level generics (#11517) 2021-09-17 21:44:31 +03:00
tests tests: support `// vtest retry: 4` for marking flaky tests 2021-09-18 11:48:32 +03:00
token all: initial support for closures (x64 / linux-only) (#11114) 2021-08-10 21:27:15 +03:00
transformer v: add constant folding AST transformation (#11085) 2021-08-06 23:19:18 +03:00
util 0.2.4 2021-08-30 22:25:14 +03:00
vcache os: make chmod() return error 2021-08-28 09:37:24 +03:00
vet v vet: give an error for trailing whitespace (#9574) 2021-04-09 13:22:14 +03:00
vmod v.vmod: return errors instead of panic-ing 2021-08-16 16:54:41 +03:00
README.md all: a massive merge of ast and table modules 2021-04-02 01:57:09 +03:00
TEMPLATES.md tools: improve `v check-md` by checking for broken TOC headline links (#10417) 2021-06-14 13:12:02 +03:00
compiler_errors_test.v checker: require or block for sumtype map (#11089) 2021-09-10 16:07:39 +03:00

README.md

Compiler pipeline

A simple high level explanation how the compiler pipeline (parser -> checker -> generator) works.

Reading files

Getting builtin files

To load all builtin files, a preference Preferences.lookup_path for the path where to look for exists. See Builder.get_builtin_files as example. If the file is a .vsh file and the backend is C, vlib/os will also be loaded as builtin.

Getting project files

Either there is a specific file: my_file.v or a directory containing V files. In the last case it scans that directory for all files. See Builder.v_files_from_dir as the helper method. This list of files needs to be filtered so that only *.v files exist.

Skips the following file types:

  • *_test.v
  • either *.c.v or *.c.js depending on the backend
  • all files that doesn't end with .v
  • Files that are not defined in Preferences.compile_defines or Preferences.compile_defines_all if any file is defined.

Parsing files

To parse something a new template is created as the first step:

import v.ast

table := ast.new_table()

a new preference is created:

import v.pref

pref := &pref.Preferences{}

and a new scope is created:

import v.ast

scope := ast.Scope{
	parent: 0
}

after that, you can parse your files.

Parse text

If you want to parse only text which isn't saved on the disk you can use this function.

import v.parser

code := ''
// table, pref and scope needs to be passed as reference
parsed_file := parser.parse_text(code, table, .parse_comments, &pref, &scope)

Parse a single file

For parsing files on disk, a path needs to be provided. The paths are collected one step earlier.

import v.parser

path := ''
// table, pref and scope needs to be passed as reference
parsed_file := parser.parse_file(path, table, .parse_comments, &pref, &scope)

Parse a set of files

If you have a batch of paths available which should be parsed, there is also a function which does all the work.

import v.parser

paths := ['']
// table, pref and scope needs to be passed as reference
parsed_files := parser.parse_files(paths, table, &pref, &scope)

Parse imports

A file often contains imports. These imports might need to be parsed as well. The builder contains a method which does this: Builder.parse_imports.

If the module which is imported isn't parsed already, you have to collect it relatively from the main file. For this the ast.File contains a list of imports. Those imports needs to be found on disk. . is just replaced with seperators in the relative location of the main file. Then all files from that directory are collected and parsed again like the previous steps explained.

Checking AST

A new checker is created:

import v.checker

mut checker := checker.new_checker(table, &pref)

After checking your files in checker.errors and checker.warnings you can see the results.

Check ast.File

checker.check(parsed_file)

Check a list of ast.File

checker.check_files(parsed_files)

Generate target from AST

Generating C code works just as this:

import v.gen.c

res := c.gen(parsed_files, table, &pref)