v/vlib/v
Enzo 2945040a67
gen: fix function with multiple blank params (#8475)
2021-01-31 16:37:26 +02:00
..
ast checker: fix compile-time call with string identifier expression (#8415) 2021-01-30 15:24:16 +01:00
builder all: cleanup redundant `.ends_with(_test.v)` calls 2021-01-30 11:08:52 +02:00
cflag builder: implement `-dump-c-flags flags.txt` 2021-01-29 18:05:14 +02:00
checker checker: check s.$method(arg) argument is []string (#8455) 2021-01-31 15:28:23 +01:00
depgraph all: update copyright to 2019-2021 (#8029) 2021-01-18 13:20:06 +01:00
doc ci: fix `v test-cleancode` 2021-01-25 12:55:01 +02:00
embed_file checker: allow ptr++/ptr-- in unsafe{}, for any kind of pointer, except voidptr 2021-01-17 18:09:25 +02:00
errors fmt: fix multiple things and format most of the compiler (#6631) 2020-10-15 22:12:59 +02:00
eval all: update copyright to 2019-2021 (#8029) 2021-01-18 13:20:06 +01:00
fmt vfmt: remove tracing println for match branches 2021-01-31 11:05:49 +02:00
gen gen: fix function with multiple blank params (#8475) 2021-01-31 16:37:26 +02:00
live all: require calling `optfn() ?` / `optfn() or {...}` for `fn optfn() ? {}` 2021-01-26 16:43:17 +02:00
parser checker: check s.$method(arg) argument is []string (#8455) 2021-01-31 15:28:23 +01:00
pkgconfig all: require calling `optfn() ?` / `optfn() or {...}` for `fn optfn() ? {}` 2021-01-26 16:43:17 +02:00
pref vfmt: add ability to use vfmt as a filter from stdin to stdout (#8432) 2021-01-30 12:38:54 +02:00
preludes live: move to vlib/v/live 2021-01-16 15:05:01 +02:00
scanner fmt: keep newlines between toplevel stmts (#8383) 2021-01-29 12:17:59 +02:00
table checker: check duplicate of a const name (#8396) 2021-01-28 18:34:55 +01:00
tests gen: fix function with multiple blank params (#8475) 2021-01-31 16:37:26 +02:00
token fmt: smarter if condition wrapping (#8201) 2021-01-23 10:33:22 +02:00
util fmt: better ternary concat wrapping (#8379) 2021-01-28 11:23:48 +01:00
vcache v.vcache: improve tracing of vcache usage 2021-01-29 18:05:13 +02:00
vet all: update copyright to 2019-2021 (#8029) 2021-01-18 13:20:06 +01:00
vmod ci: fix `v test-cleancode` 2021-01-25 12:55:01 +02:00
README.md check-md: verify code example formatting (#7143) 2020-12-05 22:54:41 +01:00
compiler_errors_test.v all: require calling `optfn() ?` / `optfn() or {...}` for `fn optfn() ? {}` 2021-01-26 16:43:17 +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.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

res := gen.cgen(parsed_files, table, &pref)