v/vlib/v
Delyan Angelov fd91811fe2
v.util: add set_source_for_path/2 to enable external tools to use util.formatted_error on pathless sources
2022-03-01 18:55:25 +02:00
..
ast ast: add table.is_sumtype_or_in_variant() (#13615) 2022-02-28 11:38:20 +03:00
builder v.builder: fix cross compiling directory with spaces (#13522) 2022-02-19 10:08:41 +02:00
callgraph
cflag
checker checker: simplify for smartcast in for_stmt() (#13619) 2022-03-01 12:31:48 +02:00
depgraph
doc builtin: change IError `msg` and `code` to methods + fix vlib, add a deprecation notice for the old usages (#13041) 2022-02-11 15:52:33 +02:00
dotgraph
embed_file
errors
eval strconv: change atof64 to return an error, if the parsed value is not a valid number (#13424) 2022-02-10 13:27:32 +02:00
fmt fmt: keep trailing comments after fn header decl (#13596) 2022-02-25 16:36:48 +03:00
gen all: comptime_call - update tmpl scope vars with caller scope vars after their properties got updated in checker 2022-03-01 02:13:29 +11:00
live
markused all: initial implementation of compile-time types (#13549) 2022-02-21 17:42:54 +02:00
mathutil math: move the `math.mathutil` generic `min`/`max`/`abs` fns to `math` (#13042) 2022-01-05 18:02:20 +02:00
parser all: comptime_call - update tmpl scope vars with caller scope vars after their properties got updated in checker 2022-03-01 02:13:29 +11:00
pkgconfig builtin: change IError `msg` and `code` to methods + fix vlib, add a deprecation notice for the old usages (#13041) 2022-02-11 15:52:33 +02:00
pref cgen,pref: support `-profile-fns strings__new_builder,i64_str -profile -` 2022-01-26 20:39:47 +02:00
preludes
preludes_js
profile
scanner scanner: remove the restriction for \x00 in strings (#13493) 2022-02-16 23:41:05 +02:00
tests cgen: fix fn mut argument of interface type (#13616) 2022-02-28 13:31:04 +02:00
token
transformer builtin: change IError `msg` and `code` to methods + fix vlib, add a deprecation notice for the old usages (#13041) 2022-02-11 15:52:33 +02:00
util v.util: add set_source_for_path/2 to enable external tools to use util.formatted_error on pathless sources 2022-03-01 18:55:25 +02:00
vcache
vet
vmod
README.md
TEMPLATES.md
compiler_errors_test.v

README.md

Description

v is a namespace for all of the V compiler modules.

The V compiler modules can be used by V programs that want to process V source code in different ways, in fact, that is how various V tools are implemented: v fmt, v doc, v ast, vls, as well as the V compiler itself.

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)