v/vlib/v
yuyi 7622ff3f54
checker: check using const var as function (#13006)
2022-01-01 09:15:43 +02:00
..
ast all: add support for `type MyEnumAlias = MyEnum` 2021-12-30 13:42:06 +02:00
builder v.builder: fix `v -no-retry-compilation -cc tcc -usecache examples/tetris/` 2021-12-29 21:45:01 +02:00
callgraph ast: rename 'table.get_type_symbol()' to 'table.sym()' and more related calls (#12898) 2021-12-19 18:25:18 +02:00
cflag all: improve unused variable warning (fix `x = 1`, `x += 1` etc) 2021-04-23 13:33:48 +03:00
checker checker: check using const var as function (#13006) 2022-01-01 09:15:43 +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 js: add missing start_digraph() for the js backend (#12638) 2021-12-01 14:05:18 +02:00
embed_file all: support `$embed_file('embed.vv', .zlib)` (#12654) 2021-12-04 19:43:19 +02: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 ast: rename 'table.get_type_symbol()' to 'table.sym()' and more related calls (#12898) 2021-12-19 18:25:18 +02:00
fmt all: inline sum types (#12912) 2021-12-25 18:26:40 +03:00
gen all: add support for `type MyEnumAlias = MyEnum` 2021-12-30 13:42:06 +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 markused: fix V compiler panics with -skip-unused, for code using generics 2021-12-29 09:48:13 +02:00
parser parser: check variable redefinition error (#12992) 2021-12-29 13:44:08 +02:00
pkgconfig ci: run the full V test suite on arm64 (#12865) 2021-12-16 17:44:21 +02:00
pref tests: support `VTEST_ONLY_FN=*test_sincos* ./v test .` and `./v test -run-only test_sin .` 2021-12-20 18:45:04 +02:00
preludes preludes,builder,cgen: add support for VTEST_RUNNER=tap and -test-runner tap (#12523) 2021-12-16 15:59:46 +02:00
preludes_js preludes,builder,cgen: add support for VTEST_RUNNER=tap and -test-runner tap (#12523) 2021-12-16 15:59:46 +02:00
scanner v.scanner: report the start of unfinished string literals too 2021-12-30 18:29:52 +02:00
tests builtin: add charptr str() and change string format (#12973) 2021-12-30 23:34:24 +03:00
token all: support slices with negative indexes `#[start..end]` (gated arrays) (#12914) 2021-12-22 16:34:02 +03:00
transformer v: fix build and failing tests on arm64 (#12840) 2021-12-15 09:00:38 +02:00
util all: split all backends into cmd/tools/builders (#12811) 2021-12-12 22:10:43 +03:00
vcache cgen: support `-d no_segfault_handler` and `-d no_main`. Cleanup `-d trace_xxx` descriptions in CONTRIBUTING.md 2021-12-03 19:01:45 +02: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 preludes,builder,cgen: add support for VTEST_RUNNER=tap and -test-runner tap (#12523) 2021-12-16 15:59:46 +02: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)