v/vlib/v
yuyi be513b4c27
cgen: split up array_init() (#14178)
2022-04-26 20:58:47 +03:00
..
ast sokol: support compilation on OpenBSD (#14169) 2022-04-26 13:14:00 +03:00
builder builder: improve macOS 10.5 and PPC support (#14152) 2022-04-25 08:17:00 +03: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 builtin: compile the gc statically by default (#14063) 2022-04-18 10:50:21 +03:00
checker ast, checker, cgen: fix error for multi-return in or expr (fix #14167) (#14172) 2022-04-26 12:17:05 +03:00
depgraph all: update copyright year 2022-01-04 12:21:12 +03:00
doc v.doc: parse multi-line examples (so they get highlighted) (#13894) 2022-04-02 18:29:12 +03:00
dotgraph js: add missing start_digraph() for the js backend (#12638) 2021-12-01 14:05:18 +02:00
embed_file all: ~500 more byte=>u8 2022-04-15 18:25:45 +03:00
errors token: rename Position to Pos, rename position() to pos() (#13279) 2022-01-26 12:36:28 +02:00
eval eval: enable `v interpret examples/hanoi.v` 2022-04-25 12:20:37 +03:00
fmt vfmt: fix array_init line wrapping (#14154) 2022-04-25 08:11:44 +03:00
gen cgen: split up array_init() (#14178) 2022-04-26 20:58:47 +03:00
live all: replace "NB:" with "Note:" (docs/comments) 2022-03-06 20:01:22 +03:00
markused checker: check error for match mut with immutable variable (fix #9704 #8976) (#13725) 2022-03-13 09:53:29 +02:00
mathutil math: move the `math.mathutil` generic `min`/`max`/`abs` fns to `math` (#13042) 2022-01-05 18:02:20 +02:00
parser parser, checker, cgen: fix error for fn call using anon fn call argument (#14155) 2022-04-25 11:26:14 +03:00
pkgconfig builtin: change IError `msg` and `code` to methods + fix vlib, add a deprecation notice for the old usages (#13041) 2022-02-11 15:52:33 +02:00
pref v.pref: show the VCROSS_COMPILER_NAME notice only when the output is not a .c file 2022-04-16 10:46:03 +03:00
preludes all: replace []byte with []u8 2022-04-15 15:35:35 +03: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
profile checker,cgen: implement v.profile.on/1, support `[if profile]` and `-d no_profile_startup` (#13232) 2022-01-21 03:26:05 +02:00
scanner all: ~500 more byte=>u8 2022-04-15 18:25:45 +03:00
tests cgen: fix error for cast to empty interface (fix #14162) (#14176) 2022-04-26 13:26:48 +03:00
token token: minor cleanup of token.v (#14083) 2022-04-19 13:28:27 +03:00
transformer checker: check error for match mut with immutable variable (fix #9704 #8976) (#13725) 2022-03-13 09:53:29 +02:00
util v.util: add math to builtin_module_names (temporary fix for C2V) (#14100) 2022-04-20 10:57:55 +03:00
vcache all: replace "NB:" with "Note:" (docs/comments) 2022-03-06 20:01:22 +03:00
vet token: rename Position to Pos, rename position() to pos() (#13279) 2022-01-26 12:36:28 +02:00
vmod all: ~500 more byte=>u8 2022-04-15 18:25:45 +03:00
README.md docs: adding skeleton README.md files for all vlib modules (#13034) 2022-01-05 18:06:08 +02:00
TEMPLATES.md
compiler_errors_test.v all: replace "NB:" with "Note:" (docs/comments) 2022-03-06 20:01:22 +03:00

README.md

Description

v is a namespace for all of the V compiler modules.

The V compiler modules can be used by V programs that want to process V source code in different ways, in fact, that is how various V tools are implemented: v fmt, v doc, v ast, vls, as well as the V compiler itself.

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)