v/vlib/v
yuyi 5c21c748c9
builder,checker,table: simpify generics unwrap and struct processing (#9531)
2021-03-30 15:23:17 +03:00
..
ast ast, parser: add additional info for CallExpr, StructInit nodes (#9526) 2021-03-30 09:43:17 +02:00
builder builder,checker,table: simpify generics unwrap and struct processing (#9531) 2021-03-30 15:23:17 +03:00
cflag
checker builder,checker,table: simpify generics unwrap and struct processing (#9531) 2021-03-30 15:23:17 +03:00
depgraph v.depgraph: ensure `v -d debug_realloc -o v cmd/v` works 2021-03-14 16:15:33 +02:00
doc vdoc: support -os and show docs according to the platform (#9474) 2021-03-27 09:50:06 +01:00
embed_file v.embed_file: add .to_string() and .to_bytes() utility methods 2021-03-20 09:30:38 +02:00
errors v: support compiler notices. Use them for `[deprecated_after: '2021-05-01']` tags 2021-03-22 19:59:00 +02:00
eval
fmt ast, parser: implement simple AST poisoning (#9525) 2021-03-30 09:33:29 +02:00
gen cgen: fix operator overloading for array/map aliases (#9529) 2021-03-30 11:39:54 +02:00
live fmt: minor array wrap improvement (#9420) 2021-03-22 23:06:12 +01:00
markused ast, parser: implement simple AST poisoning (#9525) 2021-03-30 09:33:29 +02:00
parser ast, parser: add additional info for CallExpr, StructInit nodes (#9526) 2021-03-30 09:43:17 +02:00
pkgconfig builtin,v.pkgconfig: use brew's libgc on macos 2021-03-25 07:28:30 +02:00
pref gc: make generational mode of Boehm-GC available (#9514) 2021-03-30 09:36:22 +02:00
preludes tests: support `fn test_fn() ? { opt()? }` 2021-03-05 14:18:21 +02:00
scanner scanner: fix eof token position (#9432) 2021-03-23 08:51:09 +01:00
table builder,checker,table: simpify generics unwrap and struct processing (#9531) 2021-03-30 15:23:17 +03:00
tests cgen: fix operator overloading for array/map aliases (#9529) 2021-03-30 11:39:54 +02:00
token scanner, token: add column information to tokens (#9407) 2021-03-23 06:23:46 +01:00
util tools: check formatting of more modules with `v test-cleancode`, colorize `v vet` output 2021-03-24 12:39:39 +02:00
vcache fmt: write empty or blocks the same as empty fn bodies, empty structs, etc (#9136) 2021-03-06 21:04:51 +02:00
vet
vmod v: support dump(expr) (#9160) 2021-03-06 18:09:28 +01:00
README.md checker: obey [ref_only] tag, allow embedding in other ref struct (#8707) 2021-02-13 00:47:37 +01:00
TEMPLATES.md tmpl: move to v/parser (#9052) 2021-03-15 13:35:55 +02:00
compiler_errors_test.v all: reimplement inline assembly (#8645) 2021-03-17 01:43:17 +01: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.table

table := table.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)