v/vlib/v
Delyan Angelov f1549b3ee7
vfmt: make ${} more robust; require it for every interpolation that uses '...' or "..."
2021-04-15 09:28:40 +03:00
..
ast vfmt: make ${} more robust; require it for every interpolation that uses '...' or "..." 2021-04-15 09:28:40 +03:00
builder ios: move `sokol` declarations out of builder, and support non-sokol apps too (#9703) 2021-04-12 19:35:06 +03:00
cflag v.cflag: support `#flag $first_existing("/opt/homebrew/lib/libgc.a", "/usr/local/lib/libgc.a")` 2021-04-10 10:46:43 +03:00
checker checker: fix segfault in vls for struct field declarations, having custom initializers with fn calls (#9741) 2021-04-15 08:49:25 +03:00
depgraph v.depgraph: ensure `v -d debug_realloc -o v cmd/v` works 2021-03-14 16:15:33 +02:00
doc all: a massive merge of ast and table modules 2021-04-02 01:57:09 +03:00
embed_file ci: fix byteptr cast in embed_file.v 2021-04-05 07:27:26 +03:00
errors v: support compiler notices. Use them for `[deprecated_after: '2021-05-01']` tags 2021-03-22 19:59:00 +02:00
eval all: a massive merge of ast and table modules 2021-04-02 01:57:09 +03:00
fmt fmt: mark types import as used in interface (#9718) 2021-04-15 01:29:17 +02:00
gen vfmt: make ${} more robust; require it for every interpolation that uses '...' or "..." 2021-04-15 09:28:40 +03:00
live fmt: minor array wrap improvement (#9420) 2021-03-22 23:06:12 +01:00
markused all: gc: provide optimized mode (#9716) 2021-04-14 00:40:26 +02:00
parser cgen: fix generics with embed generics (fix #8694) (#9724) 2021-04-15 01:44:11 +02:00
pkgconfig builtin,v.pkgconfig: use brew's libgc on macos 2021-03-25 07:28:30 +02:00
pref all: bare metal support (fix `-freestanding`) (#9624) 2021-04-14 07:50:50 +02:00
preludes all: a massive merge of ast and table modules 2021-04-02 01:57:09 +03:00
scanner parser: filter out vet space indent errors inside StringInterLiterals (#9695) 2021-04-12 16:03:22 +03:00
tests cgen: fix generics with embed generics (fix #8694) (#9724) 2021-04-15 01:44:11 +02:00
token all: a massive merge of ast and table modules 2021-04-02 01:57:09 +03:00
util v.util: prevent diff tool lookups when VDIFF_TOOL is set 2021-04-06 13:22:04 +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 v: support dump(expr) (#9160) 2021-03-06 18:09:28 +01:00
README.md all: a massive merge of ast and table modules 2021-04-02 01:57:09 +03:00
TEMPLATES.md tmpl: move to v/parser (#9052) 2021-03-15 13:35:55 +02:00
compiler_errors_test.v ci: fix a race in vlib/v/compiler_errors_test.v execution on m1 2021-04-05 22:57:59 +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)