v/vlib/v
zakuro 4089aa38c5
fmt: fix removal of `Abc` in `import mod { Abc }`, where `Abc` is used in a `x as Abc` expression #10306
2021-06-03 06:35:54 +03:00
..
ast all: move cur_concrete_types to Table (#10269) 2021-05-31 17:14:45 +03:00
builder builder: use some -cstrict flags only with clang (gcc does not understand them) 2021-05-23 21:00:48 +03:00
cflag all: improve unused variable warning (fix `x = 1`, `x += 1` etc) 2021-04-23 13:33:48 +03:00
checker parser: fix required function members in struct (#10299) 2021-06-03 02:55:58 +03:00
depgraph v.depgraph: fix ci/misc-tooling `./v -autofree -o v2 cmd/v` task 2021-05-20 07:24:13 +03:00
doc ci: fix `v build-tools` 2021-05-11 11:08:46 +03:00
embed_file ci: fix byteptr cast in embed_file.v 2021-04-05 07:27:26 +03:00
errors
eval
fmt fmt: fix removal of `Abc` in `import mod { Abc }`, where `Abc` is used in a `x as Abc` expression #10306 2021-06-03 06:35:54 +03:00
gen cgen: fix or_block in for declaration (#10317) 2021-06-03 01:18:52 +03:00
live examples: fix compilation with -prod 2021-04-23 14:48:07 +03:00
markused v.gen.c,v.markused: fix `println(ch)` when ch is a channel 2021-06-01 13:46:59 +03:00
parser parser: fix required function members in struct (#10299) 2021-06-03 02:55:58 +03:00
pkgconfig
pref v: replace execuast => executable 2021-05-31 09:39:18 +03:00
preludes v: replace execuast => executable 2021-05-31 09:39:18 +03:00
scanner parser: add support for flags in asm output constraints (#10103) 2021-05-14 12:01:15 +03:00
tests parser: fix required function members in struct (#10299) 2021-06-03 02:55:58 +03:00
token strings: simplify Builder (#10263) 2021-05-31 14:21:06 +03:00
util parser: fix mod_path_to_full_name to be compliant with --path option (#10149) 2021-05-25 07:46:40 +03:00
vcache v.vcache: another workaround for a tcc arm64 runtime bug 2021-04-07 19:13:05 +03:00
vet v vet: give an error for trailing whitespace (#9574) 2021-04-09 13:22:14 +03:00
vmod
README.md
TEMPLATES.md
compiler_errors_test.v v: replace `--enable-globals` with `-enable-globals` (#9898) 2021-04-28 07:44:28 +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)