v/vlib/v
spaceface 4ed9780b80
all: enable `-gc boehm` by default (#14577)
2022-06-09 00:44:29 +03:00
..
ast ast: cleanup in generic_insts_to_concrete() (#14724) 2022-06-08 23:17:03 +03:00
builder all: enable `-gc boehm` by default (#14577) 2022-06-09 00:44:29 +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 all: enable `-gc boehm` by default (#14577) 2022-06-09 00:44:29 +03:00
checker checker: add error for `if c >= A && c <= Z {` in non generic functions 2022-06-07 20:43:31 +03:00
depgraph all: update copyright year 2022-01-04 12:21:12 +03:00
doc fmt: remove space in front of ? and ! (#14366) 2022-05-13 06:56:21 +03:00
dotgraph js: add missing start_digraph() for the js backend (#12638) 2021-12-01 14:05:18 +02:00
embed_file embed_file: rename debug_embed_file_in_prod -> force_embed_file (#14523) 2022-05-25 18:26:17 +03:00
errors checker, gen: add support for a [minify] struct attribute (#14247) 2022-05-02 01:59:17 +03:00
eval fmt: remove space in front of ? and ! (#14366) 2022-05-13 06:56:21 +03:00
fmt parser: fix optional with multiple statements (#14592) 2022-06-02 08:23:16 +03:00
gen native: added new helper functions (#14723) 2022-06-08 23:16:15 +03:00
live checker, gen: add support for a [minify] struct attribute (#14247) 2022-05-02 01:59:17 +03:00
markused markused: add _result_ok (#14495) 2022-05-22 14:52:38 +03:00
mathutil math: move the `math.mathutil` generic `min`/`max`/`abs` fns to `math` (#13042) 2022-01-05 18:02:20 +02:00
parser ci: vfmt vlib/v/parser/parser.v 2022-06-02 15:55:13 +03:00
pkgconfig checker: ban unsafe pointer/fn comparison (#14462) 2022-05-20 18:30:16 +03:00
pref all: enable `-gc boehm` by default (#14577) 2022-06-09 00:44:29 +03:00
preludes fmt: remove space in front of ? and ! (#14366) 2022-05-13 06:56:21 +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 scanner: minor cleanup in scanner.v (#14565) 2022-05-31 11:52:47 +03:00
tests all: enable `-gc boehm` by default (#14577) 2022-06-09 00:44:29 +03:00
token checker, gen: add support for a [minify] struct attribute (#14247) 2022-05-02 01:59:17 +03:00
transformer transformer: minor optimization for `'string literal'.len` (#14207) 2022-04-28 22:35:16 +03:00
util v.util, v.builder: fix util.module_is_builtin on macos with -usecache 2022-05-31 09:30:45 +03:00
vcache all: enable `-gc boehm` by default (#14577) 2022-06-09 00:44:29 +03:00
vet checker, gen: add support for a [minify] struct attribute (#14247) 2022-05-02 01:59:17 +03:00
vmod fmt: remove space in front of ? and ! (#14366) 2022-05-13 06:56:21 +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 ci: skip more .vv files on specific jobs 2022-05-18 20:04:59 +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)