v/vlib/v
Delyan Angelov 8315e82188
checker: improve naming for `.stmts()` and `c.stmts_ending_with_expression()`, add a better explanation for their purpose
2021-11-27 08:09:36 +02:00
..
ast ast: cleanup table.v (#12561) 2021-11-24 09:56:56 +02:00
builder builder: prepare for `v -b native -os windows run file.v` 2021-11-26 12:05:58 +02:00
callgraph checker: add an interface check for mutability, fixes #1081, fixes #7038 (#11963) 2021-10-11 15:41:31 +03:00
cflag all: improve unused variable warning (fix `x = 1`, `x += 1` etc) 2021-04-23 13:33:48 +03:00
checker checker: improve naming for `.stmts()` and `c.stmts_ending_with_expression()`, add a better explanation for their purpose 2021-11-27 08:09:36 +02:00
depgraph strings,builder: reduce V cgen and parser memory consumption, fix strings.Builder leak (#12342) 2021-10-31 12:58:55 +02: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 fmt: remove unnecessary paren in assert stmt (#12546) 2021-11-23 07:30:54 +02:00
gen native: implement a working hello world compilation for w64 (#12577) 2021-11-26 19:03:15 +02:00
live os: move C struct declarations in their own _default.c.v files (#12268) 2021-10-22 17:08:08 +03:00
markused ast: change CompFor to ComptimeFor (#12482) 2021-11-17 08:29:43 +02:00
parser v.util,tools: use os.join_path_single 2021-11-22 21:42:55 +02:00
pkgconfig fmt: fix unnecessary line break in array init (fix #11448) (#11562) 2021-09-21 16:20:09 +03:00
pref vc: reduce further the average vc commit diff size 2021-11-22 16:46:28 +02: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 v.token,ast,scanner,parser: use a KeywordsMatcher lookup for builtin_type_names searches too 2021-11-07 16:39:40 +02:00
tests tests: test more edge cases for interfaces (#5292) 2021-11-26 11:10:03 +02:00
token v.token,ast,scanner,parser: use a KeywordsMatcher lookup for builtin_type_names searches too 2021-11-07 16:39:40 +02:00
transformer ast: change CompFor to ComptimeFor (#12482) 2021-11-17 08:29:43 +02:00
util v.util,tools: use os.join_path_single 2021-11-22 21:42:55 +02:00
vcache builder: make -usecache rebuild cached, but changed modules, and their dependants (#12193) 2021-10-15 12:22:59 +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 fmt: fix unnecessary line break in array init (fix #11448) (#11562) 2021-09-21 16:20:09 +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)